Class ClusterService

constructor

• new ClusterService(sdk: SDKInterface): ClusterService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns ClusterService

$type

create

• create(
      request: CreateClusterRequest,
  ): Request<CreateClusterRequest, Operation<GetOperationRequest>>

  Creates a new mk8s cluster.

  Parameters

  • request: CreateClusterRequest

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

• create(
      request: CreateClusterRequest,
      metadata: Metadata,
  ): Request<CreateClusterRequest, Operation<GetOperationRequest>>

  Creates a new mk8s cluster.

  Parameters

  • request: CreateClusterRequest
  • metadata: Metadata

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

• create(
      request: CreateClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateClusterRequest, Operation<GetOperationRequest>>

  Creates a new mk8s cluster.

  Parameters

  • request: CreateClusterRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

• create(
      request: CreateClusterRequest,
  ): Request<CreateClusterRequest, Operation<GetOperationRequest>>

  Creates a new mk8s cluster.

  Parameters

  • request: CreateClusterRequest

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

• create(
      request: CreateClusterRequest,
      metadata: Metadata,
  ): Request<CreateClusterRequest, Operation<GetOperationRequest>>

  Creates a new mk8s cluster.

  Parameters

  • request: CreateClusterRequest
  • metadata: Metadata

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

• create(
      request: CreateClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<CreateClusterRequest, Operation<GetOperationRequest>>

  Creates a new mk8s cluster.

  Parameters

  • request: CreateClusterRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<CreateClusterRequest, Operation<GetOperationRequest>>

delete

• delete(
      request: DeleteClusterRequest,
  ): Request<DeleteClusterRequest, Operation<GetOperationRequest>>

  Deletes an mk8s cluster.

  Parameters

  • request: DeleteClusterRequest

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteClusterRequest,
      metadata: Metadata,
  ): Request<DeleteClusterRequest, Operation<GetOperationRequest>>

  Deletes an mk8s cluster.

  Parameters

  • request: DeleteClusterRequest
  • metadata: Metadata

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteClusterRequest, Operation<GetOperationRequest>>

  Deletes an mk8s cluster.

  Parameters

  • request: DeleteClusterRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteClusterRequest,
  ): Request<DeleteClusterRequest, Operation<GetOperationRequest>>

  Deletes an mk8s cluster.

  Parameters

  • request: DeleteClusterRequest

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteClusterRequest,
      metadata: Metadata,
  ): Request<DeleteClusterRequest, Operation<GetOperationRequest>>

  Deletes an mk8s cluster.

  Parameters

  • request: DeleteClusterRequest
  • metadata: Metadata

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

