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

Class CreatePackageRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.opensearch.model.OpenSearchRequest

software.amazon.awssdk.services.opensearch.model.CreatePackageRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreatePackageRequest.Builder,CreatePackageRequest>

@Generated("software.amazon.awssdk:codegen")
public final class CreatePackageRequest
extends OpenSearchRequest
implements ToCopyableBuilder<CreatePackageRequest.Builder,CreatePackageRequest>

Container for request parameters to the CreatePackage operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreatePackageRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreatePackageRequest.Builder	builder()
String	engineVersion()	The version of the Amazon OpenSearch Service engine for which is compatible with the package.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
PackageConfiguration	packageConfiguration()	The configuration parameters for the package being created.
String	packageDescription()	Description of the package.
PackageEncryptionOptions	packageEncryptionOptions()	The encryption parameters for the package being created.
String	packageName()	Unique name for the package.
PackageSource	packageSource()	The Amazon S3 location from which to import the package.
PackageType	packageType()	The type of package.
String	packageTypeAsString()	The type of package.
PackageVendingOptions	packageVendingOptions()	The vending options for the package being created.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreatePackageRequest.Builder>	serializableBuilderClass()
CreatePackageRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

packageName

public final String packageName()

Unique name for the package.

Returns:

Unique name for the package.

packageType

public final PackageType packageType()

The type of package.

If the service returns an enum value that is not available in the current SDK version, packageType will return PackageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageTypeAsString().

Returns:

The type of package.

See Also:

PackageType

packageTypeAsString

public final String packageTypeAsString()

The type of package.

If the service returns an enum value that is not available in the current SDK version, packageType will return PackageType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from packageTypeAsString().

Returns:

The type of package.

See Also:

PackageType

packageDescription

public final String packageDescription()

Description of the package.

Returns:

Description of the package.

packageSource

public final PackageSource packageSource()

The Amazon S3 location from which to import the package.

Returns:

The Amazon S3 location from which to import the package.

packageConfiguration

public final PackageConfiguration packageConfiguration()

The configuration parameters for the package being created.

Returns:

The configuration parameters for the package being created.

engineVersion

public final 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

Returns:

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

packageVendingOptions

public final PackageVendingOptions packageVendingOptions()

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

Returns:

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

packageEncryptionOptions

public final PackageEncryptionOptions packageEncryptionOptions()

The encryption parameters for the package being created.

Returns:

The encryption parameters for the package being created.

toBuilder

public CreatePackageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreatePackageRequest.Builder,CreatePackageRequest>

Specified by:

toBuilder in class OpenSearchRequest

builder

public static CreatePackageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreatePackageRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo