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

Interface UpgradeDomainResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<UpgradeDomainResponse.Builder,UpgradeDomainResponse>, OpenSearchResponse.Builder, SdkBuilder<UpgradeDomainResponse.Builder,UpgradeDomainResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

UpgradeDomainResponse

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

Method Summary

Modifier and Type	Method	Description
UpgradeDomainResponse.Builder	advancedOptions(Map<String,String> advancedOptions)	The advanced options configuration for the domain.
default UpgradeDomainResponse.Builder	changeProgressDetails(Consumer<ChangeProgressDetails.Builder> changeProgressDetails)	Container for information about a configuration change happening on a domain.
UpgradeDomainResponse.Builder	changeProgressDetails(ChangeProgressDetails changeProgressDetails)	Container for information about a configuration change happening on a domain.
UpgradeDomainResponse.Builder	domainName(String domainName)	The name of the domain that was upgraded.
UpgradeDomainResponse.Builder	performCheckOnly(Boolean performCheckOnly)	When true, indicates that an upgrade eligibility check was performed.
UpgradeDomainResponse.Builder	targetVersion(String targetVersion)	OpenSearch or Elasticsearch version that the domain was upgraded to.
UpgradeDomainResponse.Builder	upgradeId(String upgradeId)	The unique identifier of the domain upgrade.

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

copy

Methods inherited from interface software.amazon.awssdk.services.opensearch.model.OpenSearchResponse.Builder

build, responseMetadata, responseMetadata

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

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Detail

upgradeId

UpgradeDomainResponse.Builder upgradeId(String upgradeId)

The unique identifier of the domain upgrade.

Parameters:

upgradeId - The unique identifier of the domain upgrade.

Returns:

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

domainName

UpgradeDomainResponse.Builder domainName(String domainName)

The name of the domain that was upgraded.

Parameters:

domainName - The name of the domain that was upgraded.

Returns:

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

targetVersion

UpgradeDomainResponse.Builder targetVersion(String targetVersion)

OpenSearch or Elasticsearch version that the domain was upgraded to.

Parameters:

targetVersion - OpenSearch or Elasticsearch version that the domain was upgraded to.

Returns:

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

performCheckOnly

UpgradeDomainResponse.Builder performCheckOnly(Boolean performCheckOnly)

When true, indicates that an upgrade eligibility check was performed.

Parameters:

performCheckOnly - When true, indicates that an upgrade eligibility check was performed.

Returns:

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

advancedOptions

UpgradeDomainResponse.Builder advancedOptions(Map<String,String> advancedOptions)

The advanced options configuration for the domain.

Parameters:

advancedOptions - The advanced options configuration for the domain.

Returns:

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

changeProgressDetails

UpgradeDomainResponse.Builder changeProgressDetails(ChangeProgressDetails changeProgressDetails)

Container for information about a configuration change happening on a domain.

Parameters:

changeProgressDetails - Container for information about a configuration change happening on a domain.

Returns:

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

changeProgressDetails

default UpgradeDomainResponse.Builder changeProgressDetails(Consumer<ChangeProgressDetails.Builder> changeProgressDetails)

Container for information about a configuration change happening on a domain.

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

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

Parameters:

changeProgressDetails - a consumer that will call methods on ChangeProgressDetails.Builder

Returns:

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

See Also:

changeProgressDetails(ChangeProgressDetails)