@Generated(value="software.amazon.awssdk:codegen") public final class AwsApiGatewayV2StageDetails extends Object implements SdkPojo, Serializable, ToCopyableBuilder<AwsApiGatewayV2StageDetails.Builder,AwsApiGatewayV2StageDetails>
Contains information about a version 2 stage for Amazon API Gateway.
| Modifier and Type | Class and Description |
|---|---|
static interface |
AwsApiGatewayV2StageDetails.Builder |
| Modifier and Type | Method and Description |
|---|---|
AwsApiGatewayAccessLogSettings |
accessLogSettings()
Information about settings for logging access for the stage.
|
Boolean |
apiGatewayManaged()
Indicates whether the stage is managed by API Gateway.
|
Boolean |
autoDeploy()
Indicates whether updates to an API automatically trigger a new deployment.
|
static AwsApiGatewayV2StageDetails.Builder |
builder() |
String |
clientCertificateId()
The identifier of a client certificate for a stage.
|
String |
createdDate()
Indicates when the stage was created.
|
AwsApiGatewayV2RouteSettings |
defaultRouteSettings()
Default route settings for the stage.
|
String |
deploymentId()
The identifier of the deployment that the stage is associated with.
|
String |
description()
The description of the stage.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasStageVariables()
For responses, this returns true if the service returned a value for the StageVariables property.
|
String |
lastDeploymentStatusMessage()
The status of the last deployment of a stage.
|
String |
lastUpdatedDate()
Indicates when the stage was most recently updated.
|
AwsApiGatewayV2RouteSettings |
routeSettings()
The route settings for the stage.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends AwsApiGatewayV2StageDetails.Builder> |
serializableBuilderClass() |
String |
stageName()
The name of the stage.
|
Map<String,String> |
stageVariables()
A map that defines the stage variables for the stage.
|
AwsApiGatewayV2StageDetails.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String clientCertificateId()
The identifier of a client certificate for a stage. Supported only for WebSocket API calls.
public final 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.
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 final String description()
The description of the stage.
public final AwsApiGatewayV2RouteSettings defaultRouteSettings()
Default route settings for the stage.
public final String deploymentId()
The identifier of the deployment that the stage is associated with.
public final 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.
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 final AwsApiGatewayV2RouteSettings routeSettings()
The route settings for the stage.
public final String stageName()
The name of the stage.
public final boolean hasStageVariables()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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 -._~:/?#&=,
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasStageVariables() method.
Variable names can have alphanumeric and underscore characters.
Variable values can contain the following characters:
Uppercase and lowercase letters
Numbers
Special characters -._~:/?#&=,
public final AwsApiGatewayAccessLogSettings accessLogSettings()
Information about settings for logging access for the stage.
public final Boolean autoDeploy()
Indicates whether updates to an API automatically trigger a new deployment.
public final String lastDeploymentStatusMessage()
The status of the last deployment of a stage. Supported only if the stage has automatic deployment enabled.
public final Boolean apiGatewayManaged()
Indicates whether the stage is managed by API Gateway.
public AwsApiGatewayV2StageDetails.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<AwsApiGatewayV2StageDetails.Builder,AwsApiGatewayV2StageDetails>public static AwsApiGatewayV2StageDetails.Builder builder()
public static Class<? extends AwsApiGatewayV2StageDetails.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
Copyright © 2023. All rights reserved.