Class CapacityAllowanceService

constructor

• new CapacityAllowanceService(sdk: SDKInterface): CapacityAllowanceService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns CapacityAllowanceService

$type

create

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

  Creates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

  • request: CreateCapacityAllowanceRequest

  Returns Request<CreateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Creates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

  • request: CreateCapacityAllowanceRequest
  • metadata: Metadata

  Returns Request<CreateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Creates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

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

  Returns Request<CreateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Creates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

  • request: CreateCapacityAllowanceRequest

  Returns Request<CreateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Creates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

  • request: CreateCapacityAllowanceRequest
  • metadata: Metadata

  Returns Request<CreateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Creates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

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

  Returns Request<CreateCapacityAllowanceRequest, Operation<GetOperationRequest>>

delete

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

  Resets Capacity Allowance limit to the default value.

  Parameters

  • request: DeleteCapacityAllowanceRequest

  Returns Request<DeleteCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Resets Capacity Allowance limit to the default value.

  Parameters

  • request: DeleteCapacityAllowanceRequest
  • metadata: Metadata

  Returns Request<DeleteCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Resets Capacity Allowance limit to the default value.

  Parameters

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

  Returns Request<DeleteCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Resets Capacity Allowance limit to the default value.

  Parameters

  • request: DeleteCapacityAllowanceRequest

  Returns Request<DeleteCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Resets Capacity Allowance limit to the default value.

  Parameters

  • request: DeleteCapacityAllowanceRequest
  • metadata: Metadata

  Returns Request<DeleteCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Resets Capacity Allowance limit to the default value.

  Parameters

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

  Returns Request<DeleteCapacityAllowanceRequest, Operation<GetOperationRequest>>

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<CapacityAllowance>

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

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

  Parameters

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

  Returns AsyncGenerator<CapacityAllowance>

get

• get(
      request: GetCapacityAllowanceRequest,
  ): Request<GetCapacityAllowanceRequest, CapacityAllowance>

  Gets a Capacity Allowance by its ID.

  Parameters

  • request: GetCapacityAllowanceRequest

  Returns Request<GetCapacityAllowanceRequest, CapacityAllowance>

• get(
      request: GetCapacityAllowanceRequest,
      metadata: Metadata,
  ): Request<GetCapacityAllowanceRequest, CapacityAllowance>

  Gets a Capacity Allowance by its ID.

  Parameters

  • request: GetCapacityAllowanceRequest
  • metadata: Metadata

  Returns Request<GetCapacityAllowanceRequest, CapacityAllowance>

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

  Gets a Capacity Allowance by its ID.

  Parameters

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

  Returns Request<GetCapacityAllowanceRequest, CapacityAllowance>

• get(
      request: GetCapacityAllowanceRequest,
  ): Request<GetCapacityAllowanceRequest, CapacityAllowance>

  Gets a Capacity Allowance by its ID.

  Parameters

  • request: GetCapacityAllowanceRequest

  Returns Request<GetCapacityAllowanceRequest, CapacityAllowance>

• get(
      request: GetCapacityAllowanceRequest,
      metadata: Metadata,
  ): Request<GetCapacityAllowanceRequest, CapacityAllowance>

  Gets a Capacity Allowance by its ID.

  Parameters

  • request: GetCapacityAllowanceRequest
  • metadata: Metadata

  Returns Request<GetCapacityAllowanceRequest, CapacityAllowance>

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

  Gets a Capacity Allowance by its ID.

  Parameters

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

  Returns Request<GetCapacityAllowanceRequest, CapacityAllowance>

getByParentAndCapacityBlockGroup

• getByParentAndCapacityBlockGroup(
      request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
  ): Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

  Gets a Capacity Allowance by a project and a Capacity Block Group NID. Returns non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

  • request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest

  Returns Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

• getByParentAndCapacityBlockGroup(
      request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      metadata: Metadata,
  ): Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

  Gets a Capacity Allowance by a project and a Capacity Block Group NID. Returns non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

  • request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest
  • metadata: Metadata

  Returns Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

