Interface DescribeCanariesResponse.Builder

All Superinterfaces:
AwsResponse.Builder, Buildable, CopyableBuilder<DescribeCanariesResponse.Builder,DescribeCanariesResponse>, SdkBuilder<DescribeCanariesResponse.Builder,DescribeCanariesResponse>, SdkPojo, SdkResponse.Builder, SyntheticsResponse.Builder
Enclosing class:
DescribeCanariesResponse
@Mutable @NotThreadSafe public static interface DescribeCanariesResponse.Builder extends SyntheticsResponse.Builder, SdkPojo, CopyableBuilder<DescribeCanariesResponse.Builder,DescribeCanariesResponse>

  • Method Details

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

      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:

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