Managed Service for Hive Metastore™ API, gRPC: ClusterService.Update
Updates the configuration of the specified Metastore Cluster.
gRPC request
rpc Update (UpdateClusterRequest) returns (operation.Operation)
UpdateClusterRequest
{
"cluster_id": "string",
"update_mask": "google.protobuf.FieldMask",
"name": "string",
"description": "string",
"labels": "map<string, string>",
"deletion_protection": "bool",
"service_account_id": "string",
"logging": {
// Includes only one of the fields `folder_id`, `log_group_id`
"folder_id": "string",
"log_group_id": "string",
// end of the list of possible fields
"enabled": "bool",
"min_level": "Level"
},
"network_spec": {
"security_group_ids": [
"string"
]
},
"config_spec": {
"resources": {
"resource_preset_id": "string"
},
"warehouse": {
// Includes only one of the fields `s3`
"s3": {
"bucket": "string",
"path": "string"
}
// end of the list of possible fields
}
},
"maintenance_window": {
// Includes only one of the fields `anytime`, `weekly_maintenance_window`
"anytime": "AnytimeMaintenanceWindow",
"weekly_maintenance_window": {
"day": "WeekDay",
"hour": "int64"
}
// end of the list of possible fields
},
"version": "string"
}
|
Field |
Description |
|
cluster_id |
string Required field. ID of the Metastore Cluster to update. The maximum string length in characters is 50. |
|
update_mask |
Fields of the Metastore Cluster to be updated. |
|
name |
string New name of the Metastore Cluster. Value must match the regular expression |
|
description |
string New description of the Metastore Cluster. The maximum string length in characters is 256. |
|
labels |
object (map<string, string>) Custom labels for the Metastore Cluster as The maximum string length in characters for each value is 63. The string length in characters for each key must be 1-63. Each key must match the regular expression |
|
deletion_protection |
bool Deletion Protection prevents deletion of the cluster. |
|
service_account_id |
string Service account used to access Cloud resources. The maximum string length in characters is 50. |
|
logging |
Cloud logging configuration. |
|
network_spec |
Network-related configuration options. |
|
config_spec |
Metastore Cluster configuration. |
|
maintenance_window |
Maintenance window. |
|
version |
string Metastore server version. |
LoggingConfig
|
Field |
Description |
|
folder_id |
string Logs will be written to the default log group of the specified folder. Value must match the regular expression Includes only one of the fields Destination of log records. |
|
log_group_id |
string Logs will be written to the log group specified by its ID. Value must match the regular expression Includes only one of the fields Destination of log records. |
|
enabled |
bool Logs generated by the Metastore server are delivered to Cloud Logging. |
|
min_level |
enum Level Minimum severity level for log entries.
|
UpdateNetworkConfigSpec
|
Field |
Description |
|
security_group_ids[] |
string User security groups. |
UpdateClusterConfigSpec
|
Field |
Description |
|
resources |
Configuration for computational resources for Metastore server instances. |
|
warehouse |
Configuration of warehouse. |
Resources
|
Field |
Description |
|
resource_preset_id |
string Required field. ID of the preset for computational resources allocated to an instance (e.g., CPU, memory, etc.). The maximum string length in characters is 50. |
WarehouseConfig
|
Field |
Description |
|
s3 |
Yandex Cloud Object Storage. Includes only one of the fields |
S3Warehouse
|
Field |
Description |
|
bucket |
string Required field. Bucket name to use. |
|
path |
string Path within the bucket to use. Value must match the regular expression |
MaintenanceWindow
|
Field |
Description |
|
anytime |
The cluster may be restarted for maintenance at any time. Includes only one of the fields |
|
weekly_maintenance_window |
Maintenance is allowed only within the specified weekly window. Includes only one of the fields |
AnytimeMaintenanceWindow
|
Field |
Description |
|
Empty |
|
WeeklyMaintenanceWindow
|
Field |
Description |
|
day |
enum WeekDay Day of the week when maintenance can occur.
|
|
hour |
int64 Hour of the day in UTC when the maintenance window starts. Acceptable values are 1 to 24, inclusive. |
operation.Operation
{
"id": "string",
"description": "string",
"created_at": "google.protobuf.Timestamp",
"created_by": "string",
"modified_at": "google.protobuf.Timestamp",
"done": "bool",
"metadata": "google.protobuf.Any",
// Includes only one of the fields `error`, `response`
"error": "google.rpc.Status",
"response": "google.protobuf.Any"
// 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. |
|
created_at |
Creation timestamp. |
|
created_by |
string ID of the user or service account who initiated the operation. |
|
modified_at |
The time when the Operation resource was last modified. |
|
done |
bool If the value is |
|
metadata |
Service-specific metadata associated with the operation. |
|
error |
The error result of the operation in case of failure or cancellation. Includes only one of the fields The operation result. |
|
response |
The normal response of the operation in case of success. Includes only one of the fields The operation result. |