Class ServiceMonitoringServiceClient (3.45.0)

GitHub RepositoryProduct Reference

Service Description: The Cloud Monitoring Service-Oriented Monitoring API has endpoints for managing and querying aspects of a Metrics Scope's services. These include the Service's monitored resources, its Service-Level Objectives, and a taxonomy of categorized Health Metrics.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ResourceName parent = ResourceName.of("[FOLDER]");
   Service service = Service.newBuilder().build();
   Service response = serviceMonitoringServiceClient.createService(parent, service);
 }

Note: close() needs to be called on the ServiceMonitoringServiceClient 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

Create a Service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createService(CreateServiceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createService(ResourceName parent, Service service)

  • createService(OrganizationName parent, Service service)

  • createService(ProjectName parent, Service service)

  • createService(String parent, Service service)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createServiceCallable()

GetService

Get the named 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

List Services for this Metrics Scope.

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

  • listServices(OrganizationName parent)

  • listServices(ProjectName 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

Update this Service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateService(UpdateServiceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateService(Service service)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateServiceCallable()

DeleteService

Soft delete this Service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteService(DeleteServiceRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteService(ServiceName name)

  • deleteService(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.

  • deleteServiceCallable()

CreateServiceLevelObjective

Create a ServiceLevelObjective for the given Service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createServiceLevelObjective(CreateServiceLevelObjectiveRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createServiceLevelObjective(ServiceName parent, ServiceLevelObjective serviceLevelObjective)

  • createServiceLevelObjective(String parent, ServiceLevelObjective serviceLevelObjective)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createServiceLevelObjectiveCallable()

GetServiceLevelObjective

Get a ServiceLevelObjective by name.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getServiceLevelObjective(GetServiceLevelObjectiveRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getServiceLevelObjective(ServiceLevelObjectiveName name)

  • getServiceLevelObjective(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.

  • getServiceLevelObjectiveCallable()

ListServiceLevelObjectives

List the ServiceLevelObjectives for the given Service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listServiceLevelObjectives(ListServiceLevelObjectivesRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listServiceLevelObjectives(ServiceName parent)

  • listServiceLevelObjectives(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.

  • listServiceLevelObjectivesPagedCallable()

  • listServiceLevelObjectivesCallable()

UpdateServiceLevelObjective

Update the given ServiceLevelObjective.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateServiceLevelObjective(UpdateServiceLevelObjectiveRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateServiceLevelObjective(ServiceLevelObjective serviceLevelObjective)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateServiceLevelObjectiveCallable()

DeleteServiceLevelObjective

Delete the given ServiceLevelObjective.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteServiceLevelObjective(ServiceLevelObjectiveName name)

  • deleteServiceLevelObjective(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.

  • deleteServiceLevelObjectiveCallable()

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 ServiceMonitoringServiceSettings 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
 ServiceMonitoringServiceSettings serviceMonitoringServiceSettings =
     ServiceMonitoringServiceSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create(serviceMonitoringServiceSettings);

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
 ServiceMonitoringServiceSettings serviceMonitoringServiceSettings =
     ServiceMonitoringServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
 ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create(serviceMonitoringServiceSettings);

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

Inheritance

java.lang.Object > ServiceMonitoringServiceClient

Static Methods

create()

public static final ServiceMonitoringServiceClient create()

Constructs an instance of ServiceMonitoringServiceClient with default settings.

Returns
Type Description
ServiceMonitoringServiceClient
Exceptions
Type Description
IOException

create(ServiceMonitoringServiceSettings settings)

public static final ServiceMonitoringServiceClient create(ServiceMonitoringServiceSettings settings)

Constructs an instance of ServiceMonitoringServiceClient, 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 ServiceMonitoringServiceSettings
Returns
Type Description
ServiceMonitoringServiceClient
Exceptions
Type Description
IOException

create(ServiceMonitoringServiceStub stub)

public static final ServiceMonitoringServiceClient create(ServiceMonitoringServiceStub stub)

Constructs an instance of ServiceMonitoringServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(ServiceMonitoringServiceSettings).

Parameter
Name Description
stub ServiceMonitoringServiceStub
Returns
Type Description
ServiceMonitoringServiceClient

Constructors

ServiceMonitoringServiceClient(ServiceMonitoringServiceSettings settings)

protected ServiceMonitoringServiceClient(ServiceMonitoringServiceSettings settings)

Constructs an instance of ServiceMonitoringServiceClient, 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 ServiceMonitoringServiceSettings

ServiceMonitoringServiceClient(ServiceMonitoringServiceStub stub)

protected ServiceMonitoringServiceClient(ServiceMonitoringServiceStub stub)
Parameter
Name Description
stub ServiceMonitoringServiceStub

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

createService(ResourceName parent, Service service)

public final Service createService(ResourceName parent, Service service)

Create 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ResourceName parent = ResourceName.of("[FOLDER]");
   Service service = Service.newBuilder().build();
   Service response = serviceMonitoringServiceClient.createService(parent, service);
 }
Parameters
Name Description
parent com.google.api.resourcenames.ResourceName

Required. Resource name of the parent Metrics Scope. The format is:

projects/[PROJECT_ID_OR_NUMBER]
service Service

Required. The Service to create.
Returns
Type Description
Service

createService(CreateServiceRequest request)

public final Service createService(CreateServiceRequest request)

Create 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   CreateServiceRequest request =
       CreateServiceRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setServiceId("serviceId-194185552")
           .setService(Service.newBuilder().build())
           .build();
   Service response = serviceMonitoringServiceClient.createService(request);
 }
Parameter
Name Description
request CreateServiceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Service

createService(OrganizationName parent, Service service)

public final Service createService(OrganizationName parent, Service service)

Create 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   Service service = Service.newBuilder().build();
   Service response = serviceMonitoringServiceClient.createService(parent, service);
 }
Parameters
Name Description
parent OrganizationName

Required. Resource name of the parent Metrics Scope. The format is:

projects/[PROJECT_ID_OR_NUMBER]
service Service

Required. The Service to create.
Returns
Type Description
Service

createService(ProjectName parent, Service service)

public final Service createService(ProjectName parent, Service service)

Create 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   Service service = Service.newBuilder().build();
   Service response = serviceMonitoringServiceClient.createService(parent, service);
 }
Parameters
Name Description
parent ProjectName

Required. Resource name of the parent Metrics Scope. The format is:

projects/[PROJECT_ID_OR_NUMBER]
service Service

Required. The Service to create.
Returns
Type Description
Service

createService(String parent, Service service)

public final Service createService(String parent, Service service)

Create 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   Service service = Service.newBuilder().build();
   Service response = serviceMonitoringServiceClient.createService(parent, service);
 }
Parameters
Name Description
parent String

Required. Resource name of the parent Metrics Scope. The format is:

projects/[PROJECT_ID_OR_NUMBER]
service Service

Required. The Service to create.
Returns
Type Description
Service

createServiceCallable()

public final UnaryCallable<CreateServiceRequest,Service> createServiceCallable()

Create 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   CreateServiceRequest request =
       CreateServiceRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setServiceId("serviceId-194185552")
           .setService(Service.newBuilder().build())
           .build();
   ApiFuture<Service> future =
       serviceMonitoringServiceClient.createServiceCallable().futureCall(request);
   // Do something.
   Service response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateServiceRequest,Service>

createServiceLevelObjective(CreateServiceLevelObjectiveRequest request)

public final ServiceLevelObjective createServiceLevelObjective(CreateServiceLevelObjectiveRequest request)

Create a ServiceLevelObjective for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   CreateServiceLevelObjectiveRequest request =
       CreateServiceLevelObjectiveRequest.newBuilder()
           .setParent(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .setServiceLevelObjectiveId("serviceLevelObjectiveId-240792859")
           .setServiceLevelObjective(ServiceLevelObjective.newBuilder().build())
           .build();
   ServiceLevelObjective response =
       serviceMonitoringServiceClient.createServiceLevelObjective(request);
 }
Parameter
Name Description
request CreateServiceLevelObjectiveRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ServiceLevelObjective

createServiceLevelObjective(ServiceName parent, ServiceLevelObjective serviceLevelObjective)

public final ServiceLevelObjective createServiceLevelObjective(ServiceName parent, ServiceLevelObjective serviceLevelObjective)

Create a ServiceLevelObjective for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ServiceName parent = ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]");
   ServiceLevelObjective serviceLevelObjective = ServiceLevelObjective.newBuilder().build();
   ServiceLevelObjective response =
       serviceMonitoringServiceClient.createServiceLevelObjective(parent, serviceLevelObjective);
 }
Parameters
Name Description
parent ServiceName

Required. Resource name of the parent Service. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
serviceLevelObjective ServiceLevelObjective

Required. The ServiceLevelObjective to create. The provided name will be respected if no ServiceLevelObjective exists with this name.
Returns
Type Description
ServiceLevelObjective

createServiceLevelObjective(String parent, ServiceLevelObjective serviceLevelObjective)

public final ServiceLevelObjective createServiceLevelObjective(String parent, ServiceLevelObjective serviceLevelObjective)

Create a ServiceLevelObjective for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   String parent = ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString();
   ServiceLevelObjective serviceLevelObjective = ServiceLevelObjective.newBuilder().build();
   ServiceLevelObjective response =
       serviceMonitoringServiceClient.createServiceLevelObjective(parent, serviceLevelObjective);
 }
Parameters
Name Description
parent String

Required. Resource name of the parent Service. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
serviceLevelObjective ServiceLevelObjective

Required. The ServiceLevelObjective to create. The provided name will be respected if no ServiceLevelObjective exists with this name.
Returns
Type Description
ServiceLevelObjective

createServiceLevelObjectiveCallable()

public final UnaryCallable<CreateServiceLevelObjectiveRequest,ServiceLevelObjective> createServiceLevelObjectiveCallable()

Create a ServiceLevelObjective for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   CreateServiceLevelObjectiveRequest request =
       CreateServiceLevelObjectiveRequest.newBuilder()
           .setParent(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .setServiceLevelObjectiveId("serviceLevelObjectiveId-240792859")
           .setServiceLevelObjective(ServiceLevelObjective.newBuilder().build())
           .build();
   ApiFuture<ServiceLevelObjective> future =
       serviceMonitoringServiceClient.createServiceLevelObjectiveCallable().futureCall(request);
   // Do something.
   ServiceLevelObjective response = future.get();
 }
Returns
Type Description
UnaryCallable<CreateServiceLevelObjectiveRequest,ServiceLevelObjective>

deleteService(DeleteServiceRequest request)

public final void deleteService(DeleteServiceRequest request)

Soft delete this 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   DeleteServiceRequest request =
       DeleteServiceRequest.newBuilder()
           .setName(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .build();
   serviceMonitoringServiceClient.deleteService(request);
 }
Parameter
Name Description
request DeleteServiceRequest

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

deleteService(ServiceName name)

public final void deleteService(ServiceName name)

Soft delete this 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ServiceName name = ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]");
   serviceMonitoringServiceClient.deleteService(name);
 }
Parameter
Name Description
name ServiceName

Required. Resource name of the Service to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

deleteService(String name)

public final void deleteService(String name)

Soft delete this 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   String name = ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString();
   serviceMonitoringServiceClient.deleteService(name);
 }
Parameter
Name Description
name String

Required. Resource name of the Service to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]

