CreateStageRequest (AWS Java SDK :: Services

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

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

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

Creates a new Stage resource to represent a stage.

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
`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 CreateStageRequest.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 of the API stage.
`String`	`description()` The description for the API stage.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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).
`boolean`	`hasTags()` Returns true if the Tags 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, by routeKey.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateStageRequest.Builder>`	`serializableBuilderClass()`
`String`	`stageName()` The name of the stage.
`Map<String,String>`	`stageVariables()` A map that defines the stage variables for a Stage.
`Map<String,String>`	`tags()` The collection of tags.
`CreateStageRequest.Builder`	`toBuilder()`
`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
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

- Method Detail
  - accessLogSettings
```
public final AccessLogSettings accessLogSettings()
```
    Settings for logging access in this stage.
    
    Returns:
    
    Settings for logging access in this stage.
  - apiId
```
public final String apiId()
```
    The API identifier.
    
    Returns:
    
    The API identifier.
  - autoDeploy
```
public final 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 final String 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
```
public final RouteSettings defaultRouteSettings()
```
    The default route settings for the stage.
    
    Returns:
    
    The default route settings for the stage.
  - deploymentId
```
public final String deploymentId()
```
    The deployment identifier of the API stage.
    
    Returns:
    
    The deployment identifier of the API stage.
  - description
```
public final String description()
```
    The description for the API stage.
    
    Returns:
    
    The description for the API stage.
  - hasRouteSettings
```
public final 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 final Map<String,RouteSettings> routeSettings()
```
    Route settings for the stage, by routeKey.
    
    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, by routeKey.
  - stageName
```
public final String stageName()
```
    The name of the stage.
    
    Returns:
    
    The name of the stage.
  - hasStageVariables
```
public final 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 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.
    
    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()
```
    Returns true if the Tags 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.
  - tags
```
public final Map<String,String> 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.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    The collection of tags. Each tag element is associated with a given resource.
  - toBuilder
```
public CreateStageRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>
    
    Specified by:
    
    toBuilder in class ApiGatewayV2Request
  - 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

accessLogSettings

apiId

autoDeploy

clientCertificateId

defaultRouteSettings

deploymentId

description

hasRouteSettings

routeSettings

stageName

hasStageVariables

stageVariables

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields