Class ServiceControllerClient (1.35.0)

Version 1.35.0

• 1.53.0 (latest)
• 1.52.0
• 1.51.0
• 1.49.0
• 1.48.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.37.0
• 1.36.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.24.0
• 1.23.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.1.10

GitHub Repository

Product Reference

Service Description: Google Service Control API

Lets clients check and report operations against a managed service.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceControllerClient serviceControllerClient = ServiceControllerClient.create()) {
   CheckRequest request =
       CheckRequest.newBuilder()
           .setServiceName("serviceName-1928572192")
           .setOperation(Operation.newBuilder().build())
           .setServiceConfigId("serviceConfigId650537426")
           .build();
   CheckResponse response = serviceControllerClient.check(request);
 }
 

Note: close() needs to be called on the ServiceControllerClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods

Method	Description	Method Variants
Check	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 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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. check(CheckRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. checkCallable()
Report	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 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.	Request object method variants only take one parameter, a request object, which must be constructed before the call. report(ReportRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. reportCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ServiceControllerSettings to create(). For example:

To customize credentials:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServiceControllerSettings serviceControllerSettings =
     ServiceControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServiceControllerClient serviceControllerClient =
     ServiceControllerClient.create(serviceControllerSettings);
 

To customize the endpoint:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServiceControllerSettings serviceControllerSettings =
     ServiceControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 ServiceControllerClient serviceControllerClient =
     ServiceControllerClient.create(serviceControllerSettings);
 

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 ServiceControllerSettings serviceControllerSettings =
     ServiceControllerSettings.newHttpJsonBuilder().build();
 ServiceControllerClient serviceControllerClient =
     ServiceControllerClient.create(serviceControllerSettings);
 

Please refer to the GitHub repository's samples for more quickstart code snippets.

Inheritance

java.lang.Object > ServiceControllerClient

Static Methods

create()

public static final ServiceControllerClient create()

Constructs an instance of ServiceControllerClient with default settings.

Returns
Type	Description
ServiceControllerClient

Exceptions
Type	Description
IOException

create(ServiceControllerSettings settings)

public static final ServiceControllerClient create(ServiceControllerSettings settings)

Constructs an instance of ServiceControllerClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.

Parameter
Name	Description
settings	ServiceControllerSettings

Returns
Type	Description
ServiceControllerClient

Exceptions
Type	Description
IOException

create(ServiceControllerStub stub)

public static final ServiceControllerClient create(ServiceControllerStub stub)

Constructs an instance of ServiceControllerClient, using the given stub for making calls. This is for advanced usage - prefer using create(ServiceControllerSettings).

Parameter
Name	Description
stub	ServiceControllerStub

Returns
Type	Description
ServiceControllerClient

Constructors

ServiceControllerClient(ServiceControllerSettings settings)

protected ServiceControllerClient(ServiceControllerSettings settings)

Constructs an instance of ServiceControllerClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.

Parameter
Name	Description
settings	ServiceControllerSettings

ServiceControllerClient(ServiceControllerStub stub)

protected ServiceControllerClient(ServiceControllerStub stub)

Parameter
Name	Description
stub	ServiceControllerStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters
Name	Description
duration	long
unit	TimeUnit

Returns
Type	Description
boolean

Exceptions
Type	Description
InterruptedException

check(CheckRequest request)

public final CheckResponse check(CheckRequest request)

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

Sample code:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceControllerClient serviceControllerClient = ServiceControllerClient.create()) {
   CheckRequest request =
       CheckRequest.newBuilder()
           .setServiceName("serviceName-1928572192")
           .setOperation(Operation.newBuilder().build())
           .setServiceConfigId("serviceConfigId650537426")
           .build();
   CheckResponse response = serviceControllerClient.check(request);
 }
 

Parameter
Name	Description
request	CheckRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
CheckResponse

checkCallable()

public final UnaryCallable<CheckRequest,CheckResponse> checkCallable()

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

Sample code:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceControllerClient serviceControllerClient = ServiceControllerClient.create()) {
   CheckRequest request =
       CheckRequest.newBuilder()
           .setServiceName("serviceName-1928572192")
           .setOperation(Operation.newBuilder().build())
           .setServiceConfigId("serviceConfigId650537426")
           .build();
   ApiFuture<CheckResponse> future = serviceControllerClient.checkCallable().futureCall(request);
   // Do something.
   CheckResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<CheckRequest,CheckResponse>

close()

public final void close()

getSettings()

public final ServiceControllerSettings getSettings()

Returns
Type	Description
ServiceControllerSettings

getStub()

public ServiceControllerStub getStub()

Returns
Type	Description
ServiceControllerStub

isShutdown()

public boolean isShutdown()

Returns
Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns
Type	Description
boolean

report(ReportRequest request)

public final ReportResponse report(ReportRequest request)

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

Sample code:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceControllerClient serviceControllerClient = ServiceControllerClient.create()) {
   ReportRequest request =
       ReportRequest.newBuilder()
           .setServiceName("serviceName-1928572192")
           .addAllOperations(new ArrayList<Operation>())
           .setServiceConfigId("serviceConfigId650537426")
           .build();
   ReportResponse response = serviceControllerClient.report(request);
 }
 

Parameter
Name	Description
request	ReportRequest The request object containing all of the parameters for the API call.

Returns
Type	Description
ReportResponse

reportCallable()

public final UnaryCallable<ReportRequest,ReportResponse> reportCallable()

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

Sample code:

 // 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://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
 try (ServiceControllerClient serviceControllerClient = ServiceControllerClient.create()) {
   ReportRequest request =
       ReportRequest.newBuilder()
           .setServiceName("serviceName-1928572192")
           .addAllOperations(new ArrayList<Operation>())
           .setServiceConfigId("serviceConfigId650537426")
           .build();
   ApiFuture<ReportResponse> future =
       serviceControllerClient.reportCallable().futureCall(request);
   // Do something.
   ReportResponse response = future.get();
 }
 

Returns
Type	Description
UnaryCallable<ReportRequest,ReportResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()