@nebius/js-sdk - v0.2.78
    Preparing search index...

    Interface AllocationServiceBaseClient

    Defines the low-level gRPC client for the nebius.vpc.v1.AllocationService service.

    interface AllocationServiceBaseClient {
        create(
            request: CreateAllocationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        delete(
            request: DeleteAllocationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
        get(
            request: GetAllocationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Allocation) => void,
        ): SurfaceCall;
        getByName(
            request: GetAllocationByNameRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Allocation) => void,
        ): SurfaceCall;
        list(
            request: ListAllocationsRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListAllocationsResponse,
            ) => void,
        ): SurfaceCall;
        listAggregated(
            request: ListAggregatedAllocationsRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListAllocationsResponse,
            ) => void,
        ): SurfaceCall;
        listByPool(
            request: ListAllocationsByPoolRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListAllocationsResponse,
            ) => void,
        ): SurfaceCall;
        listBySubnet(
            request: ListAllocationsBySubnetRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (
                error: ServiceError | null,
                response: ListAllocationsResponse,
            ) => void,
        ): SurfaceCall;
        update(
            request: UpdateAllocationRequest,
            metadata: Metadata,
            options: Partial<CallOptions>,
            callback: (error: ServiceError | null, response: Operation) => void,
        ): SurfaceCall;
    }

    Hierarchy

    • Client
      • AllocationServiceBaseClient
    Index
    create delete get getByName list listAggregated listByPool listBySubnet update

    • Creates a new allocation with the specified configuration.

      Parameters

      • request: CreateAllocationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Creates a new allocation with the specified configuration.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Deletes an allocation by its ID.

      Parameters

      • request: DeleteAllocationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Deletes an allocation by its ID.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    • Retrieves an allocation by its ID.

      Parameters

      • request: GetAllocationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Allocation) => void
          • (error: ServiceError | null, response: Allocation): void

          • Retrieves an allocation by its ID.

            Parameters

            Returns void

      Returns SurfaceCall

    • Retrieves an allocation by its name within a specified parent.

      Parameters

      • request: GetAllocationByNameRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Allocation) => void
          • (error: ServiceError | null, response: Allocation): void

          • Retrieves an allocation by its name within a specified parent.

            Parameters

            Returns void

      Returns SurfaceCall

    • Lists allocations within a specified parent.

      Parameters

      Returns SurfaceCall

    • Lists allocations across regions for the specified parent.

      Parameters

      Returns SurfaceCall

    • Lists allocations from a specified pool.

      Parameters

      Returns SurfaceCall

    • Lists allocations available to a specified subnet, including unassigned allocations from compatible pools.

      Parameters

      Returns SurfaceCall

    • Updates an existing allocation with new configuration parameters.

      Parameters

      • request: UpdateAllocationRequest
      • metadata: Metadata
      • options: Partial<CallOptions>
      • callback: (error: ServiceError | null, response: Operation) => void
          • (error: ServiceError | null, response: Operation): void

          • Updates an existing allocation with new configuration parameters.

            Parameters

            • error: ServiceError | null
            • response: Operation

            Returns void

      Returns SurfaceCall

    Settings
    Member Visibility

    On This Page
    Methods