Class ServiceControllerAsyncClient (1.4.1)

ServiceControllerAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.servicecontrol_v2.services.service_controller.transports.base.ServiceControllerTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Service Control API v2 <https://cloud.google.com/service-infrastructure/docs/service-control/access-control>__

Private Preview. This feature is only available for approved services.

This API provides admission control and telemetry reporting for services that are integrated with Service Infrastructure <https://cloud.google.com/service-infrastructure>__.

Inheritance

builtins.object > ServiceControllerAsyncClient

Properties

transport

Returns the transport used by the client instance.

Returns

Type	Description
ServiceControllerTransport	The transport used by the client instance.

Methods

ServiceControllerAsyncClient

ServiceControllerAsyncClient(*, credentials: Optional[google.auth.credentials.Credentials] = None, transport: Union[str, google.cloud.servicecontrol_v2.services.service_controller.transports.base.ServiceControllerTransport] = 'grpc_asyncio', client_options: Optional[google.api_core.client_options.ClientOptions] = None, client_info: google.api_core.gapic_v1.client_info.ClientInfo = <google.api_core.gapic_v1.client_info.ClientInfo object>)

Instantiates the service 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, `.ServiceControllerTransport`] 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 `transport` instance is provided. (1) The `api_endpoint` property can be used to override the default endpoint provided by the client. GOOGLE_API_USE_MTLS_ENDPOINT environment variable can also be used to override the endpoint: "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). However, the `api_endpoint` property takes precedence if provided. (2) If GOOGLE_API_USE_CLIENT_CERTIFICATE environment variable is "true", then the `client_cert_source` property can be used to provide client certificate for mutual TLS 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.

Exceptions

Type	Description
google.auth.exceptions.MutualTlsChannelError	If mutual TLS transport creation failed for any reason.

check

check(request: Optional[Union[google.cloud.servicecontrol_v2.types.service_controller.CheckRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Private Preview. This feature is only available for approved services.

This method provides admission control for services that are integrated with Service Infrastructure <https://cloud.google.com/service-infrastructure>. It checks whether an operation should be allowed based on the service configuration and relevant policies. It must be called before the operation is executed. For more information, see Admission Control <https://cloud.google.com/service-infrastructure/docs/admission-control>.

NOTE: The admission control has an expected policy propagation delay of 60s. The caller must not depend on the most recent policy changes.

NOTE: The admission control has a hard limit of 1 referenced resources per call. If an operation refers to more than 1 resources, the caller must call the Check method multiple times.

This method requires the servicemanagement.services.check permission on the specified service. For more information, see Service Control API Access Control <https://cloud.google.com/service-infrastructure/docs/service-control/access-control>__.

from google.cloud import servicecontrol_v2

async def sample_check():
    # Create a client
    client = servicecontrol_v2.ServiceControllerAsyncClient()

    # Initialize request argument(s)
    request = servicecontrol_v2.CheckRequest(
    )

    # Make the request
    response = await client.check(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicecontrol_v2.types.CheckRequest, dict]` The request object. Request message for the Check 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_v2.types.CheckResponse	Response message for the Check 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
ServiceControllerAsyncClient	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
ServiceControllerAsyncClient	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
ServiceControllerAsyncClient	The constructed client.

get_mtls_endpoint_and_cert_source

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

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 variabel 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_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.

report

report(request: Optional[Union[google.cloud.servicecontrol_v2.types.service_controller.ReportRequest, dict]] = None, *, retry: Union[google.api_core.retry.Retry, google.api_core.gapic_v1.method._MethodDefault] = <_MethodDefault._DEFAULT_VALUE: <object object>>, timeout: Optional[float] = None, metadata: Sequence[Tuple[str, str]] = ())

Private Preview. This feature is only available for approved services.

This method provides telemetry reporting for services that are integrated with Service Infrastructure <https://cloud.google.com/service-infrastructure>. It reports a list of operations that have occurred on a service. It must be called after the operations have been executed. For more information, see Telemetry Reporting <https://cloud.google.com/service-infrastructure/docs/telemetry-reporting>.

NOTE: The telemetry reporting has a hard limit of 1000 operations and 1MB per Report call. It is recommended to have no more than 100 operations per call.

This method requires the servicemanagement.services.report permission on the specified service. For more information, see Service Control API Access Control <https://cloud.google.com/service-infrastructure/docs/service-control/access-control>__.

from google.cloud import servicecontrol_v2

async def sample_report():
    # Create a client
    client = servicecontrol_v2.ServiceControllerAsyncClient()

    # Initialize request argument(s)
    request = servicecontrol_v2.ReportRequest(
    )

    # Make the request
    response = await client.report(request=request)

    # Handle the response
    print(response)

Parameters

Name	Description
request	`Union[google.cloud.servicecontrol_v2.types.ReportRequest, dict]` The request object. Request message for the Report 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_v2.types.ReportResponse	Response message for the Report method. If the request contains any invalid data, the server returns an RPC error.