software.amazon.awssdk.services.synthetics.model

Class DescribeCanariesResponse

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCanariesResponse.Builder,DescribeCanariesResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DescribeCanariesResponse.Builder

Method Summary

Modifier and Type	Method and Description
static DescribeCanariesResponse.Builder	builder()
List<Canary>	canaries() Returns an array.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCanaries() For responses, this returns true if the service returned a value for the Canaries property.
int	hashCode()
String	nextToken() A token that indicates that there is more data available.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCanariesResponse.Builder>	serializableBuilderClass()
DescribeCanariesResponse.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

hasCanaries

public final boolean hasCanaries()

For responses, this returns true if the service returned a value for the Canaries 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.

canaries

public final List<Canary> canaries()

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

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 hasCanaries() method.

Returns:

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

nextToken

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

Returns:

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.

toBuilder

public DescribeCanariesResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCanariesResponse.Builder,DescribeCanariesResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static DescribeCanariesResponse.Builder builder()

serializableBuilderClass

public static Class<? extends DescribeCanariesResponse.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