@Generated(value="software.amazon.awssdk:codegen") public final class UpdateStageRequest extends ApiGatewayV2Request implements ToCopyableBuilder<UpdateStageRequest.Builder,UpdateStageRequest>
Updates a Stage.
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateStageRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
AccessLogSettings |
accessLogSettings()
Settings for logging access in this stage.
|
String |
apiId()
The API identifier.
|
Boolean |
autoDeploy()
Specifies whether updates to an API automatically trigger a new deployment.
|
static UpdateStageRequest.Builder |
builder() |
String |
clientCertificateId()
The identifier of a client certificate for a Stage.
|
RouteSettings |
defaultRouteSettings()
The default route settings for the stage.
|
String |
deploymentId()
The deployment identifier for the API stage.
|
String |
description()
The description for the API stage.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
int |
hashCode() |
boolean |
hasRouteSettings()
For responses, this returns true if the service returned a value for the RouteSettings property.
|
boolean |
hasStageVariables()
For responses, this returns true if the service returned a value for the StageVariables property.
|
Map<String,RouteSettings> |
routeSettings()
Route settings for the stage.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateStageRequest.Builder> |
serializableBuilderClass() |
String |
stageName()
The stage name.
|
Map<String,String> |
stageVariables()
A map that defines the stage variables for a Stage.
|
UpdateStageRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationcopypublic final AccessLogSettings accessLogSettings()
Settings for logging access in this stage.
public final String apiId()
The API identifier.
public final Boolean autoDeploy()
Specifies whether updates to an API automatically trigger a new deployment. The default value is false.
public final String clientCertificateId()
The identifier of a client certificate for a Stage.
public final RouteSettings defaultRouteSettings()
The default route settings for the stage.
public final String deploymentId()
The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.
public final String description()
The description for the API stage.
public final boolean hasRouteSettings()
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.public final Map<String,RouteSettings> routeSettings()
Route 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 hasRouteSettings() method.
public final String stageName()
The stage name. Stage names can contain only alphanumeric characters, hyphens, and underscores, or be $default. Maximum length is 128 characters.
public final boolean hasStageVariables()
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.public final Map<String,String> stageVariables()
A map that defines the stage variables for a Stage. 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 hasStageVariables() method.
public UpdateStageRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<UpdateStageRequest.Builder,UpdateStageRequest>toBuilder in class ApiGatewayV2Requestpublic static UpdateStageRequest.Builder builder()
public static Class<? extends UpdateStageRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo class,
and is generated based on a service model.
If an SdkPojo class does not have any inherited fields, equalsBySdkFields
and equals are essentially the same.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. 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 SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.