Package com.google.api.servicecontrol.v2 (1.1.10)

A client to Service Control API

The interfaces provided are listed below, along with usage samples.

ServiceControllerClient

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.

Sample for ServiceControllerClient:


 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);
 }

Classes

CheckRequest

Request message for the Check method.

Protobuf type google.api.servicecontrol.v2.CheckRequest

CheckRequest.Builder

Request message for the Check method.

Protobuf type google.api.servicecontrol.v2.CheckRequest

CheckResponse

Response message for the Check method.

Protobuf type google.api.servicecontrol.v2.CheckResponse

CheckResponse.Builder

Response message for the Check method.

Protobuf type google.api.servicecontrol.v2.CheckResponse

ReportRequest

Request message for the Report method.

Protobuf type google.api.servicecontrol.v2.ReportRequest

ReportRequest.Builder

Request message for the Report method.

Protobuf type google.api.servicecontrol.v2.ReportRequest

ReportResponse

Response message for the Report method. If the request contains any invalid data, the server returns an RPC error.

Protobuf type google.api.servicecontrol.v2.ReportResponse

ReportResponse.Builder

Response message for the Report method. If the request contains any invalid data, the server returns an RPC error.

Protobuf type google.api.servicecontrol.v2.ReportResponse

ResourceInfo

Describes a resource referenced in the request.

Protobuf type google.api.servicecontrol.v2.ResourceInfo

ResourceInfo.Builder

Describes a resource referenced in the request.

Protobuf type google.api.servicecontrol.v2.ResourceInfo

ServiceControllerClient

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:


 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:

  1. 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.
  2. 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.
  3. 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:


 ServiceControllerSettings serviceControllerSettings =
     ServiceControllerSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServiceControllerClient serviceControllerClient =
     ServiceControllerClient.create(serviceControllerSettings);

To customize the endpoint:


 ServiceControllerSettings serviceControllerSettings =
     ServiceControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
 ServiceControllerClient serviceControllerClient =
     ServiceControllerClient.create(serviceControllerSettings);

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

ServiceControllerGrpc

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.

ServiceControllerGrpc.ServiceControllerBlockingStub

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.

ServiceControllerGrpc.ServiceControllerFutureStub

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.

ServiceControllerGrpc.ServiceControllerImplBase

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.

ServiceControllerGrpc.ServiceControllerStub

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.

ServiceControllerProto

ServiceControllerSettings

Settings class to configure an instance of ServiceControllerClient.

The default instance has everything set to sensible defaults:

  • The default service address (servicecontrol.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of check to 30 seconds:


 ServiceControllerSettings.Builder serviceControllerSettingsBuilder =
     ServiceControllerSettings.newBuilder();
 serviceControllerSettingsBuilder
     .checkSettings()
     .setRetrySettings(
         serviceControllerSettingsBuilder
             .checkSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ServiceControllerSettings serviceControllerSettings = serviceControllerSettingsBuilder.build();

ServiceControllerSettings.Builder

Builder for ServiceControllerSettings.

Interfaces

CheckRequestOrBuilder

CheckResponseOrBuilder

ReportRequestOrBuilder

ReportResponseOrBuilder

ResourceInfoOrBuilder