Service Control v1 API - Class ServiceControllerClientImpl (2.4.0) 

public sealed class ServiceControllerClientImpl : ServiceControllerClient

Reference documentation and code samples for the Service Control v1 API class ServiceControllerClientImpl.

ServiceController client wrapper implementation, for convenient use.

Inheritance

object > ServiceControllerClient > ServiceControllerClientImpl

Namespace

Google.Cloud.ServiceControl.V1

Assembly

Google.Cloud.ServiceControl.V1.dll

Remarks

Google Service Control API

Lets clients check and report operations against a managed service.

Constructors

ServiceControllerClientImpl(ServiceControllerClient, ServiceControllerSettings, ILogger)

public ServiceControllerClientImpl(ServiceController.ServiceControllerClient grpcClient, ServiceControllerSettings settings, ILogger logger)

Constructs a client wrapper for the ServiceController service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ServiceControllerServiceControllerClient

The underlying gRPC client.
settings ServiceControllerSettings

The base ServiceControllerSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

GrpcClient

public override ServiceController.ServiceControllerClient GrpcClient { get; }

The underlying gRPC ServiceController client

Property Value
Type Description
ServiceControllerServiceControllerClient
Overrides

Methods

Check(CheckRequest, CallSettings)

public override CheckResponse Check(CheckRequest request, CallSettings callSettings = null)

Checks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies. It must be called before the operation is executed.

If feasible, the client should cache the check results and reuse them for 60 seconds. In case of any server errors, the client should rely on the cached results for much longer time to avoid outage. WARNING: There is general 60s delay for the configuration and policy propagation, therefore callers MUST NOT depend on the Check method having the latest policy information.

NOTE: the [CheckRequest][google.api.servicecontrol.v1.CheckRequest] has the size limit (wire-format byte size) of 1MB.

This method requires the servicemanagement.services.check permission on the specified service. For more information, see Cloud IAM.

Parameters
Name Description
request CheckRequest

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
CheckResponse

The RPC response.
Overrides

CheckAsync(CheckRequest, CallSettings)

public override Task<CheckResponse> CheckAsync(CheckRequest request, CallSettings callSettings = null)

Checks whether an operation on a service should be allowed to proceed based on the configuration of the service and related policies. It must be called before the operation is executed.

If feasible, the client should cache the check results and reuse them for 60 seconds. In case of any server errors, the client should rely on the cached results for much longer time to avoid outage. WARNING: There is general 60s delay for the configuration and policy propagation, therefore callers MUST NOT depend on the Check method having the latest policy information.

NOTE: the [CheckRequest][google.api.servicecontrol.v1.CheckRequest] has the size limit (wire-format byte size) of 1MB.

This method requires the servicemanagement.services.check permission on the specified service. For more information, see Cloud IAM.

Parameters
Name Description
request CheckRequest

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
TaskCheckResponse

A Task containing the RPC response.
Overrides

Report(ReportRequest, CallSettings)

public override ReportResponse Report(ReportRequest request, CallSettings callSettings = null)

Reports operation results to Google Service Control, such as logs and metrics. It should be called after an operation is completed.

If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons.

NOTE: the [ReportRequest][google.api.servicecontrol.v1.ReportRequest] has the size limit (wire-format byte size) of 1MB.

This method requires the servicemanagement.services.report permission on the specified service. For more information, see Google Cloud IAM.

Parameters
Name Description
request ReportRequest

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
ReportResponse

The RPC response.
Overrides

ReportAsync(ReportRequest, CallSettings)

public override Task<ReportResponse> ReportAsync(ReportRequest request, CallSettings callSettings = null)

Reports operation results to Google Service Control, such as logs and metrics. It should be called after an operation is completed.

If feasible, the client should aggregate reporting data for up to 5 seconds to reduce API traffic. Limiting aggregation to 5 seconds is to reduce data loss during client crashes. Clients should carefully choose the aggregation time window to avoid data loss risk more than 0.01% for business and compliance reasons.

NOTE: the [ReportRequest][google.api.servicecontrol.v1.ReportRequest] has the size limit (wire-format byte size) of 1MB.

This method requires the servicemanagement.services.report permission on the specified service. For more information, see Google Cloud IAM.

Parameters
Name Description
request ReportRequest

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
TaskReportResponse

A Task containing the RPC response.
Overrides