Skip to content
This repository has been archived by the owner on Sep 16, 2023. It is now read-only.

Commit

Permalink
docs: fix docstring formatting (#146)
Browse files Browse the repository at this point in the history 
* 馃 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

feat: Added Service Controller v2 API

PiperOrigin-RevId: 431525317

Source-Link: googleapis/googleapis@43930af

Source-Link: googleapis/googleapis-gen@d94d483
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiZDk0ZDQ4M2Q0OTM2MzhiOGVkMjFmYjExYzBkYTM2OGNhZmY1Yzc4MiJ9

* 馃 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* docs: fix docstring formatting

Committer: parthea
PiperOrigin-RevId: 432972690

Source-Link: googleapis/googleapis@abd73bc

Source-Link: googleapis/googleapis-gen@34ddad4
Copy-Tag: eyJwIjoiLmdpdGh1Yi8uT3dsQm90LnlhbWwiLCJoIjoiMzRkZGFkNDRjODBlNTBhZGYzZGVlZTRlOTFhZmI1ZjVkNGFhYTdmNyJ9

* 馃 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* ci: fixed versions.txt inconsistent state

* 馃 Updates from OwlBot post-processor

See https://github.com/googleapis/repo-automation-bots/blob/main/packages/owl-bot/README.md

* ci: fixing the version of parent

* deps: removing unused dependencies

Fixing the warning for dependencies check:

[INFO] --- maven-dependency-plugin:3.1.2:analyze (default-cli) @ proto-google-cloud-service-control-v2 ---
Warning:  Unused declared dependencies found:
Warning:     com.google.api.grpc:proto-google-iam-v1:jar:1.2.6:compile
Warning:     com.google.api:api-common:jar:2.1.4:compile
Warning:     com.google.guava:guava:jar:31.0.1-jre:compile

* deps: removing unnecessary dependencies

[INFO] --- maven-dependency-plugin:3.1.2:analyze (default-cli) @ grpc-google-cloud-service-control-v2 ---
Warning:  Unused declared dependencies found:
Warning:     com.google.api.grpc:proto-google-common-protos:jar:2.7.4:compile

Co-authored-by: Owl Bot <gcf-owl-bot[bot]@users.noreply.github.com>
Co-authored-by: Emily Ball <emilyball@google.com>
Co-authored-by: Tomo Suzuki <suztomo@google.com>
  • Loading branch information
@gcf-owl-bot @eaball35 @suztomo
4 people committed Mar 22, 2022
1 parent 6df3fd8 commit 93110a0
Show file tree
Hide file tree
Showing 31 changed files with 9,516 additions and 0 deletions.
10 changes: 10 additions & 0 deletions google-cloud-service-control-bom/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,11 +63,21 @@
<artifactId>grpc-google-cloud-service-control-v1</artifactId>
<version>1.1.10-SNAPSHOT</version><!-- {x-version-update:grpc-google-cloud-service-control-v1:current} -->
</dependency>
<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>grpc-google-cloud-service-control-v2</artifactId>
<version>1.1.10-SNAPSHOT</version><!-- {x-version-update:grpc-google-cloud-service-control-v2:current} -->
</dependency>
<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>proto-google-cloud-service-control-v1</artifactId>
<version>1.1.10-SNAPSHOT</version><!-- {x-version-update:proto-google-cloud-service-control-v1:current} -->
</dependency>
<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>proto-google-cloud-service-control-v2</artifactId>
<version>1.1.10-SNAPSHOT</version><!-- {x-version-update:proto-google-cloud-service-control-v2:current} -->
</dependency>
</dependencies>
</dependencyManagement>

Expand Down
9 changes: 9 additions & 0 deletions google-cloud-service-control/pom.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@
<artifactId>proto-google-common-protos</artifactId>
</dependency>

<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>proto-google-cloud-service-control-v2</artifactId>
</dependency>
<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>proto-google-cloud-service-control-v1</artifactId>
Expand Down Expand Up @@ -76,6 +80,11 @@
<artifactId>grpc-google-cloud-service-control-v1</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>com.google.api.grpc</groupId>
<artifactId>grpc-google-cloud-service-control-v2</artifactId>
<scope>test</scope>
</dependency>
<!-- Need testing utility classes for generated gRPC clients tests -->
<dependency>
<groupId>com.google.api</groupId>
Expand Down
346 changes: 346 additions & 0 deletions ...rvice-control/src/main/java/com/google/api/servicecontrol/v2/ServiceControllerClient.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,346 @@
/*
* Copyright 2021 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.core.BetaApi;
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](/service-infrastructure/docs/service-control)
*
* <p>Private Preview. This feature is only available for approved services.
*
* <p>This API provides admission control and telemetry reporting for services that are integrated
* with [Service Infrastructure](/service-infrastructure).
*
* <p>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:
*
* <pre>{@code
* 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);
* }
* }</pre>
*
* <p>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().
*
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* <ol>
* <li>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.
* <li>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.
* <li>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.
* </ol>
*
* <p>See the individual methods for example code.
*
* <p>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.
*
* <p>This class can be customized by passing in a custom instance of ServiceControllerSettings to
* create(). For example:
*
* <p>To customize credentials:
*
* <pre>{@code
* ServiceControllerSettings serviceControllerSettings =
* ServiceControllerSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* ServiceControllerClient serviceControllerClient =
* ServiceControllerClient.create(serviceControllerSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@code
* ServiceControllerSettings serviceControllerSettings =
* ServiceControllerSettings.newBuilder().setEndpoint(myEndpoint).build();
* ServiceControllerClient serviceControllerClient =
* ServiceControllerClient.create(serviceControllerSettings);
* }</pre>
*
* <p>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).
*/
@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
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();
}

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
protected ServiceControllerClient(ServiceControllerStub stub) {
this.settings = null;
this.stub = stub;
}

