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>>

  Creates a new allocation with the specified configuration.

  Parameters

  • request: CreateAllocationRequest

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Creates a new allocation with the specified configuration.

  Parameters

  • request: CreateAllocationRequest
  • metadata: Metadata

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Creates a new allocation with the specified configuration.

  Parameters

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

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Creates a new allocation with the specified configuration.

  Parameters

  • request: CreateAllocationRequest

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Creates a new allocation with the specified configuration.

  Parameters

  • request: CreateAllocationRequest
  • metadata: Metadata

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

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

  Creates a new allocation with the specified configuration.

  Parameters

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

  Returns Request<CreateAllocationRequest, Operation<GetOperationRequest>>

delete

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

  Deletes an allocation by its ID.

  Parameters

  • request: DeleteAllocationRequest

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Deletes an allocation by its ID.

  Parameters

  • request: DeleteAllocationRequest
  • metadata: Metadata

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Deletes an allocation by its ID.

  Parameters

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

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Deletes an allocation by its ID.

  Parameters

  • request: DeleteAllocationRequest

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Deletes an allocation by its ID.

  Parameters

  • request: DeleteAllocationRequest
  • metadata: Metadata

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

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

  Deletes an allocation by its ID.

  Parameters

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

  Returns Request<DeleteAllocationRequest, Operation<GetOperationRequest>>

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<Allocation>

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

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

  Parameters

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

  Returns AsyncGenerator<Allocation>

get

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

  Retrieves an allocation by its ID.

  Parameters

  • request: GetAllocationRequest

  Returns Request<GetAllocationRequest, Allocation>

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

  Retrieves an allocation by its ID.

  Parameters

  • request: GetAllocationRequest
  • metadata: Metadata

  Returns Request<GetAllocationRequest, Allocation>

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

  Retrieves an allocation by its ID.

  Parameters

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

  Returns Request<GetAllocationRequest, Allocation>

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

  Retrieves an allocation by its ID.

  Parameters

  • request: GetAllocationRequest

  Returns Request<GetAllocationRequest, Allocation>

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

  Retrieves an allocation by its ID.

  Parameters

  • request: GetAllocationRequest
  • metadata: Metadata

  Returns Request<GetAllocationRequest, Allocation>

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

  Retrieves an allocation by its ID.

  Parameters

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

  Returns Request<GetAllocationRequest, Allocation>

getByName

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

  Retrieves an allocation by its name within a specified parent.

  Parameters

  • request: GetAllocationByNameRequest

  Returns Request<GetAllocationByNameRequest, Allocation>

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

  Retrieves an allocation by its name within a specified parent.

  Parameters

  • request: GetAllocationByNameRequest
  • metadata: Metadata

  Returns Request<GetAllocationByNameRequest, Allocation>

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

  Retrieves an allocation by its name within a specified parent.

  Parameters

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

  Returns Request<GetAllocationByNameRequest, Allocation>

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

  Retrieves an allocation by its name within a specified parent.

  Parameters

  • request: GetAllocationByNameRequest

  Returns Request<GetAllocationByNameRequest, Allocation>

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

  Retrieves an allocation by its name within a specified parent.

  Parameters

  • request: GetAllocationByNameRequest
  • metadata: Metadata

  Returns Request<GetAllocationByNameRequest, Allocation>

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

  Retrieves an allocation by its name within a specified parent.

  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>

  Lists allocations within a specified parent.

  Parameters

  • request: ListAllocationsRequest

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

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

  Lists allocations within a specified parent.

  Parameters

  • request: ListAllocationsRequest
  • metadata: Metadata

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

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

  Lists allocations within a specified parent.

  Parameters

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

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

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

  Lists allocations within a specified parent.

  Parameters

  • request: ListAllocationsRequest

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

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

  Lists allocations within a specified parent.

  Parameters

  • request: ListAllocationsRequest
  • metadata: Metadata

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

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

  Lists allocations within a specified parent.

  Parameters

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

  Returns Request<ListAllocationsRequest, ListAllocationsResponse>

listAggregated

• listAggregated(
      request: ListAggregatedAllocationsRequest,
  ): Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

  Lists allocations across regions for the specified parent.

  Parameters

  • request: ListAggregatedAllocationsRequest

  Returns Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

• listAggregated(
      request: ListAggregatedAllocationsRequest,
      metadata: Metadata,
  ): Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

  Lists allocations across regions for the specified parent.

  Parameters

  • request: ListAggregatedAllocationsRequest
  • metadata: Metadata

  Returns Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

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

  Lists allocations across regions for the specified parent.

  Parameters

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

  Returns Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

• listAggregated(
      request: ListAggregatedAllocationsRequest,
  ): Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

  Lists allocations across regions for the specified parent.

  Parameters

  • request: ListAggregatedAllocationsRequest

  Returns Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

• listAggregated(
      request: ListAggregatedAllocationsRequest,
      metadata: Metadata,
  ): Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

  Lists allocations across regions for the specified parent.

  Parameters

  • request: ListAggregatedAllocationsRequest
  • metadata: Metadata

  Returns Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

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

  Lists allocations across regions for the specified parent.

  Parameters

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

  Returns Request<ListAggregatedAllocationsRequest, ListAllocationsResponse>

listByPool

• listByPool(
      request: ListAllocationsByPoolRequest,
  ): Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

  Lists allocations from a specified pool.

  Parameters

  • request: ListAllocationsByPoolRequest

  Returns Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

• listByPool(
      request: ListAllocationsByPoolRequest,
      metadata: Metadata,
  ): Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

  Lists allocations from a specified pool.

  Parameters

  • request: ListAllocationsByPoolRequest
  • metadata: Metadata

  Returns Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

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

  Lists allocations from a specified pool.

  Parameters

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

  Returns Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

• listByPool(
      request: ListAllocationsByPoolRequest,
  ): Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

  Lists allocations from a specified pool.

  Parameters

  • request: ListAllocationsByPoolRequest

  Returns Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

• listByPool(
      request: ListAllocationsByPoolRequest,
      metadata: Metadata,
  ): Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

  Lists allocations from a specified pool.

  Parameters

  • request: ListAllocationsByPoolRequest
  • metadata: Metadata

  Returns Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

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

  Lists allocations from a specified pool.

  Parameters

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

  Returns Request<ListAllocationsByPoolRequest, ListAllocationsResponse>

listBySubnet

• listBySubnet(
      request: ListAllocationsBySubnetRequest,
  ): Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

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

  Parameters

  • request: ListAllocationsBySubnetRequest

  Returns Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

• listBySubnet(
      request: ListAllocationsBySubnetRequest,
      metadata: Metadata,
  ): Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

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

  Parameters

  • request: ListAllocationsBySubnetRequest
  • metadata: Metadata

  Returns Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

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

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

  Parameters

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

  Returns Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

• listBySubnet(
      request: ListAllocationsBySubnetRequest,
  ): Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

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

  Parameters

  • request: ListAllocationsBySubnetRequest

  Returns Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

• listBySubnet(
      request: ListAllocationsBySubnetRequest,
      metadata: Metadata,
  ): Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

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

  Parameters

  • request: ListAllocationsBySubnetRequest
  • metadata: Metadata

  Returns Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

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

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

  Parameters

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

  Returns Request<ListAllocationsBySubnetRequest, ListAllocationsResponse>

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: UpdateAllocationRequest,
  ): Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

  Updates an existing allocation with new configuration parameters.

  Parameters

  • request: UpdateAllocationRequest

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Updates an existing allocation with new configuration parameters.

  Parameters

  • request: UpdateAllocationRequest
  • metadata: Metadata

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Updates an existing allocation with new configuration parameters.

  Parameters

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

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Updates an existing allocation with new configuration parameters.

  Parameters

  • request: UpdateAllocationRequest

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Updates an existing allocation with new configuration parameters.

  Parameters

  • request: UpdateAllocationRequest
  • metadata: Metadata

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>

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

  Updates an existing allocation with new configuration parameters.

  Parameters

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

  Returns Request<UpdateAllocationRequest, Operation<GetOperationRequest>>