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

Interface PackageDetails.Builder

All Superinterfaces:

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

Enclosing class:

PackageDetails

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

Method Summary

Modifier and Type	Method	Description
PackageDetails.Builder	allowListedUserList(String... allowListedUserList)	A list of users who are allowed to view and associate the package.
PackageDetails.Builder	allowListedUserList(Collection<String> allowListedUserList)	A list of users who are allowed to view and associate the package.
default PackageDetails.Builder	availablePackageConfiguration(Consumer<PackageConfiguration.Builder> availablePackageConfiguration)	This represents the available configuration parameters for the package.
PackageDetails.Builder	availablePackageConfiguration(PackageConfiguration availablePackageConfiguration)	This represents the available configuration parameters for the package.
PackageDetails.Builder	availablePackageVersion(String availablePackageVersion)	The package version.
default PackageDetails.Builder	availablePluginProperties(Consumer<PluginProperties.Builder> availablePluginProperties)	If the package is a ZIP-PLUGIN package, additional information about plugin properties.
PackageDetails.Builder	availablePluginProperties(PluginProperties availablePluginProperties)	If the package is a ZIP-PLUGIN package, additional information about plugin properties.
PackageDetails.Builder	createdAt(Instant createdAt)	The timestamp when the package was created.
PackageDetails.Builder	engineVersion(String engineVersion)	Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y.
default PackageDetails.Builder	errorDetails(Consumer<ErrorDetails.Builder> errorDetails)	Additional information if the package is in an error state.
PackageDetails.Builder	errorDetails(ErrorDetails errorDetails)	Additional information if the package is in an error state.
PackageDetails.Builder	lastUpdatedAt(Instant lastUpdatedAt)	Date and time when the package was last updated.
PackageDetails.Builder	packageDescription(String packageDescription)	User-specified description of the package.
default PackageDetails.Builder	packageEncryptionOptions(Consumer<PackageEncryptionOptions.Builder> packageEncryptionOptions)	Encryption options for a package.
PackageDetails.Builder	packageEncryptionOptions(PackageEncryptionOptions packageEncryptionOptions)	Encryption options for a package.
PackageDetails.Builder	packageID(String packageID)	The unique identifier of the package.
PackageDetails.Builder	packageName(String packageName)	The user-specified name of the package.
PackageDetails.Builder	packageOwner(String packageOwner)	The owner of the package who is allowed to create and update a package and add users to the package scope.
PackageDetails.Builder	packageStatus(String packageStatus)	The current status of the package.
PackageDetails.Builder	packageStatus(PackageStatus packageStatus)	The current status of the package.
PackageDetails.Builder	packageType(String packageType)	The type of package.
PackageDetails.Builder	packageType(PackageType packageType)	The type of package.
default PackageDetails.Builder	packageVendingOptions(Consumer<PackageVendingOptions.Builder> packageVendingOptions)	Package Vending Options for a package.
PackageDetails.Builder	packageVendingOptions(PackageVendingOptions packageVendingOptions)	Package Vending Options for a package.

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

PackageDetails.Builder packageID(String packageID)

The unique identifier of the package.

Parameters:

packageID - The unique identifier of the package.

Returns:

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

packageName

PackageDetails.Builder packageName(String packageName)

The user-specified name of the package.

Parameters:

packageName - The user-specified name of the package.

Returns:

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

packageType

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

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

packageDescription

PackageDetails.Builder packageDescription(String packageDescription)

User-specified description of the package.

Parameters:

packageDescription - User-specified description of the package.

Returns:

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

packageStatus

PackageDetails.Builder packageStatus(String packageStatus)

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

Parameters:

packageStatus - The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED , DELETING, and DELETE_FAILED.

Returns:

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

See Also:

PackageStatus, PackageStatus

packageStatus

PackageDetails.Builder packageStatus(PackageStatus packageStatus)

The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED, DELETING, and DELETE_FAILED.

Parameters:

packageStatus - The current status of the package. The available options are AVAILABLE, COPYING, COPY_FAILED, VALIDATNG, VALIDATION_FAILED , DELETING, and DELETE_FAILED.

Returns:

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

See Also:

