Index (AWS Java SDK for AWS Resource Explorer 1.12.344 API)

java.lang.Object
- com.amazonaws.services.resourceexplorer2.model.Index

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Index
extends Object
implements Serializable, Cloneable, StructuredPojo
```
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:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Index()

Constructors
Constructor and Description
`Index()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Index`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon resource name (ARN) of the index.
`String`	`getRegion()` The Amazon Web Services Region in which the index exists.
`String`	`getType()` The type of index.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`void`	`setArn(String arn)` The Amazon resource name (ARN) of the index.
`void`	`setRegion(String region)` The Amazon Web Services Region in which the index exists.
`void`	`setType(String type)` The type of index.
`String`	`toString()` Returns a string representation of this object.
`Index`	`withArn(String arn)` The Amazon resource name (ARN) of the index.
`Index`	`withRegion(String region)` The Amazon Web Services Region in which the index exists.
`Index`	`withType(IndexType type)` The type of index.
`Index`	`withType(String type)` The type of index.

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Index
```
public Index()
```
- Method Detail
  - setArn
```
public void setArn(String arn)
```
    The Amazon resource name (ARN) of the index.
    
    Parameters:
    
    arn - The Amazon resource name (ARN) of the index.
  - getArn
```
public String getArn()
```
    The Amazon resource name (ARN) of the index.
    
    Returns:
    
    The Amazon resource name (ARN) of the index.
  - withArn
```
public Index withArn(String arn)
```
    The Amazon resource name (ARN) of the index.
    
    Parameters:
    
    arn - The Amazon resource name (ARN) of the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setRegion
```
public void setRegion(String region)
```
    The Amazon Web Services Region in which the index exists.
    
    Parameters:
    
    region - The Amazon Web Services Region in which the index exists.
  - getRegion
```
public String getRegion()
```
    The Amazon Web Services Region in which the index exists.
    
    Returns:
    
    The Amazon Web Services Region in which the index exists.
  - withRegion
```
public Index withRegion(String region)
```
    The Amazon Web Services Region in which the index exists.
    
    Parameters:
    
    region - The Amazon Web Services Region in which the index exists.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String 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.
    Parameters:
    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.
    See Also:
    
    IndexType
  - getType
```
public String getType()
```
    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.
    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
  - withType
```
public Index withType(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexType
  - withType
```
public Index withType(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexType
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public Index clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Index

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Index

Method Detail

setArn

getArn

withArn

setRegion

getRegion

withRegion

setType

getType

withType

withType

toString

equals

hashCode

clone

marshall