Class Parameter

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

Describes a parameter in a cluster parameter group.

See Also:

  • Method Details

    • parameterName

      public final String parameterName()

      The name of the parameter.

      Returns:
      The name of the parameter.

    • parameterValue

      public final String parameterValue()

      The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

      Returns:
      The value of the parameter. If ParameterName is wlm_json_configuration, then the maximum size of ParameterValue is 8000 characters.

    • description

      public final String description()

      A description of the parameter.

      Returns:
      A description of the parameter.

    • source

      public final String source()

      The source of the parameter value, such as "engine-default" or "user".

      Returns:
      The source of the parameter value, such as "engine-default" or "user".

    • dataType

      public final String dataType()

      The data type of the parameter.

      Returns:
      The data type of the parameter.

    • allowedValues

      public final String allowedValues()

      The valid range of values for the parameter.

      Returns:
      The valid range of values for the parameter.

    • applyType

      public final ParameterApplyType applyType()

      Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

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

      Returns:
      Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
      See Also:

    • applyTypeAsString

      public final String applyTypeAsString()

      Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.

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

      Returns:
      Specifies how to apply the WLM configuration parameter. Some properties can be applied dynamically, while other properties require that any associated clusters be rebooted for the configuration changes to be applied. For more information about parameters and parameter groups, go to Amazon Redshift Parameter Groups in the Amazon Redshift Cluster Management Guide.
      See Also:

    • isModifiable

      public final Boolean isModifiable()

      If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

      Returns:
      If true, the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.

    • minimumEngineVersion

      public final String minimumEngineVersion()

      The earliest engine version to which the parameter can apply.

      Returns:
      The earliest engine version to which the parameter can apply.

    • toBuilder

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

    • builder

      public static Parameter.Builder builder()

    • serializableBuilderClass

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