Load Testing API, gRPC: ConfigService
Written by
Updated at March 12, 2024
A set of methods for managing test configurations.
Call | Description |
---|---|
Create | Creates a test config in the specified folder. |
Get | Returns the specified config. |
List | Retrieves the list of configs in the specified folder. |
Delete | Deletes the specified config. |
Calls ConfigService
Create
Creates a test config in the specified folder.
rpc Create (CreateConfigRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:CreateConfigMetadata
Operation.response:config.Config
CreateConfigRequest
Field | Description |
---|---|
folder_id | string Required. ID of the folder to create a config in. The maximum string length in characters is 50. |
config | oneof: yaml_string Config content. |
yaml_string | string Config content provided as a string in YAML format. |
name | string Name of the config. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
CreateConfigMetadata
Field | Description |
---|---|
config_id | string ID of the config that is being created. |
Get
Returns the specified config.
To get the list of all available configs, make a List request.
rpc Get (GetConfigRequest) returns (config.Config)
GetConfigRequest
Field | Description |
---|---|
config_id | string ID of the config to return. |
List
Retrieves the list of configs in the specified folder.
rpc List (ListConfigsRequest) returns (ListConfigsResponse)
ListConfigsRequest
Field | Description |
---|---|
folder_id | string ID of the folder to list configs in. |
page_size | int64 The maximum number of results per page to return. If the number of available results is larger than page_size , the service returns a ListConfigsResponse.next_page_token that can be used to get the next page of results in subsequent list requests. Default value: 100. |
page_token | string Page token. To get the next page of results, set page_token to the ListConfigsResponse.next_page_token returned by a previous list request. |
filter | string A filter expression that filters tests listed in the response. The maximum string length in characters is 1000. |
ListConfigsResponse
Field | Description |
---|---|
configs[] | config.Config List of configs in the specified folder. |
next_page_token | string Token for getting the next page of the list. If the number of results is greater than the specified ListConfigsRequest.page_size, use next_page_token as the value for the ListConfigsRequest.page_token parameter in the next list request. Each subsequent page will have its own next_page_token to continue paging through the results. |
Delete
Deletes the specified config.
rpc Delete (DeleteConfigRequest) returns (operation.Operation)
Metadata and response of Operation:
Operation.metadata:DeleteConfigMetadata
Operation.response:google.protobuf.Empty
DeleteConfigRequest
Field | Description |
---|---|
config_id | string ID of the config to deleted. |
Operation
Field | Description |
---|---|
id | string ID of the operation. |
description | string Description of the operation. 0-256 characters long. |
created_at | google.protobuf.Timestamp Creation timestamp. |
created_by | string ID of the user or service account who initiated the operation. |
modified_at | google.protobuf.Timestamp The time when the Operation resource was last modified. |
done | bool 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. |
metadata | google.protobuf.Any Service-specific metadata associated with the operation. It typically contains the ID of the target resource that the operation is performed on. Any method that returns a long-running operation should document the metadata type, if any. |
result | oneof: error or response The operation result. If done == false and there was no failure detected, neither error nor response is set. If done == false and there was a failure detected, error is set. If done == true , exactly one of error or response is set. |
error | google.rpc.Status The error result of the operation in case of failure or cancellation. |
response | google.protobuf.Any if operation finished successfully. |
DeleteConfigMetadata
Field | Description |
---|---|
config_id | string ID of the config that is being deleted. |