deleteServiceCallable()

public final UnaryCallable<DeleteServiceRequest,Empty> deleteServiceCallable()

Soft delete this 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   DeleteServiceRequest request =
       DeleteServiceRequest.newBuilder()
           .setName(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .build();
   ApiFuture<Empty> future =
       serviceMonitoringServiceClient.deleteServiceCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteServiceRequest,Empty>

deleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest request)

public final void deleteServiceLevelObjective(DeleteServiceLevelObjectiveRequest request)

Delete the given ServiceLevelObjective.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   DeleteServiceLevelObjectiveRequest request =
       DeleteServiceLevelObjectiveRequest.newBuilder()
           .setName(
               ServiceLevelObjectiveName.ofProjectServiceServiceLevelObjectiveName(
                       "[PROJECT]", "[SERVICE]", "[SERVICE_LEVEL_OBJECTIVE]")
                   .toString())
           .build();
   serviceMonitoringServiceClient.deleteServiceLevelObjective(request);
 }
Parameter
Name Description
request DeleteServiceLevelObjectiveRequest

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

deleteServiceLevelObjective(ServiceLevelObjectiveName name)

public final void deleteServiceLevelObjective(ServiceLevelObjectiveName name)

Delete the given ServiceLevelObjective.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ServiceLevelObjectiveName name =
       ServiceLevelObjectiveName.ofProjectServiceServiceLevelObjectiveName(
           "[PROJECT]", "[SERVICE]", "[SERVICE_LEVEL_OBJECTIVE]");
   serviceMonitoringServiceClient.deleteServiceLevelObjective(name);
 }
