software.amazon.awssdk.services.iot.model

Class UpdateCaCertificateRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateCaCertificateRequest.Builder,UpdateCaCertificateRequest>

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

The input to the UpdateCACertificate operation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateCaCertificateRequest.Builder

Method Summary

Modifier and Type	Method and Description
static UpdateCaCertificateRequest.Builder	builder()
String	certificateId() The CA certificate identifier.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
AutoRegistrationStatus	newAutoRegistrationStatus() The new value for the auto registration status.
String	newAutoRegistrationStatusAsString() The new value for the auto registration status.
CACertificateStatus	newStatus() The updated status of the CA certificate.
String	newStatusAsString() The updated status of the CA certificate.
RegistrationConfig	registrationConfig() Information about the registration configuration.
Boolean	removeAutoRegistration() If true, removes auto registration.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateCaCertificateRequest.Builder>	serializableBuilderClass()
UpdateCaCertificateRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

certificateId

public final String certificateId()

The CA certificate identifier.

Returns:

The CA certificate identifier.

newStatus

public final CACertificateStatus newStatus()

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

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

Returns:

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

See Also:

CACertificateStatus

newStatusAsString

public final String newStatusAsString()

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

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

Returns:

The updated status of the CA certificate.

Note: The status value REGISTER_INACTIVE is deprecated and should not be used.

See Also:

CACertificateStatus

newAutoRegistrationStatus

public final AutoRegistrationStatus newAutoRegistrationStatus()

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

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

Returns:

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

See Also:

AutoRegistrationStatus

newAutoRegistrationStatusAsString

public final String newAutoRegistrationStatusAsString()

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

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

Returns:

The new value for the auto registration status. Valid values are: "ENABLE" or "DISABLE".

See Also:

AutoRegistrationStatus

registrationConfig

public final RegistrationConfig registrationConfig()

Information about the registration configuration.

Returns:

Information about the registration configuration.

removeAutoRegistration

public final Boolean removeAutoRegistration()

If true, removes auto registration.

Returns:

If true, removes auto registration.

toBuilder

public UpdateCaCertificateRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<UpdateCaCertificateRequest.Builder,UpdateCaCertificateRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static UpdateCaCertificateRequest.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.