Class RegisterApplicationRequest

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

  • Method Details

    • applicationId

      public final String applicationId()

      The ID of the application.

      Returns:
      The ID of the application.

    • applicationType

      public final ApplicationType applicationType()

      The type of the application.

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

      Returns:
      The type of the application.
      See Also:

    • applicationTypeAsString

      public final String applicationTypeAsString()

      The type of the application.

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

      Returns:
      The type of the application.
      See Also:

    • hasInstances

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

    • instances

      public final List<String> instances()

      The Amazon EC2 instances on which your SAP application is running.

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

      Returns:
      The Amazon EC2 instances on which your SAP application is running.

    • sapInstanceNumber

      public final String sapInstanceNumber()

      The SAP instance number of the application.

      Returns:
      The SAP instance number of the application.

    • sid

      public final String sid()

      The System ID of the application.

      Returns:
      The System ID of the application.

    • 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 Map<String,String> tags()

      The tags to be attached to the SAP 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 hasTags() method.

      Returns:
      The tags to be attached to the SAP application.

    • hasCredentials

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

    • credentials

      public final List<ApplicationCredential> credentials()

      The credentials of the SAP 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 hasCredentials() method.

      Returns:
      The credentials of the SAP application.

    • databaseArn

      public final String databaseArn()

      The Amazon Resource Name of the SAP HANA database.

      Returns:
      The Amazon Resource Name of the SAP HANA database.

    • hasComponentsInfo

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

    • componentsInfo

      public final List<ComponentInfo> componentsInfo()

      This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher.

      This is an array of ApplicationComponent objects. You may input 0 to 5 items.

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

      Returns:
      This is an optional parameter for component details to which the SAP ABAP application is attached, such as Web Dispatcher.

      This is an array of ApplicationComponent objects. You may input 0 to 5 items.

    • toBuilder

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

    • builder

      public static RegisterApplicationRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RegisterApplicationRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.