com.amazonaws.services.iot.model

Class RegisterCACertificateRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.RegisterCACertificateRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

The input to the RegisterCACertificate operation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
RegisterCACertificateRequest()

Method Summary

Modifier and Type	Method and Description
RegisterCACertificateRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getAllowAutoRegistration() Allows this CA certificate to be used for auto registration of device certificates.
String	getCaCertificate() The CA certificate.
String	getCertificateMode() Describes the certificate mode in which the Certificate Authority (CA) will be registered.
RegistrationConfig	getRegistrationConfig() Information about the registration configuration.
Boolean	getSetAsActive() A boolean value that specifies if the CA certificate is set to active.
List<Tag>	getTags() Metadata which can be used to manage the CA certificate.
String	getVerificationCertificate() The private key verification certificate.
int	hashCode()
Boolean	isAllowAutoRegistration() Allows this CA certificate to be used for auto registration of device certificates.
Boolean	isSetAsActive() A boolean value that specifies if the CA certificate is set to active.
void	setAllowAutoRegistration(Boolean allowAutoRegistration) Allows this CA certificate to be used for auto registration of device certificates.
void	setCaCertificate(String caCertificate) The CA certificate.
void	setCertificateMode(String certificateMode) Describes the certificate mode in which the Certificate Authority (CA) will be registered.
void	setRegistrationConfig(RegistrationConfig registrationConfig) Information about the registration configuration.
void	setSetAsActive(Boolean setAsActive) A boolean value that specifies if the CA certificate is set to active.
void	setTags(Collection<Tag> tags) Metadata which can be used to manage the CA certificate.
void	setVerificationCertificate(String verificationCertificate) The private key verification certificate.
String	toString() Returns a string representation of this object.
RegisterCACertificateRequest	withAllowAutoRegistration(Boolean allowAutoRegistration) Allows this CA certificate to be used for auto registration of device certificates.
RegisterCACertificateRequest	withCaCertificate(String caCertificate) The CA certificate.
RegisterCACertificateRequest	withCertificateMode(CertificateMode certificateMode) Describes the certificate mode in which the Certificate Authority (CA) will be registered.
RegisterCACertificateRequest	withCertificateMode(String certificateMode) Describes the certificate mode in which the Certificate Authority (CA) will be registered.
RegisterCACertificateRequest	withRegistrationConfig(RegistrationConfig registrationConfig) Information about the registration configuration.
RegisterCACertificateRequest	withSetAsActive(Boolean setAsActive) A boolean value that specifies if the CA certificate is set to active.
RegisterCACertificateRequest	withTags(Collection<Tag> tags) Metadata which can be used to manage the CA certificate.
RegisterCACertificateRequest	withTags(Tag... tags) Metadata which can be used to manage the CA certificate.
RegisterCACertificateRequest	withVerificationCertificate(String verificationCertificate) The private key verification certificate.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RegisterCACertificateRequest

public RegisterCACertificateRequest()

Method Detail

setCaCertificate

public void setCaCertificate(String caCertificate)

The CA certificate.

Parameters:

caCertificate - The CA certificate.

getCaCertificate

public String getCaCertificate()

The CA certificate.

Returns:

The CA certificate.

withCaCertificate

public RegisterCACertificateRequest withCaCertificate(String caCertificate)

The CA certificate.

Parameters:

caCertificate - The CA certificate.

Returns:

Returns a reference to this object so that method calls can be chained together.

setVerificationCertificate

public void setVerificationCertificate(String verificationCertificate)

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

Parameters:

verificationCertificate - The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

getVerificationCertificate

public String getVerificationCertificate()

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

Returns:

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

withVerificationCertificate

public RegisterCACertificateRequest withVerificationCertificate(String verificationCertificate)

The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

Parameters:

