Package-level declarations

Types

Link copied to clipboard
data class AccountArgs(val googleAuto: Output<GoogleAutoArgs>? = null) : ConvertibleToJava<AccountArgs>

Identifies an account and how to log into it.

Link copied to clipboard
Link copied to clipboard
data class AndroidDeviceArgs(val androidModelId: Output<String>, val androidVersionId: Output<String>, val locale: Output<String>, val orientation: Output<String>) : ConvertibleToJava<AndroidDeviceArgs>

A single Android device.

Link copied to clipboard
Link copied to clipboard
data class AndroidDeviceListArgs(val androidDevices: Output<List<AndroidDeviceArgs>>) : ConvertibleToJava<AndroidDeviceListArgs>

A list of Android device configurations in which the test is to be executed.

Link copied to clipboard
data class AndroidInstrumentationTestArgs(val appApk: Output<FileReferenceArgs>? = null, val appBundle: Output<AppBundleArgs>? = null, val appPackageId: Output<String>? = null, val orchestratorOption: Output<AndroidInstrumentationTestOrchestratorOption>? = null, val shardingOption: Output<ShardingOptionArgs>? = null, val testApk: Output<FileReferenceArgs>, val testPackageId: Output<String>? = null, val testRunnerClass: Output<String>? = null, val testTargets: Output<List<String>>? = null) : ConvertibleToJava<AndroidInstrumentationTestArgs>

A test of an Android application that can control an Android component independently of its normal lifecycle. Android instrumentation tests run an application APK and test APK inside the same process on a virtual or physical AndroidDevice. They also specify a test runner class, such as com.google.GoogleTestRunner, which can vary on the specific instrumentation framework chosen. See for more information on types of Android tests.

Link copied to clipboard
data class AndroidMatrixArgs(val androidModelIds: Output<List<String>>, val androidVersionIds: Output<List<String>>, val locales: Output<List<String>>, val orientations: Output<List<String>>) : ConvertibleToJava<AndroidMatrixArgs>

A set of Android device configuration permutations is defined by the the cross-product of the given axes. Internally, the given AndroidMatrix will be expanded into a set of AndroidDevices. Only supported permutations will be instantiated. Invalid permutations (e.g., incompatible models/versions) are ignored.

Link copied to clipboard
Link copied to clipboard
data class AndroidRoboTestArgs(val appApk: Output<FileReferenceArgs>? = null, val appBundle: Output<AppBundleArgs>? = null, val appInitialActivity: Output<String>? = null, val appPackageId: Output<String>? = null, val maxDepth: Output<Int>? = null, val maxSteps: Output<Int>? = null, val roboDirectives: Output<List<RoboDirectiveArgs>>? = null, val roboMode: Output<AndroidRoboTestRoboMode>? = null, val roboScript: Output<FileReferenceArgs>? = null, val startingIntents: Output<List<RoboStartingIntentArgs>>? = null) : ConvertibleToJava<AndroidRoboTestArgs>

A test of an android application that explores the application on a virtual or physical Android Device, finding culprits and crashes as it goes.

Link copied to clipboard
data class AndroidTestLoopArgs(val appApk: Output<FileReferenceArgs>? = null, val appBundle: Output<AppBundleArgs>? = null, val appPackageId: Output<String>? = null, val scenarioLabels: Output<List<String>>? = null, val scenarios: Output<List<Int>>? = null) : ConvertibleToJava<AndroidTestLoopArgs>

A test of an Android Application with a Test Loop. The intent \ will be implicitly added, since Games is the only user of this api, for the time being.

Link copied to clipboard
data class ApkArgs(val location: Output<FileReferenceArgs>? = null, val packageName: Output<String>? = null) : ConvertibleToJava<ApkArgs>

An Android package file to install.

Link copied to clipboard

Builder for ApkArgs.

Link copied to clipboard
data class AppBundleArgs(val bundleLocation: Output<FileReferenceArgs>? = null) : ConvertibleToJava<AppBundleArgs>

An Android App Bundle file format, containing a BundleConfig.pb file, a base module directory, zero or more dynamic feature module directories. See https://developer.android.com/guide/app-bundle/build for guidance on building App Bundles.

Link copied to clipboard
Link copied to clipboard
data class ClientInfoArgs(val clientInfoDetails: Output<List<ClientInfoDetailArgs>>? = null, val name: Output<String>) : ConvertibleToJava<ClientInfoArgs>

Information about the client which invoked the test.

Link copied to clipboard
Link copied to clipboard
data class ClientInfoDetailArgs(val key: Output<String>, val value: Output<String>) : ConvertibleToJava<ClientInfoDetailArgs>

Key-value pair of detailed information about the client which invoked the test. Examples: {'Version', '1.0'}, {'Release Track', 'BETA'}.

