Class MetricsSettings (3.20.2)

public class MetricsSettings extends ClientSettings<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:


 // 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
 MetricsSettings.Builder metricsSettingsBuilder = MetricsSettings.newBuilder();
 metricsSettingsBuilder
     .getLogMetricSettings()
     .setRetrySettings(
         metricsSettingsBuilder
             .getLogMetricSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MetricsSettings metricsSettings = metricsSettingsBuilder.build();
 

Inheritance

java.lang.Object > ClientSettings > MetricsSettings

Static Methods

create(MetricsServiceV2StubSettings stub)

public static final MetricsSettings create(MetricsServiceV2StubSettings stub)
Parameter
Name Description
stub MetricsServiceV2StubSettings
Returns
Type Description
MetricsSettings
Exceptions
Type Description
IOException

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

public static MetricsSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
MetricsSettings.Builder

newBuilder(ClientContext clientContext)

public static MetricsSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
MetricsSettings.Builder

Constructors

MetricsSettings(MetricsSettings.Builder settingsBuilder)

protected MetricsSettings(MetricsSettings.Builder settingsBuilder)
Parameter
Name Description
settingsBuilder MetricsSettings.Builder

Methods

createLogMetricSettings()

public UnaryCallSettings<CreateLogMetricRequest,LogMetric> createLogMetricSettings()

Returns the object with the settings used for calls to createLogMetric.

Returns
Type Description
UnaryCallSettings<CreateLogMetricRequest,LogMetric>

deleteLogMetricSettings()

public UnaryCallSettings<DeleteLogMetricRequest,Empty> deleteLogMetricSettings()

Returns the object with the settings used for calls to deleteLogMetric.

Returns
Type Description
UnaryCallSettings<DeleteLogMetricRequest,Empty>

getLogMetricSettings()

public UnaryCallSettings<GetLogMetricRequest,LogMetric> getLogMetricSettings()

Returns the object with the settings used for calls to getLogMetric.

Returns
Type Description
UnaryCallSettings<GetLogMetricRequest,LogMetric>

listLogMetricsSettings()

public PagedCallSettings<ListLogMetricsRequest,ListLogMetricsResponse,MetricsClient.ListLogMetricsPagedResponse> listLogMetricsSettings()

Returns the object with the settings used for calls to listLogMetrics.

Returns
Type Description
PagedCallSettings<ListLogMetricsRequest,ListLogMetricsResponse,ListLogMetricsPagedResponse>

toBuilder()

public MetricsSettings.Builder toBuilder()

Returns a builder containing all the values of this settings class.

Returns
Type Description
MetricsSettings.Builder
Overrides

updateLogMetricSettings()

public UnaryCallSettings<UpdateLogMetricRequest,LogMetric> updateLogMetricSettings()

Returns the object with the settings used for calls to updateLogMetric.

Returns
Type Description
UnaryCallSettings<UpdateLogMetricRequest,LogMetric>