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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface CreateDataSourceRequest.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`String`	`applicationId()`	The identifier of the Amazon Q Business application the data source will be attached to.
`static CreateDataSourceRequest.Builder`	`builder()`
`String`	`clientToken()`	A token you provide to identify a request to create a data source connector.
`Document`	`configuration()`	Configuration information to connect to your data source repository.
`String`	`description()`	A description for the data source connector.
`String`	`displayName()`	A 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)`
`<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`	`indexId()`	The identifier of the index that you want to use with the data source connector.
`String`	`roleArn()`	The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends CreateDataSourceRequest.Builder>`	`serializableBuilderClass()`
`String`	`syncSchedule()`	Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index.
`List<Tag>`	`tags()`	A list of key-value pairs that identify or categorize the data source connector.
`CreateDataSourceRequest.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`DataSourceVpcConfiguration`	`vpcConfiguration()`	Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source.

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 Amazon Q Business application the data source will be attached to.
    
    Returns:
    
    The identifier of the Amazon Q Business application the data source will be attached to.
  - indexId
```
public final String indexId()
```
    The identifier of the index that you want to use with the data source connector.
    
    Returns:
    
    The identifier of the index that you want to use with the data source connector.
  - displayName
```
public final String displayName()
```
    A name for the data source connector.
    
    Returns:
    
    A name for the data source connector.
  - configuration
```
public final Document configuration()
```
    Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
    
    Returns:
    
    Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.
  - vpcConfiguration
```
public final DataSourceVpcConfiguration vpcConfiguration()
```
    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
    
    Returns:
    
    Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors.
  - description
```
public final String description()
```
    A description for the data source connector.
    
    Returns:
    
    A description for the data source connector.
  - 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: _ . : / = + - @.
  - syncSchedule
```
public final String syncSchedule()
```
    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
    
    Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
    
    Returns:
    
    Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index.
    
    Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM. If you do, you receive a ValidationException exception.
  - roleArn
```
public final String roleArn()
```
    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
    
    Returns:
    
    The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.
  - clientToken
```
public final String clientToken()
```
    A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
    
    Returns:
    
    A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.
  - 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 CreateDataSourceRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateDataSourceRequest.Builder,CreateDataSourceRequest>
    
    Specified by:
    
    toBuilder in class QBusinessRequest
  - builder
```
public static CreateDataSourceRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateDataSourceRequest.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

Class CreateDataSourceRequest

Nested Class Summary

Method Summary

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

Methods inherited from class java.lang.Object

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

Method Detail

applicationId

indexId

displayName

configuration

vpcConfiguration

description

hasTags

tags

syncSchedule

roleArn

clientToken

documentEnrichmentConfiguration

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields