Capacity Planner v1beta API - Class UsageServiceClientImpl (1.0.0-beta01)

public sealed class UsageServiceClientImpl : UsageServiceClient

Reference documentation and code samples for the Capacity Planner v1beta API class UsageServiceClientImpl.

UsageService client wrapper implementation, for convenient use.

Inheritance

object > UsageServiceClient > UsageServiceClientImpl

Inherited Members

UsageServiceClient.DefaultEndpoint

UsageServiceClient.DefaultScopes

UsageServiceClient.ServiceMetadata

UsageServiceClient.CreateAsync(CancellationToken)

UsageServiceClient.Create()

UsageServiceClient.ShutdownDefaultChannelsAsync()

UsageServiceClient.QueryUsageHistoriesAsync(QueryUsageHistoriesRequest, CancellationToken)

UsageServiceClient.QueryForecastsAsync(QueryForecastsRequest, CancellationToken)

UsageServiceClient.QueryReservationsAsync(QueryReservationsRequest, CancellationToken)

UsageServiceClient.QueryReservations(string, CallSettings)

UsageServiceClient.QueryReservationsAsync(string, CallSettings)

UsageServiceClient.QueryReservationsAsync(string, CancellationToken)

UsageServiceClient.QueryReservations(LocationName, CallSettings)

UsageServiceClient.QueryReservationsAsync(LocationName, CallSettings)

UsageServiceClient.QueryReservationsAsync(LocationName, CancellationToken)

UsageServiceClient.ExportUsageHistoriesAsync(ExportUsageHistoriesRequest, CancellationToken)

UsageServiceClient.PollOnceExportUsageHistories(string, CallSettings)

UsageServiceClient.PollOnceExportUsageHistoriesAsync(string, CallSettings)

UsageServiceClient.ExportForecastsAsync(ExportForecastsRequest, CancellationToken)

UsageServiceClient.PollOnceExportForecasts(string, CallSettings)

UsageServiceClient.PollOnceExportForecastsAsync(string, CallSettings)

UsageServiceClient.ExportReservationsUsageAsync(ExportReservationsUsageRequest, CancellationToken)

UsageServiceClient.PollOnceExportReservationsUsage(string, CallSettings)

UsageServiceClient.PollOnceExportReservationsUsageAsync(string, CallSettings)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.CapacityPlanner.V1Beta

Assembly

Google.Cloud.CapacityPlanner.V1Beta.dll

Remarks

Provides access to historical and forecasted usage data.

Constructors

UsageServiceClientImpl(UsageServiceClient, UsageServiceSettings, ILogger)

public UsageServiceClientImpl(UsageService.UsageServiceClient grpcClient, UsageServiceSettings settings, ILogger logger)

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

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

Properties

ExportForecastsOperationsClient

public override OperationsClient ExportForecastsOperationsClient { get; }

The long-running operations client for ExportForecasts.

Property Value
Type	Description
OperationsClient

Overrides

UsageServiceClient.ExportForecastsOperationsClient

ExportReservationsUsageOperationsClient

public override OperationsClient ExportReservationsUsageOperationsClient { get; }

The long-running operations client for ExportReservationsUsage.

Property Value
Type	Description
OperationsClient

Overrides

UsageServiceClient.ExportReservationsUsageOperationsClient

ExportUsageHistoriesOperationsClient

public override OperationsClient ExportUsageHistoriesOperationsClient { get; }

The long-running operations client for ExportUsageHistories.

Property Value
Type	Description
OperationsClient

Overrides

UsageServiceClient.ExportUsageHistoriesOperationsClient

GrpcClient

public override UsageService.UsageServiceClient GrpcClient { get; }

The underlying gRPC UsageService client

Property Value
Type	Description
UsageServiceUsageServiceClient

Overrides

UsageServiceClient.GrpcClient

Methods

ExportForecasts(ExportForecastsRequest, CallSettings)

public override Operation<ExportForecastsResponse, OperationMetadata> ExportForecasts(ExportForecastsRequest request, CallSettings callSettings = null)

Exports forecasted usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table.

Parameters
Name	Description
request	ExportForecastsRequest 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
OperationExportForecastsResponseOperationMetadata	The RPC response.

Overrides

UsageServiceClient.ExportForecasts(ExportForecastsRequest, CallSettings)

ExportForecastsAsync(ExportForecastsRequest, CallSettings)

public override Task<Operation<ExportForecastsResponse, OperationMetadata>> ExportForecastsAsync(ExportForecastsRequest request, CallSettings callSettings = null)

Exports forecasted usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table.

Parameters
Name	Description
request	ExportForecastsRequest 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
TaskOperationExportForecastsResponseOperationMetadata	A Task containing the RPC response.

Overrides

UsageServiceClient.ExportForecastsAsync(ExportForecastsRequest, CallSettings)

ExportReservationsUsage(ExportReservationsUsageRequest, CallSettings)

public override Operation<ExportReservationsUsageResponse, OperationMetadata> ExportReservationsUsage(ExportReservationsUsageRequest request, CallSettings callSettings = null)

Exports reservations usage data requested by user into either an existing Cloud Storage bucket or a new/existing BigQuery table.

