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

Class ScopeSummary

java.lang.Object

software.amazon.awssdk.services.networkflowmonitor.model.ScopeSummary

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ScopeSummary.Builder,ScopeSummary>

@Generated("software.amazon.awssdk:codegen")
public final class ScopeSummary
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ScopeSummary.Builder,ScopeSummary>

A summary of information about a scope, including the ARN, target ID, and Amazon Web Services Region.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ScopeSummary.Builder

Method Summary

Modifier and Type	Method	Description
static ScopeSummary.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	scopeArn()	The Amazon Resource Name (ARN) of the scope.
String	scopeId()	The identifier for the scope that includes the resources you want to get data results for.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends ScopeSummary.Builder>	serializableBuilderClass()
ScopeStatus	status()	The status of a scope.
String	statusAsString()	The status of a scope.
ScopeSummary.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

scopeId

public final String scopeId()

The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

Returns:

The identifier for the scope that includes the resources you want to get data results for. A scope ID is an internally-generated identifier that includes all the resources for a specific root account.

status

public final ScopeStatus status()

The status of a scope. The status can be one of the following, depending on the state of scope creation: SUCCEEDED, IN_PROGRESS, or FAILED.

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

Returns:

The status of a scope. The status can be one of the following, depending on the state of scope creation: SUCCEEDED, IN_PROGRESS, or FAILED.

See Also:

ScopeStatus

statusAsString

public final String statusAsString()

The status of a scope. The status can be one of the following, depending on the state of scope creation: SUCCEEDED, IN_PROGRESS, or FAILED.

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

Returns:

The status of a scope. The status can be one of the following, depending on the state of scope creation: SUCCEEDED, IN_PROGRESS, or FAILED.

See Also:

ScopeStatus

scopeArn

public final String scopeArn()

The Amazon Resource Name (ARN) of the scope.

Returns:

The Amazon Resource Name (ARN) of the scope.

toBuilder

public ScopeSummary.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ScopeSummary.Builder,ScopeSummary>

builder

public static ScopeSummary.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

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