AwsApiGatewayV2StageDetails (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.securityhub.model.AwsApiGatewayV2StageDetails

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AwsApiGatewayV2StageDetails
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains information about a version 2 stage for Amazon API Gateway.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AwsApiGatewayV2StageDetails()

Constructors
Constructor and Description
`AwsApiGatewayV2StageDetails()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AwsApiGatewayV2StageDetails`	`addStageVariablesEntry(String key, String value)` Add a single StageVariables entry
`AwsApiGatewayV2StageDetails`	`clearStageVariablesEntries()` Removes all the entries added into StageVariables.
`AwsApiGatewayV2StageDetails`	`clone()`
`boolean`	`equals(Object obj)`
`AwsApiGatewayAccessLogSettings`	`getAccessLogSettings()` Information about settings for logging access for the stage.
`Boolean`	`getApiGatewayManaged()` Indicates whether the stage is managed by API Gateway.
`Boolean`	`getAutoDeploy()` Indicates whether updates to an API automatically trigger a new deployment.
`String`	`getClientCertificateId()` The identifier of a client certificate for a stage.
`String`	`getCreatedDate()` Indicates when the stage was created.
`AwsApiGatewayV2RouteSettings`	`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()` The status of the last deployment of a stage.
`String`	`getLastUpdatedDate()` Indicates when the stage was most recently updated.
`AwsApiGatewayV2RouteSettings`	`getRouteSettings()` The route settings for the stage.
`String`	`getStageName()` The name of the stage.
`Map<String,String>`	`getStageVariables()` A map that defines the stage variables for the stage.
`int`	`hashCode()`
`Boolean`	`isApiGatewayManaged()` Indicates whether the stage is managed by API Gateway.
`Boolean`	`isAutoDeploy()` Indicates whether updates to an API automatically trigger a new deployment.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setAccessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)` Information about settings for logging access for the stage.
`void`	`setApiGatewayManaged(Boolean apiGatewayManaged)` Indicates whether the stage is managed by API Gateway.
`void`	`setAutoDeploy(Boolean autoDeploy)` Indicates 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(String createdDate)` Indicates when the stage was created.
`void`	`setDefaultRouteSettings(AwsApiGatewayV2RouteSettings 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)` The status of the last deployment of a stage.
`void`	`setLastUpdatedDate(String lastUpdatedDate)` Indicates when the stage was most recently updated.
`void`	`setRouteSettings(AwsApiGatewayV2RouteSettings routeSettings)` The route settings for the stage.
`void`	`setStageName(String stageName)` The name of the stage.
`void`	`setStageVariables(Map<String,String> stageVariables)` A map that defines the stage variables for the stage.
`String`	`toString()` Returns a string representation of this object.
`AwsApiGatewayV2StageDetails`	`withAccessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)` Information about settings for logging access for the stage.
`AwsApiGatewayV2StageDetails`	`withApiGatewayManaged(Boolean apiGatewayManaged)` Indicates whether the stage is managed by API Gateway.
`AwsApiGatewayV2StageDetails`	`withAutoDeploy(Boolean autoDeploy)` Indicates whether updates to an API automatically trigger a new deployment.
`AwsApiGatewayV2StageDetails`	`withClientCertificateId(String clientCertificateId)` The identifier of a client certificate for a stage.
`AwsApiGatewayV2StageDetails`	`withCreatedDate(String createdDate)` Indicates when the stage was created.
`AwsApiGatewayV2StageDetails`	`withDefaultRouteSettings(AwsApiGatewayV2RouteSettings defaultRouteSettings)` Default route settings for the stage.
`AwsApiGatewayV2StageDetails`	`withDeploymentId(String deploymentId)` The identifier of the deployment that the stage is associated with.
`AwsApiGatewayV2StageDetails`	`withDescription(String description)` The description of the stage.
`AwsApiGatewayV2StageDetails`	`withLastDeploymentStatusMessage(String lastDeploymentStatusMessage)` The status of the last deployment of a stage.
`AwsApiGatewayV2StageDetails`	`withLastUpdatedDate(String lastUpdatedDate)` Indicates when the stage was most recently updated.
`AwsApiGatewayV2StageDetails`	`withRouteSettings(AwsApiGatewayV2RouteSettings routeSettings)` The route settings for the stage.
`AwsApiGatewayV2StageDetails`	`withStageName(String stageName)` The name of the stage.
`AwsApiGatewayV2StageDetails`	`withStageVariables(Map<String,String> stageVariables)` A map that defines the stage variables for the stage.

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

- Constructor Detail
  - AwsApiGatewayV2StageDetails
```
public AwsApiGatewayV2StageDetails()
```
- Method Detail
  - setClientCertificateId
```
public void setClientCertificateId(String clientCertificateId)
```
    The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
    
    Parameters:
    
    clientCertificateId - The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
  - getClientCertificateId
```
public String getClientCertificateId()
```
    The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
    
    Returns:
    
    The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
  - withClientCertificateId
```
public AwsApiGatewayV2StageDetails withClientCertificateId(String clientCertificateId)
```
    The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
    
    Parameters:
    
    clientCertificateId - The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreatedDate
