Package software.amazon.awssdk.services.appconfig.model

Class StartDeploymentRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.appconfig.model.AppConfigRequest
software.amazon.awssdk.services.appconfig.model.StartDeploymentRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<StartDeploymentRequest.Builder,StartDeploymentRequest>
@Generated("software.amazon.awssdk:codegen") public final class StartDeploymentRequest extends AppConfigRequest implements ToCopyableBuilder<StartDeploymentRequest.Builder,StartDeploymentRequest>

  • Method Details

    • applicationId

      public final String applicationId()

      The application ID.

      Returns:
      The application ID.

    • environmentId

      public final String environmentId()

      The environment ID.

      Returns:
      The environment ID.

    • deploymentStrategyId

      public final String deploymentStrategyId()

      The deployment strategy ID.

      Returns:
      The deployment strategy ID.

    • configurationProfileId

      public final String configurationProfileId()

      The configuration profile ID.

      Returns:
      The configuration profile ID.

    • configurationVersion

      public final String configurationVersion()

      The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

      Returns:
      The configuration version to deploy. If deploying an AppConfig hosted configuration version, you can specify either the version number or version label. For all other configurations, you must specify the version number.

    • description

      public final String description()

      A description of the deployment.

      Returns:
      A description of the deployment.

    • 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()

      Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

      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:
      Metadata to assign to the deployment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

    • kmsKeyIdentifier

      public final String kmsKeyIdentifier()

      The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

      Returns:
      The KMS key identifier (key ID, key alias, or key ARN). AppConfig uses this ID to encrypt the configuration data using a customer managed key.

    • hasDynamicExtensionParameters

      public final boolean hasDynamicExtensionParameters()
      For responses, this returns true if the service returned a value for the DynamicExtensionParameters 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.

    • dynamicExtensionParameters

      public final Map<String,String> dynamicExtensionParameters()

      A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

      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 hasDynamicExtensionParameters() method.

      Returns:
      A map of dynamic extension parameter names to values to pass to associated extensions with PRE_START_DEPLOYMENT actions.

    • toBuilder

      public StartDeploymentRequest.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<StartDeploymentRequest.Builder,StartDeploymentRequest>
      Specified by:
      toBuilder in class AppConfigRequest
      Returns:
      a builder for type T

    • builder

      public static StartDeploymentRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends StartDeploymentRequest.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.