DescribeSecurityProfileResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.iot.model.DescribeSecurityProfileResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeSecurityProfileResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeSecurityProfileResult()

Constructors
Constructor and Description
`DescribeSecurityProfileResult()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`DescribeSecurityProfileResult`	`addAlertTargetsEntry(String key, AlertTarget value)` Add a single AlertTargets entry
`DescribeSecurityProfileResult`	`clearAlertTargetsEntries()` Removes all the entries added into AlertTargets.
`DescribeSecurityProfileResult`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getAdditionalMetricsToRetain()` Deprecated.
`List<MetricToRetain>`	`getAdditionalMetricsToRetainV2()` A list of metrics whose data is retained (stored).
`Map<String,AlertTarget>`	`getAlertTargets()` Where the alerts are sent.
`List<Behavior>`	`getBehaviors()` Specifies the behaviors that, when violated by a device (thing), cause an alert.
`Date`	`getCreationDate()` The time the security profile was created.
`Date`	`getLastModifiedDate()` The time the security profile was last modified.
`MetricsExportConfig`	`getMetricsExportConfig()` Specifies the MQTT topic and role ARN required for metric export.
`String`	`getSecurityProfileArn()` The ARN of the security profile.
`String`	`getSecurityProfileDescription()` A description of the security profile (associated with the security profile when it was created or updated).
`String`	`getSecurityProfileName()` The name of the security profile.
`Long`	`getVersion()` The version of the security profile.
`int`	`hashCode()`
`void`	`setAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)` Deprecated.
`void`	`setAdditionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2)` A list of metrics whose data is retained (stored).
`void`	`setAlertTargets(Map<String,AlertTarget> alertTargets)` Where the alerts are sent.
`void`	`setBehaviors(Collection<Behavior> behaviors)` Specifies the behaviors that, when violated by a device (thing), cause an alert.
`void`	`setCreationDate(Date creationDate)` The time the security profile was created.
`void`	`setLastModifiedDate(Date lastModifiedDate)` The time the security profile was last modified.
`void`	`setMetricsExportConfig(MetricsExportConfig metricsExportConfig)` Specifies the MQTT topic and role ARN required for metric export.
`void`	`setSecurityProfileArn(String securityProfileArn)` The ARN of the security profile.
`void`	`setSecurityProfileDescription(String securityProfileDescription)` A description of the security profile (associated with the security profile when it was created or updated).
`void`	`setSecurityProfileName(String securityProfileName)` The name of the security profile.
`void`	`setVersion(Long version)` The version of the security profile.
`String`	`toString()` Returns a string representation of this object.
`DescribeSecurityProfileResult`	`withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)` Deprecated.
`DescribeSecurityProfileResult`	`withAdditionalMetricsToRetain(String... additionalMetricsToRetain)` Deprecated.
`DescribeSecurityProfileResult`	`withAdditionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2)` A list of metrics whose data is retained (stored).
`DescribeSecurityProfileResult`	`withAdditionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2)` A list of metrics whose data is retained (stored).
`DescribeSecurityProfileResult`	`withAlertTargets(Map<String,AlertTarget> alertTargets)` Where the alerts are sent.
`DescribeSecurityProfileResult`	`withBehaviors(Behavior... behaviors)` Specifies the behaviors that, when violated by a device (thing), cause an alert.
`DescribeSecurityProfileResult`	`withBehaviors(Collection<Behavior> behaviors)` Specifies the behaviors that, when violated by a device (thing), cause an alert.
`DescribeSecurityProfileResult`	`withCreationDate(Date creationDate)` The time the security profile was created.
`DescribeSecurityProfileResult`	`withLastModifiedDate(Date lastModifiedDate)` The time the security profile was last modified.
`DescribeSecurityProfileResult`	`withMetricsExportConfig(MetricsExportConfig metricsExportConfig)` Specifies the MQTT topic and role ARN required for metric export.
`DescribeSecurityProfileResult`	`withSecurityProfileArn(String securityProfileArn)` The ARN of the security profile.
`DescribeSecurityProfileResult`	`withSecurityProfileDescription(String securityProfileDescription)` A description of the security profile (associated with the security profile when it was created or updated).
`DescribeSecurityProfileResult`	`withSecurityProfileName(String securityProfileName)` The name of the security profile.
`DescribeSecurityProfileResult`	`withVersion(Long version)` The version of the security profile.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeSecurityProfileResult
```
public DescribeSecurityProfileResult()
```
- Method Detail
  - setSecurityProfileName
