Class DataLabelOptions
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<DataLabelOptions.Builder,
DataLabelOptions>
The options that determine the presentation of the data labels.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic DataLabelOptions.Builder
builder()
final Visibility
Determines the visibility of the category field labels.final String
Determines the visibility of the category field labels.final List
<DataLabelType> The option that determines the data label type.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 boolean
For responses, this returns true if the service returned a value for the DataLabelTypes property.final int
hashCode()
final String
Determines the color of the data labels.final DataLabelContent
Determines the content of the data labels.final String
Determines the content of the data labels.final FontConfiguration
Determines the font configuration of the data labels.final Visibility
Determines the visibility of the measure field labels.final String
Determines the visibility of the measure field labels.final DataLabelOverlap
overlap()
Determines whether overlap is enabled or disabled for the data labels.final String
Determines whether overlap is enabled or disabled for the data labels.final DataLabelPosition
position()
Determines the position of the data labels.final String
Determines the position of the data labels.static Class
<? extends DataLabelOptions.Builder> 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.final Visibility
Determines the visibility of the total.final String
Determines the visibility of the total.final Visibility
Determines the visibility of the data labels.final String
Determines the visibility of the data labels.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
visibility
Determines the visibility of the data labels.
If the service returns an enum value that is not available in the current SDK version,
visibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- Returns:
- Determines the visibility of the data labels.
- See Also:
-
visibilityAsString
Determines the visibility of the data labels.
If the service returns an enum value that is not available in the current SDK version,
visibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromvisibilityAsString()
.- Returns:
- Determines the visibility of the data labels.
- See Also:
-
categoryLabelVisibility
Determines the visibility of the category field labels.
If the service returns an enum value that is not available in the current SDK version,
categoryLabelVisibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryLabelVisibilityAsString()
.- Returns:
- Determines the visibility of the category field labels.
- See Also:
-
categoryLabelVisibilityAsString
Determines the visibility of the category field labels.
If the service returns an enum value that is not available in the current SDK version,
categoryLabelVisibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromcategoryLabelVisibilityAsString()
.- Returns:
- Determines the visibility of the category field labels.
- See Also:
-
measureLabelVisibility
Determines the visibility of the measure field labels.
If the service returns an enum value that is not available in the current SDK version,
measureLabelVisibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommeasureLabelVisibilityAsString()
.- Returns:
- Determines the visibility of the measure field labels.
- See Also:
-
measureLabelVisibilityAsString
Determines the visibility of the measure field labels.
If the service returns an enum value that is not available in the current SDK version,
measureLabelVisibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frommeasureLabelVisibilityAsString()
.- Returns:
- Determines the visibility of the measure field labels.
- See Also:
-
hasDataLabelTypes
public final boolean hasDataLabelTypes()For responses, this returns true if the service returned a value for the DataLabelTypes 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. -
dataLabelTypes
The option that determines the data label type.
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
hasDataLabelTypes()
method.- Returns:
- The option that determines the data label type.
-
position
Determines the position of the data labels.
If the service returns an enum value that is not available in the current SDK version,
position
will returnDataLabelPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompositionAsString()
.- Returns:
- Determines the position of the data labels.
- See Also:
-
positionAsString
Determines the position of the data labels.
If the service returns an enum value that is not available in the current SDK version,
position
will returnDataLabelPosition.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frompositionAsString()
.- Returns:
- Determines the position of the data labels.
- See Also:
-
labelContent
Determines the content of the data labels.
If the service returns an enum value that is not available in the current SDK version,
labelContent
will returnDataLabelContent.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlabelContentAsString()
.- Returns:
- Determines the content of the data labels.
- See Also:
-
labelContentAsString
Determines the content of the data labels.
If the service returns an enum value that is not available in the current SDK version,
labelContent
will returnDataLabelContent.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromlabelContentAsString()
.- Returns:
- Determines the content of the data labels.
- See Also:
-
labelFontConfiguration
Determines the font configuration of the data labels.
- Returns:
- Determines the font configuration of the data labels.
-
labelColor
Determines the color of the data labels.
- Returns:
- Determines the color of the data labels.
-
overlap
Determines whether overlap is enabled or disabled for the data labels.
If the service returns an enum value that is not available in the current SDK version,
overlap
will returnDataLabelOverlap.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoverlapAsString()
.- Returns:
- Determines whether overlap is enabled or disabled for the data labels.
- See Also:
-
overlapAsString
Determines whether overlap is enabled or disabled for the data labels.
If the service returns an enum value that is not available in the current SDK version,
overlap
will returnDataLabelOverlap.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromoverlapAsString()
.- Returns:
- Determines whether overlap is enabled or disabled for the data labels.
- See Also:
-
totalsVisibility
Determines the visibility of the total.
If the service returns an enum value that is not available in the current SDK version,
totalsVisibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtotalsVisibilityAsString()
.- Returns:
- Determines the visibility of the total.
- See Also:
-
totalsVisibilityAsString
Determines the visibility of the total.
If the service returns an enum value that is not available in the current SDK version,
totalsVisibility
will returnVisibility.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtotalsVisibilityAsString()
.- Returns:
- Determines the visibility of the total.
- See Also:
-
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<DataLabelOptions.Builder,
DataLabelOptions> - 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
-