Package software.amazon.awssdk.services.opensearch.model

Interface DomainPackageDetails.Builder

All Superinterfaces:

Buildable, CopyableBuilder<DomainPackageDetails.Builder,DomainPackageDetails>, SdkBuilder<DomainPackageDetails.Builder,DomainPackageDetails>, SdkPojo

Enclosing class:

DomainPackageDetails

public static interface DomainPackageDetails.Builder
extends SdkPojo, CopyableBuilder<DomainPackageDetails.Builder,DomainPackageDetails>

Method Summary

Modifier and Type	Method	Description
default DomainPackageDetails.Builder	associationConfiguration(Consumer<PackageAssociationConfiguration.Builder> associationConfiguration)	The configuration for associating a package with an Amazon OpenSearch Service domain.
DomainPackageDetails.Builder	associationConfiguration(PackageAssociationConfiguration associationConfiguration)	The configuration for associating a package with an Amazon OpenSearch Service domain.
DomainPackageDetails.Builder	domainName(String domainName)	Name of the domain that the package is associated with.
DomainPackageDetails.Builder	domainPackageStatus(String domainPackageStatus)	State of the association.
DomainPackageDetails.Builder	domainPackageStatus(DomainPackageStatus domainPackageStatus)	State of the association.
default DomainPackageDetails.Builder	errorDetails(Consumer<ErrorDetails.Builder> errorDetails)	Additional information if the package is in an error state.
DomainPackageDetails.Builder	errorDetails(ErrorDetails errorDetails)	Additional information if the package is in an error state.
DomainPackageDetails.Builder	lastUpdated(Instant lastUpdated)	Timestamp of the most recent update to the package association status.
DomainPackageDetails.Builder	packageID(String packageID)	Internal ID of the package.
DomainPackageDetails.Builder	packageName(String packageName)	User-specified name of the package.
DomainPackageDetails.Builder	packageType(String packageType)	The type of package.
DomainPackageDetails.Builder	packageType(PackageType packageType)	The type of package.
DomainPackageDetails.Builder	packageVersion(String packageVersion)	The current version of the package.
DomainPackageDetails.Builder	prerequisitePackageIDList(String... prerequisitePackageIDList)	A list of package IDs that must be associated with the domain before or with the package can be associated.
DomainPackageDetails.Builder	prerequisitePackageIDList(Collection<String> prerequisitePackageIDList)	A list of package IDs that must be associated with the domain before or with the package can be associated.
DomainPackageDetails.Builder	referencePath(String referencePath)	The relative path of the package on the OpenSearch Service cluster nodes.

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

copy

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

packageID

DomainPackageDetails.Builder packageID(String packageID)

Internal ID of the package.

Parameters:

packageID - Internal ID of the package.

Returns:

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

packageName

DomainPackageDetails.Builder packageName(String packageName)

User-specified name of the package.

Parameters:

packageName - User-specified name of the package.

Returns:

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

packageType

DomainPackageDetails.Builder packageType(String packageType)

The type of package.

Parameters:

packageType - The type of package.

Returns:

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

See Also:

PackageType, PackageType

packageType

DomainPackageDetails.Builder packageType(PackageType packageType)

The type of package.

Parameters:

packageType - The type of package.

Returns:

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

See Also:

PackageType, PackageType

lastUpdated

DomainPackageDetails.Builder lastUpdated(Instant lastUpdated)

Timestamp of the most recent update to the package association status.

Parameters:

lastUpdated - Timestamp of the most recent update to the package association status.

Returns:

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

domainName

DomainPackageDetails.Builder domainName(String domainName)

Name of the domain that the package is associated with.

Parameters:

domainName - Name of the domain that the package is associated with.

Returns:

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

domainPackageStatus

DomainPackageDetails.Builder domainPackageStatus(String domainPackageStatus)

State of the association.

Parameters:

domainPackageStatus - State of the association.

Returns:

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

See Also:

DomainPackageStatus, DomainPackageStatus

domainPackageStatus

DomainPackageDetails.Builder domainPackageStatus(DomainPackageStatus domainPackageStatus)

State of the association.

Parameters:

domainPackageStatus - State of the association.

Returns:

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

See Also:

DomainPackageStatus, DomainPackageStatus

packageVersion

DomainPackageDetails.Builder packageVersion(String packageVersion)

The current version of the package.

Parameters:

packageVersion - The current version of the package.

Returns:

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

prerequisitePackageIDList

DomainPackageDetails.Builder prerequisitePackageIDList(Collection<String> prerequisitePackageIDList)

A list of package IDs that must be associated with the domain before or with the package can be associated.

Parameters:

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

Returns:

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

prerequisitePackageIDList

DomainPackageDetails.Builder prerequisitePackageIDList(String... prerequisitePackageIDList)

A list of package IDs that must be associated with the domain before or with the package can be associated.

Parameters:

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

Returns:

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

referencePath

DomainPackageDetails.Builder referencePath(String referencePath)

The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

Parameters:

referencePath - The relative path of the package on the OpenSearch Service cluster nodes. This is synonym_path when the package is for synonym files.

Returns:

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

errorDetails

DomainPackageDetails.Builder errorDetails(ErrorDetails errorDetails)

Additional information if the package is in an error state. Null otherwise.

Parameters:

errorDetails - Additional information if the package is in an error state. Null otherwise.

Returns:

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

errorDetails

default DomainPackageDetails.Builder errorDetails(Consumer<ErrorDetails.Builder> errorDetails)

Additional information if the package is in an error state. Null otherwise.

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

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

Parameters:

errorDetails - a consumer that will call methods on ErrorDetails.Builder

Returns:

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

See Also:

errorDetails(ErrorDetails)

associationConfiguration

DomainPackageDetails.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 DomainPackageDetails.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)