• getByParentAndCapacityBlockGroup(
      request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

  Gets a Capacity Allowance by a project and a Capacity Block Group NID. Returns non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

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

  Returns Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

• getByParentAndCapacityBlockGroup(
      request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
  ): Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

  Gets a Capacity Allowance by a project and a Capacity Block Group NID. Returns non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

  • request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest

  Returns Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

• getByParentAndCapacityBlockGroup(
      request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      metadata: Metadata,
  ): Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

  Gets a Capacity Allowance by a project and a Capacity Block Group NID. Returns non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

  • request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest
  • metadata: Metadata

  Returns Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

• getByParentAndCapacityBlockGroup(
      request: GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

  Gets a Capacity Allowance by a project and a Capacity Block Group NID. Returns non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

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

  Returns Request<
      GetCapacityAllowanceByParentAndCapacityBlockGroupRequest,
      CapacityAllowance,
  >

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListCapacityAllowancesRequest,
  ): Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

  Lists project limits. Lists non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

  • request: ListCapacityAllowancesRequest

  Returns Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

• list(
      request: ListCapacityAllowancesRequest,
      metadata: Metadata,
  ): Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

  Lists project limits. Lists non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

  • request: ListCapacityAllowancesRequest
  • metadata: Metadata

  Returns Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

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

  Lists project limits. Lists non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

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

  Returns Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

• list(
      request: ListCapacityAllowancesRequest,
  ): Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

  Lists project limits. Lists non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

  • request: ListCapacityAllowancesRequest

  Returns Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

• list(
      request: ListCapacityAllowancesRequest,
      metadata: Metadata,
  ): Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

  Lists project limits. Lists non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

  • request: ListCapacityAllowancesRequest
  • metadata: Metadata

  Returns Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

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

  Lists project limits. Lists non-created Capacity Allowances as well for clarity, showing the default limit.

  Parameters

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

  Returns Request<ListCapacityAllowancesRequest, ListCapacityAllowancesResponse>

listByCapacityBlockGroup

• listByCapacityBlockGroup(
      request: ListCapacityAllowancesByCapacityBlockGroupRequest,
  ): Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

  Lists project limits for a Capacity Block Group.

  Parameters

  • request: ListCapacityAllowancesByCapacityBlockGroupRequest

  Returns Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

• listByCapacityBlockGroup(
      request: ListCapacityAllowancesByCapacityBlockGroupRequest,
      metadata: Metadata,
  ): Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

  Lists project limits for a Capacity Block Group.

  Parameters

  • request: ListCapacityAllowancesByCapacityBlockGroupRequest
  • metadata: Metadata

  Returns Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

• listByCapacityBlockGroup(
      request: ListCapacityAllowancesByCapacityBlockGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

  Lists project limits for a Capacity Block Group.

  Parameters

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

  Returns Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

• listByCapacityBlockGroup(
      request: ListCapacityAllowancesByCapacityBlockGroupRequest,
  ): Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

  Lists project limits for a Capacity Block Group.

  Parameters

  • request: ListCapacityAllowancesByCapacityBlockGroupRequest

  Returns Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

• listByCapacityBlockGroup(
      request: ListCapacityAllowancesByCapacityBlockGroupRequest,
      metadata: Metadata,
  ): Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

  Lists project limits for a Capacity Block Group.

  Parameters

  • request: ListCapacityAllowancesByCapacityBlockGroupRequest
  • metadata: Metadata

  Returns Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

• listByCapacityBlockGroup(
      request: ListCapacityAllowancesByCapacityBlockGroupRequest,
      metadata: Metadata,
      options: Partial<CallOptions> & RetryOptions,
  ): Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

  Lists project limits for a Capacity Block Group.

  Parameters

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

  Returns Request<
      ListCapacityAllowancesByCapacityBlockGroupRequest,
      ListCapacityAllowancesResponse,
  >

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

  Updates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

  • request: UpdateCapacityAllowanceRequest

  Returns Request<UpdateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Updates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

  • request: UpdateCapacityAllowanceRequest
  • metadata: Metadata

  Returns Request<UpdateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Updates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

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

  Returns Request<UpdateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Updates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

  • request: UpdateCapacityAllowanceRequest

  Returns Request<UpdateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Updates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

  • request: UpdateCapacityAllowanceRequest
  • metadata: Metadata

  Returns Request<UpdateCapacityAllowanceRequest, Operation<GetOperationRequest>>

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

  Updates a Capacity Allowance by project ID and Capacity Block Group NID.

  Parameters

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

  Returns Request<UpdateCapacityAllowanceRequest, Operation<GetOperationRequest>>