Class GetIndexResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.resourceexplorer2.model.ResourceExplorer2Response
software.amazon.awssdk.services.resourceexplorer2.model.GetIndexResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetIndexResponse.Builder,GetIndexResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetIndexResponse extends ResourceExplorer2Response implements ToCopyableBuilder<GetIndexResponse.Builder,GetIndexResponse>

  • Method Details

    • arn

      public final String arn()

      The Amazon resource name (ARN) of the index.

      Returns:
      The Amazon resource name (ARN) of the index.

    • createdAt

      public final Instant createdAt()

      The date and time when the index was originally created.

      Returns:
      The date and time when the index was originally created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The date and time when the index was last updated.

      Returns:
      The date and time when the index was last updated.

    • hasReplicatingFrom

      public final boolean hasReplicatingFrom()
      For responses, this returns true if the service returned a value for the ReplicatingFrom property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • replicatingFrom

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplicatingFrom() method.

      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.

    • hasReplicatingTo

      public final boolean hasReplicatingTo()
      For responses, this returns true if the service returned a value for the ReplicatingTo property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • replicatingTo

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReplicatingTo() method.

      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.

    • state

      public final IndexState state()

      The current state of the index in this Amazon Web Services Region.

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

      Returns:
      The current state of the index in this Amazon Web Services Region.
      See Also:

    • stateAsString

      public final String stateAsString()

      The current state of the index in this Amazon Web Services Region.

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

      Returns:
      The current state of the index in this Amazon Web Services Region.
      See Also:

    • hasTags

      public final boolean hasTags()
      For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • tags

      public final Map<String,String> tags()

      Tag key and value pairs that are attached to the index.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

      Returns:
      Tag key and value pairs that are attached to the index.

    • type

      public final 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.

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

    • typeAsString

      public final String typeAsString()

      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.

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

    • toBuilder

      public GetIndexResponse.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<GetIndexResponse.Builder,GetIndexResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetIndexResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.