Package software.amazon.awssdk.services.apigateway.model

Class CreateStageRequest

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("software.amazon.awssdk:codegen") public final class CreateStageRequest extends ApiGatewayRequest implements ToCopyableBuilder<CreateStageRequest.Builder,CreateStageRequest>

Requests API Gateway to create a Stage resource.

  • Method Details

    • 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()
      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<CreateStageRequest.Builder,CreateStageRequest>
      Specified by:
      toBuilder in class ApiGatewayRequest
      Returns:
      a builder for type T

    • 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)
      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 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)
      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 final 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.