Class ServicesClient (0.68.0)

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(ServicesClientservicesClient=ServicesClient.create()){
ServiceNamename=ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]");
Serviceresponse=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
ServicesSettingsservicesSettings=
ServicesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
ServicesClientservicesClient=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
ServicesSettingsservicesSettings=
ServicesSettings.newBuilder().setEndpoint(myEndpoint).build();
ServicesClientservicesClient=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
ServicesSettingsservicesSettings=ServicesSettings.newHttpJsonBuilder().build();
ServicesClientservicesClient=ServicesClient.create(servicesSettings);

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

Inheritance

java.lang.Object > ServicesClient

Static Methods

create()

publicstaticfinalServicesClientcreate()

Constructs an instance of ServicesClient with default settings.

Returns
Type Description
ServicesClient
Exceptions
Type Description
IOException

create(ServicesSettings settings)

publicstaticfinalServicesClientcreate(ServicesSettingssettings)

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)

publicstaticfinalServicesClientcreate(ServicesStubstub)

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)

protectedServicesClient(ServicesSettingssettings)

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)

protectedServicesClient(ServicesStubstub)
Parameter
Name Description
stub ServicesStub

Methods

awaitTermination(long duration, TimeUnit unit)

publicbooleanawaitTermination(longduration,TimeUnitunit)
Parameters
Name Description
duration long
unit TimeUnit
Returns
Type Description
boolean
Exceptions
Type Description
InterruptedException

close()

publicfinalvoidclose()

createServiceAsync(CreateServiceRequest request)

publicfinalOperationFuture<Service,Service>createServiceAsync(CreateServiceRequestrequest)

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(ServicesClientservicesClient=ServicesClient.create()){
CreateServiceRequestrequest=
CreateServiceRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setService(Service.newBuilder().build())
.setServiceId("serviceId-194185552")
.setValidateOnly(true)
.build();
Serviceresponse=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)

publicfinalOperationFuture<Service,Service>createServiceAsync(LocationNameparent,Serviceservice,StringserviceId)

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(ServicesClientservicesClient=ServicesClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
Serviceservice=Service.newBuilder().build();
StringserviceId="serviceId-194185552";
Serviceresponse=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)

publicfinalOperationFuture<Service,Service>createServiceAsync(Stringparent,Serviceservice,StringserviceId)

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(ServicesClientservicesClient=ServicesClient.create()){
Stringparent=LocationName.of("[PROJECT]","[LOCATION]").toString();
Serviceservice=Service.newBuilder().build();
StringserviceId="serviceId-194185552";
Serviceresponse=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()

publicfinalUnaryCallable<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(ServicesClientservicesClient=ServicesClient.create()){
CreateServiceRequestrequest=
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.
Operationresponse=future.get();
}
Returns
Type Description
UnaryCallable<CreateServiceRequest,Operation>

createServiceOperationCallable()

publicfinalOperationCallable<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(ServicesClientservicesClient=ServicesClient.create()){
CreateServiceRequestrequest=
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.
Serviceresponse=future.get();
}
Returns
Type Description
OperationCallable<CreateServiceRequest,Service,Service>

deleteServiceAsync(DeleteServiceRequest request)

publicfinalOperationFuture<Service,Service>deleteServiceAsync(DeleteServiceRequestrequest)

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(ServicesClientservicesClient=ServicesClient.create()){
DeleteServiceRequestrequest=
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
Serviceresponse=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)

publicfinalOperationFuture<Service,Service>deleteServiceAsync(ServiceNamename)

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(ServicesClientservicesClient=ServicesClient.create()){
ServiceNamename=ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]");
Serviceresponse=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)

