Class ServicesClient (2.3.2)

Version 2.3.2

• 2.49.0 (latest)
• 2.48.0
• 2.47.0
• 2.46.0
• 2.45.0
• 2.44.0
• 2.43.0
• 2.42.0
• 2.41.0
• 2.40.0
• 2.39.0
• 2.37.0
• 2.36.0
• 2.35.0
• 2.34.0
• 2.33.0
• 2.32.0
• 2.31.0
• 2.30.0
• 2.29.0
• 2.28.0
• 2.27.0
• 2.24.0
• 2.23.0
• 2.22.0
• 2.21.0
• 2.20.0
• 2.19.0
• 2.18.0
• 2.17.0
• 2.16.0
• 2.15.0
• 2.14.0
• 2.13.0
• 2.12.0
• 2.11.0
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.4
• 2.2.0
• 2.1.10
• 0.2.0

public class ServicesClient implements BackgroundResource

Service Description: Manages services of an application.

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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   GetServiceRequest request = GetServiceRequest.newBuilder().setName("name3373707").build();
   Service response = servicesClient.getService(request);
 }
 

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

The surface of this class includes several types of Java methods for each of the API's methods:

1. A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
2. A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
3. A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ServicesSettings to create(). For example:

To customize credentials:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 ServicesSettings servicesSettings =
     ServicesSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServicesClient servicesClient = ServicesClient.create(servicesSettings);
 

To customize the endpoint:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 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 for illustrative purposes only.
 // It may require modifications to work in your environment.
 ServicesSettings servicesSettings =
     ServicesSettings.newBuilder()
         .setTransportChannelProvider(
             ServicesSettings.defaultHttpJsonTransportProviderBuilder().build())
         .build();
 ServicesClient servicesClient = ServicesClient.create(servicesSettings);
 

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

Inheritance

java.lang.Object > ServicesClient

Implements

BackgroundResource

Inherited Members

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.toString()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

create()

public static final ServicesClient create()

Constructs an instance of ServicesClient with default settings.

Returns

Type	Description
ServicesClient

Exceptions

Type	Description
IOException

create(ServicesSettings settings)

public static final ServicesClient create(ServicesSettings settings)

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.

Parameter

Name	Description
settings	ServicesSettings

Returns

Type	Description
ServicesClient

Exceptions

Type	Description
IOException

create(ServicesStub stub)

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

Parameter

Name	Description
stub	ServicesStub

Returns

Type	Description
ServicesClient

Constructors

ServicesClient(ServicesSettings settings)

protected ServicesClient(ServicesSettings settings)

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.

Parameter

Name	Description
settings	ServicesSettings

ServicesClient(ServicesStub stub)

protected ServicesClient(ServicesStub stub)

Parameter

Name	Description
stub	ServicesStub

Methods

awaitTermination(long duration, TimeUnit unit)

public boolean awaitTermination(long duration, TimeUnit unit)

Parameters

Name	Description
duration	long
unit	TimeUnit

Returns

Type	Description
boolean

Exceptions

Type	Description
InterruptedException

close()

public final void close()

deleteServiceAsync(DeleteServiceRequest request)

public final OperationFuture<Empty,OperationMetadataV1> deleteServiceAsync(DeleteServiceRequest request)

Deletes the specified service and all enclosed versions.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   DeleteServiceRequest request =
       DeleteServiceRequest.newBuilder().setName("name3373707").build();
   servicesClient.deleteServiceAsync(request).get();
 }
 

Parameter

Name	Description
request	DeleteServiceRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Empty,OperationMetadataV1>

deleteServiceCallable()

public final UnaryCallable<DeleteServiceRequest,Operation> deleteServiceCallable()

Deletes the specified service and all enclosed versions.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   DeleteServiceRequest request =
       DeleteServiceRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Operation> future = servicesClient.deleteServiceCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
UnaryCallable<DeleteServiceRequest,Operation>

deleteServiceOperationCallable()

public final OperationCallable<DeleteServiceRequest,Empty,OperationMetadataV1> deleteServiceOperationCallable()

Deletes the specified service and all enclosed versions.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   DeleteServiceRequest request =
       DeleteServiceRequest.newBuilder().setName("name3373707").build();
   OperationFuture<Empty, OperationMetadataV1> future =
       servicesClient.deleteServiceOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }
 

