com.google.api.servicecontrol.v2.ServiceControllerClient Maven / Gradle / Ivy
Show all versions of google-cloud-service-control Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.api.servicecontrol.v2;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.api.servicecontrol.v2.stub.ServiceControllerStub;
import com.google.api.servicecontrol.v2.stub.ServiceControllerStubSettings;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: [Service Control API
* v2](https://cloud.google.com/service-infrastructure/docs/service-control/access-control)
*
* 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](https://cloud.google.com/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:
*
*
{@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())
* .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().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* Check
Private Preview. This feature is only available for approved services.
*
This method provides admission control for services that are integrated with [Service Infrastructure](https://cloud.google.com/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](https://cloud.google.com/service-infrastructure/docs/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](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
* 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
Private Preview. This feature is only available for approved services.
*
This method provides telemetry reporting for services that are integrated with [Service Infrastructure](https://cloud.google.com/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](https://cloud.google.com/service-infrastructure/docs/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](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
* 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:
*
*
{@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
* ServiceControllerSettings serviceControllerSettings =
* ServiceControllerSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* ServiceControllerClient serviceControllerClient =
* ServiceControllerClient.create(serviceControllerSettings);
* }
*
* To customize the endpoint:
*
*
{@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
* 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:
*
*
{@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
* ServiceControllerSettings serviceControllerSettings =
* ServiceControllerSettings.newHttpJsonBuilder().build();
* ServiceControllerClient serviceControllerClient =
* ServiceControllerClient.create(serviceControllerSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class ServiceControllerClient implements BackgroundResource {
private final ServiceControllerSettings settings;
private final ServiceControllerStub stub;
/** Constructs an instance of ServiceControllerClient with default settings. */
public static final ServiceControllerClient create() throws IOException {
return create(ServiceControllerSettings.newBuilder().build());
}
/**
* 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.
*/
public static final ServiceControllerClient create(ServiceControllerSettings settings)
throws IOException {
return new ServiceControllerClient(settings);
}
/**
* Constructs an instance of ServiceControllerClient, using the given stub for making calls. This
* is for advanced usage - prefer using create(ServiceControllerSettings).
*/
public static final ServiceControllerClient create(ServiceControllerStub stub) {
return new ServiceControllerClient(stub);
}
/**
* 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.
*/
protected ServiceControllerClient(ServiceControllerSettings settings) throws IOException {
this.settings = settings;
this.stub = ((ServiceControllerStubSettings) settings.getStubSettings()).createStub();
}
protected ServiceControllerClient(ServiceControllerStub stub) {
this.settings = null;
this.stub = stub;
}
public final ServiceControllerSettings getSettings() {
return settings;
}
public ServiceControllerStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Private Preview. This feature is only available for approved services.
*
*
This method provides admission control for services that are integrated with [Service
* Infrastructure](https://cloud.google.com/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](https://cloud.google.com/service-infrastructure/docs/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](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
*
*
Sample code:
*
*
{@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())
* .setFlags("flags97513095")
* .build();
* CheckResponse response = serviceControllerClient.check(request);
* }
* }
*
* @param 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
*/
public final CheckResponse check(CheckRequest request) {
return checkCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Private Preview. This feature is only available for approved services.
*
* This method provides admission control for services that are integrated with [Service
* Infrastructure](https://cloud.google.com/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](https://cloud.google.com/service-infrastructure/docs/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](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
*
*
Sample code:
*
*
{@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())
* .setFlags("flags97513095")
* .build();
* ApiFuture future = serviceControllerClient.checkCallable().futureCall(request);
* // Do something.
* CheckResponse response = future.get();
* }
* }
*/
public final UnaryCallable checkCallable() {
return stub.checkCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Private Preview. This feature is only available for approved services.
*
* This method provides telemetry reporting for services that are integrated with [Service
* Infrastructure](https://cloud.google.com/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](https://cloud.google.com/service-infrastructure/docs/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](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
*
*
Sample code:
*
*
{@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())
* .build();
* ReportResponse response = serviceControllerClient.report(request);
* }
* }
*
* @param 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
*/
public final ReportResponse report(ReportRequest request) {
return reportCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Private Preview. This feature is only available for approved services.
*
* This method provides telemetry reporting for services that are integrated with [Service
* Infrastructure](https://cloud.google.com/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](https://cloud.google.com/service-infrastructure/docs/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](https://cloud.google.com/service-infrastructure/docs/service-control/access-control).
*
*
Sample code:
*
*
{@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())
* .build();
* ApiFuture future =
* serviceControllerClient.reportCallable().futureCall(request);
* // Do something.
* ReportResponse response = future.get();
* }
* }
*/
public final UnaryCallable reportCallable() {
return stub.reportCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}