Package software.amazon.awssdk.services.transfer.model

Class ImportCertificateRequest

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

  • Method Details

    • usage

      public final CertificateUsageType usage()

      Specifies how this certificate is used. It can be used in the following ways:

      • SIGNING: For signing AS2 messages

      • ENCRYPTION: For encrypting AS2 messages

      • TLS: For securing AS2 communications sent over HTTPS

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

      Returns:
      Specifies how this certificate is used. It can be used in the following ways:

      • SIGNING: For signing AS2 messages

      • ENCRYPTION: For encrypting AS2 messages

      • TLS: For securing AS2 communications sent over HTTPS

      See Also:

    • usageAsString

      public final String usageAsString()

      Specifies how this certificate is used. It can be used in the following ways:

      • SIGNING: For signing AS2 messages

      • ENCRYPTION: For encrypting AS2 messages

      • TLS: For securing AS2 communications sent over HTTPS

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

      Returns:
      Specifies how this certificate is used. It can be used in the following ways:

      • SIGNING: For signing AS2 messages

      • ENCRYPTION: For encrypting AS2 messages

      • TLS: For securing AS2 communications sent over HTTPS

      See Also:

    • certificate

      public final String certificate()

      • For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.

      • For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`".

      Returns:

    • For the CLI, provide a file path for a certificate in URI format. For example, --certificate file://encryption-cert.pem. Alternatively, you can provide the raw content.

    • For the SDK, specify the raw content of a certificate file. For example, --certificate "`cat encryption-cert.pem`".

    • certificateChain

      public final String certificateChain()

      An optional list of certificates that make up the chain for the certificate that's being imported.

      Returns:
      An optional list of certificates that make up the chain for the certificate that's being imported.

    • privateKey

      public final String privateKey()

      • For the CLI, provide a file path for a private key in URI format.For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.

      • For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

      Returns:

    • For the CLI, provide a file path for a private key in URI format.For example, --private-key file://encryption-key.pem. Alternatively, you can provide the raw content of the private key file.

    • For the SDK, specify the raw content of a private key file. For example, --private-key "`cat encryption-key.pem`"

    • activeDate

      public final Instant activeDate()

      An optional date that specifies when the certificate becomes active.

      Returns:
      An optional date that specifies when the certificate becomes active.

    • inactiveDate

      public final Instant inactiveDate()

      An optional date that specifies when the certificate becomes inactive.

      Returns:
      An optional date that specifies when the certificate becomes inactive.

    • description

      public final String description()

      A short description that helps identify the certificate.

      Returns:
      A short description that helps identify the certificate.

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags 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.

    • tags

      public final List<Tag> tags()

      Key-value pairs that can be used to group and search for certificates.

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

      Returns:
      Key-value pairs that can be used to group and search for certificates.

    • toBuilder

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

    • builder

      public static ImportCertificateRequest.Builder builder()

    • serializableBuilderClass

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