Parameter (AWS Java SDK :: Services :: Amazon RDS 2.16.76 API)

java.lang.Object
- software.amazon.awssdk.services.rds.model.Parameter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Parameter.Builder,Parameter>
```
@Generated(value="software.amazon.awssdk:codegen")
public final class Parameter
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Parameter.Builder,Parameter>
```
This data type is used as a request parameter in the ModifyDBParameterGroup and ResetDBParameterGroup actions.

This data type is used as a response element in the DescribeEngineDefaultParameters and DescribeDBParameters actions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface Parameter.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`Parameter.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`allowedValues()` Specifies the valid range of values for the parameter.
`ApplyMethod`	`applyMethod()` Indicates when to apply parameter updates.
`String`	`applyMethodAsString()` Indicates when to apply parameter updates.
`String`	`applyType()` Specifies the engine specific parameters type.
`static Parameter.Builder`	`builder()`
`String`	`dataType()` Specifies the valid data type for the parameter.
`String`	`description()` Provides a description of the parameter.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasSupportedEngineModes()` Returns true if the SupportedEngineModes 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`	`isModifiable()` Indicates whether (`true`) or not (`false`) the parameter can be modified.
`String`	`minimumEngineVersion()` The earliest engine version to which the parameter can apply.
`String`	`parameterName()` Specifies the name of the parameter.
`String`	`parameterValue()` Specifies the value of the parameter.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Parameter.Builder>`	`serializableBuilderClass()`
`String`	`source()` Indicates the source of the parameter value.
`List<String>`	`supportedEngineModes()` The valid DB engine modes.
`Parameter.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

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
  - parameterName
```
public final String parameterName()
```
    Specifies the name of the parameter.
    
    Returns:
    
    Specifies the name of the parameter.
  - parameterValue
```
public final String parameterValue()
```
    Specifies the value of the parameter.
    
    Returns:
    
    Specifies the value of the parameter.
  - description
```
public final String description()
```
    Provides a description of the parameter.
    
    Returns:
    
    Provides a description of the parameter.
  - source
```
public final String source()
```
    Indicates the source of the parameter value.
    
    Returns:
    
    Indicates the source of the parameter value.
  - applyType
```
public final String applyType()
```
    Specifies the engine specific parameters type.
    
    Returns:
    
    Specifies the engine specific parameters type.
  - dataType
```
public final String dataType()
```
    Specifies the valid data type for the parameter.
    
    Returns:
    
    Specifies the valid data type for the parameter.
  - allowedValues
```
public final String allowedValues()
```
    Specifies the valid range of values for the parameter.
    
    Returns:
    
    Specifies the valid range of values for the parameter.
  - isModifiable
```
public final Boolean isModifiable()
```
    Indicates whether (true) or not (false) the parameter can be modified. Some parameters have security or operational implications that prevent them from being changed.
    
    Returns:
    
    Indicates whether (true) or not (false) 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.
  - applyMethod
```
public final ApplyMethod applyMethod()
```
    Indicates when to apply parameter updates.
    
    If the service returns an enum value that is not available in the current SDK version, applyMethod will return ApplyMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applyMethodAsString().
    
    Returns:
    
    Indicates when to apply parameter updates.
    
    See Also:
    
    ApplyMethod
  - applyMethodAsString
```
public final String applyMethodAsString()
```
    Indicates when to apply parameter updates.
    
    If the service returns an enum value that is not available in the current SDK version, applyMethod will return ApplyMethod.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from applyMethodAsString().
    
    Returns:
    
    Indicates when to apply parameter updates.
    
    See Also:
    
    ApplyMethod
  - hasSupportedEngineModes
```
public final boolean hasSupportedEngineModes()
```
    Returns true if the SupportedEngineModes 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.
  - supportedEngineModes
```
public final List<String> supportedEngineModes()
```
    The valid DB engine modes.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasSupportedEngineModes() to see if a value was sent in this field.
    
    Returns:
    
    The valid DB engine modes.
  - toBuilder
```
public Parameter.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Parameter.Builder,Parameter>
  - 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)
```
    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)
```
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class Parameter

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

parameterName

parameterValue

description

source

applyType

dataType

allowedValues

isModifiable

minimumEngineVersion

applyMethod

applyMethodAsString

hasSupportedEngineModes

supportedEngineModes

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields