Class KxClusterCodeDeploymentConfiguration

java.lang.Object
software.amazon.awssdk.services.finspace.model.KxClusterCodeDeploymentConfiguration
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<KxClusterCodeDeploymentConfiguration.Builder,KxClusterCodeDeploymentConfiguration>
@Generated("software.amazon.awssdk:codegen") public final class KxClusterCodeDeploymentConfiguration extends Object implements SdkPojo, Serializable, ToCopyableBuilder<KxClusterCodeDeploymentConfiguration.Builder,KxClusterCodeDeploymentConfiguration>

The configuration that allows you to choose how you want to update code on a cluster. Depending on the option you choose, you can reduce the time it takes to update the cluster.

See Also:

  • Method Details

    • deploymentStrategy

      public final KxClusterCodeDeploymentStrategy deploymentStrategy()

      The type of deployment that you want on a cluster.

      • ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.

      • NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for GP type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.

        With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.

      • FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.

      If the service returns an enum value that is not available in the current SDK version, deploymentStrategy will return KxClusterCodeDeploymentStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentStrategyAsString().

      Returns:
      The type of deployment that you want on a cluster.

      • ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.

      • NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for GP type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.

        With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.

      • FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.

      See Also:

    • deploymentStrategyAsString

      public final String deploymentStrategyAsString()

      The type of deployment that you want on a cluster.

      • ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.

      • NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for GP type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.

        With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.

      • FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.

      If the service returns an enum value that is not available in the current SDK version, deploymentStrategy will return KxClusterCodeDeploymentStrategy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from deploymentStrategyAsString().

      Returns:
      The type of deployment that you want on a cluster.

      • ROLLING – This options updates the cluster by stopping the exiting q process and starting a new q process with updated configuration.

      • NO_RESTART – This option updates the cluster without stopping the running q process. It is only available for GP type cluster. This option is quicker as it reduces the turn around time to update configuration on a cluster.

        With this deployment mode, you cannot update the initializationScript and commandLineArguments parameters.

      • FORCE – This option updates the cluster by immediately stopping all the running processes before starting up new ones with the updated configuration.

      See Also:

    • toBuilder

      public KxClusterCodeDeploymentConfiguration.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<KxClusterCodeDeploymentConfiguration.Builder,KxClusterCodeDeploymentConfiguration>
      Returns:
      a builder for type T

    • builder

      public static KxClusterCodeDeploymentConfiguration.Builder builder()

    • serializableBuilderClass

      public static Class<? extends KxClusterCodeDeploymentConfiguration.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

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

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.