Class GetPluginResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.qbusiness.model.QBusinessResponse
software.amazon.awssdk.services.qbusiness.model.GetPluginResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetPluginResponse.Builder,GetPluginResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetPluginResponse extends QBusinessResponse implements ToCopyableBuilder<GetPluginResponse.Builder,GetPluginResponse>

  • Method Details

    • applicationId

      public final String applicationId()

      The identifier of the application which contains the plugin.

      Returns:
      The identifier of the application which contains the plugin.

    • 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 source URL used for plugin configuration.

      Returns:
      The source URL used for plugin configuration.

    • authConfiguration

      public final PluginAuthConfiguration authConfiguration()
      Returns the value of the AuthConfiguration property for this object.
      Returns:
      The value of the AuthConfiguration property for this object.

    • customPluginConfiguration

      public final CustomPluginConfiguration customPluginConfiguration()

      Configuration information required to create a custom plugin.

      Returns:
      Configuration information required to create a custom plugin.

    • buildStatus

      public final PluginBuildStatus buildStatus()

      The current status of a plugin. A plugin is modified asynchronously.

      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 current status of a plugin. A plugin is modified asynchronously.
      See Also:

    • buildStatusAsString

      public final String buildStatusAsString()

      The current status of a plugin. A plugin is modified asynchronously.

      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 current status of a plugin. A plugin is modified asynchronously.
      See Also:

    • pluginArn

      public final String pluginArn()

      The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

      Returns:
      The Amazon Resource Name (ARN) of the role with permission to access resources needed to create the plugin.

    • state

      public final PluginState state()

      The current state 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 state of the plugin.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state 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 state 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 GetPluginResponse.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<GetPluginResponse.Builder,GetPluginResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetPluginResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetPluginResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.