Package software.amazon.awssdk.services.wafv2.model

Class ListApiKeysResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.wafv2.model.Wafv2Response

software.amazon.awssdk.services.wafv2.model.ListApiKeysResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListApiKeysResponse.Builder,ListApiKeysResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ListApiKeysResponse.Builder

Method Summary

Modifier and Type	Method	Description
List<APIKeySummary>	apiKeySummaries()	The array of key summaries.
String	applicationIntegrationURL()	The CAPTCHA application integration URL, for use in your JavaScript implementation.
static ListApiKeysResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasApiKeySummaries()	For responses, this returns true if the service returned a value for the APIKeySummaries property.
int	hashCode()
String	nextMarker()	When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ListApiKeysResponse.Builder>	serializableBuilderClass()
ListApiKeysResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.wafv2.model.Wafv2Response

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

nextMarker

public final String nextMarker()

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

Returns:

When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

hasApiKeySummaries

public final boolean hasApiKeySummaries()

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

apiKeySummaries

public final List<APIKeySummary> apiKeySummaries()

The array of key summaries. If you specified a Limit in your request, this might not be the full list.

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

Returns:

The array of key summaries. If you specified a Limit in your request, this might not be the full list.

applicationIntegrationURL

public final String applicationIntegrationURL()

The CAPTCHA application integration URL, for use in your JavaScript implementation.

Returns:

The CAPTCHA application integration URL, for use in your JavaScript implementation.

toBuilder

public ListApiKeysResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListApiKeysResponse.Builder,ListApiKeysResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static ListApiKeysResponse.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo