Package software.amazon.awssdk.services.cloudformation.model

Interface DescribeResourceScanResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CloudFormationResponse.Builder, CopyableBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>, SdkBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

DescribeResourceScanResponse

@Mutable
@NotThreadSafe
public static interface DescribeResourceScanResponse.Builder
extends CloudFormationResponse.Builder, SdkPojo, CopyableBuilder<DescribeResourceScanResponse.Builder,DescribeResourceScanResponse>

Method Summary

Modifier and Type	Method	Description
DescribeResourceScanResponse.Builder	endTime(Instant endTime)	The time that the resource scan was finished.
DescribeResourceScanResponse.Builder	percentageCompleted(Double percentageCompleted)	The percentage of the resource scan that has been completed.
DescribeResourceScanResponse.Builder	resourceScanId(String resourceScanId)	The Amazon Resource Name (ARN) of the resource scan.
DescribeResourceScanResponse.Builder	resourcesRead(Integer resourcesRead)	The number of resources that were read.
DescribeResourceScanResponse.Builder	resourcesScanned(Integer resourcesScanned)	The number of resources that were listed.
DescribeResourceScanResponse.Builder	resourceTypes(String... resourceTypes)	The list of resource types for the specified scan.
DescribeResourceScanResponse.Builder	resourceTypes(Collection<String> resourceTypes)	The list of resource types for the specified scan.
DescribeResourceScanResponse.Builder	scanFilters(Collection<ScanFilter> scanFilters)	The scan filters that were used.
DescribeResourceScanResponse.Builder	scanFilters(Consumer<ScanFilter.Builder>... scanFilters)	The scan filters that were used.
DescribeResourceScanResponse.Builder	scanFilters(ScanFilter... scanFilters)	The scan filters that were used.
DescribeResourceScanResponse.Builder	startTime(Instant startTime)	The time that the resource scan was started.
DescribeResourceScanResponse.Builder	status(String status)	Status of the resource scan.
DescribeResourceScanResponse.Builder	status(ResourceScanStatus status)	Status of the resource scan.
DescribeResourceScanResponse.Builder	statusReason(String statusReason)	The reason for the resource scan status, providing more information if a failure happened.

Methods inherited from interface software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse.Builder

build, responseMetadata, responseMetadata

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

copy

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 Detail

resourceScanId

DescribeResourceScanResponse.Builder resourceScanId(String resourceScanId)

The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

Parameters:

resourceScanId - The Amazon Resource Name (ARN) of the resource scan. The format is arn:${Partition}:cloudformation:${Region}:${Account}:resourceScan/${Id}. An example is arn:aws:cloudformation:us-east-1:123456789012:resourceScan/f5b490f7-7ed4-428a-aa06-31ff25db0772 .

Returns:

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

status

DescribeResourceScanResponse.Builder status(String status)

Status of the resource scan.

IN_PROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

Parameters:

status - Status of the resource scan.

IN_PROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

Returns:

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

See Also:

ResourceScanStatus, ResourceScanStatus

status

DescribeResourceScanResponse.Builder status(ResourceScanStatus status)

Status of the resource scan.

IN_PROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

Parameters:

status - Status of the resource scan.

IN_PROGRESS

The resource scan is still in progress.

COMPLETE

The resource scan is complete.

EXPIRED

The resource scan has expired.

FAILED

The resource scan has failed.

Returns:

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

See Also:

ResourceScanStatus, ResourceScanStatus

statusReason

DescribeResourceScanResponse.Builder statusReason(String statusReason)

The reason for the resource scan status, providing more information if a failure happened.

Parameters:

statusReason - The reason for the resource scan status, providing more information if a failure happened.

Returns:

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

startTime

DescribeResourceScanResponse.Builder startTime(Instant startTime)

The time that the resource scan was started.

Parameters:

startTime - The time that the resource scan was started.

Returns:

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

endTime

DescribeResourceScanResponse.Builder endTime(Instant endTime)

The time that the resource scan was finished.

Parameters:

endTime - The time that the resource scan was finished.

Returns:

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

percentageCompleted

DescribeResourceScanResponse.Builder percentageCompleted(Double percentageCompleted)

The percentage of the resource scan that has been completed.

Parameters:

percentageCompleted - The percentage of the resource scan that has been completed.

Returns:

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

resourceTypes

DescribeResourceScanResponse.Builder resourceTypes(Collection<String> resourceTypes)

The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

Parameters:

resourceTypes - The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

Returns:

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

resourceTypes

DescribeResourceScanResponse.Builder resourceTypes(String... resourceTypes)

The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

Parameters:

resourceTypes - The list of resource types for the specified scan. Resource types are only available for scans with a Status set to COMPLETE or FAILED .

Returns:

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

resourcesScanned

DescribeResourceScanResponse.Builder resourcesScanned(Integer resourcesScanned)

The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

Parameters:

resourcesScanned - The number of resources that were listed. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED .

Returns:

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

resourcesRead

DescribeResourceScanResponse.Builder resourcesRead(Integer resourcesRead)

The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED.

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException.

Parameters:

resourcesRead - The number of resources that were read. This is only available for scans with a Status set to COMPLETE, EXPIRED, or FAILED.

This field may be 0 if the resource scan failed with a ResourceScanLimitExceededException .

Returns:

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

scanFilters

DescribeResourceScanResponse.Builder scanFilters(Collection<ScanFilter> scanFilters)

The scan filters that were used.

Parameters:

scanFilters - The scan filters that were used.

Returns:

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

scanFilters

DescribeResourceScanResponse.Builder scanFilters(ScanFilter... scanFilters)

The scan filters that were used.

Parameters:

scanFilters - The scan filters that were used.

Returns:

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

scanFilters

DescribeResourceScanResponse.Builder scanFilters(Consumer<ScanFilter.Builder>... scanFilters)

The scan filters that were used.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #scanFilters(List).

Parameters:

scanFilters - a consumer that will call methods on ScanFilter.Builder

Returns:

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

See Also:

#scanFilters(java.util.Collection)