ServiceControllerClient (Google Service Control API 1.39.0 API)

java.lang.Object
- com.google.api.servicecontrol.v1.ServiceControllerClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ServiceControllerClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: [Google Service Control API](/service-control/overview)

Lets clients check and report operations against a [managed service](https://cloud.google.com/service-management/reference/rpc/google.api/servicemanagement.v1#google.api.servicemanagement.v1.ManagedService).

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][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](https://cloud.google.com/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][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](https://cloud.google.com/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.

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ServiceControllerClient(ServiceControllerSettings settings)` Constructs an instance of ServiceControllerClient, using the given settings.
`protected`	`ServiceControllerClient(ServiceControllerStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`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.
`com.google.api.gax.rpc.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.
`void`	`close()`
`static ServiceControllerClient`	`create()` Constructs an instance of ServiceControllerClient with default settings.
`static ServiceControllerClient`	`create(ServiceControllerSettings settings)` Constructs an instance of ServiceControllerClient, using the given settings.
`static ServiceControllerClient`	`create(ServiceControllerStub stub)` Constructs an instance of ServiceControllerClient, using the given stub for making calls.
`ServiceControllerSettings`	`getSettings()`
`ServiceControllerStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ReportResponse`	`report(ReportRequest request)` Reports operation results to Google Service Control, such as logs and metrics.
`com.google.api.gax.rpc.UnaryCallable<ReportRequest,ReportResponse>`	`reportCallable()` Reports operation results to Google Service Control, such as logs and metrics.
`void`	`shutdown()`
`void`	`shutdownNow()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ServiceControllerClient
```
protected ServiceControllerClient(ServiceControllerSettings settings)
                           throws IOException
```
    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.
    
    Throws:
    
    IOException
  - ServiceControllerClient
```
protected ServiceControllerClient(ServiceControllerStub stub)
```
- Method Detail
  - create
```
public static final ServiceControllerClient create()
                                            throws IOException
```
    Constructs an instance of ServiceControllerClient with default settings.
    
    Throws:
    
    IOException
  - create
```
public static final ServiceControllerClient create(ServiceControllerSettings settings)
                                            throws IOException
```
    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.
    
    Throws:
    
    IOException
  - create
```
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).
  - getSettings
```
public final ServiceControllerSettings getSettings()
```
  - getStub
```
public ServiceControllerStub getStub()
```
  - check
```
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][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](https://cloud.google.com/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);
 }
 
```
    Parameters:
    
    request - The request object containing all of the parameters for the API call.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - checkCallable
```
public final com.google.api.gax.rpc.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][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](https://cloud.google.com/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();
 }
 
```
  - report
```
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][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](https://cloud.google.com/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);
 }
 
```
    Parameters:
    
    request - The request object containing all of the parameters for the API call.
    
    Throws:
    
    com.google.api.gax.rpc.ApiException - if the remote call fails
  - reportCallable
```
public final com.google.api.gax.rpc.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][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](https://cloud.google.com/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();
 }
 
```
  - close
```
public final void close()
```
    Specified by:
    
    close in interface AutoCloseable
  - shutdown
```
public void shutdown()
```
    Specified by:
    
    shutdown in interface com.google.api.gax.core.BackgroundResource
  - isShutdown
```
public boolean isShutdown()
```
    Specified by:
    
    isShutdown in interface com.google.api.gax.core.BackgroundResource
  - isTerminated
```
public boolean isTerminated()
```
    Specified by:
    
    isTerminated in interface com.google.api.gax.core.BackgroundResource
  - shutdownNow
```
public void shutdownNow()
```
    Specified by:
    
    shutdownNow in interface com.google.api.gax.core.BackgroundResource
  - awaitTermination
```
public boolean awaitTermination(long duration,
                                TimeUnit unit)
                         throws InterruptedException
```
    Specified by:
    
    awaitTermination in interface com.google.api.gax.core.BackgroundResource
    
    Throws:
    
    InterruptedException

Class ServiceControllerClient

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ServiceControllerClient

ServiceControllerClient

Method Detail

create

create

create

getSettings

getStub

check

checkCallable

report

reportCallable

close

shutdown

isShutdown

isTerminated

shutdownNow

awaitTermination