software.amazon.awssdk.services.securityhub.model

Class AwsApiGatewayV2StageDetails

java.lang.Object

software.amazon.awssdk.services.securityhub.model.AwsApiGatewayV2StageDetails

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AwsApiGatewayV2StageDetails.Builder,AwsApiGatewayV2StageDetails>

@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.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AwsApiGatewayV2StageDetails.Builder

Method Summary

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.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientCertificateId

public final String clientCertificateId()

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.

createdDate

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.

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.

description

public final String description()

The description of the stage.

Returns:

The description of the stage.

defaultRouteSettings

public final AwsApiGatewayV2RouteSettings defaultRouteSettings()

Default route settings for the stage.

Returns:

Default route settings for the stage.

deploymentId

public final String deploymentId()

The identifier of the deployment that the stage is associated with.

Returns:

The identifier of the deployment that the stage is associated with.

lastUpdatedDate

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.

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.

routeSettings

public final AwsApiGatewayV2RouteSettings routeSettings()

The route settings for the stage.

Returns:

The route settings for the stage.

stageName

public final String stageName()

The name of the stage.

Returns:

The name of the stage.

hasStageVariables

public final boolean hasStageVariables()

For responses, this returns true if the service returned a value for the StageVariables property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

stageVariables

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.

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 -._~:/?#&=,

accessLogSettings

public final AwsApiGatewayAccessLogSettings accessLogSettings()

Information about settings for logging access for the stage.

Returns:

Information about settings for logging access for the stage.

autoDeploy

public final Boolean autoDeploy()

Indicates whether updates to an API automatically trigger a new deployment.

Returns:

Indicates whether updates to an API automatically trigger a new deployment.

lastDeploymentStatusMessage

public final String lastDeploymentStatusMessage()

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.

apiGatewayManaged

public final Boolean apiGatewayManaged()

Indicates whether the stage is managed by API Gateway.

Returns:

Indicates whether the stage is managed by API Gateway.

toBuilder

public AwsApiGatewayV2StageDetails.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AwsApiGatewayV2StageDetails.Builder,AwsApiGatewayV2StageDetails>

builder

public static AwsApiGatewayV2StageDetails.Builder builder()

serializableBuilderClass

public static Class<? extends AwsApiGatewayV2StageDetails.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final 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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo