software.amazon.awssdk.services.synthetics.model

Class GetCanaryRunsResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.synthetics.model.SyntheticsResponse

software.amazon.awssdk.services.synthetics.model.GetCanaryRunsResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetCanaryRunsResponse.Builder,GetCanaryRunsResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class GetCanaryRunsResponse
extends SyntheticsResponse
implements ToCopyableBuilder<GetCanaryRunsResponse.Builder,GetCanaryRunsResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	GetCanaryRunsResponse.Builder

Method Summary

Modifier and Type	Method and Description
static GetCanaryRunsResponse.Builder	builder()
List<CanaryRun>	canaryRuns() An array of structures.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCanaryRuns() For responses, this returns true if the service returned a value for the CanaryRuns property.
int	hashCode()
String	nextToken() A token that indicates that there is more data available.
List<SdkField<?>>	sdkFields()
static Class<? extends GetCanaryRunsResponse.Builder>	serializableBuilderClass()
GetCanaryRunsResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.synthetics.model.SyntheticsResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

hasCanaryRuns

public final boolean hasCanaryRuns()

For responses, this returns true if the service returned a value for the CanaryRuns property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

canaryRuns

public final List<CanaryRun> canaryRuns()

An array of structures. Each structure contains the details of one of the retrieved canary runs.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCanaryRuns() method.

Returns:

An array of structures. Each structure contains the details of one of the retrieved canary runs.

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.

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.

toBuilder

public GetCanaryRunsResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetCanaryRunsResponse.Builder,GetCanaryRunsResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static GetCanaryRunsResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo