Cloud Quotas v1 API - Class CloudQuotas.CloudQuotasClient (1.0.0-beta03)

public class CloudQuotas.CloudQuotasClient : ClientBase<CloudQuotas.CloudQuotasClient>

Reference documentation and code samples for the Cloud Quotas v1 API class CloudQuotas.CloudQuotasClient.

Client for CloudQuotas

Inheritance

object > ClientBase > ClientBaseCloudQuotasCloudQuotasClient > CloudQuotas.CloudQuotasClient

Namespace

Google.Cloud.CloudQuotas.V1

Assembly

Google.Cloud.CloudQuotas.V1.dll

Constructors

CloudQuotasClient()

protected CloudQuotasClient()

Protected parameterless constructor to allow creation of test doubles.

CloudQuotasClient(CallInvoker)

public CloudQuotasClient(CallInvoker callInvoker)

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

Parameter
NameDescription
callInvokerCallInvoker

The callInvoker to use to make remote calls.

CloudQuotasClient(ChannelBase)

public CloudQuotasClient(ChannelBase channel)

Creates a new client for CloudQuotas

Parameter
NameDescription
channelChannelBase

The channel to use to make remote calls.

CloudQuotasClient(ClientBaseConfiguration)

protected CloudQuotasClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration

The client configuration.

Methods

CreateQuotaPreference(CreateQuotaPreferenceRequest, CallOptions)

public virtual QuotaPreference CreateQuotaPreference(CreateQuotaPreferenceRequest request, CallOptions options)

Creates a new QuotaPreference that declares the desired value for a quota.

Parameters
NameDescription
requestCreateQuotaPreferenceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
QuotaPreference

The response received from the server.

CreateQuotaPreference(CreateQuotaPreferenceRequest, Metadata, DateTime?, CancellationToken)

