Class VisualCustomAction
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<VisualCustomAction.Builder,
VisualCustomAction>
A custom action defined on a visual.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionfinal List
<VisualCustomActionOperation> A list ofVisualCustomActionOperations
.static VisualCustomAction.Builder
builder()
final String
The ID of theVisualCustomAction
.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 ActionOperations property.final int
hashCode()
final String
name()
The name of theVisualCustomAction
.static Class
<? extends VisualCustomAction.Builder> final WidgetStatus
status()
The status of theVisualCustomAction
.final String
The status of theVisualCustomAction
.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.trigger()
The trigger of theVisualCustomAction
.final String
The trigger of theVisualCustomAction
.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
customActionId
The ID of the
VisualCustomAction
.- Returns:
- The ID of the
VisualCustomAction
.
-
name
The name of the
VisualCustomAction
.- Returns:
- The name of the
VisualCustomAction
.
-
status
The status of the
VisualCustomAction
.If the service returns an enum value that is not available in the current SDK version,
status
will returnWidgetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the
VisualCustomAction
. - See Also:
-
statusAsString
The status of the
VisualCustomAction
.If the service returns an enum value that is not available in the current SDK version,
status
will returnWidgetStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromstatusAsString()
.- Returns:
- The status of the
VisualCustomAction
. - See Also:
-
trigger
The trigger of the
VisualCustomAction
.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,
trigger
will returnVisualCustomActionTrigger.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtriggerAsString()
.- Returns:
- The trigger of the
VisualCustomAction
.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:
-
-
triggerAsString
The trigger of the
VisualCustomAction
.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,
trigger
will returnVisualCustomActionTrigger.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromtriggerAsString()
.- Returns:
- The trigger of the
VisualCustomAction
.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:
-
-
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
A list of
VisualCustomActionOperations
.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
VisualCustomActionOperations
.This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
-
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<VisualCustomAction.Builder,
VisualCustomAction> - 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
-