@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()
Returns true if the RouteSettings property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
boolean |
hasStageVariables()
Returns true if the StageVariables property was specified by the sender (it may be empty), or false if the sender
did not specify the value (it will be empty).
|
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.
|
overrideConfiguration
copy
public 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()
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.
You can use hasRouteSettings()
to see if a value was sent in this field.
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()
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.
You can use hasStageVariables()
to see if a value was sent in this field.
public UpdateStageRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<UpdateStageRequest.Builder,UpdateStageRequest>
toBuilder
in class ApiGatewayV2Request
public static UpdateStageRequest.Builder builder()
public static Class<? extends UpdateStageRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode
in class AwsRequest
public final boolean equals(Object obj)
equals
in class AwsRequest
public final boolean equalsBySdkFields(Object obj)
SdkPojo
SdkPojo
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 SdkPojo
obj
- the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. 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 SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.