Class MetricServiceStubSettings (3.41.0)

public class MetricServiceStubSettings extends StubSettings<MetricServiceStubSettings>

Settings class to configure an instance of MetricServiceStub.

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 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
 MetricServiceStubSettings.Builder metricServiceSettingsBuilder =
     MetricServiceStubSettings.newBuilder();
 metricServiceSettingsBuilder
     .getMonitoredResourceDescriptorSettings()
     .setRetrySettings(
         metricServiceSettingsBuilder
             .getMonitoredResourceDescriptorSettings()
             .getRetrySettings()
             .toBuilder()
             .setTotalTimeout(Duration.ofSeconds(30))
             .build());
 MetricServiceStubSettings metricServiceSettings = metricServiceSettingsBuilder.build();
 

Inheritance

java.lang.Object > StubSettings > MetricServiceStubSettings

Static Methods

defaultApiClientHeaderProviderBuilder()

public static ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()
Returns
TypeDescription
Builder

defaultCredentialsProviderBuilder()

public static GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
TypeDescription
Builder

defaultExecutorProviderBuilder()

public static InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
TypeDescription
Builder

defaultGrpcTransportProviderBuilder()

public static InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

Returns
TypeDescription
Builder

defaultTransportChannelProvider()

public static TransportChannelProvider defaultTransportChannelProvider()
Returns
TypeDescription
TransportChannelProvider

getDefaultEndpoint()

public static String getDefaultEndpoint()

Returns the default service endpoint.

Returns
TypeDescription
String

getDefaultMtlsEndpoint()

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
TypeDescription
String

getDefaultServiceScopes()

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

Returns
TypeDescription
List<String>

newBuilder()

public static MetricServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

Returns
TypeDescription
MetricServiceStubSettings.Builder

newBuilder(ClientContext clientContext)

public static MetricServiceStubSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
NameDescription
clientContextClientContext
Returns
TypeDescription
MetricServiceStubSettings.Builder

Constructors

MetricServiceStubSettings(MetricServiceStubSettings.Builder settingsBuilder)

protected MetricServiceStubSettings(MetricServiceStubSettings.Builder settingsBuilder)
Parameter
NameDescription
settingsBuilderMetricServiceStubSettings.Builder

Methods

createMetricDescriptorSettings()

public UnaryCallSettings<CreateMetricDescriptorRequest,MetricDescriptor> createMetricDescriptorSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateMetricDescriptorRequest,com.google.api.MetricDescriptor>

createServiceTimeSeriesSettings()

public UnaryCallSettings<CreateTimeSeriesRequest,Empty> createServiceTimeSeriesSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTimeSeriesRequest,Empty>

createStub()

public MetricServiceStub createStub()
Returns
TypeDescription
MetricServiceStub
Exceptions
TypeDescription
IOException

createTimeSeriesSettings()

public UnaryCallSettings<CreateTimeSeriesRequest,Empty> createTimeSeriesSettings()

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

Returns
TypeDescription
UnaryCallSettings<CreateTimeSeriesRequest,Empty>

deleteMetricDescriptorSettings()

public UnaryCallSettings<DeleteMetricDescriptorRequest,Empty> deleteMetricDescriptorSettings()

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

Returns
TypeDescription
UnaryCallSettings<DeleteMetricDescriptorRequest,Empty>

getEndpoint()

public String getEndpoint()

Returns the endpoint set by the user or the the service's default endpoint.

Returns
TypeDescription
String
Overrides

getMetricDescriptorSettings()

public UnaryCallSettings<GetMetricDescriptorRequest,MetricDescriptor> getMetricDescriptorSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetMetricDescriptorRequest,com.google.api.MetricDescriptor>

getMonitoredResourceDescriptorSettings()

public UnaryCallSettings<GetMonitoredResourceDescriptorRequest,MonitoredResourceDescriptor> getMonitoredResourceDescriptorSettings()

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

Returns
TypeDescription
UnaryCallSettings<GetMonitoredResourceDescriptorRequest,com.google.api.MonitoredResourceDescriptor>

getServiceName()

public String getServiceName()

Returns the default service name.

Returns
TypeDescription
String
Overrides

listMetricDescriptorsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListMetricDescriptorsRequest,ListMetricDescriptorsResponse,ListMetricDescriptorsPagedResponse>

listMonitoredResourceDescriptorsSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListMonitoredResourceDescriptorsRequest,ListMonitoredResourceDescriptorsResponse,ListMonitoredResourceDescriptorsPagedResponse>

listTimeSeriesSettings()

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

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

Returns
TypeDescription
PagedCallSettings<ListTimeSeriesRequest,ListTimeSeriesResponse,ListTimeSeriesPagedResponse>

toBuilder()

public MetricServiceStubSettings.Builder toBuilder()

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

Returns
TypeDescription
MetricServiceStubSettings.Builder
Overrides