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

Class UpdatePackageScopeRequest

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.UpdatePackageScopeRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdatePackageScopeRequest.Builder,UpdatePackageScopeRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdatePackageScopeRequest extends OpenSearchRequest implements ToCopyableBuilder<UpdatePackageScopeRequest.Builder,UpdatePackageScopeRequest>

  • Method Details

    • packageID

      public final String packageID()

      ID of the package whose scope is being updated.

      Returns:
      ID of the package whose scope is being updated.

    • operation

      public final PackageScopeOperationEnum operation()

      The operation to perform on the package scope (e.g., add/remove/override users).

      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 to perform on the package scope (e.g., add/remove/override users).
      See Also:

    • operationAsString

      public final String operationAsString()

      The operation to perform on the package scope (e.g., add/remove/override users).

      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 to perform on the package scope (e.g., add/remove/override users).
      See Also:

    • 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 to be added or removed from the package scope.

      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 to be added or removed from the package scope.

    • toBuilder

      public UpdatePackageScopeRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdatePackageScopeRequest.Builder,UpdatePackageScopeRequest>
      Specified by:
      toBuilder in class OpenSearchRequest

    • builder

      public static UpdatePackageScopeRequest.Builder builder()

    • serializableBuilderClass

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