Class KeyUsageProperty

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

See Also:

  • Method Details

    • propertyFlags

      public final KeyUsagePropertyFlags propertyFlags()

      You can specify key usage for encryption, key agreement, and signature. You can use property flags or property type but not both.

      Returns:
      You can specify key usage for encryption, key agreement, and signature. You can use property flags or property type but not both.

    • propertyType

      public final KeyUsagePropertyType propertyType()

      You can specify all key usages using property type ALL. You can use property type or property flags but not both.

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

      Returns:
      You can specify all key usages using property type ALL. You can use property type or property flags but not both.
      See Also:

    • propertyTypeAsString

      public final String propertyTypeAsString()

      You can specify all key usages using property type ALL. You can use property type or property flags but not both.

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

      Returns:
      You can specify all key usages using property type ALL. You can use property type or property flags but not both.
      See Also:

    • toBuilder

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

    • builder

      public static KeyUsageProperty.Builder builder()

    • serializableBuilderClass

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

    • fromPropertyFlags

      public static KeyUsageProperty fromPropertyFlags(KeyUsagePropertyFlags propertyFlags)
      Create an instance of this class with propertyFlags() initialized to the given value.

      You can specify key usage for encryption, key agreement, and signature. You can use property flags or property type but not both.

      Parameters:
      propertyFlags - You can specify key usage for encryption, key agreement, and signature. You can use property flags or property type but not both.

    • fromPropertyFlags

      public static KeyUsageProperty fromPropertyFlags(Consumer<KeyUsagePropertyFlags.Builder> propertyFlags)
      Create an instance of this class with propertyFlags() initialized to the given value.

      You can specify key usage for encryption, key agreement, and signature. You can use property flags or property type but not both.

      Parameters:
      propertyFlags - You can specify key usage for encryption, key agreement, and signature. You can use property flags or property type but not both.

    • fromPropertyType

      public static KeyUsageProperty fromPropertyType(String propertyType)
      Create an instance of this class with propertyTypeAsString() initialized to the given value.

      You can specify all key usages using property type ALL. You can use property type or property flags but not both.

      Parameters:
      propertyType - You can specify all key usages using property type ALL. You can use property type or property flags but not both.
      See Also:

    • fromPropertyType

      public static KeyUsageProperty fromPropertyType(KeyUsagePropertyType propertyType)
      Create an instance of this class with propertyTypeAsString() initialized to the given value.

      You can specify all key usages using property type ALL. You can use property type or property flags but not both.

      Parameters:
      propertyType - You can specify all key usages using property type ALL. You can use property type or property flags but not both.
      See Also:

    • type

      public KeyUsageProperty.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 KeyUsageProperty.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 KeyUsageProperty.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.