Update

Updates the specified private endpoint.

TypeScript

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

const PrivateEndpoint =
  cloudApi.vpc.privatelink_private_endpoint.PrivateEndpoint;
const UpdatePrivateEndpointRequest =
  cloudApi.vpc.privatelink_private_endpoint_service
    .UpdatePrivateEndpointRequest;

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

  const operation = await client.update(
    UpdatePrivateEndpointRequest.fromPartial({
      privateEndpointId: "privateEndpointId",
      // updateMask: {
      // paths: ["paths"]
      // },
      // name: "name",
      // description: "description",
      // labels: {"key": "labels"},
      // addressSpec: {
      // addressId: "addressId",
      // internalIpv4AddressSpec: {
      // subnetId: "subnetId",
      // address: "address"
      // }
      // },
      // dnsOptions: {
      // privateDnsRecordsEnabled: true
      // }
    })
  );
  const finishedOp = await waitForOperation(operation, session);

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

Python

import os
import grpc
import yandexcloud

from yandex.cloud.vpc.v1.privatelink.private_endpoint_service_pb2 import AddressSpec
from yandex.cloud.vpc.v1.privatelink.private_endpoint_service_pb2 import InternalIpv4AddressSpec
from yandex.cloud.vpc.v1.privatelink.private_endpoint_pb2 import PrivateEndpoint
from yandex.cloud.vpc.v1.privatelink.private_endpoint_service_pb2_grpc import (
    PrivateEndpointServiceStub,
)
from yandex.cloud.vpc.v1.privatelink.private_endpoint_service_pb2 import (
    UpdatePrivateEndpointMetadata,
)
from yandex.cloud.vpc.v1.privatelink.private_endpoint_service_pb2 import (
    UpdatePrivateEndpointRequest,
)

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(PrivateEndpointServiceStub)
operation = service.Update(
    UpdatePrivateEndpointRequest(
        private_endpoint_id="privateEndpointId",
        # update_mask = FieldMask.FromJsonString("field1,field2"),
        # name = "name",
        # description = "description",
        # labels = {"key": "labels"},
        # address_spec = AddressSpec(
        # address_id = "addressId",
        # internal_ipv_4_address_spec = InternalIpv4AddressSpec(
        # subnet_id = "subnetId",
        # address = "address"
        # )
        # ),
        # dns_options = PrivateEndpoint.DnsOptions(
        # private_dns_records_enabled = true
        # )
    )
)
operation_result = sdk.wait_operation_and_get_result(
    operation,
    response_type=PrivateEndpoint,
    meta_type=UpdatePrivateEndpointMetadata,
)
print(operation_result)

UpdatePrivateEndpointRequest

privateEndpointId : string

ID of the private endpoint to update.

To get the private endpoint ID make a PrivateEndpointService.List request.

updateMask : google.protobuf.FieldMask

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

name : string

New name for the private endpoint. The name must be unique within the folder.

description : string

New description of the private endpoint.

labels : string

Private endpoint labels as key:value pairs.

Existing set of labels is completely replaced by the provided set, so if you just want to add or remove a label:

1. Get the current set of labels with a PrivateEndpointService.Get request.
2. Add or remove a label in this set.
3. Send the new set in this field.

addressSpec : AddressSpec

Private endpoint address specification.

dnsOptions : PrivateEndpoint.DnsOptions

Private endpoint dns options.

AddressSpec

One of address

• addressId : string

  ID of IP address to associate with private endpoint.

• internalIpv4AddressSpec : InternalIpv4AddressSpec

  Internal ipv4 address specification.

DnsOptions

privateDnsRecordsEnabled : bool

If enabled - vpc will create private dns records for specified service.

InternalIpv4AddressSpec

subnetId : string

ID of the subnet that address belongs to.

address : string

Value of address.

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.

---