Package software.amazon.awssdk.services.pcaconnectorad.model

Class PrivateKeyFlagsV4

java.lang.Object

software.amazon.awssdk.services.pcaconnectorad.model.PrivateKeyFlagsV4

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<PrivateKeyFlagsV4.Builder,PrivateKeyFlagsV4>

@Generated("software.amazon.awssdk:codegen")
public final class PrivateKeyFlagsV4
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<PrivateKeyFlagsV4.Builder,PrivateKeyFlagsV4>

Private key flags for v4 templates specify the client compatibility, if the private key can be exported, if user input is required when using a private key, if an alternate signature algorithm should be used, and if certificates are renewed using the same private key.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	PrivateKeyFlagsV4.Builder

Method Summary

Modifier and Type	Method	Description
static PrivateKeyFlagsV4.Builder	builder()
ClientCompatibilityV4	clientVersion()	Defines the minimum client compatibility.
String	clientVersionAsString()	Defines the minimum client compatibility.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
Boolean	exportableKey()	Allows the private key to be exported.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	requireAlternateSignatureAlgorithm()	Requires the PKCS #1 v2.1 signature format for certificates.
Boolean	requireSameKeyRenewal()	Renew certificate using the same private key.
List<SdkField<?>>	sdkFields()
static Class<? extends PrivateKeyFlagsV4.Builder>	serializableBuilderClass()
Boolean	strongKeyProtectionRequired()	Require user input when using the private key for enrollment.
PrivateKeyFlagsV4.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Boolean	useLegacyProvider()	Specifies the cryptographic service provider category used to generate private keys.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

clientVersion

public final ClientCompatibilityV4 clientVersion()

Defines the minimum client compatibility.

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

Returns:

Defines the minimum client compatibility.

See Also:

ClientCompatibilityV4

clientVersionAsString

public final String clientVersionAsString()

Defines the minimum client compatibility.

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

Returns:

Defines the minimum client compatibility.

See Also:

ClientCompatibilityV4

exportableKey

public final Boolean exportableKey()

Allows the private key to be exported.

Returns:

Allows the private key to be exported.

requireAlternateSignatureAlgorithm

public final Boolean requireAlternateSignatureAlgorithm()

Requires the PKCS #1 v2.1 signature format for certificates. You should verify that your CA, objects, and applications can accept this signature format.

Returns:

Requires the PKCS #1 v2.1 signature format for certificates. You should verify that your CA, objects, and applications can accept this signature format.

requireSameKeyRenewal

public final Boolean requireSameKeyRenewal()

Renew certificate using the same private key.

Returns:

Renew certificate using the same private key.

strongKeyProtectionRequired

public final Boolean strongKeyProtectionRequired()

Require user input when using the private key for enrollment.

Returns:

Require user input when using the private key for enrollment.

useLegacyProvider

public final Boolean useLegacyProvider()

Specifies the cryptographic service provider category used to generate private keys. Set to TRUE to use Legacy Cryptographic Service Providers and FALSE to use Key Storage Providers.

Returns:

Specifies the cryptographic service provider category used to generate private keys. Set to TRUE to use Legacy Cryptographic Service Providers and FALSE to use Key Storage Providers.

toBuilder

public PrivateKeyFlagsV4.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PrivateKeyFlagsV4.Builder,PrivateKeyFlagsV4>

builder

public static PrivateKeyFlagsV4.Builder builder()

serializableBuilderClass

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

Specified by:

equalsBySdkFields in interface SdkPojo

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