Package software.amazon.awssdk.services.quicksight.model

Class DateTimeParameterDeclaration

java.lang.Object

software.amazon.awssdk.services.quicksight.model.DateTimeParameterDeclaration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<DateTimeParameterDeclaration.Builder,DateTimeParameterDeclaration>

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

A parameter declaration for the DateTime data type.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DateTimeParameterDeclaration.Builder

Method Summary

Modifier and Type	Method	Description
static DateTimeParameterDeclaration.Builder	builder()
DateTimeDefaultValues	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.
List<SdkField<?>>	sdkFields()
static Class<? extends DateTimeParameterDeclaration.Builder>	serializableBuilderClass()
TimeGranularity	timeGranularity()	The level of time precision that is used to aggregate DateTime values.
String	timeGranularityAsString()	The level of time precision that is used to aggregate DateTime values.
DateTimeParameterDeclaration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
DateTimeValueWhenUnsetConfiguration	valueWhenUnset()	The configuration that defines the default value of a DateTime 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

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 DateTimeDefaultValues 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.

timeGranularity

public final TimeGranularity timeGranularity()

The level of time precision that is used to aggregate DateTime values.

If the service returns an enum value that is not available in the current SDK version, timeGranularity will return TimeGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeGranularityAsString().

Returns:

The level of time precision that is used to aggregate DateTime values.

See Also:

TimeGranularity

timeGranularityAsString

public final String timeGranularityAsString()

The level of time precision that is used to aggregate DateTime values.

If the service returns an enum value that is not available in the current SDK version, timeGranularity will return TimeGranularity.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from timeGranularityAsString().

Returns:

The level of time precision that is used to aggregate DateTime values.

See Also:

TimeGranularity

valueWhenUnset

public final DateTimeValueWhenUnsetConfiguration valueWhenUnset()

The configuration that defines the default value of a DateTime parameter when a value has not been set.

Returns:

The configuration that defines the default value of a DateTime 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 DateTimeParameterDeclaration.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DateTimeParameterDeclaration.Builder,DateTimeParameterDeclaration>

builder

public static DateTimeParameterDeclaration.Builder builder()

serializableBuilderClass

public static Class<? extends DateTimeParameterDeclaration.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