Class MetricServiceSettings (3.4.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 total timeout of getMonitoredResourceDescriptor to 30 seconds:


 // This snippet has been automatically generated for illustrative purposes only.
 // It may require modifications to work in your environment.
 MetricServiceSettings.Builder metricServiceSettingsBuilder = MetricServiceSettings.newBuilder();
 metricServiceSettingsBuilder
     .getMonitoredResourceDescriptorSettings()
     .setRetrySettings(
         metricServiceSettingsBuilder
             .getMonitoredResourceDescriptorSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MetricServiceSettings metricServiceSettings = metricServiceSettingsBuilder.build();

Inheritance

java.lang.Object > ClientSettings > MetricServiceSettings

Inherited Members

ClientSettings.<B>toBuilder()

ClientSettings.getBackgroundExecutorProvider()

ClientSettings.getClock()

ClientSettings.getCredentialsProvider()

ClientSettings.getEndpoint()

ClientSettings.getExecutorProvider()

ClientSettings.getHeaderProvider()

ClientSettings.getInternalHeaderProvider()

ClientSettings.getQuotaProjectId()

ClientSettings.getStubSettings()

ClientSettings.getTransportChannelProvider()

ClientSettings.getWatchdogCheckInterval()

ClientSettings.getWatchdogProvider()

ClientSettings.toString()

Object.clone()

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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

ClientSettings<SettingsT>.<B>toBuilder()