Package 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("software.amazon.awssdk:codegen")
public final class CreateIpSetRequest
extends GuardDutyRequest
implements ToCopyableBuilder<CreateIpSetRequest.Builder,CreateIpSetRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateIpSetRequest.Builder

Method Summary

Modifier and Type	Method	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 of the GuardDuty account that you want to create an IPSet for.
boolean	equals(Object obj)
boolean	equalsBySdkFields(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)
int	hashCode()
boolean	hasTags()	For responses, this returns true if the service returned a value for the Tags property.
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()
Map<String,String>	tags()	The tags to be added to a new IP set resource.
CreateIpSetRequest.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

detectorId

public final String detectorId()

The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

Returns:

The unique ID of the detector of the GuardDuty account that you want to create an IPSet for.

name

public final String name()

The user-friendly name to identify the IPSet.

Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

Returns:

The user-friendly name to identify the IPSet.

Allowed characters are alphanumeric, whitespace, dash (-), and underscores (_).

format

public final 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 final 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 final String location()

The URI of the file that contains the IPSet.

Returns:

The URI of the file that contains the IPSet.

activate

public final 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 final String clientToken()

The idempotency token for the create request.

Returns:

The idempotency token for the create request.

hasTags

public final boolean hasTags()

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

tags

public final Map<String,String> tags()

The tags to be added to a new IP set resource.

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

Returns:

The tags to be added to a new IP set resource.

toBuilder

public CreateIpSetRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateIpSetRequest.Builder,CreateIpSetRequest>

Specified by:

toBuilder in class GuardDutyRequest

builder

public static CreateIpSetRequest.Builder builder()

serializableBuilderClass

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