Package software.amazon.awssdk.services.organizations.model

Class PolicyTypeSummary

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

Contains information about a policy type and its status in the associated root.

See Also:

  • Method Details

    • type

      public final PolicyType type()

      The name of the policy type.

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

      Returns:
      The name of the policy type.
      See Also:

    • typeAsString

      public final String typeAsString()

      The name of the policy type.

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

      Returns:
      The name of the policy type.
      See Also:

    • status

      public final PolicyTypeStatus status()

      The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

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

      Returns:
      The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
      See Also:

    • statusAsString

      public final String statusAsString()

      The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.

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

      Returns:
      The status of the policy type as it relates to the associated root. To attach a policy of the specified type to a root or to an OU or account in that root, it must be available in the organization and enabled for that root.
      See Also:

    • toBuilder

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

    • builder

      public static PolicyTypeSummary.Builder builder()

    • serializableBuilderClass

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