Class PricingPolicyService

constructor

• new PricingPolicyService(sdk: SDKInterface): PricingPolicyService

  Creates a client that uses the SDK service address.

  Parameters

  • sdk: SDKInterface

  Returns PricingPolicyService

$type

create

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

  Creates a pricing policy. A max_price outside the allowed price range fails with OUT_OF_RANGE; below the current market price it is accepted but the policy starts SCHEDULING_STATE_BLOCKED. Policies per tenant are quota-limited (RESOURCE_EXHAUSTED past the limit). The Operation completes once the policy is ready to back VMs.

  Parameters

  • request: CreatePricingPolicyRequest

  Returns Request<CreatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Creates a pricing policy. A max_price outside the allowed price range fails with OUT_OF_RANGE; below the current market price it is accepted but the policy starts SCHEDULING_STATE_BLOCKED. Policies per tenant are quota-limited (RESOURCE_EXHAUSTED past the limit). The Operation completes once the policy is ready to back VMs.

  Parameters

  • request: CreatePricingPolicyRequest
  • metadata: Metadata

  Returns Request<CreatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Creates a pricing policy. A max_price outside the allowed price range fails with OUT_OF_RANGE; below the current market price it is accepted but the policy starts SCHEDULING_STATE_BLOCKED. Policies per tenant are quota-limited (RESOURCE_EXHAUSTED past the limit). The Operation completes once the policy is ready to back VMs.

  Parameters

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

  Returns Request<CreatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Creates a pricing policy. A max_price outside the allowed price range fails with OUT_OF_RANGE; below the current market price it is accepted but the policy starts SCHEDULING_STATE_BLOCKED. Policies per tenant are quota-limited (RESOURCE_EXHAUSTED past the limit). The Operation completes once the policy is ready to back VMs.

  Parameters

  • request: CreatePricingPolicyRequest

  Returns Request<CreatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Creates a pricing policy. A max_price outside the allowed price range fails with OUT_OF_RANGE; below the current market price it is accepted but the policy starts SCHEDULING_STATE_BLOCKED. Policies per tenant are quota-limited (RESOURCE_EXHAUSTED past the limit). The Operation completes once the policy is ready to back VMs.

  Parameters

  • request: CreatePricingPolicyRequest
  • metadata: Metadata

  Returns Request<CreatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Creates a pricing policy. A max_price outside the allowed price range fails with OUT_OF_RANGE; below the current market price it is accepted but the policy starts SCHEDULING_STATE_BLOCKED. Policies per tenant are quota-limited (RESOURCE_EXHAUSTED past the limit). The Operation completes once the policy is ready to back VMs.

  Parameters

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

  Returns Request<CreatePricingPolicyRequest, Operation<GetOperationRequest>>

delete

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

  Deletes a pricing policy. Requires that no VM runs under the policy and nothing is being preempted (FAILED_PRECONDITION otherwise).

  Parameters

  • request: DeletePricingPolicyRequest

  Returns Request<DeletePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Deletes a pricing policy. Requires that no VM runs under the policy and nothing is being preempted (FAILED_PRECONDITION otherwise).

  Parameters

  • request: DeletePricingPolicyRequest
  • metadata: Metadata

  Returns Request<DeletePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Deletes a pricing policy. Requires that no VM runs under the policy and nothing is being preempted (FAILED_PRECONDITION otherwise).

  Parameters

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

  Returns Request<DeletePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Deletes a pricing policy. Requires that no VM runs under the policy and nothing is being preempted (FAILED_PRECONDITION otherwise).

  Parameters

  • request: DeletePricingPolicyRequest

  Returns Request<DeletePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Deletes a pricing policy. Requires that no VM runs under the policy and nothing is being preempted (FAILED_PRECONDITION otherwise).

  Parameters

  • request: DeletePricingPolicyRequest
  • metadata: Metadata

  Returns Request<DeletePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Deletes a pricing policy. Requires that no VM runs under the policy and nothing is being preempted (FAILED_PRECONDITION otherwise).

  Parameters

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

  Returns Request<DeletePricingPolicyRequest, Operation<GetOperationRequest>>

filter

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

  Calls the filter method.

  Parameters

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

  Returns AsyncGenerator<PricingPolicy>

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

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

  Parameters

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

  Returns AsyncGenerator<PricingPolicy>

get

• get(
      request: GetPricingPolicyRequest,
  ): Request<GetPricingPolicyRequest, PricingPolicy>

  Calls the Get RPC.

  Parameters

  • request: GetPricingPolicyRequest

  Returns Request<GetPricingPolicyRequest, PricingPolicy>

