Class ServiceControllerClient (1.31.0)

Service Description: Service Control API v2

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.

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")
           .setServiceConfigId("serviceConfigId650537426")
           .setAttributes(AttributeContext.newBuilder().build())
           .addAllResources(new ArrayList<ResourceInfo>())
           .setFlags("flags97513095")
           .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().

The surface of this class includes several types of Java methods for each of the API's methods:

A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

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)

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

This method provides admission control for services that are integrated with 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.

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.

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")
           .setServiceConfigId("serviceConfigId650537426")
           .setAttributes(AttributeContext.newBuilder().build())
           .addAllResources(new ArrayList<ResourceInfo>())
           .setFlags("flags97513095")
           .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()

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

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.

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")
           .setServiceConfigId("serviceConfigId650537426")
           .setAttributes(AttributeContext.newBuilder().build())
           .addAllResources(new ArrayList<ResourceInfo>())
           .setFlags("flags97513095")
           .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)

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

This method provides telemetry reporting for services that are integrated with 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.

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.

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")
           .setServiceConfigId("serviceConfigId650537426")
           .addAllOperations(new ArrayList<AttributeContext>())
           .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()

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

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.

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")
           .setServiceConfigId("serviceConfigId650537426")
           .addAllOperations(new ArrayList<AttributeContext>())
           .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()