Interface AssociatePackageRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<AssociatePackageRequest.Builder,AssociatePackageRequest>, OpenSearchRequest.Builder, SdkBuilder<AssociatePackageRequest.Builder,AssociatePackageRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

AssociatePackageRequest

@Mutable
@NotThreadSafe
public static interface AssociatePackageRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<AssociatePackageRequest.Builder,AssociatePackageRequest>

Method Summary

Modifier and Type	Method	Description
default AssociatePackageRequest.Builder	associationConfiguration(Consumer<PackageAssociationConfiguration.Builder> associationConfiguration)	The configuration for associating a package with an Amazon OpenSearch Service domain.
AssociatePackageRequest.Builder	associationConfiguration(PackageAssociationConfiguration associationConfiguration)	The configuration for associating a package with an Amazon OpenSearch Service domain.
AssociatePackageRequest.Builder	domainName(String domainName)	Name of the domain to associate the package with.
AssociatePackageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
AssociatePackageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
AssociatePackageRequest.Builder	packageID(String packageID)	Internal ID of the package to associate with a domain.
AssociatePackageRequest.Builder	prerequisitePackageIDList(String... prerequisitePackageIDList)	A list of package IDs that must be associated with the domain before the package specified in the request can be associated.
AssociatePackageRequest.Builder	prerequisitePackageIDList(Collection<String> prerequisitePackageIDList)	A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

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 Details

packageID

AssociatePackageRequest.Builder packageID(String packageID)

Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

Parameters:

packageID - Internal ID of the package to associate with a domain. Use DescribePackages to find this value.

Returns:

Returns a reference to this object so that method calls can be chained together.

domainName

AssociatePackageRequest.Builder domainName(String domainName)

Name of the domain to associate the package with.

Parameters:

domainName - Name of the domain to associate the package with.

Returns:

Returns a reference to this object so that method calls can be chained together.

prerequisitePackageIDList

AssociatePackageRequest.Builder prerequisitePackageIDList(Collection<String> prerequisitePackageIDList)

A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

Parameters:

prerequisitePackageIDList - A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

Returns:

Returns a reference to this object so that method calls can be chained together.

prerequisitePackageIDList

AssociatePackageRequest.Builder prerequisitePackageIDList(String... prerequisitePackageIDList)

A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

Parameters:

prerequisitePackageIDList - A list of package IDs that must be associated with the domain before the package specified in the request can be associated.

Returns:

Returns a reference to this object so that method calls can be chained together.

associationConfiguration

AssociatePackageRequest.Builder associationConfiguration(PackageAssociationConfiguration associationConfiguration)

The configuration for associating a package with an Amazon OpenSearch Service domain.

Parameters:

associationConfiguration - The configuration for associating a package with an Amazon OpenSearch Service domain.

Returns:

Returns a reference to this object so that method calls can be chained together.

associationConfiguration

default AssociatePackageRequest.Builder associationConfiguration(Consumer<PackageAssociationConfiguration.Builder> associationConfiguration)

The configuration for associating a package with an Amazon OpenSearch Service domain.

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

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

Parameters:

associationConfiguration - a consumer that will call methods on PackageAssociationConfiguration.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• associationConfiguration(PackageAssociationConfiguration)

overrideConfiguration

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

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