Class RevokeCertificateRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.acmpca.model.AcmPcaRequest
software.amazon.awssdk.services.acmpca.model.RevokeCertificateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<RevokeCertificateRequest.Builder,RevokeCertificateRequest>
@Generated("software.amazon.awssdk:codegen") public final class RevokeCertificateRequest extends AcmPcaRequest implements ToCopyableBuilder<RevokeCertificateRequest.Builder,RevokeCertificateRequest>

  • Method Details

    • certificateAuthorityArn

      public final String certificateAuthorityArn()

      Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

      Returns:
      Amazon Resource Name (ARN) of the private CA that issued the certificate to be revoked. This must be of the form:

      arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012

    • certificateSerial

      public final String certificateSerial()

      Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.

      openssl x509 -in file_path -text -noout

      You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.

      Returns:
      Serial number of the certificate to be revoked. This must be in hexadecimal format. You can retrieve the serial number by calling GetCertificate with the Amazon Resource Name (ARN) of the certificate you want and the ARN of your private CA. The GetCertificate action retrieves the certificate in the PEM format. You can use the following OpenSSL command to list the certificate in text format and copy the hexadecimal serial number.

      openssl x509 -in file_path -text -noout

      You can also copy the serial number from the console or use the DescribeCertificate action in the Certificate Manager API Reference.

    • revocationReason

      public final RevocationReason revocationReason()

      Specifies why you revoked the certificate.

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

      Returns:
      Specifies why you revoked the certificate.
      See Also:

    • revocationReasonAsString

      public final String revocationReasonAsString()

      Specifies why you revoked the certificate.

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

      Returns:
      Specifies why you revoked the certificate.
      See Also:

    • toBuilder

      public RevokeCertificateRequest.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<RevokeCertificateRequest.Builder,RevokeCertificateRequest>
      Specified by:
      toBuilder in class AcmPcaRequest
      Returns:
      a builder for type T

    • builder

      public static RevokeCertificateRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RevokeCertificateRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • 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.