software.amazon.awssdk.services.shield.model

Class ListAttacksRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.shield.model.ShieldRequest

software.amazon.awssdk.services.shield.model.ListAttacksRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ListAttacksRequest.Builder,ListAttacksRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ListAttacksRequest.Builder

Method Summary

Modifier and Type	Method and Description
static ListAttacksRequest.Builder	builder()
TimeRange	endTime() The end of the time period for the attacks.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceArns() Returns true if the ResourceArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
Integer	maxResults() The maximum number of AttackSummary objects to return.
String	nextToken() The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest.
List<String>	resourceArns() The ARN (Amazon Resource Name) of the resource that was attacked.
List<SdkField<?>>	sdkFields()
static Class<? extends ListAttacksRequest.Builder>	serializableBuilderClass()
TimeRange	startTime() The start of the time period for the attacks.
ListAttacksRequest.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

hasResourceArns

public final boolean hasResourceArns()

Returns true if the ResourceArns property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

resourceArns

public final List<String> resourceArns()

The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.

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

You can use hasResourceArns() to see if a value was sent in this field.

Returns:

The ARN (Amazon Resource Name) of the resource that was attacked. If this is left blank, all applicable resources for this account will be included.

startTime

public final TimeRange startTime()

The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

Returns:

The start of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

endTime

public final TimeRange endTime()

The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

Returns:

The end of the time period for the attacks. This is a timestamp type. The sample request above indicates a number type because the default used by WAF is Unix time in seconds. However any valid timestamp format is allowed.

nextToken

public final String nextToken()

The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

Returns:

The ListAttacksRequest.NextMarker value from a previous call to ListAttacksRequest. Pass null if this is the first call.

maxResults

public final Integer maxResults()

The maximum number of AttackSummary objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

Returns:

The maximum number of AttackSummary objects to return. If you leave this blank, Shield Advanced returns the first 20 results.

This is a maximum value. Shield Advanced might return the results in smaller batches. That is, the number of objects returned could be less than MaxResults, even if there are still more objects yet to return. If there are more objects to return, Shield Advanced returns a value in NextToken that you can use in your next request, to get the next batch of objects.

toBuilder

public ListAttacksRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ListAttacksRequest.Builder,ListAttacksRequest>

Specified by:

toBuilder in class ShieldRequest

builder

public static ListAttacksRequest.Builder builder()

serializableBuilderClass

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