Method: testEnvironmentCatalog.get
Stay organized with collections
Save and categorize content based on your preferences.
Gets the catalog of supported test environments.
May return any of the following canonical error codes:
- INVALID_ARGUMENT - if the request is malformed
- NOT_FOUND - if the environment type does not exist
- INTERNAL - if an internal error occurred
HTTP request
GET https://testing.googleapis.com/v1/testEnvironmentCatalog/{environmentType}
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
environmentType |
enum (EnvironmentType)
Required. The type of environment that should be listed.
|
Query parameters
| Parameters |
projectId |
string
For authorization, the cloud project requesting the TestEnvironmentCatalog.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains an instance of TestEnvironmentCatalog.
Authorization scopes
Requires one of the following OAuth scopes:
https://www.googleapis.com/auth/cloud-platformhttps://www.googleapis.com/auth/cloud-platform.read-only
For more information, see the Authentication Overview.
EnvironmentType
Types of environments the Test API supports.
| Enums |
ENVIRONMENT_TYPE_UNSPECIFIED |
Do not use. For proto versioning only. |
ANDROID |
A device running a version of the Android OS. |
IOS |
A device running a version of iOS. |
NETWORK_CONFIGURATION |
A network configuration to use when running a test. |
PROVIDED_SOFTWARE |
The software environment provided by TestExecutionService. |
DEVICE_IP_BLOCKS |
The IP blocks used by devices in the test environment. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-07-25 UTC.
[null,null,["Last updated 2024-07-25 UTC."],[],[],null,["# Method: testEnvironmentCatalog.get\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n- [Authorization scopes](#body.aspect)\n- [EnvironmentType](#EnvironmentType)\n- [Try it!](#try-it)\n\nGets the catalog of supported test environments.\n\nMay return any of the following canonical error codes:\n\n- INVALID_ARGUMENT - if the request is malformed\n- NOT_FOUND - if the environment type does not exist\n- INTERNAL - if an internal error occurred\n\n### HTTP request\n\n`GET https://testing.googleapis.com/v1/testEnvironmentCatalog/{environmentType}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|-------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `environmentType` | `enum (`[EnvironmentType](/docs/test-lab/reference/testing/rest/v1/testEnvironmentCatalog/get#EnvironmentType)`)` Required. The type of environment that should be listed. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|--------------------------------------------------------------------------------------|\n| `projectId` | `string` For authorization, the cloud project requesting the TestEnvironmentCatalog. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains an instance of [TestEnvironmentCatalog](/docs/test-lab/reference/testing/rest/v1/testEnvironmentCatalog#TestEnvironmentCatalog).\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `https://www.googleapis.com/auth/cloud-platform.read-only`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/).\n\nEnvironmentType\n---------------\n\nTypes of environments the Test API supports.\n\n| Enums ||\n|--------------------------------|------------------------------------------------------------|\n| `ENVIRONMENT_TYPE_UNSPECIFIED` | Do not use. For proto versioning only. |\n| `ANDROID` | A device running a version of the Android OS. |\n| `IOS` | A device running a version of iOS. |\n| `NETWORK_CONFIGURATION` | A network configuration to use when running a test. |\n| `PROVIDED_SOFTWARE` | The software environment provided by TestExecutionService. |\n| `DEVICE_IP_BLOCKS` | The IP blocks used by devices in the test environment. |"]]