```
public void setCreatedDate(String createdDate)
```
    Indicates when the stage was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
    
    Parameters:
    
    createdDate - Indicates when the stage was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
  - getCreatedDate
```
public String getCreatedDate()
```
    Indicates when the stage was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
    
    Returns:
    
    Indicates when the stage was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
  - withCreatedDate
```
public AwsApiGatewayV2StageDetails withCreatedDate(String createdDate)
```
    Indicates when the stage was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
    
    Parameters:
    
    createdDate - Indicates when the stage was created.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
    
    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 AwsApiGatewayV2StageDetails 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.
  - setDefaultRouteSettings
```
public void setDefaultRouteSettings(AwsApiGatewayV2RouteSettings defaultRouteSettings)
```
    Default route settings for the stage.
    
    Parameters:
    
    defaultRouteSettings - Default route settings for the stage.
  - getDefaultRouteSettings
```
public AwsApiGatewayV2RouteSettings getDefaultRouteSettings()
```
    Default route settings for the stage.
    
    Returns:
    
    Default route settings for the stage.
  - withDefaultRouteSettings
```
public AwsApiGatewayV2StageDetails withDefaultRouteSettings(AwsApiGatewayV2RouteSettings 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.
    
    Parameters:
    
    deploymentId - The identifier of the deployment that the stage is associated with.
  - getDeploymentId
```
public String getDeploymentId()
```
    The identifier of the deployment that the stage is associated with.
    
    Returns:
    
    The identifier of the deployment that the stage is associated with.
  - withDeploymentId
```
public AwsApiGatewayV2StageDetails withDeploymentId(String deploymentId)
```
    The identifier of the deployment that the stage is associated with.
    
    Parameters:
    
    deploymentId - The identifier of the deployment that the stage is associated with.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedDate
```
public void setLastUpdatedDate(String lastUpdatedDate)
```
    Indicates when the stage was most recently updated.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
    
    Parameters:
    
    lastUpdatedDate - Indicates when the stage was most recently updated.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
  - getLastUpdatedDate
```
public String getLastUpdatedDate()
```
    Indicates when the stage was most recently updated.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
    
    Returns:
    
    Indicates when the stage was most recently updated.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
  - withLastUpdatedDate
```
public AwsApiGatewayV2StageDetails withLastUpdatedDate(String lastUpdatedDate)
```
    Indicates when the stage was most recently updated.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
    
    Parameters:
    
    lastUpdatedDate - Indicates when the stage was most recently updated.
    
    Uses the date-time format specified in RFC 3339 section 5.6, Internet Date/Time Format. The value cannot contain spaces, and date and time should be separated by T. For example, 2020-03-22T13:22:13.933Z.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRouteSettings
```
public void setRouteSettings(AwsApiGatewayV2RouteSettings routeSettings)
```
    The route settings for the stage.
    
    Parameters:
    
    routeSettings - The route settings for the stage.
  - getRouteSettings
```
public AwsApiGatewayV2RouteSettings getRouteSettings()
```
    The route settings for the stage.
    
    Returns:
    
    The route settings for the stage.
  - withRouteSettings
```
public AwsApiGatewayV2StageDetails withRouteSettings(AwsApiGatewayV2RouteSettings routeSettings)
```
    The route settings for the stage.
    
    Parameters:
    
    routeSettings - The route settings for the stage.
    
    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 AwsApiGatewayV2StageDetails 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 the stage.
    
    Variable names can have alphanumeric and underscore characters.
    
    Variable values can contain the following characters:
    - Uppercase and lowercase letters
    - Numbers
    - Special characters -._~:/?#&=,
    Returns:
    A map that defines the stage variables for the stage.
    
    Variable names can have alphanumeric and underscore characters.
    
    Variable values can contain the following characters:
    
    Uppercase and lowercase letters
    
    Numbers
    
    Special characters -._~:/?#&=,
  - setStageVariables
```
public void setStageVariables(Map<String,String> stageVariables)
```
    A map that defines the stage variables for the stage.
    
    Variable names can have alphanumeric and underscore characters.
    
    Variable values can contain the following characters:
    - Uppercase and lowercase letters
    - Numbers
    - Special characters -._~:/?#&=,
    Parameters:
    stageVariables - A map that defines the stage variables for the stage.
    
    Variable names can have alphanumeric and underscore characters.
    
    Variable values can contain the following characters:
    
    Uppercase and lowercase letters
    
    Numbers
    
    Special characters -._~:/?#&=,
  - withStageVariables
```
public AwsApiGatewayV2StageDetails withStageVariables(Map<String,String> stageVariables)
```
    A map that defines the stage variables for the stage.
    
    Variable names can have alphanumeric and underscore characters.
    
    Variable values can contain the following characters:
    - Uppercase and lowercase letters
    - Numbers
    - Special characters -._~:/?#&=,
    Parameters:
    stageVariables - A map that defines the stage variables for the stage.
    
    Variable names can have alphanumeric and underscore characters.
    
    Variable values can contain the following characters:
    
    Uppercase and lowercase letters
    
    Numbers
    
    Special characters -._~:/?#&=,
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addStageVariablesEntry
```
public AwsApiGatewayV2StageDetails addStageVariablesEntry(String key,
                                                          String value)
