Class Plugin

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

Information about an Amazon Q Business plugin and its configuration.

See Also:

  • Method Details

    • pluginId

      public final String pluginId()

      The identifier of the plugin.

      Returns:
      The identifier of the plugin.

    • displayName

      public final String displayName()

      The name of the plugin.

      Returns:
      The name of the plugin.

    • type

      public final PluginType type()

      The type of the plugin.

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

      Returns:
      The type of the plugin.
      See Also:

    • typeAsString

      public final String typeAsString()

      The type of the plugin.

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

      Returns:
      The type of the plugin.
      See Also:

    • serverUrl

      public final String serverUrl()

      The plugin server URL used for configuration.

      Returns:
      The plugin server URL used for configuration.

    • state

      public final PluginState state()

      The current status of the plugin.

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

      Returns:
      The current status of the plugin.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current status of the plugin.

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

      Returns:
      The current status of the plugin.
      See Also:

    • buildStatus

      public final PluginBuildStatus buildStatus()

      The status of the plugin.

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

      Returns:
      The status of the plugin.
      See Also:

    • buildStatusAsString

      public final String buildStatusAsString()

      The status of the plugin.

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

      Returns:
      The status of the plugin.
      See Also:

    • createdAt

      public final Instant createdAt()

      The timestamp for when the plugin was created.

      Returns:
      The timestamp for when the plugin was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp for when the plugin was last updated.

      Returns:
      The timestamp for when the plugin was last updated.

    • toBuilder

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

    • builder

      public static Plugin.Builder builder()

    • serializableBuilderClass

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