{ "icons": { "x16": "http://www.google.com/images/icons/product/search-16.gif", "x32": "http://www.google.com/images/icons/product/search-32.gif" }, "discoveryVersion": "v1", "title": "Device Run API", "baseUrl": "https://devicerun.googleapis.com/", "revision": "20261028", "documentationLink": "https://docs.cloud.google.com/developer-device-platform/device-run", "version_module": true, "ownerDomain": "google.com", "fullyEncodeReservedExpansion": true, "ownerName": "Google", "rootUrl": "https://devicerun.googleapis.com/", "protocol": "rest", "servicePath": "", "canonicalName": "Device Run", "mtlsRootUrl": "https://devicerun.mtls.googleapis.com/", "kind": "discovery#restDescription", "resources": { "projects": { "resources": { "locations": { "methods": { "list": { "path": "v1/{+name}/locations", "flatPath": "v1/projects/{projectsId}/locations", "parameterOrder": [ "name" ], "id": "devicerun.projects.locations.list", "description": "Lists information about the supported locations for this service. This method lists locations based on the resource scope provided in the ListLocationsRequest.name field: * **Global locations**: If `name` is empty, the method lists the public locations available to all projects. * **Project-specific locations**: If `name` follows the format `projects/{project}`, the method lists locations visible to that specific project. This includes public, private, or other project-specific locations enabled for the project. For gRPC and client library implementations, the resource name is passed as the `name` field. For direct service calls, the resource name is incorporated into the request path based on the specific service implementation and version.", "response": { "$ref": "ListLocationsResponse" }, "httpMethod": "GET", "parameters": { "pageSize": { "type": "integer", "description": "The maximum number of results to return. If not set, the service selects a default.", "location": "query", "format": "int32" }, "pageToken": { "type": "string", "location": "query", "description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page." }, "extraLocationTypes": { "location": "query", "type": "string", "repeated": true, "description": "Optional. Do not use this field unless explicitly documented otherwise. This is primarily for internal usage." }, "name": { "pattern": "^projects/[^/]+$", "required": true, "type": "string", "location": "path", "description": "The resource that owns the locations collection, if applicable." }, "filter": { "location": "query", "type": "string", "description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160)." } }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "description": "Gets information about a location.", "response": { "$ref": "Location" }, "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "name": { "location": "path", "required": true, "description": "Resource name for the location.", "pattern": "^projects/[^/]+/locations/[^/]+$", "type": "string" } }, "flatPath": "v1/projects/{projectsId}/locations/{locationsId}", "id": "devicerun.projects.locations.get", "httpMethod": "GET", "parameterOrder": [ "name" ] } }, "resources": { "softwareVersions": { "methods": { "get": { "parameters": { "name": { "required": true, "type": "string", "description": "Required. The name of the software version. Format: `projects/{project}/locations/global/softwareVersions/{software_version}`.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/softwareVersions/[^/]+$" } }, "path": "v1/{+name}", "response": { "$ref": "CatalogSoftwareVersion" }, "httpMethod": "GET", "parameterOrder": [ "name" ], "id": "devicerun.projects.locations.softwareVersions.get", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/softwareVersions/{softwareVersionsId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns information about a specific software version." }, "list": { "description": "Lists all software versions.", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/softwareVersions", "parameterOrder": [ "parent" ], "path": "v1/{+parent}/softwareVersions", "response": { "$ref": "CatalogListSoftwareVersionsResponse" }, "httpMethod": "GET", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "filter": { "location": "query", "description": "Optional. An AIP-160 (https://google.aip.dev/160) filter expression restricting which software versions are returned. An empty filter returns all software versions. Filtering is supported over the `SoftwareVersion` fields, including nested fields via dot-path. Enum and string values must be double-quoted. Examples: * `software_type = \"ANDROIDX_TEST_ORCHESTRATOR\"` * `software_type = \"ANDROIDX_TEST_ORCHESTRATOR\" AND is_default = true` * `lifecycle.state = \"ACTIVE\"` * `version = \"1.4.1\"`", "type": "string" }, "pageToken": { "location": "query", "type": "string", "description": "Optional. A page token, received from a previous `ListSoftwareVersions` call. Provide this to receive the subsequent page. When paginating, all other parameters provided to `ListSoftwareVersions` must match the call that provided the page token." }, "parent": { "required": true, "location": "path", "description": "Required. The parent of the collection of software versions. Format: `projects/{project}/locations/global`.", "type": "string", "pattern": "^projects/[^/]+/locations/[^/]+$" }, "pageSize": { "location": "query", "description": "Optional. The maximum number of software versions to return. The server may return fewer items than this value.", "format": "int32", "type": "integer" } }, "id": "devicerun.projects.locations.softwareVersions.list" } } }, "devices": { "methods": { "list": { "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "parameters": { "pageToken": { "description": "Optional. A page token, received from a previous `ListDevices` call. Provide this to receive the subsequent page. When paginating, all other parameters provided to `ListDevices` must match the call that provided the page token.", "location": "query", "type": "string" }, "parent": { "pattern": "^projects/[^/]+/locations/[^/]+$", "required": true, "location": "path", "description": "Required. The parent of the collection of devices. Format: `projects/{project}/locations/global`.", "type": "string" }, "pageSize": { "type": "integer", "location": "query", "description": "Optional. The maximum number of devices to return. The server may return fewer items than this value.", "format": "int32" }, "filter": { "type": "string", "description": "Optional. An AIP-160 (https://google.aip.dev/160) filter expression restricting which devices are returned. An empty filter returns all devices. Filtering is supported over the `Device` fields, including nested fields via dot-path. Enum and string values must be double-quoted. Examples: * `platform = \"ANDROID\"` * `platform = \"ANDROID\" AND os_version = \"34\"` * `hardware_type = \"PHYSICAL\" AND form_factor = \"PHONE\"` * `android_details.build_type = \"userdebug\"` * `availability.capacity = \"HIGH\"`", "location": "query" } }, "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/devices", "path": "v1/{+parent}/devices", "response": { "$ref": "CatalogListDevicesResponse" }, "description": "Lists all devices.", "id": "devicerun.projects.locations.devices.list", "parameterOrder": [ "parent" ] }, "get": { "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "location": "path", "required": true, "pattern": "^projects/[^/]+/locations/[^/]+/devices/[^/]+$", "description": "Required. The name of the device. Format: `projects/{project}/locations/global/devices/{device}`." } }, "path": "v1/{+name}", "id": "devicerun.projects.locations.devices.get", "httpMethod": "GET", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/devices/{devicesId}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Returns information about a specific device.", "response": { "$ref": "CatalogDevice" } } } }, "operations": { "methods": { "delete": { "id": "devicerun.projects.locations.operations.delete", "response": { "$ref": "Empty" }, "description": "Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`.", "path": "v1/{+name}", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "parameters": { "name": { "description": "The name of the operation resource to be deleted.", "type": "string", "required": true, "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "httpMethod": "DELETE", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "list": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations", "parameterOrder": [ "name" ], "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.", "httpMethod": "GET", "path": "v1/{+name}/operations", "response": { "$ref": "GoogleLongrunningListOperationsResponse" }, "id": "devicerun.projects.locations.operations.list", "parameters": { "pageSize": { "description": "The standard list page size.", "location": "query", "type": "integer", "format": "int32" }, "filter": { "type": "string", "location": "query", "description": "The standard list filter." }, "returnPartialSuccess": { "description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.", "type": "boolean", "location": "query" }, "pageToken": { "location": "query", "type": "string", "description": "The standard list page token." }, "name": { "description": "The name of the operation's parent resource.", "required": true, "type": "string", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+$" } } }, "cancel": { "id": "devicerun.projects.locations.operations.cancel", "path": "v1/{+name}:cancel", "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}:cancel", "request": { "$ref": "GoogleLongrunningCancelOperationRequest" }, "description": "Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of `1`, corresponding to `Code.CANCELLED`.", "parameterOrder": [ "name" ], "parameters": { "name": { "type": "string", "required": true, "description": "The name of the operation resource to be cancelled.", "location": "path", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$" } }, "httpMethod": "POST", "response": { "$ref": "Empty" }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ] }, "get": { "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}", "httpMethod": "GET", "path": "v1/{+name}", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" ], "response": { "$ref": "GoogleLongrunningOperation" }, "parameters": { "name": { "description": "The name of the operation resource.", "pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$", "location": "path", "type": "string", "required": true } }, "id": "devicerun.projects.locations.operations.get", "description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.", "parameterOrder": [ "name" ] } } } } } } } }, "auth": { "oauth2": { "scopes": { "https://www.googleapis.com/auth/cloud-platform": { "description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account." } } } }, "parameters": { "alt": { "type": "string", "description": "Data format for response.", "enum": [ "json", "media", "proto" ], "location": "query", "default": "json", "enumDescriptions": [ "Responses with Content-Type of application/json", "Media download with context-dependent Content-Type", "Responses with Content-Type of application/x-protobuf" ] }, "key": { "location": "query", "type": "string", "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token." }, "uploadType": { "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").", "type": "string", "location": "query" }, "fields": { "type": "string", "location": "query", "description": "Selector specifying which fields to include in a partial response." }, "access_token": { "location": "query", "type": "string", "description": "OAuth access token." }, "callback": { "location": "query", "description": "JSONP", "type": "string" }, "quotaUser": { "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.", "location": "query", "type": "string" }, "prettyPrint": { "default": "true", "description": "Returns response with indentations and line breaks.", "type": "boolean", "location": "query" }, "$.xgafv": { "enumDescriptions": [ "v1 error format", "v2 error format" ], "type": "string", "description": "V1 error format.", "location": "query", "enum": [ "1", "2" ] }, "upload_protocol": { "location": "query", "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").", "type": "string" }, "oauth_token": { "location": "query", "type": "string", "description": "OAuth 2.0 token for the current user." } }, "name": "devicerun", "schemas": { "ListLocationsResponse": { "description": "The response message for Locations.ListLocations.", "id": "ListLocationsResponse", "properties": { "nextPageToken": { "type": "string", "description": "The standard List next-page token." }, "locations": { "type": "array", "description": "A list of locations that matches the specified filter in the request.", "items": { "$ref": "Location" } } }, "type": "object" }, "CatalogListDevicesResponse": { "properties": { "devices": { "items": { "$ref": "CatalogDevice" }, "description": "The list of devices.", "type": "array" }, "nextPageToken": { "description": "Token to receive the next page of devices. This will be absent if the end of the response list has been reached.", "type": "string" } }, "description": "Response including listed devices.", "type": "object", "id": "CatalogListDevicesResponse" }, "CatalogScreenMetrics": { "id": "CatalogScreenMetrics", "type": "object", "description": "Screen measurements of a device.", "properties": { "widthPx": { "description": "Output only. Width in pixels.", "format": "int32", "readOnly": true, "type": "integer" }, "heightPx": { "format": "int32", "type": "integer", "description": "Output only. Height in pixels.", "readOnly": true }, "densityDpi": { "description": "Output only. Pixel density in dots per inch (dpi).", "format": "int32", "readOnly": true, "type": "integer" } } }, "CatalogSupportedProduct": { "properties": { "automation": { "$ref": "CatalogAutomationSupport", "description": "Output only. Represents Automation, which is DeviceRun-backed automated test execution.", "readOnly": true }, "deviceStreaming": { "readOnly": true, "description": "Output only. Represents DeviceStreaming, which is interactive remote device streaming.", "$ref": "CatalogDeviceStreamingSupport" } }, "id": "CatalogSupportedProduct", "type": "object", "description": "Declares that a device supports a given Device Cloud product, with optional per-product metadata. Discriminated by which product-specific message is set; adding a new product = new oneof arm + new per-product message." }, "GoogleRpcStatus": { "description": "The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors).", "properties": { "code": { "type": "integer", "description": "The status code, which should be an enum value of google.rpc.Code.", "format": "int32" }, "details": { "description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.", "items": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object" }, "type": "array" }, "message": { "type": "string", "description": "A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client." } }, "type": "object", "id": "GoogleRpcStatus" }, "Empty": { "description": "A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }", "id": "Empty", "type": "object", "properties": {} }, "CatalogXcodeDetails": { "description": "Xcode-specific attributes.", "id": "CatalogXcodeDetails", "properties": { "supportedIosVersions": { "items": { "type": "string" }, "type": "array", "description": "Output only. Lists the iOS versions this Xcode can run tests against, e.g. \"16.6\". This is a property of the toolchain, so it says nothing about whether a device on that iOS version is available; list the `Device` collection to find out.", "readOnly": true } }, "type": "object" }, "CatalogIosDeviceDetails": { "properties": {}, "description": "iOS-specific device attributes. Reserved for future iOS-only fields.", "type": "object", "id": "CatalogIosDeviceDetails" }, "Date": { "type": "object", "properties": { "month": { "description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.", "format": "int32", "type": "integer" }, "year": { "description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.", "format": "int32", "type": "integer" }, "day": { "format": "int32", "description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.", "type": "integer" } }, "id": "Date", "description": "Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp" }, "Location": { "description": "A resource that represents a Google Cloud location.", "type": "object", "properties": { "labels": { "type": "object", "description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}", "additionalProperties": { "type": "string" } }, "locationId": { "type": "string", "description": "The canonical id for this location. For example: `\"us-east1\"`." }, "name": { "description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`", "type": "string" }, "displayName": { "description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".", "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "description": "Service-specific metadata. For example the available capacity at the given location." } }, "id": "Location" }, "CatalogDevice": { "type": "object", "properties": { "androidDetails": { "readOnly": true, "$ref": "CatalogAndroidDeviceDetails", "description": "Output only. Contains Android-specific attributes (set when platform == ANDROID)." }, "name": { "type": "string", "description": "Identifier. Identifies the device resource. Format: `projects/{project}/locations/{location}/devices/{device}`. The {device} segment is an opaque, stable string. Clients must not parse it to derive or assume device-specific details." }, "primaryScreen": { "description": "Output only. Measurements of the primary device screen. Informational only. Unset for devices without a screen (e.g. some wearables).", "readOnly": true, "$ref": "CatalogScreenMetrics" }, "lifecycle": { "readOnly": true, "$ref": "CatalogLifecycle", "description": "Output only. The device lifecycle (maturity stage and removal date)." }, "modelCode": { "readOnly": true, "description": "Output only. Provides a human-readable model identifier for this device, independent of OS version. May be empty. Platform-dependent: * Android physical: hardware codename (android.os.Build.DEVICE), e.g. \"shiba\". * Android virtual: AVD model identifier, e.g. \"MediumPhone.arm\". * iOS: model identifier, e.g. \"iphone14pro\".", "type": "string" }, "supportedProducts": { "description": "Output only. Products/Services supported by this device.", "type": "array", "readOnly": true, "items": { "$ref": "CatalogSupportedProduct" } }, "labInfo": { "description": "Output only. The lab hosting this device.", "readOnly": true, "$ref": "CatalogLabInfo" }, "availability": { "$ref": "CatalogDeviceAvailability", "description": "Output only. Reports the current fleet availability for this device configuration.", "readOnly": true }, "manufacturer": { "readOnly": true, "description": "Output only. Specifies the hardware manufacturer of the device.", "type": "string" }, "accessDeniedReasons": { "items": { "type": "string", "enum": [ "ACCESS_DENIED_REASON_UNSPECIFIED", "EULA_NOT_ACCEPTED" ], "enumDescriptions": [ "Reason not specified.", "The device is hosted in a partner lab whose end user license agreement the project has not accepted." ] }, "type": "array", "readOnly": true, "description": "Output only. Reasons for access denial. This model is accessible/usable if this list is empty, otherwise the model is viewable only." }, "iosDetails": { "readOnly": true, "$ref": "CatalogIosDeviceDetails", "description": "Output only. Contains iOS-specific attributes (set when platform == IOS)." }, "osVersion": { "description": "Output only. Specifies the OS version, e.g. \"30\" (Android API level) or \"17.4\" (iOS).", "readOnly": true, "type": "string" }, "formFactor": { "enum": [ "FORM_FACTOR_UNSPECIFIED", "PHONE", "TABLET", "WEARABLE", "TV" ], "readOnly": true, "type": "string", "enumDescriptions": [ "Form factor not specified.", "Phone.", "Tablet.", "Wearable (e.g. watch).", "TV." ], "description": "Output only. Specifies the form factor of the device." }, "labels": { "description": "Output only. Additional information. Informational only. May change over the lifecycle of a device.", "type": "object", "readOnly": true, "additionalProperties": { "type": "string" } }, "platform": { "type": "string", "enumDescriptions": [ "Platform not specified.", "Android.", "iOS." ], "enum": [ "PLATFORM_UNSPECIFIED", "ANDROID", "IOS" ], "description": "Output only. Specifies the platform of the device.", "readOnly": true }, "displayName": { "readOnly": true, "type": "string", "description": "Output only. Provides a human-readable display name, e.g. \"Pixel 5\"." }, "hardwareType": { "enum": [ "HARDWARE_TYPE_UNSPECIFIED", "PHYSICAL", "VIRTUAL" ], "readOnly": true, "type": "string", "description": "Output only. Indicates whether the device is physical or virtual.", "enumDescriptions": [ "Hardware type not specified.", "Physical hardware device.", "Virtual device (emulator / simulator)." ] } }, "description": "A single routable device configuration in the catalog.", "id": "CatalogDevice" }, "CatalogLabInfo": { "description": "The lab hosting a device.", "type": "object", "id": "CatalogLabInfo", "properties": { "regionCode": { "readOnly": true, "description": "Output only. The Unicode country/region code (CLDR) of the lab where the device is hosted, e.g. \"US\" for United States, \"KR\" for South Korea. Empty when the hosting region is not published.", "type": "string" }, "displayName": { "type": "string", "readOnly": true, "description": "Output only. Display name of the lab where the device is hosted. If empty, the device is hosted in a Google owned lab." } } }, "GoogleLongrunningListOperationsResponse": { "description": "The response message for Operations.ListOperations.", "type": "object", "properties": { "unreachable": { "items": { "type": "string" }, "type": "array", "description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations." }, "operations": { "type": "array", "description": "A list of operations that matches the specified filter in the request.", "items": { "$ref": "GoogleLongrunningOperation" } }, "nextPageToken": { "description": "The standard List next-page token.", "type": "string" } }, "id": "GoogleLongrunningListOperationsResponse" }, "CatalogDeviceAvailability": { "properties": { "capacity": { "enumDescriptions": [ "The value of device capacity is unknown or unset.", "No online devices of this configuration. These devices are unavailable either temporarily or permanently and should not be requested. If the device is also marked as deprecated, this state is very likely permanent.", "Devices that are low in capacity (the lab has a small number of these devices). These devices may be used if users need to test on this specific device model and version. Please note that due to low capacity, the tests may take much longer to finish, especially if a large number of tests are invoked at once. These devices are not suitable for test sharding.", "Devices that are medium in capacity (the lab has a decent number of these devices, though not as many as high capacity devices). These devices are suitable for fewer test runs (e.g. fewer than 100 tests) and only for low shard counts (e.g. less than 10 shards).", "Devices that are high in capacity (the lab has a large number of these devices). These devices are generally suggested for running a large number of simultaneous tests (e.g. more than 100 tests). Please note that high capacity devices do not guarantee short wait times due to several factors: 1. Traffic (how heavily they are used at any given moment). 2. High capacity devices are prioritized for certain usages, which may cause user tests to be slower than selecting other similar device types." ], "enum": [ "CAPACITY_UNSPECIFIED", "CAPACITY_NONE", "CAPACITY_LOW", "CAPACITY_MEDIUM", "CAPACITY_HIGH" ], "readOnly": true, "description": "Output only. Specifies the current capacity bucket for this device configuration. Represents the total number of online devices (idle or in use).", "type": "string" }, "available": { "readOnly": true, "type": "string", "enumDescriptions": [ "The value of availability is unknown or unset.", "No devices of this configuration are currently idle. A request can still be made, but it will queue until a device frees up. Expect longer wait times, and avoid requesting many devices at once (e.g. high shard counts).", "A small number of devices are currently idle. Suitable for a few concurrent requests. Larger bursts (e.g. many shards) may queue until devices free up.", "A moderate number of devices are currently idle. Suitable for a moderate number of concurrent requests. Very large bursts may still queue.", "Many devices are currently idle. Suitable for a large number of concurrent requests with little to no queueing at the moment of observation." ], "enum": [ "AVAILABILITY_UNSPECIFIED", "AVAILABILITY_NONE", "AVAILABILITY_LOW", "AVAILABILITY_MEDIUM", "AVAILABILITY_HIGH" ], "description": "Output only. Specifies the current availability bucket (idle, immediately allocatable devices) for this device configuration. This is a best-effort snapshot, refreshed periodically. It fluctuates depending on traffic as other requests allocate devices." } }, "type": "object", "id": "CatalogDeviceAvailability", "description": "Fleet availability for a device configuration." }, "GoogleLongrunningOperation": { "properties": { "response": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object", "description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`." }, "error": { "$ref": "GoogleRpcStatus", "description": "The error result of the operation in case of failure or cancellation." }, "name": { "type": "string", "description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`." }, "metadata": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, "type": "object", "description": "Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any." }, "done": { "type": "boolean", "description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available." } }, "type": "object", "description": "This resource represents a long-running operation that is the result of a network API call.", "id": "GoogleLongrunningOperation" }, "CatalogAutomationSupport": { "type": "object", "description": "Per-product metadata for the Automation (DeviceRun) product.", "properties": {}, "id": "CatalogAutomationSupport" }, "CatalogSoftwareVersion": { "id": "CatalogSoftwareVersion", "type": "object", "description": "A single software version in the catalog.", "properties": { "isDefault": { "type": "boolean", "readOnly": true, "description": "Output only. Indicates whether the system uses this version when a request does not select one explicitly. Exactly one version per `software_type` is the default, and it may change over time." }, "androidxTestOrchestratorDetails": { "description": "Output only. Contains AndroidX Test Orchestrator-specific attributes (set when software_type == ANDROIDX_TEST_ORCHESTRATOR).", "readOnly": true, "$ref": "CatalogAndroidxTestOrchestratorDetails" }, "version": { "readOnly": true, "description": "Output only. Specifies the version identifier, e.g. \"1.4.1\". Unique within a `software_type`.", "type": "string" }, "displayName": { "readOnly": true, "description": "Output only. Provides a human-readable name for this version, e.g. \"AndroidX Test Orchestrator 1.4.1\".", "type": "string" }, "lifecycle": { "readOnly": true, "$ref": "CatalogLifecycle", "description": "Output only. The version lifecycle (maturity stage and removal date)." }, "softwareType": { "type": "string", "description": "Output only. Specifies which software this is a version of. Filter on this field to narrow the collection to a single kind of software, for example `software_type = \"ANDROIDX_TEST_ORCHESTRATOR\"`.", "enumDescriptions": [ "Software type not specified.", "AndroidX Test Orchestrator, which runs each Android instrumentation test case in its own process.", "Apple Xcode, the toolchain that builds and runs iOS XCTests." ], "enum": [ "SOFTWARE_TYPE_UNSPECIFIED", "ANDROIDX_TEST_ORCHESTRATOR", "XCODE" ], "readOnly": true }, "name": { "description": "Identifier. Identifies the software version resource. Format: `projects/{project}/locations/{location}/softwareVersions/{software_version}`. The {software_version} segment is an opaque, stable string. Clients must not parse it to derive or assume the version.", "type": "string" }, "xcodeDetails": { "description": "Output only. Contains Xcode-specific attributes (set when software_type == XCODE).", "$ref": "CatalogXcodeDetails", "readOnly": true } } }, "GoogleLongrunningCancelOperationRequest": { "description": "The request message for Operations.CancelOperation.", "type": "object", "properties": {}, "id": "GoogleLongrunningCancelOperationRequest" }, "CatalogDeviceStreamingSupport": { "description": "Per-product metadata for the DeviceStreaming product.", "type": "object", "properties": { "minimumAndroidStudioVersion": { "type": "string", "description": "Output only. Specifies the minimum Android Studio version that supports this device. Optional; only set when the device is known to work only at or above a certain Android Studio version. Expected format \"major.minor.micro.patch\", e.g. \"5921.22.2211.8881706\".", "readOnly": true } }, "id": "CatalogDeviceStreamingSupport" }, "CatalogAndroidxTestOrchestratorDetails": { "id": "CatalogAndroidxTestOrchestratorDetails", "description": "AndroidX Test Orchestrator-specific attributes. Reserved for future orchestrator-only fields.", "type": "object", "properties": {} }, "CatalogListSoftwareVersionsResponse": { "properties": { "nextPageToken": { "type": "string", "description": "Token to receive the next page of software versions. This will be absent if the end of the response list has been reached." }, "softwareVersions": { "type": "array", "items": { "$ref": "CatalogSoftwareVersion" }, "description": "The list of software versions." } }, "description": "Response including listed software versions.", "type": "object", "id": "CatalogListSoftwareVersionsResponse" }, "CatalogLifecycle": { "description": "Catalog resource lifecycle: maturity state plus key lifecycle dates.", "type": "object", "properties": { "removalDate": { "readOnly": true, "$ref": "Date", "description": "Output only. Specifies the date the resource is scheduled to be removed from the catalog. Only set when `state == DEPRECATED`." }, "state": { "enumDescriptions": [ "State not specified.", "Early access. This resource may have reduced stability and availability.", "Generally available.", "Still usable, but scheduled for removal." ], "readOnly": true, "description": "Output only. Specifies the current maturity state of the resource.", "type": "string", "enum": [ "STATE_UNSPECIFIED", "PREVIEW", "ACTIVE", "DEPRECATED" ] } }, "id": "CatalogLifecycle" }, "CatalogAndroidDeviceDetails": { "id": "CatalogAndroidDeviceDetails", "description": "Android-specific device attributes.", "properties": { "buildType": { "readOnly": true, "description": "Output only. Mirrors the AOSP `ro.build.type` property, e.g. \"user\", \"userdebug\", \"eng\". Empty if unknown.", "type": "string" }, "supportedAbis": { "readOnly": true, "description": "Output only. Lists ABIs supported by the device (android.os.Build.SUPPORTED_ABIS), most preferred first, e.g. \"arm64-v8a\".", "type": "array", "items": { "type": "string" } } }, "type": "object" } }, "basePath": "", "batchPath": "batch", "version": "v1", "description": "The Device Run API allows management, scheduling, and execution of automated sessions and workloads across device catalogs.", "id": "devicerun:v1" }