Class CreateUploadRequest

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

@Generated("software.amazon.awssdk:codegen") public final class CreateUploadRequest extends DeviceFarmRequest implements ToCopyableBuilder<CreateUploadRequest.Builder,CreateUploadRequest>

Represents a request to the create upload operation.

  • Method Details

    • projectArn

      public final String projectArn()

      The ARN of the project for the upload.

      Returns:
      The ARN of the project for the upload.
    • name

      public final String name()

      The upload's file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension.

      Returns:
      The upload's file name. The name should not contain any forward slashes (/). If you are uploading an iOS app, the file name must end with the .ipa extension. If you are uploading an Android app, the file name must end with the .apk extension. For all others, the file name must end with the .zip file extension.
    • type

      public final UploadType type()

      The upload's upload 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 you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

      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 upload 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 you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

      See Also:
    • typeAsString

      public final String typeAsString()

      The upload's upload 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 you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

      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 upload 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 you call CreateUpload with WEB_APP specified, AWS Device Farm throws an ArgumentException error.

      See Also:
    • 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).
    • toBuilder

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

      public static CreateUploadRequest.Builder builder()
    • serializableBuilderClass

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