Class Index

java.lang.Object
software.amazon.awssdk.services.resourceexplorer2.model.Index
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<Index.Builder,Index>
@Generated("software.amazon.awssdk:codegen") public final class Index extends Object implements SdkPojo, Serializable, ToCopyableBuilder<Index.Builder,Index>

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. Creating an index in an Amazon Web Services Region turns on Resource Explorer and lets it discover your resources.

By default, an index is local, meaning that it contains information about resources in only the same Region as the index. However, you can promote the index of one Region in the account by calling UpdateIndexType to convert it into an aggregator index. The aggregator index receives a replicated copy of the index information from all other Regions where Resource Explorer is turned on. This allows search operations in that Region to return results from all Regions in the account.

See Also:

  • Method Details

    • 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:

    • 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:

    • toBuilder

      public Index.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<Index.Builder,Index>
      Returns:
      a builder for type T

    • builder

      public static Index.Builder builder()

    • serializableBuilderClass

      public static Class<? extends Index.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.