Package software.amazon.awssdk.services.synthetics.model

Class DescribeCanariesRequest

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

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<DescribeCanariesRequest.Builder,DescribeCanariesRequest>

@Generated("software.amazon.awssdk:codegen")
public final class DescribeCanariesRequest
extends SyntheticsRequest
implements ToCopyableBuilder<DescribeCanariesRequest.Builder,DescribeCanariesRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DescribeCanariesRequest.Builder

Method Summary

Modifier and Type	Method	Description
static DescribeCanariesRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasNames()	For responses, this returns true if the service returned a value for the Names property.
Integer	maxResults()	Specify this parameter to limit how many canaries are returned each time you use the DescribeCanaries operation.
List<String>	names()	Use this parameter to return only canaries that match the names that you specify here.
String	nextToken()	A token that indicates that there is more data available.
List<SdkField<?>>	sdkFields()
static Class<? extends DescribeCanariesRequest.Builder>	serializableBuilderClass()
DescribeCanariesRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

nextToken

public final String nextToken()

A token that indicates that there is more data available. You can use this token in a subsequent 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 operation to retrieve the next set of results.

maxResults

public final Integer maxResults()

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

Returns:

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

hasNames

public final boolean hasNames()

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

names

public final List<String> names()

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

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

Returns:

Use this parameter to return only canaries that match the names that you specify here. You can specify as many as five canary names.

If you specify this parameter, the operation is successful only if you have authorization to view all the canaries that you specify in your request. If you do not have permission to view any of the canaries, the request fails with a 403 response.

You are required to use this parameter if you are logged on to a user or role that has an IAM policy that restricts which canaries that you are allowed to view. For more information, see Limiting a user to viewing specific canaries.

toBuilder

public DescribeCanariesRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DescribeCanariesRequest.Builder,DescribeCanariesRequest>

Specified by:

toBuilder in class SyntheticsRequest

builder

public static DescribeCanariesRequest.Builder builder()

serializableBuilderClass

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

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo