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

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

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

Describes the properties of a certificate.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface ListedCertificate.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 Amazon Resource Name (ARN) of the specified certificate.
`static ListedCertificate.Builder`	`builder()`
`String`	`certificateId()`	An array of identifiers for the imported certificates.
`String`	`description()`	The name or short description that's used to identify the certificate.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`Instant`	`inactiveDate()`	An optional date that specifies when the certificate becomes inactive.
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends ListedCertificate.Builder>`	`serializableBuilderClass()`
`CertificateStatusType`	`status()`	The certificate can be either `ACTIVE`, `PENDING_ROTATION`, or `INACTIVE`.
`String`	`statusAsString()`	The certificate can be either `ACTIVE`, `PENDING_ROTATION`, or `INACTIVE`.
`ListedCertificate.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`CertificateType`	`type()`	The type for the certificate.
`String`	`typeAsString()`	The type for the certificate.
`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 Amazon Resource Name (ARN) of the specified certificate.
    
    Returns:
    
    The Amazon Resource Name (ARN) of the specified 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()
```
    The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
    
    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:
    
    The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
    
    See Also:
    
    CertificateStatusType
  - statusAsString
```
public final String statusAsString()
```
    The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
    
    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:
    
    The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
    
    See Also:
    
    CertificateStatusType
  - 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.
  - type
```
public final CertificateType type()
```
    The type for the certificate. 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:
    
    The type for the certificate. 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()
```
    The type for the certificate. 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:
    
    The type for the certificate. 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 short description that's used to identify the certificate.
    
    Returns:
    
    The name or short description that's used to identify the certificate.
  - toBuilder
```
public ListedCertificate.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<ListedCertificate.Builder,ListedCertificate>
  - builder
```
public static ListedCertificate.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends ListedCertificate.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 ListedCertificate

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

activeDate

inactiveDate

type

typeAsString

description

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields

sdkFieldNameToField