Cloud Billing Budget v1 API - Class BudgetServiceClientImpl (2.5.0)

Version latest

• 2.5.0 (latest)
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.2.0
• 1.1.0

public sealed class BudgetServiceClientImpl : BudgetServiceClient

Reference documentation and code samples for the Cloud Billing Budget v1 API class BudgetServiceClientImpl.

BudgetService client wrapper implementation, for convenient use.

Inheritance

object > BudgetServiceClient > BudgetServiceClientImpl

Inherited Members

BudgetServiceClient.DefaultEndpoint

BudgetServiceClient.DefaultScopes

BudgetServiceClient.ServiceMetadata

BudgetServiceClient.CreateAsync(CancellationToken)

BudgetServiceClient.Create()

BudgetServiceClient.ShutdownDefaultChannelsAsync()

BudgetServiceClient.CreateBudgetAsync(CreateBudgetRequest, CancellationToken)

BudgetServiceClient.CreateBudget(string, Budget, CallSettings)

BudgetServiceClient.CreateBudgetAsync(string, Budget, CallSettings)

BudgetServiceClient.CreateBudgetAsync(string, Budget, CancellationToken)

BudgetServiceClient.CreateBudget(BillingAccountName, Budget, CallSettings)

BudgetServiceClient.CreateBudgetAsync(BillingAccountName, Budget, CallSettings)

BudgetServiceClient.CreateBudgetAsync(BillingAccountName, Budget, CancellationToken)

BudgetServiceClient.UpdateBudgetAsync(UpdateBudgetRequest, CancellationToken)

BudgetServiceClient.UpdateBudget(Budget, FieldMask, CallSettings)

BudgetServiceClient.UpdateBudgetAsync(Budget, FieldMask, CallSettings)

BudgetServiceClient.UpdateBudgetAsync(Budget, FieldMask, CancellationToken)

BudgetServiceClient.GetBudgetAsync(GetBudgetRequest, CancellationToken)

BudgetServiceClient.GetBudget(string, CallSettings)

BudgetServiceClient.GetBudgetAsync(string, CallSettings)

BudgetServiceClient.GetBudgetAsync(string, CancellationToken)

BudgetServiceClient.GetBudget(BudgetName, CallSettings)

BudgetServiceClient.GetBudgetAsync(BudgetName, CallSettings)

BudgetServiceClient.GetBudgetAsync(BudgetName, CancellationToken)

BudgetServiceClient.ListBudgets(string, string, int?, CallSettings)

BudgetServiceClient.ListBudgetsAsync(string, string, int?, CallSettings)

BudgetServiceClient.ListBudgets(BillingAccountName, string, int?, CallSettings)

BudgetServiceClient.ListBudgetsAsync(BillingAccountName, string, int?, CallSettings)

BudgetServiceClient.DeleteBudgetAsync(DeleteBudgetRequest, CancellationToken)

BudgetServiceClient.DeleteBudget(string, CallSettings)

BudgetServiceClient.DeleteBudgetAsync(string, CallSettings)

BudgetServiceClient.DeleteBudgetAsync(string, CancellationToken)

BudgetServiceClient.DeleteBudget(BudgetName, CallSettings)

BudgetServiceClient.DeleteBudgetAsync(BudgetName, CallSettings)