public virtual QuotaPreference CreateQuotaPreference(CreateQuotaPreferenceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new QuotaPreference that declares the desired value for a quota.

Parameters
NameDescription
requestCreateQuotaPreferenceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
QuotaPreference

The response received from the server.

CreateQuotaPreferenceAsync(CreateQuotaPreferenceRequest, CallOptions)

public virtual AsyncUnaryCall<QuotaPreference> CreateQuotaPreferenceAsync(CreateQuotaPreferenceRequest request, CallOptions options)

Creates a new QuotaPreference that declares the desired value for a quota.

Parameters
NameDescription
requestCreateQuotaPreferenceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallQuotaPreference

The call object.

CreateQuotaPreferenceAsync(CreateQuotaPreferenceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<QuotaPreference> CreateQuotaPreferenceAsync(CreateQuotaPreferenceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Creates a new QuotaPreference that declares the desired value for a quota.

Parameters
NameDescription
requestCreateQuotaPreferenceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallQuotaPreference

The call object.

GetQuotaInfo(GetQuotaInfoRequest, CallOptions)

public virtual QuotaInfo GetQuotaInfo(GetQuotaInfoRequest request, CallOptions options)

Retrieve the QuotaInfo of a quota for a project, folder or organization.

Parameters
NameDescription
requestGetQuotaInfoRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
QuotaInfo

The response received from the server.

GetQuotaInfo(GetQuotaInfoRequest, Metadata, DateTime?, CancellationToken)

public virtual QuotaInfo GetQuotaInfo(GetQuotaInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve the QuotaInfo of a quota for a project, folder or organization.

Parameters
NameDescription
requestGetQuotaInfoRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
QuotaInfo

The response received from the server.

GetQuotaInfoAsync(GetQuotaInfoRequest, CallOptions)

public virtual AsyncUnaryCall<QuotaInfo> GetQuotaInfoAsync(GetQuotaInfoRequest request, CallOptions options)

Retrieve the QuotaInfo of a quota for a project, folder or organization.

Parameters
NameDescription
requestGetQuotaInfoRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallQuotaInfo

The call object.

GetQuotaInfoAsync(GetQuotaInfoRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<QuotaInfo> GetQuotaInfoAsync(GetQuotaInfoRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Retrieve the QuotaInfo of a quota for a project, folder or organization.

Parameters
NameDescription
requestGetQuotaInfoRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallQuotaInfo

The call object.

GetQuotaPreference(GetQuotaPreferenceRequest, CallOptions)

public virtual QuotaPreference GetQuotaPreference(GetQuotaPreferenceRequest request, CallOptions options)

Gets details of a single QuotaPreference.

Parameters
NameDescription
requestGetQuotaPreferenceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
QuotaPreference

The response received from the server.

GetQuotaPreference(GetQuotaPreferenceRequest, Metadata, DateTime?, CancellationToken)

public virtual QuotaPreference GetQuotaPreference(GetQuotaPreferenceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single QuotaPreference.

Parameters
NameDescription
requestGetQuotaPreferenceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
QuotaPreference

The response received from the server.

GetQuotaPreferenceAsync(GetQuotaPreferenceRequest, CallOptions)

public virtual AsyncUnaryCall<QuotaPreference> GetQuotaPreferenceAsync(GetQuotaPreferenceRequest request, CallOptions options)

Gets details of a single QuotaPreference.

Parameters
NameDescription
requestGetQuotaPreferenceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallQuotaPreference

The call object.

GetQuotaPreferenceAsync(GetQuotaPreferenceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<QuotaPreference> GetQuotaPreferenceAsync(GetQuotaPreferenceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets details of a single QuotaPreference.

Parameters
NameDescription
requestGetQuotaPreferenceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallQuotaPreference

The call object.

ListQuotaInfos(ListQuotaInfosRequest, CallOptions)

public virtual ListQuotaInfosResponse ListQuotaInfos(ListQuotaInfosRequest request, CallOptions options)

Lists QuotaInfos of all quotas for a given project, folder or organization.

Parameters
NameDescription
requestListQuotaInfosRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListQuotaInfosResponse

The response received from the server.

ListQuotaInfos(ListQuotaInfosRequest, Metadata, DateTime?, CancellationToken)

public virtual ListQuotaInfosResponse ListQuotaInfos(ListQuotaInfosRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists QuotaInfos of all quotas for a given project, folder or organization.

Parameters
NameDescription
requestListQuotaInfosRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListQuotaInfosResponse

The response received from the server.

ListQuotaInfosAsync(ListQuotaInfosRequest, CallOptions)

public virtual AsyncUnaryCall<ListQuotaInfosResponse> ListQuotaInfosAsync(ListQuotaInfosRequest request, CallOptions options)

Lists QuotaInfos of all quotas for a given project, folder or organization.

Parameters
NameDescription
requestListQuotaInfosRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListQuotaInfosResponse

The call object.

ListQuotaInfosAsync(ListQuotaInfosRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListQuotaInfosResponse> ListQuotaInfosAsync(ListQuotaInfosRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists QuotaInfos of all quotas for a given project, folder or organization.

Parameters
NameDescription
requestListQuotaInfosRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListQuotaInfosResponse

The call object.

ListQuotaPreferences(ListQuotaPreferencesRequest, CallOptions)

public virtual ListQuotaPreferencesResponse ListQuotaPreferences(ListQuotaPreferencesRequest request, CallOptions options)

Lists QuotaPreferences in a given project, folder or organization.

Parameters
NameDescription
requestListQuotaPreferencesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
ListQuotaPreferencesResponse

The response received from the server.

ListQuotaPreferences(ListQuotaPreferencesRequest, Metadata, DateTime?, CancellationToken)

public virtual ListQuotaPreferencesResponse ListQuotaPreferences(ListQuotaPreferencesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists QuotaPreferences in a given project, folder or organization.

Parameters
NameDescription
requestListQuotaPreferencesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
ListQuotaPreferencesResponse

The response received from the server.

ListQuotaPreferencesAsync(ListQuotaPreferencesRequest, CallOptions)

public virtual AsyncUnaryCall<ListQuotaPreferencesResponse> ListQuotaPreferencesAsync(ListQuotaPreferencesRequest request, CallOptions options)

Lists QuotaPreferences in a given project, folder or organization.

Parameters
NameDescription
requestListQuotaPreferencesRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallListQuotaPreferencesResponse

The call object.

ListQuotaPreferencesAsync(ListQuotaPreferencesRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListQuotaPreferencesResponse> ListQuotaPreferencesAsync(ListQuotaPreferencesRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Lists QuotaPreferences in a given project, folder or organization.

Parameters
NameDescription
requestListQuotaPreferencesRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallListQuotaPreferencesResponse

The call object.

NewInstance(ClientBaseConfiguration)

protected override CloudQuotas.CloudQuotasClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
NameDescription
configurationClientBaseClientBaseConfiguration
Returns
TypeDescription
CloudQuotasCloudQuotasClient
Overrides

UpdateQuotaPreference(UpdateQuotaPreferenceRequest, CallOptions)

public virtual QuotaPreference UpdateQuotaPreference(UpdateQuotaPreferenceRequest request, CallOptions options)

Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.

Parameters
NameDescription
requestUpdateQuotaPreferenceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
QuotaPreference

The response received from the server.

UpdateQuotaPreference(UpdateQuotaPreferenceRequest, Metadata, DateTime?, CancellationToken)

public virtual QuotaPreference UpdateQuotaPreference(UpdateQuotaPreferenceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.

Parameters
NameDescription
requestUpdateQuotaPreferenceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
QuotaPreference

The response received from the server.

UpdateQuotaPreferenceAsync(UpdateQuotaPreferenceRequest, CallOptions)

public virtual AsyncUnaryCall<QuotaPreference> UpdateQuotaPreferenceAsync(UpdateQuotaPreferenceRequest request, CallOptions options)

Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.

Parameters
NameDescription
requestUpdateQuotaPreferenceRequest

The request to send to the server.

optionsCallOptions

The options for the call.

Returns
TypeDescription
AsyncUnaryCallQuotaPreference

The call object.

UpdateQuotaPreferenceAsync(UpdateQuotaPreferenceRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<QuotaPreference> UpdateQuotaPreferenceAsync(UpdateQuotaPreferenceRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates the parameters of a single QuotaPreference. It can updates the config in any states, not just the ones pending approval.

Parameters
NameDescription
requestUpdateQuotaPreferenceRequest

The request to send to the server.

headersMetadata

The initial metadata to send with the call. This parameter is optional.

deadlineDateTime

An optional deadline for the call. The call will be cancelled if deadline is hit.

cancellationTokenCancellationToken

An optional token for canceling the call.

Returns
TypeDescription
AsyncUnaryCallQuotaPreference

The call object.