Class QPluginCard

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

A card in an Q App that integrates with a third-party plugin or service.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier of the plugin card.

      Returns:
      The unique identifier of the plugin card.

    • title

      public final String title()

      The title or label of the plugin card.

      Returns:
      The title or label of the plugin card.

    • hasDependencies

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

    • dependencies

      public final List<String> dependencies()

      Any dependencies or requirements for the plugin card.

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

      Returns:
      Any dependencies or requirements for the plugin card.

    • type

      public final CardType type()

      The type of the card.

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

      Returns:
      The type of the card.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the card.

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

      Returns:
      The type of the card.
      See Also:

    • prompt

      public final String prompt()

      The prompt or instructions displayed for the plugin card.

      Returns:
      The prompt or instructions displayed for the plugin card.

    • pluginType

      public final PluginType pluginType()

      The type or category of the plugin used by the card.

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

      Returns:
      The type or category of the plugin used by the card.
      See Also:

    • pluginTypeAsString

      public final String pluginTypeAsString()

      The type or category of the plugin used by the card.

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

      Returns:
      The type or category of the plugin used by the card.
      See Also:

    • pluginId

      public final String pluginId()

      The unique identifier of the plugin used by the card.

      Returns:
      The unique identifier of the plugin used by the card.

    • actionIdentifier

      public final String actionIdentifier()

      The action identifier of the action to be performed by the plugin card.

      Returns:
      The action identifier of the action to be performed by the plugin card.

    • toBuilder

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

    • builder

      public static QPluginCard.Builder builder()

    • serializableBuilderClass

      public static Class<? extends QPluginCard.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.