UpdateSecurityProfileRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.iot.model.IotRequest
    - - software.amazon.awssdk.services.iot.model.UpdateSecurityProfileRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface UpdateSecurityProfileRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`additionalMetricsToRetain()` 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 UpdateSecurityProfileRequest.Builder`	`builder()`
`Boolean`	`deleteAdditionalMetricsToRetain()` If true, delete all `additionalMetricsToRetain` defined for this security profile.
`Boolean`	`deleteAlertTargets()` If true, delete all `alertTargets` defined for this security profile.
`Boolean`	`deleteBehaviors()` If true, delete all `behaviors` defined for this security profile.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`Long`	`expectedVersion()` The expected version of the security profile.
`<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`	`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()`
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityProfileDescription()` A description of the security profile.
`String`	`securityProfileName()` The name of the security profile you want to update.
`static Class<? extends UpdateSecurityProfileRequest.Builder>`	`serializableBuilderClass()`
`UpdateSecurityProfileRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

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 String securityProfileName()
```
    The name of the security profile you want to update.
    
    Returns:
    
    The name of the security profile you want to update.
  - securityProfileDescription
```
public String securityProfileDescription()
```
    A description of the security profile.
    
    Returns:
    
    A description of the security profile.
  - hasBehaviors
```
public 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 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 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 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 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 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 List<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.
    
    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:
    
    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.
  - deleteBehaviors
```
public 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:
    
    If true, delete all behaviors defined for this security profile. If any behaviors are defined in the current invocation, an exception occurs.
  - deleteAlertTargets
```
public 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:
    
    If true, delete all alertTargets defined for this security profile. If any alertTargets are defined in the current invocation, an exception occurs.
  - deleteAdditionalMetricsToRetain
```
public 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:
    
    If true, delete all additionalMetricsToRetain defined for this security profile. If any additionalMetricsToRetain are defined in the current invocation, an exception occurs.
  - expectedVersion
```
public 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:
    
    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.
  - toBuilder
```
public UpdateSecurityProfileRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<UpdateSecurityProfileRequest.Builder,UpdateSecurityProfileRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
  - builder
```
public static UpdateSecurityProfileRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends UpdateSecurityProfileRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class UpdateSecurityProfileRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

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

Method Detail

securityProfileName

securityProfileDescription

hasBehaviors

behaviors

alertTargets

hasAlertTargets

alertTargetsAsStrings

hasAdditionalMetricsToRetain

additionalMetricsToRetain

deleteBehaviors

deleteAlertTargets

deleteAdditionalMetricsToRetain

expectedVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields