Capacity Planner v1beta API - Class UsageService.UsageServiceClient (1.0.0-beta01)

public class UsageService.UsageServiceClient : ClientBase<UsageService.UsageServiceClient>

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

Client for UsageService

Inheritance

object > ClientBase > ClientBaseUsageServiceUsageServiceClient > UsageService.UsageServiceClient

Inherited Members

ClientBase<UsageService.UsageServiceClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.CapacityPlanner.V1Beta

Assembly

Google.Cloud.CapacityPlanner.V1Beta.dll

Constructors

UsageServiceClient()

protected UsageServiceClient()

Protected parameterless constructor to allow creation of test doubles.

UsageServiceClient(CallInvoker)

public UsageServiceClient(CallInvoker callInvoker)

Creates a new client for UsageService that uses a custom CallInvoker.

Parameter
Name	Description
callInvoker	CallInvoker The callInvoker to use to make remote calls.

UsageServiceClient(ChannelBase)

public UsageServiceClient(ChannelBase channel)

Creates a new client for UsageService

Parameter
Name	Description
channel	ChannelBase The channel to use to make remote calls.

UsageServiceClient(ClientBaseConfiguration)

protected UsageServiceClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
OperationsOperationsClient	A new Operations client for the same target as this client.

ExportForecasts(ExportForecastsRequest, CallOptions)

public virtual Operation ExportForecasts(ExportForecastsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportForecasts(ExportForecastsRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportForecasts(ExportForecastsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ExportForecastsAsync(ExportForecastsRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportForecastsAsync(ExportForecastsRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportForecastsAsync(ExportForecastsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportForecastsAsync(ExportForecastsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportReservationsUsage(ExportReservationsUsageRequest, CallOptions)

public virtual Operation ExportReservationsUsage(ExportReservationsUsageRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportReservationsUsage(ExportReservationsUsageRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportReservationsUsage(ExportReservationsUsageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ExportReservationsUsageAsync(ExportReservationsUsageRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportReservationsUsageAsync(ExportReservationsUsageRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportReservationsUsageAsync(ExportReservationsUsageRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportReservationsUsageAsync(ExportReservationsUsageRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportUsageHistories(ExportUsageHistoriesRequest, CallOptions)

public virtual Operation ExportUsageHistories(ExportUsageHistoriesRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
Operation	The response received from the server.

ExportUsageHistories(ExportUsageHistoriesRequest, Metadata, DateTime?, CancellationToken)

public virtual Operation ExportUsageHistories(ExportUsageHistoriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
Operation	The response received from the server.

ExportUsageHistoriesAsync(ExportUsageHistoriesRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> ExportUsageHistoriesAsync(ExportUsageHistoriesRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

ExportUsageHistoriesAsync(ExportUsageHistoriesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Operation> ExportUsageHistoriesAsync(ExportUsageHistoriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

NewInstance(ClientBaseConfiguration)

protected override UsageService.UsageServiceClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
UsageServiceUsageServiceClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.CapacityPlanner.V1Beta.UsageService.UsageServiceClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

QueryForecasts(QueryForecastsRequest, CallOptions)

public virtual QueryForecastsResponse QueryForecasts(QueryForecastsRequest request, CallOptions options)

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

Parameters
Name	Description
request	QueryForecastsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
QueryForecastsResponse	The response received from the server.

QueryForecasts(QueryForecastsRequest, Metadata, DateTime?, CancellationToken)

public virtual QueryForecastsResponse QueryForecasts(QueryForecastsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	QueryForecastsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
QueryForecastsResponse	The response received from the server.

QueryForecastsAsync(QueryForecastsRequest, CallOptions)

public virtual AsyncUnaryCall<QueryForecastsResponse> QueryForecastsAsync(QueryForecastsRequest request, CallOptions options)

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

Parameters
Name	Description
request	QueryForecastsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallQueryForecastsResponse	The call object.

QueryForecastsAsync(QueryForecastsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<QueryForecastsResponse> QueryForecastsAsync(QueryForecastsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	QueryForecastsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallQueryForecastsResponse	The call object.

QueryReservations(QueryReservationsRequest, CallOptions)

public virtual QueryReservationsResponse QueryReservations(QueryReservationsRequest request, CallOptions options)

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

Parameters
Name	Description
request	QueryReservationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
QueryReservationsResponse	The response received from the server.

QueryReservations(QueryReservationsRequest, Metadata, DateTime?, CancellationToken)

public virtual QueryReservationsResponse QueryReservations(QueryReservationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	QueryReservationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
QueryReservationsResponse	The response received from the server.

QueryReservationsAsync(QueryReservationsRequest, CallOptions)

public virtual AsyncUnaryCall<QueryReservationsResponse> QueryReservationsAsync(QueryReservationsRequest request, CallOptions options)

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

Parameters
Name	Description
request	QueryReservationsRequest The request to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallQueryReservationsResponse	The call object.

QueryReservationsAsync(QueryReservationsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<QueryReservationsResponse> QueryReservationsAsync(QueryReservationsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	QueryReservationsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallQueryReservationsResponse	The call object.

QueryUsageHistories(QueryUsageHistoriesRequest, CallOptions)

public virtual QueryUsageHistoriesResponse QueryUsageHistories(QueryUsageHistoriesRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
QueryUsageHistoriesResponse	The response received from the server.

QueryUsageHistories(QueryUsageHistoriesRequest, Metadata, DateTime?, CancellationToken)

public virtual QueryUsageHistoriesResponse QueryUsageHistories(QueryUsageHistoriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
QueryUsageHistoriesResponse	The response received from the server.

QueryUsageHistoriesAsync(QueryUsageHistoriesRequest, CallOptions)

public virtual AsyncUnaryCall<QueryUsageHistoriesResponse> QueryUsageHistoriesAsync(QueryUsageHistoriesRequest request, CallOptions options)

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 to send to the server.
options	CallOptions The options for the call.

Returns
Type	Description
AsyncUnaryCallQueryUsageHistoriesResponse	The call object.

QueryUsageHistoriesAsync(QueryUsageHistoriesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<QueryUsageHistoriesResponse> QueryUsageHistoriesAsync(QueryUsageHistoriesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	System.DateTime An optional deadline for the call. The call will be cancelled if deadline is hit.
cancellationToken	CancellationToken An optional token for canceling the call.

Returns
Type	Description
AsyncUnaryCallQueryUsageHistoriesResponse	The call object.