Class GetCanaryRunsRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.synthetics.model.SyntheticsRequest
software.amazon.awssdk.services.synthetics.model.GetCanaryRunsRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetCanaryRunsRequest.Builder,GetCanaryRunsRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetCanaryRunsRequest extends SyntheticsRequest implements ToCopyableBuilder<GetCanaryRunsRequest.Builder,GetCanaryRunsRequest>

  • Method Details

    • name

      public final String name()

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

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

    • nextToken

      public final 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.

      Returns:
      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.

    • maxResults

      public final 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.

      Returns:
      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.

    • dryRunId

      public final String dryRunId()

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

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

    • runType

      public final 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

      If the service returns an enum value that is not available in the current SDK version, runType will return RunType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runTypeAsString().

      Returns:

    • 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

      • See Also:

    • runTypeAsString

      public final String runTypeAsString()

      • 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

      If the service returns an enum value that is not available in the current SDK version, runType will return RunType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from runTypeAsString().

      Returns:

    • 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

      • See Also:

    • toBuilder

      public GetCanaryRunsRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetCanaryRunsRequest.Builder,GetCanaryRunsRequest>
      Specified by:
      toBuilder in class SyntheticsRequest
      Returns:
      a builder for type T

    • builder

      public static GetCanaryRunsRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetCanaryRunsRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.