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

Class UpdatePackageScopeResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.opensearch.model.OpenSearchResponse

software.amazon.awssdk.services.opensearch.model.UpdatePackageScopeResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdatePackageScopeResponse.Builder,UpdatePackageScopeResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	UpdatePackageScopeResponse.Builder

Method Summary

Modifier and Type	Method	Description
static UpdatePackageScopeResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasPackageUserList()	For responses, this returns true if the service returned a value for the PackageUserList property.
PackageScopeOperationEnum	operation()	The operation that was performed on the package scope.
String	operationAsString()	The operation that was performed on the package scope.
String	packageID()	ID of the package whose scope was updated.
List<String>	packageUserList()	List of users who have access to the package after the scope update.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends UpdatePackageScopeResponse.Builder>	serializableBuilderClass()
UpdatePackageScopeResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.opensearch.model.OpenSearchResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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()

ID of the package whose scope was updated.

Returns:

ID of the package whose scope was updated.

operation

public final PackageScopeOperationEnum operation()

The operation that was performed on the package scope.

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

Returns:

The operation that was performed on the package scope.

See Also:

PackageScopeOperationEnum

operationAsString

public final String operationAsString()

The operation that was performed on the package scope.

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

Returns:

The operation that was performed on the package scope.

See Also:

PackageScopeOperationEnum

hasPackageUserList

public final boolean hasPackageUserList()

For responses, this returns true if the service returned a value for the PackageUserList 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.

packageUserList

public final List<String> packageUserList()

List of users who have access to the package after the scope update.

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 hasPackageUserList() method.

Returns:

List of users who have access to the package after the scope update.

toBuilder

public UpdatePackageScopeResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<UpdatePackageScopeResponse.Builder,UpdatePackageScopeResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static UpdatePackageScopeResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

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