```
public void setSecurityProfileName(String securityProfileName)
```
    The name of the security profile.
    
    Parameters:
    
    securityProfileName - The name of the security profile.
  - getSecurityProfileName
```
public String getSecurityProfileName()
```
    The name of the security profile.
    
    Returns:
    
    The name of the security profile.
  - withSecurityProfileName
```
public DescribeSecurityProfileResult withSecurityProfileName(String securityProfileName)
```
    The name of the security profile.
    
    Parameters:
    
    securityProfileName - The name of the security profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityProfileArn
```
public void setSecurityProfileArn(String securityProfileArn)
```
    The ARN of the security profile.
    
    Parameters:
    
    securityProfileArn - The ARN of the security profile.
  - getSecurityProfileArn
```
public String getSecurityProfileArn()
```
    The ARN of the security profile.
    
    Returns:
    
    The ARN of the security profile.
  - withSecurityProfileArn
```
public DescribeSecurityProfileResult withSecurityProfileArn(String securityProfileArn)
```
    The ARN of the security profile.
    
    Parameters:
    
    securityProfileArn - The ARN of the security profile.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSecurityProfileDescription
```
public void setSecurityProfileDescription(String securityProfileDescription)
```
    A description of the security profile (associated with the security profile when it was created or updated).
    
    Parameters:
    
    securityProfileDescription - A description of the security profile (associated with the security profile when it was created or updated).
  - getSecurityProfileDescription
```
public String getSecurityProfileDescription()
```
    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).
  - withSecurityProfileDescription
```
public DescribeSecurityProfileResult withSecurityProfileDescription(String securityProfileDescription)
```
    A description of the security profile (associated with the security profile when it was created or updated).
    
    Parameters:
    
    securityProfileDescription - A description of the security profile (associated with the security profile when it was created or updated).
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getBehaviors
```
public List<Behavior> getBehaviors()
```
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Returns:
    
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
  - setBehaviors
```
public void setBehaviors(Collection<Behavior> behaviors)
```
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Parameters:
    
    behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.
  - withBehaviors
```
public DescribeSecurityProfileResult withBehaviors(Behavior... behaviors)
```
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    NOTE: This method appends the values to the existing list (if any). Use setBehaviors(java.util.Collection) or withBehaviors(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withBehaviors
```
public DescribeSecurityProfileResult withBehaviors(Collection<Behavior> behaviors)
```
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Parameters:
    
    behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAlertTargets
```
public Map<String,AlertTarget> getAlertTargets()
```
    Where the alerts are sent. (Alerts are always sent to the console.)
    
    Returns:
    
    Where the alerts are sent. (Alerts are always sent to the console.)
  - setAlertTargets
```
public void setAlertTargets(Map<String,AlertTarget> alertTargets)
```
    Where the alerts are sent. (Alerts are always sent to the console.)
    
    Parameters:
    
    alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)
  - withAlertTargets
```
public DescribeSecurityProfileResult withAlertTargets(Map<String,AlertTarget> alertTargets)
```
    Where the alerts are sent. (Alerts are always sent to the console.)
    
    Parameters:
    
    alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addAlertTargetsEntry
```
public DescribeSecurityProfileResult addAlertTargetsEntry(String key,
                                                          AlertTarget value)
```
    Add a single AlertTargets entry
    
    See Also:
    
    withAlertTargets(java.util.Map<java.lang.String, com.amazonaws.services.iot.model.AlertTarget>)
  - clearAlertTargetsEntries
```
public DescribeSecurityProfileResult clearAlertTargetsEntries()
```
    Removes all the entries added into AlertTargets.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalMetricsToRetain
```
@Deprecated
public List<String> getAdditionalMetricsToRetain()
```
    Deprecated.
    
    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.
    
    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.
  - setAdditionalMetricsToRetain
```
@Deprecated
public void setAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)
```
    Deprecated.
    
    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.
    
    Parameters:
    
    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.
  - withAdditionalMetricsToRetain