• get(
      request: GetPricingPolicyRequest,
      metadata: Metadata,
  ): Request<GetPricingPolicyRequest, PricingPolicy>

  Calls the Get RPC.

  Parameters

  • request: GetPricingPolicyRequest
  • metadata: Metadata

  Returns Request<GetPricingPolicyRequest, PricingPolicy>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetPricingPolicyRequest, PricingPolicy>

• get(
      request: GetPricingPolicyRequest,
  ): Request<GetPricingPolicyRequest, PricingPolicy>

  Calls the Get RPC.

  Parameters

  • request: GetPricingPolicyRequest

  Returns Request<GetPricingPolicyRequest, PricingPolicy>

• get(
      request: GetPricingPolicyRequest,
      metadata: Metadata,
  ): Request<GetPricingPolicyRequest, PricingPolicy>

  Calls the Get RPC.

  Parameters

  • request: GetPricingPolicyRequest
  • metadata: Metadata

  Returns Request<GetPricingPolicyRequest, PricingPolicy>

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

  Calls the Get RPC.

  Parameters

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

  Returns Request<GetPricingPolicyRequest, PricingPolicy>

getByName

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

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, PricingPolicy>

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

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, PricingPolicy>

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

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetByNameRequest, PricingPolicy>

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

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest

  Returns Request<GetByNameRequest, PricingPolicy>

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

  Calls the GetByName RPC.

  Parameters

  • request: GetByNameRequest
  • metadata: Metadata

  Returns Request<GetByNameRequest, PricingPolicy>

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

  Calls the GetByName RPC.

  Parameters

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

  Returns Request<GetByNameRequest, PricingPolicy>

getOperationService

• getOperationService(): OperationService

  Returns the operation service for this service address.

  Returns OperationService

list

• list(
      request: ListPricingPoliciesRequest,
  ): Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

  Calls the List RPC.

  Parameters

  • request: ListPricingPoliciesRequest

  Returns Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

• list(
      request: ListPricingPoliciesRequest,
      metadata: Metadata,
  ): Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

  Calls the List RPC.

  Parameters

  • request: ListPricingPoliciesRequest
  • metadata: Metadata

  Returns Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

• list(
      request: ListPricingPoliciesRequest,
  ): Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

  Calls the List RPC.

  Parameters

  • request: ListPricingPoliciesRequest

  Returns Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

• list(
      request: ListPricingPoliciesRequest,
      metadata: Metadata,
  ): Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

  Calls the List RPC.

  Parameters

  • request: ListPricingPoliciesRequest
  • metadata: Metadata

  Returns Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

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

  Calls the List RPC.

  Parameters

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

  Returns Request<ListPricingPoliciesRequest, ListPricingPoliciesResponse>

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

  Updates a pricing policy. metadata.name may change any time; the max_price in spec.pricing.max_price_v1 only while status.running_vm_count is 0 (FAILED_PRECONDITION otherwise). Other spec fields are immutable (INVALID_ARGUMENT).

  Parameters

  • request: UpdatePricingPolicyRequest

  Returns Request<UpdatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Updates a pricing policy. metadata.name may change any time; the max_price in spec.pricing.max_price_v1 only while status.running_vm_count is 0 (FAILED_PRECONDITION otherwise). Other spec fields are immutable (INVALID_ARGUMENT).

  Parameters

  • request: UpdatePricingPolicyRequest
  • metadata: Metadata

  Returns Request<UpdatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Updates a pricing policy. metadata.name may change any time; the max_price in spec.pricing.max_price_v1 only while status.running_vm_count is 0 (FAILED_PRECONDITION otherwise). Other spec fields are immutable (INVALID_ARGUMENT).

  Parameters

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

  Returns Request<UpdatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Updates a pricing policy. metadata.name may change any time; the max_price in spec.pricing.max_price_v1 only while status.running_vm_count is 0 (FAILED_PRECONDITION otherwise). Other spec fields are immutable (INVALID_ARGUMENT).

  Parameters

  • request: UpdatePricingPolicyRequest

  Returns Request<UpdatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Updates a pricing policy. metadata.name may change any time; the max_price in spec.pricing.max_price_v1 only while status.running_vm_count is 0 (FAILED_PRECONDITION otherwise). Other spec fields are immutable (INVALID_ARGUMENT).

  Parameters

  • request: UpdatePricingPolicyRequest
  • metadata: Metadata

  Returns Request<UpdatePricingPolicyRequest, Operation<GetOperationRequest>>

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

  Updates a pricing policy. metadata.name may change any time; the max_price in spec.pricing.max_price_v1 only while status.running_vm_count is 0 (FAILED_PRECONDITION otherwise). Other spec fields are immutable (INVALID_ARGUMENT).

  Parameters

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

  Returns Request<UpdatePricingPolicyRequest, Operation<GetOperationRequest>>