Class ServicesClient (0.7.0)

public class ServicesClient implements 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().

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

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

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

createServiceAsync(CreateServiceRequest request)

public final OperationFuture<Service,Service> createServiceAsync(CreateServiceRequest request)

Creates a new Service in a given project and location.

Sample 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();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Service,Service>

createServiceAsync(LocationName parent, Service service, String serviceId)

public final OperationFuture<Service,Service> createServiceAsync(LocationName parent, Service service, String serviceId)

Creates a new Service in a given project and location.

Sample 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();
 }

Parameters

Name	Description
parent	`LocationName` Required. The location and project in which this service should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.
service	`Service` Required. The Service instance to create.
serviceId	`String` Required. The unique identifier for the Service. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the service becomes {parent}/services/{service_id}.

Returns

Type	Description
OperationFuture<Service,Service>

createServiceAsync(String parent, Service service, String serviceId)

public final OperationFuture<Service,Service> createServiceAsync(String parent, Service service, String serviceId)

Creates a new Service in a given project and location.

Sample 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();
 }

Parameters

Name	Description
parent	`String` Required. The location and project in which this service should be created. Format: projects/{project}/locations/{location}, where {project} can be project id or number. Only lowercase characters, digits, and hyphens.
service	`Service` Required. The Service instance to create.
serviceId	`String` Required. The unique identifier for the Service. It must begin with letter, and cannot end with hyphen; must contain fewer than 50 characters. The name of the service becomes {parent}/services/{service_id}.

Returns

Type	Description
OperationFuture<Service,Service>

createServiceCallable()

public final UnaryCallable<CreateServiceRequest,Operation> createServiceCallable()

Creates a new Service in a given project and location.

Sample 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();
 }

Returns

Type	Description
UnaryCallable<CreateServiceRequest,Operation>

createServiceOperationCallable()

public final OperationCallable<CreateServiceRequest,Service,Service> createServiceOperationCallable()

Creates a new Service in a given project and location.

Sample 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();
 }

Returns

Type	Description
OperationCallable<CreateServiceRequest,Service,Service>

deleteServiceAsync(DeleteServiceRequest request)

public final OperationFuture<Service,Service> deleteServiceAsync(DeleteServiceRequest request)

Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

Sample 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();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Service,Service>

deleteServiceAsync(ServiceName name)

public final OperationFuture<Service,Service> deleteServiceAsync(ServiceName name)

Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

Sample 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();
 }

Parameter

Name	Description
name	`ServiceName` Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number.

Returns

Type	Description
OperationFuture<Service,Service>

deleteServiceAsync(String name)

public final OperationFuture<Service,Service> deleteServiceAsync(String name)

Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

Sample 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();
 }

Parameter

Name	Description
name	`String` Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number.

Returns

Type	Description
OperationFuture<Service,Service>

deleteServiceCallable()

public final UnaryCallable<DeleteServiceRequest,Operation> deleteServiceCallable()

Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

Sample 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();
 }

Returns

Type	Description
UnaryCallable<DeleteServiceRequest,Operation>

deleteServiceOperationCallable()

public final OperationCallable<DeleteServiceRequest,Service,Service> deleteServiceOperationCallable()

Deletes a Service. This will cause the Service to stop serving traffic and will delete all revisions.

Sample 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();
 }

Returns

Type	Description
OperationCallable<DeleteServiceRequest,Service,Service>

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

getIamPolicy(GetIamPolicyRequest request)

public final Policy getIamPolicy(GetIamPolicyRequest request)

Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.

Sample 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);
 }

Parameter

