Class Upload

    • Method Detail

      • arn

        public final String arn()

        The upload's ARN.

        Returns:
        The upload's ARN.
      • name

        public final String name()

        The upload's file name.

        Returns:
        The upload's file name.
      • created

        public final Instant created()

        When the upload was created.

        Returns:
        When the upload was created.
      • type

        public final UploadType type()

        The upload's type.

        Must be one of the following values:

        • ANDROID_APP

        • IOS_APP

        • WEB_APP

        • EXTERNAL_DATA

        • APPIUM_JAVA_JUNIT_TEST_PACKAGE

        • APPIUM_JAVA_TESTNG_TEST_PACKAGE

        • APPIUM_PYTHON_TEST_PACKAGE

        • APPIUM_NODE_TEST_PACKAGE

        • APPIUM_RUBY_TEST_PACKAGE

        • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE

        • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE

        • APPIUM_WEB_PYTHON_TEST_PACKAGE

        • APPIUM_WEB_NODE_TEST_PACKAGE

        • APPIUM_WEB_RUBY_TEST_PACKAGE

        • CALABASH_TEST_PACKAGE

        • INSTRUMENTATION_TEST_PACKAGE

        • UIAUTOMATION_TEST_PACKAGE

        • UIAUTOMATOR_TEST_PACKAGE

        • XCTEST_TEST_PACKAGE

        • XCTEST_UI_TEST_PACKAGE

        • APPIUM_JAVA_JUNIT_TEST_SPEC

        • APPIUM_JAVA_TESTNG_TEST_SPEC

        • APPIUM_PYTHON_TEST_SPEC

        • APPIUM_NODE_TEST_SPEC

        • APPIUM_RUBY_TEST_SPEC

        • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC

        • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC

        • APPIUM_WEB_PYTHON_TEST_SPEC

        • APPIUM_WEB_NODE_TEST_SPEC

        • APPIUM_WEB_RUBY_TEST_SPEC

        • INSTRUMENTATION_TEST_SPEC

        • XCTEST_UI_TEST_SPEC

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

        Returns:
        The upload's type.

        Must be one of the following values:

        • ANDROID_APP

        • IOS_APP

        • WEB_APP

        • EXTERNAL_DATA

        • APPIUM_JAVA_JUNIT_TEST_PACKAGE

        • APPIUM_JAVA_TESTNG_TEST_PACKAGE

        • APPIUM_PYTHON_TEST_PACKAGE

        • APPIUM_NODE_TEST_PACKAGE

        • APPIUM_RUBY_TEST_PACKAGE

        • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE

        • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE

        • APPIUM_WEB_PYTHON_TEST_PACKAGE

        • APPIUM_WEB_NODE_TEST_PACKAGE

        • APPIUM_WEB_RUBY_TEST_PACKAGE

        • CALABASH_TEST_PACKAGE

        • INSTRUMENTATION_TEST_PACKAGE

        • UIAUTOMATION_TEST_PACKAGE

        • UIAUTOMATOR_TEST_PACKAGE

        • XCTEST_TEST_PACKAGE

        • XCTEST_UI_TEST_PACKAGE

        • APPIUM_JAVA_JUNIT_TEST_SPEC

        • APPIUM_JAVA_TESTNG_TEST_SPEC

        • APPIUM_PYTHON_TEST_SPEC

        • APPIUM_NODE_TEST_SPEC

        • APPIUM_RUBY_TEST_SPEC

        • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC

        • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC

        • APPIUM_WEB_PYTHON_TEST_SPEC

        • APPIUM_WEB_NODE_TEST_SPEC

        • APPIUM_WEB_RUBY_TEST_SPEC

        • INSTRUMENTATION_TEST_SPEC

        • XCTEST_UI_TEST_SPEC

        See Also:
        UploadType
      • typeAsString

        public final String typeAsString()

        The upload's type.

        Must be one of the following values:

        • ANDROID_APP

        • IOS_APP

        • WEB_APP

        • EXTERNAL_DATA

        • APPIUM_JAVA_JUNIT_TEST_PACKAGE

        • APPIUM_JAVA_TESTNG_TEST_PACKAGE

        • APPIUM_PYTHON_TEST_PACKAGE

        • APPIUM_NODE_TEST_PACKAGE

        • APPIUM_RUBY_TEST_PACKAGE

        • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE

        • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE

        • APPIUM_WEB_PYTHON_TEST_PACKAGE

        • APPIUM_WEB_NODE_TEST_PACKAGE

        • APPIUM_WEB_RUBY_TEST_PACKAGE

        • CALABASH_TEST_PACKAGE

        • INSTRUMENTATION_TEST_PACKAGE

        • UIAUTOMATION_TEST_PACKAGE

        • UIAUTOMATOR_TEST_PACKAGE

        • XCTEST_TEST_PACKAGE

        • XCTEST_UI_TEST_PACKAGE

        • APPIUM_JAVA_JUNIT_TEST_SPEC

        • APPIUM_JAVA_TESTNG_TEST_SPEC

        • APPIUM_PYTHON_TEST_SPEC

        • APPIUM_NODE_TEST_SPEC

        • APPIUM_RUBY_TEST_SPEC

        • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC

        • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC

        • APPIUM_WEB_PYTHON_TEST_SPEC

        • APPIUM_WEB_NODE_TEST_SPEC

        • APPIUM_WEB_RUBY_TEST_SPEC

        • INSTRUMENTATION_TEST_SPEC

        • XCTEST_UI_TEST_SPEC

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

        Returns:
        The upload's type.

        Must be one of the following values:

        • ANDROID_APP

        • IOS_APP

        • WEB_APP

        • EXTERNAL_DATA

        • APPIUM_JAVA_JUNIT_TEST_PACKAGE

        • APPIUM_JAVA_TESTNG_TEST_PACKAGE

        • APPIUM_PYTHON_TEST_PACKAGE

        • APPIUM_NODE_TEST_PACKAGE

        • APPIUM_RUBY_TEST_PACKAGE

        • APPIUM_WEB_JAVA_JUNIT_TEST_PACKAGE

        • APPIUM_WEB_JAVA_TESTNG_TEST_PACKAGE

        • APPIUM_WEB_PYTHON_TEST_PACKAGE

        • APPIUM_WEB_NODE_TEST_PACKAGE

        • APPIUM_WEB_RUBY_TEST_PACKAGE

        • CALABASH_TEST_PACKAGE

        • INSTRUMENTATION_TEST_PACKAGE

        • UIAUTOMATION_TEST_PACKAGE

        • UIAUTOMATOR_TEST_PACKAGE

        • XCTEST_TEST_PACKAGE

        • XCTEST_UI_TEST_PACKAGE

        • APPIUM_JAVA_JUNIT_TEST_SPEC

        • APPIUM_JAVA_TESTNG_TEST_SPEC

        • APPIUM_PYTHON_TEST_SPEC

        • APPIUM_NODE_TEST_SPEC

        • APPIUM_RUBY_TEST_SPEC

        • APPIUM_WEB_JAVA_JUNIT_TEST_SPEC

        • APPIUM_WEB_JAVA_TESTNG_TEST_SPEC

        • APPIUM_WEB_PYTHON_TEST_SPEC

        • APPIUM_WEB_NODE_TEST_SPEC

        • APPIUM_WEB_RUBY_TEST_SPEC

        • INSTRUMENTATION_TEST_SPEC

        • XCTEST_UI_TEST_SPEC

        See Also:
        UploadType
      • status

        public final UploadStatus status()

        The upload's status.

        Must be one of the following values:

        • FAILED

        • INITIALIZED

        • PROCESSING

        • SUCCEEDED

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

        Returns:
        The upload's status.

        Must be one of the following values:

        • FAILED

        • INITIALIZED

        • PROCESSING

        • SUCCEEDED

        See Also:
        UploadStatus
      • statusAsString

        public final String statusAsString()

        The upload's status.

        Must be one of the following values:

        • FAILED

        • INITIALIZED

        • PROCESSING

        • SUCCEEDED

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

        Returns:
        The upload's status.

        Must be one of the following values:

        • FAILED

        • INITIALIZED

        • PROCESSING

        • SUCCEEDED

        See Also:
        UploadStatus
      • url

        public final String url()

        The presigned Amazon S3 URL that was used to store a file using a PUT request.

        Returns:
        The presigned Amazon S3 URL that was used to store a file using a PUT request.
      • metadata

        public final String metadata()

        The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.

        Returns:
        The upload's metadata. For example, for Android, this contains information that is parsed from the manifest and is displayed in the AWS Device Farm console after the associated app is uploaded.
      • contentType

        public final String contentType()

        The upload's content type (for example, application/octet-stream).

        Returns:
        The upload's content type (for example, application/octet-stream).
      • message

        public final String message()

        A message about the upload's result.

        Returns:
        A message about the upload's result.
      • category

        public final UploadCategory category()

        The upload's category. Allowed values include:

        • CURATED: An upload managed by AWS Device Farm.

        • PRIVATE: An upload managed by the AWS Device Farm customer.

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

        Returns:
        The upload's category. Allowed values include:

        • CURATED: An upload managed by AWS Device Farm.

        • PRIVATE: An upload managed by the AWS Device Farm customer.

        See Also:
        UploadCategory
      • categoryAsString

        public final String categoryAsString()

        The upload's category. Allowed values include:

        • CURATED: An upload managed by AWS Device Farm.

        • PRIVATE: An upload managed by the AWS Device Farm customer.

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

        Returns:
        The upload's category. Allowed values include:

        • CURATED: An upload managed by AWS Device Farm.

        • PRIVATE: An upload managed by the AWS Device Farm customer.

        See Also:
        UploadCategory
      • serializableBuilderClass

        public static Class<? extends Upload.Builder> serializableBuilderClass()
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)