Package software.amazon.awssdk.services.synthetics.model

Interface DescribeCanariesResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<DescribeCanariesResponse.Builder,DescribeCanariesResponse>, SdkBuilder<DescribeCanariesResponse.Builder,DescribeCanariesResponse>, SdkPojo, SdkResponse.Builder, SyntheticsResponse.Builder

Enclosing class:

DescribeCanariesResponse

public static interface DescribeCanariesResponse.Builder
extends SyntheticsResponse.Builder, SdkPojo, CopyableBuilder<DescribeCanariesResponse.Builder,DescribeCanariesResponse>

Method Summary

Modifier and Type	Method	Description
DescribeCanariesResponse.Builder	canaries(Collection<Canary> canaries)	Returns an array.
DescribeCanariesResponse.Builder	canaries(Consumer<Canary.Builder>... canaries)	Returns an array.
DescribeCanariesResponse.Builder	canaries(Canary... canaries)	Returns an array.
DescribeCanariesResponse.Builder	nextToken(String nextToken)	A token that indicates that there is more data available.

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, sdkFields

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

sdkHttpResponse, sdkHttpResponse

Methods inherited from interface software.amazon.awssdk.services.synthetics.model.SyntheticsResponse.Builder

build, responseMetadata, responseMetadata

Method Detail

canaries

DescribeCanariesResponse.Builder canaries(Collection<Canary> canaries)

Returns an array. Each item in the array contains the full information about one canary.

Parameters:

canaries - Returns an array. Each item in the array contains the full information about one canary.

Returns:

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

canaries

DescribeCanariesResponse.Builder canaries(Canary... canaries)

Returns an array. Each item in the array contains the full information about one canary.

Parameters:

canaries - Returns an array. Each item in the array contains the full information about one canary.

Returns:

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

canaries

DescribeCanariesResponse.Builder canaries(Consumer<Canary.Builder>... canaries)

Returns an array. Each item in the array contains the full information about one canary.

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

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

Parameters:

canaries - a consumer that will call methods on Canary.Builder

Returns:

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

See Also:

#canaries(java.util.Collection)

nextToken

DescribeCanariesResponse.Builder nextToken(String nextToken)

A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.

Parameters:

nextToken - A token that indicates that there is more data available. You can use this token in a subsequent DescribeCanaries operation to retrieve the next set of results.

Returns:

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