Class DateTimeParameterDeclaration
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DateTimeParameterDeclaration.Builder,
DateTimeParameterDeclaration>
A parameter declaration for the DateTime
data type.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
final DateTimeDefaultValues
The default values of a parameter.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the MappedDataSetParameters property.final List
<MappedDataSetParameter> Returns the value of the MappedDataSetParameters property for this object.final String
name()
The name of the parameter that is being declared.static Class
<? extends DateTimeParameterDeclaration.Builder> final TimeGranularity
The level of time precision that is used to aggregateDateTime
values.final String
The level of time precision that is used to aggregateDateTime
values.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.The configuration that defines the default value of aDateTime
parameter when a value has not been set.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
name
The name of the parameter that is being declared.
- Returns:
- The name of the parameter that is being declared.
-
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
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 returnTimeGranularity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimeGranularityAsString()
.- Returns:
- The level of time precision that is used to aggregate
DateTime
values. - See Also:
-
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 returnTimeGranularity.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtimeGranularityAsString()
.- Returns:
- The level of time precision that is used to aggregate
DateTime
values. - See Also:
-
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 theisEmpty()
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
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
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 interfaceToCopyableBuilder<DateTimeParameterDeclaration.Builder,
DateTimeParameterDeclaration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-