PackageStatus, PackageStatus

createdAt

PackageDetails.Builder createdAt(Instant createdAt)

The timestamp when the package was created.

Parameters:

createdAt - The timestamp when the package was created.

Returns:

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

lastUpdatedAt

PackageDetails.Builder lastUpdatedAt(Instant lastUpdatedAt)

Date and time when the package was last updated.

Parameters:

lastUpdatedAt - Date and time when the package was last updated.

Returns:

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

availablePackageVersion

PackageDetails.Builder availablePackageVersion(String availablePackageVersion)

The package version.

Parameters:

availablePackageVersion - The package version.

Returns:

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

errorDetails

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

engineVersion

PackageDetails.Builder engineVersion(String engineVersion)

Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Parameters:

engineVersion - Version of OpenSearch or Elasticsearch, in the format Elasticsearch_X.Y or OpenSearch_X.Y. Defaults to the latest version of OpenSearch.

Returns:

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

availablePluginProperties

PackageDetails.Builder availablePluginProperties(PluginProperties availablePluginProperties)

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

Parameters:

availablePluginProperties - If the package is a ZIP-PLUGIN package, additional information about plugin properties.

Returns:

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

availablePluginProperties

default PackageDetails.Builder availablePluginProperties(Consumer<PluginProperties.Builder> availablePluginProperties)

If the package is a ZIP-PLUGIN package, additional information about plugin properties.

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

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

Parameters:

availablePluginProperties - a consumer that will call methods on PluginProperties.Builder

Returns:

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

See Also:

availablePluginProperties(PluginProperties)

availablePackageConfiguration

PackageDetails.Builder availablePackageConfiguration(PackageConfiguration availablePackageConfiguration)

This represents the available configuration parameters for the package.

Parameters:

availablePackageConfiguration - This represents the available configuration parameters for the package.

Returns:

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

availablePackageConfiguration

default PackageDetails.Builder availablePackageConfiguration(Consumer<PackageConfiguration.Builder> availablePackageConfiguration)

This represents the available configuration parameters for the package.

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

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

Parameters:

availablePackageConfiguration - a consumer that will call methods on PackageConfiguration.Builder

Returns:

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

See Also:

availablePackageConfiguration(PackageConfiguration)

allowListedUserList

PackageDetails.Builder allowListedUserList(Collection<String> allowListedUserList)

A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

Parameters:

allowListedUserList - A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

Returns:

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

allowListedUserList

PackageDetails.Builder allowListedUserList(String... allowListedUserList)

A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

Parameters:

allowListedUserList - A list of users who are allowed to view and associate the package. This field is only visible to the owner of a package.

Returns:

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

packageOwner

PackageDetails.Builder packageOwner(String packageOwner)

The owner of the package who is allowed to create and update a package and add users to the package scope.

Parameters:

packageOwner - The owner of the package who is allowed to create and update a package and add users to the package scope.

Returns:

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

packageVendingOptions

PackageDetails.Builder packageVendingOptions(PackageVendingOptions packageVendingOptions)

Package Vending Options for a package.

Parameters:

packageVendingOptions - Package Vending Options for a package.

Returns:

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

packageVendingOptions

default PackageDetails.Builder packageVendingOptions(Consumer<PackageVendingOptions.Builder> packageVendingOptions)

Package Vending Options for a package.

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

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

Parameters:

packageVendingOptions - a consumer that will call methods on PackageVendingOptions.Builder

Returns:

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

See Also:

packageVendingOptions(PackageVendingOptions)

packageEncryptionOptions

PackageDetails.Builder packageEncryptionOptions(PackageEncryptionOptions packageEncryptionOptions)

Encryption options for a package.

Parameters:

packageEncryptionOptions - Encryption options for a package.

Returns:

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

packageEncryptionOptions

default PackageDetails.Builder packageEncryptionOptions(Consumer<PackageEncryptionOptions.Builder> packageEncryptionOptions)

Encryption options for a package.

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

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

Parameters:

packageEncryptionOptions - a consumer that will call methods on PackageEncryptionOptions.Builder

Returns:

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

See Also:

packageEncryptionOptions(PackageEncryptionOptions)