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

Class CreatePluginRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.qbusiness.model.QBusinessRequest

software.amazon.awssdk.services.qbusiness.model.CreatePluginRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePluginRequest.Builder,CreatePluginRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreatePluginRequest
extends QBusinessRequest
implements ToCopyableBuilder<CreatePluginRequest.Builder,CreatePluginRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePluginRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the application that will contain the plugin.
PluginAuthConfiguration	authConfiguration()	Returns the value of the AuthConfiguration property for this object.
static CreatePluginRequest.Builder	builder()
String	clientToken()	A token that you provide to identify the request to create your Amazon Q Business plugin.
CustomPluginConfiguration	customPluginConfiguration()	Contains configuration for a custom plugin.
String	displayName()	A the name for your plugin.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePluginRequest.Builder>	serializableBuilderClass()
String	serverUrl()	The source URL used for plugin configuration.
List<Tag>	tags()	A list of key-value pairs that identify or categorize the data source connector.
CreatePluginRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
PluginType	type()	The type of plugin you want to create.
String	typeAsString()	The type of plugin you want to create.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

applicationId

public final String applicationId()

The identifier of the application that will contain the plugin.

Returns:

The identifier of the application that will contain the plugin.

displayName

public final String displayName()

A the name for your plugin.

Returns:

A the name for your plugin.

type

public final PluginType type()

The type of plugin you want to create.

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 plugin you want to create.

See Also:

PluginType

typeAsString

public final String typeAsString()

The type of plugin you want to create.

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 plugin you want to create.

See Also:

PluginType

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.

serverUrl

public final String serverUrl()

The source URL used for plugin configuration.

Returns:

The source URL used for plugin configuration.

customPluginConfiguration

public final CustomPluginConfiguration customPluginConfiguration()

Contains configuration for a custom plugin.

Returns:

Contains configuration for a custom plugin.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

tags

public final List<Tag> tags()

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

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

Returns:

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

clientToken

public final String clientToken()

A token that you provide to identify the request to create your Amazon Q Business plugin.

Returns:

A token that you provide to identify the request to create your Amazon Q Business plugin.

toBuilder

public CreatePluginRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePluginRequest.Builder,CreatePluginRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static CreatePluginRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo