software.amazon.awssdk.services.iot.model

Interface DescribeSecurityProfileResponse.Builder

All Superinterfaces:

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

Enclosing class:

DescribeSecurityProfileResponse

public static interface DescribeSecurityProfileResponse.Builder
extends IotResponse.Builder, SdkPojo, CopyableBuilder<DescribeSecurityProfileResponse.Builder,DescribeSecurityProfileResponse>

Method Summary

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

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

build, responseMetadata, responseMetadata

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

sdkHttpResponse, sdkHttpResponse

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

equalsBySdkFields, sdkFields

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

copy

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

applyMutation, build

Method Detail

securityProfileName

DescribeSecurityProfileResponse.Builder securityProfileName(String securityProfileName)

The name of the security profile.

Parameters:

securityProfileName - The name of the security profile.

Returns:

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

securityProfileArn

DescribeSecurityProfileResponse.Builder securityProfileArn(String securityProfileArn)

The ARN of the security profile.

Parameters:

securityProfileArn - The ARN of the security profile.

Returns:

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

securityProfileDescription

DescribeSecurityProfileResponse.Builder securityProfileDescription(String securityProfileDescription)

A description of the security profile (associated with the security profile when it was created or updated).

Parameters:

securityProfileDescription - A description of the security profile (associated with the security profile when it was created or updated).

Returns:

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

behaviors

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

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

DescribeSecurityProfileResponse.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).

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)

alertTargetsWithStrings

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

DescribeSecurityProfileResponse.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
DescribeSecurityProfileResponse.Builder additionalMetricsToRetain(Collection<String> additionalMetricsToRetain)

Deprecated. Use additionalMetricsToRetainV2.

Please use DescribeSecurityProfileResponse$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.

Parameters:

additionalMetricsToRetain - Please use DescribeSecurityProfileResponse$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.

Returns:

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

additionalMetricsToRetain

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

Deprecated. Use additionalMetricsToRetainV2.

Please use DescribeSecurityProfileResponse$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.

Parameters:

additionalMetricsToRetain - Please use DescribeSecurityProfileResponse$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.

Returns:

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

additionalMetricsToRetainV2

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

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.

Returns:

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

additionalMetricsToRetainV2

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

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.

Returns:

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

additionalMetricsToRetainV2

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

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

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)

version

DescribeSecurityProfileResponse.Builder version(Long version)

The version of the security profile. A new version is generated whenever the security profile is updated.

Parameters:

version - The version of the security profile. A new version is generated whenever the security profile is updated.

Returns:

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

creationDate

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

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