Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Истории успеха
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Доступны в регионе
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • ИИ для бизнеса
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Партнёрская программа
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Истории успеха
  • Документация
  • Блог
Проект Яндекса
© 2025 ТОО «Облачные Сервисы Казахстан»
Yandex Managed Service for Trino
  • Начало работы
  • Справочник Terraform
    • Аутентификация в API
      • Overview
        • Overview
        • Get
        • List
        • Create
        • Update
        • Delete
        • Start
        • Stop
        • ListOperations
  • Квоты и лимиты
  • Управление доступом
  • Правила тарификации
  • Метрики Yandex Monitoring
  • Аудитные логи Audit Trails
  • История изменений

В этой статье:

  • HTTP request
  • Body parameters
  • TrinoConfigSpec
  • CatalogSpec
  • Connector
  • HiveConnector
  • Metastore
  • HiveMetastore
  • FileSystem
  • ExternalS3FileSystem
  • IcebergConnector
  • DeltaLakeConnector
  • PostgresqlConnector
  • PostgresqlConnection
  • OnPremise
  • ConnectionManager
  • ClickhouseConnector
  • ClickhouseConnection
  • OnPremise
  • ConnectionManager
  • TPCHConnector
  • TPCDSConnector
  • OracleConnector
  • OracleConnection
  • OnPremise
  • SQLServerConnector
  • SQLServerConnection
  • OnPremise
  • HudiConnector
  • CoordinatorConfig
  • Resources
  • WorkerConfig
  • WorkerScalePolicy
  • FixedScalePolicy
  • AutoScalePolicy
  • RetryPolicyConfig
  • ExchangeManagerConfig
  • ExchangeManagerStorage
  • AccessControlConfig
  • CatalogAccessRule
  • CatalogAccessRuleMatcher
  • CatalogIds
  • CatalogNames
  • SchemaAccessRule
  • SchemaAccessRuleMatcher
  • SchemaNames
  • TableAccessRule
  • TableAccessRuleMatcher
  • TableNames
  • Column
  • FunctionAccessRule
  • FunctionAccessRuleMatcher
  • FunctionNames
  • ProcedureAccessRule
  • ProcedureAccessRuleMatcher
  • ProcedureNames
  • QueryAccessRule
  • SystemSessionPropertyAccessRule
  • PropertyAccessRuleMatcher
  • PropertyNames
  • CatalogSessionPropertyAccessRule
  • TLSConfig
  • NetworkConfig
  • LoggingConfig
  • MaintenanceWindow
  • WeeklyMaintenanceWindow
  • Response
  • CreateClusterMetadata
  • Status
  • Cluster
  • Monitoring
  • TrinoConfig
  • CoordinatorConfig
  • Resources
  • WorkerConfig
  • WorkerScalePolicy
  • FixedScalePolicy
  • AutoScalePolicy
  • RetryPolicyConfig
  • ExchangeManagerConfig
  • ExchangeManagerStorage
  • AccessControlConfig
  • CatalogAccessRule
  • CatalogAccessRuleMatcher
  • CatalogIds
  • CatalogNames
  • SchemaAccessRule
  • SchemaAccessRuleMatcher
  • SchemaNames
  • TableAccessRule
  • TableAccessRuleMatcher
  • TableNames
  • Column
  • FunctionAccessRule
  • FunctionAccessRuleMatcher
  • FunctionNames
  • ProcedureAccessRule
  • ProcedureAccessRuleMatcher
  • ProcedureNames
  • QueryAccessRule
  • SystemSessionPropertyAccessRule
  • PropertyAccessRuleMatcher
  • PropertyNames
  • CatalogSessionPropertyAccessRule
  • TLSConfig
  • NetworkConfig
  • LoggingConfig
  • MaintenanceWindow
  • WeeklyMaintenanceWindow
  • MaintenanceOperation
  1. Справочник API
  2. REST (англ.)
  3. Cluster
  4. Create

Managed Service for Trino API, REST: Cluster.Create

Статья создана
Yandex Cloud
Обновлена 30 октября 2025 г.
  • HTTP request
  • Body parameters
  • TrinoConfigSpec
  • CatalogSpec
  • Connector
  • HiveConnector
  • Metastore
  • HiveMetastore
  • FileSystem
  • ExternalS3FileSystem
  • IcebergConnector
  • DeltaLakeConnector
  • PostgresqlConnector
  • PostgresqlConnection
  • OnPremise
  • ConnectionManager
  • ClickhouseConnector
  • ClickhouseConnection
  • OnPremise
  • ConnectionManager
  • TPCHConnector
  • TPCDSConnector
  • OracleConnector
  • OracleConnection
  • OnPremise
  • SQLServerConnector
  • SQLServerConnection
  • OnPremise
  • HudiConnector
  • CoordinatorConfig
  • Resources
  • WorkerConfig
  • WorkerScalePolicy
  • FixedScalePolicy
  • AutoScalePolicy
  • RetryPolicyConfig
  • ExchangeManagerConfig
  • ExchangeManagerStorage
  • AccessControlConfig
  • CatalogAccessRule
  • CatalogAccessRuleMatcher
  • CatalogIds
  • CatalogNames
  • SchemaAccessRule
  • SchemaAccessRuleMatcher
  • SchemaNames
  • TableAccessRule
  • TableAccessRuleMatcher
  • TableNames
  • Column
  • FunctionAccessRule
  • FunctionAccessRuleMatcher
  • FunctionNames
  • ProcedureAccessRule
  • ProcedureAccessRuleMatcher
  • ProcedureNames
  • QueryAccessRule
  • SystemSessionPropertyAccessRule
  • PropertyAccessRuleMatcher
  • PropertyNames
  • CatalogSessionPropertyAccessRule
  • TLSConfig
  • NetworkConfig
  • LoggingConfig
  • MaintenanceWindow
  • WeeklyMaintenanceWindow
  • Response
  • CreateClusterMetadata
  • Status
  • Cluster
  • Monitoring
  • TrinoConfig
  • CoordinatorConfig
  • Resources
  • WorkerConfig
  • WorkerScalePolicy
  • FixedScalePolicy
  • AutoScalePolicy
  • RetryPolicyConfig
  • ExchangeManagerConfig
  • ExchangeManagerStorage
  • AccessControlConfig
  • CatalogAccessRule
  • CatalogAccessRuleMatcher
  • CatalogIds
  • CatalogNames
  • SchemaAccessRule
  • SchemaAccessRuleMatcher
  • SchemaNames
  • TableAccessRule
  • TableAccessRuleMatcher
  • TableNames
  • Column
  • FunctionAccessRule
  • FunctionAccessRuleMatcher
  • FunctionNames
  • ProcedureAccessRule
  • ProcedureAccessRuleMatcher
  • ProcedureNames
  • QueryAccessRule
  • SystemSessionPropertyAccessRule
  • PropertyAccessRuleMatcher
  • PropertyNames
  • CatalogSessionPropertyAccessRule
  • TLSConfig
  • NetworkConfig
  • LoggingConfig
  • MaintenanceWindow
  • WeeklyMaintenanceWindow
  • MaintenanceOperation

