Purge

Removes specified files from the cache of the specified resource. For details about purging, see documentation.

Purging may take up to 15 minutes.

TypeScript

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

const PurgeCacheRequest = cloudApi.cdn.cache_service.PurgeCacheRequest;

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

  const operation = await client.purge(
    PurgeCacheRequest.fromPartial({
      resourceId: "resourceId",
      // paths: ["paths"]
    })
  );
  await waitForOperation(operation, session);
})();

Python

import os
import grpc
import yandexcloud

from yandex.cloud.cdn.v1.cache_service_pb2_grpc import CacheServiceStub
from yandex.cloud.cdn.v1.cache_service_pb2 import PurgeCacheMetadata
from yandex.cloud.cdn.v1.cache_service_pb2 import PurgeCacheRequest

token = os.getenv("YC_OAUTH_TOKEN")

sdk = yandexcloud.SDK(token=token)

service = sdk.client(CacheServiceStub)
operation = service.Purge()
operation_result = sdk.wait_operation_and_get_result(
    operation,
    meta_type=PurgeCacheMetadata,
)

PurgeCacheRequest

resourceId : string

ID of the resource to perform purge operation on.

paths : string

Set of paths: Paths of the files to remove from the cache.

You may use asterisk (*) as a wildcard character that substitutes any number of characters.

If an empty array of paths is specified ("paths": []), the cache is purged entirely.

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.

---