Parameter
Name Description
name ServiceLevelObjectiveName

Required. Resource name of the ServiceLevelObjective to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

deleteServiceLevelObjective(String name)

public final void deleteServiceLevelObjective(String name)

Delete the given ServiceLevelObjective.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   String name =
       ServiceLevelObjectiveName.ofProjectServiceServiceLevelObjectiveName(
               "[PROJECT]", "[SERVICE]", "[SERVICE_LEVEL_OBJECTIVE]")
           .toString();
   serviceMonitoringServiceClient.deleteServiceLevelObjective(name);
 }
Parameter
Name Description
name String

Required. Resource name of the ServiceLevelObjective to delete. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]

deleteServiceLevelObjectiveCallable()

public final UnaryCallable<DeleteServiceLevelObjectiveRequest,Empty> deleteServiceLevelObjectiveCallable()

Delete the given ServiceLevelObjective.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   DeleteServiceLevelObjectiveRequest request =
       DeleteServiceLevelObjectiveRequest.newBuilder()
           .setName(
               ServiceLevelObjectiveName.ofProjectServiceServiceLevelObjectiveName(
                       "[PROJECT]", "[SERVICE]", "[SERVICE_LEVEL_OBJECTIVE]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       serviceMonitoringServiceClient.deleteServiceLevelObjectiveCallable().futureCall(request);
   // Do something.
   future.get();
 }
Returns
Type Description
UnaryCallable<DeleteServiceLevelObjectiveRequest,Empty>

getService(GetServiceRequest request)

public final Service getService(GetServiceRequest request)

Get the named 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   GetServiceRequest request =
       GetServiceRequest.newBuilder()
           .setName(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .build();
   Service response = serviceMonitoringServiceClient.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)

Get the named 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ServiceName name = ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]");
   Service response = serviceMonitoringServiceClient.getService(name);
 }
