Package software.amazon.awssdk.services.opensearch.model

Class GetApplicationResponse

    • Method Detail

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

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

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

      • 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