Creates a Trino Cluster resource.

HTTP requestHTTP request

POST https://trino.api.yandexcloud.kz/managed-trino/v1/clusters

Body parametersBody parameters

{
  "folderId": "string",
  "name": "string",
  "description": "string",
  "labels": "object",
  "trino": {
    "catalogs": [
      {
        "name": "string",
        "connector": {
          // Includes only one of the fields `hive`, `iceberg`, `deltaLake`, `postgresql`, `clickhouse`, `tpch`, `tpcds`, `oracle`, `sqlserver`, `hudi`
          "hive": {
            "metastore": {
              // Includes only one of the fields `hive`
              "hive": {
                // Includes only one of the fields `uri`
                "uri": "string"
                // end of the list of possible fields
              }
              // end of the list of possible fields
            },
            "filesystem": {
              // Includes only one of the fields `s3`, `externalS3`
              "s3": "object",
              "externalS3": {
                "awsAccessKey": "string",
                "awsSecretKey": "string",
                "awsEndpoint": "string",
                "awsRegion": "string"
              }
              // end of the list of possible fields
            },
            "additionalProperties": "object"
          },
          "iceberg": {
            "metastore": {
              // Includes only one of the fields `hive`
              "hive": {
                // Includes only one of the fields `uri`
                "uri": "string"
                // end of the list of possible fields
              }
              // end of the list of possible fields
            },
            "filesystem": {
              // Includes only one of the fields `s3`, `externalS3`
              "s3": "object",
              "externalS3": {
                "awsAccessKey": "string",
                "awsSecretKey": "string",
                "awsEndpoint": "string",
                "awsRegion": "string"
              }
              // end of the list of possible fields
            },
            "additionalProperties": "object"
          },
          "deltaLake": {
            "metastore": {
              // Includes only one of the fields `hive`
              "hive": {
                // Includes only one of the fields `uri`
                "uri": "string"
                // end of the list of possible fields
              }
              // end of the list of possible fields
            },
            "filesystem": {
              // Includes only one of the fields `s3`, `externalS3`
              "s3": "object",
              "externalS3": {
                "awsAccessKey": "string",
                "awsSecretKey": "string",
                "awsEndpoint": "string",
                "awsRegion": "string"
              }
              // end of the list of possible fields
            },
            "additionalProperties": "object"
          },
          "postgresql": {
            "connection": {
              // Includes only one of the fields `onPremise`, `connectionManager`
              "onPremise": {
                "connectionUrl": "string",
                "userName": "string",
                "password": "string"
              },
              "connectionManager": {
                "connectionId": "string",
                "database": "string",
                "connectionProperties": "object"
              }
              // end of the list of possible fields
            },
            "additionalProperties": "object"
          },
          "clickhouse": {
            "connection": {
              // Includes only one of the fields `onPremise`, `connectionManager`
              "onPremise": {
                "connectionUrl": "string",
                "userName": "string",
                "password": "string"
              },
              "connectionManager": {
                "connectionId": "string",
                "database": "string",
                "connectionProperties": "object"
              }
              // end of the list of possible fields
            },
            "additionalProperties": "object"
          },
          "tpch": {
            "additionalProperties": "object"
          },
          "tpcds": {
            "additionalProperties": "object"
          },
          "oracle": {
            "connection": {
              // Includes only one of the fields `onPremise`
              "onPremise": {
                "connectionUrl": "string",
                "userName": "string",
                "password": "string"
              }
              // end of the list of possible fields
            },
            "additionalProperties": "object"
          },
          "sqlserver": {
            "connection": {
              // Includes only one of the fields `onPremise`
              "onPremise": {
                "connectionUrl": "string",
                "userName": "string",
                "password": "string"
              }
              // end of the list of possible fields
            },
            "additionalProperties": "object"
          },
          "hudi": {
            "metastore": {
              // Includes only one of the fields `hive`
              "hive": {
                // Includes only one of the fields `uri`
                "uri": "string"
                // end of the list of possible fields
              }
              // end of the list of possible fields
            },
            "filesystem": {
              // Includes only one of the fields `s3`, `externalS3`
              "s3": "object",
              "externalS3": {
                "awsAccessKey": "string",
                "awsSecretKey": "string",
                "awsEndpoint": "string",
                "awsRegion": "string"
              }
              // end of the list of possible fields
            },
            "additionalProperties": "object"
          }
          // end of the list of possible fields
        },
        "description": "string",
        "labels": "object"
      }
    ],
    "coordinatorConfig": {
      "resources": {
        "resourcePresetId": "string"
      }
    },
    "workerConfig": {
      "resources": {
        "resourcePresetId": "string"
      },
      "scalePolicy": {
        // Includes only one of the fields `fixedScale`, `autoScale`
        "fixedScale": {
          "count": "string"
        },
        "autoScale": {
          "minCount": "string",
          "maxCount": "string"
        }
        // end of the list of possible fields
      }
    },
    "retryPolicy": {
      "policy": "string",
      "exchangeManager": {
        "additionalProperties": "object",
        "storage": {
          // Includes only one of the fields `serviceS3`
          "serviceS3": "object"
          // end of the list of possible fields
        }
      },
      "additionalProperties": "object"
    },
    "version": "string",
    "accessControl": {
      "catalogs": [
        {
          "users": [
            "string"
          ],
          "groups": [
            "string"
          ],
          "catalog": {
            // Includes only one of the fields `nameRegexp`, `ids`, `names`
            "nameRegexp": "string",
            "ids": {
              "any": [
                "string"
              ]
            },
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "permission": "string",
          "description": "string"
        }
      ],
      "schemas": [
        {
          "users": [
            "string"
          ],
          "groups": [
            "string"
          ],
          "catalog": {
            // Includes only one of the fields `nameRegexp`, `ids`, `names`
            "nameRegexp": "string",
            "ids": {
              "any": [
                "string"
              ]
            },
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "schema": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "owner": "string",
          "description": "string"
        }
      ],
      "tables": [
        {
          "users": [
            "string"
          ],
          "groups": [
            "string"
          ],
          "catalog": {
            // Includes only one of the fields `nameRegexp`, `ids`, `names`
            "nameRegexp": "string",
            "ids": {
              "any": [
                "string"
              ]
            },
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "schema": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "table": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "privileges": [
            "string"
          ],
          "columns": [
            {
              "name": "string",
              "access": "string",
              "mask": "string"
            }
          ],
          "filter": "string",
          "description": "string"
        }
      ],
      "functions": [
        {
          "users": [
            "string"
          ],
          "groups": [
            "string"
          ],
          "catalog": {
            // Includes only one of the fields `nameRegexp`, `ids`, `names`
            "nameRegexp": "string",
            "ids": {
              "any": [
                "string"
              ]
            },
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "schema": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "function": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "privileges": [
            "string"
          ],
          "description": "string"
        }
      ],
      "procedures": [
        {
          "users": [
            "string"
          ],
          "groups": [
            "string"
          ],
          "catalog": {
            // Includes only one of the fields `nameRegexp`, `ids`, `names`
            "nameRegexp": "string",
            "ids": {
              "any": [
                "string"
              ]
            },
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "schema": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "procedure": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "privileges": [
            "string"
          ],
          "description": "string"
        }
      ],
      "queries": [
        {
          "users": [
            "string"
          ],
          "groups": [
            "string"
          ],
          "queryOwners": [
            "string"
          ],
          "privileges": [
            "string"
          ],
          "description": "string"
        }
      ],
      "systemSessionProperties": [
        {
          "users": [
            "string"
          ],
          "groups": [
            "string"
          ],
          "property": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "allow": "string",
          "description": "string"
        }
      ],
      "catalogSessionProperties": [
        {
          "users": [
            "string"
          ],
          "groups": [
            "string"
          ],
          "catalog": {
            // Includes only one of the fields `nameRegexp`, `ids`, `names`
            "nameRegexp": "string",
            "ids": {
              "any": [
                "string"
              ]
            },
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "property": {
            // Includes only one of the fields `nameRegexp`, `names`
            "nameRegexp": "string",
            "names": {
              "any": [
                "string"
              ]
            }
            // end of the list of possible fields
          },
          "allow": "string",
          "description": "string"
        }
      ]
    },
    "tls": {
      "trustedCertificates": [
        "string"
      ]
    }
  },
  "network": {
    "subnetIds": [
      "string"
    ],
    "securityGroupIds": [
      "string"
    ]
  },
  "deletionProtection": "boolean",
  "serviceAccountId": "string",
  "logging": {
    "enabled": "boolean",
    // Includes only one of the fields `folderId`, `logGroupId`
    "folderId": "string",
    "logGroupId": "string",
    // end of the list of possible fields
    "minLevel": "string"
  },
  "maintenanceWindow": {
    // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
    "anytime": "object",
    "weeklyMaintenanceWindow": {
      "day": "string",
      "hour": "string"
    }
    // end of the list of possible fields
  }
}

Field

Description

folderId

string

Required field. ID of the folder to create Trino cluster in.

name

string

Required field. Name of the Trino cluster. The name must be unique within the folder.

description

string

Description of the Trino cluster.

labels

object (map<string, string>)

Custom labels for the Trino cluster as key:value pairs.
For example: {"env": "prod"}.

trino

TrinoConfigSpec

Required field. Configuration of Trino components.

network

NetworkConfig

Required field. Network related configuration options.

deletionProtection

boolean

Deletion Protection inhibits deletion of the cluster.

serviceAccountId

string

Required field. Service account used to access Cloud resources.

logging

LoggingConfig

Cloud logging configuration.

maintenanceWindow

MaintenanceWindow

Window of maintenance operations.

TrinoConfigSpecTrinoConfigSpec

Field

Description

catalogs[]

CatalogSpec

List of catalogs that enable integration with various data sources.
Each catalog defines a connection to an external data source that Trino can query.

coordinatorConfig

CoordinatorConfig

Required field. Configuration for the coordinator, specifying computational resources and other settings.

workerConfig

WorkerConfig

Required field. Configuration for worker nodes, including scaling policy and computational resources.

retryPolicy

RetryPolicyConfig

Configuration for retry policy, specifying the spooling storage destination and other settings.

version

string

Trino version.
Format: "Number".

accessControl

AccessControlConfig

Configuration for access control, specifying the fine-grained access rules.

tls

TLSConfig

Configuration for TLS.

CatalogSpecCatalogSpec

CatalogSpec defines the desired state of a new catalog.

Field

Description

name

string

Required field. Name of the catalog.
Must be unique within a Trino cluster.

connector

Connector

Required field. Connector backing this catalog.

description

string

Description of the catalog.

labels

object (map<string, string>)

Labels associated with the catalog.

ConnectorConnector

Connector configuration. Exactly one connector type must be specified.

Field

Description

hive

HiveConnector

Hive connector configuration.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

iceberg

IcebergConnector

Iceberg connector configuration.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

deltaLake

DeltaLakeConnector

Delta Lake connector configuration.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

postgresql

PostgresqlConnector

PostgreSQL connector configuration.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

clickhouse

ClickhouseConnector

ClickHouse connector configuration.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

tpch

TPCHConnector

TPC-H connector for synthetic benchmarking.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

tpcds

TPCDSConnector

TPC-DS connector for synthetic benchmarking.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

oracle

OracleConnector

Oracle connector configuration for connecting to Oracle Database instances.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

sqlserver

SQLServerConnector

SQLServer connector configuration for connecting to SQLServer Database instances.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

hudi

HudiConnector

Hudi connector configuration.

Includes only one of the fields hive, iceberg, deltaLake, postgresql, clickhouse, tpch, tpcds, oracle, sqlserver, hudi.

HiveConnectorHiveConnector

Field

Description

metastore

Metastore

Required field. Metastore configuration.

filesystem

FileSystem

Required field. File system configuration.

additionalProperties

object (map<string, string>)

Additional properties.

MetastoreMetastore

Metastore configuration.

Field

Description

hive

HiveMetastore

Includes only one of the fields hive.

HiveMetastoreHiveMetastore

Configuration of Hive's metastore type.

Field

Description

uri

string

URI or cluster ID of the Hive Metastore.

Includes only one of the fields uri.

FileSystemFileSystem

Configuration of file system used by a connector.

Field

Description

s3

object

Includes only one of the fields s3, externalS3.

externalS3

ExternalS3FileSystem

Includes only one of the fields s3, externalS3.

ExternalS3FileSystemExternalS3FileSystem

Describes External S3 compatible file system.

Field

Description

awsAccessKey

string

Required field.

awsSecretKey

string

Required field.

awsEndpoint

string

Required field.

awsRegion

string

Required field.

IcebergConnectorIcebergConnector

Field

Description

metastore

Metastore

Required field. Metastore configuration.

filesystem

FileSystem

Required field. File system configuration.

additionalProperties

object (map<string, string>)

Additional properties.

DeltaLakeConnectorDeltaLakeConnector

Field

Description

metastore

Metastore

Required field. Metastore configuration.

filesystem

FileSystem

Required field. File system configuration.

additionalProperties

object (map<string, string>)

Additional properties.

PostgresqlConnectorPostgresqlConnector

Field

Description

connection

PostgresqlConnection

Connection configuration.

additionalProperties

object (map<string, string>)

Additional properties.

PostgresqlConnectionPostgresqlConnection

Field

Description

onPremise

OnPremise

Includes only one of the fields onPremise, connectionManager.

connectionManager

ConnectionManager

Includes only one of the fields onPremise, connectionManager.

OnPremiseOnPremise

Field

Description

connectionUrl

string

Required field. Connection to the Postgresql.

userName

string

Required field. Name of the Postgresql user.

password

string

Required field. Password of the Postgresql user.

ConnectionManagerConnectionManager

Field

Description

connectionId

string

Required field. Connection ID.

database

string

Required field. Database.

connectionProperties

object (map<string, string>)

Additional connection properties.

ClickhouseConnectorClickhouseConnector

Field

Description

connection

ClickhouseConnection

Connection configuration.

additionalProperties

object (map<string, string>)

Additional properties.

ClickhouseConnectionClickhouseConnection

Field

Description

onPremise

OnPremise

Includes only one of the fields onPremise, connectionManager.

connectionManager

ConnectionManager

Includes only one of the fields onPremise, connectionManager.

OnPremiseOnPremise

Field

Description

connectionUrl

string

Required field. Connection to the Clickhouse.

userName

string

Required field. Name of the Clickhouse user.

password

string

Required field. Password of the Clickhouse user.

ConnectionManagerConnectionManager

Field

Description

connectionId

string

Required field. Connection ID.

database

string

Required field. Database.

connectionProperties

object (map<string, string>)

Additional connection properties.

TPCHConnectorTPCHConnector

Field

Description

additionalProperties

object (map<string, string>)

Additional properties.

TPCDSConnectorTPCDSConnector

Field

Description

additionalProperties

object (map<string, string>)

Additional properties.

OracleConnectorOracleConnector

Field

Description

connection

OracleConnection

Connection configuration.

additionalProperties

object (map<string, string>)

Additional properties.

OracleConnectionOracleConnection

Field

Description

onPremise

OnPremise

Includes only one of the fields onPremise.

OnPremiseOnPremise

Field

Description

connectionUrl

string

Required field. Connection to the Oracle.

userName

string

Required field. Name of the Oracle user.

password

string

Required field. Password of the Oracle user.

SQLServerConnectorSQLServerConnector

Field

Description

connection

SQLServerConnection

Connection configuration.

additionalProperties

object (map<string, string>)

Additional properties.

SQLServerConnectionSQLServerConnection

Field

Description

onPremise

OnPremise

Includes only one of the fields onPremise.

OnPremiseOnPremise

Field

Description

connectionUrl

string

Required field. Connection to the SQLServer.

userName

string

Required field. Name of the SQLServer user.

password

string

Required field. Password of the SQLServer user.

HudiConnectorHudiConnector

Field

Description

metastore

Metastore

Required field. Metastore configuration.

filesystem

FileSystem

Required field. File system configuration.

additionalProperties

object (map<string, string>)

Additional properties.

CoordinatorConfigCoordinatorConfig

Field

Description

resources

Resources

Required field. Configuration for computational resources assigned to the coordinator instance.

ResourcesResources

Field

Description

resourcePresetId

string

Required field. ID of the preset for computational resources allocated to a instance (e.g., CPU, memory, etc.).

WorkerConfigWorkerConfig

Field

Description

resources

Resources

Required field. Configuration for computational resources for worker instances.

scalePolicy

WorkerScalePolicy

Required field. Configuration for scaling policy for worker instances.

WorkerScalePolicyWorkerScalePolicy

Field

Description

fixedScale

FixedScalePolicy

A fixed scaling policy that specifies a fixed number of worker instances.

Includes only one of the fields fixedScale, autoScale.

Defines the scaling type for worker instances.
Only one type of scaling can be specified at a time.

autoScale

AutoScalePolicy

A scaling policy that dynamically adjusts the number of worker instances
based on the cluster's workload. The system automatically increases or
decreases the number of instances within the defined range.

Includes only one of the fields fixedScale, autoScale.

Defines the scaling type for worker instances.
Only one type of scaling can be specified at a time.

FixedScalePolicyFixedScalePolicy

Field

Description

count

string (int64)

Specifies the number of worker instances.

AutoScalePolicyAutoScalePolicy

Field

Description

minCount

string (int64)

maxCount

string (int64)

RetryPolicyConfigRetryPolicyConfig

Field

Description

policy

enum (RetryPolicy)

Retry policy level.

  • RETRY_POLICY_UNSPECIFIED
  • QUERY
  • TASK

exchangeManager

ExchangeManagerConfig

Configuration for exchange manager.

additionalProperties

object (map<string, string>)

Additional properties.

ExchangeManagerConfigExchangeManagerConfig

Field

Description

additionalProperties

object (map<string, string>)

Additional properties.

storage

ExchangeManagerStorage

ExchangeManagerStorageExchangeManagerStorage

Field

Description

serviceS3

object

Use service side s3 bucket for exchange manager.

Includes only one of the fields serviceS3.

AccessControlConfigAccessControlConfig

Field

Description

catalogs[]

CatalogAccessRule

Catalog access control rules.

schemas[]

SchemaAccessRule

Schema access control rules.

tables[]

TableAccessRule

Table access control rules.

functions[]

FunctionAccessRule

Function access control rules.

procedures[]

ProcedureAccessRule

Procedures access control rules.

queries[]

QueryAccessRule

Queries access control rules.

systemSessionProperties[]

SystemSessionPropertyAccessRule

System session property access control rules.

catalogSessionProperties[]

CatalogSessionPropertyAccessRule

Catalog session property access control rules.

CatalogAccessRuleCatalogAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

permission

enum (Permission)

Required field. Permission granted by the rule.

  • PERMISSION_UNSPECIFIED
  • NONE: Denies all operations on the catalog entities.
  • ALL: Allows all operations on catalog entities.
  • READ_ONLY: Allows only read operations on catalog entities.

description

string

Rule description.

CatalogAccessRuleMatcherCatalogAccessRuleMatcher

Field

Description

nameRegexp

string

Catalog name regexp the rule is applied to.

Includes only one of the fields nameRegexp, ids, names.

ids

CatalogIds

Catalog IDs rule is applied to.

Includes only one of the fields nameRegexp, ids, names.

names

CatalogNames

Catalog names rule is applied to.

Includes only one of the fields nameRegexp, ids, names.

CatalogIdsCatalogIds

Field

Description

any[]

string

CatalogNamesCatalogNames

Field

Description

any[]

string

SchemaAccessRuleSchemaAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

schema

SchemaAccessRuleMatcher

Schema matcher specifying what schemas the rule is applied to.

owner

enum (Owner)

Required field. Ownership granted by the rule.

  • OWNER_UNSPECIFIED
  • NO: User is not considered an owner of the schema.
  • YES: User is considered an owner of the schema.

description

string

Rule description.

SchemaAccessRuleMatcherSchemaAccessRuleMatcher

Field

Description

nameRegexp

string

Schema name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

SchemaNames

Schema names the rule is applied to.

Includes only one of the fields nameRegexp, names.

SchemaNamesSchemaNames

Field

Description

any[]

string

TableAccessRuleTableAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

schema

SchemaAccessRuleMatcher

Schema matcher specifying what schemas the rule is applied to.

table

TableAccessRuleMatcher

Table matcher specifying what tables the rule is applied to.

privileges[]

enum (Privilege)

Permission granted by the rule.

  • PRIVILEGE_UNSPECIFIED
  • SELECT: Allows SELECT statements on the table.
  • INSERT: Allows INSERT statements on the table.
  • DELETE: Allows DELETE statements on the table.
  • UPDATE: Allows UPDATE statements on the table.
  • OWNERSHIP: Allows CREATE, DROP, COMMENT ON and ALTER statements on the table.
  • GRANT_SELECT: Allows SELECT statements on the table while creating view.

columns[]

Column

Column rules.

filter

string

Boolean SQL expression to filter table rows for particular user.

description

string

Rule description.

TableAccessRuleMatcherTableAccessRuleMatcher

Field

Description

nameRegexp

string

Table name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

TableNames

Table names the rule is applied to.

Includes only one of the fields nameRegexp, names.

TableNamesTableNames

Field

Description

any[]

string

ColumnColumn

Field

Description

name

string

Required field. Column name.

access

enum (AccessMode)

Required field. Column access mode.

  • ACCESS_MODE_UNSPECIFIED
  • NONE: Access to column is denied.
  • ALL: Access to column is allowed.

mask

string

SQL expression mask to evaluate instead of original column values.
Mask should have the same type as original column.

FunctionAccessRuleFunctionAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

schema

SchemaAccessRuleMatcher

Schema matcher specifying what schema the rule is applied to.

function

FunctionAccessRuleMatcher

Function matcher specifying what functions the rule is applied to.

privileges[]

enum (Privilege)

Privileges granted by the rule.

  • PRIVILEGE_UNSPECIFIED
  • EXECUTE: Allows to execute the function.
  • GRANT_EXECUTE: Allows to use the function while view creation.
  • OWNERSHIP: Allows to CREATE and DROP the function.

description

string

Rule description.

FunctionAccessRuleMatcherFunctionAccessRuleMatcher

Field

Description

nameRegexp

string

Function name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

FunctionNames

Function names the rule is applied to.

Includes only one of the fields nameRegexp, names.

FunctionNamesFunctionNames

Field

Description

any[]

string

ProcedureAccessRuleProcedureAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

schema

SchemaAccessRuleMatcher

Schema matcher specifying what schema the rule is applied to.

procedure

ProcedureAccessRuleMatcher

Procedure matcher specifying what functions the rule is applied to.

privileges[]

enum (Privilege)

Privileges granted by the rule.

  • PRIVILEGE_UNSPECIFIED
  • EXECUTE: Allows to execute the procedure.

description

string

Rule description.

ProcedureAccessRuleMatcherProcedureAccessRuleMatcher

Field

Description

nameRegexp

string

Procedure name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

ProcedureNames

Procedure names the rule is applied to.

Includes only one of the fields nameRegexp, names.

ProcedureNamesProcedureNames

Field

Description

any[]

string

QueryAccessRuleQueryAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

queryOwners[]

string

Owners of queries the rule is applied to.
Cannot be combined with EXECUTE privilege.

privileges[]

enum (Privilege)

Privileges granted by the user.

  • PRIVILEGE_UNSPECIFIED
  • VIEW: Allows to view the query.
  • EXECUTE: Allows to execute the query.
  • KILL: Allows to kill the query.

description

string

Rule description.

SystemSessionPropertyAccessRuleSystemSessionPropertyAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

property

PropertyAccessRuleMatcher

Property matcher specifying what properties the rule is applied to.

allow

enum (Allow)

Required field. Whether the rule allows setting the property.

  • ALLOW_UNSPECIFIED
  • NO: Denies setting the system session property.
  • YES: Allows to set the system session property.

description

string

Rule description.

PropertyAccessRuleMatcherPropertyAccessRuleMatcher

Field

Description

nameRegexp

string

Property name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

PropertyNames

Property names the rule is applied to.

Includes only one of the fields nameRegexp, names.

PropertyNamesPropertyNames

Field

Description

any[]

string

CatalogSessionPropertyAccessRuleCatalogSessionPropertyAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

property

PropertyAccessRuleMatcher

Property matcher specifying what properties the rule is applied to.

allow

enum (Allow)

Required field. Whether the rule allows setting the property.

  • ALLOW_UNSPECIFIED
  • NO: Denies setting the catalog session property.
  • YES: Allows to set the catalog session property.

description

string

Rule description.

TLSConfigTLSConfig

Field

Description

trustedCertificates[]

string

Trusted CA-certificates. Each element should contain single self-signed CA-certificate or
chain of CA-certificates where first certificate is the leaf and last certificate is the self-signed root.

NetworkConfigNetworkConfig

Field

Description

subnetIds[]

string

IDs of VPC network subnets where instances of the cluster are attached.

securityGroupIds[]

string

User security groups.

LoggingConfigLoggingConfig

Field

Description

enabled

boolean

Logs generated by the Trino components are delivered to Cloud Logging.

folderId

string

Logs should be written to default log group for specified folder.

Includes only one of the fields folderId, logGroupId.

Destination of log records.

logGroupId

string

Logs should be written to log group resolved by ID.

Includes only one of the fields folderId, logGroupId.

Destination of log records.

minLevel

enum (Level)

Minimum log entry level.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

MaintenanceWindowMaintenanceWindow

Field

Description

anytime

object

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weeklyMaintenanceWindow.

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

Field

Description

day

enum (WeekDay)

  • WEEK_DAY_UNSPECIFIED
  • MON
  • TUE
  • WED
  • THU
  • FRI
  • SAT
  • SUN

hour

string (int64)

Hour of the day in UTC.

ResponseResponse

HTTP Code: 200 - OK

{
  "id": "string",
  "description": "string",
  "createdAt": "string",
  "createdBy": "string",
  "modifiedAt": "string",
  "done": "boolean",
  "metadata": {
    "clusterId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": {
    "code": "integer",
    "message": "string",
    "details": [
      "object"
    ]
  },
  "response": {
    "id": "string",
    "folderId": "string",
    "createdAt": "string",
    "name": "string",
    "description": "string",
    "labels": "object",
    "monitoring": [
      {
        "name": "string",
        "description": "string",
        "link": "string"
      }
    ],
    "trino": {
      "coordinatorConfig": {
        "resources": {
          "resourcePresetId": "string"
        }
      },
      "workerConfig": {
        "resources": {
          "resourcePresetId": "string"
        },
        "scalePolicy": {
          // Includes only one of the fields `fixedScale`, `autoScale`
          "fixedScale": {
            "count": "string"
          },
          "autoScale": {
            "minCount": "string",
            "maxCount": "string"
          }
          // end of the list of possible fields
        }
      },
      "version": "string",
      "retryPolicy": {
        "policy": "string",
        "exchangeManager": {
          "additionalProperties": "object",
          "storage": {
            // Includes only one of the fields `serviceS3`
            "serviceS3": "object"
            // end of the list of possible fields
          }
        },
        "additionalProperties": "object"
      },
      "accessControl": {
        "catalogs": [
          {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "catalog": {
              // Includes only one of the fields `nameRegexp`, `ids`, `names`
              "nameRegexp": "string",
              "ids": {
                "any": [
                  "string"
                ]
              },
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "permission": "string",
            "description": "string"
          }
        ],
        "schemas": [
          {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "catalog": {
              // Includes only one of the fields `nameRegexp`, `ids`, `names`
              "nameRegexp": "string",
              "ids": {
                "any": [
                  "string"
                ]
              },
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "schema": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "owner": "string",
            "description": "string"
          }
        ],
        "tables": [
          {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "catalog": {
              // Includes only one of the fields `nameRegexp`, `ids`, `names`
              "nameRegexp": "string",
              "ids": {
                "any": [
                  "string"
                ]
              },
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "schema": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "table": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "privileges": [
              "string"
            ],
            "columns": [
              {
                "name": "string",
                "access": "string",
                "mask": "string"
              }
            ],
            "filter": "string",
            "description": "string"
          }
        ],
        "functions": [
          {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "catalog": {
              // Includes only one of the fields `nameRegexp`, `ids`, `names`
              "nameRegexp": "string",
              "ids": {
                "any": [
                  "string"
                ]
              },
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "schema": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "function": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "privileges": [
              "string"
            ],
            "description": "string"
          }
        ],
        "procedures": [
          {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "catalog": {
              // Includes only one of the fields `nameRegexp`, `ids`, `names`
              "nameRegexp": "string",
              "ids": {
                "any": [
                  "string"
                ]
              },
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "schema": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "procedure": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "privileges": [
              "string"
            ],
            "description": "string"
          }
        ],
        "queries": [
          {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "queryOwners": [
              "string"
            ],
            "privileges": [
              "string"
            ],
            "description": "string"
          }
        ],
        "systemSessionProperties": [
          {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "property": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "allow": "string",
            "description": "string"
          }
        ],
        "catalogSessionProperties": [
          {
            "users": [
              "string"
            ],
            "groups": [
              "string"
            ],
            "catalog": {
              // Includes only one of the fields `nameRegexp`, `ids`, `names`
              "nameRegexp": "string",
              "ids": {
                "any": [
                  "string"
                ]
              },
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "property": {
              // Includes only one of the fields `nameRegexp`, `names`
              "nameRegexp": "string",
              "names": {
                "any": [
                  "string"
                ]
              }
              // end of the list of possible fields
            },
            "allow": "string",
            "description": "string"
          }
        ]
      },
      "tls": {
        "trustedCertificates": [
          "string"
        ]
      }
    },
    "health": "string",
    "status": "string",
    "network": {
      "subnetIds": [
        "string"
      ],
      "securityGroupIds": [
        "string"
      ]
    },
    "deletionProtection": "boolean",
    "serviceAccountId": "string",
    "logging": {
      "enabled": "boolean",
      // Includes only one of the fields `folderId`, `logGroupId`
      "folderId": "string",
      "logGroupId": "string",
      // end of the list of possible fields
      "minLevel": "string"
    },
    "coordinatorUrl": "string",
    "maintenanceWindow": {
      // Includes only one of the fields `anytime`, `weeklyMaintenanceWindow`
      "anytime": "object",
      "weeklyMaintenanceWindow": {
        "day": "string",
        "hour": "string"
      }
      // end of the list of possible fields
    },
    "plannedOperation": {
      "info": "string",
      "delayedUntil": "string",
      "latestMaintenanceTime": "string",
      "nextMaintenanceWindowTime": "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

string (date-time)

Creation timestamp.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

createdBy

string

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

modifiedAt

string (date-time)

The time when the Operation resource was last modified.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

done

boolean

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

CreateClusterMetadata

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

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

Cluster

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.

CreateClusterMetadataCreateClusterMetadata

Field

Description

clusterId

string

ID of the Trino cluster that is being created.

StatusStatus

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

Field

Description

code

integer (int32)

Error code. An enum value of google.rpc.Code.

message

string

An error message.

details[]

object

A list of messages that carry the error details.

ClusterCluster

Trino cluster.

Field

Description

id

string

Unique ID of the Trino cluster.
This ID is assigned by Cloud in the process of creating a Trino cluster.

folderId

string

ID of the folder that the Trino cluster belongs to.

createdAt

string (date-time)

The time when the Trino cluster was created.

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

name

string

Name of the Trino cluster.
The name is unique within the folder. 1-64 characters long.

description

string

Description of the Trino cluster. 0-256 characters long.

labels

object (map<string, string>)

Resource labels as key:value pairs. Maximum of 64 per resource.

monitoring[]

Monitoring

Monitoring systems relevant to the Trino cluster.

trino

TrinoConfig

Configuration of the Trino cluster.

health

enum (Health)

Aggregated cluster health.

  • HEALTH_UNKNOWN: Object is in unknown state (we have no data)
  • ALIVE: Object is alive and well (all hosts are alive)
  • DEAD: Object is inoperable (it cannot perform any of its essential functions)
  • DEGRADED: Object is partially alive (it can perform some of its essential functions)

status

enum (Status)

Cluster status.

  • STATUS_UNKNOWN: Cluster state is unknown.
  • CREATING: Cluster is being created.
  • RUNNING: Cluster is running normally.
  • ERROR: Cluster encountered a problem and cannot operate.
  • STOPPING: Cluster is stopping.
  • STOPPED: Cluster is stopped.
  • STARTING: Cluster is starting.
  • UPDATING: Cluster is being updated.

network

NetworkConfig

Network related configuration options.

deletionProtection

boolean

Deletion Protection inhibits deletion of the cluster.

serviceAccountId

string

Service account used to access Cloud resources.

logging

LoggingConfig

Cloud logging configuration.

coordinatorUrl

string

Address of Trino Coordinator.

maintenanceWindow

MaintenanceWindow

Window of maintenance operations.

plannedOperation

MaintenanceOperation

Maintenance operation planned at nearest maintenance_window.

MonitoringMonitoring

Monitoring system.

Field

Description

name

string

Name of the monitoring system.

description

string

Description of the monitoring system.

link

string

Link to the monitoring system.

TrinoConfigTrinoConfig

Field

Description

coordinatorConfig

CoordinatorConfig

Required field. Configuration for the coordinator, specifying computational resources and other settings.

workerConfig

WorkerConfig

Required field. Configuration for worker nodes, including scaling policy and computational resources.

version

string

Version of Trino.

retryPolicy

RetryPolicyConfig

Configuration for retry policy, specifying the spooling storage destination and other settings.

accessControl

AccessControlConfig

Configuration for access control, specifying the fine-grained rules of accesses.

tls

TLSConfig

Configuration for TLS.

CoordinatorConfigCoordinatorConfig

Field

Description

resources

Resources

Required field. Configuration for computational resources assigned to the coordinator instance.

ResourcesResources

Field

Description

resourcePresetId

string

Required field. ID of the preset for computational resources allocated to a instance (e.g., CPU, memory, etc.).

WorkerConfigWorkerConfig

Field

Description

resources

Resources

Required field. Configuration for computational resources for worker instances.

scalePolicy

WorkerScalePolicy

Required field. Configuration for scaling policy for worker instances.

WorkerScalePolicyWorkerScalePolicy

Field

Description

fixedScale

FixedScalePolicy

A fixed scaling policy that specifies a fixed number of worker instances.

Includes only one of the fields fixedScale, autoScale.

Defines the scaling type for worker instances.
Only one type of scaling can be specified at a time.

autoScale

AutoScalePolicy

A scaling policy that dynamically adjusts the number of worker instances
based on the cluster's workload. The system automatically increases or
decreases the number of instances within the defined range.

Includes only one of the fields fixedScale, autoScale.

Defines the scaling type for worker instances.
Only one type of scaling can be specified at a time.

FixedScalePolicyFixedScalePolicy

Field

Description

count

string (int64)

Specifies the number of worker instances.

AutoScalePolicyAutoScalePolicy

Field

Description

minCount

string (int64)

maxCount

string (int64)

RetryPolicyConfigRetryPolicyConfig

Field

Description

policy

enum (RetryPolicy)

Retry policy level.

  • RETRY_POLICY_UNSPECIFIED
  • QUERY
  • TASK

exchangeManager

ExchangeManagerConfig

Configuration for exchange manager.

additionalProperties

object (map<string, string>)

Additional properties.

ExchangeManagerConfigExchangeManagerConfig

Field

Description

additionalProperties

object (map<string, string>)

Additional properties.

storage

ExchangeManagerStorage

ExchangeManagerStorageExchangeManagerStorage

Field

Description

serviceS3

object

Use service side s3 bucket for exchange manager.

Includes only one of the fields serviceS3.

AccessControlConfigAccessControlConfig

Field

Description

catalogs[]

CatalogAccessRule

Catalog access control rules.

schemas[]

SchemaAccessRule

Schema access control rules.

tables[]

TableAccessRule

Table access control rules.

functions[]

FunctionAccessRule

Function access control rules.

procedures[]

ProcedureAccessRule

Procedures access control rules.

queries[]

QueryAccessRule

Queries access control rules.

systemSessionProperties[]

SystemSessionPropertyAccessRule

System session property access control rules.

catalogSessionProperties[]

CatalogSessionPropertyAccessRule

Catalog session property access control rules.

CatalogAccessRuleCatalogAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

permission

enum (Permission)

Required field. Permission granted by the rule.

  • PERMISSION_UNSPECIFIED
  • NONE: Denies all operations on the catalog entities.
  • ALL: Allows all operations on catalog entities.
  • READ_ONLY: Allows only read operations on catalog entities.

description

string

Rule description.

CatalogAccessRuleMatcherCatalogAccessRuleMatcher

Field

Description

nameRegexp

string

Catalog name regexp the rule is applied to.

Includes only one of the fields nameRegexp, ids, names.

ids

CatalogIds

Catalog IDs rule is applied to.

Includes only one of the fields nameRegexp, ids, names.

names

CatalogNames

Catalog names rule is applied to.

Includes only one of the fields nameRegexp, ids, names.

CatalogIdsCatalogIds

Field

Description

any[]

string

CatalogNamesCatalogNames

Field

Description

any[]

string

SchemaAccessRuleSchemaAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

schema

SchemaAccessRuleMatcher

Schema matcher specifying what schemas the rule is applied to.

owner

enum (Owner)

Required field. Ownership granted by the rule.

  • OWNER_UNSPECIFIED
  • NO: User is not considered an owner of the schema.
  • YES: User is considered an owner of the schema.

description

string

Rule description.

SchemaAccessRuleMatcherSchemaAccessRuleMatcher

Field

Description

nameRegexp

string

Schema name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

SchemaNames

Schema names the rule is applied to.

Includes only one of the fields nameRegexp, names.

SchemaNamesSchemaNames

Field

Description

any[]

string

TableAccessRuleTableAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

schema

SchemaAccessRuleMatcher

Schema matcher specifying what schemas the rule is applied to.

table

TableAccessRuleMatcher

Table matcher specifying what tables the rule is applied to.

privileges[]

enum (Privilege)

Permission granted by the rule.

  • PRIVILEGE_UNSPECIFIED
  • SELECT: Allows SELECT statements on the table.
  • INSERT: Allows INSERT statements on the table.
  • DELETE: Allows DELETE statements on the table.
  • UPDATE: Allows UPDATE statements on the table.
  • OWNERSHIP: Allows CREATE, DROP, COMMENT ON and ALTER statements on the table.
  • GRANT_SELECT: Allows SELECT statements on the table while creating view.

columns[]

Column

Column rules.

filter

string

Boolean SQL expression to filter table rows for particular user.

description

string

Rule description.

TableAccessRuleMatcherTableAccessRuleMatcher

Field

Description

nameRegexp

string

Table name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

TableNames

Table names the rule is applied to.

Includes only one of the fields nameRegexp, names.

TableNamesTableNames

Field

Description

any[]

string

ColumnColumn

Field

Description

name

string

Required field. Column name.

access

enum (AccessMode)

Required field. Column access mode.

  • ACCESS_MODE_UNSPECIFIED
  • NONE: Access to column is denied.
  • ALL: Access to column is allowed.

mask

string

SQL expression mask to evaluate instead of original column values.
Mask should have the same type as original column.

FunctionAccessRuleFunctionAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

schema

SchemaAccessRuleMatcher

Schema matcher specifying what schema the rule is applied to.

function

FunctionAccessRuleMatcher

Function matcher specifying what functions the rule is applied to.

privileges[]

enum (Privilege)

Privileges granted by the rule.

  • PRIVILEGE_UNSPECIFIED
  • EXECUTE: Allows to execute the function.
  • GRANT_EXECUTE: Allows to use the function while view creation.
  • OWNERSHIP: Allows to CREATE and DROP the function.

description

string

Rule description.

FunctionAccessRuleMatcherFunctionAccessRuleMatcher

Field

Description

nameRegexp

string

Function name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

FunctionNames

Function names the rule is applied to.

Includes only one of the fields nameRegexp, names.

FunctionNamesFunctionNames

Field

Description

any[]

string

ProcedureAccessRuleProcedureAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

schema

SchemaAccessRuleMatcher

Schema matcher specifying what schema the rule is applied to.

procedure

ProcedureAccessRuleMatcher

Procedure matcher specifying what functions the rule is applied to.

privileges[]

enum (Privilege)

Privileges granted by the rule.

  • PRIVILEGE_UNSPECIFIED
  • EXECUTE: Allows to execute the procedure.

description

string

Rule description.

ProcedureAccessRuleMatcherProcedureAccessRuleMatcher

Field

Description

nameRegexp

string

Procedure name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

ProcedureNames

Procedure names the rule is applied to.

Includes only one of the fields nameRegexp, names.

ProcedureNamesProcedureNames

Field

Description

any[]

string

QueryAccessRuleQueryAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

queryOwners[]

string

Owners of queries the rule is applied to.
Cannot be combined with EXECUTE privilege.

privileges[]

enum (Privilege)

Privileges granted by the user.

  • PRIVILEGE_UNSPECIFIED
  • VIEW: Allows to view the query.
  • EXECUTE: Allows to execute the query.
  • KILL: Allows to kill the query.

description

string

Rule description.

SystemSessionPropertyAccessRuleSystemSessionPropertyAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

property

PropertyAccessRuleMatcher

Property matcher specifying what properties the rule is applied to.

allow

enum (Allow)

Required field. Whether the rule allows setting the property.

  • ALLOW_UNSPECIFIED
  • NO: Denies setting the system session property.
  • YES: Allows to set the system session property.

description

string

Rule description.

PropertyAccessRuleMatcherPropertyAccessRuleMatcher

Field

Description

nameRegexp

string

Property name regexp the rule is applied to.

Includes only one of the fields nameRegexp, names.

names

PropertyNames

Property names the rule is applied to.

Includes only one of the fields nameRegexp, names.

PropertyNamesPropertyNames

Field

Description

any[]

string

CatalogSessionPropertyAccessRuleCatalogSessionPropertyAccessRule

Field

Description

users[]

string

IAM user IDs the rule is applied to.

groups[]

string

IAM group IDs the rule is applied to.

catalog

CatalogAccessRuleMatcher

Catalog matcher specifying what catalogs the rule is applied to.

property

PropertyAccessRuleMatcher

Property matcher specifying what properties the rule is applied to.

allow

enum (Allow)

Required field. Whether the rule allows setting the property.

  • ALLOW_UNSPECIFIED
  • NO: Denies setting the catalog session property.
  • YES: Allows to set the catalog session property.

description

string

Rule description.

TLSConfigTLSConfig

Field

Description

trustedCertificates[]

string

Trusted CA-certificates. Each element should contain single self-signed CA-certificate or
chain of CA-certificates where first certificate is the leaf and last certificate is the self-signed root.

NetworkConfigNetworkConfig

Field

Description

subnetIds[]

string

IDs of VPC network subnets where instances of the cluster are attached.

securityGroupIds[]

string

User security groups.

LoggingConfigLoggingConfig

Field

Description

enabled

boolean

Logs generated by the Trino components are delivered to Cloud Logging.

folderId

string

Logs should be written to default log group for specified folder.

Includes only one of the fields folderId, logGroupId.

Destination of log records.

logGroupId

string

Logs should be written to log group resolved by ID.

Includes only one of the fields folderId, logGroupId.

Destination of log records.

minLevel

enum (Level)

Minimum log entry level.

See LogLevel.Level for details.

  • LEVEL_UNSPECIFIED: Default log level.

    Equivalent to not specifying log level at all.

  • TRACE: Trace log level.

    Possible use case: verbose logging of some business logic.

  • DEBUG: Debug log level.

    Possible use case: debugging special cases in application logic.

  • INFO: Info log level.

    Mostly used for information messages.

  • WARN: Warn log level.

    May be used to alert about significant events.

  • ERROR: Error log level.

    May be used to alert about errors in infrastructure, logic, etc.

  • FATAL: Fatal log level.

    May be used to alert about unrecoverable failures and events.

MaintenanceWindowMaintenanceWindow

Field

Description

anytime

object

Includes only one of the fields anytime, weeklyMaintenanceWindow.

weeklyMaintenanceWindow

WeeklyMaintenanceWindow

Includes only one of the fields anytime, weeklyMaintenanceWindow.

WeeklyMaintenanceWindowWeeklyMaintenanceWindow

Field

Description

day

enum (WeekDay)

  • WEEK_DAY_UNSPECIFIED
  • MON
  • TUE
  • WED
  • THU
  • FRI
  • SAT
  • SUN

hour

string (int64)

Hour of the day in UTC.

MaintenanceOperationMaintenanceOperation

Field

Description

info

string

delayedUntil

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

latestMaintenanceTime

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

nextMaintenanceWindowTime

string (date-time)

String in RFC3339 text format. The range of possible values is from
0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z, i.e. from 0 to 9 digits for fractions of a second.

To work with values in this field, use the APIs described in the
Protocol Buffers reference.
In some languages, built-in datetime utilities do not support nanosecond precision (9 digits).

Была ли статья полезна?

Предыдущая
List
Следующая
Update
Проект Яндекса
© 2025 ТОО «Облачные Сервисы Казахстан»