publicfinalOperationFuture<Service,Service>deleteServiceAsync(Stringname)

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(ServicesClientservicesClient=ServicesClient.create()){
Stringname=ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString();
Serviceresponse=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()

publicfinalUnaryCallable<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(ServicesClientservicesClient=ServicesClient.create()){
DeleteServiceRequestrequest=
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
ApiFuture<Operation>future=servicesClient.deleteServiceCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
Returns
Type Description
UnaryCallable<DeleteServiceRequest,Operation>

deleteServiceOperationCallable()

publicfinalOperationCallable<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(ServicesClientservicesClient=ServicesClient.create()){
DeleteServiceRequestrequest=
DeleteServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.setValidateOnly(true)
.setEtag("etag3123477")
.build();
OperationFuture<Service,Service>future=
servicesClient.deleteServiceOperationCallable().futureCall(request);
// Do something.
Serviceresponse=future.get();
}
Returns
Type Description
OperationCallable<DeleteServiceRequest,Service,Service>

getHttpJsonOperationsClient()

publicfinalOperationsClientgetHttpJsonOperationsClient()

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)

publicfinalPolicygetIamPolicy(GetIamPolicyRequestrequest)

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(ServicesClientservicesClient=ServicesClient.create()){
GetIamPolicyRequestrequest=
GetIamPolicyRequest.newBuilder()
.setResource(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
Policyresponse=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()

publicfinalUnaryCallable<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(ServicesClientservicesClient=ServicesClient.create()){
GetIamPolicyRequestrequest=
GetIamPolicyRequest.newBuilder()
.setResource(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.setOptions(GetPolicyOptions.newBuilder().build())
.build();
ApiFuture<Policy>future=servicesClient.getIamPolicyCallable().futureCall(request);
// Do something.
Policyresponse=future.get();
}
Returns
Type Description
UnaryCallable<com.google.iam.v1.GetIamPolicyRequest,com.google.iam.v1.Policy>

getOperationsClient()

publicfinalOperationsClientgetOperationsClient()

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)

publicfinalServicegetService(GetServiceRequestrequest)

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(ServicesClientservicesClient=ServicesClient.create()){
GetServiceRequestrequest=
GetServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.build();
Serviceresponse=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)

publicfinalServicegetService(ServiceNamename)

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(ServicesClientservicesClient=ServicesClient.create()){
ServiceNamename=ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]");
Serviceresponse=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)

publicfinalServicegetService(Stringname)

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(ServicesClientservicesClient=ServicesClient.create()){
Stringname=ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString();
Serviceresponse=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()

publicfinalUnaryCallable<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(ServicesClientservicesClient=ServicesClient.create()){
GetServiceRequestrequest=
GetServiceRequest.newBuilder()
.setName(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.build();
ApiFuture<Service>future=servicesClient.getServiceCallable().futureCall(request);
// Do something.
Serviceresponse=future.get();
}
Returns
Type Description
UnaryCallable<GetServiceRequest,Service>

getSettings()

publicfinalServicesSettingsgetSettings()
Returns
Type Description
ServicesSettings

getStub()

publicServicesStubgetStub()
Returns
Type Description
ServicesStub

isShutdown()

publicbooleanisShutdown()
Returns
Type Description
boolean

isTerminated()

publicbooleanisTerminated()
Returns
Type Description
boolean

listServices(ListServicesRequest request)

publicfinalServicesClient.ListServicesPagedResponselistServices(ListServicesRequestrequest)

Lists Services. Results are sorted by creation time, descending.

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(ServicesClientservicesClient=ServicesClient.create()){
ListServicesRequestrequest=
ListServicesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.build();
for(Serviceelement: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)

publicfinalServicesClient.ListServicesPagedResponselistServices(LocationNameparent)

Lists Services. Results are sorted by creation time, descending.

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(ServicesClientservicesClient=ServicesClient.create()){
LocationNameparent=LocationName.of("[PROJECT]","[LOCATION]");
for(Serviceelement: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 Google Cloud 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)

publicfinalServicesClient.ListServicesPagedResponselistServices(Stringparent)

Lists Services. Results are sorted by creation time, descending.

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(ServicesClientservicesClient=ServicesClient.create()){
Stringparent=LocationName.of("[PROJECT]","[LOCATION]").toString();
for(Serviceelement: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 Google Cloud 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()

publicfinalUnaryCallable<ListServicesRequest,ListServicesResponse>listServicesCallable()

Lists Services. Results are sorted by creation time, descending.

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(ServicesClientservicesClient=ServicesClient.create()){
ListServicesRequestrequest=
ListServicesRequest.newBuilder()
.setParent(LocationName.of("[PROJECT]","[LOCATION]").toString())
.setPageSize(883849137)
.setPageToken("pageToken873572522")
.setShowDeleted(true)
.build();
while(true){
ListServicesResponseresponse=servicesClient.listServicesCallable().call(request);
for(Serviceelement:response.getServicesList()){
// doThingsWith(element);
}
StringnextPageToken=response.getNextPageToken();
if(!Strings.isNullOrEmpty(nextPageToken)){
request=request.toBuilder().setPageToken(nextPageToken).build();
}else{
break;
}
}
}
Returns
Type Description
UnaryCallable<ListServicesRequest,ListServicesResponse>

listServicesPagedCallable()

publicfinalUnaryCallable<ListServicesRequest,ServicesClient.ListServicesPagedResponse>listServicesPagedCallable()

Lists Services. Results are sorted by creation time, descending.

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(ServicesClientservicesClient=ServicesClient.create()){
ListServicesRequestrequest=
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(Serviceelement:future.get().iterateAll()){
// doThingsWith(element);
}
}
Returns
Type Description
UnaryCallable<ListServicesRequest,ListServicesPagedResponse>

setIamPolicy(SetIamPolicyRequest request)

publicfinalPolicysetIamPolicy(SetIamPolicyRequestrequest)

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(ServicesClientservicesClient=ServicesClient.create()){
SetIamPolicyRequestrequest=
SetIamPolicyRequest.newBuilder()
.setResource(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.setPolicy(Policy.newBuilder().build())
.setUpdateMask(FieldMask.newBuilder().build())
.build();
Policyresponse=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()

publicfinalUnaryCallable<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(ServicesClientservicesClient=ServicesClient.create()){
SetIamPolicyRequestrequest=
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.
Policyresponse=future.get();
}
Returns
Type Description
UnaryCallable<com.google.iam.v1.SetIamPolicyRequest,com.google.iam.v1.Policy>

shutdown()

publicvoidshutdown()

shutdownNow()

publicvoidshutdownNow()

testIamPermissions(TestIamPermissionsRequest request)

publicfinalTestIamPermissionsResponsetestIamPermissions(TestIamPermissionsRequestrequest)

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(ServicesClientservicesClient=ServicesClient.create()){
TestIamPermissionsRequestrequest=
TestIamPermissionsRequest.newBuilder()
.setResource(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.addAllPermissions(newArrayList<String>())
.build();
TestIamPermissionsResponseresponse=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()

publicfinalUnaryCallable<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(ServicesClientservicesClient=ServicesClient.create()){
TestIamPermissionsRequestrequest=
TestIamPermissionsRequest.newBuilder()
.setResource(ServiceName.of("[PROJECT]","[LOCATION]","[SERVICE]").toString())
.addAllPermissions(newArrayList<String>())
.build();
ApiFuture<TestIamPermissionsResponse>future=
servicesClient.testIamPermissionsCallable().futureCall(request);
// Do something.
TestIamPermissionsResponseresponse=future.get();
}
Returns
Type Description
UnaryCallable<com.google.iam.v1.TestIamPermissionsRequest,com.google.iam.v1.TestIamPermissionsResponse>

updateServiceAsync(Service service)

publicfinalOperationFuture<Service,Service>updateServiceAsync(Serviceservice)

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(ServicesClientservicesClient=ServicesClient.create()){
Serviceservice=Service.newBuilder().build();
Serviceresponse=servicesClient.updateServiceAsync(service).get();
}
Parameter
Name Description
service Service

Required. The Service to be updated.

Returns
Type Description
OperationFuture<Service,Service>

updateServiceAsync(Service service, FieldMask updateMask)

publicfinalOperationFuture<Service,Service>updateServiceAsync(Serviceservice,FieldMaskupdateMask)

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(ServicesClientservicesClient=ServicesClient.create()){
Serviceservice=Service.newBuilder().build();
FieldMaskupdateMask=FieldMask.newBuilder().build();
Serviceresponse=servicesClient.updateServiceAsync(service,updateMask).get();
}
Parameters
Name Description
service Service

Required. The Service to be updated.

updateMask FieldMask

Optional. The list of fields to be updated.

Returns
Type Description
OperationFuture<Service,Service>

updateServiceAsync(UpdateServiceRequest request)

publicfinalOperationFuture<Service,Service>updateServiceAsync(UpdateServiceRequestrequest)

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(ServicesClientservicesClient=ServicesClient.create()){
UpdateServiceRequestrequest=
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setValidateOnly(true)
.setAllowMissing(true)
.build();
Serviceresponse=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()

publicfinalUnaryCallable<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(ServicesClientservicesClient=ServicesClient.create()){
UpdateServiceRequestrequest=
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setValidateOnly(true)
.setAllowMissing(true)
.build();
ApiFuture<Operation>future=servicesClient.updateServiceCallable().futureCall(request);
// Do something.
Operationresponse=future.get();
}
Returns
Type Description
UnaryCallable<UpdateServiceRequest,Operation>

updateServiceOperationCallable()

publicfinalOperationCallable<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(ServicesClientservicesClient=ServicesClient.create()){
UpdateServiceRequestrequest=
UpdateServiceRequest.newBuilder()
.setUpdateMask(FieldMask.newBuilder().build())
.setService(Service.newBuilder().build())
.setValidateOnly(true)
.setAllowMissing(true)
.build();
OperationFuture<Service,Service>future=
servicesClient.updateServiceOperationCallable().futureCall(request);
// Do something.
Serviceresponse=future.get();
}
Returns
Type Description
OperationCallable<UpdateServiceRequest,Service,Service>

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年10月30日 UTC.