@Generated(value="software.amazon.awssdk:codegen") public class UpdateStageResponse extends APIGatewayResponse implements ToCopyableBuilder<UpdateStageResponse.Builder,UpdateStageResponse>
Represents a unique identifier for a version of a deployed RestApi that is callable by users.
Modifier and Type | Class and Description |
---|---|
static interface |
UpdateStageResponse.Builder |
Modifier and Type | Method and Description |
---|---|
static UpdateStageResponse.Builder |
builder() |
Boolean |
cacheClusterEnabled()
Specifies whether a cache cluster is enabled for the stage.
|
String |
cacheClusterSize()
The size of the cache cluster for the stage, if enabled.
|
CacheClusterStatus |
cacheClusterStatus()
The status of the cache cluster for the stage, if enabled.
|
String |
cacheClusterStatusString()
The status of the cache cluster for the stage, if enabled.
|
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) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkResponse . |
int |
hashCode() |
Instant |
lastUpdatedDate()
The timestamp when the stage last updated.
|
Map<String,MethodSetting> |
methodSettings()
A map that defines the method settings for a Stage resource.
|
static Class<? extends UpdateStageResponse.Builder> |
serializableBuilderClass() |
String |
stageName()
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API
Gateway.
|
UpdateStageResponse.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
Map<String,String> |
variables()
A map that defines the stage variables for a Stage resource.
|
copy
public String deploymentId()
The identifier of the Deployment that the stage points to.
public String clientCertificateId()
The identifier of a client certificate for an API stage.
public String stageName()
The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to Amazon API Gateway.
public String description()
The stage's description.
public Boolean cacheClusterEnabled()
Specifies whether a cache cluster is enabled for the stage.
public String cacheClusterSize()
The size of the cache cluster for the stage, if enabled.
public 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 cacheClusterStatusString()
.
CacheClusterStatus
public String cacheClusterStatusString()
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 cacheClusterStatusString()
.
CacheClusterStatus
public 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.
/{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.public 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.
[A-Za-z0-9-._~:/?#&=,]+
.public String documentationVersion()
The version of the associated API documentation.
public Instant createdDate()
The timestamp when the stage was created.
public Instant lastUpdatedDate()
The timestamp when the stage last updated.
public UpdateStageResponse.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateStageResponse.Builder,UpdateStageResponse>
toBuilder
in class AwsResponse
public static UpdateStageResponse.Builder builder()
public static Class<? extends UpdateStageResponse.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkResponse
SdkResponse
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkResponse
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.