• delete(
      request: DeleteClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<DeleteClusterRequest, Operation<GetOperationRequest>>

  Deletes an mk8s cluster.

  Parameters

  • request: DeleteClusterRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<DeleteClusterRequest, Operation<GetOperationRequest>>

filter

• filter(
      request: ListClustersRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Cluster>

  Calls the filter method.

  Parameters

  • request: ListClustersRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Cluster>

• filter(
      request: ListClustersRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): AsyncGenerator<Cluster>

  Yields list items across pages, without changing the supplied request.

  Parameters

  • request: ListClustersRequest
  • Optionalmetadata: Metadata
  • Optionaloptions: Partial<CallOptions> & RetryOptions

  Returns AsyncGenerator<Cluster>

get

• get(request: GetClusterRequest): Request<GetClusterRequest, Cluster>

  Returns a specific mk8s cluster by its unique identifier.

  Parameters

  • request: GetClusterRequest

  Returns Request<GetClusterRequest, Cluster>

• get(
      request: GetClusterRequest,
      metadata: Metadata,
  ): Request<GetClusterRequest, Cluster>

  Returns a specific mk8s cluster by its unique identifier.

  Parameters

  • request: GetClusterRequest
  • metadata: Metadata

  Returns Request<GetClusterRequest, Cluster>

• get(
      request: GetClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetClusterRequest, Cluster>

  Returns a specific mk8s cluster by its unique identifier.

  Parameters

  • request: GetClusterRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetClusterRequest, Cluster>

• get(request: GetClusterRequest): Request<GetClusterRequest, Cluster>

  Returns a specific mk8s cluster by its unique identifier.

  Parameters

  • request: GetClusterRequest

  Returns Request<GetClusterRequest, Cluster>

• get(
      request: GetClusterRequest,
      metadata: Metadata,
  ): Request<GetClusterRequest, Cluster>

  Returns a specific mk8s cluster by its unique identifier.

  Parameters

  • request: GetClusterRequest
  • metadata: Metadata

  Returns Request<GetClusterRequest, Cluster>

• get(
      request: GetClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetClusterRequest, Cluster>

  Returns a specific mk8s cluster by its unique identifier.

  Parameters

  • request: GetClusterRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetClusterRequest, Cluster>

getByName

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Cluster>

  Returns a specific mk8s cluster by its unique name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Cluster>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Cluster>

  Returns a specific mk8s cluster by its unique name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Cluster>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Cluster>

  Returns a specific mk8s cluster by its unique name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Cluster>

• getByName(request: GetByNameRequest): Request<GetByNameRequest, Cluster>

  Returns a specific mk8s cluster by its unique name.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, Cluster>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
  ): Request<GetByNameRequest, Cluster>

  Returns a specific mk8s cluster by its unique name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, Cluster>

• getByName(
      request: GetByNameRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<GetByNameRequest, Cluster>

  Returns a specific mk8s cluster by its unique name.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<GetByNameRequest, Cluster>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListClustersRequest,
  ): Request<ListClustersRequest, ListClustersResponse>

  Returns a list of all mk8s clusters in the specified project.

  Parameters

  • request: ListClustersRequest

  Returns Request<ListClustersRequest, ListClustersResponse>

• list(
      request: ListClustersRequest,
      metadata: Metadata,
  ): Request<ListClustersRequest, ListClustersResponse>

  Returns a list of all mk8s clusters in the specified project.

  Parameters

  • request: ListClustersRequest
  • metadata: Metadata

  Returns Request<ListClustersRequest, ListClustersResponse>

• list(
      request: ListClustersRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListClustersRequest, ListClustersResponse>

  Returns a list of all mk8s clusters in the specified project.

  Parameters

  • request: ListClustersRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListClustersRequest, ListClustersResponse>

• list(
      request: ListClustersRequest,
  ): Request<ListClustersRequest, ListClustersResponse>

  Returns a list of all mk8s clusters in the specified project.

  Parameters

  • request: ListClustersRequest

  Returns Request<ListClustersRequest, ListClustersResponse>

• list(
      request: ListClustersRequest,
      metadata: Metadata,
  ): Request<ListClustersRequest, ListClustersResponse>

  Returns a list of all mk8s clusters in the specified project.

  Parameters

  • request: ListClustersRequest
  • metadata: Metadata

  Returns Request<ListClustersRequest, ListClustersResponse>

• list(
      request: ListClustersRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<ListClustersRequest, ListClustersResponse>

  Returns a list of all mk8s clusters in the specified project.

  Parameters

  • request: ListClustersRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<ListClustersRequest, ListClustersResponse>

listControlPlaneVersions

• listControlPlaneVersions(
      request: ListClusterControlPlaneVersionsRequest,
  ): Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

  ListControlPlaneVersions returns all k8s release versions available in Nebius API.

  Parameters

  • request: ListClusterControlPlaneVersionsRequest

  Returns Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

• listControlPlaneVersions(
      request: ListClusterControlPlaneVersionsRequest,
      metadata: Metadata,
  ): Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

  ListControlPlaneVersions returns all k8s release versions available in Nebius API.

  Parameters

  • request: ListClusterControlPlaneVersionsRequest
  • metadata: Metadata

  Returns Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

• listControlPlaneVersions(
      request: ListClusterControlPlaneVersionsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

  ListControlPlaneVersions returns all k8s release versions available in Nebius API.

  Parameters

  • request: ListClusterControlPlaneVersionsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

• listControlPlaneVersions(
      request: ListClusterControlPlaneVersionsRequest,
  ): Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

  ListControlPlaneVersions returns all k8s release versions available in Nebius API.

  Parameters

  • request: ListClusterControlPlaneVersionsRequest

  Returns Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

• listControlPlaneVersions(
      request: ListClusterControlPlaneVersionsRequest,
      metadata: Metadata,
  ): Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

  ListControlPlaneVersions returns all k8s release versions available in Nebius API.

  Parameters

  • request: ListClusterControlPlaneVersionsRequest
  • metadata: Metadata

  Returns Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

• listControlPlaneVersions(
      request: ListClusterControlPlaneVersionsRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

  ListControlPlaneVersions returns all k8s release versions available in Nebius API.

  Parameters

  • request: ListClusterControlPlaneVersionsRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<
      ListClusterControlPlaneVersionsRequest,
      ListClusterControlPlaneVersionsResponse,
  >

listOperations

• listOperations(
      request: ListOperationsRequest,
      metadata?: Metadata,
      options?: Partial<CallOptions> & RetryOptions,
  ): Request<ListOperationsRequest>

  Lists operations for this service address.

  Parameters

  • request: ListOperationsRequest
  • metadata: Metadata = ...
  • options: Partial<CallOptions> & RetryOptions = {}

  Returns Request<ListOperationsRequest>

update

• update(
      request: UpdateClusterRequest,
  ): Request<UpdateClusterRequest, Operation<GetOperationRequest>>

  Modifies an existing mk8s cluster.

  Parameters

  • request: UpdateClusterRequest

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateClusterRequest,
      metadata: Metadata,
  ): Request<UpdateClusterRequest, Operation<GetOperationRequest>>

  Modifies an existing mk8s cluster.

  Parameters

  • request: UpdateClusterRequest
  • metadata: Metadata

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateClusterRequest, Operation<GetOperationRequest>>

  Modifies an existing mk8s cluster.

  Parameters

  • request: UpdateClusterRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateClusterRequest,
  ): Request<UpdateClusterRequest, Operation<GetOperationRequest>>

  Modifies an existing mk8s cluster.

  Parameters

  • request: UpdateClusterRequest

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateClusterRequest,
      metadata: Metadata,
  ): Request<UpdateClusterRequest, Operation<GetOperationRequest>>

  Modifies an existing mk8s cluster.

  Parameters

  • request: UpdateClusterRequest
  • metadata: Metadata

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>

• update(
      request: UpdateClusterRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<UpdateClusterRequest, Operation<GetOperationRequest>>

  Modifies an existing mk8s cluster.

  Parameters

  • request: UpdateClusterRequest
  • metadata: Metadata
  • options: Partial<CallOptions> & RetryOptions

  Returns Request<UpdateClusterRequest, Operation<GetOperationRequest>>