software.amazon.awssdk.services.kinesisanalyticsv2.model

Class ApplicationDetail

java.lang.Object

software.amazon.awssdk.services.kinesisanalyticsv2.model.ApplicationDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<ApplicationDetail.Builder,ApplicationDetail>

@Generated(value="software.amazon.awssdk:codegen")
public final class ApplicationDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<ApplicationDetail.Builder,ApplicationDetail>

Describes the application, including the application Amazon Resource Name (ARN), status, latest version, and input and output configurations.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ApplicationDetail.Builder

Method Summary

Modifier and Type	Method and Description
String	applicationARN() The ARN of the application.
ApplicationConfigurationDescription	applicationConfigurationDescription() Describes details about the application code and starting parameters for a Kinesis Data Analytics application.
String	applicationDescription() The description of the application.
ApplicationMaintenanceConfigurationDescription	applicationMaintenanceConfigurationDescription() The details of the maintenance configuration for the application.
ApplicationMode	applicationMode() To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE.
String	applicationModeAsString() To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE.
String	applicationName() The name of the application.
ApplicationStatus	applicationStatus() The status of the application.
String	applicationStatusAsString() The status of the application.
Long	applicationVersionId() Provides the current application version.
Long	applicationVersionRolledBackFrom() If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.
Long	applicationVersionRolledBackTo() The version to which you want to roll back the application.
Long	applicationVersionUpdatedFrom() The previous application version before the latest application update.
static ApplicationDetail.Builder	builder()
List<CloudWatchLoggingOptionDescription>	cloudWatchLoggingOptionDescriptions() Describes the application Amazon CloudWatch logging options.
String	conditionalToken() A value you use to implement strong concurrency for application updates.
Instant	createTimestamp() The current timestamp when the application was created.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCloudWatchLoggingOptionDescriptions() For responses, this returns true if the service returned a value for the CloudWatchLoggingOptionDescriptions property.
int	hashCode()
Instant	lastUpdateTimestamp() The current timestamp when the application was last updated.
RuntimeEnvironment	runtimeEnvironment() The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8 , or FLINK-1_11).
String	runtimeEnvironmentAsString() The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8 , or FLINK-1_11).
List<SdkField<?>>	sdkFields()
static Class<? extends ApplicationDetail.Builder>	serializableBuilderClass()
String	serviceExecutionRole() Specifies the IAM role that the application uses to access external resources.
ApplicationDetail.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

applicationARN

public final String applicationARN()

The ARN of the application.

Returns:

The ARN of the application.

applicationDescription

public final String applicationDescription()

The description of the application.

Returns:

The description of the application.

applicationName

public final String applicationName()

The name of the application.

Returns:

The name of the application.

runtimeEnvironment

public final RuntimeEnvironment runtimeEnvironment()

The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8 , or FLINK-1_11).

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

Returns:

The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

See Also:

RuntimeEnvironment

runtimeEnvironmentAsString

public final String runtimeEnvironmentAsString()

The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8 , or FLINK-1_11).

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

Returns:

The runtime environment for the application (SQL-1_0, FLINK-1_6, FLINK-1_8, or FLINK-1_11).

See Also:

RuntimeEnvironment

serviceExecutionRole

public final String serviceExecutionRole()

Specifies the IAM role that the application uses to access external resources.

Returns:

Specifies the IAM role that the application uses to access external resources.

applicationStatus

public final ApplicationStatus applicationStatus()

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

The status of the application.

See Also:

ApplicationStatus

applicationStatusAsString

public final String applicationStatusAsString()

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

The status of the application.

See Also:

ApplicationStatus

applicationVersionId

public final Long applicationVersionId()

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

Returns:

Provides the current application version. Kinesis Data Analytics updates the ApplicationVersionId each time you update the application.

createTimestamp

public final Instant createTimestamp()

The current timestamp when the application was created.

Returns:

The current timestamp when the application was created.

lastUpdateTimestamp

public final Instant lastUpdateTimestamp()

The current timestamp when the application was last updated.

Returns:

The current timestamp when the application was last updated.

applicationConfigurationDescription

public final ApplicationConfigurationDescription applicationConfigurationDescription()

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

Returns:

Describes details about the application code and starting parameters for a Kinesis Data Analytics application.

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 application Amazon CloudWatch logging options.

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 application Amazon CloudWatch logging options.

applicationMaintenanceConfigurationDescription

public final ApplicationMaintenanceConfigurationDescription applicationMaintenanceConfigurationDescription()

The details of the maintenance configuration for the application.

Returns:

The details of the maintenance configuration for the application.

applicationVersionUpdatedFrom

public final Long applicationVersionUpdatedFrom()

The previous application version before the latest application update. RollbackApplication reverts the application to this version.

Returns:

The previous application version before the latest application update. RollbackApplication reverts the application to this version.

applicationVersionRolledBackFrom

public final Long applicationVersionRolledBackFrom()

If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

Returns:

If you reverted the application using RollbackApplication, the application version when RollbackApplication was called.

conditionalToken

public final String conditionalToken()

A value you use to implement strong concurrency for application updates.

Returns:

A value you use to implement strong concurrency for application updates.

applicationVersionRolledBackTo

public final Long applicationVersionRolledBackTo()

The version to which you want to roll back the application.

Returns:

The version to which you want to roll back the application.

applicationMode

public final ApplicationMode applicationMode()

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

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

Returns:

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

See Also:

ApplicationMode

applicationModeAsString

public final String applicationModeAsString()

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

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

Returns:

To create a Kinesis Data Analytics Studio notebook, you must set the mode to INTERACTIVE. However, for a Kinesis Data Analytics for Apache Flink application, the mode is optional.

See Also:

ApplicationMode

toBuilder

public ApplicationDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ApplicationDetail.Builder,ApplicationDetail>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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