@yandex-cloud/nodejs-sdk
Version:
Yandex.Cloud NodeJS SDK
1,135 lines (1,134 loc) • 238 kB
TypeScript
/// <reference types="node" />
import { ChannelCredentials, ChannelOptions, UntypedServiceImplementation, handleUnaryCall, handleServerStreamingCall, Client, ClientUnaryCall, Metadata, CallOptions, ClientReadableStream, ServiceError } from "@grpc/grpc-js";
import _m0 from "protobufjs/minimal";
import { Cluster_Environment, Access, Resources, Cluster, Host, OpenSearch_GroupRole } from "../../../../../yandex/cloud/mdb/opensearch/v1/cluster";
import { MaintenanceWindow } from "../../../../../yandex/cloud/mdb/opensearch/v1/maintenance";
import { FieldMask } from "../../../../../google/protobuf/field_mask";
import { AuthSettings } from "../../../../../yandex/cloud/mdb/opensearch/v1/auth";
import { Operation } from "../../../../../yandex/cloud/operation/operation";
import { OpenSearchConfig2 } from "../../../../../yandex/cloud/mdb/opensearch/v1/config/opensearch";
import { Backup } from "../../../../../yandex/cloud/mdb/opensearch/v1/backup";
export declare const protobufPackage = "yandex.cloud.mdb.opensearch.v1";
export interface GetClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.GetClusterRequest";
/**
* ID of the OpenSearch cluster to return.
*
* To get the cluster ID, use a [ClusterService.List] request.
*/
clusterId: string;
}
export interface ListClustersRequest {
$type: "yandex.cloud.mdb.opensearch.v1.ListClustersRequest";
/**
* ID of the folder to list OpenSearch clusters in.
*
* To get the folder ID, use a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
*/
folderId: string;
/**
* The maximum number of results per page to return.
*
* If the number of available results is larger than [page_size], the service returns
* a [ListClustersResponse.next_page_token] that can be used to get the next page of results in subsequent list requests.
*/
pageSize: number;
/**
* Page token. To get the next page of results, set [page_token] to the [ListClustersResponse.next_page_token]
* returned by the previous list request.
*/
pageToken: string;
/**
* A filter expression that filters resources listed in the response.
*
* The expression must specify:
*
* 1. The field name. Currently you can only use filtering with the [Cluster.name] field.
*
* 2. An `=` operator.
*
* 3. The value in double quotes (`"`). Must be 1-63 characters long and match the regular expression `[a-zA-Z0-9_-]+`.
*/
filter: string;
}
export interface ListClustersResponse {
$type: "yandex.cloud.mdb.opensearch.v1.ListClustersResponse";
/** List of OpenSearch clusters. */
clusters: Cluster[];
/**
* This token allows you to get the next page of results for list requests.
*
* If the number of results is larger than [ListClustersRequest.page_size], use the [next_page_token] as the value
* for the [ListClustersRequest.page_token] parameter in the next list request.
*
* Each subsequent list request has its own [next_page_token] to continue paging through the results.
*/
nextPageToken: string;
}
export interface CreateClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.CreateClusterRequest";
/** ID of the folder to create the OpenSearch cluster in. */
folderId: string;
/** Name of the OpenSearch cluster. The name must be unique within the folder. */
name: string;
/** Description of the OpenSearch cluster. */
description: string;
/**
* Custom labels for the OpenSearch cluster as `key:value` pairs.
* For example, `"project": "mvp"` or `"source": "dictionary"`.
*/
labels: {
[key: string]: string;
};
/** Deployment environment of the OpenSearch cluster. */
environment: Cluster_Environment;
/** OpenSearch cluster configuration. */
configSpec?: ConfigCreateSpec;
/** ID of the network to create the cluster in. */
networkId: string;
/** User security groups. */
securityGroupIds: string[];
/** ID of the service account used to access Object Storage. */
serviceAccountId: string;
/** Determines whether the cluster is protected from being deleted. */
deletionProtection: boolean;
/** Cluster maintenance window. Should be defined by either one of the two options. */
maintenanceWindow?: MaintenanceWindow;
}
export interface CreateClusterRequest_LabelsEntry {
$type: "yandex.cloud.mdb.opensearch.v1.CreateClusterRequest.LabelsEntry";
key: string;
value: string;
}
export interface CreateClusterMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.CreateClusterMetadata";
/** ID of the OpenSearch cluster that is being created. */
clusterId: string;
}
export interface UpdateClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.UpdateClusterRequest";
/**
* ID of the OpenSearch cluster resource to update.
* To get the OpenSearch cluster ID, use a [ClusterService.List] request.
*/
clusterId: string;
/** Field mask that specifies which fields of the OpenSearch cluster resource should be updated. */
updateMask?: FieldMask;
/** New description of the OpenSearch cluster. */
description: string;
/**
* Custom labels for the OpenSearch cluster as `key:value` pairs.
* For example, `"project": "mvp"` or `"source": "dictionary"`.
*
* The new set of labels completely replaces the old one. To add a label, request the current
* set with the [ClusterService.Get] method, then send an [ClusterService.Update] request with the new label added to the set.
*/
labels: {
[key: string]: string;
};
/** New cluster configuration */
configSpec?: ConfigUpdateSpec;
/** New name for the cluster. The name must be unique within the folder. */
name: string;
/** User security groups */
securityGroupIds: string[];
/** ID of the service account used to access Object Storage. */
serviceAccountId: string;
/** Determines whether the cluster is protected from being deleted. */
deletionProtection: boolean;
/** Cluster maintenance window. Should be defined by either one of the two options. */
maintenanceWindow?: MaintenanceWindow;
}
export interface UpdateClusterRequest_LabelsEntry {
$type: "yandex.cloud.mdb.opensearch.v1.UpdateClusterRequest.LabelsEntry";
key: string;
value: string;
}
export interface UpdateClusterMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.UpdateClusterMetadata";
/** ID of the OpenSearch cluster resource that is being updated. */
clusterId: string;
}
export interface DeleteClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.DeleteClusterRequest";
/**
* ID of the OpenSearch cluster to delete.
* To get the OpenSearch cluster ID, use a [ClusterService.List] request.
*/
clusterId: string;
}
export interface DeleteClusterMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.DeleteClusterMetadata";
/** ID of the OpenSearch cluster that is being deleted. */
clusterId: string;
}
export interface ListClusterLogsRequest {
$type: "yandex.cloud.mdb.opensearch.v1.ListClusterLogsRequest";
/**
* ID of the OpenSearch cluster to request logs for.
*
* To get the OpenSearch cluster ID use a [ClusterService.List] request.
*/
clusterId: string;
/**
* Columns from log table to request.
* If no columns are specified, entire log records are returned.
*/
columnFilter: string[];
/** Start timestamp for the logs request. */
fromTime?: Date;
/** End timestamp for the logs request. */
toTime?: Date;
/**
* The maximum number of results per page to return.
*
* If the number of available results is larger than [page_size], the service returns a [ListClusterLogsResponse.next_page_token]
* that can be used to get the next page of results in subsequent list requests.
*/
pageSize: number;
/**
* Page token. To get the next page of results, set [page_token] to the
* [ListClusterLogsResponse.next_page_token] returned by the previous list request.
*/
pageToken: string;
/** The service always returns a [ListClusterLogsResponse.next_page_token], even if the current page is empty. */
alwaysNextPageToken: boolean;
/**
* A filter expression that filters resources listed in the response.
*
* The expression must specify:
*
* 1. A field name. Currently filtering can be applied to the [LogRecord.logs.message.hostname] field.
*
* 2. A conditional operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values.
*
* 3. A value. Must be 1-63 characters long and match the regular expression `^[a-z0-9.-]{1,61}$`.
*
* Examples of a filter:
* * `message.hostname='node1.db.cloud.yandex.net'`;
* * `message.error_severity IN ("ERROR", "FATAL", "PANIC") AND message.hostname = "node1.db.cloud.yandex.net"`.
*/
filter: string;
/** Type of the service to request logs about. */
serviceType: ListClusterLogsRequest_ServiceType;
}
export declare enum ListClusterLogsRequest_ServiceType {
/** SERVICE_TYPE_UNSPECIFIED - Type is not specified. */
SERVICE_TYPE_UNSPECIFIED = 0,
/** OPENSEARCH - OpenSearch logs. */
OPENSEARCH = 1,
/** DASHBOARDS - Dashboards logs. */
DASHBOARDS = 2,
UNRECOGNIZED = -1
}
export declare function listClusterLogsRequest_ServiceTypeFromJSON(object: any): ListClusterLogsRequest_ServiceType;
export declare function listClusterLogsRequest_ServiceTypeToJSON(object: ListClusterLogsRequest_ServiceType): string;
export interface LogRecord {
$type: "yandex.cloud.mdb.opensearch.v1.LogRecord";
/** Time when the log was recorded. */
timestamp?: Date;
/** Contents of the log record. */
message: {
[key: string]: string;
};
}
export interface LogRecord_MessageEntry {
$type: "yandex.cloud.mdb.opensearch.v1.LogRecord.MessageEntry";
key: string;
value: string;
}
export interface ListClusterLogsResponse {
$type: "yandex.cloud.mdb.opensearch.v1.ListClusterLogsResponse";
/** Requested log records. */
logs: LogRecord[];
/**
* This token allows you to get the next page of results for list requests.
*
* If the number of results is larger than [ListClusterLogsRequest.page_size], use the [next_page_token] as the value
* for the [ListClusterLogsRequest.page_token] query parameter in the next list request.
*
* Each subsequent list request has its own [next_page_token] to continue paging through the results.
*
* This value is interchangeable with the [StreamLogRecord.next_record_token] from [StreamLogs] method.
*/
nextPageToken: string;
}
export interface StreamLogRecord {
$type: "yandex.cloud.mdb.opensearch.v1.StreamLogRecord";
/** One of the requested log records. */
record?: LogRecord;
/**
* This token allows you to continue streaming logs starting from the exact same record.
*
* To do that, specify value of [next_record_token] as the value for [StreamLogs.record_token] parameter in the next [StreamLogs] request.
*
* This value is interchangeable with [ListLogs.next_page_token] from [ListLogs] method.
*/
nextRecordToken: string;
}
export interface StreamClusterLogsRequest {
$type: "yandex.cloud.mdb.opensearch.v1.StreamClusterLogsRequest";
/** ID of the OpenSearch cluster. */
clusterId: string;
/**
* Columns from log table to get in the response.
* If no columns are specified, entire log records are returned.
*/
columnFilter: string[];
/** Start timestamp for the logs request. */
fromTime?: Date;
/**
* End timestamp for the logs request.
*
* If this field is not set, all existing logs are sent as well as the new ones as they appear.
*
* In essence it has `tail -f` semantics.
*/
toTime?: Date;
/**
* Record token. Set `record_token` to the `next_record_token` returned by the previous [StreamLogs]
* request to start streaming from the next log record.
*/
recordToken: string;
/**
* A filter expression that filters resources listed in the response.
*
* The expression must specify:
*
* 1. A field name. Currently filtering can be applied to the [LogRecord.logs.message.hostname] field.
*
* 2. A conditional operator. Can be either `=` or `!=` for single values, `IN` or `NOT IN` for lists of values.
*
* 3. A value. Must be 1-63 characters long and match the regular expression `^[a-z0-9.-]{1,61}$`.
*
* Examples of a filter:
* * `message.hostname='node1.db.cloud.yandex.net'`;
* * `message.error_severity IN ("ERROR", "FATAL", "PANIC") AND message.hostname = "node1.db.cloud.yandex.net"`.
*/
filter: string;
/** Type of the service to request logs about. */
serviceType: StreamClusterLogsRequest_ServiceType;
}
export declare enum StreamClusterLogsRequest_ServiceType {
/** SERVICE_TYPE_UNSPECIFIED - Type is not specified. */
SERVICE_TYPE_UNSPECIFIED = 0,
/** OPENSEARCH - OpenSearch logs. */
OPENSEARCH = 1,
/** DASHBOARDS - Dashboards logs. */
DASHBOARDS = 2,
UNRECOGNIZED = -1
}
export declare function streamClusterLogsRequest_ServiceTypeFromJSON(object: any): StreamClusterLogsRequest_ServiceType;
export declare function streamClusterLogsRequest_ServiceTypeToJSON(object: StreamClusterLogsRequest_ServiceType): string;
export interface ListClusterOperationsRequest {
$type: "yandex.cloud.mdb.opensearch.v1.ListClusterOperationsRequest";
/** ID of the OpenSearch cluster resource to list operations for. */
clusterId: string;
/**
* The maximum number of results per page to return.
*
* If the number of available results is larger than [page_size], the service returns
* a [ListClusterOperationsResponse.next_page_token] that can be used to get the next page of results in subsequent list requests.
*/
pageSize: number;
/** Page token. To get the next page of results, set [page_token] to the [ListClusterOperationsResponse.next_page_token] returned by the previous list request. */
pageToken: string;
}
export interface ListClusterOperationsResponse {
$type: "yandex.cloud.mdb.opensearch.v1.ListClusterOperationsResponse";
/** List of Operation resources for the specified OpenSearch cluster. */
operations: Operation[];
/**
* This token allows you to get the next page of results for list requests.
*
* If the number of results is larger than [ListClusterOperationsRequest.page_size], use the [next_page_token] as the value for the [ListClusterOperationsRequest.page_token] query parameter in the next list request.
*
* Each subsequent list request has its own [next_page_token] to continue paging through the results.
*/
nextPageToken: string;
}
export interface ListClusterHostsRequest {
$type: "yandex.cloud.mdb.opensearch.v1.ListClusterHostsRequest";
/**
* ID of the OpenSearch cluster.
* To get the OpenSearch cluster ID use a [ClusterService.List] request.
*/
clusterId: string;
/**
* The maximum number of results per page to return.
*
* If the number of available results is larger than [page_size], the service returns
* a [ListClusterHostsResponse.next_page_token] that can be used to get the next page of results in subsequent list requests.
*/
pageSize: number;
/**
* Page token. To get the next page of results, set [page_token] to the [ListClusterHostsResponse.next_page_token]
* returned by the previous list request.
*/
pageToken: string;
}
export interface ListClusterHostsResponse {
$type: "yandex.cloud.mdb.opensearch.v1.ListClusterHostsResponse";
/** Requested list of hosts for the cluster. */
hosts: Host[];
/**
* This token allows you to get the next page of results for list requests.
*
* If the number of results is larger than [ListClusterHostsRequest.page_size], use the [next_page_token]
* as the value for the [ListClusterHostsRequest.page_token] query parameter in the next list request.
*
* Each subsequent list request has its own [next_page_token] to continue paging through the results.
*/
nextPageToken: string;
}
export interface MoveClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.MoveClusterRequest";
/** ID of the OpenSearch cluster to move. */
clusterId: string;
/** ID of the destination folder. */
destinationFolderId: string;
}
export interface MoveClusterMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.MoveClusterMetadata";
/** ID of the OpenSearch cluster being moved. */
clusterId: string;
/** ID of the source folder. */
sourceFolderId: string;
/** ID of the destnation folder. */
destinationFolderId: string;
}
export interface StartClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.StartClusterRequest";
/**
* ID of the OpenSearch cluster to start.
* To get the cluster ID, use a [ClusterService.List] request.
*/
clusterId: string;
}
export interface StartClusterMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.StartClusterMetadata";
/** ID of the OpenSearch cluster being started. */
clusterId: string;
}
export interface StopClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.StopClusterRequest";
/**
* ID of the OpenSearch cluster to stop.
* To get the cluster ID, use a [ClusterService.List] request.
*/
clusterId: string;
}
export interface StopClusterMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.StopClusterMetadata";
/** ID of the OpenSearch cluster being stopped. */
clusterId: string;
}
export interface ConfigCreateSpec {
$type: "yandex.cloud.mdb.opensearch.v1.ConfigCreateSpec";
/** OpenSearch version. */
version: string;
/** OpenSearch admin password. */
adminPassword: string;
/** OpenSearch configuration. */
opensearchSpec?: OpenSearchCreateSpec;
/** Dashboards configuration. */
dashboardsSpec?: DashboardsCreateSpec;
/** Access policy for external services. */
access?: Access;
}
/** OpenSearch create-time configuration. */
export interface OpenSearchCreateSpec {
$type: "yandex.cloud.mdb.opensearch.v1.OpenSearchCreateSpec";
/** Names of the cluster plugins. */
plugins: string[];
/** OpenSearch type host groups of the cluster. */
nodeGroups: OpenSearchCreateSpec_NodeGroup[];
opensearchConfig2?: OpenSearchConfig2 | undefined;
}
/** Configuration of the host group. */
export interface OpenSearchCreateSpec_NodeGroup {
$type: "yandex.cloud.mdb.opensearch.v1.OpenSearchCreateSpec.NodeGroup";
/** Name of the group. */
name: string;
/** Resources allocated to the hosts. */
resources?: Resources;
/** Number of hosts in the group. */
hostsCount: number;
/** IDs of the availability zones the hosts belong to. */
zoneIds: string[];
/** IDs of the subnets that the hosts belong to. */
subnetIds: string[];
/** Determines whether a public IP is assigned to the hosts in the group. */
assignPublicIp: boolean;
/** Roles of the hosts in the group. */
roles: OpenSearch_GroupRole[];
}
/** Dashboards create-time configuration. */
export interface DashboardsCreateSpec {
$type: "yandex.cloud.mdb.opensearch.v1.DashboardsCreateSpec";
/** Dashboards type host groups of the cluster. */
nodeGroups: DashboardsCreateSpec_NodeGroup[];
}
export interface DashboardsCreateSpec_NodeGroup {
$type: "yandex.cloud.mdb.opensearch.v1.DashboardsCreateSpec.NodeGroup";
/** Name of the group. */
name: string;
/** Resources allocated to the hosts. */
resources?: Resources;
/** Number of hosts in the group. */
hostsCount: number;
/** IDs of the availability zones the hosts belong to. */
zoneIds: string[];
/** IDs of the subnets that the hosts belong to. */
subnetIds: string[];
/** Determines whether a public IP is assigned to the hosts in the group. */
assignPublicIp: boolean;
}
export interface ConfigUpdateSpec {
$type: "yandex.cloud.mdb.opensearch.v1.ConfigUpdateSpec";
/** OpenSearch version. */
version: string;
/** OpenSearch admin password. */
adminPassword: string;
/** OpenSearch configuration. */
opensearchSpec?: OpenSearchClusterUpdateSpec;
/** Dashboards configuration. */
dashboardsSpec?: DashboardsClusterUpdateSpec;
/** Access policy for external services. */
access?: Access;
}
export interface OpenSearchClusterUpdateSpec {
$type: "yandex.cloud.mdb.opensearch.v1.OpenSearchClusterUpdateSpec";
/** Names of the cluster plugins. */
plugins: string[];
opensearchConfig2?: OpenSearchConfig2 | undefined;
}
/** Dashboards configuration. */
export interface DashboardsClusterUpdateSpec {
$type: "yandex.cloud.mdb.opensearch.v1.DashboardsClusterUpdateSpec";
}
export interface BackupClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.BackupClusterRequest";
/**
* ID of the OpenSearch cluster to back up.
*
* To get the ID, use a [ClusterService.List] request.
*/
clusterId: string;
}
export interface BackupClusterMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.BackupClusterMetadata";
/** ID of the OpenSearch cluster being backed up. */
clusterId: string;
}
export interface RestoreClusterRequest {
$type: "yandex.cloud.mdb.opensearch.v1.RestoreClusterRequest";
/**
* ID of the backup to create a new cluster from.
*
* To get the backup ID, use a [ClusterService.ListBackups] request.
*/
backupId: string;
/** Name of the new OpenSearch cluster to be created from the backup. The name must be unique within the folder. */
name: string;
/** Description of the new OpenSearch cluster to be created from the backup. */
description: string;
/**
* Custom labels for the new OpenSearch cluster to be created from the backup as `key:value` pairs. Maximum 64 per resource.
* For example, "project": "mvp" or "source": "dictionary".
*/
labels: {
[key: string]: string;
};
/** Deployment environment of the new OpenSearch cluster to be created from the backup. */
environment: Cluster_Environment;
/** Configuration for the new OpenSearch cluster to be created from the backup. */
configSpec?: ConfigCreateSpec;
/** ID of the network to create the cluster in. */
networkId: string;
/** User security groups. */
securityGroupIds: string[];
/** ID of the service account used to access Object Storage. */
serviceAccountId: string;
/** Determines whether the cluster is protected from being deleted. */
deletionProtection: boolean;
/**
* ID of the folder to create the OpenSearch cluster in.
*
* To get the folder ID, use a [yandex.cloud.resourcemanager.v1.FolderService.List] request.
*/
folderId: string;
/** Cluster maintenance window. Should be defined by either one of the two options. */
maintenanceWindow?: MaintenanceWindow;
}
export interface RestoreClusterRequest_LabelsEntry {
$type: "yandex.cloud.mdb.opensearch.v1.RestoreClusterRequest.LabelsEntry";
key: string;
value: string;
}
export interface RestoreClusterMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.RestoreClusterMetadata";
/** ID of the new OpenSearch cluster being created from a backup. */
clusterId: string;
/** ID of the backup being used for creating a cluster. */
backupId: string;
}
export interface RescheduleMaintenanceRequest {
$type: "yandex.cloud.mdb.opensearch.v1.RescheduleMaintenanceRequest";
/**
* ID of the OpenSearch cluster to reschedule the maintenance operation for.
*
* To get the ID, use a [ClusterService.List] request.
*/
clusterId: string;
/** The type of the reschedule request. */
rescheduleType: RescheduleMaintenanceRequest_RescheduleType;
/**
* The time until which this maintenance operation should be delayed.
* The value should be ahead of the first time when the maintenance operation has been scheduled for no more than two weeks.
* The value can also point to a moment in the past if [reschedule_type.IMMEDIATE] reschedule type is selected.
*/
delayedUntil?: Date;
}
export declare enum RescheduleMaintenanceRequest_RescheduleType {
/** RESCHEDULE_TYPE_UNSPECIFIED - Time of the maintenance is not specified.. */
RESCHEDULE_TYPE_UNSPECIFIED = 0,
/** IMMEDIATE - Start the maintenance operation immediately. */
IMMEDIATE = 1,
/** NEXT_AVAILABLE_WINDOW - Start the maintenance operation within the next available maintenance window. */
NEXT_AVAILABLE_WINDOW = 2,
/** SPECIFIC_TIME - Start the maintenance operation at the specific time. */
SPECIFIC_TIME = 3,
UNRECOGNIZED = -1
}
export declare function rescheduleMaintenanceRequest_RescheduleTypeFromJSON(object: any): RescheduleMaintenanceRequest_RescheduleType;
export declare function rescheduleMaintenanceRequest_RescheduleTypeToJSON(object: RescheduleMaintenanceRequest_RescheduleType): string;
export interface RescheduleMaintenanceMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.RescheduleMaintenanceMetadata";
/** ID of the OpenSearch cluster where the reschedule is applied. */
clusterId: string;
/** The time until which this maintenance operation is to be delayed. */
delayedUntil?: Date;
}
export interface ListClusterBackupsRequest {
$type: "yandex.cloud.mdb.opensearch.v1.ListClusterBackupsRequest";
/**
* ID of the OpenSearch cluster.
*
* To get the ID, use a [ClusterService.List] request.
*/
clusterId: string;
/**
* The maximum number of results per page to return. If the number of available
* results is larger than `page_size`, the service returns a [ListClusterBackupsResponse.next_page_token]
* that can be used to get the next page of results in subsequent list requests.
*/
pageSize: number;
/**
* Page token. To get the next page of results, set `page_token` to the [ListClusterBackupsResponse.next_page_token]
* returned by the previous list request.
*/
pageToken: string;
}
export interface ListClusterBackupsResponse {
$type: "yandex.cloud.mdb.opensearch.v1.ListClusterBackupsResponse";
/** List of the OpenSearch cluster backups. */
backups: Backup[];
/**
* This token allows you to get the next page of results for list requests.
*
* If the number of results is larger than [ListClustersRequest.page_size], use the [next_page_token] as the value
* for the [ListClustersRequest.page_token] parameter in the next list request.
*
* Each subsequent list request has its own [next_page_token] to continue paging through the results.
*/
nextPageToken: string;
}
export interface DeleteOpenSearchNodeGroupRequest {
$type: "yandex.cloud.mdb.opensearch.v1.DeleteOpenSearchNodeGroupRequest";
/**
* ID of the OpenSearch cluster to delete the OpenSearch type host group in.
*
* To get the ID, use a [ClusterService.List] request.
*/
clusterId: string;
/** Name of the OpenSearch type host group to delete. */
name: string;
}
export interface UpdateOpenSearchNodeGroupRequest {
$type: "yandex.cloud.mdb.opensearch.v1.UpdateOpenSearchNodeGroupRequest";
/**
* ID of the OpenSearch cluster to update the OpenSearch type host group in.
*
* To get the ID, use a [ClusterService.List] request.
*/
clusterId: string;
/** Name of the OpenSearch type host group to be updated. */
name: string;
/** Field mask that specifies which fields of the host group configuration should be updated. */
updateMask?: FieldMask;
/** New configuration for the host group. */
nodeGroupSpec?: OpenSearchNodeGroupUpdateSpec;
}
export interface OpenSearchNodeGroupUpdateSpec {
$type: "yandex.cloud.mdb.opensearch.v1.OpenSearchNodeGroupUpdateSpec";
/** Resources allocated to the hosts. */
resources?: Resources;
/** Number of hosts in the group. */
hostsCount: number;
/** Roles of the host group. */
roles: OpenSearch_GroupRole[];
}
export interface AddOpenSearchNodeGroupRequest {
$type: "yandex.cloud.mdb.opensearch.v1.AddOpenSearchNodeGroupRequest";
/**
* ID of the OpenSearch cluster to create the OpenSearch type host group in.
*
* To get the ID, use a [ClusterService.List] request.
*/
clusterId: string;
/** Configuration of the new host group. */
nodeGroupSpec?: OpenSearchCreateSpec_NodeGroup;
}
export interface DeleteDashboardsNodeGroupRequest {
$type: "yandex.cloud.mdb.opensearch.v1.DeleteDashboardsNodeGroupRequest";
/**
* ID of the OpenSearch cluster to delete the Dashboards type host group in.
*
* To get the ID, use a [ClusterService.List] request.
*/
clusterId: string;
/** Name of the Dashboards type host group to delete. */
name: string;
}
export interface UpdateDashboardsNodeGroupRequest {
$type: "yandex.cloud.mdb.opensearch.v1.UpdateDashboardsNodeGroupRequest";
/** ID of the OpenSearch cluster to update the Dashboards type host group in. */
clusterId: string;
/** Name of the Dashboards type host group to be updated. */
name: string;
/** Field mask that specifies which fields of the host group configuration should be updated. */
updateMask?: FieldMask;
/** New configuration for the host group. */
nodeGroupSpec?: DashboardsNodeGroupUpdateSpec;
}
export interface DashboardsNodeGroupUpdateSpec {
$type: "yandex.cloud.mdb.opensearch.v1.DashboardsNodeGroupUpdateSpec";
/** Resources allocated to the hosts. */
resources?: Resources;
/** Number of hosts in the group. */
hostsCount: number;
}
export interface AddDashboardsNodeGroupRequest {
$type: "yandex.cloud.mdb.opensearch.v1.AddDashboardsNodeGroupRequest";
/**
* ID of the OpenSearch cluster to create the Dashboards type host group in.
*
* To get the ID, use a [ClusterService.List] request.
*/
clusterId: string;
/** Configuration of the new host group. */
nodeGroupSpec?: DashboardsCreateSpec_NodeGroup;
}
export interface AddNodeGroupMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.AddNodeGroupMetadata";
/** ID of the OpenSearch cluster where the host group is being created. */
clusterId: string;
/** Name of the host group being created. */
name: string;
}
export interface UpdateNodeGroupMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.UpdateNodeGroupMetadata";
/** ID of the OpenSearch cluster where the host group is being updated. */
clusterId: string;
/** Name of the host group being updated. */
name: string;
}
export interface DeleteNodeGroupMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.DeleteNodeGroupMetadata";
/** ID of the OpenSearch cluster where the host group is being deleted. */
clusterId: string;
/** Name of the host group being deleted. */
name: string;
}
export interface GetAuthSettingsRequest {
$type: "yandex.cloud.mdb.opensearch.v1.GetAuthSettingsRequest";
/** Required. ID of the OpenSearch cluster. */
clusterId: string;
}
export interface UpdateAuthSettingsRequest {
$type: "yandex.cloud.mdb.opensearch.v1.UpdateAuthSettingsRequest";
/** Required. ID of the OpenSearch cluster. */
clusterId: string;
/** Required. Auth settings. */
settings?: AuthSettings;
}
export interface UpdateAuthSettingsMetadata {
$type: "yandex.cloud.mdb.opensearch.v1.UpdateAuthSettingsMetadata";
/** ID of the OpenSearch cluster. */
clusterId: string;
}
export declare const GetClusterRequest: {
$type: "yandex.cloud.mdb.opensearch.v1.GetClusterRequest";
encode(message: GetClusterRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): GetClusterRequest;
fromJSON(object: any): GetClusterRequest;
toJSON(message: GetClusterRequest): unknown;
fromPartial<I extends {
clusterId?: string | undefined;
} & {
clusterId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "clusterId">, never>>(object: I): GetClusterRequest;
};
export declare const ListClustersRequest: {
$type: "yandex.cloud.mdb.opensearch.v1.ListClustersRequest";
encode(message: ListClustersRequest, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListClustersRequest;
fromJSON(object: any): ListClustersRequest;
toJSON(message: ListClustersRequest): unknown;
fromPartial<I extends {
pageSize?: number | undefined;
pageToken?: string | undefined;
filter?: string | undefined;
folderId?: string | undefined;
} & {
pageSize?: number | undefined;
pageToken?: string | undefined;
filter?: string | undefined;
folderId?: string | undefined;
} & Record<Exclude<keyof I, "$type" | "pageSize" | "pageToken" | "filter" | "folderId">, never>>(object: I): ListClustersRequest;
};
export declare const ListClustersResponse: {
$type: "yandex.cloud.mdb.opensearch.v1.ListClustersResponse";
encode(message: ListClustersResponse, writer?: _m0.Writer): _m0.Writer;
decode(input: _m0.Reader | Uint8Array, length?: number | undefined): ListClustersResponse;
fromJSON(object: any): ListClustersResponse;
toJSON(message: ListClustersResponse): unknown;
fromPartial<I extends {
nextPageToken?: string | undefined;
clusters?: {
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../../yandex/cloud/mdb/opensearch/v1/cluster").Cluster_Status | undefined;
config?: {
version?: string | undefined;
access?: {
serverless?: boolean | undefined;
dataTransfer?: boolean | undefined;
} | undefined;
opensearch?: {
nodeGroups?: {
name?: string | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
zoneIds?: string[] | undefined;
subnetIds?: string[] | undefined;
hostsCount?: number | undefined;
assignPublicIp?: boolean | undefined;
roles?: OpenSearch_GroupRole[] | undefined;
}[] | undefined;
plugins?: string[] | undefined;
opensearchConfigSet2?: {
effectiveConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
userConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
defaultConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
dashboards?: {
nodeGroups?: {
name?: string | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
zoneIds?: string[] | undefined;
subnetIds?: string[] | undefined;
hostsCount?: number | undefined;
assignPublicIp?: boolean | undefined;
}[] | undefined;
} | undefined;
} | undefined;
folderId?: string | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
networkId?: string | undefined;
securityGroupIds?: string[] | undefined;
deletionProtection?: boolean | undefined;
serviceAccountId?: string | undefined;
health?: import("../../../../../yandex/cloud/mdb/opensearch/v1/cluster").Cluster_Health | undefined;
monitoring?: {
link?: string | undefined;
description?: string | undefined;
name?: string | undefined;
}[] | undefined;
maintenanceWindow?: {
anytime?: {} | undefined;
weeklyMaintenanceWindow?: {
hour?: number | undefined;
day?: import("../../../../../yandex/cloud/mdb/opensearch/v1/maintenance").WeeklyMaintenanceWindow_WeekDay | undefined;
} | undefined;
} | undefined;
environment?: Cluster_Environment | undefined;
plannedOperation?: {
info?: string | undefined;
delayedUntil?: Date | undefined;
latestMaintenanceTime?: Date | undefined;
nextMaintenanceWindowTime?: Date | undefined;
} | undefined;
}[] | undefined;
} & {
nextPageToken?: string | undefined;
clusters?: ({
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../../yandex/cloud/mdb/opensearch/v1/cluster").Cluster_Status | undefined;
config?: {
version?: string | undefined;
access?: {
serverless?: boolean | undefined;
dataTransfer?: boolean | undefined;
} | undefined;
opensearch?: {
nodeGroups?: {
name?: string | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
zoneIds?: string[] | undefined;
subnetIds?: string[] | undefined;
hostsCount?: number | undefined;
assignPublicIp?: boolean | undefined;
roles?: OpenSearch_GroupRole[] | undefined;
}[] | undefined;
plugins?: string[] | undefined;
opensearchConfigSet2?: {
effectiveConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
userConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
defaultConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
dashboards?: {
nodeGroups?: {
name?: string | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
zoneIds?: string[] | undefined;
subnetIds?: string[] | undefined;
hostsCount?: number | undefined;
assignPublicIp?: boolean | undefined;
}[] | undefined;
} | undefined;
} | undefined;
folderId?: string | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
networkId?: string | undefined;
securityGroupIds?: string[] | undefined;
deletionProtection?: boolean | undefined;
serviceAccountId?: string | undefined;
health?: import("../../../../../yandex/cloud/mdb/opensearch/v1/cluster").Cluster_Health | undefined;
monitoring?: {
link?: string | undefined;
description?: string | undefined;
name?: string | undefined;
}[] | undefined;
maintenanceWindow?: {
anytime?: {} | undefined;
weeklyMaintenanceWindow?: {
hour?: number | undefined;
day?: import("../../../../../yandex/cloud/mdb/opensearch/v1/maintenance").WeeklyMaintenanceWindow_WeekDay | undefined;
} | undefined;
} | undefined;
environment?: Cluster_Environment | undefined;
plannedOperation?: {
info?: string | undefined;
delayedUntil?: Date | undefined;
latestMaintenanceTime?: Date | undefined;
nextMaintenanceWindowTime?: Date | undefined;
} | undefined;
}[] & ({
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../../yandex/cloud/mdb/opensearch/v1/cluster").Cluster_Status | undefined;
config?: {
version?: string | undefined;
access?: {
serverless?: boolean | undefined;
dataTransfer?: boolean | undefined;
} | undefined;
opensearch?: {
nodeGroups?: {
name?: string | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
zoneIds?: string[] | undefined;
subnetIds?: string[] | undefined;
hostsCount?: number | undefined;
assignPublicIp?: boolean | undefined;
roles?: OpenSearch_GroupRole[] | undefined;
}[] | undefined;
plugins?: string[] | undefined;
opensearchConfigSet2?: {
effectiveConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
userConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
defaultConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
dashboards?: {
nodeGroups?: {
name?: string | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
zoneIds?: string[] | undefined;
subnetIds?: string[] | undefined;
hostsCount?: number | undefined;
assignPublicIp?: boolean | undefined;
}[] | undefined;
} | undefined;
} | undefined;
folderId?: string | undefined;
labels?: {
[x: string]: string | undefined;
[x: number]: string | undefined;
} | undefined;
networkId?: string | undefined;
securityGroupIds?: string[] | undefined;
deletionProtection?: boolean | undefined;
serviceAccountId?: string | undefined;
health?: import("../../../../../yandex/cloud/mdb/opensearch/v1/cluster").Cluster_Health | undefined;
monitoring?: {
link?: string | undefined;
description?: string | undefined;
name?: string | undefined;
}[] | undefined;
maintenanceWindow?: {
anytime?: {} | undefined;
weeklyMaintenanceWindow?: {
hour?: number | undefined;
day?: import("../../../../../yandex/cloud/mdb/opensearch/v1/maintenance").WeeklyMaintenanceWindow_WeekDay | undefined;
} | undefined;
} | undefined;
environment?: Cluster_Environment | undefined;
plannedOperation?: {
info?: string | undefined;
delayedUntil?: Date | undefined;
latestMaintenanceTime?: Date | undefined;
nextMaintenanceWindowTime?: Date | undefined;
} | undefined;
} & {
description?: string | undefined;
id?: string | undefined;
name?: string | undefined;
createdAt?: Date | undefined;
status?: import("../../../../../yandex/cloud/mdb/opensearch/v1/cluster").Cluster_Status | undefined;
config?: ({
version?: string | undefined;
access?: {
serverless?: boolean | undefined;
dataTransfer?: boolean | undefined;
} | undefined;
opensearch?: {
nodeGroups?: {
name?: string | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
zoneIds?: string[] | undefined;
subnetIds?: string[] | undefined;
hostsCount?: number | undefined;
assignPublicIp?: boolean | undefined;
roles?: OpenSearch_GroupRole[] | undefined;
}[] | undefined;
plugins?: string[] | undefined;
opensearchConfigSet2?: {
effectiveConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
userConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
defaultConfig?: {
fielddataCacheSize?: string | undefined;
reindexRemoteWhitelist?: string | undefined;
maxClauseCount?: number | undefined;
} | undefined;
} | undefined;
} | undefined;
dashboards?: {
nodeGroups?: {
name?: string | undefined;
resources?: {
diskTypeId?: string | undefined;
diskSize?: number | undefined;
resourcePresetId?: string | undefined;
} | undefined;
zoneIds?: string[] | undefined;
subnetIds?: string[] | undefined;
hostsCount?: number | undefined;