@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.
Constructor and Description |
---|
AwsApiGatewayV2StageDetails() |
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.
|
public void setClientCertificateId(String clientCertificateId)
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
clientCertificateId
- The identifier of a client certificate for a stage. Supported only for WebSocket API calls.public String getClientCertificateId()
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
public AwsApiGatewayV2StageDetails withClientCertificateId(String clientCertificateId)
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
clientCertificateId
- The identifier of a client certificate for a stage. Supported only for WebSocket API calls.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
.
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
.
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
.
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
.
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
.
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
.
public void setDescription(String description)
The description of the stage.
description
- The description of the stage.public String getDescription()
The description of the stage.
public AwsApiGatewayV2StageDetails withDescription(String description)
The description of the stage.
description
- The description of the stage.public void setDefaultRouteSettings(AwsApiGatewayV2RouteSettings defaultRouteSettings)
Default route settings for the stage.
defaultRouteSettings
- Default route settings for the stage.public AwsApiGatewayV2RouteSettings getDefaultRouteSettings()
Default route settings for the stage.
public AwsApiGatewayV2StageDetails withDefaultRouteSettings(AwsApiGatewayV2RouteSettings defaultRouteSettings)
Default route settings for the stage.
defaultRouteSettings
- Default route settings for the stage.public void setDeploymentId(String deploymentId)
The identifier of the deployment that the stage is associated with.
deploymentId
- The identifier of the deployment that the stage is associated with.public String getDeploymentId()
The identifier of the deployment that the stage is associated with.
public AwsApiGatewayV2StageDetails withDeploymentId(String deploymentId)
The identifier of the deployment that the stage is associated with.
deploymentId
- The identifier of the deployment that the stage is associated with.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
.
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
.
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
.
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
.
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
.
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
.
public void setRouteSettings(AwsApiGatewayV2RouteSettings routeSettings)
The route settings for the stage.
routeSettings
- The route settings for the stage.public AwsApiGatewayV2RouteSettings getRouteSettings()
The route settings for the stage.
public AwsApiGatewayV2StageDetails withRouteSettings(AwsApiGatewayV2RouteSettings routeSettings)
The route settings for the stage.
routeSettings
- The route settings for the stage.public void setStageName(String stageName)
The name of the stage.
stageName
- The name of the stage.public String getStageName()
The name of the stage.
public AwsApiGatewayV2StageDetails withStageName(String stageName)
The name of the stage.
stageName
- The name of the stage.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 -._~:/?#&=,
Variable names can have alphanumeric and underscore characters.
Variable values can contain the following characters:
Uppercase and lowercase letters
Numbers
Special characters -._~:/?#&=,
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 -._~:/?#&=,
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 -._~:/?#&=,
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 -._~:/?#&=,
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 -._~:/?#&=,
public AwsApiGatewayV2StageDetails addStageVariablesEntry(String key, String value)
public AwsApiGatewayV2StageDetails clearStageVariablesEntries()
public void setAccessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)
Information about settings for logging access for the stage.
accessLogSettings
- Information about settings for logging access for the stage.public AwsApiGatewayAccessLogSettings getAccessLogSettings()
Information about settings for logging access for the stage.
public AwsApiGatewayV2StageDetails withAccessLogSettings(AwsApiGatewayAccessLogSettings accessLogSettings)
Information about settings for logging access for the stage.
accessLogSettings
- Information about settings for logging access for the stage.public void setAutoDeploy(Boolean autoDeploy)
Indicates whether updates to an API automatically trigger a new deployment.
autoDeploy
- Indicates whether updates to an API automatically trigger a new deployment.public Boolean getAutoDeploy()
Indicates whether updates to an API automatically trigger a new deployment.
public AwsApiGatewayV2StageDetails withAutoDeploy(Boolean autoDeploy)
Indicates whether updates to an API automatically trigger a new deployment.
autoDeploy
- Indicates whether updates to an API automatically trigger a new deployment.public Boolean isAutoDeploy()
Indicates whether updates to an API automatically trigger a new deployment.
public void setLastDeploymentStatusMessage(String lastDeploymentStatusMessage)
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
lastDeploymentStatusMessage
- The status of the last deployment of a stage. Supported only if the stage has automatic deployment
enabled.public String getLastDeploymentStatusMessage()
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
public AwsApiGatewayV2StageDetails withLastDeploymentStatusMessage(String lastDeploymentStatusMessage)
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
lastDeploymentStatusMessage
- The status of the last deployment of a stage. Supported only if the stage has automatic deployment
enabled.public void setApiGatewayManaged(Boolean apiGatewayManaged)
Indicates whether the stage is managed by API Gateway.
apiGatewayManaged
- Indicates whether the stage is managed by API Gateway.public Boolean getApiGatewayManaged()
Indicates whether the stage is managed by API Gateway.
public AwsApiGatewayV2StageDetails withApiGatewayManaged(Boolean apiGatewayManaged)
Indicates whether the stage is managed by API Gateway.
apiGatewayManaged
- Indicates whether the stage is managed by API Gateway.public Boolean isApiGatewayManaged()
Indicates whether the stage is managed by API Gateway.
public String toString()
toString
in class Object
Object.toString()
public AwsApiGatewayV2StageDetails clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.