@Generated(value="software.amazon.awssdk:codegen") public final class Parameter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Parameter.Builder,Parameter>
Specifies a parameter.
Modifier and Type | Class and Description |
---|---|
static interface |
Parameter.Builder |
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)
Indicates whether some other object is "equal to" this one by SDK fields.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
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.
|
Parameter.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString()
Returns a string representation of this object.
|
copy
public final String parameterName()
Specifies the name of the parameter.
public final String parameterValue()
Specifies the value of the parameter.
public final String description()
Provides a description of the parameter.
public final String source()
Indicates the source of the parameter value.
public final String applyType()
Specifies the engine specific parameters type.
public final String dataType()
Specifies the valid data type for the parameter.
public final String allowedValues()
Specifies the valid range of values for the parameter.
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.
true
) or not (false
) the parameter can be modified. Some
parameters have security or operational implications that prevent them from being changed.public final String minimumEngineVersion()
The earliest engine version to which the parameter can apply.
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()
.
ApplyMethod
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()
.
ApplyMethod
public Parameter.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<Parameter.Builder,Parameter>
public static Parameter.Builder builder()
public static Class<? extends Parameter.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
SdkPojo
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.
equalsBySdkFields
in interface SdkPojo
obj
- the object to be compared withpublic final String toString()
Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.