GetStageResponse (AWS Java SDK :: Services :: Amazon API Gateway 2.20.133 API)

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
    - - software.amazon.awssdk.services.apigateway.model.GetStageResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetStageResponse.Builder,GetStageResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetStageResponse
extends ApiGatewayResponse
implements ToCopyableBuilder<GetStageResponse.Builder,GetStageResponse>

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetStageResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetStageResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AccessLogSettings`	`accessLogSettings()` Settings for logging access in this stage.
`static GetStageResponse.Builder`	`builder()`
`Boolean`	`cacheClusterEnabled()` Specifies whether a cache cluster is enabled for the stage.
`String`	`cacheClusterSize()` The stage's cache capacity in GB.
`CacheClusterStatus`	`cacheClusterStatus()` The status of the cache cluster for the stage, if enabled.
`String`	`cacheClusterStatusAsString()` The status of the cache cluster for the stage, if enabled.
`CanarySettings`	`canarySettings()` Settings for the canary deployment in this stage.
`String`	`clientCertificateId()` The identifier of a client certificate for an API stage.
`Instant`	`createdDate()` The timestamp when the stage was created.
`String`	`deploymentId()` The identifier of the Deployment that the stage points to.
`String`	`description()` The stage's description.
`String`	`documentationVersion()` The version of the associated API documentation.
`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`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasVariables()` For responses, this returns true if the service returned a value for the Variables property.
`Instant`	`lastUpdatedDate()` The timestamp when the stage last updated.
`Map<String,MethodSetting>`	`methodSettings()` A map that defines the method settings for a Stage resource.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetStageResponse.Builder>`	`serializableBuilderClass()`
`String`	`stageName()` The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.
`Map<String,String>`	`tags()` The collection of tags.
`GetStageResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`tracingEnabled()` Specifies whether active tracing with X-ray is enabled for the Stage.
`Map<String,String>`	`variables()` A map that defines the stage variables for a Stage resource.
`String`	`webAclArn()` The ARN of the WebAcl associated with the Stage.

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse
responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse

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 a client certificate for an API stage.
    
    Returns:
    
    The identifier of a client certificate for an API stage.
  - stageName
```
public final String stageName()
```
    The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    
    Returns:
    
    The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
  - description
```
public final String description()
```
    The stage's description.
    
    Returns:
    
    The stage's description.
  - cacheClusterEnabled
```
public final Boolean cacheClusterEnabled()
```
    Specifies whether a cache cluster is enabled for the stage.
    
    Returns:
    
    Specifies whether a cache cluster is enabled for the stage.
  - cacheClusterSize
```
public final String cacheClusterSize()
```
    The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
    
    Returns:
    
    The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
  - cacheClusterStatus
```
public final CacheClusterStatus cacheClusterStatus()
```
    The status of the cache cluster for the stage, if enabled.
    
    If the service returns an enum value that is not available in the current SDK version, cacheClusterStatus will return CacheClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cacheClusterStatusAsString().
    
    Returns:
    
    The status of the cache cluster for the stage, if enabled.
    
    See Also:
    
    CacheClusterStatus
  - cacheClusterStatusAsString
```
public final String cacheClusterStatusAsString()
```
    The status of the cache cluster for the stage, if enabled.
    
    If the service returns an enum value that is not available in the current SDK version, cacheClusterStatus will return CacheClusterStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from cacheClusterStatusAsString().
    
    Returns:
    
    The status of the cache cluster for the stage, if enabled.
    
    See Also:
    
    CacheClusterStatus
  - 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 Map<String,MethodSetting> methodSettings()
```
    A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in 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:
    
    A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in 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 a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
    
    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 a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
  - documentationVersion
```
public final String documentationVersion()
```
    The version of the associated API documentation.
    
    Returns:
    
    The version of the associated API documentation.
  - accessLogSettings
```
public final AccessLogSettings accessLogSettings()
```
    Settings for logging access in this stage.
    
    Returns:
    
    Settings for logging access in this stage.
  - canarySettings
```
public final CanarySettings canarySettings()
```
    Settings for the canary deployment in this stage.
    
    Returns:
    
    Settings for the canary deployment in this stage.
  - tracingEnabled
```
public final Boolean tracingEnabled()
```
    Specifies whether active tracing with X-ray is enabled for the Stage.
    
    Returns:
    
    Specifies whether active tracing with X-ray is enabled for the Stage.
  - webAclArn
```
public final String webAclArn()
```
    The ARN of the WebAcl associated with the Stage.
    
    Returns:
    
    The ARN of the WebAcl associated with the Stage.
  - hasTags
```
public final boolean hasTags()
```
    For responses, this returns true if the service returned a value for the Tags 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.
  - tags
```
public final Map<String,String> tags()
```
    The collection of tags. Each tag element is associated with a given resource.
    
    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 hasTags() method.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - createdDate
```
public final Instant createdDate()
```
    The timestamp when the stage was created.
    
    Returns:
    
    The timestamp when the stage was created.
  - lastUpdatedDate
```
public final Instant lastUpdatedDate()
```
    The timestamp when the stage last updated.
    
    Returns:
    
    The timestamp when the stage last updated.
  - toBuilder
```
public GetStageResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetStageResponse.Builder,GetStageResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetStageResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetStageResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - 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)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class GetStageResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.apigateway.model.ApiGatewayResponse

Methods inherited from class software.amazon.awssdk.core.SdkResponse

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

cacheClusterStatusAsString

hasMethodSettings

methodSettings

hasVariables

variables

documentationVersion

accessLogSettings

canarySettings

tracingEnabled

webAclArn

hasTags

tags

createdDate

lastUpdatedDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields