Class GetApplicationResponse

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

  • Method Details

    • id

      public final String id()

      The unique identifier of the OpenSearch application.

      Returns:
      The unique identifier of the OpenSearch application.

    • arn

      public final String arn()
      Returns the value of the Arn property for this object.
      Returns:
      The value of the Arn property for this object.

    • name

      public final String name()

      The name of the OpenSearch application.

      Returns:
      The name of the OpenSearch application.

    • endpoint

      public final String endpoint()

      The endpoint URL of the OpenSearch application.

      Returns:
      The endpoint URL of the OpenSearch application.

    • status

      public final ApplicationStatus status()

      The current status of the OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

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

      Returns:
      The current status of the OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.

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

      Returns:
      The current status of the OpenSearch application. Possible values: CREATING, UPDATING, DELETING, FAILED, ACTIVE, and DELETED.
      See Also:

    • iamIdentityCenterOptions

      public final IamIdentityCenterOptions iamIdentityCenterOptions()

      The IAM Identity Center settings configured for the OpenSearch application.

      Returns:
      The IAM Identity Center settings configured for the OpenSearch application.

    • hasDataSources

      public final boolean hasDataSources()
      For responses, this returns true if the service returned a value for the DataSources 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.

    • dataSources

      public final List<DataSource> dataSources()

      The data sources associated with the OpenSearch application.

      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 hasDataSources() method.

      Returns:
      The data sources associated with the OpenSearch application.

    • hasAppConfigs

      public final boolean hasAppConfigs()
      For responses, this returns true if the service returned a value for the AppConfigs 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.

    • appConfigs

      public final List<AppConfig> appConfigs()

      The configuration settings of the OpenSearch application.

      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 hasAppConfigs() method.

      Returns:
      The configuration settings of the OpenSearch application.

    • createdAt

      public final Instant createdAt()

      The timestamp when the OpenSearch application was created.

      Returns:
      The timestamp when the OpenSearch application was created.

    • lastUpdatedAt

      public final Instant lastUpdatedAt()

      The timestamp of the last update to the OpenSearch application.

      Returns:
      The timestamp of the last update to the OpenSearch application.

    • toBuilder

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

    • builder

      public static GetApplicationResponse.Builder builder()

    • serializableBuilderClass

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