Class QuotaAdjusterSettingsManagerClient (0.1.18) 

QuotaAdjusterSettingsManagerClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager.transports.base.QuotaAdjusterSettingsManagerTransport, typing.Callable[[...], google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager.transports.base.QuotaAdjusterSettingsManagerTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

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

api_endpoint

Return the API endpoint used by the client instance.

Returns
Type Description
str The API endpoint used by the client instance.

transport

Returns the transport used by the client instance.

Returns
Type Description
QuotaAdjusterSettingsManagerTransport The transport used by the client instance.

universe_domain

Return the universe domain used by the client instance.

Returns
Type Description
str The universe domain used by the client instance.

Methods

QuotaAdjusterSettingsManagerClient

QuotaAdjusterSettingsManagerClient(*, credentials: typing.Optional[google.auth.credentials.Credentials] = None, transport: typing.Optional[typing.Union[str, google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager.transports.base.QuotaAdjusterSettingsManagerTransport, typing.Callable[[...], google.cloud.cloudquotas_v1beta.services.quota_adjuster_settings_manager.transports.base.QuotaAdjusterSettingsManagerTransport]]] = None, client_options: typing.Optional[typing.Union[google.api_core.client_options.ClientOptions, dict]] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the quota adjuster settings manager 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 Optional[Union[str,QuotaAdjusterSettingsManagerTransport,Callable[..., QuotaAdjusterSettingsManagerTransport]]]

The transport to use, or a Callable that constructs and returns a new transport. If a Callable is given, it will be called with the same set of initialization arguments as used in the QuotaAdjusterSettingsManagerTransport constructor. If set to None, a transport is chosen automatically.
client_options Optional[Union[google.api_core.client_options.ClientOptions, dict]]

Custom options for the client. 1. The api_endpoint property can be used to override the default endpoint provided by the client when transport is not explicitly provided. Only if this property is not set and transport was not explicitly provided, the endpoint is determined by the GOOGLE_API_USE_MTLS_ENDPOINT environment variable, which have one of the following values: "always" (always use the default mTLS endpoint), "never" (always use the default regular endpoint) and "auto" (auto-switch to the default mTLS endpoint if client certificate is present; this is the default value). 2. If the GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the client_cert_source property can be used to provide a client certificate for mTLS transport. If not provided, the default SSL client certificate will be used if present. If GOOGLE_API_USE_CLIENT_CERTIFICATE is "false" or not set, no client certificate will be used. 3. The universe_domain property can be used to override the default "googleapis.com" universe. Note that the api_endpoint property still takes precedence; and universe_domain is currently not supported for mTLS.
client_info google.api_core.gapic_v1.client_info.ClientInfo

The client info used to send a user-agent string along with API requests. If None, then default info will be used. Generally, you only need to set this if you're developing your own client library.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If mutual TLS transport creation failed for any reason.

__exit__

__exit__(type, value, traceback)

Releases underlying transport's resources.

common_billing_account_path

common_billing_account_path(billing_account: str) -> str

Returns a fully-qualified billing_account string.

common_folder_path

common_folder_path(folder: str) -> str

Returns a fully-qualified folder string.

common_location_path

common_location_path(project: str, location: str) -> str

Returns a fully-qualified location string.

common_organization_path

common_organization_path(organization: str) -> str

Returns a fully-qualified organization string.

common_project_path

common_project_path(project: str) -> 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
QuotaAdjusterSettingsManagerClient 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
QuotaAdjusterSettingsManagerClient 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
QuotaAdjusterSettingsManagerClient The constructed client.

get_mtls_endpoint_and_cert_source

get_mtls_endpoint_and_cert_source(
    client_options: typing.Optional[
        google.api_core.client_options.ClientOptions
    ] = None,
)

Deprecated. Return the API endpoint and client cert source for mutual TLS.

The client cert source is determined in the following order: (1) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is not "true", the client cert source is None. (2) if client_options.client_cert_source is provided, use the provided one; if the default client cert source exists, use the default one; otherwise the client cert source is None.

The API endpoint is determined in the following order: (1) if client_options.api_endpoint if provided, use the provided one. (2) if GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "always", use the default mTLS endpoint; if the environment variable is "never", use the default API endpoint; otherwise if client cert source exists, use the default mTLS endpoint, otherwise use the default API endpoint.

More details can be found at https://google.aip.dev/auth/4114.

Parameter
Name Description
client_options google.api_core.client_options.ClientOptions

Custom options for the client. Only the api_endpoint and client_cert_source properties may be used in this method.
Exceptions
Type Description
google.auth.exceptions.MutualTLSChannelError If any errors happen.
Returns
Type Description
Tuple[str, Callable[[], Tuple[bytes, bytes]]] returns the API endpoint and the client cert source to use.

get_quota_adjuster_settings

get_quota_adjuster_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudquotas_v1beta.types.quota_adjuster_settings.GetQuotaAdjusterSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    name: typing.Optional[str] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.cloudquotas_v1beta.types.quota_adjuster_settings.QuotaAdjusterSettings
)

RPC Method for getting QuotaAdjusterSettings based on the request

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudquotas_v1beta

def sample_get_quota_adjuster_settings():
    # Create a client
    client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient()

    # Initialize request argument(s)
    request = cloudquotas_v1beta.GetQuotaAdjusterSettingsRequest(
        name="name_value",
    )

    # Make the request
    response = client.get_quota_adjuster_settings(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.cloudquotas_v1beta.types.GetQuotaAdjusterSettingsRequest, dict]

The request object. Request for getting QuotaAdjusterSettings
name str

Required. Name of the quotaAdjusterSettings configuration. Only a single setting per project is supported. This corresponds to the name field on the request instance; if request is provided, this should not be set.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings The QuotaAdjusterSettings resource defines the settings for the Quota Adjuster.

parse_common_billing_account_path

parse_common_billing_account_path(path: str) -> typing.Dict[str, str]

Parse a billing_account path into its component segments.

parse_common_folder_path

parse_common_folder_path(path: str) -> typing.Dict[str, str]

Parse a folder path into its component segments.

parse_common_location_path

parse_common_location_path(path: str) -> typing.Dict[str, str]

Parse a location path into its component segments.

parse_common_organization_path

parse_common_organization_path(path: str) -> typing.Dict[str, str]

Parse a organization path into its component segments.

parse_common_project_path

parse_common_project_path(path: str) -> typing.Dict[str, str]

Parse a project path into its component segments.

parse_quota_adjuster_settings_path

parse_quota_adjuster_settings_path(path: str) -> typing.Dict[str, str]

Parses a quota_adjuster_settings path into its component segments.

quota_adjuster_settings_path

quota_adjuster_settings_path(project: str, location: str) -> str

Returns a fully-qualified quota_adjuster_settings string.

update_quota_adjuster_settings

update_quota_adjuster_settings(
    request: typing.Optional[
        typing.Union[
            google.cloud.cloudquotas_v1beta.types.quota_adjuster_settings.UpdateQuotaAdjusterSettingsRequest,
            dict,
        ]
    ] = None,
    *,
    quota_adjuster_settings: typing.Optional[
        google.cloud.cloudquotas_v1beta.types.quota_adjuster_settings.QuotaAdjusterSettings
    ] = None,
    update_mask: typing.Optional[google.protobuf.field_mask_pb2.FieldMask] = None,
    retry: typing.Optional[
        typing.Union[
            google.api_core.retry.retry_unary.Retry,
            google.api_core.gapic_v1.method._MethodDefault,
        ]
    ] = _MethodDefault._DEFAULT_VALUE,
    timeout: typing.Union[float, object] = _MethodDefault._DEFAULT_VALUE,
    metadata: typing.Sequence[typing.Tuple[str, typing.Union[str, bytes]]] = ()
) -> (
    google.cloud.cloudquotas_v1beta.types.quota_adjuster_settings.QuotaAdjusterSettings
)

RPC Method for updating QuotaAdjusterSettings based on the request

# This snippet has been automatically generated and should be regarded as a
# code template only.
# It will require modifications to work:
# - It may require correct/in-range values for request initialization.
# - It may require specifying regional endpoints when creating the service
#   client as shown in:
#   https://googleapis.dev/python/google-api-core/latest/client_options.html
from google.cloud import cloudquotas_v1beta

def sample_update_quota_adjuster_settings():
    # Create a client
    client = cloudquotas_v1beta.QuotaAdjusterSettingsManagerClient()

    # Initialize request argument(s)
    request = cloudquotas_v1beta.UpdateQuotaAdjusterSettingsRequest(
    )

    # Make the request
    response = client.update_quota_adjuster_settings(request=request)

    # Handle the response
    print(response)
Parameters
Name Description
request Union[google.cloud.cloudquotas_v1beta.types.UpdateQuotaAdjusterSettingsRequest, dict]

The request object. Request for updating QuotaAdjusterSettings
quota_adjuster_settings google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings

Required. The QuotaAdjusterSettings to update. This corresponds to the quota_adjuster_settings field on the request instance; if request is provided, this should not be set.
update_mask google.protobuf.field_mask_pb2.FieldMask

Optional. The list of fields to update. This corresponds to the update_mask field on the request instance; if request is provided, this should not be set.
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, Union[str, bytes]]]

Key/value pairs which should be sent along with the request as metadata. Normally, each value must be of type str, but for metadata keys ending with the suffix -bin, the corresponding values must be of type bytes.
Returns
Type Description
google.cloud.cloudquotas_v1beta.types.QuotaAdjusterSettings The QuotaAdjusterSettings resource defines the settings for the Quota Adjuster.