Update

Updates the specified proxy.

TypeScript

import {
  cloudApi,
  decodeMessage,
  serviceClients,
  Session,
  waitForOperation,
} from "@yandex-cloud/nodejs-sdk";

const Proxy = cloudApi.serverless.mdbproxy_proxy.Proxy;
const UpdateProxyRequest =
  cloudApi.serverless.mdbproxy_proxy_service.UpdateProxyRequest;

(async () => {
  const authToken = process.env["YC_OAUTH_TOKEN"];
  const session = new Session({ oauthToken: authToken });
  const client = session.client(serviceClients.ProxyServiceClient);

  const operation = await client.update(
    UpdateProxyRequest.fromPartial({
      proxyId: "proxyId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // target: {
      // clickhouse: {
      // clusterId: "clusterId",
      // user: "user",
      // password: "password",
      // db: "db",
      // endpoint: "endpoint"
      // },
      // postgresql: {
      // clusterId: "clusterId",
      // user: "user",
      // password: "password",
      // db: "db",
      // endpoint: "endpoint"
      // }
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

  if (finishedOp.response) {
    const result = decodeMessage<typeof Proxy>(finishedOp.response);
    console.log(result);
  }
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.serverless.mdbproxy.v1.proxy_pb2 import Proxy
from yandex.cloud.serverless.mdbproxy.v1.proxy_service_pb2_grpc import ProxyServiceStub
from yandex.cloud.serverless.mdbproxy.v1.proxy_pb2 import Target
from yandex.cloud.serverless.mdbproxy.v1.proxy_service_pb2 import UpdateProxyMetadata
from yandex.cloud.serverless.mdbproxy.v1.proxy_service_pb2 import UpdateProxyRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(ProxyServiceStub)
operation = service.Update(
    UpdateProxyRequest(
        proxy_id="proxyId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # target = Target(
        # clickhouse = Target.ClickHouse(
        # cluster_id = "clusterId",
        # user = "user",
        # password = "password",
        # db = "db",
        # endpoint = "endpoint"
        # ),
        # postgresql = Target.PostgreSQL(
        # cluster_id = "clusterId",
        # user = "user",
        # password = "password",
        # db = "db",
        # endpoint = "endpoint"
        # )
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=Proxy,
    meta_type=UpdateProxyMetadata,
)
print(operation_result)

UpdateProxyRequest

proxyId : string

ID of the proxy to update.

updateMask : google.protobuf.FieldMask

Field mask that specifies which attributes of the proxy should be updated.

name : string

New name for the proxy. The name must be unique within the folder.

description : string

New description for the proxy.

labels : string

Proxy labels as key:value pairs.

target : Target

Proxy target.

Target

PostgreSQL

clusterId : string

Cluster identifier for postgresql.

user : string

PostgreSQL user.

password : string

PostgreSQL password, input only field.

db : string

PostgreSQL database name.

endpoint : string

PostgreSQL proxy-host for connection, output only field.

ClickHouse

clusterId : string

Cluster identifier for clickhouse.

user : string

Clickhouse user.

password : string

Clickhouse password, input only field.

db : string

Clickhouse database name.

endpoint : string

Clickhouse proxy-host for connection, output only field.

One of mdb

• clickhouse : ClickHouse

  Clickhouse settings for proxy.

• postgresql : PostgreSQL

  PostgreSQL settings for proxy.

ClickHouse

clusterId : string

Cluster identifier for clickhouse.

user : string

Clickhouse user.

password : string

Clickhouse password, input only field.

db : string

Clickhouse database name.

endpoint : string

Clickhouse proxy-host for connection, output only field.

PostgreSQL

clusterId : string

Cluster identifier for postgresql.

user : string

PostgreSQL user.

password : string

PostgreSQL password, input only field.

db : string

PostgreSQL database name.

endpoint : string

PostgreSQL proxy-host for connection, output only field.

Operation

An Operation resource. For more information, see Operation.

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 : 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.

One of result

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

  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.

---