Stay organized with collections
Save and categorize content based on your preferences.
EmulatorControl
@Incubating interface EmulatorControl
Options for configuring Android Emulator Access
When enabled, it will be possible to control the emulator through gRPC.
Summary
Public properties |
MutableSet<String> |
Set of endpoints to which access is granted, this is only required if the method you wish to access is in the set of methods that require authorization as defined in emulator_access.json used by the emulator this test is running on.
|
Boolean |
True if emulator control should be enabled.
|
Int |
The duration in seconds the test can access the gRPC endpoint.
|
Public properties
allowedEndpoints
val allowedEndpoints: MutableSet<String>
Set of endpoints to which access is granted, this is only required if the method you wish to access is in the set of methods that require authorization as defined in emulator_access.json used by the emulator this test is running on.
Details on which endpoints and what considerations are taken to make an endpoint accessible is described in go/emu-grpc-integration.
enable
var enable: Boolean
True if emulator control should be enabled.
secondsValid
var secondsValid: Int
The duration in seconds the test can access the gRPC endpoint. The default value is 3600 (one hour).
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-02-10 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-02-10 UTC."],[],[],null,["# EmulatorControl\n===============\n\n\n```\n@Incubating interface EmulatorControl\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nOptions for configuring Android Emulator Access\n\nWhen enabled, it will be possible to control the emulator through gRPC.\n\nSummary\n-------\n\n| ### Public properties ||\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [MutableSet](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.collections/-mutable-set/index.html)`\u003c`[String](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-string/index.html)`\u003e` | [allowedEndpoints](/reference/tools/gradle-api/8.1/com/android/build/api/dsl/EmulatorControl#allowedEndpoints()) Set of endpoints to which access is granted, this is only required if the method you wish to access is in the set of methods that require authorization as defined in emulator_access.json used by the emulator this test is running on. |\n| [Boolean](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-boolean/index.html) | [enable](/reference/tools/gradle-api/8.1/com/android/build/api/dsl/EmulatorControl#enable()) True if emulator control should be enabled. |\n| [Int](https://kotlinlang.org/api/latest/jvm/stdlib/kotlin/-int/index.html) | [secondsValid](/reference/tools/gradle-api/8.1/com/android/build/api/dsl/EmulatorControl#secondsValid()) The duration in seconds the test can access the gRPC endpoint. |\n\nPublic properties\n-----------------\n\n### allowedEndpoints\n\n```\nval allowedEndpoints: MutableSet\u003cString\u003e\n```\n\nSet of endpoints to which access is granted, this is only required if the method you wish to access is in the set of methods that require authorization as defined in emulator_access.json used by the emulator this test is running on.\n\nDetails on which endpoints and what considerations are taken to make an endpoint accessible is described in go/emu-grpc-integration. \n\n### enable\n\n```\nvar enable: Boolean\n```\n\nTrue if emulator control should be enabled. \n\n### secondsValid\n\n```\nvar secondsValid: Int\n```\n\nThe duration in seconds the test can access the gRPC endpoint. The default value is 3600 (one hour)."]]
