GetIndexResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.resourceexplorer2.model.GetIndexResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetIndexResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetIndexResult()

Constructors
Constructor and Description
`GetIndexResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetIndexResult`	`addTagsEntry(String key, String value)` Add a single Tags entry
`GetIndexResult`	`clearTagsEntries()` Removes all the entries added into Tags.
`GetIndexResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getArn()` The Amazon resource name (ARN) of the index.
`Date`	`getCreatedAt()` The date and time when the index was originally created.
`Date`	`getLastUpdatedAt()` The date and time when the index was last updated.
`List<String>`	`getReplicatingFrom()` This response value is present only if this index is `Type=AGGREGATOR`.
`List<String>`	`getReplicatingTo()` This response value is present only if this index is `Type=LOCAL`.
`String`	`getState()` The current state of the index in this Amazon Web Services Region.
`Map<String,String>`	`getTags()` Tag key and value pairs that are attached to the index.
`String`	`getType()` The type of the index in this Region.
`int`	`hashCode()`
`void`	`setArn(String arn)` The Amazon resource name (ARN) of the index.
`void`	`setCreatedAt(Date createdAt)` The date and time when the index was originally created.
`void`	`setLastUpdatedAt(Date lastUpdatedAt)` The date and time when the index was last updated.
`void`	`setReplicatingFrom(Collection<String> replicatingFrom)` This response value is present only if this index is `Type=AGGREGATOR`.
`void`	`setReplicatingTo(Collection<String> replicatingTo)` This response value is present only if this index is `Type=LOCAL`.
`void`	`setState(String state)` The current state of the index in this Amazon Web Services Region.
`void`	`setTags(Map<String,String> tags)` Tag key and value pairs that are attached to the index.
`void`	`setType(String type)` The type of the index in this Region.
`String`	`toString()` Returns a string representation of this object.
`GetIndexResult`	`withArn(String arn)` The Amazon resource name (ARN) of the index.
`GetIndexResult`	`withCreatedAt(Date createdAt)` The date and time when the index was originally created.
`GetIndexResult`	`withLastUpdatedAt(Date lastUpdatedAt)` The date and time when the index was last updated.
`GetIndexResult`	`withReplicatingFrom(Collection<String> replicatingFrom)` This response value is present only if this index is `Type=AGGREGATOR`.
`GetIndexResult`	`withReplicatingFrom(String... replicatingFrom)` This response value is present only if this index is `Type=AGGREGATOR`.
`GetIndexResult`	`withReplicatingTo(Collection<String> replicatingTo)` This response value is present only if this index is `Type=LOCAL`.
`GetIndexResult`	`withReplicatingTo(String... replicatingTo)` This response value is present only if this index is `Type=LOCAL`.
`GetIndexResult`	`withState(IndexState state)` The current state of the index in this Amazon Web Services Region.
`GetIndexResult`	`withState(String state)` The current state of the index in this Amazon Web Services Region.
`GetIndexResult`	`withTags(Map<String,String> tags)` Tag key and value pairs that are attached to the index.
`GetIndexResult`	`withType(IndexType type)` The type of the index in this Region.
`GetIndexResult`	`withType(String type)` The type of the index in this Region.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetIndexResult
```
public GetIndexResult()
```
- 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 GetIndexResult 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.
  - setCreatedAt
```
public void setCreatedAt(Date createdAt)
```
    The date and time when the index was originally created.
    
    Parameters:
    
    createdAt - The date and time when the index was originally created.
  - getCreatedAt
```
public Date getCreatedAt()
```
    The date and time when the index was originally created.
    
    Returns:
    
    The date and time when the index was originally created.
  - withCreatedAt
```
public GetIndexResult withCreatedAt(Date createdAt)
```
    The date and time when the index was originally created.
    
    Parameters:
    
    createdAt - The date and time when the index was originally created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedAt
```
public void setLastUpdatedAt(Date lastUpdatedAt)
```
    The date and time when the index was last updated.
    
    Parameters:
    
    lastUpdatedAt - The date and time when the index was last updated.
  - getLastUpdatedAt
```
public Date getLastUpdatedAt()
```
    The date and time when the index was last updated.
    
    Returns:
    
    The date and time when the index was last updated.
  - withLastUpdatedAt
```
public GetIndexResult withLastUpdatedAt(Date lastUpdatedAt)
```
    The date and time when the index was last updated.
    
    Parameters:
    
    lastUpdatedAt - The date and time when the index was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReplicatingFrom
```
public List<String> getReplicatingFrom()
```
    This response value is present only if this index is Type=AGGREGATOR.
    
    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
    
    Returns:
    
    This response value is present only if this index is Type=AGGREGATOR.
    
    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
  - setReplicatingFrom
```
public void setReplicatingFrom(Collection<String> replicatingFrom)
```
    This response value is present only if this index is Type=AGGREGATOR.
    
    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
    
    Parameters:
    
    replicatingFrom - This response value is present only if this index is Type=AGGREGATOR.
    
    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
  - withReplicatingFrom
