Interface AddDirectQueryDataSourceRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder,Buildable,CopyableBuilder<AddDirectQueryDataSourceRequest.Builder,AddDirectQueryDataSourceRequest>,OpenSearchRequest.Builder,SdkBuilder<AddDirectQueryDataSourceRequest.Builder,AddDirectQueryDataSourceRequest>,SdkPojo,SdkRequest.Builder
- Enclosing class:
- AddDirectQueryDataSourceRequest
@Mutable @NotThreadSafe public static interface AddDirectQueryDataSourceRequest.Builder extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<AddDirectQueryDataSourceRequest.Builder,AddDirectQueryDataSourceRequest>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description AddDirectQueryDataSourceRequest.BuilderdataSourceAccessPolicy(String dataSourceAccessPolicy)An optional IAM access policy document that defines the permissions for accessing the data source.AddDirectQueryDataSourceRequest.BuilderdataSourceName(String dataSourceName)A unique, user-defined label to identify the data source within your OpenSearch Service environment.default AddDirectQueryDataSourceRequest.BuilderdataSourceType(Consumer<DirectQueryDataSourceType.Builder> dataSourceType)The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.AddDirectQueryDataSourceRequest.BuilderdataSourceType(DirectQueryDataSourceType dataSourceType)The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.AddDirectQueryDataSourceRequest.Builderdescription(String description)An optional text field for providing additional context and details about the data source.AddDirectQueryDataSourceRequest.BuilderopenSearchArns(String... openSearchArns)A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.AddDirectQueryDataSourceRequest.BuilderopenSearchArns(Collection<String> openSearchArns)A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.AddDirectQueryDataSourceRequest.BuilderoverrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)AddDirectQueryDataSourceRequest.BuilderoverrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)AddDirectQueryDataSourceRequest.BuildertagList(Collection<Tag> tagList)Sets the value of the TagList property for this object.AddDirectQueryDataSourceRequest.BuildertagList(Consumer<Tag.Builder>... tagList)Sets the value of the TagList property for this object.AddDirectQueryDataSourceRequest.BuildertagList(Tag... tagList)Sets the value of the TagList property for this object.-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.services.opensearch.model.OpenSearchRequest.Builder
build
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFieldNameToField, sdkFields
-
-
-
-
Method Detail
-
dataSourceName
AddDirectQueryDataSourceRequest.Builder dataSourceName(String dataSourceName)
A unique, user-defined label to identify the data source within your OpenSearch Service environment.
- Parameters:
dataSourceName- A unique, user-defined label to identify the data source within your OpenSearch Service environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSourceType
AddDirectQueryDataSourceRequest.Builder dataSourceType(DirectQueryDataSourceType dataSourceType)
The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.
- Parameters:
dataSourceType- The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSourceType
default AddDirectQueryDataSourceRequest.Builder dataSourceType(Consumer<DirectQueryDataSourceType.Builder> dataSourceType)
The supported Amazon Web Services service that you want to use as the source for direct queries in OpenSearch Service.
This is a convenience method that creates an instance of theDirectQueryDataSourceType.Builderavoiding the need to create one manually viaDirectQueryDataSourceType.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed todataSourceType(DirectQueryDataSourceType).- Parameters:
dataSourceType- a consumer that will call methods onDirectQueryDataSourceType.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
dataSourceType(DirectQueryDataSourceType)
-
description
AddDirectQueryDataSourceRequest.Builder description(String description)
An optional text field for providing additional context and details about the data source.
- Parameters:
description- An optional text field for providing additional context and details about the data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openSearchArns
AddDirectQueryDataSourceRequest.Builder openSearchArns(Collection<String> openSearchArns)
A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.
- Parameters:
openSearchArns- A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
openSearchArns
AddDirectQueryDataSourceRequest.Builder openSearchArns(String... openSearchArns)
A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.
- Parameters:
openSearchArns- A list of Amazon Resource Names (ARNs) for the OpenSearch collections that are associated with the direct query data source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dataSourceAccessPolicy
AddDirectQueryDataSourceRequest.Builder dataSourceAccessPolicy(String dataSourceAccessPolicy)
An optional IAM access policy document that defines the permissions for accessing the data source. The policy document must be in valid JSON format and follow IAM policy syntax.
- Parameters:
dataSourceAccessPolicy- An optional IAM access policy document that defines the permissions for accessing the data source. The policy document must be in valid JSON format and follow IAM policy syntax.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
AddDirectQueryDataSourceRequest.Builder tagList(Collection<Tag> tagList)
Sets the value of the TagList property for this object.- Parameters:
tagList- The new value for the TagList property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
AddDirectQueryDataSourceRequest.Builder tagList(Tag... tagList)
Sets the value of the TagList property for this object.- Parameters:
tagList- The new value for the TagList property for this object.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
tagList
AddDirectQueryDataSourceRequest.Builder tagList(Consumer<Tag.Builder>... tagList)
Sets the value of the TagList property for this object. This is a convenience method that creates an instance of theTag.Builderavoiding the need to create one manually viaTag.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed to#tagList(List.) - Parameters:
tagList- a consumer that will call methods onTag.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#tagList(java.util.Collection)
-
overrideConfiguration
AddDirectQueryDataSourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
overrideConfiguration
AddDirectQueryDataSourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfigurationin interfaceAwsRequest.Builder
-
-