Link copied to clipboard
data class DeviceFileArgs(val obbFile: Output<ObbFileArgs>? = null, val regularFile: Output<RegularFileArgs>? = null) : ConvertibleToJava<DeviceFileArgs>

A single device file description.

Link copied to clipboard
Link copied to clipboard
data class EnvironmentMatrixArgs(val androidDeviceList: Output<AndroidDeviceListArgs>? = null, val androidMatrix: Output<AndroidMatrixArgs>? = null, val iosDeviceList: Output<IosDeviceListArgs>? = null) : ConvertibleToJava<EnvironmentMatrixArgs>

The matrix of environments in which the test is to be executed.

Link copied to clipboard
data class EnvironmentVariableArgs(val key: Output<String>? = null, val value: Output<String>? = null) : ConvertibleToJava<EnvironmentVariableArgs>

A key-value pair passed as an environment variable to the test.

Link copied to clipboard
data class FileReferenceArgs(val gcsPath: Output<String>? = null) : ConvertibleToJava<FileReferenceArgs>

A reference to a file, used for user inputs.

Link copied to clipboard
Link copied to clipboard
data class GetTestMatrixPlainArgs(val project: String? = null, val testMatrixId: String) : ConvertibleToJava<GetTestMatrixPlainArgs>
Link copied to clipboard
class GoogleAutoArgs : ConvertibleToJava<GoogleAutoArgs>

Enables automatic Google account login. If set, the service automatically generates a Google test account and adds it to the device, before executing the test. Note that test accounts might be reused. Many applications show their full set of functionalities when an account is present on the device. Logging into the device with these generated accounts allows testing more functionalities.

Link copied to clipboard
Link copied to clipboard
data class GoogleCloudStorageArgs(val gcsPath: Output<String>) : ConvertibleToJava<GoogleCloudStorageArgs>

A storage location within Google cloud storage (GCS).

Link copied to clipboard
data class IosDeviceArgs(val iosModelId: Output<String>, val iosVersionId: Output<String>, val locale: Output<String>, val orientation: Output<String>) : ConvertibleToJava<IosDeviceArgs>

A single iOS device.

Link copied to clipboard
Link copied to clipboard
data class IosDeviceFileArgs(val bundleId: Output<String>? = null, val content: Output<FileReferenceArgs>? = null, val devicePath: Output<String>? = null) : ConvertibleToJava<IosDeviceFileArgs>

A file or directory to install on the device before the test starts.

Link copied to clipboard
Link copied to clipboard
data class IosDeviceListArgs(val iosDevices: Output<List<IosDeviceArgs>>) : ConvertibleToJava<IosDeviceListArgs>

A list of iOS device configurations in which the test is to be executed.

Link copied to clipboard
Link copied to clipboard
data class IosTestLoopArgs(val appIpa: Output<FileReferenceArgs>, val scenarios: Output<List<Int>>? = null) : ConvertibleToJava<IosTestLoopArgs>

A test of an iOS application that implements one or more game loop scenarios. This test type accepts an archived application (.ipa file) and a list of integer scenarios that will be executed on the app sequentially.

Link copied to clipboard
Link copied to clipboard
data class IosTestSetupArgs(val additionalIpas: Output<List<FileReferenceArgs>>? = null, val networkProfile: Output<String>? = null, val pullDirectories: Output<List<IosDeviceFileArgs>>? = null, val pushFiles: Output<List<IosDeviceFileArgs>>? = null) : ConvertibleToJava<IosTestSetupArgs>

A description of how to set up an iOS device prior to running the test.

Link copied to clipboard
Link copied to clipboard
data class IosXcTestArgs(val testSpecialEntitlements: Output<Boolean>? = null, val testsZip: Output<FileReferenceArgs>, val xcodeVersion: Output<String>? = null, val xctestrun: Output<FileReferenceArgs>? = null) : ConvertibleToJava<IosXcTestArgs>

A test of an iOS application that uses the XCTest framework. Xcode supports the option to "build for testing", which generates an .xctestrun file that contains a test specification (arguments, test methods, etc). This test type accepts a zip file containing the .xctestrun file and the corresponding contents of the Build/Products directory that contains all the binaries needed to run the tests.

Link copied to clipboard
Link copied to clipboard
class LauncherActivityIntentArgs : ConvertibleToJava<LauncherActivityIntentArgs>

Specifies an intent that starts the main launcher activity.

Link copied to clipboard
data class ManualShardingArgs(val testTargetsForShard: Output<List<TestTargetsForShardArgs>>) : ConvertibleToJava<ManualShardingArgs>

Shards test cases into the specified groups of packages, classes, and/or methods. With manual sharding enabled, specifying test targets via environment_variables or in InstrumentationTest is invalid.

Link copied to clipboard
Link copied to clipboard
data class ObbFileArgs(val obb: Output<FileReferenceArgs>, val obbFileName: Output<String>) : ConvertibleToJava<ObbFileArgs>

