Class Parameter
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
Specifies the valid range of values for the parameter.final ApplyMethod
Indicates when to apply parameter updates.final String
Indicates when to apply parameter updates.final String
Specifies the engine specific parameters type.static Parameter.Builder
builder()
final String
dataType()
Specifies the valid data type for the parameter.final String
Provides a description of the parameter.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupportedEngineModes property.final Boolean
Indicates whether (true
) or not (false
) the parameter can be modified.final String
The earliest engine version to which the parameter can apply.final String
The name of the parameter.final String
The value of the parameter.static Class
<? extends Parameter.Builder> final String
source()
The source of the parameter value.The valid DB engine modes.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
parameterName
The name of the parameter.
- Returns:
- The name of the parameter.
-
parameterValue
The value of the parameter.
- Returns:
- The value of the parameter.
-
description
Provides a description of the parameter.
- Returns:
- Provides a description of the parameter.
-
source
The source of the parameter value.
- Returns:
- The source of the parameter value.
-
applyType
Specifies the engine specific parameters type.
- Returns:
- Specifies the engine specific parameters type.
-
dataType
Specifies the valid data type for the parameter.
- Returns:
- Specifies the valid data type for the parameter.
-
allowedValues
Specifies the valid range of values for the parameter.
- Returns:
- Specifies the valid range of values for the parameter.
-
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
The earliest engine version to which the parameter can apply.
- Returns:
- The earliest engine version to which the parameter can apply.
-
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 returnApplyMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapplyMethodAsString()
.- Returns:
- Indicates when to apply parameter updates.
- See Also:
-
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 returnApplyMethod.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapplyMethodAsString()
.- Returns:
- Indicates when to apply parameter updates.
- See Also:
-
hasSupportedEngineModes
public final boolean hasSupportedEngineModes()For responses, this returns true if the service returned a value for the SupportedEngineModes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supportedEngineModes
The valid DB engine modes.
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
hasSupportedEngineModes()
method.- Returns:
- The valid DB engine modes.
-
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 interfaceToCopyableBuilder<Parameter.Builder,
Parameter> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-