Package software.amazon.awssdk.services.kinesisanalyticsv2.model

Class CreateApplicationRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.kinesisanalyticsv2.model.KinesisAnalyticsV2Request
software.amazon.awssdk.services.kinesisanalyticsv2.model.CreateApplicationRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateApplicationRequest extends KinesisAnalyticsV2Request implements ToCopyableBuilder<CreateApplicationRequest.Builder,CreateApplicationRequest>

  • Method Details

    • applicationName

      public final String applicationName()

      The name of your application (for example, sample-app).

      Returns:
      The name of your application (for example, sample-app).

    • applicationDescription

      public final String applicationDescription()

      A summary description of the application.

      Returns:
      A summary description of the application.

    • runtimeEnvironment

      public final RuntimeEnvironment runtimeEnvironment()

      The runtime environment for the application.

      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.
      See Also:

    • runtimeEnvironmentAsString

      public final String runtimeEnvironmentAsString()

      The runtime environment for the application.

      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.
      See Also:

    • serviceExecutionRole

      public final String serviceExecutionRole()

      The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

      Returns:
      The IAM role used by the application to access Kinesis data streams, Kinesis Data Firehose delivery streams, Amazon S3 objects, and other external resources.

    • applicationConfiguration

      public final ApplicationConfiguration applicationConfiguration()

      Use this parameter to configure the application.

      Returns:
      Use this parameter to configure the application.

    • hasCloudWatchLoggingOptions

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

    • cloudWatchLoggingOptions

      public final List<CloudWatchLoggingOption> cloudWatchLoggingOptions()

      Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

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

      Returns:
      Use this parameter to configure an Amazon CloudWatch log stream to monitor application configuration errors.

    • hasTags

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

    • tags

      public final List<Tag> tags()

      A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

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

      Returns:
      A list of one or more tags to assign to the application. A tag is a key-value pair that identifies an application. Note that the maximum number of application tags includes system tags. The maximum number of user-defined application tags is 50. For more information, see Using Tagging.

    • applicationMode

      public final ApplicationMode applicationMode()

      Use the STREAMING mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE mode.

      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:
      Use the STREAMING mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE mode.
      See Also:

    • applicationModeAsString

      public final String applicationModeAsString()

      Use the STREAMING mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE mode.

      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:
      Use the STREAMING mode to create a Managed Service for Apache Flink application. To create a Managed Service for Apache Flink Studio notebook, use the INTERACTIVE mode.
      See Also:

    • toBuilder

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

    • builder

      public static CreateApplicationRequest.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. 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 SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      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.