Package com.google.cloud.logging.v2 (3.7.6)

A client to Cloud Logging API

The interfaces provided are listed below, along with usage samples.

LoggingClient

Service Description: Service for ingesting and querying logs.

Sample for LoggingClient:


 try (LoggingClient loggingClient = LoggingClient.create()) {
   LogName logName = LogName.ofProjectLogName("[PROJECT]", "[LOG]");
   loggingClient.deleteLog(logName);
 }

ConfigClient

Service Description: Service for configuring sinks used to route log entries.

Sample for ConfigClient:


 try (ConfigClient configClient = ConfigClient.create()) {
   GetBucketRequest request =
       GetBucketRequest.newBuilder()
           .setName(
               LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                   .toString())
           .build();
   LogBucket response = configClient.getBucket(request);
 }

MetricsClient

Service Description: Service for configuring logs-based metrics.

Sample for MetricsClient:


 try (MetricsClient metricsClient = MetricsClient.create()) {
   LogMetricName metricName = LogMetricName.of("[PROJECT]", "[METRIC]");
   LogMetric response = metricsClient.getLogMetric(metricName);
 }

Classes

ConfigClient

Service Description: Service for configuring sinks used to route log entries.

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:


 try (ConfigClient configClient = ConfigClient.create()) {
   GetBucketRequest request =
       GetBucketRequest.newBuilder()
           .setName(
               LogBucketName.ofProjectLocationBucketName("[PROJECT]", "[LOCATION]", "[BUCKET]")
                   .toString())
           .build();
   LogBucket response = configClient.getBucket(request);
 }

Note: close() needs to be called on the ConfigClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

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

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

See the individual methods for example code.

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

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

To customize credentials:


 ConfigSettings configSettings =
     ConfigSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ConfigClient configClient = ConfigClient.create(configSettings);

To customize the endpoint:


 ConfigSettings configSettings = ConfigSettings.newBuilder().setEndpoint(myEndpoint).build();
 ConfigClient configClient = ConfigClient.create(configSettings);

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

ConfigClient.ListBucketsFixedSizeCollection

ConfigClient.ListBucketsPage

ConfigClient.ListBucketsPagedResponse

ConfigClient.ListExclusionsFixedSizeCollection

ConfigClient.ListExclusionsPage

ConfigClient.ListExclusionsPagedResponse

ConfigClient.ListSinksFixedSizeCollection

ConfigClient.ListSinksPage

ConfigClient.ListSinksPagedResponse

ConfigClient.ListViewsFixedSizeCollection

ConfigClient.ListViewsPage

ConfigClient.ListViewsPagedResponse

ConfigSettings

Settings class to configure an instance of ConfigClient.

The default instance has everything set to sensible defaults:

  • The default service address (logging.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getBucket to 30 seconds:


 ConfigSettings.Builder configSettingsBuilder = ConfigSettings.newBuilder();
 configSettingsBuilder
     .getBucketSettings()
     .setRetrySettings(
         configSettingsBuilder
             .getBucketSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 ConfigSettings configSettings = configSettingsBuilder.build();

ConfigSettings.Builder

Builder for ConfigSettings.

LoggingClient

Service Description: Service for ingesting and querying logs.

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:


 try (LoggingClient loggingClient = LoggingClient.create()) {
   LogName logName = LogName.ofProjectLogName("[PROJECT]", "[LOG]");
   loggingClient.deleteLog(logName);
 }

Note: close() needs to be called on the LoggingClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

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

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

See the individual methods for example code.

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

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

To customize credentials:


 LoggingSettings loggingSettings =
     LoggingSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 LoggingClient loggingClient = LoggingClient.create(loggingSettings);

To customize the endpoint:


 LoggingSettings loggingSettings = LoggingSettings.newBuilder().setEndpoint(myEndpoint).build();
 LoggingClient loggingClient = LoggingClient.create(loggingSettings);

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

LoggingClient.ListLogEntriesFixedSizeCollection

LoggingClient.ListLogEntriesPage

LoggingClient.ListLogEntriesPagedResponse

LoggingClient.ListLogsFixedSizeCollection

LoggingClient.ListLogsPage

LoggingClient.ListLogsPagedResponse

LoggingClient.ListMonitoredResourceDescriptorsFixedSizeCollection

LoggingClient.ListMonitoredResourceDescriptorsPage

LoggingClient.ListMonitoredResourceDescriptorsPagedResponse

LoggingSettings

Settings class to configure an instance of LoggingClient.

The default instance has everything set to sensible defaults:

  • The default service address (logging.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of deleteLog to 30 seconds:


 LoggingSettings.Builder loggingSettingsBuilder = LoggingSettings.newBuilder();
 loggingSettingsBuilder
     .deleteLogSettings()
     .setRetrySettings(
         loggingSettingsBuilder
             .deleteLogSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 LoggingSettings loggingSettings = loggingSettingsBuilder.build();

LoggingSettings.Builder

Builder for LoggingSettings.

MetricsClient

Service Description: Service for configuring logs-based 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:


 try (MetricsClient metricsClient = MetricsClient.create()) {
   LogMetricName metricName = LogMetricName.of("[PROJECT]", "[METRIC]");
   LogMetric response = metricsClient.getLogMetric(metricName);
 }

Note: close() needs to be called on the MetricsClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

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

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

See the individual methods for example code.

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

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

To customize credentials:


 MetricsSettings metricsSettings =
     MetricsSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 MetricsClient metricsClient = MetricsClient.create(metricsSettings);

To customize the endpoint:


 MetricsSettings metricsSettings = MetricsSettings.newBuilder().setEndpoint(myEndpoint).build();
 MetricsClient metricsClient = MetricsClient.create(metricsSettings);

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

MetricsClient.ListLogMetricsFixedSizeCollection

MetricsClient.ListLogMetricsPage

MetricsClient.ListLogMetricsPagedResponse

MetricsSettings

Settings class to configure an instance of MetricsClient.

The default instance has everything set to sensible defaults:

  • The default service address (logging.googleapis.com) and default port (443) are used.
  • Credentials are acquired automatically through Application Default Credentials.
  • Retries are configured for idempotent methods but not for non-idempotent methods.

The builder of this class is recursive, so contained classes are themselves builders. When build() is called, the tree of builders is called to create the complete settings object.

For example, to set the total timeout of getLogMetric to 30 seconds:


 MetricsSettings.Builder metricsSettingsBuilder = MetricsSettings.newBuilder();
 metricsSettingsBuilder
     .getLogMetricSettings()
     .setRetrySettings(
         metricsSettingsBuilder
             .getLogMetricSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MetricsSettings metricsSettings = metricsSettingsBuilder.build();

MetricsSettings.Builder

Builder for MetricsSettings.