software.amazon.awssdk.services.iot.model

Class UpdateAccountAuditConfigurationRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateAccountAuditConfigurationRequest.Builder,UpdateAccountAuditConfigurationRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateAccountAuditConfigurationRequest.Builder

Method Summary

Modifier and Type	Method and Description
Map<String,AuditCheckConfiguration>	auditCheckConfigurations() Specifies which audit checks are enabled and disabled for this account.
Map<AuditNotificationType,AuditNotificationTarget>	auditNotificationTargetConfigurations() Information about the targets to which audit notifications are sent.
Map<String,AuditNotificationTarget>	auditNotificationTargetConfigurationsAsStrings() Information about the targets to which audit notifications are sent.
static UpdateAccountAuditConfigurationRequest.Builder	builder()
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.
boolean	hasAuditCheckConfigurations() For responses, this returns true if the service returned a value for the AuditCheckConfigurations property.
boolean	hasAuditNotificationTargetConfigurations() For responses, this returns true if the service returned a value for the AuditNotificationTargetConfigurations property.
int	hashCode()
String	roleArn() The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.
List<SdkField<?>>	sdkFields()
static Class<? extends UpdateAccountAuditConfigurationRequest.Builder>	serializableBuilderClass()
UpdateAccountAuditConfigurationRequest.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

roleArn

public final String roleArn()

The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

Returns:

The Amazon Resource Name (ARN) of the role that grants permission to IoT to access information about your devices, policies, certificates, and other items as required when performing an audit.

auditNotificationTargetConfigurations

public final Map<AuditNotificationType,AuditNotificationTarget> auditNotificationTargetConfigurations()

Information about the targets to which audit notifications are sent.

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 hasAuditNotificationTargetConfigurations() method.

Returns:

Information about the targets to which audit notifications are sent.

hasAuditNotificationTargetConfigurations

public final boolean hasAuditNotificationTargetConfigurations()

For responses, this returns true if the service returned a value for the AuditNotificationTargetConfigurations 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.

auditNotificationTargetConfigurationsAsStrings

public final Map<String,AuditNotificationTarget> auditNotificationTargetConfigurationsAsStrings()

Information about the targets to which audit notifications are sent.

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 hasAuditNotificationTargetConfigurations() method.

Returns:

Information about the targets to which audit notifications are sent.

hasAuditCheckConfigurations

public final boolean hasAuditCheckConfigurations()

For responses, this returns true if the service returned a value for the AuditCheckConfigurations 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.

auditCheckConfigurations

public final Map<String,AuditCheckConfiguration> auditCheckConfigurations()

Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

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 hasAuditCheckConfigurations() method.

Returns:

Specifies which audit checks are enabled and disabled for this account. Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are currently enabled.

Some data collection might start immediately when certain checks are enabled. When a check is disabled, any data collected so far in relation to the check is deleted.

You cannot disable a check if it's used by any scheduled audit. You must first delete the check from the scheduled audit or delete the scheduled audit itself.

On the first call to UpdateAccountAuditConfiguration, this parameter is required and must specify at least one enabled check.

toBuilder

public UpdateAccountAuditConfigurationRequest.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<UpdateAccountAuditConfigurationRequest.Builder,UpdateAccountAuditConfigurationRequest>

Specified by:

toBuilder in class IotRequest

Returns:

a builder for type T

builder

public static UpdateAccountAuditConfigurationRequest.Builder builder()

serializableBuilderClass

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