software.amazon.awssdk.services.guardduty.model

Class CreateIpSetRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.guardduty.model.GuardDutyRequest

software.amazon.awssdk.services.guardduty.model.CreateIpSetRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateIpSetRequest.Builder,CreateIpSetRequest>

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

CreateIPSet request body.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateIpSetRequest.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	activate() A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.
static CreateIpSetRequest.Builder	builder()
String	clientToken() The idempotency token for the create request.
String	detectorId() The unique ID of the detector that you want to update.
boolean	equals(Object obj)
IpSetFormat	format() The format of the file that contains the IPSet.
String	formatAsString() The format of the file that contains the IPSet.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extends SdkRequest.
int	hashCode()
String	location() The URI of the file that contains the IPSet.
String	name() The user friendly name to identify the IPSet.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateIpSetRequest.Builder>	serializableBuilderClass()
CreateIpSetRequest.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()

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

overrideConfiguration

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

activate

public Boolean activate()

A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

Returns:

A boolean value that indicates whether GuardDuty is to start using the uploaded IPSet.

clientToken

public String clientToken()

The idempotency token for the create request.

Returns:

The idempotency token for the create request.

detectorId

public String detectorId()

The unique ID of the detector that you want to update.

Returns:

The unique ID of the detector that you want to update.

format

public IpSetFormat format()

The format of the file that contains the IPSet.

If the service returns an enum value that is not available in the current SDK version, format will return IpSetFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The format of the file that contains the IPSet.

See Also:

IpSetFormat

formatAsString

public String formatAsString()

The format of the file that contains the IPSet.

If the service returns an enum value that is not available in the current SDK version, format will return IpSetFormat.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from formatAsString().

Returns:

The format of the file that contains the IPSet.

See Also:

IpSetFormat

location

public String location()

The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)

Returns:

The URI of the file that contains the IPSet. For example (https://s3.us-west-2.amazonaws.com/my-bucket/my-object-key)

name

public String name()

The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.

Returns:

The user friendly name to identify the IPSet. This name is displayed in all findings that are triggered by activity that involves IP addresses included in this IPSet.

toBuilder

public CreateIpSetRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIpSetRequest.Builder,CreateIpSetRequest>

Specified by:

toBuilder in class GuardDutyRequest

Returns:

a builder for type T

builder

public static CreateIpSetRequest.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Description copied from class: SdkRequest

Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.

Overrides:

getValueForField in class SdkRequest

Parameters:

fieldName - The name of the member to be retrieved.

clazz - The class to cast the returned object to.

Returns:

Optional containing the casted return value

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

Returns:

List of SdkField in this POJO. May be empty list but should never be null.