Class GeneralName

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

Describes an ASN.1 X.400 GeneralName as defined in RFC 5280. Only one of the following naming options should be provided.

See Also:

  • Method Details

    • directoryName

      public final DistinguishedName directoryName()

      Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

      Returns:
      Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

    • dnsName

      public final String dnsName()

      Represents GeneralName as a DNS name.

      Returns:
      Represents GeneralName as a DNS name.

    • ipAddress

      public final String ipAddress()

      Represents GeneralName as an IPv4 or IPv6 address.

      Returns:
      Represents GeneralName as an IPv4 or IPv6 address.

    • otherName

      public final OtherName otherName()

      Represents GeneralName using an OtherName object.

      Returns:
      Represents GeneralName using an OtherName object.

    • registeredId

      public final String registeredId()

      Represents GeneralName as an object identifier (OID).

      Returns:
      Represents GeneralName as an object identifier (OID).

    • rfc822Name

      public final String rfc822Name()

      Represents GeneralName as an RFC 822 email address.

      Returns:
      Represents GeneralName as an RFC 822 email address.

    • uniformResourceIdentifier

      public final String uniformResourceIdentifier()

      Represents GeneralName as a URI.

      Returns:
      Represents GeneralName as a URI.

    • toBuilder

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

    • builder

      public static GeneralName.Builder builder()

    • serializableBuilderClass

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

    • fromDirectoryName

      public static GeneralName fromDirectoryName(DistinguishedName directoryName)
      Create an instance of this class with directoryName() initialized to the given value.

      Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

      Parameters:
      directoryName - Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

    • fromDirectoryName

      public static GeneralName fromDirectoryName(Consumer<DistinguishedName.Builder> directoryName)
      Create an instance of this class with directoryName() initialized to the given value.

      Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

      Parameters:
      directoryName - Contains information about the certificate subject. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate.

    • fromDnsName

      public static GeneralName fromDnsName(String dnsName)
      Create an instance of this class with dnsName() initialized to the given value.

      Represents GeneralName as a DNS name.

      Parameters:
      dnsName - Represents GeneralName as a DNS name.

    • fromIpAddress

      public static GeneralName fromIpAddress(String ipAddress)
      Create an instance of this class with ipAddress() initialized to the given value.

      Represents GeneralName as an IPv4 or IPv6 address.

      Parameters:
      ipAddress - Represents GeneralName as an IPv4 or IPv6 address.

    • fromOtherName

      public static GeneralName fromOtherName(OtherName otherName)
      Create an instance of this class with otherName() initialized to the given value.

      Represents GeneralName using an OtherName object.

      Parameters:
      otherName - Represents GeneralName using an OtherName object.

    • fromOtherName

      public static GeneralName fromOtherName(Consumer<OtherName.Builder> otherName)
      Create an instance of this class with otherName() initialized to the given value.

      Represents GeneralName using an OtherName object.

      Parameters:
      otherName - Represents GeneralName using an OtherName object.

    • fromRegisteredId

      public static GeneralName fromRegisteredId(String registeredId)
      Create an instance of this class with registeredId() initialized to the given value.

      Represents GeneralName as an object identifier (OID).

      Parameters:
      registeredId - Represents GeneralName as an object identifier (OID).

    • fromRfc822Name

      public static GeneralName fromRfc822Name(String rfc822Name)
      Create an instance of this class with rfc822Name() initialized to the given value.

      Represents GeneralName as an RFC 822 email address.

      Parameters:
      rfc822Name - Represents GeneralName as an RFC 822 email address.

    • fromUniformResourceIdentifier

      public static GeneralName fromUniformResourceIdentifier(String uniformResourceIdentifier)
      Create an instance of this class with uniformResourceIdentifier() initialized to the given value.

      Represents GeneralName as a URI.

      Parameters:
      uniformResourceIdentifier - Represents GeneralName as a URI.

    • type

      public GeneralName.Type type()
      Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will be GeneralName.Type.UNKNOWN_TO_SDK_VERSION if the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will be GeneralName.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.

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