Interface UpdateDirectQueryDataSourceRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<UpdateDirectQueryDataSourceRequest.Builder,UpdateDirectQueryDataSourceRequest>, OpenSearchRequest.Builder, SdkBuilder<UpdateDirectQueryDataSourceRequest.Builder,UpdateDirectQueryDataSourceRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
UpdateDirectQueryDataSourceRequest
@Mutable @NotThreadSafe public static interface UpdateDirectQueryDataSourceRequest.Builder extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<UpdateDirectQueryDataSourceRequest.Builder,UpdateDirectQueryDataSourceRequest>

  • Method Details

    • dataSourceName

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

      UpdateDirectQueryDataSourceRequest.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 UpdateDirectQueryDataSourceRequest.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 the DirectQueryDataSourceType.Builder avoiding the need to create one manually via DirectQueryDataSourceType.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to dataSourceType(DirectQueryDataSourceType).

      Parameters:
      dataSourceType - a consumer that will call methods on DirectQueryDataSourceType.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

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

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

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

      UpdateDirectQueryDataSourceRequest.Builder dataSourceAccessPolicy(String dataSourceAccessPolicy)

      An optional IAM access policy document that defines the updated permissions for accessing the direct query data source. The policy document must be in valid JSON format and follow IAM policy syntax. If not specified, the existing access policy if present remains unchanged.

      Parameters:
      dataSourceAccessPolicy - An optional IAM access policy document that defines the updated permissions for accessing the direct query data source. The policy document must be in valid JSON format and follow IAM policy syntax. If not specified, the existing access policy if present remains unchanged.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      UpdateDirectQueryDataSourceRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      UpdateDirectQueryDataSourceRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.