Class LayerCustomAction
- java.lang.Object
-
- software.amazon.awssdk.services.quicksight.model.LayerCustomAction
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<LayerCustomAction.Builder,LayerCustomAction>
@Generated("software.amazon.awssdk:codegen") public final class LayerCustomAction extends Object implements SdkPojo, Serializable, ToCopyableBuilder<LayerCustomAction.Builder,LayerCustomAction>
A layer custom action.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceLayerCustomAction.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<LayerCustomActionOperation>actionOperations()A list ofLayerCustomActionOperations.static LayerCustomAction.Builderbuilder()StringcustomActionId()The ID of the custom action.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasActionOperations()For responses, this returns true if the service returned a value for the ActionOperations property.inthashCode()Stringname()The name of the custom action.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends LayerCustomAction.Builder>serializableBuilderClass()WidgetStatusstatus()The status of theLayerCustomAction.StringstatusAsString()The status of theLayerCustomAction.LayerCustomAction.BuildertoBuilder()StringtoString()Returns a string representation of this object.LayerCustomActionTriggertrigger()The trigger of theLayerCustomAction.StringtriggerAsString()The trigger of theLayerCustomAction.-
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
-
customActionId
public final String customActionId()
The ID of the custom action.
- Returns:
- The ID of the custom action.
-
name
public final String name()
The name of the custom action.
- Returns:
- The name of the custom action.
-
status
public final WidgetStatus status()
The status of the
LayerCustomAction.If the service returns an enum value that is not available in the current SDK version,
statuswill returnWidgetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the
LayerCustomAction. - See Also:
WidgetStatus
-
statusAsString
public final String statusAsString()
The status of the
LayerCustomAction.If the service returns an enum value that is not available in the current SDK version,
statuswill returnWidgetStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the
LayerCustomAction. - See Also:
WidgetStatus
-
trigger
public final LayerCustomActionTrigger trigger()
The trigger of the
LayerCustomAction.Valid values are defined as follows:
-
DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point. -
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
If the service returns an enum value that is not available in the current SDK version,
triggerwill returnLayerCustomActionTrigger.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtriggerAsString().- Returns:
- The trigger of the
LayerCustomAction.Valid values are defined as follows:
-
DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point. -
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
-
- See Also:
LayerCustomActionTrigger
-
-
triggerAsString
public final String triggerAsString()
The trigger of the
LayerCustomAction.Valid values are defined as follows:
-
DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point. -
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
If the service returns an enum value that is not available in the current SDK version,
triggerwill returnLayerCustomActionTrigger.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromtriggerAsString().- Returns:
- The trigger of the
LayerCustomAction.Valid values are defined as follows:
-
DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point. -
DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
-
- See Also:
LayerCustomActionTrigger
-
-
hasActionOperations
public final boolean hasActionOperations()
For responses, this returns true if the service returned a value for the ActionOperations 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.
-
actionOperations
public final List<LayerCustomActionOperation> actionOperations()
A list of
LayerCustomActionOperations.This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
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
hasActionOperations()method.- Returns:
- A list of
LayerCustomActionOperations.This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
-
toBuilder
public LayerCustomAction.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<LayerCustomAction.Builder,LayerCustomAction>
-
builder
public static LayerCustomAction.Builder builder()
-
serializableBuilderClass
public static Class<? extends LayerCustomAction.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-