```
public GetIndexResult withReplicatingFrom(String... replicatingFrom)
```
    This response value is present only if this index is Type=AGGREGATOR.
    
    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
    
    NOTE: This method appends the values to the existing list (if any). Use setReplicatingFrom(java.util.Collection) or withReplicatingFrom(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    replicatingFrom - This response value is present only if this index is Type=AGGREGATOR.
    
    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReplicatingFrom
```
public GetIndexResult withReplicatingFrom(Collection<String> replicatingFrom)
```
    This response value is present only if this index is Type=AGGREGATOR.
    
    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
    
    Parameters:
    
    replicatingFrom - This response value is present only if this index is Type=AGGREGATOR.
    
    A list of the Amazon Web Services Regions that replicate their content to the index in this Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getReplicatingTo
```
public List<String> getReplicatingTo()
```
    This response value is present only if this index is Type=LOCAL.
    
    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
    
    Returns:
    
    This response value is present only if this index is Type=LOCAL.
    
    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
  - setReplicatingTo
```
public void setReplicatingTo(Collection<String> replicatingTo)
```
    This response value is present only if this index is Type=LOCAL.
    
    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
    
    Parameters:
    
    replicatingTo - This response value is present only if this index is Type=LOCAL.
    
    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
  - withReplicatingTo
```
public GetIndexResult withReplicatingTo(String... replicatingTo)
```
    This response value is present only if this index is Type=LOCAL.
    
    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
    
    NOTE: This method appends the values to the existing list (if any). Use setReplicatingTo(java.util.Collection) or withReplicatingTo(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    replicatingTo - This response value is present only if this index is Type=LOCAL.
    
    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withReplicatingTo
```
public GetIndexResult withReplicatingTo(Collection<String> replicatingTo)
```
    This response value is present only if this index is Type=LOCAL.
    
    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
    
    Parameters:
    
    replicatingTo - This response value is present only if this index is Type=LOCAL.
    
    The Amazon Web Services Region that contains the aggregator index, if one exists. If an aggregator index does exist then the Region in which you called this operation replicates its index information to the Region specified in this response value.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setState
```
public void setState(String state)
```
    The current state of the index in this Amazon Web Services Region.
    
    Parameters:
    
    state - The current state of the index in this Amazon Web Services Region.
    
    See Also:
    
    IndexState
  - getState
```
public String getState()
```
    The current state of the index in this Amazon Web Services Region.
    
    Returns:
    
    The current state of the index in this Amazon Web Services Region.
    
    See Also:
    
    IndexState
  - withState
```
public GetIndexResult withState(String state)
```
    The current state of the index in this Amazon Web Services Region.
    
    Parameters:
    
    state - The current state of the index in this Amazon Web Services Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexState
  - withState
```
public GetIndexResult withState(IndexState state)
```
    The current state of the index in this Amazon Web Services Region.
    
    Parameters:
    
    state - The current state of the index in this Amazon Web Services Region.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexState
  - getTags
```
public Map<String,String> getTags()
```
    Tag key and value pairs that are attached to the index.
    
    Returns:
    
    Tag key and value pairs that are attached to the index.
  - setTags
```
public void setTags(Map<String,String> tags)
```
    Tag key and value pairs that are attached to the index.
    
    Parameters:
    
    tags - Tag key and value pairs that are attached to the index.
  - withTags
```
public GetIndexResult withTags(Map<String,String> tags)
```
    Tag key and value pairs that are attached to the index.
    
    Parameters:
    
    tags - Tag key and value pairs that are attached to the index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addTagsEntry
```
public GetIndexResult addTagsEntry(String key,
                                   String value)
```
    Add a single Tags entry
    
    See Also:
    
    withTags(java.util.Map<java.lang.String, java.lang.String>)
  - clearTagsEntries
```
public GetIndexResult clearTagsEntries()
```
    Removes all the entries added into Tags.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setType
```
public void setType(String type)
```
    The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
    
    Parameters:
    
    type - The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
    
    See Also:
    
    IndexType
  - getType
```
public String getType()
```
    The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
    
    Returns:
    
    The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
    
    See Also:
    
    IndexType
  - withType
```
public GetIndexResult withType(String type)
```
    The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
    
    Parameters:
    
    type - The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IndexType
  - withType
```
public GetIndexResult withType(IndexType type)
```
    The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
    
    Parameters:
    
    type - The type of the index in this Region. For information about the aggregator index and how it differs from a local index, see Turning on cross-Region search by creating an aggregator index.
    
    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 GetIndexResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetIndexResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetIndexResult

Method Detail

setArn

getArn

withArn

setCreatedAt

getCreatedAt

withCreatedAt

setLastUpdatedAt

getLastUpdatedAt

withLastUpdatedAt

getReplicatingFrom

setReplicatingFrom

withReplicatingFrom

withReplicatingFrom

getReplicatingTo

setReplicatingTo

withReplicatingTo

withReplicatingTo

setState

getState

withState

withState

getTags

setTags

withTags

addTagsEntry

clearTagsEntries

setType

getType

withType

withType

toString

equals

hashCode

clone