Class GetScreenDataRequest

All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetScreenDataRequest.Builder,GetScreenDataRequest>

@Generated("software.amazon.awssdk:codegen") public final class GetScreenDataRequest extends HoneycodeRequest implements ToCopyableBuilder<GetScreenDataRequest.Builder,GetScreenDataRequest>
  • Method Details

    • workbookId

      public final String workbookId()

      The ID of the workbook that contains the screen.

      Returns:
      The ID of the workbook that contains the screen.
    • appId

      public final String appId()

      The ID of the app that contains the screen.

      Returns:
      The ID of the app that contains the screen.
    • screenId

      public final String screenId()

      The ID of the screen.

      Returns:
      The ID of the screen.
    • hasVariables

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

      public final Map<String,VariableValue> variables()

      Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.

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

      Returns:
      Variables are optional and are needed only if the screen requires them to render correctly. Variables are specified as a map where the key is the name of the variable as defined on the screen. The value is an object which currently has only one property, rawValue, which holds the value of the variable to be passed to the screen.
    • maxResults

      public final Integer maxResults()

      The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

      This parameter is optional. If you don't specify this parameter, the default page size is 100.

      Returns:
      The number of results to be returned on a single page. Specify a number between 1 and 100. The maximum value is 100.

      This parameter is optional. If you don't specify this parameter, the default page size is 100.

    • nextToken

      public final String nextToken()

      This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

      Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

      Returns:
      This parameter is optional. If a nextToken is not specified, the API returns the first page of data.

      Pagination tokens expire after 1 hour. If you use a token that was returned more than an hour back, the API will throw ValidationException.

    • toBuilder

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

      public static GetScreenDataRequest.Builder builder()
    • serializableBuilderClass

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