Parameter (AWS SDK for Java

java.lang.Object
- software.amazon.awssdk.services.neptune.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>

Specifies a parameter.

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)` 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.

Methods inherited from class java.lang.Object
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
  - 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.

AWS SDK for Java API Reference - 2.17.43

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

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields