Package software.amazon.awssdk.services.networkflowmonitor.model

Class CreateScopeRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.networkflowmonitor.model.NetworkFlowMonitorRequest

software.amazon.awssdk.services.networkflowmonitor.model.CreateScopeRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateScopeRequest.Builder,CreateScopeRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateScopeRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateScopeRequest.Builder	builder()
String	clientToken()	A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<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.
boolean	hasTargets()	For responses, this returns true if the service returned a value for the Targets property.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateScopeRequest.Builder>	serializableBuilderClass()
Map<String,String>	tags()	The tags for a scope.
List<TargetResource>	targets()	The targets to define the scope to be monitored.
CreateScopeRequest.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

hasTargets

public final boolean hasTargets()

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

targets

public final List<TargetResource> targets()

The targets to define the scope to be monitored. Currently, a target is an Amazon Web Services account.

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

Returns:

The targets to define the scope to be monitored. Currently, a target is an Amazon Web Services account.

clientToken

public final String clientToken()

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.

Returns:

A unique, case-sensitive string of up to 64 ASCII characters that you specify to make an idempotent API request. Don't reuse the same client token for other API requests.

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 for a scope. You can add a maximum of 200 tags.

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 for a scope. You can add a maximum of 200 tags.

toBuilder

public CreateScopeRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateScopeRequest.Builder,CreateScopeRequest>

Specified by:

toBuilder in class NetworkFlowMonitorRequest

builder

public static CreateScopeRequest.Builder builder()

serializableBuilderClass

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

sdkFieldNameToField

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

Specified by:

sdkFieldNameToField in interface SdkPojo