Contact UsGet started

Load Testing API, gRPC: ConfigService.Create

Written by
Updated at October 17, 2024

Creates a test config in the specified folder.

gRPC request

rpc Create (CreateConfigRequest) returns (operation.Operation)

CreateConfigRequest

{
  "folderId": "string",
  // Includes only one of the fields `yamlString`
  "yamlString": "string",
  // end of the list of possible fields
  "name": "string"
}

Field

Description

folderId

string

Required field. ID of the folder to create a config in.

yamlString

string

Config content provided as a string in YAML format.

Includes only one of the fields yamlString.

Config content.

name

string

Name of the config.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "configId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "id": "string",
    "folderId": "string",
    "yamlString": "string",
    "name": "string",
    "createdAt": "google.protobuf.Timestamp",
    "createdBy": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

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

CreateConfigMetadata

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.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, 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.

response

Config

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, 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.

CreateConfigMetadata

Field

Description

configId

string

ID of the config that is being created.

Config

Test config.

Field

Description

id

string

ID of the test config. Generated at creation time.

folderId

string

ID of the folder that the config belongs to.

yamlString

string

Config content in YAML format.

name

string

Name of the config.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

UA or SA that created the config.
Previous
Overview
Next
Get