Class UpdateSecurityProfileRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<UpdateSecurityProfileRequest.Builder,
UpdateSecurityProfileRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionDeprecated.Use additionalMetricsToRetainV2.final List
<MetricToRetain> A list of metrics whose data is retained (stored).final Map
<AlertTargetType, AlertTarget> Where the alerts are sent.final Map
<String, AlertTarget> Where the alerts are sent.Specifies the behaviors that, when violated by a device (thing), cause an alert.builder()
final Boolean
If true, delete alladditionalMetricsToRetain
defined for this security profile.final Boolean
If true, delete allalertTargets
defined for this security profile.final Boolean
If true, delete allbehaviors
defined for this security profile.final Boolean
Set the value as true to delete metrics export related configurations.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final Long
The expected version of the security profile.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final boolean
Deprecated.Use additionalMetricsToRetainV2.final boolean
For responses, this returns true if the service returned a value for the AdditionalMetricsToRetainV2 property.final boolean
For responses, this returns true if the service returned a value for the AlertTargets property.final boolean
For responses, this returns true if the service returned a value for the Behaviors property.final int
hashCode()
final MetricsExportConfig
Specifies the MQTT topic and role ARN required for metric export.final String
A description of the security profile.final String
The name of the security profile you want to update.static Class
<? extends UpdateSecurityProfileRequest.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
securityProfileName
The name of the security profile you want to update.
- Returns:
- The name of the security profile you want to update.
-
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 theisEmpty()
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
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
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 theisEmpty()
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
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.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 theisEmpty()
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.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 theisEmpty()
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
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
If true, delete all
behaviors
defined for this security profile. If anybehaviors
are defined in the current invocation, an exception occurs.- Returns:
- If true, delete all
behaviors
defined for this security profile. If anybehaviors
are defined in the current invocation, an exception occurs.
-
deleteAlertTargets
If true, delete all
alertTargets
defined for this security profile. If anyalertTargets
are defined in the current invocation, an exception occurs.- Returns:
- If true, delete all
alertTargets
defined for this security profile. If anyalertTargets
are defined in the current invocation, an exception occurs.
-
deleteAdditionalMetricsToRetain
If true, delete all
additionalMetricsToRetain
defined for this security profile. If anyadditionalMetricsToRetain
are defined in the current invocation, an exception occurs.- Returns:
- If true, delete all
additionalMetricsToRetain
defined for this security profile. If anyadditionalMetricsToRetain
are defined in the current invocation, an exception occurs.
-
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.
-
metricsExportConfig
Specifies the MQTT topic and role ARN required for metric export.
- Returns:
- Specifies the MQTT topic and role ARN required for metric export.
-
deleteMetricsExportConfig
Set the value as true to delete metrics export related configurations.
- Returns:
- Set the value as true to delete metrics export related configurations.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<UpdateSecurityProfileRequest.Builder,
UpdateSecurityProfileRequest> - Specified by:
toBuilder
in classIotRequest
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-