BudgetServiceClient.DeleteBudgetAsync(BudgetName, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Billing.Budgets.V1

Assembly

Google.Cloud.Billing.Budgets.V1.dll

Remarks

BudgetService stores Cloud Billing budgets, which define a budget plan and rules to execute as we track spend against that plan.

Constructors

BudgetServiceClientImpl(BudgetServiceClient, BudgetServiceSettings, ILogger)

public BudgetServiceClientImpl(BudgetService.BudgetServiceClient grpcClient, BudgetServiceSettings settings, ILogger logger)

Constructs a client wrapper for the BudgetService service, with the specified gRPC client and settings.

Parameters
Name	Description
grpcClient	BudgetServiceBudgetServiceClient The underlying gRPC client.
settings	BudgetServiceSettings The base BudgetServiceSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

GrpcClient

public override BudgetService.BudgetServiceClient GrpcClient { get; }

The underlying gRPC BudgetService client

Property Value
Type	Description
BudgetServiceBudgetServiceClient

Overrides

BudgetServiceClient.GrpcClient

Methods

CreateBudget(CreateBudgetRequest, CallSettings)

public override Budget CreateBudget(CreateBudgetRequest request, CallSettings callSettings = null)

Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.

Parameters
Name	Description
request	CreateBudgetRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Budget	The RPC response.

Overrides

BudgetServiceClient.CreateBudget(CreateBudgetRequest, CallSettings)

CreateBudgetAsync(CreateBudgetRequest, CallSettings)

public override Task<Budget> CreateBudgetAsync(CreateBudgetRequest request, CallSettings callSettings = null)

Creates a new budget. See Quotas and limits for more information on the limits of the number of budgets you can create.

Parameters
Name	Description
request	CreateBudgetRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBudget	A Task containing the RPC response.

Overrides

BudgetServiceClient.CreateBudgetAsync(CreateBudgetRequest, CallSettings)

DeleteBudget(DeleteBudgetRequest, CallSettings)

public override void DeleteBudget(DeleteBudgetRequest request, CallSettings callSettings = null)

Deletes a budget. Returns successfully if already deleted.

Parameters
Name	Description
request	DeleteBudgetRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Overrides

BudgetServiceClient.DeleteBudget(DeleteBudgetRequest, CallSettings)

DeleteBudgetAsync(DeleteBudgetRequest, CallSettings)

public override Task DeleteBudgetAsync(DeleteBudgetRequest request, CallSettings callSettings = null)

Deletes a budget. Returns successfully if already deleted.

Parameters
Name	Description
request	DeleteBudgetRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Task	A Task containing the RPC response.

Overrides

BudgetServiceClient.DeleteBudgetAsync(DeleteBudgetRequest, CallSettings)

GetBudget(GetBudgetRequest, CallSettings)

public override Budget GetBudget(GetBudgetRequest request, CallSettings callSettings = null)

Returns a budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.

Parameters
Name	Description
request	GetBudgetRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Budget	The RPC response.

Overrides

BudgetServiceClient.GetBudget(GetBudgetRequest, CallSettings)

GetBudgetAsync(GetBudgetRequest, CallSettings)

public override Task<Budget> GetBudgetAsync(GetBudgetRequest request, CallSettings callSettings = null)

Returns a budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.

Parameters
Name	Description
request	GetBudgetRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBudget	A Task containing the RPC response.

Overrides

BudgetServiceClient.GetBudgetAsync(GetBudgetRequest, CallSettings)

ListBudgets(ListBudgetsRequest, CallSettings)

public override PagedEnumerable<ListBudgetsResponse, Budget> ListBudgets(ListBudgetsRequest request, CallSettings callSettings = null)

Returns a list of budgets for a billing account.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.

Parameters
Name	Description
request	ListBudgetsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedEnumerableListBudgetsResponseBudget	A pageable sequence of Budget resources.

Overrides

BudgetServiceClient.ListBudgets(ListBudgetsRequest, CallSettings)

ListBudgetsAsync(ListBudgetsRequest, CallSettings)

public override PagedAsyncEnumerable<ListBudgetsResponse, Budget> ListBudgetsAsync(ListBudgetsRequest request, CallSettings callSettings = null)

Returns a list of budgets for a billing account.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. When reading from the API, you will not see these fields in the return value, though they may have been set in the Cloud Console.

Parameters
Name	Description
request	ListBudgetsRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
PagedAsyncEnumerableListBudgetsResponseBudget	A pageable asynchronous sequence of Budget resources.

Overrides

BudgetServiceClient.ListBudgetsAsync(ListBudgetsRequest, CallSettings)

UpdateBudget(UpdateBudgetRequest, CallSettings)

public override Budget UpdateBudget(UpdateBudgetRequest request, CallSettings callSettings = null)

Updates a budget and returns the updated budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method.

Parameters
Name	Description
request	UpdateBudgetRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
Budget	The RPC response.

Overrides

BudgetServiceClient.UpdateBudget(UpdateBudgetRequest, CallSettings)

UpdateBudgetAsync(UpdateBudgetRequest, CallSettings)

public override Task<Budget> UpdateBudgetAsync(UpdateBudgetRequest request, CallSettings callSettings = null)

Updates a budget and returns the updated budget.

WARNING: There are some fields exposed on the Google Cloud Console that aren't available on this API. Budget fields that are not exposed in this API will not be changed by this method.

Parameters
Name	Description
request	UpdateBudgetRequest The request object containing all of the parameters for the API call.
callSettings	CallSettings If not null, applies overrides to this RPC call.

Returns
Type	Description
TaskBudget	A Task containing the RPC response.

Overrides

BudgetServiceClient.UpdateBudgetAsync(UpdateBudgetRequest, CallSettings)