Package software.amazon.awssdk.services.qbusiness.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Plugin.Builder

Method Summary

Modifier and Type	Method	Description
static Plugin.Builder	builder()
PluginBuildStatus	buildStatus()	The status of the plugin.
String	buildStatusAsString()	The status of the plugin.
Instant	createdAt()	The timestamp for when the plugin was created.
String	displayName()	The name of the plugin.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	pluginId()	The identifier of the plugin.
List<SdkField<?>>	sdkFields()
static Class<? extends Plugin.Builder>	serializableBuilderClass()
String	serverUrl()	The plugin server URL used for configuration.
PluginState	state()	The current status of the plugin.
String	stateAsString()	The current status of the plugin.
Plugin.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PluginType	type()	The type of the plugin.
String	typeAsString()	The type of the plugin.
Instant	updatedAt()	The timestamp for when the plugin was last updated.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

PluginType

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:

PluginType

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:

PluginState

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:

PluginState

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:

PluginBuildStatus

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:

PluginBuildStatus

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()

Specified by:

toBuilder in interface ToCopyableBuilder<Plugin.Builder,Plugin>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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