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 Deprecated Methods
Modifier and Type	Method and Description
`List<String>`	`additionalMetricsToRetain()` Deprecated. Use additionalMetricsToRetainV2.
`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 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()` Deprecated. Use additionalMetricsToRetainV2.
`boolean`	`hasAdditionalMetricsToRetainV2()` For responses, this returns true if the service returned a value for the AdditionalMetricsToRetainV2 property.
`boolean`	`hasAlertTargets()` For responses, this returns true if the service returned a value for the AlertTargets property.
`boolean`	`hasBehaviors()` For responses, this returns true if the service returned a value for the Behaviors property.
`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 final 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 final String securityProfileDescription()
```
    A description of the security profile.
    
    Returns:
    
    A description of the security profile.
  - hasBehaviors
```
public final boolean hasBehaviors()
```
    For responses, this returns true if the service returned a value for the Behaviors property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasBehaviors() method.
    
    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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlertTargets() method.
    
    Returns:
    
    Where the alerts are sent. (Alerts are always sent to the console.)
  - hasAlertTargets
```
public final boolean hasAlertTargets()
```
    For responses, this returns true if the service returned a value for the AlertTargets property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAlertTargets() method.
    
    Returns:
    
    Where the alerts are sent. (Alerts are always sent to the console.)
  - hasAdditionalMetricsToRetain
```
@Deprecated
public final boolean hasAdditionalMetricsToRetain()
```
    Deprecated. Use additionalMetricsToRetainV2.
    
    For responses, this returns true if the service returned a value for the AdditionalMetricsToRetain property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - additionalMetricsToRetain
```
@Deprecated
public final List<String> additionalMetricsToRetain()
```
    Deprecated. Use additionalMetricsToRetainV2.
    
    Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalMetricsToRetain() method.
    
    Returns:
    
    Please use UpdateSecurityProfileRequest$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. Can be used with custom metrics; cannot be used with dimensions.
  - hasAdditionalMetricsToRetainV2
```
public final boolean hasAdditionalMetricsToRetainV2()
```
    For responses, this returns true if the service returned a value for the AdditionalMetricsToRetainV2 property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - 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. Can be used with custom metrics; cannot be used with dimensions.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasAdditionalMetricsToRetainV2() method.
    
    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. Can be used with custom metrics; cannot be used with dimensions.
  - deleteBehaviors
```
public final 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 final 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 final 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 final 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 final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - 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 SdkRequest
  - sdkFields
```
public final 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

hasAdditionalMetricsToRetainV2

additionalMetricsToRetainV2

deleteBehaviors

deleteAlertTargets

deleteAdditionalMetricsToRetain

expectedVersion

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields