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

Class GetDataSourceResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetDataSourceResponse.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationId()	The identifier of the Amazon Q Business application.
static GetDataSourceResponse.Builder	builder()
Document	configuration()	The details of how the data source connector is configured.
Instant	createdAt()	The Unix timestamp when the data source connector was created.
String	dataSourceArn()	The Amazon Resource Name (ARN) of the data source.
String	dataSourceId()	The identifier of the data source connector.
String	description()	The description for the data source connector.
String	displayName()	The name for the data source connector.
DocumentEnrichmentConfiguration	documentEnrichmentConfiguration()	Returns the value of the DocumentEnrichmentConfiguration property for this object.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
ErrorDetail	error()	When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	indexId()	The identifier of the index linked to the data source connector.
String	roleArn()	The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.
List<SdkField<?>>	sdkFields()
static Class<? extends GetDataSourceResponse.Builder>	serializableBuilderClass()
DataSourceStatus	status()	The current status of the data source connector.
String	statusAsString()	The current status of the data source connector.
String	syncSchedule()	The schedule for Amazon Q Business to update the index.
GetDataSourceResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	type()	The type of the data source connector.
Instant	updatedAt()	The Unix timestamp when the data source connector was last updated.
DataSourceVpcConfiguration	vpcConfiguration()	Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

Methods inherited from class software.amazon.awssdk.services.qbusiness.model.QBusinessResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

Returns:

The identifier of the Amazon Q Business application.

indexId

public final String indexId()

The identifier of the index linked to the data source connector.

Returns:

The identifier of the index linked to the data source connector.

dataSourceId

public final String dataSourceId()

The identifier of the data source connector.

Returns:

The identifier of the data source connector.

dataSourceArn

public final String dataSourceArn()

The Amazon Resource Name (ARN) of the data source.

Returns:

The Amazon Resource Name (ARN) of the data source.

displayName

public final String displayName()

The name for the data source connector.

Returns:

The name for the data source connector.

type

public final String type()

The type of the data source connector. For example, S3.

Returns:

The type of the data source connector. For example, S3.

configuration

public final Document configuration()

The details of how the data source connector is configured.

Returns:

The details of how the data source connector is configured.

vpcConfiguration

public final DataSourceVpcConfiguration vpcConfiguration()

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

Returns:

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

createdAt

public final Instant createdAt()

The Unix timestamp when the data source connector was created.

Returns:

The Unix timestamp when the data source connector was created.

updatedAt

public final Instant updatedAt()

The Unix timestamp when the data source connector was last updated.

Returns:

The Unix timestamp when the data source connector was last updated.

description

public final String description()

The description for the data source connector.

Returns:

The description for the data source connector.

status

public final DataSourceStatus status()

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

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

Returns:

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

See Also:

DataSourceStatus

statusAsString

public final String statusAsString()

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

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

Returns:

The current status of the data source connector. When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

See Also:

DataSourceStatus

syncSchedule

public final String syncSchedule()

The schedule for Amazon Q Business to update the index.

Returns:

The schedule for Amazon Q Business to update the index.

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

Returns:

The Amazon Resource Name (ARN) of the role with permission to access the data source and required resources.

error

public final ErrorDetail error()

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

Returns:

When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source connector to fail.

documentEnrichmentConfiguration

public final DocumentEnrichmentConfiguration documentEnrichmentConfiguration()

Returns the value of the DocumentEnrichmentConfiguration property for this object.

Returns:

The value of the DocumentEnrichmentConfiguration property for this object.

toBuilder

public GetDataSourceResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetDataSourceResponse.Builder,GetDataSourceResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetDataSourceResponse.Builder builder()

serializableBuilderClass

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

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo