Class ReplacePermissionAssociationsWork

java.lang.Object
software.amazon.awssdk.services.ram.model.ReplacePermissionAssociationsWork
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ReplacePermissionAssociationsWork.Builder,ReplacePermissionAssociationsWork>
@Generated("software.amazon.awssdk:codegen") public final class ReplacePermissionAssociationsWork extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ReplacePermissionAssociationsWork.Builder,ReplacePermissionAssociationsWork>

A structure that represents the background work that RAM performs when you invoke the ReplacePermissionAssociations operation.

See Also:

  • Method Details

    • id

      public final String id()

      The unique identifier for the background task associated with one ReplacePermissionAssociations request.

      Returns:
      The unique identifier for the background task associated with one ReplacePermissionAssociations request.

    • fromPermissionArn

      public final String fromPermissionArn()

      The Amazon Resource Name (ARN) of the managed permission that this background task is replacing.

      Returns:
      The Amazon Resource Name (ARN) of the managed permission that this background task is replacing.

    • fromPermissionVersion

      public final String fromPermissionVersion()

      The version of the managed permission that this background task is replacing.

      Returns:
      The version of the managed permission that this background task is replacing.

    • toPermissionArn

      public final String toPermissionArn()

      The ARN of the managed permission that this background task is associating with the resource shares in place of the managed permission and version specified in fromPermissionArn and fromPermissionVersion.

      Returns:
      The ARN of the managed permission that this background task is associating with the resource shares in place of the managed permission and version specified in fromPermissionArn and fromPermissionVersion.

    • toPermissionVersion

      public final String toPermissionVersion()

      The version of the managed permission that this background task is associating with the resource shares. This is always the version that is currently the default for this managed permission.

      Returns:
      The version of the managed permission that this background task is associating with the resource shares. This is always the version that is currently the default for this managed permission.

    • status

      public final ReplacePermissionAssociationsWorkStatus status()

      Specifies the current status of the background tasks for the specified ID. The output is one of the following strings:

      • IN_PROGRESS

      • COMPLETED

      • FAILED

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

      Returns:
      Specifies the current status of the background tasks for the specified ID. The output is one of the following strings:

      • IN_PROGRESS

      • COMPLETED

      • FAILED

      See Also:

    • statusAsString

      public final String statusAsString()

      Specifies the current status of the background tasks for the specified ID. The output is one of the following strings:

      • IN_PROGRESS

      • COMPLETED

      • FAILED

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

      Returns:
      Specifies the current status of the background tasks for the specified ID. The output is one of the following strings:

      • IN_PROGRESS

      • COMPLETED

      • FAILED

      See Also:

    • statusMessage

      public final String statusMessage()

      Specifies the reason for a FAILED status. This field is present only when there status is FAILED.

      Returns:
      Specifies the reason for a FAILED status. This field is present only when there status is FAILED.

    • creationTime

      public final Instant creationTime()

      The date and time when this asynchronous background task was created.

      Returns:
      The date and time when this asynchronous background task was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      The date and time when the status of this background task was last updated.

      Returns:
      The date and time when the status of this background task was last updated.

    • toBuilder

      public ReplacePermissionAssociationsWork.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<ReplacePermissionAssociationsWork.Builder,ReplacePermissionAssociationsWork>
      Returns:
      a builder for type T

    • builder

      public static ReplacePermissionAssociationsWork.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

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

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.