StringParameterDeclaration (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.quicksight.model.StringParameterDeclaration

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class StringParameterDeclaration
extends Object
implements Serializable, Cloneable, StructuredPojo

A parameter declaration for the String data type.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

StringParameterDeclaration()

Constructors
Constructor and Description
`StringParameterDeclaration()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`StringParameterDeclaration`	`clone()`
`boolean`	`equals(Object obj)`
`StringDefaultValues`	`getDefaultValues()` The default values of a parameter.
`String`	`getName()` The name of the parameter that is being declared.
`String`	`getParameterValueType()` The value type determines whether the parameter is a single-value or multi-value parameter.
`StringValueWhenUnsetConfiguration`	`getValueWhenUnset()` The configuration that defines the default value of a `String` parameter when a value has not been set.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setDefaultValues(StringDefaultValues defaultValues)` The default values of a parameter.
`void`	`setName(String name)` The name of the parameter that is being declared.
`void`	`setParameterValueType(String parameterValueType)` The value type determines whether the parameter is a single-value or multi-value parameter.
`void`	`setValueWhenUnset(StringValueWhenUnsetConfiguration valueWhenUnset)` The configuration that defines the default value of a `String` parameter when a value has not been set.
`String`	`toString()` Returns a string representation of this object.
`StringParameterDeclaration`	`withDefaultValues(StringDefaultValues defaultValues)` The default values of a parameter.
`StringParameterDeclaration`	`withName(String name)` The name of the parameter that is being declared.
`StringParameterDeclaration`	`withParameterValueType(ParameterValueType parameterValueType)` The value type determines whether the parameter is a single-value or multi-value parameter.
`StringParameterDeclaration`	`withParameterValueType(String parameterValueType)` The value type determines whether the parameter is a single-value or multi-value parameter.
`StringParameterDeclaration`	`withValueWhenUnset(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
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - StringParameterDeclaration
```
public StringParameterDeclaration()
```
- Method Detail
  - setParameterValueType
```
public void setParameterValueType(String parameterValueType)
```
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    Parameters:
    
    parameterValueType - The value type determines whether the parameter is a single-value or multi-value parameter.
    
    See Also:
    
    ParameterValueType
  - getParameterValueType
```
public String getParameterValueType()
```
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    Returns:
    
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    See Also:
    
    ParameterValueType
  - withParameterValueType
```
public StringParameterDeclaration withParameterValueType(String parameterValueType)
```
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    Parameters:
    
    parameterValueType - The value type determines whether the parameter is a single-value or multi-value parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterValueType
  - withParameterValueType
```
public StringParameterDeclaration withParameterValueType(ParameterValueType parameterValueType)
```
    The value type determines whether the parameter is a single-value or multi-value parameter.
    
    Parameters:
    
    parameterValueType - The value type determines whether the parameter is a single-value or multi-value parameter.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    ParameterValueType
  - setName
```
public void setName(String name)
```
    The name of the parameter that is being declared.
    
    Parameters:
    
    name - The name of the parameter that is being declared.
  - getName
```
public String getName()
```
    The name of the parameter that is being declared.
    
    Returns:
    
    The name of the parameter that is being declared.
  - withName
```
public StringParameterDeclaration withName(String name)
```
    The name of the parameter that is being declared.
    
    Parameters:
    
    name - The name of the parameter that is being declared.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDefaultValues
```
public void setDefaultValues(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.
    
    Parameters:
    
    defaultValues - The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
  - getDefaultValues
```
public StringDefaultValues getDefaultValues()
```
    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.
  - withDefaultValues
```
public StringParameterDeclaration withDefaultValues(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setValueWhenUnset
```
public void setValueWhenUnset(StringValueWhenUnsetConfiguration valueWhenUnset)
```
    The configuration that defines the default value of a String parameter when a value has not been set.
    
    Parameters:
    
    valueWhenUnset - The configuration that defines the default value of a String parameter when a value has not been set.
  - getValueWhenUnset
```
public StringValueWhenUnsetConfiguration getValueWhenUnset()
```
    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.
  - withValueWhenUnset
```
public StringParameterDeclaration withValueWhenUnset(StringValueWhenUnsetConfiguration valueWhenUnset)
```
    The configuration that defines the default value of a String parameter when a value has not been set.
    
    Parameters:
    
    valueWhenUnset - The configuration that defines the default value of a String parameter when a value has not been set.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public StringParameterDeclaration clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

Did this page help you?

Class StringParameterDeclaration

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

StringParameterDeclaration

Method Detail

setParameterValueType

getParameterValueType

withParameterValueType

withParameterValueType

setName

getName

withName

setDefaultValues

getDefaultValues

withDefaultValues

setValueWhenUnset

getValueWhenUnset

withValueWhenUnset

toString

equals

hashCode

clone

marshall