software.amazon.awssdk.services.pcaconnectorad.model

Class PrivateKeyAttributesV4

java.lang.Object

software.amazon.awssdk.services.pcaconnectorad.model.PrivateKeyAttributesV4

All Implemented Interfaces:

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

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

Defines the attributes of the private key.

See Also:

Serialized Form

Property Summary

Type	Property and Description
KeyUsageProperty	keyUsage The key usage property defines the purpose of the private key contained in the certificate.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	PrivateKeyAttributesV4.Builder

Method Summary

Modifier and Type	Method and Description
PrivateKeyAlgorithm	algorithm() Defines the algorithm used to generate the private key.
String	algorithmAsString() Defines the algorithm used to generate the private key.
static PrivateKeyAttributesV4.Builder	builder()
List<String>	cryptoProviders() Defines the cryptographic providers used to generate the private key.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCryptoProviders() For responses, this returns true if the service returned a value for the CryptoProviders property.
int	hashCode()
KeySpec	keySpec() Defines the purpose of the private key.
String	keySpecAsString() Defines the purpose of the private key.
KeyUsageProperty	keyUsageProperty() The key usage property defines the purpose of the private key contained in the certificate.
Integer	minimalKeyLength() Set the minimum key length of the private key.
List<SdkField<?>>	sdkFields()
static Class<? extends PrivateKeyAttributesV4.Builder>	serializableBuilderClass()
PrivateKeyAttributesV4.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

Property Detail

keyUsage

public final KeyUsageProperty keyUsageProperty

The key usage property defines the purpose of the private key contained in the certificate. You can specify specific purposes using property flags or all by using property type ALL.

Method Detail

algorithm

public final PrivateKeyAlgorithm algorithm()

Defines the algorithm used to generate the private key.

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

Returns:

Defines the algorithm used to generate the private key.

See Also:

PrivateKeyAlgorithm

algorithmAsString

public final String algorithmAsString()

Defines the algorithm used to generate the private key.

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

Returns:

Defines the algorithm used to generate the private key.

See Also:

PrivateKeyAlgorithm

hasCryptoProviders

public final boolean hasCryptoProviders()

For responses, this returns true if the service returned a value for the CryptoProviders 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.

cryptoProviders

public final List<String> cryptoProviders()

Defines the cryptographic providers used to generate the private key.

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

Returns:

Defines the cryptographic providers used to generate the private key.

keySpec

public final KeySpec keySpec()

Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE" value.

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

Returns:

Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE" value.

See Also:

KeySpec

keySpecAsString

public final String keySpecAsString()

Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE" value.

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

Returns:

Defines the purpose of the private key. Set it to "KEY_EXCHANGE" or "SIGNATURE" value.

See Also:

KeySpec

keyUsageProperty

public final KeyUsageProperty keyUsageProperty()

The key usage property defines the purpose of the private key contained in the certificate. You can specify specific purposes using property flags or all by using property type ALL.

minimalKeyLength

public final Integer minimalKeyLength()

Set the minimum key length of the private key.

Returns:

Set the minimum key length of the private key.

toBuilder

public PrivateKeyAttributesV4.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<PrivateKeyAttributesV4.Builder,PrivateKeyAttributesV4>

builder

public static PrivateKeyAttributesV4.Builder builder()

serializableBuilderClass

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