- 0.48.0 (latest)
- 0.47.0
- 0.46.0
- 0.45.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.3.0
- 0.2.0
- 0.1.0
public class MetricsScopesClient implements BackgroundResource
Service Description: Manages Cloud Monitoring Metrics Scopes, and the monitoring of Google Cloud projects and AWS accounts.
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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
MetricsScopeName name = MetricsScopeName.of("[METRICS_SCOPE]");
MetricsScope response = metricsScopesClient.getMetricsScope(name);
}
Note: close() needs to be called on the MetricsScopesClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().
The surface of this class includes several types of Java methods for each of the API's methods:
- A "flattened" method. With this type of method, the fields of the request type have been converted into function parameters. It may be the case that not all fields are available as parameters, and not every API method will have a flattened method entry point.
- A "request object" method. This type of method only takes one parameter, a request object, which must be constructed before the call. Not every API method will have a request object method.
- A "callable" method. This type of method takes no parameters and returns an immutable API callable object, which can be used to initiate calls to the service.
See the individual methods for example code.
Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.
This class can be customized by passing in a custom instance of MetricsScopesSettings 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
MetricsScopesSettings metricsScopesSettings =
MetricsScopesSettings.newBuilder()
.setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
.build();
MetricsScopesClient metricsScopesClient = MetricsScopesClient.create(metricsScopesSettings);
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
MetricsScopesSettings metricsScopesSettings =
MetricsScopesSettings.newBuilder().setEndpoint(myEndpoint).build();
MetricsScopesClient metricsScopesClient = MetricsScopesClient.create(metricsScopesSettings);
Please refer to the GitHub repository's samples for more quickstart code snippets.
Implements
BackgroundResourceStatic Methods
create()
public static final MetricsScopesClient create()
Constructs an instance of MetricsScopesClient with default settings.
Type | Description |
MetricsScopesClient |
Type | Description |
IOException |
create(MetricsScopesSettings settings)
public static final MetricsScopesClient create(MetricsScopesSettings settings)
Constructs an instance of MetricsScopesClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
Name | Description |
settings | MetricsScopesSettings |
Type | Description |
MetricsScopesClient |
Type | Description |
IOException |
create(MetricsScopesStub stub)
public static final MetricsScopesClient create(MetricsScopesStub stub)
Constructs an instance of MetricsScopesClient, using the given stub for making calls. This is for advanced usage - prefer using create(MetricsScopesSettings).
Name | Description |
stub | MetricsScopesStub |
Type | Description |
MetricsScopesClient |
Constructors
MetricsScopesClient(MetricsScopesSettings settings)
protected MetricsScopesClient(MetricsScopesSettings settings)
Constructs an instance of MetricsScopesClient, 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.
Name | Description |
settings | MetricsScopesSettings |
MetricsScopesClient(MetricsScopesStub stub)
protected MetricsScopesClient(MetricsScopesStub stub)
Name | Description |
stub | MetricsScopesStub |
Methods
awaitTermination(long duration, TimeUnit unit)
public boolean awaitTermination(long duration, TimeUnit unit)
Name | Description |
duration | long |
unit | TimeUnit |
Type | Description |
boolean |
Type | Description |
InterruptedException |
close()
public final void close()
createMonitoredProjectAsync(CreateMonitoredProjectRequest request)
public final OperationFuture<MonitoredProject,OperationMetadata> createMonitoredProjectAsync(CreateMonitoredProjectRequest request)
Adds a MonitoredProject
with the given project ID to the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
CreateMonitoredProjectRequest request =
CreateMonitoredProjectRequest.newBuilder()
.setParent(MetricsScopeName.of("[METRICS_SCOPE]").toString())
.setMonitoredProject(MonitoredProject.newBuilder().build())
.build();
MonitoredProject response = metricsScopesClient.createMonitoredProjectAsync(request).get();
}
Name | Description |
request | CreateMonitoredProjectRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<MonitoredProject,OperationMetadata> |
createMonitoredProjectAsync(MetricsScopeName parent, MonitoredProject monitoredProject)
public final OperationFuture<MonitoredProject,OperationMetadata> createMonitoredProjectAsync(MetricsScopeName parent, MonitoredProject monitoredProject)
Adds a MonitoredProject
with the given project ID to the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
MetricsScopeName parent = MetricsScopeName.of("[METRICS_SCOPE]");
MonitoredProject monitoredProject = MonitoredProject.newBuilder().build();
MonitoredProject response =
metricsScopesClient.createMonitoredProjectAsync(parent, monitoredProject).get();
}
Name | Description |
parent | MetricsScopeName Required. The resource name of the existing |
monitoredProject | MonitoredProject Required. The initial |
Type | Description |
OperationFuture<MonitoredProject,OperationMetadata> |
createMonitoredProjectAsync(String parent, MonitoredProject monitoredProject)
public final OperationFuture<MonitoredProject,OperationMetadata> createMonitoredProjectAsync(String parent, MonitoredProject monitoredProject)
Adds a MonitoredProject
with the given project ID to the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
String parent = MetricsScopeName.of("[METRICS_SCOPE]").toString();
MonitoredProject monitoredProject = MonitoredProject.newBuilder().build();
MonitoredProject response =
metricsScopesClient.createMonitoredProjectAsync(parent, monitoredProject).get();
}
Name | Description |
parent | String Required. The resource name of the existing |
monitoredProject | MonitoredProject Required. The initial |
Type | Description |
OperationFuture<MonitoredProject,OperationMetadata> |
createMonitoredProjectCallable()
public final UnaryCallable<CreateMonitoredProjectRequest,Operation> createMonitoredProjectCallable()
Adds a MonitoredProject
with the given project ID to the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
CreateMonitoredProjectRequest request =
CreateMonitoredProjectRequest.newBuilder()
.setParent(MetricsScopeName.of("[METRICS_SCOPE]").toString())
.setMonitoredProject(MonitoredProject.newBuilder().build())
.build();
ApiFuture<Operation> future =
metricsScopesClient.createMonitoredProjectCallable().futureCall(request);
// Do something.
Operation response = future.get();
}
Type | Description |
UnaryCallable<CreateMonitoredProjectRequest,Operation> |
createMonitoredProjectOperationCallable()
public final OperationCallable<CreateMonitoredProjectRequest,MonitoredProject,OperationMetadata> createMonitoredProjectOperationCallable()
Adds a MonitoredProject
with the given project ID to the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
CreateMonitoredProjectRequest request =
CreateMonitoredProjectRequest.newBuilder()
.setParent(MetricsScopeName.of("[METRICS_SCOPE]").toString())
.setMonitoredProject(MonitoredProject.newBuilder().build())
.build();
OperationFuture<MonitoredProject, OperationMetadata> future =
metricsScopesClient.createMonitoredProjectOperationCallable().futureCall(request);
// Do something.
MonitoredProject response = future.get();
}
Type | Description |
OperationCallable<CreateMonitoredProjectRequest,MonitoredProject,OperationMetadata> |
deleteMonitoredProjectAsync(DeleteMonitoredProjectRequest request)
public final OperationFuture<Empty,OperationMetadata> deleteMonitoredProjectAsync(DeleteMonitoredProjectRequest request)
Deletes a MonitoredProject
from the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
DeleteMonitoredProjectRequest request =
DeleteMonitoredProjectRequest.newBuilder()
.setName(MonitoredProjectName.of("[METRICS_SCOPE]", "[PROJECT]").toString())
.build();
metricsScopesClient.deleteMonitoredProjectAsync(request).get();
}
Name | Description |
request | DeleteMonitoredProjectRequest The request object containing all of the parameters for the API call. |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteMonitoredProjectAsync(MonitoredProjectName name)
public final OperationFuture<Empty,OperationMetadata> deleteMonitoredProjectAsync(MonitoredProjectName name)
Deletes a MonitoredProject
from the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
MonitoredProjectName name = MonitoredProjectName.of("[METRICS_SCOPE]", "[PROJECT]");
metricsScopesClient.deleteMonitoredProjectAsync(name).get();
}
Name | Description |
name | MonitoredProjectName Required. The resource name of the Authorization requires the following Google IAM
permissions on both the |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteMonitoredProjectAsync(String name)
public final OperationFuture<Empty,OperationMetadata> deleteMonitoredProjectAsync(String name)
Deletes a MonitoredProject
from the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
String name = MonitoredProjectName.of("[METRICS_SCOPE]", "[PROJECT]").toString();
metricsScopesClient.deleteMonitoredProjectAsync(name).get();
}
Name | Description |
name | String Required. The resource name of the Authorization requires the following Google IAM
permissions on both the |
Type | Description |
OperationFuture<Empty,OperationMetadata> |
deleteMonitoredProjectCallable()
public final UnaryCallable<DeleteMonitoredProjectRequest,Operation> deleteMonitoredProjectCallable()
Deletes a MonitoredProject
from the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
DeleteMonitoredProjectRequest request =
DeleteMonitoredProjectRequest.newBuilder()
.setName(MonitoredProjectName.of("[METRICS_SCOPE]", "[PROJECT]").toString())
.build();
ApiFuture<Operation> future =
metricsScopesClient.deleteMonitoredProjectCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
UnaryCallable<DeleteMonitoredProjectRequest,Operation> |
deleteMonitoredProjectOperationCallable()
public final OperationCallable<DeleteMonitoredProjectRequest,Empty,OperationMetadata> deleteMonitoredProjectOperationCallable()
Deletes a MonitoredProject
from the specified 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
DeleteMonitoredProjectRequest request =
DeleteMonitoredProjectRequest.newBuilder()
.setName(MonitoredProjectName.of("[METRICS_SCOPE]", "[PROJECT]").toString())
.build();
OperationFuture<Empty, OperationMetadata> future =
metricsScopesClient.deleteMonitoredProjectOperationCallable().futureCall(request);
// Do something.
future.get();
}
Type | Description |
OperationCallable<DeleteMonitoredProjectRequest,Empty,OperationMetadata> |
getMetricsScope(GetMetricsScopeRequest request)
public final MetricsScope getMetricsScope(GetMetricsScopeRequest request)
Returns a specific 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
GetMetricsScopeRequest request =
GetMetricsScopeRequest.newBuilder()
.setName(MetricsScopeName.of("[METRICS_SCOPE]").toString())
.build();
MetricsScope response = metricsScopesClient.getMetricsScope(request);
}
Name | Description |
request | GetMetricsScopeRequest The request object containing all of the parameters for the API call. |
Type | Description |
MetricsScope |
getMetricsScope(MetricsScopeName name)
public final MetricsScope getMetricsScope(MetricsScopeName name)
Returns a specific 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
MetricsScopeName name = MetricsScopeName.of("[METRICS_SCOPE]");
MetricsScope response = metricsScopesClient.getMetricsScope(name);
}
Name | Description |
name | MetricsScopeName Required. The resource name of the |
Type | Description |
MetricsScope |
getMetricsScope(String name)
public final MetricsScope getMetricsScope(String name)
Returns a specific 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
String name = MetricsScopeName.of("[METRICS_SCOPE]").toString();
MetricsScope response = metricsScopesClient.getMetricsScope(name);
}
Name | Description |
name | String Required. The resource name of the |
Type | Description |
MetricsScope |
getMetricsScopeCallable()
public final UnaryCallable<GetMetricsScopeRequest,MetricsScope> getMetricsScopeCallable()
Returns a specific 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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
GetMetricsScopeRequest request =
GetMetricsScopeRequest.newBuilder()
.setName(MetricsScopeName.of("[METRICS_SCOPE]").toString())
.build();
ApiFuture<MetricsScope> future =
metricsScopesClient.getMetricsScopeCallable().futureCall(request);
// Do something.
MetricsScope response = future.get();
}
Type | Description |
UnaryCallable<GetMetricsScopeRequest,MetricsScope> |
getOperationsClient()
public final OperationsClient getOperationsClient()
Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.
Type | Description |
OperationsClient |
getSettings()
public final MetricsScopesSettings getSettings()
Type | Description |
MetricsScopesSettings |
getStub()
public MetricsScopesStub getStub()
Type | Description |
MetricsScopesStub |
isShutdown()
public boolean isShutdown()
Type | Description |
boolean |
isTerminated()
public boolean isTerminated()
Type | Description |
boolean |
listMetricsScopesByMonitoredProject(ListMetricsScopesByMonitoredProjectRequest request)
public final ListMetricsScopesByMonitoredProjectResponse listMetricsScopesByMonitoredProject(ListMetricsScopesByMonitoredProjectRequest request)
Returns a list of every Metrics Scope
that a specific MonitoredProject
has been added to.
The metrics scope representing the specified monitored project will always be the first entry
in the response.
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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
ListMetricsScopesByMonitoredProjectRequest request =
ListMetricsScopesByMonitoredProjectRequest.newBuilder()
.setMonitoredResourceContainer("monitoredResourceContainer884669850")
.build();
ListMetricsScopesByMonitoredProjectResponse response =
metricsScopesClient.listMetricsScopesByMonitoredProject(request);
}
Name | Description |
request | ListMetricsScopesByMonitoredProjectRequest The request object containing all of the parameters for the API call. |
Type | Description |
ListMetricsScopesByMonitoredProjectResponse |
listMetricsScopesByMonitoredProjectCallable()
public final UnaryCallable<ListMetricsScopesByMonitoredProjectRequest,ListMetricsScopesByMonitoredProjectResponse> listMetricsScopesByMonitoredProjectCallable()
Returns a list of every Metrics Scope
that a specific MonitoredProject
has been added to.
The metrics scope representing the specified monitored project will always be the first entry
in the response.
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 (MetricsScopesClient metricsScopesClient = MetricsScopesClient.create()) {
ListMetricsScopesByMonitoredProjectRequest request =
ListMetricsScopesByMonitoredProjectRequest.newBuilder()
.setMonitoredResourceContainer("monitoredResourceContainer884669850")
.build();
ApiFuture<ListMetricsScopesByMonitoredProjectResponse> future =
metricsScopesClient.listMetricsScopesByMonitoredProjectCallable().futureCall(request);
// Do something.
ListMetricsScopesByMonitoredProjectResponse response = future.get();
}
Type | Description |
UnaryCallable<ListMetricsScopesByMonitoredProjectRequest,ListMetricsScopesByMonitoredProjectResponse> |
shutdown()
public void shutdown()
shutdownNow()
public void shutdownNow()