Parameter
Name Description
name ServiceName

Required. Resource name of the Service. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
Returns
Type Description
Service

getService(String name)

public final Service getService(String name)

Get the named 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   String name = ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString();
   Service response = serviceMonitoringServiceClient.getService(name);
 }
Parameter
Name Description
name String

Required. Resource name of the Service. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]
Returns
Type Description
Service

getServiceCallable()

public final UnaryCallable<GetServiceRequest,Service> getServiceCallable()

Get the named 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   GetServiceRequest request =
       GetServiceRequest.newBuilder()
           .setName(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .build();
   ApiFuture<Service> future =
       serviceMonitoringServiceClient.getServiceCallable().futureCall(request);
   // Do something.
   Service response = future.get();
 }
Returns
Type Description
UnaryCallable<GetServiceRequest,Service>

getServiceLevelObjective(GetServiceLevelObjectiveRequest request)

public final ServiceLevelObjective getServiceLevelObjective(GetServiceLevelObjectiveRequest request)

Get a ServiceLevelObjective by name.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   GetServiceLevelObjectiveRequest request =
       GetServiceLevelObjectiveRequest.newBuilder()
           .setName(
               ServiceLevelObjectiveName.ofProjectServiceServiceLevelObjectiveName(
                       "[PROJECT]", "[SERVICE]", "[SERVICE_LEVEL_OBJECTIVE]")
                   .toString())
           .build();
   ServiceLevelObjective response =
       serviceMonitoringServiceClient.getServiceLevelObjective(request);
 }
Parameter
Name Description
request GetServiceLevelObjectiveRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ServiceLevelObjective

getServiceLevelObjective(ServiceLevelObjectiveName name)

public final ServiceLevelObjective getServiceLevelObjective(ServiceLevelObjectiveName name)

