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

Class AssociatePackageRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<AssociatePackageRequest.Builder,AssociatePackageRequest>

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

Container for the request parameters to the AssociatePackage operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AssociatePackageRequest.Builder

Method Summary

Modifier and Type	Method	Description
PackageAssociationConfiguration	associationConfiguration()	The configuration for associating a package with an Amazon OpenSearch Service domain.
static AssociatePackageRequest.Builder	builder()
String	domainName()	Name of the domain to associate the package with.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPrerequisitePackageIDList()	For responses, this returns true if the service returned a value for the PrerequisitePackageIDList property.
String	packageID()	Internal ID of the package to associate with a domain.
List<String>	prerequisitePackageIDList()	A list of package IDs that must be associated with the domain before the package specified in the request can be associated.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AssociatePackageRequest.Builder>	serializableBuilderClass()
AssociatePackageRequest.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

packageID

public final String packageID()

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

Returns:

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

domainName

public final String domainName()

Name of the domain to associate the package with.

Returns:

Name of the domain to associate the package with.

hasPrerequisitePackageIDList

public final boolean hasPrerequisitePackageIDList()

For responses, this returns true if the service returned a value for the PrerequisitePackageIDList property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

prerequisitePackageIDList

public final List<String> prerequisitePackageIDList()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasPrerequisitePackageIDList() method.

Returns:

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

associationConfiguration

public final PackageAssociationConfiguration associationConfiguration()

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

Returns:

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

toBuilder

public AssociatePackageRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AssociatePackageRequest.Builder,AssociatePackageRequest>

Specified by:

toBuilder in class OpenSearchRequest

builder

public static AssociatePackageRequest.Builder builder()

serializableBuilderClass

public static Class<? extends AssociatePackageRequest.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