com.google.api.cloudquotas.v1beta

Class CloudQuotasSettings

java.lang.Object

com.google.api.gax.rpc.ClientSettings<CloudQuotasSettings>

com.google.api.cloudquotas.v1beta.CloudQuotasSettings

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

Settings class to configure an instance of CloudQuotasClient.

The default instance has everything set to sensible defaults:

• The default service address (cloudquotas.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 getQuotaInfo:

 // 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
 CloudQuotasSettings.Builder cloudQuotasSettingsBuilder = CloudQuotasSettings.newBuilder();
 cloudQuotasSettingsBuilder
     .getQuotaInfoSettings()
     .setRetrySettings(
         cloudQuotasSettingsBuilder
             .getQuotaInfoSettings()
             .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());
 CloudQuotasSettings cloudQuotasSettings = cloudQuotasSettingsBuilder.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	CloudQuotasSettings.Builder Builder for CloudQuotasSettings.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
static CloudQuotasSettings	create(CloudQuotasStubSettings stub)
com.google.api.gax.rpc.UnaryCallSettings<CreateQuotaPreferenceRequest,QuotaPreference>	createQuotaPreferenceSettings() Returns the object with the settings used for calls to createQuotaPreference.
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 gRPC ChannelProvider for this service.
static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder	defaultHttpJsonTransportProviderBuilder() Returns a builder for the default REST ChannelProvider for this service.
static com.google.api.gax.rpc.TransportChannelProvider	defaultTransportChannelProvider()
static String	getDefaultEndpoint() Returns the default service endpoint.
static List<String>	getDefaultServiceScopes() Returns the default service scopes.
com.google.api.gax.rpc.UnaryCallSettings<GetQuotaInfoRequest,QuotaInfo>	getQuotaInfoSettings() Returns the object with the settings used for calls to getQuotaInfo.
com.google.api.gax.rpc.UnaryCallSettings<GetQuotaPreferenceRequest,QuotaPreference>	getQuotaPreferenceSettings() Returns the object with the settings used for calls to getQuotaPreference.
com.google.api.gax.rpc.PagedCallSettings<ListQuotaInfosRequest,ListQuotaInfosResponse,CloudQuotasClient.ListQuotaInfosPagedResponse>	listQuotaInfosSettings() Returns the object with the settings used for calls to listQuotaInfos.
com.google.api.gax.rpc.PagedCallSettings<ListQuotaPreferencesRequest,ListQuotaPreferencesResponse,CloudQuotasClient.ListQuotaPreferencesPagedResponse>	listQuotaPreferencesSettings() Returns the object with the settings used for calls to listQuotaPreferences.
static CloudQuotasSettings.Builder	newBuilder() Returns a new gRPC builder for this class.
static CloudQuotasSettings.Builder	newBuilder(com.google.api.gax.rpc.ClientContext clientContext) Returns a new builder for this class.
static CloudQuotasSettings.Builder	newHttpJsonBuilder() Returns a new REST builder for this class.
CloudQuotasSettings.Builder	toBuilder() Returns a builder containing all the values of this settings class.
com.google.api.gax.rpc.UnaryCallSettings<UpdateQuotaPreferenceRequest,QuotaPreference>	updateQuotaPreferenceSettings() Returns the object with the settings used for calls to updateQuotaPreference.

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

getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getQuotaProjectId, getStubSettings, getTransportChannelProvider, getUniverseDomain, getWatchdogCheckInterval, getWatchdogCheckIntervalDuration, getWatchdogProvider, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudQuotasSettings

protected CloudQuotasSettings(CloudQuotasSettings.Builder settingsBuilder)
                       throws IOException

Throws:

IOException

Method Detail

listQuotaInfosSettings

public com.google.api.gax.rpc.PagedCallSettings<ListQuotaInfosRequest,ListQuotaInfosResponse,CloudQuotasClient.ListQuotaInfosPagedResponse> listQuotaInfosSettings()

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

getQuotaInfoSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetQuotaInfoRequest,QuotaInfo> getQuotaInfoSettings()

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

listQuotaPreferencesSettings

public com.google.api.gax.rpc.PagedCallSettings<ListQuotaPreferencesRequest,ListQuotaPreferencesResponse,CloudQuotasClient.ListQuotaPreferencesPagedResponse> listQuotaPreferencesSettings()

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

getQuotaPreferenceSettings

public com.google.api.gax.rpc.UnaryCallSettings<GetQuotaPreferenceRequest,QuotaPreference> getQuotaPreferenceSettings()

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

createQuotaPreferenceSettings

public com.google.api.gax.rpc.UnaryCallSettings<CreateQuotaPreferenceRequest,QuotaPreference> createQuotaPreferenceSettings()

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

updateQuotaPreferenceSettings

public com.google.api.gax.rpc.UnaryCallSettings<UpdateQuotaPreferenceRequest,QuotaPreference> updateQuotaPreferenceSettings()

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

create

public static final CloudQuotasSettings create(CloudQuotasStubSettings stub)
                                        throws IOException

Throws:

IOException

defaultExecutorProviderBuilder

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

Returns a builder for the default ExecutorProvider for this service.

getDefaultEndpoint

public static String getDefaultEndpoint()

Returns the default 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 gRPC ChannelProvider for this service.

defaultHttpJsonTransportProviderBuilder

@BetaApi
public static com.google.api.gax.httpjson.InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST 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 CloudQuotasSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

newHttpJsonBuilder

public static CloudQuotasSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

newBuilder

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

Returns a new builder for this class.

toBuilder

public CloudQuotasSettings.Builder toBuilder()

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

Specified by:

toBuilder in class com.google.api.gax.rpc.ClientSettings<CloudQuotasSettings>