An opaque binary blob file to install on the device before the test starts.

Link copied to clipboard
Link copied to clipboard
data class RegularFileArgs(val content: Output<FileReferenceArgs>, val devicePath: Output<String>) : ConvertibleToJava<RegularFileArgs>

A file or directory to install on the device before the test starts.

Link copied to clipboard
Link copied to clipboard
data class ResultStorageArgs(val googleCloudStorage: Output<GoogleCloudStorageArgs>, val toolResultsHistory: Output<ToolResultsHistoryArgs>? = null) : ConvertibleToJava<ResultStorageArgs>

Locations where the results of running the test are stored.

Link copied to clipboard
Link copied to clipboard
data class RoboDirectiveArgs(val actionType: Output<RoboDirectiveActionType>, val inputText: Output<String>? = null, val resourceName: Output<String>) : ConvertibleToJava<RoboDirectiveArgs>

Directs Robo to interact with a specific UI element if it is encountered during the crawl. Currently, Robo can perform text entry or element click.

Link copied to clipboard
Link copied to clipboard
data class RoboStartingIntentArgs(val launcherActivity: Output<LauncherActivityIntentArgs>? = null, val startActivity: Output<StartActivityIntentArgs>? = null, val timeout: Output<String>? = null) : ConvertibleToJava<RoboStartingIntentArgs>

Message for specifying the start activities to crawl.

Link copied to clipboard
data class ShardingOptionArgs(val manualSharding: Output<ManualShardingArgs>? = null, val smartSharding: Output<SmartShardingArgs>? = null, val uniformSharding: Output<UniformShardingArgs>? = null) : ConvertibleToJava<ShardingOptionArgs>

Options for enabling sharding.

Link copied to clipboard
Link copied to clipboard
data class SmartShardingArgs(val targetedShardDuration: Output<String>? = null) : ConvertibleToJava<SmartShardingArgs>

Shards test based on previous test case timing records.

Link copied to clipboard
Link copied to clipboard
data class StartActivityIntentArgs(val action: Output<String>? = null, val categories: Output<List<String>>? = null, val uri: Output<String>? = null) : ConvertibleToJava<StartActivityIntentArgs>

A starting intent specified by an action, uri, and categories.

Link copied to clipboard
data class SystraceSetupArgs(val durationSeconds: Output<Int>? = null) : ConvertibleToJava<SystraceSetupArgs>
Link copied to clipboard
Link copied to clipboard
data class TestSetupArgs(val account: Output<AccountArgs>? = null, val additionalApks: Output<List<ApkArgs>>? = null, val directoriesToPull: Output<List<String>>? = null, val dontAutograntPermissions: Output<Boolean>? = null, val environmentVariables: Output<List<EnvironmentVariableArgs>>? = null, val filesToPush: Output<List<DeviceFileArgs>>? = null, val networkProfile: Output<String>? = null, val systrace: Output<SystraceSetupArgs>? = null) : ConvertibleToJava<TestSetupArgs>

A description of how to set up the Android device prior to running the test.

Link copied to clipboard
Link copied to clipboard
data class TestSpecificationArgs(val androidInstrumentationTest: Output<AndroidInstrumentationTestArgs>? = null, val androidRoboTest: Output<AndroidRoboTestArgs>? = null, val androidTestLoop: Output<AndroidTestLoopArgs>? = null, val disablePerformanceMetrics: Output<Boolean>? = null, val disableVideoRecording: Output<Boolean>? = null, val iosTestLoop: Output<IosTestLoopArgs>? = null, val iosTestSetup: Output<IosTestSetupArgs>? = null, val iosXcTest: Output<IosXcTestArgs>? = null, val testSetup: Output<TestSetupArgs>? = null, val testTimeout: Output<String>? = null) : ConvertibleToJava<TestSpecificationArgs>

A description of how to run the test.

Link copied to clipboard
data class TestTargetsForShardArgs(val testTargets: Output<List<String>>? = null) : ConvertibleToJava<TestTargetsForShardArgs>

Test targets for a shard.

Link copied to clipboard
data class ToolResultsHistoryArgs(val historyId: Output<String>, val project: Output<String>) : ConvertibleToJava<ToolResultsHistoryArgs>

Represents a tool results history resource.

Link copied to clipboard
data class UniformShardingArgs(val numShards: Output<Int>) : ConvertibleToJava<UniformShardingArgs>

Uniformly shards test cases given a total number of shards. For instrumentation tests, it will be translated to "-e numShard" and "-e shardIndex" AndroidJUnitRunner arguments. With uniform sharding enabled, specifying either of these sharding arguments via environment_variables is invalid. Based on the sharding mechanism AndroidJUnitRunner uses, there is no guarantee that test cases will be distributed uniformly across all shards.