Interface CreatePackageRequest.Builder

All Superinterfaces:

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

Enclosing class:

CreatePackageRequest

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

Method Summary

Modifier and Type	Method	Description
CreatePackageRequest.Builder	engineVersion(String engineVersion)	The version of the Amazon OpenSearch Service engine for which is compatible with the package.
CreatePackageRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreatePackageRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
default CreatePackageRequest.Builder	packageConfiguration(Consumer<PackageConfiguration.Builder> packageConfiguration)	The configuration parameters for the package being created.
CreatePackageRequest.Builder	packageConfiguration(PackageConfiguration packageConfiguration)	The configuration parameters for the package being created.
CreatePackageRequest.Builder	packageDescription(String packageDescription)	Description of the package.
default CreatePackageRequest.Builder	packageEncryptionOptions(Consumer<PackageEncryptionOptions.Builder> packageEncryptionOptions)	The encryption parameters for the package being created.
CreatePackageRequest.Builder	packageEncryptionOptions(PackageEncryptionOptions packageEncryptionOptions)	The encryption parameters for the package being created.
CreatePackageRequest.Builder	packageName(String packageName)	Unique name for the package.
default CreatePackageRequest.Builder	packageSource(Consumer<PackageSource.Builder> packageSource)	The Amazon S3 location from which to import the package.
CreatePackageRequest.Builder	packageSource(PackageSource packageSource)	The Amazon S3 location from which to import the package.
CreatePackageRequest.Builder	packageType(String packageType)	The type of package.
CreatePackageRequest.Builder	packageType(PackageType packageType)	The type of package.
default CreatePackageRequest.Builder	packageVendingOptions(Consumer<PackageVendingOptions.Builder> packageVendingOptions)	The vending options for the package being created.
CreatePackageRequest.Builder	packageVendingOptions(PackageVendingOptions packageVendingOptions)	The vending options for the package being created.

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

packageName

CreatePackageRequest.Builder packageName(String packageName)

Unique name for the package.

Parameters:

packageName - Unique name for the package.

Returns:

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

packageType

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

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

CreatePackageRequest.Builder packageDescription(String packageDescription)

Description of the package.

Parameters:

packageDescription - Description of the package.

Returns:

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

packageSource

CreatePackageRequest.Builder packageSource(PackageSource packageSource)

The Amazon S3 location from which to import the package.

Parameters:

packageSource - The Amazon S3 location from which to import the package.

Returns:

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

packageSource

default CreatePackageRequest.Builder packageSource(Consumer<PackageSource.Builder> packageSource)

The Amazon S3 location from which to import the package.

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

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

Parameters:

packageSource - a consumer that will call methods on PackageSource.Builder

Returns:

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

See Also:

• packageSource(PackageSource)

packageConfiguration

CreatePackageRequest.Builder packageConfiguration(PackageConfiguration packageConfiguration)

The configuration parameters for the package being created.

Parameters:

packageConfiguration - The configuration parameters for the package being created.

Returns:

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

packageConfiguration

default CreatePackageRequest.Builder packageConfiguration(Consumer<PackageConfiguration.Builder> packageConfiguration)

The configuration parameters for the package being created.

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 packageConfiguration(PackageConfiguration).

Parameters:

packageConfiguration - 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:

• packageConfiguration(PackageConfiguration)

engineVersion

CreatePackageRequest.Builder engineVersion(String engineVersion)

The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN

Parameters:

engineVersion - The version of the Amazon OpenSearch Service engine for which is compatible with the package. This can only be specified for package type ZIP-PLUGIN

Returns:

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

packageVendingOptions

CreatePackageRequest.Builder packageVendingOptions(PackageVendingOptions packageVendingOptions)

The vending options for the package being created. They determine if the package can be vended to other users.

Parameters:

packageVendingOptions - The vending options for the package being created. They determine if the package can be vended to other users.

Returns:

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

packageVendingOptions

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

The vending options for the package being created. They determine if the package can be vended to other users.

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

CreatePackageRequest.Builder packageEncryptionOptions(PackageEncryptionOptions packageEncryptionOptions)

The encryption parameters for the package being created.

Parameters:

packageEncryptionOptions - The encryption parameters for the package being created.

Returns:

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

packageEncryptionOptions

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

The encryption parameters for the package being created.

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)

overrideConfiguration

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

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