Get a ServiceLevelObjective by name.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ServiceLevelObjectiveName name =
       ServiceLevelObjectiveName.ofProjectServiceServiceLevelObjectiveName(
           "[PROJECT]", "[SERVICE]", "[SERVICE_LEVEL_OBJECTIVE]");
   ServiceLevelObjective response =
       serviceMonitoringServiceClient.getServiceLevelObjective(name);
 }
Parameter
Name Description
name ServiceLevelObjectiveName

Required. Resource name of the ServiceLevelObjective to get. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
Returns
Type Description
ServiceLevelObjective

getServiceLevelObjective(String name)

public final ServiceLevelObjective getServiceLevelObjective(String name)

Get a ServiceLevelObjective by name.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   String name =
       ServiceLevelObjectiveName.ofProjectServiceServiceLevelObjectiveName(
               "[PROJECT]", "[SERVICE]", "[SERVICE_LEVEL_OBJECTIVE]")
           .toString();
   ServiceLevelObjective response =
       serviceMonitoringServiceClient.getServiceLevelObjective(name);
 }
Parameter
Name Description
name String

Required. Resource name of the ServiceLevelObjective to get. The format is:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID]/serviceLevelObjectives/[SLO_NAME]
Returns
Type Description
ServiceLevelObjective

getServiceLevelObjectiveCallable()

public final UnaryCallable<GetServiceLevelObjectiveRequest,ServiceLevelObjective> getServiceLevelObjectiveCallable()

Get a ServiceLevelObjective by name.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   GetServiceLevelObjectiveRequest request =
       GetServiceLevelObjectiveRequest.newBuilder()
           .setName(
               ServiceLevelObjectiveName.ofProjectServiceServiceLevelObjectiveName(
                       "[PROJECT]", "[SERVICE]", "[SERVICE_LEVEL_OBJECTIVE]")
                   .toString())
           .build();
   ApiFuture<ServiceLevelObjective> future =
       serviceMonitoringServiceClient.getServiceLevelObjectiveCallable().futureCall(request);
   // Do something.
   ServiceLevelObjective response = future.get();
 }
Returns
Type Description
UnaryCallable<GetServiceLevelObjectiveRequest,ServiceLevelObjective>

getSettings()

public final ServiceMonitoringServiceSettings getSettings()
Returns
Type Description
ServiceMonitoringServiceSettings

getStub()

public ServiceMonitoringServiceStub getStub()
Returns
Type Description
ServiceMonitoringServiceStub

isShutdown()

public boolean isShutdown()
Returns
Type Description
boolean

isTerminated()

public boolean isTerminated()
Returns
Type Description
boolean

listServiceLevelObjectives(ListServiceLevelObjectivesRequest request)

public final ServiceMonitoringServiceClient.ListServiceLevelObjectivesPagedResponse listServiceLevelObjectives(ListServiceLevelObjectivesRequest request)