Returns

Type	Description
OperationCallable<DeleteServiceRequest,Empty,OperationMetadataV1>

getHttpJsonOperationsClient()

public final OperationsClient getHttpJsonOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getOperationsClient()

public final OperationsClient getOperationsClient()

Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

Returns

Type	Description
OperationsClient

getService(GetServiceRequest request)

public final Service getService(GetServiceRequest request)

Gets the current configuration of the specified service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   GetServiceRequest request = GetServiceRequest.newBuilder().setName("name3373707").build();
   Service response = servicesClient.getService(request);
 }
 

Parameter

Name	Description
request	GetServiceRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
Service

getServiceCallable()

public final UnaryCallable<GetServiceRequest,Service> getServiceCallable()

Gets the current configuration of the specified service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   GetServiceRequest request = GetServiceRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Service> future = servicesClient.getServiceCallable().futureCall(request);
   // Do something.
   Service response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<GetServiceRequest,Service>

getSettings()

public final ServicesSettings getSettings()

Returns

Type	Description
ServicesSettings

getStub()

public ServicesStub getStub()

Returns

Type	Description
ServicesStub

isShutdown()

public boolean isShutdown()

Returns

Type	Description
boolean

isTerminated()

public boolean isTerminated()

Returns

Type	Description
boolean

listServices(ListServicesRequest request)

public final ServicesClient.ListServicesPagedResponse listServices(ListServicesRequest request)

Lists all the services in the application.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Service element : servicesClient.listServices(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Parameter

Name	Description
request	ListServicesRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
ServicesClient.ListServicesPagedResponse

listServicesCallable()

public final UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()

Lists all the services in the application.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .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;
     }
   }
 }
 

Returns

Type	Description
UnaryCallable<ListServicesRequest,ListServicesResponse>

listServicesPagedCallable()

public final UnaryCallable<ListServicesRequest,ServicesClient.ListServicesPagedResponse> listServicesPagedCallable()

Lists all the services in the application.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setParent("parent-995424086")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Service> future = servicesClient.listServicesPagedCallable().futureCall(request);
   // Do something.
   for (Service element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
 

Returns

Type	Description
UnaryCallable<ListServicesRequest,ListServicesPagedResponse>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

updateServiceAsync(UpdateServiceRequest request)

public final OperationFuture<Service,OperationMetadataV1> updateServiceAsync(UpdateServiceRequest request)

Updates the configuration of the specified service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   UpdateServiceRequest request =
       UpdateServiceRequest.newBuilder()
           .setName("name3373707")
           .setService(Service.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setMigrateTraffic(true)
           .build();
   Service response = servicesClient.updateServiceAsync(request).get();
 }
 

Parameter

Name	Description
request	UpdateServiceRequest The request object containing all of the parameters for the API call.

Returns

Type	Description
OperationFuture<Service,OperationMetadataV1>

updateServiceCallable()

public final UnaryCallable<UpdateServiceRequest,Operation> updateServiceCallable()

Updates the configuration of the specified service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   UpdateServiceRequest request =
       UpdateServiceRequest.newBuilder()
           .setName("name3373707")
           .setService(Service.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setMigrateTraffic(true)
           .build();
   ApiFuture<Operation> future = servicesClient.updateServiceCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }
 

Returns

Type	Description
UnaryCallable<UpdateServiceRequest,Operation>

updateServiceOperationCallable()

public final OperationCallable<UpdateServiceRequest,Service,OperationMetadataV1> updateServiceOperationCallable()

Updates the configuration of the specified service.

Sample code:

 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 try (ServicesClient servicesClient = ServicesClient.create()) {
   UpdateServiceRequest request =
       UpdateServiceRequest.newBuilder()
           .setName("name3373707")
           .setService(Service.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .setMigrateTraffic(true)
           .build();
   OperationFuture<Service, OperationMetadataV1> future =
       servicesClient.updateServiceOperationCallable().futureCall(request);
   // Do something.
   Service response = future.get();
 }
 

Returns

Type	Description
OperationCallable<UpdateServiceRequest,Service,OperationMetadataV1>