QuotaControllerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.servicecontrol_v1.services.quota_controller.transports.base.QuotaControllerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-service-control/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Google Quota Control API </service-control/overview>
__
Allows clients to allocate and release quota against a managed
service <https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService>
__.
Properties
transport
Returns the transport used by the client instance.
Returns | |
---|---|
Type | Description |
QuotaControllerTransport | The transport used by the client instance. |
Methods
QuotaControllerAsyncClient
QuotaControllerAsyncClient(*, credentials: google.auth.credentials.Credentials = None, transport: Union[str, google.cloud.servicecontrol_v1.services.quota_controller.transports.base.QuotaControllerTransport] = 'grpc_asyncio', client_options: <module 'google.api_core.client_options' from '/workspace/python-service-control/.nox/docfx/lib/python3.9/site-packages/google/api_core/client_options.py'> = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)
Instantiates the quota controller client.
Parameters | |
---|---|
Name | Description |
credentials |
Optional[google.auth.credentials.Credentials]
The authorization credentials to attach to requests. These credentials identify the application to the service; if none are specified, the client will attempt to ascertain the credentials from the environment. |
transport |
Union[str,
The transport to use. If set to None, a transport is chosen automatically. |
client_options |
ClientOptions
Custom options for the client. It won't take effect if a |
Exceptions | |
---|---|
Type | Description |
google.auth.exceptions.MutualTlsChannelError | If mutual TLS transport creation failed for any reason. |
allocate_quota
allocate_quota(request: Optional[google.cloud.servicecontrol_v1.types.quota_controller.AllocateQuotaRequest] = None, *, retry: google.api_core.retry.Retry = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())
Attempts to allocate quota for the specified consumer. It should be called before the operation is executed.
This method requires the servicemanagement.services.quota
permission on the specified service. For more information, see
Cloud IAM <https://cloud.google.com/iam>
__.
NOTE: The client must fail-open on server errors
INTERNAL
, UNKNOWN
, DEADLINE_EXCEEDED
, and
UNAVAILABLE
. To ensure system reliability, the server may
inject these errors to prohibit any hard dependency on the quota
functionality.
Parameters | |
---|---|
Name | Description |
request |
AllocateQuotaRequest
The request object. Request message for the AllocateQuota method. |
retry |
google.api_core.retry.Retry
Designation of what errors, if any, should be retried. |
timeout |
float
The timeout for this request. |
metadata |
Sequence[Tuple[str, str]]
Strings which should be sent along with the request as metadata. |
Returns | |
---|---|
Type | Description |
google.cloud.servicecontrol_v1.types.AllocateQuotaResponse | Response message for the AllocateQuota method. |
common_billing_account_path
common_billing_account_path(billing_account: str)
Returns a fully-qualified billing_account string.
common_folder_path
common_folder_path(folder: str)
Returns a fully-qualified folder string.
common_location_path
common_location_path(project: str, location: str)
Returns a fully-qualified location string.
common_organization_path
common_organization_path(organization: str)
Returns a fully-qualified organization string.
common_project_path
common_project_path(project: str)
Returns a fully-qualified project string.
from_service_account_file
from_service_account_file(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
QuotaControllerAsyncClient | The constructed client. |
from_service_account_info
from_service_account_info(info: dict, *args, **kwargs)
Creates an instance of this client using the provided credentials info.
Parameter | |
---|---|
Name | Description |
info |
dict
The service account private key info. |
Returns | |
---|---|
Type | Description |
QuotaControllerAsyncClient | The constructed client. |
from_service_account_json
from_service_account_json(filename: str, *args, **kwargs)
Creates an instance of this client using the provided credentials file.
Parameter | |
---|---|
Name | Description |
filename |
str
The path to the service account private key json file. |
Returns | |
---|---|
Type | Description |
QuotaControllerAsyncClient | The constructed client. |
get_transport_class
get_transport_class()
Returns an appropriate transport class.
parse_common_billing_account_path
parse_common_billing_account_path(path: str)
Parse a billing_account path into its component segments.
parse_common_folder_path
parse_common_folder_path(path: str)
Parse a folder path into its component segments.
parse_common_location_path
parse_common_location_path(path: str)
Parse a location path into its component segments.
parse_common_organization_path
parse_common_organization_path(path: str)
Parse a organization path into its component segments.
parse_common_project_path
parse_common_project_path(path: str)
Parse a project path into its component segments.