Interface GetCanaryRunsRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<GetCanaryRunsRequest.Builder,GetCanaryRunsRequest>, SdkBuilder<GetCanaryRunsRequest.Builder,GetCanaryRunsRequest>, SdkPojo, SdkRequest.Builder, SyntheticsRequest.Builder
Enclosing class:
GetCanaryRunsRequest
@Mutable @NotThreadSafe public static interface GetCanaryRunsRequest.Builder extends SyntheticsRequest.Builder, SdkPojo, CopyableBuilder<GetCanaryRunsRequest.Builder,GetCanaryRunsRequest>

  • Method Details

    • name

      GetCanaryRunsRequest.Builder name(String name)

      The name of the canary that you want to see runs for.

      Parameters:
      name - The name of the canary that you want to see runs for.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • nextToken

      GetCanaryRunsRequest.Builder nextToken(String nextToken)

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

      When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.

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

      When auto retry is enabled for the canary, the first subsequent retry is suffixed with *1 indicating its the first retry and the next subsequent try is suffixed with *2.

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

    • maxResults

      GetCanaryRunsRequest.Builder maxResults(Integer maxResults)

      Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.

      Parameters:
      maxResults - Specify this parameter to limit how many runs are returned each time you use the GetCanaryRuns operation. If you omit this parameter, the default of 100 is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dryRunId

      GetCanaryRunsRequest.Builder dryRunId(String dryRunId)

      The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.

      Parameters:
      dryRunId - The DryRunId associated with an existing canary’s dry run. You can use this DryRunId to retrieve information about the dry run.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • runType

      GetCanaryRunsRequest.Builder runType(String runType)

      • When you provide RunType=CANARY_RUN and dryRunId, you will get an exception

      • When a value is not provided for RunType, the default value is CANARY_RUN

      • When CANARY_RUN is provided, all canary runs excluding dry runs are returned

      • When DRY_RUN is provided, all dry runs excluding canary runs are returned

      Parameters:
      runType -

    • When you provide RunType=CANARY_RUN and dryRunId, you will get an exception

    • When a value is not provided for RunType, the default value is CANARY_RUN

    • When CANARY_RUN is provided, all canary runs excluding dry runs are returned

    • When DRY_RUN is provided, all dry runs excluding canary runs are returned

      • Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • runType

      GetCanaryRunsRequest.Builder runType(RunType runType)

      • When you provide RunType=CANARY_RUN and dryRunId, you will get an exception

      • When a value is not provided for RunType, the default value is CANARY_RUN

      • When CANARY_RUN is provided, all canary runs excluding dry runs are returned

      • When DRY_RUN is provided, all dry runs excluding canary runs are returned

      Parameters:
      runType -

    • When you provide RunType=CANARY_RUN and dryRunId, you will get an exception

    • When a value is not provided for RunType, the default value is CANARY_RUN

    • When CANARY_RUN is provided, all canary runs excluding dry runs are returned

    • When DRY_RUN is provided, all dry runs excluding canary runs are returned

      • Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      GetCanaryRunsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      GetCanaryRunsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.