software.amazon.awssdk.services.iot.model

Class UpdateSecurityProfileResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.iot.model.IotResponse

software.amazon.awssdk.services.iot.model.UpdateSecurityProfileResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<UpdateSecurityProfileResponse.Builder,UpdateSecurityProfileResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	UpdateSecurityProfileResponse.Builder

Method Summary

Modifier and Type	Method and Description
List<String>	additionalMetricsToRetain() Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.
List<MetricToRetain>	additionalMetricsToRetainV2() A list of metrics whose data is retained (stored).
Map<AlertTargetType,AlertTarget>	alertTargets() Where the alerts are sent.
Map<String,AlertTarget>	alertTargetsAsStrings() Where the alerts are sent.
List<Behavior>	behaviors() Specifies the behaviors that, when violated by a device (thing), cause an alert.
static UpdateSecurityProfileResponse.Builder	builder()
Instant	creationDate() The time the security profile was created.
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 SdkResponse.
boolean	hasAdditionalMetricsToRetain() Returns true if the AdditionalMetricsToRetain property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasAdditionalMetricsToRetainV2() Returns true if the AdditionalMetricsToRetainV2 property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasAlertTargets() Returns true if the AlertTargets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
boolean	hasBehaviors() Returns true if the Behaviors property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
int	hashCode()
Instant	lastModifiedDate() The time the security profile was last modified.
List<SdkField<?>>	sdkFields()
String	securityProfileArn() The ARN of the security profile that was updated.
String	securityProfileDescription() The description of the security profile.
String	securityProfileName() The name of the security profile that was updated.
static Class<? extends UpdateSecurityProfileResponse.Builder>	serializableBuilderClass()
UpdateSecurityProfileResponse.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.
Long	version() The updated version of the security profile.

Methods inherited from class software.amazon.awssdk.services.iot.model.IotResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

securityProfileName

public final String securityProfileName()

The name of the security profile that was updated.

Returns:

The name of the security profile that was updated.

securityProfileArn

public final String securityProfileArn()

The ARN of the security profile that was updated.

Returns:

The ARN of the security profile that was updated.

securityProfileDescription

public final String securityProfileDescription()

The description of the security profile.

Returns:

The description of the security profile.

hasBehaviors

public final boolean hasBehaviors()

Returns true if the Behaviors property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

behaviors

public final List<Behavior> behaviors()

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasBehaviors() to see if a value was sent in this field.

Returns:

Specifies the behaviors that, when violated by a device (thing), cause an alert.

alertTargets

public final Map<AlertTargetType,AlertTarget> alertTargets()

Where the alerts are sent. (Alerts are always sent to the console.)

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAlertTargets() to see if a value was sent in this field.

Returns:

Where the alerts are sent. (Alerts are always sent to the console.)

hasAlertTargets

public final boolean hasAlertTargets()

Returns true if the AlertTargets property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

alertTargetsAsStrings

public final Map<String,AlertTarget> alertTargetsAsStrings()

Where the alerts are sent. (Alerts are always sent to the console.)

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAlertTargets() to see if a value was sent in this field.

Returns:

Where the alerts are sent. (Alerts are always sent to the console.)

hasAdditionalMetricsToRetain

public final boolean hasAdditionalMetricsToRetain()

Returns true if the AdditionalMetricsToRetain property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

additionalMetricsToRetain

public final List<String> additionalMetricsToRetain()

Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAdditionalMetricsToRetain() to see if a value was sent in this field.

Returns:

Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

hasAdditionalMetricsToRetainV2

public final boolean hasAdditionalMetricsToRetainV2()

Returns true if the AdditionalMetricsToRetainV2 property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

additionalMetricsToRetainV2

public final List<MetricToRetain> additionalMetricsToRetainV2()

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasAdditionalMetricsToRetainV2() to see if a value was sent in this field.

Returns:

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the profile's behaviors, but it is also retained for any metric specified here. Can be used with custom metrics; cannot be used with dimensions.

version

public final Long version()

The updated version of the security profile.

Returns:

The updated version of the security profile.

creationDate

public final Instant creationDate()

The time the security profile was created.

Returns:

The time the security profile was created.

lastModifiedDate

public final Instant lastModifiedDate()

The time the security profile was last modified.

Returns:

The time the security profile was last modified.

toBuilder

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

Specified by:

toBuilder in class AwsResponse

Returns:

a builder for type T

builder

public static UpdateSecurityProfileResponse.Builder builder()

serializableBuilderClass

public static Class<? extends UpdateSecurityProfileResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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: SdkResponse

Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkResponse

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.