List the ServiceLevelObjectives for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ListServiceLevelObjectivesRequest request =
       ListServiceLevelObjectivesRequest.newBuilder()
           .setParent(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ServiceLevelObjective element :
       serviceMonitoringServiceClient.listServiceLevelObjectives(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
request ListServiceLevelObjectivesRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ServiceMonitoringServiceClient.ListServiceLevelObjectivesPagedResponse

listServiceLevelObjectives(ServiceName parent)

public final ServiceMonitoringServiceClient.ListServiceLevelObjectivesPagedResponse listServiceLevelObjectives(ServiceName parent)

List the ServiceLevelObjectives for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ServiceName parent = ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]");
   for (ServiceLevelObjective element :
       serviceMonitoringServiceClient.listServiceLevelObjectives(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ServiceName

Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Metrics Scope. The formats are:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
Returns
Type Description
ServiceMonitoringServiceClient.ListServiceLevelObjectivesPagedResponse

listServiceLevelObjectives(String parent)

public final ServiceMonitoringServiceClient.ListServiceLevelObjectivesPagedResponse listServiceLevelObjectives(String parent)

List the ServiceLevelObjectives for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   String parent = ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString();
   for (ServiceLevelObjective element :
       serviceMonitoringServiceClient.listServiceLevelObjectives(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Resource name of the parent containing the listed SLOs, either a project or a Monitoring Metrics Scope. The formats are:

projects/[PROJECT_ID_OR_NUMBER]/services/[SERVICE_ID] workspaces/[HOST_PROJECT_ID_OR_NUMBER]/services/-
Returns
Type Description
ServiceMonitoringServiceClient.ListServiceLevelObjectivesPagedResponse

listServiceLevelObjectivesCallable()

public final UnaryCallable<ListServiceLevelObjectivesRequest,ListServiceLevelObjectivesResponse> listServiceLevelObjectivesCallable()

List the ServiceLevelObjectives for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ListServiceLevelObjectivesRequest request =
       ListServiceLevelObjectivesRequest.newBuilder()
           .setParent(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListServiceLevelObjectivesResponse response =
         serviceMonitoringServiceClient.listServiceLevelObjectivesCallable().call(request);
     for (ServiceLevelObjective element : response.getServiceLevelObjectivesList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }
Returns
Type Description
UnaryCallable<ListServiceLevelObjectivesRequest,ListServiceLevelObjectivesResponse>

listServiceLevelObjectivesPagedCallable()

public final UnaryCallable<ListServiceLevelObjectivesRequest,ServiceMonitoringServiceClient.ListServiceLevelObjectivesPagedResponse> listServiceLevelObjectivesPagedCallable()

List the ServiceLevelObjectives for the given 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ListServiceLevelObjectivesRequest request =
       ListServiceLevelObjectivesRequest.newBuilder()
           .setParent(ServiceName.ofProjectServiceName("[PROJECT]", "[SERVICE]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ServiceLevelObjective> future =
       serviceMonitoringServiceClient
           .listServiceLevelObjectivesPagedCallable()
           .futureCall(request);
   // Do something.
   for (ServiceLevelObjective element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }
Returns
Type Description
UnaryCallable<ListServiceLevelObjectivesRequest,ListServiceLevelObjectivesPagedResponse>

listServices(ResourceName parent)

public final ServiceMonitoringServiceClient.ListServicesPagedResponse listServices(ResourceName parent)

List Services for this Metrics Scope.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ResourceName parent = ResourceName.of("[FOLDER]");
   for (Service element : serviceMonitoringServiceClient.listServices(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent com.google.api.resourcenames.ResourceName

Required. Resource name of the parent containing the listed services, either a project or a Monitoring Metrics Scope. The formats are:

projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Returns
Type Description
ServiceMonitoringServiceClient.ListServicesPagedResponse

listServices(ListServicesRequest request)

public final ServiceMonitoringServiceClient.ListServicesPagedResponse listServices(ListServicesRequest request)

List Services for this Metrics Scope.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Service element : serviceMonitoringServiceClient.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
ServiceMonitoringServiceClient.ListServicesPagedResponse

listServices(OrganizationName parent)

public final ServiceMonitoringServiceClient.ListServicesPagedResponse listServices(OrganizationName parent)

List Services for this Metrics Scope.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   OrganizationName parent = OrganizationName.of("[ORGANIZATION]");
   for (Service element : serviceMonitoringServiceClient.listServices(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent OrganizationName

Required. Resource name of the parent containing the listed services, either a project or a Monitoring Metrics Scope. The formats are:

projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Returns
Type Description
ServiceMonitoringServiceClient.ListServicesPagedResponse

listServices(ProjectName parent)

public final ServiceMonitoringServiceClient.ListServicesPagedResponse listServices(ProjectName parent)

List Services for this Metrics Scope.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ProjectName parent = ProjectName.of("[PROJECT]");
   for (Service element : serviceMonitoringServiceClient.listServices(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent ProjectName

Required. Resource name of the parent containing the listed services, either a project or a Monitoring Metrics Scope. The formats are:

projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Returns
Type Description
ServiceMonitoringServiceClient.ListServicesPagedResponse

listServices(String parent)

public final ServiceMonitoringServiceClient.ListServicesPagedResponse listServices(String parent)

List Services for this Metrics Scope.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   String parent = ProjectName.of("[PROJECT]").toString();
   for (Service element : serviceMonitoringServiceClient.listServices(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
Parameter
Name Description
parent String

Required. Resource name of the parent containing the listed services, either a project or a Monitoring Metrics Scope. The formats are:

projects/[PROJECT_ID_OR_NUMBER] workspaces/[HOST_PROJECT_ID_OR_NUMBER]
Returns
Type Description
ServiceMonitoringServiceClient.ListServicesPagedResponse

listServicesCallable()

public final UnaryCallable<ListServicesRequest,ListServicesResponse> listServicesCallable()

List Services for this Metrics Scope.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListServicesResponse response =
         serviceMonitoringServiceClient.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,ServiceMonitoringServiceClient.ListServicesPagedResponse> listServicesPagedCallable()

List Services for this Metrics Scope.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ListServicesRequest request =
       ListServicesRequest.newBuilder()
           .setParent(ProjectName.of("[PROJECT]").toString())
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Service> future =
       serviceMonitoringServiceClient.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()

updateService(Service service)

public final Service updateService(Service service)

Update this 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   Service service = Service.newBuilder().build();
   Service response = serviceMonitoringServiceClient.updateService(service);
 }
Parameter
Name Description
service Service

Required. The Service to draw updates from. The given name specifies the resource to update.
Returns
Type Description
Service

updateService(UpdateServiceRequest request)

public final Service updateService(UpdateServiceRequest request)

Update this 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   UpdateServiceRequest request =
       UpdateServiceRequest.newBuilder()
           .setService(Service.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Service response = serviceMonitoringServiceClient.updateService(request);
 }
Parameter
Name Description
request UpdateServiceRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
Service

updateServiceCallable()

public final UnaryCallable<UpdateServiceRequest,Service> updateServiceCallable()

Update this 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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   UpdateServiceRequest request =
       UpdateServiceRequest.newBuilder()
           .setService(Service.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Service> future =
       serviceMonitoringServiceClient.updateServiceCallable().futureCall(request);
   // Do something.
   Service response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateServiceRequest,Service>

updateServiceLevelObjective(ServiceLevelObjective serviceLevelObjective)

public final ServiceLevelObjective updateServiceLevelObjective(ServiceLevelObjective serviceLevelObjective)

Update the given ServiceLevelObjective.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   ServiceLevelObjective serviceLevelObjective = ServiceLevelObjective.newBuilder().build();
   ServiceLevelObjective response =
       serviceMonitoringServiceClient.updateServiceLevelObjective(serviceLevelObjective);
 }
Parameter
Name Description
serviceLevelObjective ServiceLevelObjective

Required. The ServiceLevelObjective to draw updates from. The given name specifies the resource to update.
Returns
Type Description
ServiceLevelObjective

updateServiceLevelObjective(UpdateServiceLevelObjectiveRequest request)

public final ServiceLevelObjective updateServiceLevelObjective(UpdateServiceLevelObjectiveRequest request)

Update the given ServiceLevelObjective.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   UpdateServiceLevelObjectiveRequest request =
       UpdateServiceLevelObjectiveRequest.newBuilder()
           .setServiceLevelObjective(ServiceLevelObjective.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ServiceLevelObjective response =
       serviceMonitoringServiceClient.updateServiceLevelObjective(request);
 }
Parameter
Name Description
request UpdateServiceLevelObjectiveRequest

The request object containing all of the parameters for the API call.
Returns
Type Description
ServiceLevelObjective

updateServiceLevelObjectiveCallable()

public final UnaryCallable<UpdateServiceLevelObjectiveRequest,ServiceLevelObjective> updateServiceLevelObjectiveCallable()

Update the given ServiceLevelObjective.

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 (ServiceMonitoringServiceClient serviceMonitoringServiceClient =
     ServiceMonitoringServiceClient.create()) {
   UpdateServiceLevelObjectiveRequest request =
       UpdateServiceLevelObjectiveRequest.newBuilder()
           .setServiceLevelObjective(ServiceLevelObjective.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<ServiceLevelObjective> future =
       serviceMonitoringServiceClient.updateServiceLevelObjectiveCallable().futureCall(request);
   // Do something.
   ServiceLevelObjective response = future.get();
 }
Returns
Type Description
UnaryCallable<UpdateServiceLevelObjectiveRequest,ServiceLevelObjective>