Class ApplicationDetail
- All Implemented Interfaces:
Serializable
,SdkPojo
,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:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal String
ARN of the application.final String
Returns the application code that you provided to perform data analysis on any of the in-application streams in your application.final String
Description of the application.final String
Name of the application.final ApplicationStatus
Status of the application.final String
Status of the application.final Long
Provides the current application version.static ApplicationDetail.Builder
builder()
Describes the CloudWatch log streams that are configured to receive application messages.final Instant
Time stamp when the application version was created.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the CloudWatchLoggingOptionDescriptions property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the InputDescriptions property.final boolean
For responses, this returns true if the service returned a value for the OutputDescriptions property.final boolean
For responses, this returns true if the service returned a value for the ReferenceDataSourceDescriptions property.final List
<InputDescription> Describes the application input configuration.final Instant
Time stamp when the application was last updated.final List
<OutputDescription> Describes the application output configuration.Describes reference data sources configured for the application.static Class
<? extends ApplicationDetail.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
applicationName
Name of the application.
- Returns:
- Name of the application.
-
applicationDescription
Description of the application.
- Returns:
- Description of the application.
-
applicationARN
ARN of the application.
- Returns:
- ARN of the application.
-
applicationStatus
Status of the application.
If the service returns an enum value that is not available in the current SDK version,
applicationStatus
will returnApplicationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapplicationStatusAsString()
.- Returns:
- Status of the application.
- See Also:
-
applicationStatusAsString
Status of the application.
If the service returns an enum value that is not available in the current SDK version,
applicationStatus
will returnApplicationStatus.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available fromapplicationStatusAsString()
.- Returns:
- Status of the application.
- See Also:
-
createTimestamp
Time stamp when the application version was created.
- Returns:
- Time stamp when the application version was created.
-
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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 theisEmpty()
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
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
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
Provides the current application version.
- Returns:
- Provides the current application version.
-
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 interfaceToCopyableBuilder<ApplicationDetail.Builder,
ApplicationDetail> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
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 anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-