DescribeDataSourceResponse (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkResponse
- - software.amazon.awssdk.awscore.AwsResponse
  - - software.amazon.awssdk.services.kendra.model.KendraResponse
    - - software.amazon.awssdk.services.kendra.model.DescribeDataSourceResponse

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class DescribeDataSourceResponse
extends KendraResponse
implements ToCopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeDataSourceResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeDataSourceResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static DescribeDataSourceResponse.Builder`	`builder()`
`DataSourceConfiguration`	`configuration()` Information that describes where the data source is located and how the data source is configured.
`Instant`	`createdAt()` The Unix timestamp of when the data source was created.
`String`	`description()` The description of the data source.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`errorMessage()` When the `Status` field value is `FAILED`, the `ErrorMessage` field contains a description of the error that caused the data source to fail.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`id()` The identifier of the data source.
`String`	`indexId()` The identifier of the index that contains the data source.
`String`	`name()` The name that you gave the data source when it was created.
`String`	`roleArn()` The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
`String`	`schedule()` The schedule that Amazon Kendra will update the data source.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeDataSourceResponse.Builder>`	`serializableBuilderClass()`
`DataSourceStatus`	`status()` The current status of the data source.
`String`	`statusAsString()` The current status of the data source.
`DescribeDataSourceResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`DataSourceType`	`type()` The type of the data source.
`String`	`typeAsString()` The type of the data source.
`Instant`	`updatedAt()` The Unix timestamp of when the data source was last updated.

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse
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
  - id
```
public String id()
```
    The identifier of the data source.
    
    Returns:
    
    The identifier of the data source.
  - indexId
```
public String indexId()
```
    The identifier of the index that contains the data source.
    
    Returns:
    
    The identifier of the index that contains the data source.
  - name
```
public String name()
```
    The name that you gave the data source when it was created.
    
    Returns:
    
    The name that you gave the data source when it was created.
  - type
```
public DataSourceType type()
```
    The type of the data source.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the data source.
    
    See Also:
    
    DataSourceType
  - typeAsString
```
public String typeAsString()
```
    The type of the data source.
    
    If the service returns an enum value that is not available in the current SDK version, type will return DataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    The type of the data source.
    
    See Also:
    
    DataSourceType
  - configuration
```
public DataSourceConfiguration configuration()
```
    Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.
    
    Returns:
    
    Information that describes where the data source is located and how the data source is configured. The specific information in the description depends on the data source provider.
  - createdAt
```
public Instant createdAt()
```
    The Unix timestamp of when the data source was created.
    
    Returns:
    
    The Unix timestamp of when the data source was created.
  - updatedAt
```
public Instant updatedAt()
```
    The Unix timestamp of when the data source was last updated.
    
    Returns:
    
    The Unix timestamp of when the data source was last updated.
  - description
```
public String description()
```
    The description of the data source.
    
    Returns:
    
    The description of the data source.
  - status
```
public DataSourceStatus status()
```
    The current status of the data source. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
    
    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. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
    
    See Also:
    
    DataSourceStatus
  - statusAsString
```
public String statusAsString()
```
    The current status of the data source. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
    
    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. When the status is ACTIVE the data source is ready to use. When the status is FAILED, the ErrorMessage field contains the reason that the data source failed.
    
    See Also:
    
    DataSourceStatus
  - schedule
```
public String schedule()
```
    The schedule that Amazon Kendra will update the data source.
    
    Returns:
    
    The schedule that Amazon Kendra will update the data source.
  - roleArn
```
public String roleArn()
```
    The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the role that enables the data source to access its resources.
  - errorMessage
```
public String errorMessage()
```
    When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
    
    Returns:
    
    When the Status field value is FAILED, the ErrorMessage field contains a description of the error that caused the data source to fail.
  - toBuilder
```
public DescribeDataSourceResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeDataSourceResponse.Builder,DescribeDataSourceResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeDataSourceResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeDataSourceResponse.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsResponse
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsResponse
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public 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 <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkResponse
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeDataSourceResponse

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.services.kendra.model.KendraResponse

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

Methods inherited from class java.lang.Object

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

Method Detail

id

indexId

name

type

typeAsString

configuration

createdAt

updatedAt

description

status

statusAsString

schedule

roleArn

errorMessage

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields