Class AllocationService

constructor

• new AllocationService(sdk: SDKInterface): AllocationService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns AllocationService

$type

create

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

  Calls the Create RPC.

  Parameters

  • request: CreateAllocationRequest

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

  • request: CreateAllocationRequest
  • metadata: Metadata

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

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

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

  • request: CreateAllocationRequest

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

  • request: CreateAllocationRequest
  • metadata: Metadata

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Create RPC.

  Parameters

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

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

delete

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

  Calls the Delete RPC.

  Parameters

  • request: DeleteAllocationRequest

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

  • request: DeleteAllocationRequest
  • metadata: Metadata

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

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

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

  • request: DeleteAllocationRequest

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

  • request: DeleteAllocationRequest
  • metadata: Metadata

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Delete RPC.

  Parameters

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

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

get

• get(request: GetAllocationRequest): Request<GetAllocationRequest, Allocation>

  Calls the Get RPC.

  Parameters

  • request: GetAllocationRequest

  Returns Request<GetAllocationRequest, Allocation>

• get(
      request: GetAllocationRequest,
      metadata: Metadata,
  ): Request<GetAllocationRequest, Allocation>

  Calls the Get RPC.

  Parameters

  • request: GetAllocationRequest
  • metadata: Metadata

  Returns Request<GetAllocationRequest, Allocation>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetAllocationRequest, Allocation>

• get(request: GetAllocationRequest): Request<GetAllocationRequest, Allocation>

  Calls the Get RPC.

  Parameters

  • request: GetAllocationRequest

  Returns Request<GetAllocationRequest, Allocation>

• get(
      request: GetAllocationRequest,
      metadata: Metadata,
  ): Request<GetAllocationRequest, Allocation>

  Calls the Get RPC.

  Parameters

  • request: GetAllocationRequest
  • metadata: Metadata

  Returns Request<GetAllocationRequest, Allocation>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetAllocationRequest, Allocation>

getByName

• getByName(
      request: GetAllocationByNameRequest,
  ): Request<GetAllocationByNameRequest, Allocation>

  Calls the GetByName RPC.

  Parameters

  • request: GetAllocationByNameRequest

  Returns Request<GetAllocationByNameRequest, Allocation>

• getByName(
      request: GetAllocationByNameRequest,
      metadata: Metadata,
  ): Request<GetAllocationByNameRequest, Allocation>

  Calls the GetByName RPC.

  Parameters

  • request: GetAllocationByNameRequest
  • metadata: Metadata

  Returns Request<GetAllocationByNameRequest, Allocation>

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

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetAllocationByNameRequest, Allocation>

• getByName(
      request: GetAllocationByNameRequest,
  ): Request<GetAllocationByNameRequest, Allocation>

  Calls the GetByName RPC.

  Parameters

  • request: GetAllocationByNameRequest

  Returns Request<GetAllocationByNameRequest, Allocation>

• getByName(
      request: GetAllocationByNameRequest,
      metadata: Metadata,
  ): Request<GetAllocationByNameRequest, Allocation>

  Calls the GetByName RPC.

  Parameters

  • request: GetAllocationByNameRequest
  • metadata: Metadata

  Returns Request<GetAllocationByNameRequest, Allocation>

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

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetAllocationByNameRequest, Allocation>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListAllocationsRequest,
  ): Request<ListAllocationsRequest, ListAllocationsResponse>

  Calls the List RPC.

  Parameters

  • request: ListAllocationsRequest

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

• list(
      request: ListAllocationsRequest,
      metadata: Metadata,
  ): Request<ListAllocationsRequest, ListAllocationsResponse>

  Calls the List RPC.

  Parameters

  • request: ListAllocationsRequest
  • metadata: Metadata

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

• list(
      request: ListAllocationsRequest,
  ): Request<ListAllocationsRequest, ListAllocationsResponse>

  Calls the List RPC.

  Parameters

  • request: ListAllocationsRequest

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

• list(
      request: ListAllocationsRequest,
      metadata: Metadata,
  ): Request<ListAllocationsRequest, ListAllocationsResponse>

  Calls the List RPC.

  Parameters

  • request: ListAllocationsRequest
  • metadata: Metadata

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

update

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

  Calls the Update RPC.

  Parameters

  • request: UpdateAllocationRequest

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Update RPC.

  Parameters

  • request: UpdateAllocationRequest
  • metadata: Metadata

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Update RPC.

  Parameters

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

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Update RPC.

  Parameters

  • request: UpdateAllocationRequest

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Update RPC.

  Parameters

  • request: UpdateAllocationRequest
  • metadata: Metadata

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Calls the Update RPC.

  Parameters

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

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>