DescribedCertificate (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.transfer.model.DescribedCertificate

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribedCertificate
extends Object
implements Serializable, Cloneable, StructuredPojo

Describes the properties of a certificate.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribedCertificate()

Constructors
Constructor and Description
`DescribedCertificate()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribedCertificate`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getActiveDate()` An optional date that specifies when the certificate becomes active.
`String`	`getArn()` The unique Amazon Resource Name (ARN) for the certificate.
`String`	`getCertificate()` The file name for the certificate.
`String`	`getCertificateChain()` The list of certificates that make up the chain for the certificate.
`String`	`getCertificateId()` An array of identifiers for the imported certificates.
`String`	`getDescription()` The name or description that's used to identity the certificate.
`Date`	`getInactiveDate()` An optional date that specifies when the certificate becomes inactive.
`Date`	`getNotAfterDate()` The final date that the certificate is valid.
`Date`	`getNotBeforeDate()` The earliest date that the certificate is valid.
`String`	`getSerial()` The serial number for the certificate.
`String`	`getStatus()` The certificate can be either `ACTIVE`, `PENDING_ROTATION`, or `INACTIVE`.
`List<Tag>`	`getTags()` Key-value pairs that can be used to group and search for certificates.
`String`	`getType()` If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY`.
`String`	`getUsage()` Specifies how this certificate is used.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`void`	`setActiveDate(Date activeDate)` An optional date that specifies when the certificate becomes active.
`void`	`setArn(String arn)` The unique Amazon Resource Name (ARN) for the certificate.
`void`	`setCertificate(String certificate)` The file name for the certificate.
`void`	`setCertificateChain(String certificateChain)` The list of certificates that make up the chain for the certificate.
`void`	`setCertificateId(String certificateId)` An array of identifiers for the imported certificates.
`void`	`setDescription(String description)` The name or description that's used to identity the certificate.
`void`	`setInactiveDate(Date inactiveDate)` An optional date that specifies when the certificate becomes inactive.
`void`	`setNotAfterDate(Date notAfterDate)` The final date that the certificate is valid.
`void`	`setNotBeforeDate(Date notBeforeDate)` The earliest date that the certificate is valid.
`void`	`setSerial(String serial)` The serial number for the certificate.
`void`	`setStatus(String status)` The certificate can be either `ACTIVE`, `PENDING_ROTATION`, or `INACTIVE`.
`void`	`setTags(Collection<Tag> tags)` Key-value pairs that can be used to group and search for certificates.
`void`	`setType(String type)` If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY`.
`void`	`setUsage(String usage)` Specifies how this certificate is used.
`String`	`toString()` Returns a string representation of this object.
`DescribedCertificate`	`withActiveDate(Date activeDate)` An optional date that specifies when the certificate becomes active.
`DescribedCertificate`	`withArn(String arn)` The unique Amazon Resource Name (ARN) for the certificate.
`DescribedCertificate`	`withCertificate(String certificate)` The file name for the certificate.
`DescribedCertificate`	`withCertificateChain(String certificateChain)` The list of certificates that make up the chain for the certificate.
`DescribedCertificate`	`withCertificateId(String certificateId)` An array of identifiers for the imported certificates.
`DescribedCertificate`	`withDescription(String description)` The name or description that's used to identity the certificate.
`DescribedCertificate`	`withInactiveDate(Date inactiveDate)` An optional date that specifies when the certificate becomes inactive.
`DescribedCertificate`	`withNotAfterDate(Date notAfterDate)` The final date that the certificate is valid.
`DescribedCertificate`	`withNotBeforeDate(Date notBeforeDate)` The earliest date that the certificate is valid.
`DescribedCertificate`	`withSerial(String serial)` The serial number for the certificate.
`DescribedCertificate`	`withStatus(CertificateStatusType status)` The certificate can be either `ACTIVE`, `PENDING_ROTATION`, or `INACTIVE`.
`DescribedCertificate`	`withStatus(String status)` The certificate can be either `ACTIVE`, `PENDING_ROTATION`, or `INACTIVE`.
`DescribedCertificate`	`withTags(Collection<Tag> tags)` Key-value pairs that can be used to group and search for certificates.
`DescribedCertificate`	`withTags(Tag... tags)` Key-value pairs that can be used to group and search for certificates.
`DescribedCertificate`	`withType(CertificateType type)` If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY`.
`DescribedCertificate`	`withType(String type)` If a private key has been specified for the certificate, its type is `CERTIFICATE_WITH_PRIVATE_KEY`.
`DescribedCertificate`	`withUsage(CertificateUsageType usage)` Specifies how this certificate is used.
`DescribedCertificate`	`withUsage(String usage)` Specifies how this certificate is used.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribedCertificate
```
public DescribedCertificate()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The unique Amazon Resource Name (ARN) for the certificate.
    
    Parameters:
    
    arn - The unique Amazon Resource Name (ARN) for the certificate.
  - getArn
```
public String getArn()
```
    The unique Amazon Resource Name (ARN) for the certificate.
    
    Returns:
    
    The unique Amazon Resource Name (ARN) for the certificate.
  - withArn
```
public DescribedCertificate withArn(String arn)
```
    The unique Amazon Resource Name (ARN) for the certificate.
    
    Parameters:
    
    arn - The unique Amazon Resource Name (ARN) for the certificate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertificateId
```
public void setCertificateId(String certificateId)
```
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    Parameters:
    
    certificateId - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
  - getCertificateId
```
public String getCertificateId()
```
    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.
  - withCertificateId
```
public DescribedCertificate withCertificateId(String certificateId)
```
    An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    Parameters:
    
    certificateId - An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setUsage
```
public void setUsage(String 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
    Parameters:
    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
    See Also:
    
    CertificateUsageType
  - getUsage
```
public String getUsage()
```
    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
    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
  - withUsage
```
public DescribedCertificate withUsage(String 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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateUsageType
  - withUsage
```
public DescribedCertificate withUsage(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
    Parameters:
    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
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateUsageType
  - setStatus
```
public void setStatus(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    CertificateStatusType
  - getStatus
```
public String getStatus()
```
    The certificate can be either ACTIVE, PENDING_ROTATION, or INACTIVE. PENDING_ROTATION means that this certificate will replace the current certificate when it expires.
    
    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
  - withStatus
```
public DescribedCertificate withStatus(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateStatusType
  - withStatus
```
public DescribedCertificate withStatus(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateStatusType
  - setCertificate
```
public void setCertificate(String certificate)
```
    The file name for the certificate.
    
    Parameters:
    
    certificate - The file name for the certificate.
  - getCertificate
```
public String getCertificate()
```
    The file name for the certificate.
    
    Returns:
    
    The file name for the certificate.
  - withCertificate
```
public DescribedCertificate withCertificate(String certificate)
```
    The file name for the certificate.
    
    Parameters:
    
    certificate - The file name for the certificate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCertificateChain
```
public void setCertificateChain(String certificateChain)
```
    The list of certificates that make up the chain for the certificate.
    
    Parameters:
    
    certificateChain - The list of certificates that make up the chain for the certificate.
  - getCertificateChain
```
public String getCertificateChain()
```
    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.
  - withCertificateChain
```
public DescribedCertificate withCertificateChain(String certificateChain)
```
    The list of certificates that make up the chain for the certificate.
    
    Parameters:
    
    certificateChain - The list of certificates that make up the chain for the certificate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setActiveDate
```
public void setActiveDate(Date activeDate)
```
    An optional date that specifies when the certificate becomes active.
    
    Parameters:
    
    activeDate - An optional date that specifies when the certificate becomes active.
  - getActiveDate
```
public Date getActiveDate()
```
    An optional date that specifies when the certificate becomes active.
    
    Returns:
    
    An optional date that specifies when the certificate becomes active.
  - withActiveDate
```
public DescribedCertificate withActiveDate(Date activeDate)
```
    An optional date that specifies when the certificate becomes active.
    
    Parameters:
    
    activeDate - An optional date that specifies when the certificate becomes active.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setInactiveDate
```
public void setInactiveDate(Date inactiveDate)
```
    An optional date that specifies when the certificate becomes inactive.
    
    Parameters:
    
    inactiveDate - An optional date that specifies when the certificate becomes inactive.
  - getInactiveDate
```
public Date getInactiveDate()
```
    An optional date that specifies when the certificate becomes inactive.
    
    Returns:
    
    An optional date that specifies when the certificate becomes inactive.
  - withInactiveDate
```
public DescribedCertificate withInactiveDate(Date inactiveDate)
```
    An optional date that specifies when the certificate becomes inactive.
    
    Parameters:
    
    inactiveDate - An optional date that specifies when the certificate becomes inactive.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSerial
```
public void setSerial(String serial)
```
    The serial number for the certificate.
    
    Parameters:
    
    serial - The serial number for the certificate.
  - getSerial
```
public String getSerial()
```
    The serial number for the certificate.
    
    Returns:
    
    The serial number for the certificate.
  - withSerial
```
public DescribedCertificate withSerial(String serial)
```
    The serial number for the certificate.
    
    Parameters:
    
    serial - The serial number for the certificate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotBeforeDate
```
public void setNotBeforeDate(Date notBeforeDate)
```
    The earliest date that the certificate is valid.
    
    Parameters:
    
    notBeforeDate - The earliest date that the certificate is valid.
  - getNotBeforeDate
```
public Date getNotBeforeDate()
```
    The earliest date that the certificate is valid.
    
    Returns:
    
    The earliest date that the certificate is valid.
  - withNotBeforeDate
```
public DescribedCertificate withNotBeforeDate(Date notBeforeDate)
```
    The earliest date that the certificate is valid.
    
    Parameters:
    
    notBeforeDate - The earliest date that the certificate is valid.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNotAfterDate
```
public void setNotAfterDate(Date notAfterDate)
```
    The final date that the certificate is valid.
    
    Parameters:
    
    notAfterDate - The final date that the certificate is valid.
  - getNotAfterDate
```
public Date getNotAfterDate()
```
    The final date that the certificate is valid.
    
    Returns:
    
    The final date that the certificate is valid.
  - withNotAfterDate
```
public DescribedCertificate withNotAfterDate(Date notAfterDate)
```
    The final date that the certificate is valid.
    
    Parameters:
    
    notAfterDate - The final date that the certificate is valid.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String 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.
    
    Parameters:
    
    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.
    
    See Also:
    
    CertificateType
  - getType
```
public String getType()
```
    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.
    
    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
  - withType
```
public DescribedCertificate withType(String 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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateType
  - withType
```
public DescribedCertificate withType(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    CertificateType
  - setDescription
```
public void setDescription(String description)
```
    The name or description that's used to identity the certificate.
    
    Parameters:
    
    description - The name or description that's used to identity the certificate.
  - getDescription
```
public String getDescription()
```
    The name or description that's used to identity the certificate.
    
    Returns:
    
    The name or description that's used to identity the certificate.
  - withDescription
```
public DescribedCertificate withDescription(String description)
```
    The name or description that's used to identity the certificate.
    
    Parameters:
    
    description - The name or description that's used to identity the certificate.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getTags
```
public List<Tag> getTags()
```
    Key-value pairs that can be used to group and search for certificates.
    
    Returns:
    
    Key-value pairs that can be used to group and search for certificates.
  - setTags
```
public void setTags(Collection<Tag> tags)
```
    Key-value pairs that can be used to group and search for certificates.
    
    Parameters:
    
    tags - Key-value pairs that can be used to group and search for certificates.
  - withTags
```
public DescribedCertificate withTags(Tag... tags)
```
    Key-value pairs that can be used to group and search for certificates.
    
    NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    tags - Key-value pairs that can be used to group and search for certificates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withTags
```
public DescribedCertificate withTags(Collection<Tag> tags)
```
    Key-value pairs that can be used to group and search for certificates.
    
    Parameters:
    
    tags - Key-value pairs that can be used to group and search for certificates.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribedCertificate clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Description copied from interface: StructuredPojo
    
    Marshalls this structured data using the given ProtocolMarshaller.
    
    Specified by:
    
    marshall in interface StructuredPojo
    
    Parameters:
    
    protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.

AWS SDK for Java 1.x API Reference - 1.12.779

Class DescribedCertificate

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DescribedCertificate

Method Detail

setArn

getArn

withArn

setCertificateId

getCertificateId

withCertificateId

setUsage

getUsage

withUsage

withUsage

setStatus

getStatus

withStatus

withStatus

setCertificate

getCertificate

withCertificate

setCertificateChain

getCertificateChain

withCertificateChain

setActiveDate

getActiveDate

withActiveDate

setInactiveDate

getInactiveDate

withInactiveDate

setSerial

getSerial

withSerial

setNotBeforeDate

getNotBeforeDate

withNotBeforeDate

setNotAfterDate

getNotAfterDate

withNotAfterDate

setType

getType

withType

withType

setDescription

getDescription

withDescription

getTags

setTags

withTags

withTags

toString

equals

hashCode

clone

marshall