Interface AttachDataSourceRequest.Builder

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

  • Method Details

    • id

      AttachDataSourceRequest.Builder id(String id)

      The unique identifier or name of the OpenSearch application to attach the data source to. This is the same identifier used with UpdateApplication, GetApplication, and DeleteApplication.

      Parameters:
      id - The unique identifier or name of the OpenSearch application to attach the data source to. This is the same identifier used with UpdateApplication, GetApplication, and DeleteApplication.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataSourceArn

      AttachDataSourceRequest.Builder dataSourceArn(String dataSourceArn)
      Sets the value of the DataSourceArn property for this object.
      Parameters:
      dataSourceArn - The new value for the DataSourceArn property for this object.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceId

      AttachDataSourceRequest.Builder workspaceId(String workspaceId)

      The identifier of an existing workspace to update with the new data source. Mutually exclusive with workspaceConfiguration.

      Parameters:
      workspaceId - The identifier of an existing workspace to update with the new data source. Mutually exclusive with workspaceConfiguration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceConfiguration

      AttachDataSourceRequest.Builder workspaceConfiguration(WorkspaceConfigurationInput workspaceConfiguration)

      Configuration for creating a new workspace during the attachment. If specified, a workspace is created and linked to the data source after the attachment completes. Mutually exclusive with workspaceId.

      Parameters:
      workspaceConfiguration - Configuration for creating a new workspace during the attachment. If specified, a workspace is created and linked to the data source after the attachment completes. Mutually exclusive with workspaceId.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • workspaceConfiguration

      default AttachDataSourceRequest.Builder workspaceConfiguration(Consumer<WorkspaceConfigurationInput.Builder> workspaceConfiguration)

      Configuration for creating a new workspace during the attachment. If specified, a workspace is created and linked to the data source after the attachment completes. Mutually exclusive with workspaceId.

      This is a convenience method that creates an instance of the WorkspaceConfigurationInput.Builder avoiding the need to create one manually via WorkspaceConfigurationInput.builder().

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

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

    • clientToken

      AttachDataSourceRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure idempotency of the request. If you retry a request with the same client token and the same parameters, the retry succeeds without performing any further actions.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure idempotency of the request. If you retry a request with the same client token and the same parameters, the retry succeeds without performing any further actions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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