CreateStageRequest (AWS Java SDK :: Services :: Amazon API Gateway 2.20.133 API)

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.apigateway.model.ApiGatewayRequest
    - - software.amazon.awssdk.services.apigateway.model.CreateStageRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

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

Requests API Gateway to create a Stage resource.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateStageRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateStageRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateStageRequest.Builder`	`builder()`
`Boolean`	`cacheClusterEnabled()` Whether cache clustering is enabled for the stage.
`String`	`cacheClusterSize()` The stage's cache capacity in GB.
`CanarySettings`	`canarySettings()` The canary deployment settings of this stage.
`String`	`deploymentId()` The identifier of the Deployment resource for the Stage resource.
`String`	`description()` The description of the Stage resource.
`String`	`documentationVersion()` The version of the associated API documentation.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()` For responses, this returns true if the service returned a value for the Tags property.
`boolean`	`hasVariables()` For responses, this returns true if the service returned a value for the Variables property.
`String`	`restApiId()` The string identifier of the associated RestApi.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateStageRequest.Builder>`	`serializableBuilderClass()`
`String`	`stageName()` The name for the Stage resource.
`Map<String,String>`	`tags()` The key-value map of strings.
`CreateStageRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Boolean`	`tracingEnabled()` Specifies whether active tracing with X-ray is enabled for the Stage.
`Map<String,String>`	`variables()` A map that defines the stage variables for the new Stage resource.

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

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - restApiId
```
public final String restApiId()
```
    The string identifier of the associated RestApi.
    
    Returns:
    
    The string identifier of the associated RestApi.
  - stageName
```
public final String stageName()
```
    The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
    
    Returns:
    
    The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
  - deploymentId
```
public final String deploymentId()
```
    The identifier of the Deployment resource for the Stage resource.
    
    Returns:
    
    The identifier of the Deployment resource for the Stage resource.
  - description
```
public final String description()
```
    The description of the Stage resource.
    
    Returns:
    
    The description of the Stage resource.
  - cacheClusterEnabled
```
public final Boolean cacheClusterEnabled()
```
    Whether cache clustering is enabled for the stage.
    
    Returns:
    
    Whether cache clustering is enabled for the stage.
  - cacheClusterSize
```
public final String 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 the 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.
  - variables
```
public final Map<String,String> variables()
```
    A map that defines the stage variables for the new Stage resource. 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 new Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.
  - documentationVersion
```
public final String documentationVersion()
```
    The version of the associated API documentation.
    
    Returns:
    
    The version of the associated API documentation.
  - canarySettings
```
public final CanarySettings canarySettings()
```
    The canary deployment settings of this stage.
    
    Returns:
    
    The canary deployment settings of this stage.
  - tracingEnabled
```
public final Boolean 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.
  - 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 the 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.
  - tags
```
public final Map<String,String> tags()
```
    The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
    
    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 key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.
  - toBuilder
```
public CreateStageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayRequest
  - builder
```
public static CreateStageRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateStageRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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 final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateStageRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

restApiId

stageName

deploymentId

description

cacheClusterEnabled

cacheClusterSize

hasVariables

variables

documentationVersion

canarySettings

tracingEnabled

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields