Interface UpdateSecurityProfileResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<UpdateSecurityProfileResponse.Builder,UpdateSecurityProfileResponse>, IotResponse.Builder, SdkBuilder<UpdateSecurityProfileResponse.Builder,UpdateSecurityProfileResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

UpdateSecurityProfileResponse

@Mutable
@NotThreadSafe
public static interface UpdateSecurityProfileResponse.Builder
extends IotResponse.Builder, SdkPojo, CopyableBuilder<UpdateSecurityProfileResponse.Builder,UpdateSecurityProfileResponse>

Method Summary

Modifier and Type	Method	Description
UpdateSecurityProfileResponse.Builder	additionalMetricsToRetain(String... additionalMetricsToRetain)	Deprecated. Use additionalMetricsToRetainV2.
UpdateSecurityProfileResponse.Builder	additionalMetricsToRetain(Collection<String> additionalMetricsToRetain)	Deprecated. Use additionalMetricsToRetainV2.
UpdateSecurityProfileResponse.Builder	additionalMetricsToRetainV2(Collection<MetricToRetain> additionalMetricsToRetainV2)	A list of metrics whose data is retained (stored).
UpdateSecurityProfileResponse.Builder	additionalMetricsToRetainV2(Consumer<MetricToRetain.Builder>... additionalMetricsToRetainV2)	A list of metrics whose data is retained (stored).
UpdateSecurityProfileResponse.Builder	additionalMetricsToRetainV2(MetricToRetain... additionalMetricsToRetainV2)	A list of metrics whose data is retained (stored).
UpdateSecurityProfileResponse.Builder	alertTargets(Map<AlertTargetType,AlertTarget> alertTargets)	Where the alerts are sent.
UpdateSecurityProfileResponse.Builder	alertTargetsWithStrings(Map<String,AlertTarget> alertTargets)	Where the alerts are sent.
UpdateSecurityProfileResponse.Builder	behaviors(Collection<Behavior> behaviors)	Specifies the behaviors that, when violated by a device (thing), cause an alert.
UpdateSecurityProfileResponse.Builder	behaviors(Consumer<Behavior.Builder>... behaviors)	Specifies the behaviors that, when violated by a device (thing), cause an alert.
UpdateSecurityProfileResponse.Builder	behaviors(Behavior... behaviors)	Specifies the behaviors that, when violated by a device (thing), cause an alert.
UpdateSecurityProfileResponse.Builder	creationDate(Instant creationDate)	The time the security profile was created.
UpdateSecurityProfileResponse.Builder	lastModifiedDate(Instant lastModifiedDate)	The time the security profile was last modified.
default UpdateSecurityProfileResponse.Builder	metricsExportConfig(Consumer<MetricsExportConfig.Builder> metricsExportConfig)	Specifies the MQTT topic and role ARN required for metric export.
UpdateSecurityProfileResponse.Builder	metricsExportConfig(MetricsExportConfig metricsExportConfig)	Specifies the MQTT topic and role ARN required for metric export.
UpdateSecurityProfileResponse.Builder	securityProfileArn(String securityProfileArn)	The ARN of the security profile that was updated.
UpdateSecurityProfileResponse.Builder	securityProfileDescription(String securityProfileDescription)	The description of the security profile.
UpdateSecurityProfileResponse.Builder	securityProfileName(String securityProfileName)	The name of the security profile that was updated.
UpdateSecurityProfileResponse.Builder	version(Long version)	The updated version of the security profile.

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.services.iot.model.IotResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

Method Details

securityProfileName

UpdateSecurityProfileResponse.Builder securityProfileName(String securityProfileName)

The name of the security profile that was updated.

Parameters:

securityProfileName - The name of the security profile that was updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityProfileArn

UpdateSecurityProfileResponse.Builder securityProfileArn(String securityProfileArn)

The ARN of the security profile that was updated.

Parameters:

securityProfileArn - The ARN of the security profile that was updated.

Returns:

Returns a reference to this object so that method calls can be chained together.

securityProfileDescription

UpdateSecurityProfileResponse.Builder securityProfileDescription(String securityProfileDescription)

The description of the security profile.

Parameters:

securityProfileDescription - The description of the security profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

behaviors

UpdateSecurityProfileResponse.Builder behaviors(Collection<Behavior> behaviors)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Parameters:

behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.

Returns:

Returns a reference to this object so that method calls can be chained together.

behaviors

