Class ActionConnector

java.lang.Object
software.amazon.awssdk.services.quicksight.model.ActionConnector
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ActionConnector.Builder,ActionConnector>
@Generated("software.amazon.awssdk:codegen") public final class ActionConnector extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ActionConnector.Builder,ActionConnector>

Contains detailed information about an action connector, including its configuration, status, and enabled actions.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) of the action connector.

      Returns:
      The Amazon Resource Name (ARN) of the action connector.

    • actionConnectorId

      public final String actionConnectorId()

      The unique identifier of the action connector.

      Returns:
      The unique identifier of the action connector.

    • type

      public final ActionConnectorType type()

      The type of action connector.

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

      Returns:
      The type of action connector.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of action connector.

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

      Returns:
      The type of action connector.
      See Also:

    • name

      public final String name()

      The name of the action connector.

      Returns:
      The name of the action connector.

    • createdTime

      public final Instant createdTime()

      The timestamp when the action connector was created.

      Returns:
      The timestamp when the action connector was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date and time when the action connector was last updated.

      Returns:
      The date and time when the action connector was last updated.

    • status

      public final ResourceStatus status()

      The current status of the action connector.

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

      Returns:
      The current status of the action connector.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the action connector.

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

      Returns:
      The current status of the action connector.
      See Also:

    • error

      public final ActionConnectorError error()

      Error information if the action connector is in an error state.

      Returns:
      Error information if the action connector is in an error state.

    • description

      public final String description()

      The description of the action connector.

      Returns:
      The description of the action connector.

    • authenticationConfig

      public final ReadAuthConfig authenticationConfig()

      The authentication configuration used to connect to the external service.

      Returns:
      The authentication configuration used to connect to the external service.

    • hasEnabledActions

      public final boolean hasEnabledActions()
      For responses, this returns true if the service returned a value for the EnabledActions 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.

    • enabledActions

      public final List<String> enabledActions()

      The list of actions that are enabled for this connector.

      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 hasEnabledActions() method.

      Returns:
      The list of actions that are enabled for this connector.

    • vpcConnectionArn

      public final String vpcConnectionArn()

      The ARN of the VPC connection used for secure connectivity to the external service.

      Returns:
      The ARN of the VPC connection used for secure connectivity to the external service.

    • toBuilder

      public ActionConnector.Builder 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 interface ToCopyableBuilder<ActionConnector.Builder,ActionConnector>
      Returns:
      a builder for type T

    • builder

      public static ActionConnector.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ActionConnector.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)
      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 an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.