Managed Service for ClickHouse API, REST: FormatSchema.List

Field

Description

clusterId

string

Required field. ClickHouse cluster ID.

To get a ClickHouse cluster ID, use the ClusterService.List method.

Field

Description

pageSize

string (int64)

The maximum number of results per page to return. If the number of the results is larger than pageSize, the service returns ListFormatSchemasResponse.nextPageToken. You can use it to get the next page of the results in subsequent requests of a format schema list.

pageToken

string

Page token. To get the next page of results, set pageToken to the ListFormatSchemasResponse.nextPageToken returned by the previous format schema list request.

Field

Description

formatSchemas[]

FormatSchema

List of format schemas.

nextPageToken

string

This token allows you to get the next page of results when requesting the format schema list. If the number of the results is larger than ListFormatSchemasRequest.pageSize, use the nextPageToken as the value for the ListFormatSchemasRequest.pageToken parameter in the next request. Each subsequent request will have its own nextPageToken to continue paging through the results.

Field

Description

name

string

Format schema name.

clusterId

string

ClickHouse cluster ID.

type

enum (FormatSchemaType)

Schema type. Possible values are the following:

• FORMAT_SCHEMA_TYPE_PROTOBUF - Protobuf data format (including ProtobufSingle).
• FORMAT_SCHEMA_TYPE_CAPNPROTO - Cap'n Proto data format.

• FORMAT_SCHEMA_TYPE_UNSPECIFIED
• FORMAT_SCHEMA_TYPE_PROTOBUF
• FORMAT_SCHEMA_TYPE_CAPNPROTO

uri

string

Link to the file of a format schema in Yandex Object Storage. Managed Service for ClickHouse works only with format schemas imported to Object Storage.