UpdateSecurityProfileResponse.Builder behaviors(Behavior... behaviors)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

Parameters:

behaviors - Specifies the behaviors that, when violated by a device (thing), cause an alert.

Returns:

Returns a reference to this object so that method calls can be chained together.

behaviors

UpdateSecurityProfileResponse.Builder behaviors(Consumer<Behavior.Builder>... behaviors)

Specifies the behaviors that, when violated by a device (thing), cause an alert.

This is a convenience method that creates an instance of the Behavior.Builder avoiding the need to create one manually via Behavior.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to behaviors(List<Behavior>).

Parameters:

behaviors - a consumer that will call methods on Behavior.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• behaviors(java.util.Collection<Behavior>)

alertTargetsWithStrings

UpdateSecurityProfileResponse.Builder alertTargetsWithStrings(Map<String,AlertTarget> alertTargets)

Where the alerts are sent. (Alerts are always sent to the console.)

Parameters:

alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)

Returns:

Returns a reference to this object so that method calls can be chained together.

alertTargets

UpdateSecurityProfileResponse.Builder alertTargets(Map<AlertTargetType,AlertTarget> alertTargets)

Where the alerts are sent. (Alerts are always sent to the console.)

Parameters:

alertTargets - Where the alerts are sent. (Alerts are always sent to the console.)

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalMetricsToRetain

@Deprecated
UpdateSecurityProfileResponse.Builder additionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

Deprecated.

Use additionalMetricsToRetainV2.

Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

Parameters:

additionalMetricsToRetain - Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalMetricsToRetain

@Deprecated
UpdateSecurityProfileResponse.Builder additionalMetricsToRetain(String... additionalMetricsToRetain)

Deprecated.

Use additionalMetricsToRetainV2.

Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

Parameters:

additionalMetricsToRetain - Please use UpdateSecurityProfileResponse$additionalMetricsToRetainV2 instead.

A list of metrics whose data is retained (stored). By default, data is retained for any metric used in the security profile's behaviors, but it is also retained for any metric specified here.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalMetricsToRetainV2

UpdateSecurityProfileResponse.Builder additionalMetricsToRetainV2(Collection<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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalMetricsToRetainV2

UpdateSecurityProfileResponse.Builder additionalMetricsToRetainV2(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.

Parameters:

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.

Returns:

Returns a reference to this object so that method calls can be chained together.

additionalMetricsToRetainV2

UpdateSecurityProfileResponse.Builder additionalMetricsToRetainV2(Consumer<MetricToRetain.Builder>... 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.

This is a convenience method that creates an instance of the MetricToRetain.Builder avoiding the need to create one manually via MetricToRetain.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to additionalMetricsToRetainV2(List<MetricToRetain>).

Parameters:

additionalMetricsToRetainV2 - a consumer that will call methods on MetricToRetain.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• additionalMetricsToRetainV2(java.util.Collection<MetricToRetain>)

version

UpdateSecurityProfileResponse.Builder version(Long version)

The updated version of the security profile.

Parameters:

version - The updated version of the security profile.

Returns:

Returns a reference to this object so that method calls can be chained together.

creationDate

UpdateSecurityProfileResponse.Builder creationDate(Instant creationDate)

The time the security profile was created.

Parameters:

creationDate - The time the security profile was created.

Returns:

Returns a reference to this object so that method calls can be chained together.

lastModifiedDate

UpdateSecurityProfileResponse.Builder lastModifiedDate(Instant lastModifiedDate)

The time the security profile was last modified.

Parameters:

lastModifiedDate - The time the security profile was last modified.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricsExportConfig

UpdateSecurityProfileResponse.Builder metricsExportConfig(MetricsExportConfig metricsExportConfig)

Specifies the MQTT topic and role ARN required for metric export.

Parameters:

metricsExportConfig - Specifies the MQTT topic and role ARN required for metric export.

Returns:

Returns a reference to this object so that method calls can be chained together.

metricsExportConfig

default UpdateSecurityProfileResponse.Builder metricsExportConfig(Consumer<MetricsExportConfig.Builder> metricsExportConfig)

Specifies the MQTT topic and role ARN required for metric export.

This is a convenience method that creates an instance of the MetricsExportConfig.Builder avoiding the need to create one manually via MetricsExportConfig.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricsExportConfig(MetricsExportConfig).

Parameters:

metricsExportConfig - a consumer that will call methods on MetricsExportConfig.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

• metricsExportConfig(MetricsExportConfig)