verificationCertificate - The private key verification certificate. If certificateMode is SNI_ONLY, the verificationCertificate field must be empty. If certificateMode is DEFAULT or not provided, the verificationCertificate field must not be empty.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSetAsActive

public void setSetAsActive(Boolean setAsActive)

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

Parameters:

setAsActive - A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

getSetAsActive

public Boolean getSetAsActive()

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

Returns:

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

withSetAsActive

public RegisterCACertificateRequest withSetAsActive(Boolean setAsActive)

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

Parameters:

setAsActive - A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

Returns:

Returns a reference to this object so that method calls can be chained together.

isSetAsActive

public Boolean isSetAsActive()

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

Returns:

A boolean value that specifies if the CA certificate is set to active.

Valid values: ACTIVE | INACTIVE

setAllowAutoRegistration

public void setAllowAutoRegistration(Boolean allowAutoRegistration)

Allows this CA certificate to be used for auto registration of device certificates.

Parameters:

allowAutoRegistration - Allows this CA certificate to be used for auto registration of device certificates.

getAllowAutoRegistration

public Boolean getAllowAutoRegistration()

Allows this CA certificate to be used for auto registration of device certificates.

Returns:

Allows this CA certificate to be used for auto registration of device certificates.

withAllowAutoRegistration

public RegisterCACertificateRequest withAllowAutoRegistration(Boolean allowAutoRegistration)

Allows this CA certificate to be used for auto registration of device certificates.

Parameters:

allowAutoRegistration - Allows this CA certificate to be used for auto registration of device certificates.

Returns:

Returns a reference to this object so that method calls can be chained together.

isAllowAutoRegistration

public Boolean isAllowAutoRegistration()

Allows this CA certificate to be used for auto registration of device certificates.

Returns:

Allows this CA certificate to be used for auto registration of device certificates.

setRegistrationConfig

public void setRegistrationConfig(RegistrationConfig registrationConfig)

Information about the registration configuration.

Parameters:

registrationConfig - Information about the registration configuration.

getRegistrationConfig

public RegistrationConfig getRegistrationConfig()

Information about the registration configuration.

Returns:

Information about the registration configuration.

withRegistrationConfig

public RegisterCACertificateRequest withRegistrationConfig(RegistrationConfig registrationConfig)

Information about the registration configuration.

Parameters:

registrationConfig - Information about the registration configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

setTags

public void setTags(Collection<Tag> tags)

Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Parameters:

tags - Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

withTags

public RegisterCACertificateRequest withTags(Tag... tags)

Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

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 - Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public RegisterCACertificateRequest withTags(Collection<Tag> tags)

Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Parameters:

tags - Metadata which can be used to manage the CA certificate.

For URI Request parameters use format: ...key1=value1&key2=value2...

For the CLI command-line parameter use format: &&tags "key1=value1&key2=value2..."

For the cli-input-json file use format: "tags": "key1=value1&key2=value2..."

Returns:

Returns a reference to this object so that method calls can be chained together.

setCertificateMode

public void setCertificateMode(String certificateMode)

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

Parameters:

certificateMode - Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

See Also:

CertificateMode

getCertificateMode

public String getCertificateMode()

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

Returns:

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

See Also:

CertificateMode

withCertificateMode

public RegisterCACertificateRequest withCertificateMode(String certificateMode)

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

Parameters:

certificateMode - Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CertificateMode

withCertificateMode

public RegisterCACertificateRequest withCertificateMode(CertificateMode certificateMode)

Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

Parameters:

certificateMode - Describes the certificate mode in which the Certificate Authority (CA) will be registered. If the verificationCertificate field is not provided, set certificateMode to be SNI_ONLY. If the verificationCertificate field is provided, set certificateMode to be DEFAULT. When certificateMode is not provided, it defaults to DEFAULT. All the device certificates that are registered using this CA will be registered in the same certificate mode as the CA. For more information about certificate mode for device certificates, see certificate mode.

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

CertificateMode

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 RegisterCACertificateRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()