Package software.amazon.awssdk.services.resourceexplorer2.model

Class MemberIndex

java.lang.Object

software.amazon.awssdk.services.resourceexplorer2.model.MemberIndex

All Implemented Interfaces:

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

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

An index is the data store used by Amazon Web Services Resource Explorer to hold information about your Amazon Web Services resources that the service discovers.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MemberIndex.Builder

Method Summary

Modifier and Type	Method	Description
String	accountId()	The account ID for the index.
String	arn()	The Amazon resource name (ARN) of the index.
static MemberIndex.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	region()	The Amazon Web Services Region in which the index exists.
List<SdkField<?>>	sdkFields()
static Class<? extends MemberIndex.Builder>	serializableBuilderClass()
MemberIndex.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
IndexType	type()	The type of index.
String	typeAsString()	The type of index.

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

accountId

public final String accountId()

The account ID for the index.

Returns:

The account ID for the index.

arn

public final String arn()

The Amazon resource name (ARN) of the index.

Returns:

The Amazon resource name (ARN) of the index.

region

public final String region()

The Amazon Web Services Region in which the index exists.

Returns:

The Amazon Web Services Region in which the index exists.

type

public final IndexType type()

The type of index. It can be one of the following values:

• LOCAL – The index contains information about resources from only the same Amazon Web Services Region.

• AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.

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

Returns:

The type of index. It can be one of the following values:

• LOCAL – The index contains information about resources from only the same Amazon Web Services Region.

• AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.

See Also:

IndexType

typeAsString

public final String typeAsString()

The type of index. It can be one of the following values:

• LOCAL – The index contains information about resources from only the same Amazon Web Services Region.

• AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.

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

Returns:

The type of index. It can be one of the following values:

• LOCAL – The index contains information about resources from only the same Amazon Web Services Region.

• AGGREGATOR – Resource Explorer replicates copies of the indexed information about resources in all other Amazon Web Services Regions to the aggregator index. This lets search results in the Region with the aggregator index to include resources from all Regions in the account where Resource Explorer is turned on.

See Also:

IndexType

toBuilder

public MemberIndex.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MemberIndex.Builder,MemberIndex>

builder

public static MemberIndex.Builder builder()

serializableBuilderClass

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