Cloud Quotas v1beta API - Class QuotaAdjusterSettingsManagerClient (1.0.0-beta01)

public abstract class QuotaAdjusterSettingsManagerClient

Reference documentation and code samples for the Cloud Quotas v1beta API class QuotaAdjusterSettingsManagerClient.

QuotaAdjusterSettingsManager client wrapper, for convenient use.

Inheritance

object > QuotaAdjusterSettingsManagerClient

Namespace

Google.Cloud.CloudQuotas.V1Beta

Assembly

Google.Cloud.CloudQuotas.V1Beta.dll

Remarks

The Quotas Adjuster Settings API is an infrastructure service for Google Cloud that lets service consumers view and update their quota adjuster settings.

  • Update quota adjuster settings.
  • Get the name of the configurations.

Properties

DefaultEndpoint

public static string DefaultEndpoint { get; }

The default endpoint for the QuotaAdjusterSettingsManager service, which is a host of "cloudquotas.googleapis.com" and a port of 443.

Property Value
Type Description
string

DefaultScopes

public static IReadOnlyList<string> DefaultScopes { get; }

The default QuotaAdjusterSettingsManager scopes.

Property Value
Type Description
IReadOnlyListstring
Remarks

The default QuotaAdjusterSettingsManager scopes are:

GrpcClient

public virtual QuotaAdjusterSettingsManager.QuotaAdjusterSettingsManagerClient GrpcClient { get; }

The underlying gRPC QuotaAdjusterSettingsManager client

Property Value
Type Description
QuotaAdjusterSettingsManagerQuotaAdjusterSettingsManagerClient

ServiceMetadata

public static ServiceMetadata ServiceMetadata { get; }

The service metadata associated with this client type.

Property Value
Type Description
ServiceMetadata

Methods

Create()

public static QuotaAdjusterSettingsManagerClient Create()

Synchronously creates a QuotaAdjusterSettingsManagerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use QuotaAdjusterSettingsManagerClientBuilder.

Returns
Type Description
QuotaAdjusterSettingsManagerClient

The created QuotaAdjusterSettingsManagerClient.

CreateAsync(CancellationToken)

public static Task<QuotaAdjusterSettingsManagerClient> CreateAsync(CancellationToken cancellationToken = default)

Asynchronously creates a QuotaAdjusterSettingsManagerClient using the default credentials, endpoint and settings. To specify custom credentials or other settings, use QuotaAdjusterSettingsManagerClientBuilder.

Parameter
Name Description
cancellationToken CancellationToken

The CancellationToken to use while creating the client.

Returns
Type Description
TaskQuotaAdjusterSettingsManagerClient

The task representing the created QuotaAdjusterSettingsManagerClient.

GetQuotaAdjusterSettings(GetQuotaAdjusterSettingsRequest, CallSettings)

public virtual QuotaAdjusterSettings GetQuotaAdjusterSettings(GetQuotaAdjusterSettingsRequest request, CallSettings callSettings = null)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
request GetQuotaAdjusterSettingsRequest

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
QuotaAdjusterSettings

The RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.Create();
// Initialize request argument(s)
GetQuotaAdjusterSettingsRequest request = new GetQuotaAdjusterSettingsRequest
{
    QuotaAdjusterSettingsName = QuotaAdjusterSettingsName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettings(request);

GetQuotaAdjusterSettings(QuotaAdjusterSettingsName, CallSettings)

public virtual QuotaAdjusterSettings GetQuotaAdjusterSettings(QuotaAdjusterSettingsName name, CallSettings callSettings = null)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
name QuotaAdjusterSettingsName

Required. Name of the config. Required to be “settings”, as only a single setting per container will be supported initially.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
QuotaAdjusterSettings

The RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.Create();
// Initialize request argument(s)
QuotaAdjusterSettingsName name = QuotaAdjusterSettingsName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettings(name);

GetQuotaAdjusterSettings(string, CallSettings)

public virtual QuotaAdjusterSettings GetQuotaAdjusterSettings(string name, CallSettings callSettings = null)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
name string

Required. Name of the config. Required to be “settings”, as only a single setting per container will be supported initially.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
QuotaAdjusterSettings

The RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.Create();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/quotaAdjusterSettings";
// Make the request
QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettings(name);

GetQuotaAdjusterSettingsAsync(GetQuotaAdjusterSettingsRequest, CallSettings)

public virtual Task<QuotaAdjusterSettings> GetQuotaAdjusterSettingsAsync(GetQuotaAdjusterSettingsRequest request, CallSettings callSettings = null)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
request GetQuotaAdjusterSettingsRequest

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
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
GetQuotaAdjusterSettingsRequest request = new GetQuotaAdjusterSettingsRequest
{
    QuotaAdjusterSettingsName = QuotaAdjusterSettingsName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettingsAsync(request);

GetQuotaAdjusterSettingsAsync(GetQuotaAdjusterSettingsRequest, CancellationToken)

public virtual Task<QuotaAdjusterSettings> GetQuotaAdjusterSettingsAsync(GetQuotaAdjusterSettingsRequest request, CancellationToken cancellationToken)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
request GetQuotaAdjusterSettingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
GetQuotaAdjusterSettingsRequest request = new GetQuotaAdjusterSettingsRequest
{
    QuotaAdjusterSettingsName = QuotaAdjusterSettingsName.FromProjectLocation("[PROJECT]", "[LOCATION]"),
};
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettingsAsync(request);

GetQuotaAdjusterSettingsAsync(QuotaAdjusterSettingsName, CallSettings)

public virtual Task<QuotaAdjusterSettings> GetQuotaAdjusterSettingsAsync(QuotaAdjusterSettingsName name, CallSettings callSettings = null)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
name QuotaAdjusterSettingsName

Required. Name of the config. Required to be “settings”, as only a single setting per container will be supported initially.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
QuotaAdjusterSettingsName name = QuotaAdjusterSettingsName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettingsAsync(name);

GetQuotaAdjusterSettingsAsync(QuotaAdjusterSettingsName, CancellationToken)

public virtual Task<QuotaAdjusterSettings> GetQuotaAdjusterSettingsAsync(QuotaAdjusterSettingsName name, CancellationToken cancellationToken)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
name QuotaAdjusterSettingsName

Required. Name of the config. Required to be “settings”, as only a single setting per container will be supported initially.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
QuotaAdjusterSettingsName name = QuotaAdjusterSettingsName.FromProjectLocation("[PROJECT]", "[LOCATION]");
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettingsAsync(name);

GetQuotaAdjusterSettingsAsync(string, CallSettings)

public virtual Task<QuotaAdjusterSettings> GetQuotaAdjusterSettingsAsync(string name, CallSettings callSettings = null)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
name string

Required. Name of the config. Required to be “settings”, as only a single setting per container will be supported initially.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/quotaAdjusterSettings";
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettingsAsync(name);

GetQuotaAdjusterSettingsAsync(string, CancellationToken)

public virtual Task<QuotaAdjusterSettings> GetQuotaAdjusterSettingsAsync(string name, CancellationToken cancellationToken)

RPC Method for getting QuotaAdjusterSettings based on the request

Parameters
Name Description
name string

Required. Name of the config. Required to be “settings”, as only a single setting per container will be supported initially.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
string name = "projects/[PROJECT]/locations/[LOCATION]/quotaAdjusterSettings";
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.GetQuotaAdjusterSettingsAsync(name);

ShutdownDefaultChannelsAsync()

public static Task ShutdownDefaultChannelsAsync()

Shuts down any channels automatically created by Create() and CreateAsync(CancellationToken). Channels which weren't automatically created are not affected.

Returns
Type Description
Task

A task representing the asynchronous shutdown operation.

Remarks

After calling this method, further calls to Create() and CreateAsync(CancellationToken) will create new channels, which could in turn be shut down by another call to this method.

UpdateQuotaAdjusterSettings(QuotaAdjusterSettings, FieldMask, CallSettings)

public virtual QuotaAdjusterSettings UpdateQuotaAdjusterSettings(QuotaAdjusterSettings quotaAdjusterSettings, FieldMask updateMask, CallSettings callSettings = null)

RPC Method for updating QuotaAdjusterSettings based on the request

Parameters
Name Description
quotaAdjusterSettings QuotaAdjusterSettings

Required. The QuotaAdjusterSettings to update.

updateMask FieldMask

Optional. The list of fields to update.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
QuotaAdjusterSettings

The RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.Create();
// Initialize request argument(s)
QuotaAdjusterSettings quotaAdjusterSettings = new QuotaAdjusterSettings();
FieldMask updateMask = new FieldMask();
// Make the request
QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.UpdateQuotaAdjusterSettings(quotaAdjusterSettings, updateMask);

UpdateQuotaAdjusterSettings(UpdateQuotaAdjusterSettingsRequest, CallSettings)

public virtual QuotaAdjusterSettings UpdateQuotaAdjusterSettings(UpdateQuotaAdjusterSettingsRequest request, CallSettings callSettings = null)

RPC Method for updating QuotaAdjusterSettings based on the request

Parameters
Name Description
request UpdateQuotaAdjusterSettingsRequest

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
QuotaAdjusterSettings

The RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = QuotaAdjusterSettingsManagerClient.Create();
// Initialize request argument(s)
UpdateQuotaAdjusterSettingsRequest request = new UpdateQuotaAdjusterSettingsRequest
{
    QuotaAdjusterSettings = new QuotaAdjusterSettings(),
    UpdateMask = new FieldMask(),
    ValidateOnly = false,
};
// Make the request
QuotaAdjusterSettings response = quotaAdjusterSettingsManagerClient.UpdateQuotaAdjusterSettings(request);

UpdateQuotaAdjusterSettingsAsync(QuotaAdjusterSettings, FieldMask, CallSettings)

public virtual Task<QuotaAdjusterSettings> UpdateQuotaAdjusterSettingsAsync(QuotaAdjusterSettings quotaAdjusterSettings, FieldMask updateMask, CallSettings callSettings = null)

RPC Method for updating QuotaAdjusterSettings based on the request

Parameters
Name Description
quotaAdjusterSettings QuotaAdjusterSettings

Required. The QuotaAdjusterSettings to update.

updateMask FieldMask

Optional. The list of fields to update.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
QuotaAdjusterSettings quotaAdjusterSettings = new QuotaAdjusterSettings();
FieldMask updateMask = new FieldMask();
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.UpdateQuotaAdjusterSettingsAsync(quotaAdjusterSettings, updateMask);

UpdateQuotaAdjusterSettingsAsync(QuotaAdjusterSettings, FieldMask, CancellationToken)

public virtual Task<QuotaAdjusterSettings> UpdateQuotaAdjusterSettingsAsync(QuotaAdjusterSettings quotaAdjusterSettings, FieldMask updateMask, CancellationToken cancellationToken)

RPC Method for updating QuotaAdjusterSettings based on the request

Parameters
Name Description
quotaAdjusterSettings QuotaAdjusterSettings

Required. The QuotaAdjusterSettings to update.

updateMask FieldMask

Optional. The list of fields to update.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
QuotaAdjusterSettings quotaAdjusterSettings = new QuotaAdjusterSettings();
FieldMask updateMask = new FieldMask();
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.UpdateQuotaAdjusterSettingsAsync(quotaAdjusterSettings, updateMask);

UpdateQuotaAdjusterSettingsAsync(UpdateQuotaAdjusterSettingsRequest, CallSettings)

public virtual Task<QuotaAdjusterSettings> UpdateQuotaAdjusterSettingsAsync(UpdateQuotaAdjusterSettingsRequest request, CallSettings callSettings = null)

RPC Method for updating QuotaAdjusterSettings based on the request

Parameters
Name Description
request UpdateQuotaAdjusterSettingsRequest

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
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
UpdateQuotaAdjusterSettingsRequest request = new UpdateQuotaAdjusterSettingsRequest
{
    QuotaAdjusterSettings = new QuotaAdjusterSettings(),
    UpdateMask = new FieldMask(),
    ValidateOnly = false,
};
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.UpdateQuotaAdjusterSettingsAsync(request);

UpdateQuotaAdjusterSettingsAsync(UpdateQuotaAdjusterSettingsRequest, CancellationToken)

public virtual Task<QuotaAdjusterSettings> UpdateQuotaAdjusterSettingsAsync(UpdateQuotaAdjusterSettingsRequest request, CancellationToken cancellationToken)

RPC Method for updating QuotaAdjusterSettings based on the request

Parameters
Name Description
request UpdateQuotaAdjusterSettingsRequest

The request object containing all of the parameters for the API call.

cancellationToken CancellationToken

A CancellationToken to use for this RPC.

Returns
Type Description
TaskQuotaAdjusterSettings

A Task containing the RPC response.

Example
// Create client
QuotaAdjusterSettingsManagerClient quotaAdjusterSettingsManagerClient = await QuotaAdjusterSettingsManagerClient.CreateAsync();
// Initialize request argument(s)
UpdateQuotaAdjusterSettingsRequest request = new UpdateQuotaAdjusterSettingsRequest
{
    QuotaAdjusterSettings = new QuotaAdjusterSettings(),
    UpdateMask = new FieldMask(),
    ValidateOnly = false,
};
// Make the request
QuotaAdjusterSettings response = await quotaAdjusterSettingsManagerClient.UpdateQuotaAdjusterSettingsAsync(request);