Package software.amazon.awssdk.services.iot.model

Class UpdateSecurityProfileRequest

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

      • metricsExportConfig

        public final MetricsExportConfig 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

        public final Boolean deleteMetricsExportConfig()

        Set the value as true to delete metrics export related configurations.

        Returns:
        Set the value as true to delete metrics export related configurations.

      • 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