Class PolicyVersion

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

Contains details for the version of a policy. Policies define what operations a team that define the permissions for team resources.

The protected operation for a service integration might require specific permissions. For more information, see How other services work with Multi-party approval in the Multi-party approval User Guide.

See Also:

  • Method Details

    • arn

      public final String arn()

      Amazon Resource Name (ARN) for the team.

      Returns:
      Amazon Resource Name (ARN) for the team.

    • policyArn

      public final String policyArn()

      Amazon Resource Name (ARN) for the policy.

      Returns:
      Amazon Resource Name (ARN) for the policy.

    • versionId

      public final Integer versionId()

      Verison ID

      Returns:
      Verison ID

    • policyType

      public final PolicyType policyType()

      The type of policy.

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

      Returns:
      The type of policy.
      See Also:

    • policyTypeAsString

      public final String policyTypeAsString()

      The type of policy.

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

      Returns:
      The type of policy.
      See Also:

    • isDefault

      public final Boolean isDefault()

      Determines if the specified policy is the default for the team.

      Returns:
      Determines if the specified policy is the default for the team.

    • name

      public final String name()

      Name of the policy.

      Returns:
      Name of the policy.

    • status

      public final PolicyStatus status()

      Status for the policy. For example, if the policy is attachable or deprecated.

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

      Returns:
      Status for the policy. For example, if the policy is attachable or deprecated.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status for the policy. For example, if the policy is attachable or deprecated.

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

      Returns:
      Status for the policy. For example, if the policy is attachable or deprecated.
      See Also:

    • creationTime

      public final Instant creationTime()

      Timestamp when the policy was created.

      Returns:
      Timestamp when the policy was created.

    • lastUpdatedTime

      public final Instant lastUpdatedTime()

      Timestamp when the policy was last updated.

      Returns:
      Timestamp when the policy was last updated.

    • document

      public final String document()

      Document that contains the policy contents.

      Returns:
      Document that contains the policy contents.

    • toBuilder

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

    • builder

      public static PolicyVersion.Builder builder()

    • serializableBuilderClass

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