Parameters
Name	Description
request	ExportReservationsUsageRequest 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
OperationExportReservationsUsageResponseOperationMetadata	The RPC response.

Overrides

UsageServiceClient.ExportReservationsUsage(ExportReservationsUsageRequest, CallSettings)

ExportReservationsUsageAsync(ExportReservationsUsageRequest, CallSettings)

public override Task<Operation<ExportReservationsUsageResponse, OperationMetadata>> ExportReservationsUsageAsync(ExportReservationsUsageRequest request, CallSettings callSettings = null)

Exports reservations usage data requested by user into either an existing Cloud Storage bucket or a new/existing BigQuery table.

Parameters
Name	Description
request	ExportReservationsUsageRequest 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
TaskOperationExportReservationsUsageResponseOperationMetadata	A Task containing the RPC response.

Overrides

UsageServiceClient.ExportReservationsUsageAsync(ExportReservationsUsageRequest, CallSettings)

ExportUsageHistories(ExportUsageHistoriesRequest, CallSettings)

public override Operation<ExportUsageHistoriesResponse, OperationMetadata> ExportUsageHistories(ExportUsageHistoriesRequest request, CallSettings callSettings = null)

Exports historical usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table.

Parameters
Name	Description
request	ExportUsageHistoriesRequest 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
OperationExportUsageHistoriesResponseOperationMetadata	The RPC response.

Overrides

UsageServiceClient.ExportUsageHistories(ExportUsageHistoriesRequest, CallSettings)

ExportUsageHistoriesAsync(ExportUsageHistoriesRequest, CallSettings)

public override Task<Operation<ExportUsageHistoriesResponse, OperationMetadata>> ExportUsageHistoriesAsync(ExportUsageHistoriesRequest request, CallSettings callSettings = null)

Exports historical usage data requested by user into either an existing Cloud Storage bucket or a BigQuery table.

Parameters
Name	Description
request	ExportUsageHistoriesRequest 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
TaskOperationExportUsageHistoriesResponseOperationMetadata	A Task containing the RPC response.

Overrides

UsageServiceClient.ExportUsageHistoriesAsync(ExportUsageHistoriesRequest, CallSettings)

QueryForecasts(QueryForecastsRequest, CallSettings)

public override QueryForecastsResponse QueryForecasts(QueryForecastsRequest request, CallSettings callSettings = null)

Returns a list of the forecasts that are in the parent parameter and match your specified filters.

Parameters
Name	Description
request	QueryForecastsRequest 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
QueryForecastsResponse	The RPC response.

Overrides

UsageServiceClient.QueryForecasts(QueryForecastsRequest, CallSettings)

QueryForecastsAsync(QueryForecastsRequest, CallSettings)

public override Task<QueryForecastsResponse> QueryForecastsAsync(QueryForecastsRequest request, CallSettings callSettings = null)

Returns a list of the forecasts that are in the parent parameter and match your specified filters.

Parameters
Name	Description
request	QueryForecastsRequest 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
TaskQueryForecastsResponse	A Task containing the RPC response.

Overrides

UsageServiceClient.QueryForecastsAsync(QueryForecastsRequest, CallSettings)

QueryReservations(QueryReservationsRequest, CallSettings)

public override QueryReservationsResponse QueryReservations(QueryReservationsRequest request, CallSettings callSettings = null)

Returns a list of the reservations that are in the parent parameter and match your specified filters.

Parameters
Name	Description
request	QueryReservationsRequest 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
QueryReservationsResponse	The RPC response.

Overrides

UsageServiceClient.QueryReservations(QueryReservationsRequest, CallSettings)

QueryReservationsAsync(QueryReservationsRequest, CallSettings)

public override Task<QueryReservationsResponse> QueryReservationsAsync(QueryReservationsRequest request, CallSettings callSettings = null)

Returns a list of the reservations that are in the parent parameter and match your specified filters.

Parameters
Name	Description
request	QueryReservationsRequest 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
TaskQueryReservationsResponse	A Task containing the RPC response.

Overrides

UsageServiceClient.QueryReservationsAsync(QueryReservationsRequest, CallSettings)

QueryUsageHistories(QueryUsageHistoriesRequest, CallSettings)

public override QueryUsageHistoriesResponse QueryUsageHistories(QueryUsageHistoriesRequest request, CallSettings callSettings = null)

Returns a list of the usage histories that are in the parent parameter and match your specified filters.

Parameters
Name	Description
request	QueryUsageHistoriesRequest 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
QueryUsageHistoriesResponse	The RPC response.

Overrides

UsageServiceClient.QueryUsageHistories(QueryUsageHistoriesRequest, CallSettings)

QueryUsageHistoriesAsync(QueryUsageHistoriesRequest, CallSettings)

public override Task<QueryUsageHistoriesResponse> QueryUsageHistoriesAsync(QueryUsageHistoriesRequest request, CallSettings callSettings = null)

Returns a list of the usage histories that are in the parent parameter and match your specified filters.

Parameters
Name	Description
request	QueryUsageHistoriesRequest 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
TaskQueryUsageHistoriesResponse	A Task containing the RPC response.

Overrides

UsageServiceClient.QueryUsageHistoriesAsync(QueryUsageHistoriesRequest, CallSettings)