software.amazon.awssdk.services.apigatewayv2.model

Class UpdateStageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.apigatewayv2.model.ApiGatewayV2Request

software.amazon.awssdk.services.apigatewayv2.model.UpdateStageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateStageRequest.Builder,UpdateStageRequest>

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

Updates a Stage.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateStageRequest.Builder

Method Summary

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.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

accessLogSettings

public AccessLogSettings accessLogSettings()

Settings for logging access in this stage.

Returns:

Settings for logging access in this stage.

apiId

public String apiId()

The API identifier.

Returns:

The API identifier.

autoDeploy

public Boolean autoDeploy()

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Returns:

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

clientCertificateId

public String clientCertificateId()

The identifier of a client certificate for a Stage.

Returns:

The identifier of a client certificate for a Stage.

defaultRouteSettings

public RouteSettings defaultRouteSettings()

The default route settings for the stage.

Returns:

The default route settings for the stage.

deploymentId

public String deploymentId()

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

Returns:

The deployment identifier for the API stage. Can't be updated if autoDeploy is enabled.

description

public String description()

The description for the API stage.

Returns:

The description for the API stage.

hasRouteSettings

public 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). For responses returned by the SDK, the sender is the AWS service.

routeSettings

public 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.

Returns:

Route settings for the stage.

stageName

public String stageName()

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Returns:

The stage name. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

hasStageVariables

public 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). For responses returned by the SDK, the sender is the AWS service.

stageVariables

public 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.

Returns:

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-._~:/?#&=,]+.

toBuilder

public UpdateStageRequest.Builder 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 interface ToCopyableBuilder<UpdateStageRequest.Builder,UpdateStageRequest>

Specified by:

toBuilder in class ApiGatewayV2Request

Returns:

a builder for type T

builder

public static UpdateStageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateStageRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

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 an 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.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

toString

public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends 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.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.