GetResult (Snowpark Java API Reference 1.21.0)

Package com.snowflake.snowpark_java

## Class GetResult

- java.lang.Object
- - com.snowflake.snowpark_java.GetResult

-     public class GetResult
      extends java.lang.Object

  Represents the results of downloading a file from a stage location to the local file system.

  NOTE: `fileName` is the relative path to the file on the stage. For example, if you download `@myStage/prefix1/file1.csv.gz`, `fileName` is `prefix1/file1.csv.gz`.

  Since:
    1.2.0

- - ### Method Summary

    All Methods Instance Methods Concrete Methods
    Modifier and Type | Method | Description
    --- | --- | ---
    `java.lang.String` | `getEncryption()` | Retrieves the encryption status
    `java.lang.String` | `getFileName()` | Retrieves the file name
    `java.lang.String` | `getMessage()` | Retrieves the message
    `long` | `getSizeBytes()` | Retrieves the file size in bytes
    `java.lang.String` | `getStatus()` | Retrieves the file status

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### getFileName

          public java.lang.String getFileName()

      Retrieves the file name
      Returns:
        A String
      Since:
        1.2.0

    - #### getSizeBytes

          public long getSizeBytes()

      Retrieves the file size in bytes
      Returns:
        A long number
      Since:
        1.2.0

    - #### getStatus

          public java.lang.String getStatus()

      Retrieves the file status
      Returns:
        A String
      Since:
        1.2.0

    - #### getEncryption

          public java.lang.String getEncryption()

      Retrieves the encryption status
      Returns:
        A String
      Since:
        1.2.0

    - #### getMessage

          public java.lang.String getMessage()

      Retrieves the message
      Returns:
        A String
      Since:
        1.2.0