ServicesClient.java
/*
* Copyright 2022 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.cloud.run.v2;
import com.google.api.core.ApiFuture;
import com.google.api.core.ApiFutures;
import com.google.api.core.BetaApi;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.httpjson.longrunning.OperationsClient;
import com.google.api.gax.longrunning.OperationFuture;
import com.google.api.gax.paging.AbstractFixedSizeCollection;
import com.google.api.gax.paging.AbstractPage;
import com.google.api.gax.paging.AbstractPagedListResponse;
import com.google.api.gax.rpc.OperationCallable;
import com.google.api.gax.rpc.PageContext;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.run.v2.stub.ServicesStub;
import com.google.cloud.run.v2.stub.ServicesStubSettings;
import com.google.common.util.concurrent.MoreExecutors;
import com.google.iam.v1.GetIamPolicyRequest;
import com.google.iam.v1.Policy;
import com.google.iam.v1.SetIamPolicyRequest;
import com.google.iam.v1.TestIamPermissionsRequest;
import com.google.iam.v1.TestIamPermissionsResponse;
import com.google.longrunning.Operation;
import java.io.IOException;
import java.util.List;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Cloud Run Service Control Plane API
*
* <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
* // 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 (ServicesClient servicesClient = ServicesClient.create()) {
* ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
* Service response = servicesClient.getService(name);
* }
* }</pre>
*
* <p>Note: close() needs to be called on the ServicesClient 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 ServicesSettings to create().
* For example:
*
* <p>To customize credentials:
*
* <pre>{@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
* ServicesSettings servicesSettings =
* ServicesSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* ServicesClient servicesClient = ServicesClient.create(servicesSettings);
* }</pre>
*
* <p>To customize the endpoint:
*
* <pre>{@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
* ServicesSettings servicesSettings =
* ServicesSettings.newBuilder().setEndpoint(myEndpoint).build();
* ServicesClient servicesClient = ServicesClient.create(servicesSettings);
* }</pre>
*
* <p>To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
* <pre>{@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
* ServicesSettings servicesSettings =
* ServicesSettings.newBuilder()
* .setTransportChannelProvider(
* ServicesSettings.defaultHttpJsonTransportProviderBuilder().build())
* .build();
* ServicesClient servicesClient = ServicesClient.create(servicesSettings);
* }</pre>
*
* <p>Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class ServicesClient implements BackgroundResource {
private final ServicesSettings settings;
private final ServicesStub stub;
private final OperationsClient httpJsonOperationsClient;
private final com.google.longrunning.OperationsClient operationsClient;
/** Constructs an instance of ServicesClient with default settings. */
public static final ServicesClient create() throws IOException {
return create(ServicesSettings.newBuilder().build());
}
/**
* Constructs an instance of ServicesClient, 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 ServicesClient create(ServicesSettings settings) throws IOException {
return new ServicesClient(settings);
}
/**
* Constructs an instance of ServicesClient, using the given stub for making calls. This is for
* advanced usage - prefer using create(ServicesSettings).
*/
public static final ServicesClient create(ServicesStub stub) {
return new ServicesClient(stub);
}
/**
* Constructs an instance of ServicesClient, 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 ServicesClient(ServicesSettings settings) throws IOException {
this.settings = settings;
this.stub = ((ServicesStubSettings) settings.getStubSettings()).createStub();
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
protected ServicesClient(ServicesStub stub) {
this.settings = null;
this.stub = stub;
this.operationsClient =
com.google.longrunning.OperationsClient.create(this.stub.getOperationsStub());
this.httpJsonOperationsClient = OperationsClient.create(this.stub.getHttpJsonOperationsStub());
}
public final ServicesSettings getSettings() {
return settings;
}
public ServicesStub getStub() {
return stub;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
public final com.google.longrunning.OperationsClient getOperationsClient() {
return operationsClient;
}
/**
* Returns the OperationsClient that can be used to query the status of a long-running operation
* returned by another API method call.
*/
@BetaApi
public final OperationsClient getHttpJsonOperationsClient() {
return httpJsonOperationsClient;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Service in a given project and location.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* Service service = Service.newBuilder().build();
* String serviceId = "serviceId-194185552";
* Service response = servicesClient.createServiceAsync(parent, service, serviceId).get();
* }
* }</pre>
*
* @param parent Required. The location and project in which this service should be created.
* Format: projects/{projectnumber}/locations/{location}
* @param service Required. The Service instance to create.
* @param serviceId Required. The unique identifier for the Service. The name of the service
* becomes {parent}/services/{service_id}.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Service, Service> createServiceAsync(
LocationName parent, Service service, String serviceId) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.setService(service)
.setServiceId(serviceId)
.build();
return createServiceAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Service in a given project and location.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* Service service = Service.newBuilder().build();
* String serviceId = "serviceId-194185552";
* Service response = servicesClient.createServiceAsync(parent, service, serviceId).get();
* }
* }</pre>
*
* @param parent Required. The location and project in which this service should be created.
* Format: projects/{projectnumber}/locations/{location}
* @param service Required. The Service instance to create.
* @param serviceId Required. The unique identifier for the Service. The name of the service
* becomes {parent}/services/{service_id}.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Service, Service> createServiceAsync(
String parent, Service service, String serviceId) {
CreateServiceRequest request =
CreateServiceRequest.newBuilder()
.setParent(parent)
.setService(service)
.setServiceId(serviceId)
.build();
return createServiceAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Service in a given project and location.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* CreateServiceRequest request =
* CreateServiceRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setService(Service.newBuilder().build())
* .setServiceId("serviceId-194185552")
* .setValidateOnly(true)
* .build();
* Service response = servicesClient.createServiceAsync(request).get();
* }
* }</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 OperationFuture<Service, Service> createServiceAsync(CreateServiceRequest request) {
return createServiceOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Service in a given project and location.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* CreateServiceRequest request =
* CreateServiceRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setService(Service.newBuilder().build())
* .setServiceId("serviceId-194185552")
* .setValidateOnly(true)
* .build();
* OperationFuture<Service, Service> future =
* servicesClient.createServiceOperationCallable().futureCall(request);
* // Do something.
* Service response = future.get();
* }
* }</pre>
*/
public final OperationCallable<CreateServiceRequest, Service, Service>
createServiceOperationCallable() {
return stub.createServiceOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Creates a new Service in a given project and location.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* CreateServiceRequest request =
* CreateServiceRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setService(Service.newBuilder().build())
* .setServiceId("serviceId-194185552")
* .setValidateOnly(true)
* .build();
* ApiFuture<Operation> future = servicesClient.createServiceCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<CreateServiceRequest, Operation> createServiceCallable() {
return stub.createServiceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a Service.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
* Service response = servicesClient.getService(name);
* }
* }</pre>
*
* @param name Required. The full name of the Service. Format:
* projects/{projectnumber}/locations/{location}/services/{service}
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Service getService(ServiceName name) {
GetServiceRequest request =
GetServiceRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return getService(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a Service.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* String name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
* Service response = servicesClient.getService(name);
* }
* }</pre>
*
* @param name Required. The full name of the Service. Format:
* projects/{projectnumber}/locations/{location}/services/{service}
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final Service getService(String name) {
GetServiceRequest request = GetServiceRequest.newBuilder().setName(name).build();
return getService(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a Service.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* GetServiceRequest request =
* GetServiceRequest.newBuilder()
* .setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .build();
* Service response = servicesClient.getService(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 Service getService(GetServiceRequest request) {
return getServiceCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Gets information about a Service.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* GetServiceRequest request =
* GetServiceRequest.newBuilder()
* .setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .build();
* ApiFuture<Service> future = servicesClient.getServiceCallable().futureCall(request);
* // Do something.
* Service response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetServiceRequest, Service> getServiceCallable() {
return stub.getServiceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List Services.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
* for (Service element : servicesClient.listServices(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The location and project to list resources on. Location must be a valid
* GCP region, and may not be the "-" wildcard. Format:
* projects/{projectnumber}/locations/{location}
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListServicesPagedResponse listServices(LocationName parent) {
ListServicesRequest request =
ListServicesRequest.newBuilder()
.setParent(parent == null ? null : parent.toString())
.build();
return listServices(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List Services.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
* for (Service element : servicesClient.listServices(parent).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*
* @param parent Required. The location and project to list resources on. Location must be a valid
* GCP region, and may not be the "-" wildcard. Format:
* projects/{projectnumber}/locations/{location}
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ListServicesPagedResponse listServices(String parent) {
ListServicesRequest request = ListServicesRequest.newBuilder().setParent(parent).build();
return listServices(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List Services.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* ListServicesRequest request =
* ListServicesRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setShowDeleted(true)
* .build();
* for (Service element : servicesClient.listServices(request).iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</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 ListServicesPagedResponse listServices(ListServicesRequest request) {
return listServicesPagedCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List Services.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* ListServicesRequest request =
* ListServicesRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setShowDeleted(true)
* .build();
* ApiFuture<Service> future = servicesClient.listServicesPagedCallable().futureCall(request);
* // Do something.
* for (Service element : future.get().iterateAll()) {
* // doThingsWith(element);
* }
* }
* }</pre>
*/
public final UnaryCallable<ListServicesRequest, ListServicesPagedResponse>
listServicesPagedCallable() {
return stub.listServicesPagedCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* List Services.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* ListServicesRequest request =
* ListServicesRequest.newBuilder()
* .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
* .setPageSize(883849137)
* .setPageToken("pageToken873572522")
* .setShowDeleted(true)
* .build();
* while (true) {
* ListServicesResponse response = servicesClient.listServicesCallable().call(request);
* for (Service element : response.getServicesList()) {
* // doThingsWith(element);
* }
* String nextPageToken = response.getNextPageToken();
* if (!Strings.isNullOrEmpty(nextPageToken)) {
* request = request.toBuilder().setPageToken(nextPageToken).build();
* } else {
* break;
* }
* }
* }
* }</pre>
*/
public final UnaryCallable<ListServicesRequest, ListServicesResponse> listServicesCallable() {
return stub.listServicesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Service.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* Service service = Service.newBuilder().build();
* Service response = servicesClient.updateServiceAsync(service).get();
* }
* }</pre>
*
* @param service Required. The Service to be updated.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Service, Service> updateServiceAsync(Service service) {
UpdateServiceRequest request = UpdateServiceRequest.newBuilder().setService(service).build();
return updateServiceAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Service.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* UpdateServiceRequest request =
* UpdateServiceRequest.newBuilder()
* .setService(Service.newBuilder().build())
* .setValidateOnly(true)
* .setAllowMissing(true)
* .build();
* Service response = servicesClient.updateServiceAsync(request).get();
* }
* }</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 OperationFuture<Service, Service> updateServiceAsync(UpdateServiceRequest request) {
return updateServiceOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Service.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* UpdateServiceRequest request =
* UpdateServiceRequest.newBuilder()
* .setService(Service.newBuilder().build())
* .setValidateOnly(true)
* .setAllowMissing(true)
* .build();
* OperationFuture<Service, Service> future =
* servicesClient.updateServiceOperationCallable().futureCall(request);
* // Do something.
* Service response = future.get();
* }
* }</pre>
*/
public final OperationCallable<UpdateServiceRequest, Service, Service>
updateServiceOperationCallable() {
return stub.updateServiceOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Updates a Service.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* UpdateServiceRequest request =
* UpdateServiceRequest.newBuilder()
* .setService(Service.newBuilder().build())
* .setValidateOnly(true)
* .setAllowMissing(true)
* .build();
* ApiFuture<Operation> future = servicesClient.updateServiceCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<UpdateServiceRequest, Operation> updateServiceCallable() {
return stub.updateServiceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Service. This will cause the Service to stop serving traffic and will delete all
* revisions.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
* Service response = servicesClient.deleteServiceAsync(name).get();
* }
* }</pre>
*
* @param name Required. The full name of the Service. Format:
* projects/{projectnumber}/locations/{location}/services/{service}
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Service, Service> deleteServiceAsync(ServiceName name) {
DeleteServiceRequest request =
DeleteServiceRequest.newBuilder().setName(name == null ? null : name.toString()).build();
return deleteServiceAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Service. This will cause the Service to stop serving traffic and will delete all
* revisions.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* String name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString();
* Service response = servicesClient.deleteServiceAsync(name).get();
* }
* }</pre>
*
* @param name Required. The full name of the Service. Format:
* projects/{projectnumber}/locations/{location}/services/{service}
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final OperationFuture<Service, Service> deleteServiceAsync(String name) {
DeleteServiceRequest request = DeleteServiceRequest.newBuilder().setName(name).build();
return deleteServiceAsync(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Service. This will cause the Service to stop serving traffic and will delete all
* revisions.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* DeleteServiceRequest request =
* DeleteServiceRequest.newBuilder()
* .setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .setValidateOnly(true)
* .setEtag("etag3123477")
* .build();
* Service response = servicesClient.deleteServiceAsync(request).get();
* }
* }</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 OperationFuture<Service, Service> deleteServiceAsync(DeleteServiceRequest request) {
return deleteServiceOperationCallable().futureCall(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Service. This will cause the Service to stop serving traffic and will delete all
* revisions.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* DeleteServiceRequest request =
* DeleteServiceRequest.newBuilder()
* .setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .setValidateOnly(true)
* .setEtag("etag3123477")
* .build();
* OperationFuture<Service, Service> future =
* servicesClient.deleteServiceOperationCallable().futureCall(request);
* // Do something.
* Service response = future.get();
* }
* }</pre>
*/
public final OperationCallable<DeleteServiceRequest, Service, Service>
deleteServiceOperationCallable() {
return stub.deleteServiceOperationCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Deletes a Service. This will cause the Service to stop serving traffic and will delete all
* revisions.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* DeleteServiceRequest request =
* DeleteServiceRequest.newBuilder()
* .setName(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .setValidateOnly(true)
* .setEtag("etag3123477")
* .build();
* ApiFuture<Operation> future = servicesClient.deleteServiceCallable().futureCall(request);
* // Do something.
* Operation response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<DeleteServiceRequest, Operation> deleteServiceCallable() {
return stub.deleteServiceCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get the IAM Access Control policy currently in effect for the given Cloud Run Service. This
* result does not include any inherited policies.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* Policy response = servicesClient.getIamPolicy(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 Policy getIamPolicy(GetIamPolicyRequest request) {
return getIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Get the IAM Access Control policy currently in effect for the given Cloud Run Service. This
* result does not include any inherited policies.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* GetIamPolicyRequest request =
* GetIamPolicyRequest.newBuilder()
* .setResource(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .setOptions(GetPolicyOptions.newBuilder().build())
* .build();
* ApiFuture<Policy> future = servicesClient.getIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<GetIamPolicyRequest, Policy> getIamPolicyCallable() {
return stub.getIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* Policy response = servicesClient.setIamPolicy(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 Policy setIamPolicy(SetIamPolicyRequest request) {
return setIamPolicyCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* SetIamPolicyRequest request =
* SetIamPolicyRequest.newBuilder()
* .setResource(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .setPolicy(Policy.newBuilder().build())
* .setUpdateMask(FieldMask.newBuilder().build())
* .build();
* ApiFuture<Policy> future = servicesClient.setIamPolicyCallable().futureCall(request);
* // Do something.
* Policy response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<SetIamPolicyRequest, Policy> setIamPolicyCallable() {
return stub.setIamPolicyCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that a caller has on the specified Project.
*
* <p>There are no permissions required for making this API call.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .addAllPermissions(new ArrayList<String>())
* .build();
* TestIamPermissionsResponse response = servicesClient.testIamPermissions(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 TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request) {
return testIamPermissionsCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Returns permissions that a caller has on the specified Project.
*
* <p>There are no permissions required for making this API call.
*
* <p>Sample code:
*
* <pre>{@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 (ServicesClient servicesClient = ServicesClient.create()) {
* TestIamPermissionsRequest request =
* TestIamPermissionsRequest.newBuilder()
* .setResource(ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]").toString())
* .addAllPermissions(new ArrayList<String>())
* .build();
* ApiFuture<TestIamPermissionsResponse> future =
* servicesClient.testIamPermissionsCallable().futureCall(request);
* // Do something.
* TestIamPermissionsResponse response = future.get();
* }
* }</pre>
*/
public final UnaryCallable<TestIamPermissionsRequest, TestIamPermissionsResponse>
testIamPermissionsCallable() {
return stub.testIamPermissionsCallable();
}
@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);
}
public static class ListServicesPagedResponse
extends AbstractPagedListResponse<
ListServicesRequest,
ListServicesResponse,
Service,
ListServicesPage,
ListServicesFixedSizeCollection> {
public static ApiFuture<ListServicesPagedResponse> createAsync(
PageContext<ListServicesRequest, ListServicesResponse, Service> context,
ApiFuture<ListServicesResponse> futureResponse) {
ApiFuture<ListServicesPage> futurePage =
ListServicesPage.createEmptyPage().createPageAsync(context, futureResponse);
return ApiFutures.transform(
futurePage,
input -> new ListServicesPagedResponse(input),
MoreExecutors.directExecutor());
}
private ListServicesPagedResponse(ListServicesPage page) {
super(page, ListServicesFixedSizeCollection.createEmptyCollection());
}
}
public static class ListServicesPage
extends AbstractPage<ListServicesRequest, ListServicesResponse, Service, ListServicesPage> {
private ListServicesPage(
PageContext<ListServicesRequest, ListServicesResponse, Service> context,
ListServicesResponse response) {
super(context, response);
}
private static ListServicesPage createEmptyPage() {
return new ListServicesPage(null, null);
}
@Override
protected ListServicesPage createPage(
PageContext<ListServicesRequest, ListServicesResponse, Service> context,
ListServicesResponse response) {
return new ListServicesPage(context, response);
}
@Override
public ApiFuture<ListServicesPage> createPageAsync(
PageContext<ListServicesRequest, ListServicesResponse, Service> context,
ApiFuture<ListServicesResponse> futureResponse) {
return super.createPageAsync(context, futureResponse);
}
}
public static class ListServicesFixedSizeCollection
extends AbstractFixedSizeCollection<
ListServicesRequest,
ListServicesResponse,
Service,
ListServicesPage,
ListServicesFixedSizeCollection> {
private ListServicesFixedSizeCollection(List<ListServicesPage> pages, int collectionSize) {
super(pages, collectionSize);
}
private static ListServicesFixedSizeCollection createEmptyCollection() {
return new ListServicesFixedSizeCollection(null, 0);
}
@Override
protected ListServicesFixedSizeCollection createCollection(
List<ListServicesPage> pages, int collectionSize) {
return new ListServicesFixedSizeCollection(pages, collectionSize);
}
}
}