Class TemplateV3
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<TemplateV3.Builder,
TemplateV3>
v3 template schema that uses Key Storage Providers.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic TemplateV3.Builder
builder()
final CertificateValidity
Certificate validity describes the validity and renewal periods of a certificate.final EnrollmentFlagsV3
Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final ExtensionsV3
Extensions describe the key usage extensions and application policies for a template.final GeneralFlagsV3
General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final HashAlgorithm
Specifies the hash algorithm used to hash the private key.final String
Specifies the hash algorithm used to hash the private key.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the SupersededTemplates property.final PrivateKeyAttributesV3
Private key attributes allow you to specify the algorithm, minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v3 templates.final PrivateKeyFlagsV3
Private key flags for v3 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, and if an alternate signature algorithm should be used.static Class
<? extends TemplateV3.Builder> final SubjectNameFlagsV3
Subject name flags describe the subject name and subject alternate name that is included in a certificate.List of templates in Active Directory that are superseded by this template.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
certificateValidity
Certificate validity describes the validity and renewal periods of a certificate.
- Returns:
- Certificate validity describes the validity and renewal periods of a certificate.
-
enrollmentFlags
Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.
- Returns:
- Enrollment flags describe the enrollment settings for certificates such as using the existing private key and deleting expired or revoked certificates.
-
extensions
Extensions describe the key usage extensions and application policies for a template.
- Returns:
- Extensions describe the key usage extensions and application policies for a template.
-
generalFlags
General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.
- Returns:
- General flags describe whether the template is used for computers or users and if the template can be used with autoenrollment.
-
hashAlgorithm
Specifies the hash algorithm used to hash the private key.
If the service returns an enum value that is not available in the current SDK version,
hashAlgorithm
will returnHashAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhashAlgorithmAsString()
.- Returns:
- Specifies the hash algorithm used to hash the private key.
- See Also:
-
hashAlgorithmAsString
Specifies the hash algorithm used to hash the private key.
If the service returns an enum value that is not available in the current SDK version,
hashAlgorithm
will returnHashAlgorithm.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromhashAlgorithmAsString()
.- Returns:
- Specifies the hash algorithm used to hash the private key.
- See Also:
-
privateKeyAttributes
Private key attributes allow you to specify the algorithm, minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v3 templates. V3 templates allow you to use Key Storage Providers.
- Returns:
- Private key attributes allow you to specify the algorithm, minimal key length, key spec, key usage, and cryptographic providers for the private key of a certificate for v3 templates. V3 templates allow you to use Key Storage Providers.
-
privateKeyFlags
Private key flags for v3 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, and if an alternate signature algorithm should be used.
- Returns:
- Private key flags for v3 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, and if an alternate signature algorithm should be used.
-
subjectNameFlags
Subject name flags describe the subject name and subject alternate name that is included in a certificate.
- Returns:
- Subject name flags describe the subject name and subject alternate name that is included in a certificate.
-
hasSupersededTemplates
public final boolean hasSupersededTemplates()For responses, this returns true if the service returned a value for the SupersededTemplates property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
supersededTemplates
List of templates in Active Directory that are superseded by this template.
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
hasSupersededTemplates()
method.- Returns:
- List of templates in Active Directory that are superseded by this template.
-
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 interfaceToCopyableBuilder<TemplateV3.Builder,
TemplateV3> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-