DescribeSecurityProfileResponse (AWS Java SDK :: Services

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<DescribeSecurityProfileResponse.Builder,DescribeSecurityProfileResponse>

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface DescribeSecurityProfileResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`DescribeSecurityProfileResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`additionalMetricsToRetain()` Please use DescribeSecurityProfileResponse$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 DescribeSecurityProfileResponse.Builder`	`builder()`
`Instant`	`creationDate()` The time the security profile was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`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.
`String`	`securityProfileDescription()` A description of the security profile (associated with the security profile when it was created or updated).
`String`	`securityProfileName()` The name of the security profile.
`static Class<? extends DescribeSecurityProfileResponse.Builder>`	`serializableBuilderClass()`
`DescribeSecurityProfileResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`Long`	`version()` The 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
clone, finalize, 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.
    
    Returns:
    
    The name of the security profile.
  - securityProfileArn
```
public final String securityProfileArn()
```
    The ARN of the security profile.
    
    Returns:
    
    The ARN of the security profile.
  - securityProfileDescription
```
public final String securityProfileDescription()
```
    A description of the security profile (associated with the security profile when it was created or updated).
    
    Returns:
    
    A description of the security profile (associated with the security profile when it was created or updated).
  - 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 DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
    
    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.
    
    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 DescribeSecurityProfileResponse$additionalMetricsToRetainV2 instead.
    
    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.
  - 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.
    
    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.
  - version
```
public final Long version()
```
    The version of the security profile. A new version is generated whenever the security profile is updated.
    
    Returns:
    
    The version of the security profile. A new version is generated whenever the security profile is updated.
  - 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 DescribeSecurityProfileResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeSecurityProfileResponse.Builder,DescribeSecurityProfileResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeSecurityProfileResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeSecurityProfileResponse.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)
```
    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 SdkResponse
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class DescribeSecurityProfileResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

securityProfileName

securityProfileArn

securityProfileDescription

hasBehaviors

behaviors

alertTargets

hasAlertTargets

alertTargetsAsStrings

hasAdditionalMetricsToRetain

additionalMetricsToRetain

hasAdditionalMetricsToRetainV2

additionalMetricsToRetainV2

version

creationDate

lastModifiedDate

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields