Class CreateStageRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateStageRequest.Builder,
CreateStageRequest>
Creates a new Stage resource to represent a stage.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal AccessLogSettings
Settings for logging access in this stage.final String
apiId()
The API identifier.final Boolean
Specifies whether updates to an API automatically trigger a new deployment.static CreateStageRequest.Builder
builder()
final String
The identifier of a client certificate for a Stage.final RouteSettings
The default route settings for the stage.final String
The deployment identifier of the API stage.final String
The description for the API stage.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) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the RouteSettings property.final boolean
For responses, this returns true if the service returned a value for the StageVariables property.final boolean
hasTags()
For responses, this returns true if the service returned a value for the Tags property.final Map
<String, RouteSettings> Route settings for the stage, by routeKey.static Class
<? extends CreateStageRequest.Builder> final String
The name of the stage.A map that defines the stage variables for a Stage.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.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
accessLogSettings
Settings for logging access in this stage.
- Returns:
- Settings for logging access in this stage.
-
apiId
The API identifier.
- Returns:
- The API identifier.
-
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
The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
- Returns:
- The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.
-
defaultRouteSettings
The default route settings for the stage.
- Returns:
- The default route settings for the stage.
-
deploymentId
The deployment identifier of the API stage.
- Returns:
- The deployment identifier of the API stage.
-
description
The description for the API stage.
- Returns:
- The description for the API stage.
-
hasRouteSettings
public final boolean hasRouteSettings()For responses, this returns true if the service returned a value for the RouteSettings 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. -
routeSettings
Route settings for the stage, by routeKey.
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.- Returns:
- Route settings for the stage, by routeKey.
-
stageName
The name of the stage.
- Returns:
- The name of the stage.
-
hasStageVariables
public final boolean hasStageVariables()For responses, this returns true if the service returned a value for the StageVariables 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. -
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.- 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-._~:/?#&=,]+.
-
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.
-
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<CreateStageRequest.Builder,
CreateStageRequest> - Specified by:
toBuilder
in classApiGatewayV2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. 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, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- 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
-