public final ServiceControllerSettings getSettings() {
return settings;
}

@BetaApi("A restructuring of stub classes is planned, so this may break in the future")
public ServiceControllerStub getStub() {
return stub;
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Private Preview. This feature is only available for approved services.
*
* <p>This method provides admission control for services that are integrated with [Service
* Infrastructure](/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](/service-infrastructure/docs/admission-control).
*
* <p>NOTE: The admission control has an expected policy propagation delay of 60s. The caller
* &#42;&#42;must&#42;&#42; not depend on the most recent policy changes.
*
* <p>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.
*
* <p>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).
*
* <p>Sample code:
*
* <pre>{@code
* 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);
* }
* }</pre>
*
* @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.
*
* <p>This method provides admission control for services that are integrated with [Service
* Infrastructure](/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](/service-infrastructure/docs/admission-control).
*
* <p>NOTE: The admission control has an expected policy propagation delay of 60s. The caller
* &#42;&#42;must&#42;&#42; not depend on the most recent policy changes.
*
* <p>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.
*
* <p>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).
*
* <p>Sample code:
*
* <pre>{@code
* 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();
* }
* }</pre>
*/
public final UnaryCallable<CheckRequest, CheckResponse> checkCallable() {
return stub.checkCallable();
}

// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Private Preview. This feature is only available for approved services.
*
* <p>This method provides telemetry reporting for services that are integrated with [Service
* Infrastructure](/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](/service-infrastructure/docs/telemetry-reporting).
*
* <p>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.
*
* <p>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).
*
* <p>Sample code:
*
* <pre>{@code
* try (ServiceControllerClient serviceControllerClient = ServiceControllerClient.create()) {
* ReportRequest request =
* ReportRequest.newBuilder()
* .setServiceName("serviceName-1928572192")
* .setServiceConfigId("serviceConfigId650537426")
* .addAllOperations(new ArrayList<AttributeContext>())
* .build();
* ReportResponse response = serviceControllerClient.report(request);
* }
* }</pre>
*
* @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.
*
* <p>This method provides telemetry reporting for services that are integrated with [Service
* Infrastructure](/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](/service-infrastructure/docs/telemetry-reporting).
*
* <p>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.
*
* <p>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).
*
* <p>Sample code:
*
* <pre>{@code
* 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();
* }
* }</pre>
*/
public final UnaryCallable<ReportRequest, ReportResponse> 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);
}
}
Loading

0 comments on commit 93110a0

Please sign in to comment.