software.amazon.awssdk.services.iot.model

Class CreateSecurityProfileRequest

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

Method Summary

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() 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() 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()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
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()

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

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.

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:

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

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

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.

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:

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

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

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

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.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags 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.

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.

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 hasTags() method.

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