java.lang.Object
- software.amazon.awssdk.services.transfer.model.DescribedCertificate

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<DescribedCertificate.Builder,DescribedCertificate>

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

Describes the properties of a certificate.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribedCertificate.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Instant`	`activeDate()`	An optional date that specifies when the certificate becomes active.
`String`	`arn()`	The unique Amazon Resource Name (ARN) for the certificate.
`static DescribedCertificate.Builder`	`builder()`
`String`	`certificate()`	The file name for the certificate.
`String`	`certificateChain()`	The list of certificates that make up the chain for the certificate.
`String`	`certificateId()`	An array of identifiers for the imported certificates.
`String`	`description()`	The name or description that's used to identity the certificate.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasTags()`	For responses, this returns true if the service returned a value for the Tags property.
`Instant`	`inactiveDate()`	An optional date that specifies when the certificate becomes inactive.
`Instant`	`notAfterDate()`	The final date that the certificate is valid.
`Instant`	`notBeforeDate()`	The earliest date that the certificate is valid.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`String`	`serial()`	The serial number for the certificate.
`static Class<? extends DescribedCertificate.Builder>`	`serializableBuilderClass()`
`CertificateStatusType`	`status()`	Currently, the only available status is `ACTIVE`: all other values are reserved for future use.
`String`	`statusAsString()`	Currently, the only available status is `ACTIVE`: all other values are reserved for future use.
`List<Tag>`	`tags()`	Key-value pairs that can be used to group and search for certificates.
`DescribedCertificate.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`CertificateType`	`type()`	If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY`.
`String`	`typeAsString()`	If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY`.
`CertificateUsageType`	`usage()`	Specifies how this certificate is used.
`String`	`usageAsString()`	Specifies how this certificate is used.

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
  - arn
```
public final String arn()
```
    The unique Amazon Resource Name (ARN) for the certificate.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) for the certificate.
  - certificateId
```
public final String certificateId()
```
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    Returns:
    
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
  - 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:
    
    CertificateUsageType
  - 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:
    
    CertificateUsageType
  - status
```
public final CertificateStatusType status()
```
    Currently, the only available status is ACTIVE: all other values are reserved for future use.
    
    If the service returns an enum value that is not available in the current SDK version, status will return CertificateStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    Currently, the only available status is ACTIVE: all other values are reserved for future use.
    
    See Also:
    
    CertificateStatusType
  - statusAsString
```
public final String statusAsString()
```
    Currently, the only available status is ACTIVE: all other values are reserved for future use.
    
    If the service returns an enum value that is not available in the current SDK version, status will return CertificateStatusType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    
    Returns:
    
    Currently, the only available status is ACTIVE: all other values are reserved for future use.
    
    See Also:
    
    CertificateStatusType
  - certificate
```
public final String certificate()
```
    The file name for the certificate.
    
    Returns:
    
    The file name for the certificate.
  - certificateChain
```
public final String certificateChain()
```
    The list of certificates that make up the chain for the certificate.
    
    Returns:
    
    The list of certificates that make up the chain for the certificate.
  - 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.
  - serial
```
public final String serial()
```
    The serial number for the certificate.
    
    Returns:
    
    The serial number for the certificate.
  - notBeforeDate
```
public final Instant notBeforeDate()
```
    The earliest date that the certificate is valid.
    
    Returns:
    
    The earliest date that the certificate is valid.
  - notAfterDate
```
public final Instant notAfterDate()
```
    The final date that the certificate is valid.
    
    Returns:
    
    The final date that the certificate is valid.
  - type
```
public final CertificateType type()
```
    If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
    
    If the service returns an enum value that is not available in the current SDK version, type will return CertificateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
    
    See Also:
    
    CertificateType
  - typeAsString
```
public final String typeAsString()
```
    If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
    
    If the service returns an enum value that is not available in the current SDK version, type will return CertificateType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    If a private key has been specified for the certificate, its type is CERTIFICATE_WITH_PRIVATE_KEY. If there is no private key, the type is CERTIFICATE.
    
    See Also:
    
    CertificateType
  - description
```
public final String description()
```
    The name or description that's used to identity the certificate.
    
    Returns:
    
    The name or description that's used to identity 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 DescribedCertificate.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribedCertificate.Builder,DescribedCertificate>
  - builder
```
public static DescribedCertificate.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribedCertificate.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
  - sdkFieldNameToField
```
public final Map<String,SdkField<?>> sdkFieldNameToField()
```
    Specified by:
    
    sdkFieldNameToField in interface SdkPojo

Class DescribedCertificate

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

arn

certificateId

usage

usageAsString

status

statusAsString

certificate

certificateChain

activeDate

inactiveDate

serial

notBeforeDate

notAfterDate

type

typeAsString

description

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField