StringParameterDeclaration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.StringParameterDeclaration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<StringParameterDeclaration.Builder,StringParameterDeclaration>

@Generated(value="software.amazon.awssdk:codegen")
public final class StringParameterDeclaration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<StringParameterDeclaration.Builder,StringParameterDeclaration>

A parameter declaration for the String data type.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface StringParameterDeclaration.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static StringParameterDeclaration.Builder`	`builder()`
`StringDefaultValues`	`defaultValues()` The default values of a parameter.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasMappedDataSetParameters()` For responses, this returns true if the service returned a value for the MappedDataSetParameters property.
`List<MappedDataSetParameter>`	`mappedDataSetParameters()` Returns the value of the MappedDataSetParameters property for this object.
`String`	`name()` The name of the parameter that is being declared.
`ParameterValueType`	`parameterValueType()` The value type determines whether the parameter is a single-value or multi-value parameter.
`String`	`parameterValueTypeAsString()` The value type determines whether the parameter is a single-value or multi-value parameter.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends StringParameterDeclaration.Builder>`	`serializableBuilderClass()`
`StringParameterDeclaration.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`StringValueWhenUnsetConfiguration`	`valueWhenUnset()` The configuration that defines the default value of a `String` parameter when a value has not been set.

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
  - parameterValueType
```
public final ParameterValueType parameterValueType()
```
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    If the service returns an enum value that is not available in the current SDK version, parameterValueType will return ParameterValueType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parameterValueTypeAsString().
    
    Returns:
    
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    See Also:
    
    ParameterValueType
  - parameterValueTypeAsString
```
public final String parameterValueTypeAsString()
```
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    If the service returns an enum value that is not available in the current SDK version, parameterValueType will return ParameterValueType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from parameterValueTypeAsString().
    
    Returns:
    
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    See Also:
    
    ParameterValueType
  - name
```
public final String name()
```
    The name of the parameter that is being declared.
    
    Returns:
    
    The name of the parameter that is being declared.
  - defaultValues
```
public final StringDefaultValues defaultValues()
```
    The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
    
    Returns:
    
    The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
  - valueWhenUnset
```
public final StringValueWhenUnsetConfiguration valueWhenUnset()
```
    The configuration that defines the default value of a String parameter when a value has not been set.
    
    Returns:
    
    The configuration that defines the default value of a String parameter when a value has not been set.
  - hasMappedDataSetParameters
```
public final boolean hasMappedDataSetParameters()
```
    For responses, this returns true if the service returned a value for the MappedDataSetParameters property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() 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.
  - mappedDataSetParameters
```
public final List<MappedDataSetParameter> mappedDataSetParameters()
```
    Returns the value of the MappedDataSetParameters property for this object.
    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 hasMappedDataSetParameters() method.
    
    Returns:
    
    The value of the MappedDataSetParameters property for this object.
  - toBuilder
```
public StringParameterDeclaration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<StringParameterDeclaration.Builder,StringParameterDeclaration>
  - builder
```
public static StringParameterDeclaration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends StringParameterDeclaration.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 StringParameterDeclaration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

parameterValueType

parameterValueTypeAsString

name

defaultValues

valueWhenUnset

hasMappedDataSetParameters

mappedDataSetParameters

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields