Package software.amazon.awssdk.services.iotfleethub.model

Class DescribeApplicationResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotfleethub.model.IoTFleetHubResponse
software.amazon.awssdk.services.iotfleethub.model.DescribeApplicationResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeApplicationResponse.Builder,DescribeApplicationResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeApplicationResponse extends IoTFleetHubResponse implements ToCopyableBuilder<DescribeApplicationResponse.Builder,DescribeApplicationResponse>

  • Method Details

    • applicationId

      public final String applicationId()

      The unique Id of the web application.

      Returns:
      The unique Id of the web application.

    • applicationArn

      public final String applicationArn()

      The ARN of the web application.

      Returns:
      The ARN of the web application.

    • applicationName

      public final String applicationName()

      The name of the web application.

      Returns:
      The name of the web application.

    • applicationDescription

      public final String applicationDescription()

      An optional description of the web application.

      Returns:
      An optional description of the web application.

    • applicationUrl

      public final String applicationUrl()

      The URL of the web application.

      Returns:
      The URL of the web application.

    • applicationState

      public final ApplicationState applicationState()

      The current state of the web application.

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

      Returns:
      The current state of the web application.
      See Also:

    • applicationStateAsString

      public final String applicationStateAsString()

      The current state of the web application.

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

      Returns:
      The current state of the web application.
      See Also:

    • applicationCreationDate

      public final Long applicationCreationDate()

      The date (in Unix epoch time) when the application was created.

      Returns:
      The date (in Unix epoch time) when the application was created.

    • applicationLastUpdateDate

      public final Long applicationLastUpdateDate()

      The date (in Unix epoch time) when the application was last updated.

      Returns:
      The date (in Unix epoch time) when the application was last updated.

    • roleArn

      public final String roleArn()

      The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.

      Returns:
      The ARN of the role that the web application assumes when it interacts with Amazon Web Services IoT Core.

    • ssoClientId

      public final String ssoClientId()

      The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

      Returns:
      The Id of the single sign-on client that you use to authenticate and authorize users on the web application.

    • errorMessage

      public final String errorMessage()

      A message that explains any failures included in the applicationState response field. This message explains failures in the CreateApplication and DeleteApplication actions.

      Returns:
      A message that explains any failures included in the applicationState response field. This message explains failures in the CreateApplication and DeleteApplication actions.

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

      A set of key/value pairs that you can use to manage the web application resource.

      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 set of key/value pairs that you can use to manage the web application resource.

    • toBuilder

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

    • builder

      public static DescribeApplicationResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

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