GetAppDetailResponse
    • PDF

    GetAppDetailResponse

    • PDF

    Article summary

    Available in VPC

    These are Data Forest app details.

    Syntax

    The syntax is as follows.

    private Boolean success;
    private String message;
    private String id;
    private String appId;
    private String name;
    private String appTypeId;
    private Integer lifetime;
    private String queueName;
    private String description;
    private String state;
    private String links;
    private AppComponentResponse components;
    

    Field

    The following describes the fields.

    FieldTypeRequiredDescription
    successBooleanRequiredWhether the app details query was successful
    • true | false
      • true: succeeded
      • false: failure
    messageStringOptionalResult message after querying the app details
    idStringRequiredApp identifier UUID (base62)
    appIdStringOptionalApp ID
    nameStringOptionalApp name
    appTypeIdStringRequiredData Forest app type and app version
    • <Example> DEV-1.0.0
    lifetimeIntegerOptionalApp uptime (seconds)
    • 300 - 604800, -1 (infinite)
    queueNameStringRequiredYARN queue name
    • dev (default)
    descriptionStringOptionalApp description
    stateStringOptionalApp status
    linksStringRequiredAccess address to quick links
    componentsAppComponentResponseRequiredAppComponentResponse data type

    Was this article helpful?

    Changing your password will log you out immediately. Use the new password to log back in.
    First name must have atleast 2 characters. Numbers and special characters are not allowed.
    Last name must have atleast 1 characters. Numbers and special characters are not allowed.
    Enter a valid email
    Enter a valid password
    Your profile has been successfully updated.