com.google.cloud.monitoring.v3.stub

Class QueryServiceStubSettings

java.lang.Object

com.google.api.gax.rpc.StubSettings<QueryServiceStubSettings>

com.google.cloud.monitoring.v3.stub.QueryServiceStubSettings

@Generated(value="by gapic-generator-java")
public class QueryServiceStubSettings
extends com.google.api.gax.rpc.StubSettings<QueryServiceStubSettings>

Settings class to configure an instance of QueryServiceStub.

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](https://cloud.google.com/java/docs/reference/gax/latest/com.google.api.gax.retrying.RetrySettings) of queryTimeSeries:

 // 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
 QueryServiceStubSettings.Builder queryServiceSettingsBuilder =
     QueryServiceStubSettings.newBuilder();
 queryServiceSettingsBuilder
     .queryTimeSeriesSettings()
     .setRetrySettings(
         queryServiceSettingsBuilder
             .queryTimeSeriesSettings()
             .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());
 QueryServiceStubSettings queryServiceSettings = queryServiceSettingsBuilder.build();
 

Please refer to the [Client Side Retry Guide](https://github.com/googleapis/google-cloud-java/blob/main/docs/client_retries.md) for additional support in setting retries.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	QueryServiceStubSettings.Builder Builder for QueryServiceStubSettings.

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	QueryServiceStubSettings(QueryServiceStubSettings.Builder settingsBuilder)

Method Summary

Modifier and Type	Method and Description
QueryServiceStub	createStub()
static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder	defaultApiClientHeaderProviderBuilder()
static com.google.api.gax.core.GoogleCredentialsProvider.Builder	defaultCredentialsProviderBuilder() Returns a builder for the default credentials for this service.
static com.google.api.gax.core.InstantiatingExecutorProvider.Builder	defaultExecutorProviderBuilder() Returns a builder for the default ExecutorProvider for this service.
static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder	defaultGrpcTransportProviderBuilder() Returns a builder for the default ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
static String	getDefaultEndpoint() Returns the default service endpoint.
static String	getDefaultMtlsEndpoint() Returns the default mTLS service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
String	getServiceName() Returns the default service name.
static QueryServiceStubSettings.Builder	newBuilder() Returns a new builder for this class.
static QueryServiceStubSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
com.google.api.gax.rpc.PagedCallSettings<QueryTimeSeriesRequest,QueryTimeSeriesResponse,QueryServiceClient.QueryTimeSeriesPagedResponse>	queryTimeSeriesSettings() Deprecated. This method is deprecated and will be removed in the next major version update.
QueryServiceStubSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.

Methods inherited from class com.google.api.gax.rpc.StubSettings

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

QueryServiceStubSettings

protected QueryServiceStubSettings(QueryServiceStubSettings.Builder settingsBuilder)
                            throws IOException

Throws:

IOException

Method Detail

queryTimeSeriesSettings

@Deprecated
public com.google.api.gax.rpc.PagedCallSettings<QueryTimeSeriesRequest,QueryTimeSeriesResponse,QueryServiceClient.QueryTimeSeriesPagedResponse> queryTimeSeriesSettings()

Deprecated. This method is deprecated and will be removed in the next major version update.

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

createStub

public QueryServiceStub createStub()
                            throws IOException

Throws:

IOException

getServiceName

public String getServiceName()

Returns the default service name.

Overrides:

getServiceName in class com.google.api.gax.rpc.StubSettings<QueryServiceStubSettings>

defaultExecutorProviderBuilder

public static com.google.api.gax.core.InstantiatingExecutorProvider.Builder defaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

@ObsoleteApi(value="Use getEndpoint() instead")
public static String getDefaultEndpoint()

Returns the default service endpoint.

getDefaultMtlsEndpoint

public static String getDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

getDefaultServiceScopes

public static List<String> getDefaultServiceScopes()

Returns the default service scopes.

defaultCredentialsProviderBuilder

public static com.google.api.gax.core.GoogleCredentialsProvider.Builder defaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

defaultGrpcTransportProviderBuilder

public static com.google.api.gax.grpc.InstantiatingGrpcChannelProvider.Builder defaultGrpcTransportProviderBuilder()

Returns a builder for the default ChannelProvider for this service.

defaultTransportChannelProvider

public static com.google.api.gax.rpc.TransportChannelProvider defaultTransportChannelProvider()

defaultApiClientHeaderProviderBuilder

public static com.google.api.gax.rpc.ApiClientHeaderProvider.Builder defaultApiClientHeaderProviderBuilder()

newBuilder

public static QueryServiceStubSettings.Builder newBuilder()

Returns a new builder for this class.

newBuilder

public static QueryServiceStubSettings.Builder newBuilder(com.google.api.gax.rpc.ClientContext clientContext)

Returns a new builder for this class.

toBuilder

public QueryServiceStubSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.StubSettings<QueryServiceStubSettings>