UpdateSecurityProfileRequest (AWS SDK for Android

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.iot.model.UpdateSecurityProfileRequest

All Implemented Interfaces:

Serializable, Cloneable
```
public class UpdateSecurityProfileRequest
extends AmazonWebServiceRequest
implements Serializable
```
Updates a Device Defender security profile.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

UpdateSecurityProfileRequest()

Constructors
Constructor and Description
`UpdateSecurityProfileRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`UpdateSecurityProfileRequest`	`addalertTargetsEntry(String key, AlertTarget value)` Where the alerts are sent.
`UpdateSecurityProfileRequest`	`clearalertTargetsEntries()` Removes all the entries added into alertTargets.
`boolean`	`equals(Object obj)`
`List<String>`	`getAdditionalMetricsToRetain()` 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.
`Boolean`	`getDeleteAdditionalMetricsToRetain()` If true, delete all `additionalMetricsToRetain` defined for this security profile.
`Boolean`	`getDeleteAlertTargets()` If true, delete all `alertTargets` defined for this security profile.
`Boolean`	`getDeleteBehaviors()` If true, delete all `behaviors` defined for this security profile.
`Long`	`getExpectedVersion()` The expected version of the security profile.
`String`	`getSecurityProfileDescription()` A description of the security profile.
`String`	`getSecurityProfileName()` The name of the security profile you want to update.
`int`	`hashCode()`
`Boolean`	`isDeleteAdditionalMetricsToRetain()` If true, delete all `additionalMetricsToRetain` defined for this security profile.
`Boolean`	`isDeleteAlertTargets()` If true, delete all `alertTargets` defined for this security profile.
`Boolean`	`isDeleteBehaviors()` If true, delete all `behaviors` defined for this security profile.
`void`	`setAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)` 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`	`setDeleteAdditionalMetricsToRetain(Boolean deleteAdditionalMetricsToRetain)` If true, delete all `additionalMetricsToRetain` defined for this security profile.
`void`	`setDeleteAlertTargets(Boolean deleteAlertTargets)` If true, delete all `alertTargets` defined for this security profile.
`void`	`setDeleteBehaviors(Boolean deleteBehaviors)` If true, delete all `behaviors` defined for this security profile.
`void`	`setExpectedVersion(Long expectedVersion)` The expected version of the security profile.
`void`	`setSecurityProfileDescription(String securityProfileDescription)` A description of the security profile.
`void`	`setSecurityProfileName(String securityProfileName)` The name of the security profile you want to update.
`String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`UpdateSecurityProfileRequest`	`withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)` A list of metrics whose data is retained (stored).
`UpdateSecurityProfileRequest`	`withAdditionalMetricsToRetain(String... additionalMetricsToRetain)` A list of metrics whose data is retained (stored).
`UpdateSecurityProfileRequest`	`withAlertTargets(Map<String,AlertTarget> alertTargets)` Where the alerts are sent.
`UpdateSecurityProfileRequest`	`withBehaviors(Behavior... behaviors)` Specifies the behaviors that, when violated by a device (thing), cause an alert.
`UpdateSecurityProfileRequest`	`withBehaviors(Collection<Behavior> behaviors)` Specifies the behaviors that, when violated by a device (thing), cause an alert.
`UpdateSecurityProfileRequest`	`withDeleteAdditionalMetricsToRetain(Boolean deleteAdditionalMetricsToRetain)` If true, delete all `additionalMetricsToRetain` defined for this security profile.
`UpdateSecurityProfileRequest`	`withDeleteAlertTargets(Boolean deleteAlertTargets)` If true, delete all `alertTargets` defined for this security profile.
`UpdateSecurityProfileRequest`	`withDeleteBehaviors(Boolean deleteBehaviors)` If true, delete all `behaviors` defined for this security profile.
`UpdateSecurityProfileRequest`	`withExpectedVersion(Long expectedVersion)` The expected version of the security profile.
`UpdateSecurityProfileRequest`	`withSecurityProfileDescription(String securityProfileDescription)` A description of the security profile.
`UpdateSecurityProfileRequest`	`withSecurityProfileName(String securityProfileName)` The name of the security profile you want to update.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - UpdateSecurityProfileRequest
```
public UpdateSecurityProfileRequest()
```
- Method Detail
  - getSecurityProfileName
```
public String getSecurityProfileName()
```
    The name of the security profile you want to update.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Returns:
    
    The name of the security profile you want to update.
  - setSecurityProfileName
```
public void setSecurityProfileName(String securityProfileName)
```
    The name of the security profile you want to update.
    
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Parameters:
    
    securityProfileName -
    The name of the security profile you want to update.
  - withSecurityProfileName
```
public UpdateSecurityProfileRequest withSecurityProfileName(String securityProfileName)
```
    The name of the security profile you want to update.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [a-zA-Z0-9:_-]+
    
    Parameters:
    
    securityProfileName -
    The name of the security profile you want to update.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSecurityProfileDescription
```
public String getSecurityProfileDescription()
```
    A description of the security profile.
    
    Constraints:
    Length: - 1000
    Pattern: [\p{Graph}\x20]*
    
    Returns:
    
    A description of the security profile.
  - setSecurityProfileDescription
```
public void setSecurityProfileDescription(String securityProfileDescription)
```
    A description of the security profile.
    
    Constraints:
    Length: - 1000
    Pattern: [\p{Graph}\x20]*
    
    Parameters:
    
    securityProfileDescription -
    A description of the security profile.
  - withSecurityProfileDescription
```
public UpdateSecurityProfileRequest withSecurityProfileDescription(String securityProfileDescription)
```
    A description of the security profile.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: - 1000
    Pattern: [\p{Graph}\x20]*
    
    Parameters:
    
    securityProfileDescription -
    A description of the security profile.
    
    Returns:
    
    A reference to this updated 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 UpdateSecurityProfileRequest withBehaviors(Behavior... behaviors)
```
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    behaviors -
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - withBehaviors
```
public UpdateSecurityProfileRequest withBehaviors(Collection<Behavior> behaviors)
```
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    behaviors -
    Specifies the behaviors that, when violated by a device (thing), cause an alert.
    
    Returns:
    
    A reference to this updated 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 UpdateSecurityProfileRequest withAlertTargets(Map<String,AlertTarget> alertTargets)
```
    Where the alerts are sent. (Alerts are always sent to the console.)
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    alertTargets -
    Where the alerts are sent. (Alerts are always sent to the console.)
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - addalertTargetsEntry
```
public UpdateSecurityProfileRequest addalertTargetsEntry(String key,
                                                         AlertTarget value)
```
    Where the alerts are sent. (Alerts are always sent to the console.)
    
    The method adds a new key-value pair into alertTargets parameter, and returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    key - The key of the entry to be added into alertTargets.
    
    value - The corresponding value of the entry to be added into alertTargets.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - clearalertTargetsEntries
```
public UpdateSecurityProfileRequest clearalertTargetsEntries()
```
    Removes all the entries added into alertTargets.
    Returns a reference to this object so that method calls can be chained together.
  - getAdditionalMetricsToRetain
```
public List<String> getAdditionalMetricsToRetain()
```
    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.
  - setAdditionalMetricsToRetain
```
public void setAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)
```
    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 -
    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
```
public UpdateSecurityProfileRequest withAdditionalMetricsToRetain(String... additionalMetricsToRetain)
```
    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 reference to this object so that method calls can be chained together.
    
    Parameters:
    
    additionalMetricsToRetain -
    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 reference to this updated object so that method calls can be chained together.
  - withAdditionalMetricsToRetain
```
public UpdateSecurityProfileRequest withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)
```
    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 reference to this object so that method calls can be chained together.
    
    Parameters:
    
    additionalMetricsToRetain -
    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 reference to this updated object so that method calls can be chained together.
  - isDeleteBehaviors
```
public Boolean isDeleteBehaviors()
```
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
    
    Returns:
    
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
  - getDeleteBehaviors
```
public Boolean getDeleteBehaviors()
```
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
    
    Returns:
    
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
  - setDeleteBehaviors
```
public void setDeleteBehaviors(Boolean deleteBehaviors)
```
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
    
    Parameters:
    
    deleteBehaviors -
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
  - withDeleteBehaviors
```
public UpdateSecurityProfileRequest withDeleteBehaviors(Boolean deleteBehaviors)
```
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deleteBehaviors -
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isDeleteAlertTargets
```
public Boolean isDeleteAlertTargets()
```
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
    
    Returns:
    
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
  - getDeleteAlertTargets
```
public Boolean getDeleteAlertTargets()
```
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
    
    Returns:
    
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
  - setDeleteAlertTargets
```
public void setDeleteAlertTargets(Boolean deleteAlertTargets)
```
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
    
    Parameters:
    
    deleteAlertTargets -
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
  - withDeleteAlertTargets
```
public UpdateSecurityProfileRequest withDeleteAlertTargets(Boolean deleteAlertTargets)
```
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deleteAlertTargets -
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - isDeleteAdditionalMetricsToRetain
```
public Boolean isDeleteAdditionalMetricsToRetain()
```
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
    
    Returns:
    
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
  - getDeleteAdditionalMetricsToRetain
```
public Boolean getDeleteAdditionalMetricsToRetain()
```
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
    
    Returns:
    
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
  - setDeleteAdditionalMetricsToRetain
```
public void setDeleteAdditionalMetricsToRetain(Boolean deleteAdditionalMetricsToRetain)
```
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
    
    Parameters:
    
    deleteAdditionalMetricsToRetain -
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
  - withDeleteAdditionalMetricsToRetain
```
public UpdateSecurityProfileRequest withDeleteAdditionalMetricsToRetain(Boolean deleteAdditionalMetricsToRetain)
```
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    deleteAdditionalMetricsToRetain -
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getExpectedVersion
```
public Long getExpectedVersion()
```
    The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
    
    Returns:
    
    The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
  - setExpectedVersion
```
public void setExpectedVersion(Long expectedVersion)
```
    The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
    
    Parameters:
    
    expectedVersion -
    The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
  - withExpectedVersion
```
public UpdateSecurityProfileRequest withExpectedVersion(Long expectedVersion)
```
    The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    expectedVersion -
    The expected version of the security profile. A new version is generated whenever the security profile is updated. If you specify a value that is different from the actual version, a VersionConflictException is thrown.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object

Class UpdateSecurityProfileRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

UpdateSecurityProfileRequest

Method Detail

getSecurityProfileName

setSecurityProfileName

withSecurityProfileName

getSecurityProfileDescription

setSecurityProfileDescription

withSecurityProfileDescription

getBehaviors

setBehaviors

withBehaviors

withBehaviors

getAlertTargets

setAlertTargets

withAlertTargets

addalertTargetsEntry

clearalertTargetsEntries

getAdditionalMetricsToRetain

setAdditionalMetricsToRetain

withAdditionalMetricsToRetain

withAdditionalMetricsToRetain

isDeleteBehaviors

getDeleteBehaviors

setDeleteBehaviors

withDeleteBehaviors

isDeleteAlertTargets

getDeleteAlertTargets

setDeleteAlertTargets

withDeleteAlertTargets

isDeleteAdditionalMetricsToRetain

getDeleteAdditionalMetricsToRetain

setDeleteAdditionalMetricsToRetain

withDeleteAdditionalMetricsToRetain

getExpectedVersion

setExpectedVersion

withExpectedVersion

toString

hashCode

equals