Class CreateDeploymentRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateDeploymentRequest.Builder,
CreateDeploymentRequest>
Requests API Gateway to create a Deployment resource.
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final Boolean
Enables a cache cluster for the Stage resource specified in the input.final String
The stage's cache capacity in GB.final DeploymentCanarySettings
The input configuration for the canary deployment when the deployment is a canary release deployment.final String
The description for the Deployment resource to create.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 Variables property.final String
The string identifier of the associated RestApi.static Class
<? extends CreateDeploymentRequest.Builder> final String
The description of the Stage resource for the Deployment resource to create.final String
The name of the Stage resource for the Deployment resource to create.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.final Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.A map that defines the stage variables for the Stage resource that is associated with the new deployment.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
restApiId
The string identifier of the associated RestApi.
- Returns:
- The string identifier of the associated RestApi.
-
stageName
The name of the Stage resource for the Deployment resource to create.
- Returns:
- The name of the Stage resource for the Deployment resource to create.
-
stageDescription
The description of the Stage resource for the Deployment resource to create.
- Returns:
- The description of the Stage resource for the Deployment resource to create.
-
description
The description for the Deployment resource to create.
- Returns:
- The description for the Deployment resource to create.
-
cacheClusterEnabled
Enables a cache cluster for the Stage resource specified in the input.
- Returns:
- Enables a cache cluster for the Stage resource specified in the input.
-
cacheClusterSize
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
- Returns:
- The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
-
hasVariables
public final boolean hasVariables()For responses, this returns true if the service returned a value for the Variables 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. -
variables
A map that defines the stage variables for the Stage resource that is associated with the new deployment. 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
hasVariables()
method.- Returns:
- A map that defines the stage variables for the Stage resource that is associated with the new deployment.
Variable names can have alphanumeric and underscore characters, and the values must match
[A-Za-z0-9-._~:/?#&=,]+
.
-
canarySettings
The input configuration for the canary deployment when the deployment is a canary release deployment.
- Returns:
- The input configuration for the canary deployment when the deployment is a canary release deployment.
-
tracingEnabled
Specifies whether active tracing with X-ray is enabled for the Stage.
- Returns:
- Specifies whether active tracing with X-ray is enabled for the Stage.
-
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<CreateDeploymentRequest.Builder,
CreateDeploymentRequest> - Specified by:
toBuilder
in classApiGatewayRequest
- 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
-