Class ApplicationDetail

java.lang.Object
software.amazon.awssdk.services.kinesisanalytics.model.ApplicationDetail
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<ApplicationDetail.Builder,ApplicationDetail>
@Generated("software.amazon.awssdk:codegen") public final class ApplicationDetail extends Object implements SdkPojo, Serializable, ToCopyableBuilder<ApplicationDetail.Builder,ApplicationDetail>

This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.

Provides a description of the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configuration.

See Also:

  • Method Details

    • applicationName

      public final String applicationName()

      Name of the application.

      Returns:
      Name of the application.

    • applicationDescription

      public final String applicationDescription()

      Description of the application.

      Returns:
      Description of the application.

    • applicationARN

      public final String applicationARN()

      ARN of the application.

      Returns:
      ARN of the application.

    • applicationStatus

      public final ApplicationStatus applicationStatus()

      Status of the application.

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

      Returns:
      Status of the application.
      See Also:

    • applicationStatusAsString

      public final String applicationStatusAsString()

      Status of the application.

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

      Returns:
      Status of the application.
      See Also:

    • createTimestamp

      public final Instant createTimestamp()

      Time stamp when the application version was created.

      Returns:
      Time stamp when the application version was created.

    • lastUpdateTimestamp

      public final Instant lastUpdateTimestamp()

      Time stamp when the application was last updated.

      Returns:
      Time stamp when the application was last updated.

    • hasInputDescriptions

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

    • inputDescriptions

      public final List<InputDescription> inputDescriptions()

      Describes the application input configuration. For more information, see Configuring Application Input.

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

      Returns:
      Describes the application input configuration. For more information, see Configuring Application Input.

    • hasOutputDescriptions

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

    • outputDescriptions

      public final List<OutputDescription> outputDescriptions()

      Describes the application output configuration. For more information, see Configuring Application Output.

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

      Returns:
      Describes the application output configuration. For more information, see Configuring Application Output.

    • hasReferenceDataSourceDescriptions

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

    • referenceDataSourceDescriptions

      public final List<ReferenceDataSourceDescription> referenceDataSourceDescriptions()

      Describes reference data sources configured for the application. For more information, see Configuring Application Input.

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

      Returns:
      Describes reference data sources configured for the application. For more information, see Configuring Application Input.

    • hasCloudWatchLoggingOptionDescriptions

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

    • cloudWatchLoggingOptionDescriptions

      public final List<CloudWatchLoggingOptionDescription> cloudWatchLoggingOptionDescriptions()

      Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

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

      Returns:
      Describes the CloudWatch log streams that are configured to receive application messages. For more information about using CloudWatch log streams with Amazon Kinesis Analytics applications, see Working with Amazon CloudWatch Logs.

    • applicationCode

      public final String applicationCode()

      Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.

      Returns:
      Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.

    • applicationVersionId

      public final Long applicationVersionId()

      Provides the current application version.

      Returns:
      Provides the current application version.

    • toBuilder

      public ApplicationDetail.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<ApplicationDetail.Builder,ApplicationDetail>
      Returns:
      a builder for type T

    • builder

      public static ApplicationDetail.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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

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