software.amazon.awssdk.services.iot.model

Class RegisterCaCertificateRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.iot.model.IotRequest

software.amazon.awssdk.services.iot.model.RegisterCaCertificateRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<RegisterCaCertificateRequest.Builder,RegisterCaCertificateRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RegisterCaCertificateRequest
extends IotRequest
implements ToCopyableBuilder<RegisterCaCertificateRequest.Builder,RegisterCaCertificateRequest>

The input to the RegisterCACertificate operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RegisterCaCertificateRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowAutoRegistration() Allows this CA certificate to be used for auto registration of device certificates.
static RegisterCaCertificateRequest.Builder	builder()
String	caCertificate() The CA certificate.
CertificateMode	certificateMode() Describes the certificate mode in which the Certificate Authority (CA) will be registered.
String	certificateModeAsString() Describes the certificate mode in which the Certificate Authority (CA) will be registered.
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.
RegistrationConfig	registrationConfig() Information about the registration configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends RegisterCaCertificateRequest.Builder>	serializableBuilderClass()
Boolean	setAsActive() A boolean value that specifies if the CA certificate is set to active.
List<Tag>	tags() Metadata which can be used to manage the CA certificate.
RegisterCaCertificateRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.
String	verificationCertificate() The private key verification certificate.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

caCertificate

public final String caCertificate()

The CA certificate.

Returns:

The CA certificate.

verificationCertificate

public final 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.

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.

setAsActive

public final Boolean setAsActive()

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

allowAutoRegistration

public final Boolean allowAutoRegistration()

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.

registrationConfig

public final RegistrationConfig registrationConfig()

Information about the registration configuration.

Returns:

Information about the registration configuration.

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

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..."

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:

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..."

certificateMode

public final 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.

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

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

certificateModeAsString

public final String certificateModeAsString()

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.

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

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

toBuilder

public RegisterCaCertificateRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RegisterCaCertificateRequest.Builder,RegisterCaCertificateRequest>

Specified by:

toBuilder in class IotRequest

builder

public static RegisterCaCertificateRequest.Builder builder()

serializableBuilderClass

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

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)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo