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

Class CreateRetrieverRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRetrieverRequest.Builder,CreateRetrieverRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRetrieverRequest.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of your Amazon Q Business application.
static CreateRetrieverRequest.Builder	builder()
String	clientToken()	A token that you provide to identify the request to create your Amazon Q Business application retriever.
RetrieverConfiguration	configuration()	Returns the value of the Configuration property for this object.
String	displayName()	The name of your retriever.
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.
String	roleArn()	The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRetrieverRequest.Builder>	serializableBuilderClass()
List<Tag>	tags()	A list of key-value pairs that identify or categorize the retriever.
CreateRetrieverRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
RetrieverType	type()	The type of retriever you are using.
String	typeAsString()	The type of retriever you are using.

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 your Amazon Q Business application.

Returns:

The identifier of your Amazon Q Business application.

type

public final RetrieverType type()

The type of retriever you are using.

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

Returns:

The type of retriever you are using.

See Also:

RetrieverType

typeAsString

public final String typeAsString()

The type of retriever you are using.

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

Returns:

The type of retriever you are using.

See Also:

RetrieverType

displayName

public final String displayName()

The name of your retriever.

Returns:

The name of your retriever.

configuration

public final RetrieverConfiguration configuration()

Returns the value of the Configuration property for this object.

Returns:

The value of the Configuration property for this object.

roleArn

public final String roleArn()

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

Returns:

The ARN of an IAM role used by Amazon Q Business to access the basic authentication credentials stored in a Secrets Manager secret.

clientToken

public final String clientToken()

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

Returns:

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

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 retriever. You can also use tags to help control access to the retriever. 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 retriever. You can also use tags to help control access to the retriever. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

toBuilder

public CreateRetrieverRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRetrieverRequest.Builder,CreateRetrieverRequest>

Specified by:

toBuilder in class QBusinessRequest

builder

public static CreateRetrieverRequest.Builder builder()

serializableBuilderClass

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