Class DistinguishedName

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

Contains X.500 distinguished name information.

See Also:

  • Method Details

    • commonName

      public final String commonName()

      The common name (CN) attribute.

      Returns:
      The common name (CN) attribute.

    • hasDomainComponents

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

    • domainComponents

      public final List<String> domainComponents()

      The domain component attributes.

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

      Returns:
      The domain component attributes.

    • country

      public final String country()

      The country (C) attribute.

      Returns:
      The country (C) attribute.

    • hasCustomAttributes

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

    • customAttributes

      public final List<CustomAttribute> customAttributes()

      A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.

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

      Returns:
      A list of custom attributes in the distinguished name. Each custom attribute contains an object identifier (OID) and its corresponding value.

    • distinguishedNameQualifier

      public final String distinguishedNameQualifier()

      The distinguished name qualifier attribute.

      Returns:
      The distinguished name qualifier attribute.

    • generationQualifier

      public final String generationQualifier()

      The generation qualifier attribute.

      Returns:
      The generation qualifier attribute.

    • givenName

      public final String givenName()

      The given name attribute.

      Returns:
      The given name attribute.

    • initials

      public final String initials()

      The initials attribute.

      Returns:
      The initials attribute.

    • locality

      public final String locality()

      The locality (L) attribute.

      Returns:
      The locality (L) attribute.

    • organization

      public final String organization()

      The organization (O) attribute.

      Returns:
      The organization (O) attribute.

    • organizationalUnit

      public final String organizationalUnit()

      The organizational unit (OU) attribute.

      Returns:
      The organizational unit (OU) attribute.

    • pseudonym

      public final String pseudonym()

      The pseudonym attribute.

      Returns:
      The pseudonym attribute.

    • serialNumber

      public final String serialNumber()

      The serial number attribute.

      Returns:
      The serial number attribute.

    • state

      public final String state()

      The state or province (ST) attribute.

      Returns:
      The state or province (ST) attribute.

    • surname

      public final String surname()

      The surname attribute.

      Returns:
      The surname attribute.

    • title

      public final String title()

      The title attribute.

      Returns:
      The title attribute.

    • toBuilder

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

    • builder

      public static DistinguishedName.Builder builder()

    • serializableBuilderClass

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