Class TemplateSummary

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

An Active Directory compatible certificate template. Connectors issue certificates against these templates based on the requestor's Active Directory group membership.

See Also:

  • Method Details

    • arn

      public final String arn()

      The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

      Returns:
      The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.

    • connectorArn

      public final String connectorArn()

      The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

      Returns:
      The Amazon Resource Name (ARN) that was returned when you called CreateConnector.

    • createdAt

      public final Instant createdAt()

      The date and time that the template was created.

      Returns:
      The date and time that the template was created.

    • definition

      public final TemplateDefinition definition()

      Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

      Returns:
      Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.

    • name

      public final String name()

      Name of the template. The template name must be unique.

      Returns:
      Name of the template. The template name must be unique.

    • objectIdentifier

      public final String objectIdentifier()

      Object identifier of a template.

      Returns:
      Object identifier of a template.

    • policySchema

      public final Integer policySchema()

      The template schema version. Template schema versions can be v2, v3, or v4. The template configuration options change based on the template schema version.

      Returns:
      The template schema version. Template schema versions can be v2, v3, or v4. The template configuration options change based on the template schema version.

    • revision

      public final TemplateRevision revision()

      The revision version of the template. Template updates will increment the minor revision. Re-enrolling all certificate holders will increment the major revision.

      Returns:
      The revision version of the template. Template updates will increment the minor revision. Re-enrolling all certificate holders will increment the major revision.

    • status

      public final TemplateStatus status()

      Status of the template. Status can be creating, active, deleting, or failed.

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

      Returns:
      Status of the template. Status can be creating, active, deleting, or failed.
      See Also:

    • statusAsString

      public final String statusAsString()

      Status of the template. Status can be creating, active, deleting, or failed.

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

      Returns:
      Status of the template. Status can be creating, active, deleting, or failed.
      See Also:

    • updatedAt

      public final Instant updatedAt()

      The date and time that the template was updated.

      Returns:
      The date and time that the template was updated.

    • toBuilder

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

    • builder

      public static TemplateSummary.Builder builder()

    • serializableBuilderClass

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