```
    Add a single StageVariables entry
    
    See Also:
    
    withStageVariables(java.util.Map<java.lang.String, java.lang.String>)
  - clearStageVariablesEntries
```
public AwsApiGatewayV2StageDetails clearStageVariablesEntries()
```
    Removes all the entries added into StageVariables.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAccessLogSettings
```
public void setAccessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)
```
    Information about settings for logging access for the stage.
    
    Parameters:
    
    accessLogSettings - Information about settings for logging access for the stage.
  - getAccessLogSettings
```
public AwsApiGatewayAccessLogSettings getAccessLogSettings()
```
    Information about settings for logging access for the stage.
    
    Returns:
    
    Information about settings for logging access for the stage.
  - withAccessLogSettings
```
public AwsApiGatewayV2StageDetails withAccessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)
```
    Information about settings for logging access for the stage.
    
    Parameters:
    
    accessLogSettings - Information about settings for logging access for the stage.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setAutoDeploy
```
public void setAutoDeploy(Boolean autoDeploy)
```
    Indicates whether updates to an API automatically trigger a new deployment.
    
    Parameters:
    
    autoDeploy - Indicates whether updates to an API automatically trigger a new deployment.
  - getAutoDeploy
```
public Boolean getAutoDeploy()
```
    Indicates whether updates to an API automatically trigger a new deployment.
    
    Returns:
    
    Indicates whether updates to an API automatically trigger a new deployment.
  - withAutoDeploy
```
public AwsApiGatewayV2StageDetails withAutoDeploy(Boolean autoDeploy)
```
    Indicates whether updates to an API automatically trigger a new deployment.
    
    Parameters:
    
    autoDeploy - Indicates whether updates to an API automatically trigger a new deployment.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isAutoDeploy
```
public Boolean isAutoDeploy()
```
    Indicates whether updates to an API automatically trigger a new deployment.
    
    Returns:
    
    Indicates whether updates to an API automatically trigger a new deployment.
  - setLastDeploymentStatusMessage
```
public void setLastDeploymentStatusMessage(String lastDeploymentStatusMessage)
```
    The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
    
    Parameters:
    
    lastDeploymentStatusMessage - The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
  - getLastDeploymentStatusMessage
```
public String getLastDeploymentStatusMessage()
```
    The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
    
    Returns:
    
    The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
  - withLastDeploymentStatusMessage
```
public AwsApiGatewayV2StageDetails withLastDeploymentStatusMessage(String lastDeploymentStatusMessage)
```
    The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
    
    Parameters:
    
    lastDeploymentStatusMessage - The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setApiGatewayManaged
```
public void setApiGatewayManaged(Boolean apiGatewayManaged)
```
    Indicates whether the stage is managed by API Gateway.
    
    Parameters:
    
    apiGatewayManaged - Indicates whether the stage is managed by API Gateway.
  - getApiGatewayManaged
```
public Boolean getApiGatewayManaged()
```
    Indicates whether the stage is managed by API Gateway.
    
    Returns:
    
    Indicates whether the stage is managed by API Gateway.
  - withApiGatewayManaged
```
public AwsApiGatewayV2StageDetails withApiGatewayManaged(Boolean apiGatewayManaged)
```
    Indicates whether the stage is managed by API Gateway.
    
    Parameters:
    
    apiGatewayManaged - Indicates whether the stage is managed by API Gateway.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - isApiGatewayManaged
```
public Boolean isApiGatewayManaged()
```
    Indicates whether the stage is managed by API Gateway.
    
    Returns:
    
    Indicates whether the stage is managed by API Gateway.
  - 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 AwsApiGatewayV2StageDetails 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 AwsApiGatewayV2StageDetails

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AwsApiGatewayV2StageDetails

Method Detail

setClientCertificateId

getClientCertificateId

withClientCertificateId

setCreatedDate

getCreatedDate

withCreatedDate

setDescription

getDescription

withDescription

setDefaultRouteSettings

getDefaultRouteSettings

withDefaultRouteSettings

setDeploymentId

getDeploymentId

withDeploymentId

setLastUpdatedDate

getLastUpdatedDate

withLastUpdatedDate

setRouteSettings

getRouteSettings

withRouteSettings

setStageName

getStageName

withStageName

getStageVariables

setStageVariables

withStageVariables

addStageVariablesEntry

clearStageVariablesEntries

setAccessLogSettings

getAccessLogSettings

withAccessLogSettings

setAutoDeploy

getAutoDeploy

withAutoDeploy

isAutoDeploy

setLastDeploymentStatusMessage

getLastDeploymentStatusMessage

withLastDeploymentStatusMessage

setApiGatewayManaged

getApiGatewayManaged

withApiGatewayManaged

isApiGatewayManaged

toString

equals

hashCode

clone

marshall