Class PendingUpdate

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

Contains details for the pending updates for an approval team, if applicable.

See Also:

  • Method Details

    • versionId

      public final String versionId()

      Version ID for the team.

      Returns:
      Version ID for the team.

    • description

      public final String description()

      Description for the team.

      Returns:
      Description for the team.

    • approvalStrategy

      public final ApprovalStrategyResponse approvalStrategy()

      An ApprovalStrategyResponse object. Contains details for how the team grants approval.

      Returns:
      An ApprovalStrategyResponse object. Contains details for how the team grants approval.

    • numberOfApprovers

      public final Integer numberOfApprovers()

      Total number of approvers in the team.

      Returns:
      Total number of approvers in the team.

    • status

      public final ApprovalTeamStatus status()

      Status for the team. For more information, see Team health in the Multi-party approval User Guide.

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

      Returns:
      Status for the team. For more information, see Team health in the Multi-party approval User Guide.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status for the team. For more information, see Team health in the Multi-party approval User Guide.

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

      Returns:
      Status for the team. For more information, see Team health in the Multi-party approval User Guide.
      See Also:

    • statusCode

      public final ApprovalTeamStatusCode statusCode()

      Status code for the update. For more information, see Team health in the Multi-party approval User Guide.

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

      Returns:
      Status code for the update. For more information, see Team health in the Multi-party approval User Guide.
      See Also:

    • statusCodeAsString

      public final String statusCodeAsString()

      Status code for the update. For more information, see Team health in the Multi-party approval User Guide.

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

      Returns:
      Status code for the update. For more information, see Team health in the Multi-party approval User Guide.
      See Also:

    • statusMessage

      public final String statusMessage()

      Message describing the status for the team.

      Returns:
      Message describing the status for the team.

    • hasApprovers

      public final boolean hasApprovers()
      For responses, this returns true if the service returned a value for the Approvers 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.

    • approvers

      public final List<GetApprovalTeamResponseApprover> approvers()

      An array of GetApprovalTeamResponseApprover objects. Contains details for the approvers in the team.

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

      Returns:
      An array of GetApprovalTeamResponseApprover objects. Contains details for the approvers in the team.

    • updateInitiationTime

      public final Instant updateInitiationTime()

      Timestamp when the update request was initiated.

      Returns:
      Timestamp when the update request was initiated.

    • toBuilder

      public PendingUpdate.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<PendingUpdate.Builder,PendingUpdate>
      Returns:
      a builder for type T

    • builder

      public static PendingUpdate.Builder builder()

    • serializableBuilderClass

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