CreateSecurityProfileRequest (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.CreateSecurityProfileRequest

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateSecurityProfileRequest.Builder

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`List<String>`	`additionalMetricsToRetain()` Please use CreateSecurityProfileRequest$additionalMetricsToRetainV2 instead.
`List<MetricToRetain>`	`additionalMetricsToRetainV2()` A list of metrics whose data is retained (stored).
`Map<AlertTargetType,AlertTarget>`	`alertTargets()` Specifies the destinations to which alerts are sent.
`Map<String,AlertTarget>`	`alertTargetsAsStrings()` Specifies the destinations to which alerts are sent.
`List<Behavior>`	`behaviors()` Specifies the behaviors that, when violated by a device (thing), cause an alert.
`static CreateSecurityProfileRequest.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<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`	`hasAdditionalMetricsToRetainV2()` Returns true if the AdditionalMetricsToRetainV2 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()`
`boolean`	`hasTags()` Returns true if the Tags property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
`List<SdkField<?>>`	`sdkFields()`
`String`	`securityProfileDescription()` A description of the security profile.
`String`	`securityProfileName()` The name you are giving to the security profile.
`static Class<? extends CreateSecurityProfileRequest.Builder>`	`serializableBuilderClass()`
`List<Tag>`	`tags()` Metadata that can be used to manage the security profile.
`CreateSecurityProfileRequest.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 you are giving to the security profile.
    
    Returns:
    
    The name you are giving to the security profile.
  - securityProfileDescription
```
public final String securityProfileDescription()
```
    A description of the security profile.
    
    Returns:
    
    A description of the security profile.
  - hasBehaviors
```
public final 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 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.
    
    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 final Map<AlertTargetType,AlertTarget> alertTargets()
```
    Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
    
    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:
    
    Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
  - hasAlertTargets
```
public final 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 final Map<String,AlertTarget> alertTargetsAsStrings()
```
    Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
    
    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:
    
    Specifies the destinations to which alerts are sent. (Alerts are always sent to the console.) Alerts are generated when a device (thing) violates a behavior.
  - hasAdditionalMetricsToRetain
```
public final 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 final List<String> additionalMetricsToRetain()
```
    Please use CreateSecurityProfileRequest$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.
    
    You can use hasAdditionalMetricsToRetain() to see if a value was sent in this field.
    
    Returns:
    
    Please use CreateSecurityProfileRequest$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()
```
    Returns true if the AdditionalMetricsToRetainV2 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.
  - 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.
    
    You can use hasAdditionalMetricsToRetainV2() 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. Can be used with custom metrics; cannot be used with dimensions.
  - hasTags
```
public final boolean hasTags()
```
    Returns true if the Tags 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.
  - tags
```
public final List<Tag> tags()
```
    Metadata that can be used to manage the security profile.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    You can use hasTags() to see if a value was sent in this field.
    
    Returns:
    
    Metadata that can be used to manage the security profile.
  - toBuilder
```
public CreateSecurityProfileRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateSecurityProfileRequest.Builder,CreateSecurityProfileRequest>
    
    Specified by:
    
    toBuilder in class IotRequest
  - builder
```
public static CreateSecurityProfileRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateSecurityProfileRequest.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 CreateSecurityProfileRequest

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

hasTags

tags

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields