com.amazonaws.services.iot.model

Class UpdateSecurityProfileRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.iot.model.UpdateSecurityProfileRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class UpdateSecurityProfileRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateSecurityProfileRequest()

Method Summary

Modifier and Type	Method and Description
UpdateSecurityProfileRequest	addAlertTargetsEntry(String key, AlertTarget value) Add a single AlertTargets entry
UpdateSecurityProfileRequest	clearAlertTargetsEntries() Removes all the entries added into AlertTargets.
UpdateSecurityProfileRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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.
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) 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	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.
UpdateSecurityProfileRequest	withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain) Deprecated.
UpdateSecurityProfileRequest	withAdditionalMetricsToRetain(String... additionalMetricsToRetain) Deprecated.
UpdateSecurityProfileRequest	withAdditionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2) A list of metrics whose data is retained (stored).
UpdateSecurityProfileRequest	withAdditionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2) 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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateSecurityProfileRequest

public UpdateSecurityProfileRequest()

Method Detail

setSecurityProfileName

public void setSecurityProfileName(String securityProfileName)

The name of the security profile you want to update.

Parameters:

securityProfileName - The name of the security profile you want to update.

getSecurityProfileName

public String getSecurityProfileName()

The name of the security profile you want to update.

Returns:

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.

Parameters:

securityProfileName - The name of the security profile you want to update.

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.

Parameters:

securityProfileDescription - A description of the security profile.

getSecurityProfileDescription

public String getSecurityProfileDescription()

A description of the security profile.

Returns:

A description of the security profile.

withSecurityProfileDescription

public UpdateSecurityProfileRequest withSecurityProfileDescription(String securityProfileDescription)

A description of the security profile.

Parameters:

securityProfileDescription - A description of the security profile.

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

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 API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

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.

Note: This API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

setAdditionalMetricsToRetain

@Deprecated
public void setAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

Deprecated.

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 API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

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.

Note: This API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

withAdditionalMetricsToRetain

@Deprecated
public UpdateSecurityProfileRequest withAdditionalMetricsToRetain(String... additionalMetricsToRetain)

Deprecated.

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 API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

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 - 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 API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

Returns:

Returns a reference to this object so that method calls can be chained together.

withAdditionalMetricsToRetain

@Deprecated
public UpdateSecurityProfileRequest withAdditionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

Deprecated.

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 API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

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.

Note: This API field is deprecated. Please use UpdateSecurityProfileRequest$additionalMetricsToRetainV2 instead.

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

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.

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.

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.

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:

Returns a reference to this 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.

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.

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.

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.

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:

Returns a reference to this 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.

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.

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.

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.

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:

Returns a reference to this 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.

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.

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.

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.

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:

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 UpdateSecurityProfileRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()