ServicesClient (Google Cloud Run 0.67.0 API)

java.lang.Object
- com.google.cloud.run.v2.ServicesClient

All Implemented Interfaces:: com.google.api.gax.core.BackgroundResource, AutoCloseable

@Generated(value="by gapic-generator-java")
public class ServicesClient
extends Object
implements com.google.api.gax.core.BackgroundResource

Service Description: Cloud Run Service Control Plane API

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 (ServicesClient servicesClient = ServicesClient.create()) {
   ServiceName name = ServiceName.of("[PROJECT]", "[LOCATION]", "[SERVICE]");
   Service response = servicesClient.getService(name);
 }

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().

Methods
Method	Description	Method Variants
CreateService	Creates a new Service in a given project and location.	Request object method variants only take one parameter, a request object, which must be constructed before the call. createServiceAsync(CreateServiceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. createServiceAsync(LocationName parent, Service service, String serviceId) createServiceAsync(String parent, Service service, String serviceId) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. createServiceOperationCallable() createServiceCallable()
GetService	Gets information about a Service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getService(GetServiceRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. getService(ServiceName name) getService(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getServiceCallable()
ListServices	Lists Services. Results are sorted by creation time, descending.	Request object method variants only take one parameter, a request object, which must be constructed before the call. listServices(ListServicesRequest request) "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method. listServices(LocationName parent) listServices(String parent) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. listServicesPagedCallable() listServicesCallable()
UpdateService	Updates a Service.	Request object method variants only take one parameter, a request object, which must be constructed before the call. updateServiceAsync(UpdateServiceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. updateServiceAsync(Service service) updateServiceAsync(Service service, FieldMask updateMask) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. updateServiceOperationCallable() updateServiceCallable()
DeleteService	Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.	Request object method variants only take one parameter, a request object, which must be constructed before the call. deleteServiceAsync(DeleteServiceRequest request) Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service. deleteServiceAsync(ServiceName name) deleteServiceAsync(String name) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. deleteServiceOperationCallable() deleteServiceCallable()
GetIamPolicy	Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.	Request object method variants only take one parameter, a request object, which must be constructed before the call. getIamPolicy(GetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. getIamPolicyCallable()
SetIamPolicy	Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.	Request object method variants only take one parameter, a request object, which must be constructed before the call. setIamPolicy(SetIamPolicyRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. setIamPolicyCallable()
TestIamPermissions	Returns permissions that a caller has on the specified Project. There are no permissions required for making this API call.	Request object method variants only take one parameter, a request object, which must be constructed before the call. testIamPermissions(TestIamPermissionsRequest request) Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service. testIamPermissionsCallable()

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 ServicesSettings 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
 ServicesSettings servicesSettings =
     ServicesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServicesClient servicesClient = ServicesClient.create(servicesSettings);

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
 ServicesSettings servicesSettings =
     ServicesSettings.newBuilder().setEndpoint(myEndpoint).build();
 ServicesClient servicesClient = ServicesClient.create(servicesSettings);

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
 ServicesSettings servicesSettings = ServicesSettings.newHttpJsonBuilder().build();
 ServicesClient servicesClient = ServicesClient.create(servicesSettings);

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

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ServicesClient.ListServicesFixedSizeCollection`
`static class`	`ServicesClient.ListServicesPage`
`static class`	`ServicesClient.ListServicesPagedResponse`

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`ServicesClient(ServicesSettings settings)` Constructs an instance of ServicesClient, using the given settings.
`protected`	`ServicesClient(ServicesStub stub)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`awaitTermination(long duration, TimeUnit unit)`
`void`	`close()`
`static ServicesClient`	`create()` Constructs an instance of ServicesClient with default settings.
`static ServicesClient`	`create(ServicesSettings settings)` Constructs an instance of ServicesClient, using the given settings.
`static ServicesClient`	`create(ServicesStub stub)` Constructs an instance of ServicesClient, using the given stub for making calls.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`createServiceAsync(CreateServiceRequest request)` Creates a new Service in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`createServiceAsync(LocationName parent, Service service, String serviceId)` Creates a new Service in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`createServiceAsync(String parent, Service service, String serviceId)` Creates a new Service in a given project and location.
`com.google.api.gax.rpc.UnaryCallable<CreateServiceRequest,com.google.longrunning.Operation>`	`createServiceCallable()` Creates a new Service in a given project and location.
`com.google.api.gax.rpc.OperationCallable<CreateServiceRequest,Service,Service>`	`createServiceOperationCallable()` Creates a new Service in a given project and location.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`deleteServiceAsync(DeleteServiceRequest request)` Deletes a Service.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`deleteServiceAsync(ServiceName name)` Deletes a Service.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`deleteServiceAsync(String name)` Deletes a Service.
`com.google.api.gax.rpc.UnaryCallable<DeleteServiceRequest,com.google.longrunning.Operation>`	`deleteServiceCallable()` Deletes a Service.
`com.google.api.gax.rpc.OperationCallable<DeleteServiceRequest,Service,Service>`	`deleteServiceOperationCallable()` Deletes a Service.
`com.google.api.gax.httpjson.longrunning.OperationsClient`	`getHttpJsonOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`com.google.iam.v1.Policy`	`getIamPolicy(com.google.iam.v1.GetIamPolicyRequest request)` Gets the IAM Access Control policy currently in effect for the given Cloud Run Service.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>`	`getIamPolicyCallable()` Gets the IAM Access Control policy currently in effect for the given Cloud Run Service.
`com.google.longrunning.OperationsClient`	`getOperationsClient()` Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
`Service`	`getService(GetServiceRequest request)` Gets information about a Service.
`Service`	`getService(ServiceName name)` Gets information about a Service.
`Service`	`getService(String name)` Gets information about a Service.
`com.google.api.gax.rpc.UnaryCallable<GetServiceRequest,Service>`	`getServiceCallable()` Gets information about a Service.
`ServicesSettings`	`getSettings()`
`ServicesStub`	`getStub()`
`boolean`	`isShutdown()`
`boolean`	`isTerminated()`
`ServicesClient.ListServicesPagedResponse`	`listServices(ListServicesRequest request)` Lists Services.
`ServicesClient.ListServicesPagedResponse`	`listServices(LocationName parent)` Lists Services.
`ServicesClient.ListServicesPagedResponse`	`listServices(String parent)` Lists Services.
`com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ListServicesResponse>`	`listServicesCallable()` Lists Services.
`com.google.api.gax.rpc.UnaryCallable<ListServicesRequest,ServicesClient.ListServicesPagedResponse>`	`listServicesPagedCallable()` Lists Services.
`com.google.iam.v1.Policy`	`setIamPolicy(com.google.iam.v1.SetIamPolicyRequest request)` Sets the IAM Access control policy for the specified Service.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>`	`setIamPolicyCallable()` Sets the IAM Access control policy for the specified Service.
`void`	`shutdown()`
`void`	`shutdownNow()`
`com.google.iam.v1.TestIamPermissionsResponse`	`testIamPermissions(com.google.iam.v1.TestIamPermissionsRequest request)` Returns permissions that a caller has on the specified Project.
`com.google.api.gax.rpc.UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>`	`testIamPermissionsCallable()` Returns permissions that a caller has on the specified Project.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`updateServiceAsync(Service service)` Updates a Service.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`updateServiceAsync(Service service, com.google.protobuf.FieldMask updateMask)` Updates a Service.
`com.google.api.gax.longrunning.OperationFuture<Service,Service>`	`updateServiceAsync(UpdateServiceRequest request)` Updates a Service.
`com.google.api.gax.rpc.UnaryCallable<UpdateServiceRequest,com.google.longrunning.Operation>`	`updateServiceCallable()` Updates a Service.
`com.google.api.gax.rpc.OperationCallable<UpdateServiceRequest,Service,Service>`	`updateServiceOperationCallable()` Updates a Service.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail
- ServicesClient
```
protected ServicesClient(ServicesSettings settings)
                  throws IOException
```
  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.
  
  Throws:
  
  IOException
- ServicesClient
```
protected ServicesClient(ServicesStub stub)
```

Method Detail

create

public static final ServicesClient create()
                                   throws IOException

Constructs an instance of ServicesClient with default settings.

Throws:: IOException

create
```
public static final ServicesClient create(ServicesSettings settings)
                                   throws IOException
```
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.

Throws:

IOException

create
```
public static final ServicesClient create(ServicesStub stub)
```
Constructs an instance of ServicesClient, using the given stub for making calls. This is for advanced usage - prefer using create(ServicesSettings).

getSettings

public final ServicesSettings getSettings()

getStub
```
public ServicesStub getStub()
```

getOperationsClient
```
public final com.google.longrunning.OperationsClient getOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

getHttpJsonOperationsClient
```
@BetaApi
public final com.google.api.gax.httpjson.longrunning.OperationsClient getHttpJsonOperationsClient()
```
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.