Name	Description
request	`com.google.iam.v1.GetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

getIamPolicyCallable()

public final UnaryCallable<GetIamPolicyRequest,Policy> getIamPolicyCallable()

Gets the IAM Access Control policy currently in effect for the given Cloud Run Service. This result does not include any inherited policies.

Sample 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();
 }

Returns

Type	Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

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 information about a Service.

Sample 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);
 }

Parameter

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

Returns

Type	Description
Service

getService(ServiceName name)

public final Service getService(ServiceName name)

Gets information about a Service.

Sample 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);
 }

Parameter

Name	Description
name	`ServiceName` Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number.

Returns

Type	Description
Service

getService(String name)

public final Service getService(String name)

Gets information about a Service.

Sample 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);
 }

Parameter

Name	Description
name	`String` Required. The full name of the Service. Format: projects/{project}/locations/{location}/services/{service}, where {project} can be project id or number.

Returns

Type	Description
Service

getServiceCallable()

public final UnaryCallable<GetServiceRequest,Service> getServiceCallable()

Gets information about a Service.

Sample 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();
 }

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

Sample 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);
   }
 }

Parameter

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

Returns

Type	Description
ServicesClient.ListServicesPagedResponse

listServices(LocationName parent)

public final ServicesClient.ListServicesPagedResponse listServices(LocationName parent)

Lists Services.

Sample 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);
   }
 }

Parameter

Name	Description
parent	`LocationName` Required. The location and project to list resources on. Location must be a valid GCP region, and cannot be the "-" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

Returns

Type	Description
ServicesClient.ListServicesPagedResponse

listServices(String parent)

public final ServicesClient.ListServicesPagedResponse listServices(String parent)

Lists Services.

Sample 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);
   }
 }

Parameter

Name	Description
parent	`String` Required. The location and project to list resources on. Location must be a valid GCP region, and cannot be the "-" wildcard. Format: projects/{project}/locations/{location}, where {project} can be project id or number.

Returns

Type	Description
ServicesClient.ListServicesPagedResponse

listServicesCallable()

public final UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()

Lists Services.

Sample 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;
     }
   }
 }

Returns

Type	Description
UnaryCallable<ListServicesRequest,ListServicesResponse>

listServicesPagedCallable()

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

Lists Services.

Sample 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);
   }
 }

Returns

Type	Description
UnaryCallable<ListServicesRequest,ListServicesPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

public final Policy setIamPolicy(SetIamPolicyRequest request)

Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.

Sample 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);
 }

Parameter

Name	Description
request	`com.google.iam.v1.SetIamPolicyRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.Policy

setIamPolicyCallable()

public final UnaryCallable<SetIamPolicyRequest,Policy> setIamPolicyCallable()

Sets the IAM Access control policy for the specified Service. Overwrites any existing policy.

Sample 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();
 }

Returns

Type	Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

public void shutdown()

shutdownNow()

public void shutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

public final TestIamPermissionsResponse testIamPermissions(TestIamPermissionsRequest request)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

Sample 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);
 }

Parameter

Name	Description
request	`com.google.iam.v1.TestIamPermissionsRequest` The request object containing all of the parameters for the API call.

Returns

Type	Description
com.google.iam.v1.TestIamPermissionsResponse

testIamPermissionsCallable()

public final UnaryCallable<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsCallable()

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

Sample 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();
 }

Returns

Type	Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateServiceAsync(Service service)

public final OperationFuture<Service,Service> updateServiceAsync(Service service)

Updates a Service.

Sample 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();
 }

Parameter

Name	Description
service	`Service` Required. The Service to be updated.

Returns

Type	Description
OperationFuture<Service,Service>

updateServiceAsync(UpdateServiceRequest request)

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

Updates a Service.

Sample 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();
 }

Parameter

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

Returns

Type	Description
OperationFuture<Service,Service>

updateServiceCallable()

public final UnaryCallable<UpdateServiceRequest,Operation> updateServiceCallable()

Updates a Service.

Sample 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();
 }

Returns

Type	Description
UnaryCallable<UpdateServiceRequest,Operation>

updateServiceOperationCallable()

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

Updates a Service.

Sample 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();
 }

Returns

Type	Description
OperationCallable<UpdateServiceRequest,Service,Service>