```
@Deprecated
public DescribeSecurityProfileResult withAdditionalMetricsToRetain(String... additionalMetricsToRetain)
```
    Deprecated.
    
    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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalMetricsToRetain(java.util.Collection) or withAdditionalMetricsToRetain(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalMetricsToRetain
```
@Deprecated
public DescribeSecurityProfileResult withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)
```
    Deprecated.
    
    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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalMetricsToRetainV2
```
public List<MetricToRetain> getAdditionalMetricsToRetainV2()
```
    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.
    
    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.
  - setAdditionalMetricsToRetainV2
```
public void setAdditionalMetricsToRetainV2(Collection<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.
    
    Parameters:
    
    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.
  - withAdditionalMetricsToRetainV2
```
public DescribeSecurityProfileResult withAdditionalMetricsToRetainV2(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setAdditionalMetricsToRetainV2(java.util.Collection) or withAdditionalMetricsToRetainV2(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withAdditionalMetricsToRetainV2
```
public DescribeSecurityProfileResult withAdditionalMetricsToRetainV2(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setVersion
```
public void setVersion(Long version)
```
    The version of the security profile. A new version is generated whenever the security profile is updated.
    
    Parameters:
    
    version - The version of the security profile. A new version is generated whenever the security profile is updated.
  - getVersion
```
public Long getVersion()
```
    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.
  - withVersion
```
public DescribeSecurityProfileResult withVersion(Long version)
```
    The version of the security profile. A new version is generated whenever the security profile is updated.
    
    Parameters:
    
    version - The version of the security profile. A new version is generated whenever the security profile is updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationDate
```
public void setCreationDate(Date creationDate)
```
    The time the security profile was created.
    
    Parameters:
    
    creationDate - The time the security profile was created.
  - getCreationDate
```
public Date getCreationDate()
```
    The time the security profile was created.
    
    Returns:
    
    The time the security profile was created.
  - withCreationDate
```
public DescribeSecurityProfileResult withCreationDate(Date creationDate)
```
    The time the security profile was created.
    
    Parameters:
    
    creationDate - The time the security profile was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastModifiedDate
```
public void setLastModifiedDate(Date lastModifiedDate)
```
    The time the security profile was last modified.
    
    Parameters:
    
    lastModifiedDate - The time the security profile was last modified.
  - getLastModifiedDate
```
public Date getLastModifiedDate()
```
    The time the security profile was last modified.
    
    Returns:
    
    The time the security profile was last modified.
  - withLastModifiedDate
```
public DescribeSecurityProfileResult withLastModifiedDate(Date lastModifiedDate)
```
    The time the security profile was last modified.
    
    Parameters:
    
    lastModifiedDate - The time the security profile was last modified.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMetricsExportConfig
```
public void setMetricsExportConfig(MetricsExportConfig metricsExportConfig)
```
    Specifies the MQTT topic and role ARN required for metric export.
    
    Parameters:
    
    metricsExportConfig - Specifies the MQTT topic and role ARN required for metric export.
  - getMetricsExportConfig
```
public MetricsExportConfig getMetricsExportConfig()
```
    Specifies the MQTT topic and role ARN required for metric export.
    
    Returns:
    
    Specifies the MQTT topic and role ARN required for metric export.
  - withMetricsExportConfig
```
public DescribeSecurityProfileResult withMetricsExportConfig(MetricsExportConfig metricsExportConfig)
```
    Specifies the MQTT topic and role ARN required for metric export.
    
    Parameters:
    
    metricsExportConfig - Specifies the MQTT topic and role ARN required for metric export.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeSecurityProfileResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.773

Class DescribeSecurityProfileResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeSecurityProfileResult

Method Detail

setSecurityProfileName

getSecurityProfileName

withSecurityProfileName

setSecurityProfileArn

getSecurityProfileArn

withSecurityProfileArn

setSecurityProfileDescription

getSecurityProfileDescription

withSecurityProfileDescription

getBehaviors

setBehaviors

withBehaviors

withBehaviors

getAlertTargets

setAlertTargets

withAlertTargets

addAlertTargetsEntry

clearAlertTargetsEntries

getAdditionalMetricsToRetain

setAdditionalMetricsToRetain

withAdditionalMetricsToRetain

withAdditionalMetricsToRetain

getAdditionalMetricsToRetainV2

setAdditionalMetricsToRetainV2

withAdditionalMetricsToRetainV2

withAdditionalMetricsToRetainV2

setVersion

getVersion

withVersion

setCreationDate

getCreationDate

withCreationDate

setLastModifiedDate

getLastModifiedDate

withLastModifiedDate

setMetricsExportConfig

getMetricsExportConfig

withMetricsExportConfig

toString

equals

hashCode

clone