Class MetricServiceSettings (3.55.0) 

public class MetricServiceSettings extends ClientSettings<MetricServiceSettings>

Settings class to configure an instance of MetricServiceClient.

The default instance has everything set to sensible defaults:

  • The default service address (monitoring.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 RetrySettings of getMonitoredResourceDescriptor:


 // 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
 MetricServiceSettings.Builder metricServiceSettingsBuilder = MetricServiceSettings.newBuilder();
 metricServiceSettingsBuilder
     .getMonitoredResourceDescriptorSettings()
     .setRetrySettings(
         metricServiceSettingsBuilder
             .getMonitoredResourceDescriptorSettings()
             .getRetrySettings()
             .toBuilder()
             .setInitialRetryDelayDuration(Duration.ofSeconds(1))
             .setInitialRpcTimeoutDuration(Duration.ofSeconds(5))
             .setMaxAttempts(5)
             .setMaxRetryDelayDuration(Duration.ofSeconds(30))
             .setMaxRpcTimeoutDuration(Duration.ofSeconds(60))
             .setRetryDelayMultiplier(1.3)
             .setRpcTimeoutMultiplier(1.5)
             .setTotalTimeoutDuration(Duration.ofSeconds(300))
             .build());
 MetricServiceSettings metricServiceSettings = metricServiceSettingsBuilder.build();

Please refer to the Client Side Retry Guide for additional support in setting retries.

Inheritance

java.lang.Object > ClientSettings > MetricServiceSettings

Static Methods

create(MetricServiceStubSettings stub)

public static final MetricServiceSettings create(MetricServiceStubSettings stub)
Parameter
Name Description
stub MetricServiceStubSettings
Returns
Type Description
MetricServiceSettings
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 MetricServiceSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
Type Description
MetricServiceSettings.Builder

newBuilder(ClientContext clientContext)

public static MetricServiceSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
MetricServiceSettings.Builder

Constructors

MetricServiceSettings(MetricServiceSettings.Builder settingsBuilder)

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

Methods

createMetricDescriptorSettings()

public UnaryCallSettings<CreateMetricDescriptorRequest,MetricDescriptor> createMetricDescriptorSettings()

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

Returns
Type Description
UnaryCallSettings<CreateMetricDescriptorRequest,com.google.api.MetricDescriptor>

createServiceTimeSeriesSettings()

public UnaryCallSettings<CreateTimeSeriesRequest,Empty> createServiceTimeSeriesSettings()

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

Returns
Type Description
UnaryCallSettings<CreateTimeSeriesRequest,Empty>

createTimeSeriesSettings()

public UnaryCallSettings<CreateTimeSeriesRequest,Empty> createTimeSeriesSettings()

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

Returns
Type Description
UnaryCallSettings<CreateTimeSeriesRequest,Empty>

deleteMetricDescriptorSettings()

public UnaryCallSettings<DeleteMetricDescriptorRequest,Empty> deleteMetricDescriptorSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteMetricDescriptorRequest,Empty>

getMetricDescriptorSettings()

public UnaryCallSettings<GetMetricDescriptorRequest,MetricDescriptor> getMetricDescriptorSettings()

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

Returns
Type Description
UnaryCallSettings<GetMetricDescriptorRequest,com.google.api.MetricDescriptor>

getMonitoredResourceDescriptorSettings()

public UnaryCallSettings<GetMonitoredResourceDescriptorRequest,MonitoredResourceDescriptor> getMonitoredResourceDescriptorSettings()

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

Returns
Type Description
UnaryCallSettings<GetMonitoredResourceDescriptorRequest,com.google.api.MonitoredResourceDescriptor>

listMetricDescriptorsSettings()

public PagedCallSettings<ListMetricDescriptorsRequest,ListMetricDescriptorsResponse,MetricServiceClient.ListMetricDescriptorsPagedResponse> listMetricDescriptorsSettings()

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

Returns
Type Description
PagedCallSettings<ListMetricDescriptorsRequest,ListMetricDescriptorsResponse,ListMetricDescriptorsPagedResponse>

listMonitoredResourceDescriptorsSettings()

public PagedCallSettings<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse,MetricServiceClient.ListMonitoredResourceDescriptorsPagedResponse> listMonitoredResourceDescriptorsSettings()

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

Returns
Type Description
PagedCallSettings<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse,ListMonitoredResourceDescriptorsPagedResponse>

listTimeSeriesSettings()

public PagedCallSettings<ListTimeSeriesRequest,ListTimeSeriesResponse,MetricServiceClient.ListTimeSeriesPagedResponse> listTimeSeriesSettings()

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

Returns
Type Description
PagedCallSettings<ListTimeSeriesRequest,ListTimeSeriesResponse,ListTimeSeriesPagedResponse>

toBuilder()

public MetricServiceSettings.Builder toBuilder()

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

Returns
Type Description
MetricServiceSettings.Builder
Overrides