You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::DeviceFarm::Types::Run

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb

Overview

Represents a test run on a set of devices with a given app package, test parameters, etc.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The run's ARN.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#billing_methodString

Specifies the billing method for a test run: metered or unmetered. If the parameter is not specified, the default value is metered.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#completed_jobsInteger

The total number of completed jobs.

Returns:

  • (Integer)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#countersTypes::Counters

The run's result counters.

Returns:



3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#createdTime

When the run was created.

Returns:

  • (Time)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#customer_artifact_pathsTypes::CustomerArtifactPaths

Output CustomerArtifactPaths object for the test run.



3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#device_minutesTypes::DeviceMinutes

Represents the total (metered or unmetered) minutes used by the test run.



3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#messageString

A message about the run's result.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#nameString

The run's name.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#network_profileTypes::NetworkProfile

The network profile being used for a test run.



3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#parsing_result_urlString

Read-only URL for an object in S3 bucket where you can get the parsing results of the test package. If the test package doesn't parse, the reason why it doesn't parse appears in the file that this URL points to.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#platformString

The run's platform.

Allowed values include:

  • ANDROID: The Android platform.

  • IOS: The iOS platform.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#resultString

The run's result.

Allowed values include:

  • PENDING: A pending condition.

  • PASSED: A passing condition.

  • WARNED: A warning condition.

  • FAILED: A failed condition.

  • SKIPPED: A skipped condition.

  • ERRORED: An error condition.

  • STOPPED: A stopped condition.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#result_codeString

Supporting field for the result field. Set only if result is SKIPPED. PARSING_FAILED if the result is skipped because of test package parsing failure.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#startedTime

The run's start time.

Returns:

  • (Time)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#statusString

The run's status.

Allowed values include:

  • PENDING: A pending status.

  • PENDING_CONCURRENCY: A pending concurrency status.

  • PENDING_DEVICE: A pending device status.

  • PROCESSING: A processing status.

  • SCHEDULING: A scheduling status.

  • PREPARING: A preparing status.

  • RUNNING: A running status.

  • COMPLETED: A completed status.

  • STOPPING: A stopping status.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#stoppedTime

The run's stop time.

Returns:

  • (Time)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#total_jobsInteger

The total number of jobs for the run.

Returns:

  • (Integer)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end

#typeString

The run's type.

Must be one of the following values:

  • BUILTIN_FUZZ: The built-in fuzz type.

  • BUILTIN_EXPLORER: For Android, an app explorer that will traverse an Android app, interacting with it and capturing screenshots at the same time.

  • APPIUM_JAVA_JUNIT: The Appium Java JUnit type.

  • APPIUM_JAVA_TESTNG: The Appium Java TestNG type.

  • APPIUM_PYTHON: The Appium Python type.

  • APPIUM_WEB_JAVA_JUNIT: The Appium Java JUnit type for Web apps.

  • APPIUM_WEB_JAVA_TESTNG: The Appium Java TestNG type for Web apps.

  • APPIUM_WEB_PYTHON: The Appium Python type for Web apps.

  • CALABASH: The Calabash type.

  • INSTRUMENTATION: The Instrumentation type.

  • UIAUTOMATION: The uiautomation type.

  • UIAUTOMATOR: The uiautomator type.

  • XCTEST: The XCode test type.

  • XCTEST_UI: The XCode UI test type.

Returns:

  • (String)


3462
3463
3464
3465
3466
3467
3468
3469
3470
3471
3472
3473
3474
3475
3476
3477
3478
3479
3480
3481
3482
3483
# File 'gems/aws-sdk-devicefarm/lib/aws-sdk-devicefarm/types.rb', line 3462

class Run < Struct.new(
  :arn,
  :name,
  :type,
  :platform,
  :created,
  :status,
  :result,
  :started,
  :stopped,
  :counters,
  :message,
  :total_jobs,
  :completed_jobs,
  :billing_method,
  :device_minutes,
  :network_profile,
  :parsing_result_url,
  :result_code,
  :customer_artifact_paths)
  include Aws::Structure
end