java.lang.Object
- software.amazon.awssdk.services.securityhub.model.AwsApiGatewayStageDetails

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<AwsApiGatewayStageDetails.Builder,AwsApiGatewayStageDetails>

@Generated("software.amazon.awssdk:codegen")
public final class AwsApiGatewayStageDetails
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AwsApiGatewayStageDetails.Builder,AwsApiGatewayStageDetails>

Provides information about a version 1 Amazon API Gateway stage.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface AwsApiGatewayStageDetails.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`AwsApiGatewayAccessLogSettings`	`accessLogSettings()`	Settings for logging access for the stage.
`static AwsApiGatewayStageDetails.Builder`	`builder()`
`Boolean`	`cacheClusterEnabled()`	Indicates whether a cache cluster is enabled for the stage.
`String`	`cacheClusterSize()`	If a cache cluster is enabled, the size of the cache cluster.
`String`	`cacheClusterStatus()`	If a cache cluster is enabled, the status of the cache cluster.
`AwsApiGatewayCanarySettings`	`canarySettings()`	Information about settings for canary deployment in the stage.
`String`	`clientCertificateId()`	The identifier of the client certificate for the stage.
`String`	`createdDate()`	Indicates when the stage was created.
`String`	`deploymentId()`	The identifier of the deployment that the stage points to.
`String`	`description()`	A description of the stage.
`String`	`documentationVersion()`	The version of the API documentation that is associated with the stage.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMethodSettings()`	For responses, this returns true if the service returned a value for the MethodSettings property.
`boolean`	`hasVariables()`	For responses, this returns true if the service returned a value for the Variables property.
`String`	`lastUpdatedDate()`	Indicates when the stage was most recently updated.
`List<AwsApiGatewayMethodSettings>`	`methodSettings()`	Defines the method settings for the stage.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends AwsApiGatewayStageDetails.Builder>`	`serializableBuilderClass()`
`String`	`stageName()`	The name of the stage.
`AwsApiGatewayStageDetails.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Boolean`	`tracingEnabled()`	Indicates whether active tracing with X-Ray is enabled for the stage.
`Map<String,String>`	`variables()`	A map that defines the stage variables for the stage.
`String`	`webAclArn()`	The ARN of the web ACL associated with the stage.

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
  - deploymentId
```
public final String deploymentId()
```
    The identifier of the deployment that the stage points to.
    
    Returns:
    
    The identifier of the deployment that the stage points to.
  - clientCertificateId
```
public final String clientCertificateId()
```
    The identifier of the client certificate for the stage.
    
    Returns:
    
    The identifier of the client certificate for the stage.
  - stageName
```
public final String stageName()
```
    The name of the stage.
    
    Returns:
    
    The name of the stage.
  - description
```
public final String description()
```
    A description of the stage.
    
    Returns:
    
    A description of the stage.
  - cacheClusterEnabled
```
public final Boolean cacheClusterEnabled()
```
    Indicates whether a cache cluster is enabled for the stage.
    
    Returns:
    
    Indicates whether a cache cluster is enabled for the stage.
  - cacheClusterSize
```
public final String cacheClusterSize()
```
    If a cache cluster is enabled, the size of the cache cluster.
    
    Returns:
    
    If a cache cluster is enabled, the size of the cache cluster.
  - cacheClusterStatus
```
public final String cacheClusterStatus()
```
    If a cache cluster is enabled, the status of the cache cluster.
    
    Returns:
    
    If a cache cluster is enabled, the status of the cache cluster.
  - hasMethodSettings
```
public final boolean hasMethodSettings()
```
    For responses, this returns true if the service returned a value for the MethodSettings 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.
  - methodSettings
```
public final List<AwsApiGatewayMethodSettings> methodSettings()
```
    Defines the method settings for the stage.
    
    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 hasMethodSettings() method.
    
    Returns:
    
    Defines the method settings for the stage.
  - hasVariables
```
public final boolean hasVariables()
```
    For responses, this returns true if the service returned a value for the Variables 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.
  - variables
```
public final Map<String,String> variables()
```
    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 hasVariables() 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 -._~:/?#&=,
  - documentationVersion
```
public final String documentationVersion()
```
    The version of the API documentation that is associated with the stage.
    
    Returns:
    
    The version of the API documentation that is associated with the stage.
  - accessLogSettings
```
public final AwsApiGatewayAccessLogSettings accessLogSettings()
```
    Settings for logging access for the stage.
    
    Returns:
    
    Settings for logging access for the stage.
  - canarySettings
```
public final AwsApiGatewayCanarySettings canarySettings()
```
    Information about settings for canary deployment in the stage.
    
    Returns:
    
    Information about settings for canary deployment in the stage.
  - tracingEnabled
```
public final Boolean tracingEnabled()
```
    Indicates whether active tracing with X-Ray is enabled for the stage.
    
    Returns:
    
    Indicates whether active tracing with X-Ray is enabled for the stage.
  - createdDate
```
public final String createdDate()
```
    Indicates when the stage was created.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    
    YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    
    YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    
    YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
    Returns:
    
    Indicates when the stage was created.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    
    YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    
    YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    
    YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
  - lastUpdatedDate
```
public final String lastUpdatedDate()
```
    Indicates when the stage was most recently updated.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    
    YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    
    YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    
    YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
    Returns:
    
    Indicates when the stage was most recently updated.
    
    This field accepts only the specified formats. Timestamps can end with Z or ("+" / "-") time-hour [":" time-minute]. The time-secfrac after seconds is limited to a maximum of 9 digits. The offset is bounded by +/-18:00. Here are valid timestamp formats with examples:
    
    YYYY-MM-DDTHH:MM:SSZ (for example, 2019-01-31T23:00:00Z)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmmZ (for example, 2019-01-31T23:00:00.123456789Z)
    
    YYYY-MM-DDTHH:MM:SS+HH:MM (for example, 2024-01-04T15:25:10+17:59)
    
    YYYY-MM-DDTHH:MM:SS-HHMM (for example, 2024-01-04T15:25:10-1759)
    
    YYYY-MM-DDTHH:MM:SS.mmmmmmmmm+HH:MM (for example, 2024-01-04T15:25:10.123456789+17:59)
  - webAclArn
```
public final String webAclArn()
```
    The ARN of the web ACL associated with the stage.
    
    Returns:
    
    The ARN of the web ACL associated with the stage.
  - toBuilder
```
public AwsApiGatewayStageDetails.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<AwsApiGatewayStageDetails.Builder,AwsApiGatewayStageDetails>
  - builder
```
public static AwsApiGatewayStageDetails.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends AwsApiGatewayStageDetails.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

Class AwsApiGatewayStageDetails

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

deploymentId

clientCertificateId

stageName

description

cacheClusterEnabled

cacheClusterSize

cacheClusterStatus

hasMethodSettings

methodSettings

hasVariables

variables

documentationVersion

accessLogSettings

canarySettings

tracingEnabled

createdDate

lastUpdatedDate

webAclArn

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields