Class Stage
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Stage.Builder,
Stage>
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AccessLogSettings
Settings for logging access in this stage.static Stage.Builder
builder()
final Boolean
Specifies whether a cache cluster is enabled for the stage.final String
The stage's cache capacity in GB.final CacheClusterStatus
The status of the cache cluster for the stage, if enabled.final String
The status of the cache cluster for the stage, if enabled.final CanarySettings
Settings for the canary deployment in this stage.final String
The identifier of a client certificate for an API stage.final Instant
The timestamp when the stage was created.final String
The identifier of the Deployment that the stage points to.final String
The stage's description.final String
The version of the associated API documentation.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MethodSettings property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final boolean
For responses, this returns true if the service returned a value for the Variables property.final Instant
The timestamp when the stage last updated.final Map
<String, MethodSetting> A map that defines the method settings for a Stage resource.static Class
<? extends Stage.Builder> final String
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway.tags()
The collection of tags.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.A map that defines the stage variables for a Stage resource.final String
The ARN of the WebAcl associated with the Stage.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
deploymentId
The identifier of the Deployment that the stage points to.
- Returns:
- The identifier of the Deployment that the stage points to.
-
clientCertificateId
The identifier of a client certificate for an API stage.
- Returns:
- The identifier of a client certificate for an API stage.
-
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
The stage's description.
- Returns:
- The stage's description.
-
cacheClusterEnabled
Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
totrue
for a method.- Returns:
- Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set
CachingEnabled
totrue
for a method.
-
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
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 returnCacheClusterStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcacheClusterStatusAsString()
.- Returns:
- The status of the cache cluster for the stage, if enabled.
- See Also:
-
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 returnCacheClusterStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcacheClusterStatusAsString()
.- Returns:
- The status of the cache cluster for the stage, if enabled.
- See Also:
-
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 theisEmpty()
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
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 theisEmpty()
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
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
The version of the associated API documentation.
- Returns:
- The version of the associated API documentation.
-
accessLogSettings
Settings for logging access in this stage.
- Returns:
- Settings for logging access in this stage.
-
canarySettings
Settings for the canary deployment in this stage.
- Returns:
- Settings for the canary deployment in this stage.
-
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
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 theisEmpty()
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
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
The timestamp when the stage was created.
- Returns:
- The timestamp when the stage was created.
-
lastUpdatedDate
The timestamp when the stage last updated.
- Returns:
- The timestamp when the stage last updated.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Stage.Builder,
Stage> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-