Class ServiceUsageSettings (2.52.0) 

public class ServiceUsageSettings extends ClientSettings<ServiceUsageSettings>

Settings class to configure an instance of ServiceUsageClient.

The default instance has everything set to sensible defaults:

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


 // 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
 ServiceUsageSettings.Builder serviceUsageSettingsBuilder = ServiceUsageSettings.newBuilder();
 serviceUsageSettingsBuilder
     .getServiceSettings()
     .setRetrySettings(
         serviceUsageSettingsBuilder
             .getServiceSettings()
             .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());
 ServiceUsageSettings serviceUsageSettings = serviceUsageSettingsBuilder.build();

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

To configure the RetrySettings of a Long Running Operation method, create an OperationTimedPollAlgorithm object and update the RPC's polling algorithm. For example, to configure the RetrySettings for enableService:


 // 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
 ServiceUsageSettings.Builder serviceUsageSettingsBuilder = ServiceUsageSettings.newBuilder();
 TimedRetryAlgorithm timedRetryAlgorithm =
     OperationalTimedPollAlgorithm.create(
         RetrySettings.newBuilder()
             .setInitialRetryDelayDuration(Duration.ofMillis(500))
             .setRetryDelayMultiplier(1.5)
             .setMaxRetryDelay(Duration.ofMillis(5000))
             .setTotalTimeoutDuration(Duration.ofHours(24))
             .build());
 serviceUsageSettingsBuilder
     .createClusterOperationSettings()
     .setPollingAlgorithm(timedRetryAlgorithm)
     .build();

Inheritance

java.lang.Object > ClientSettings > ServiceUsageSettings

Static Methods

create(ServiceUsageStubSettings stub)

public static final ServiceUsageSettings create(ServiceUsageStubSettings stub)
Parameter
Name Description
stub ServiceUsageStubSettings
Returns
Type Description
ServiceUsageSettings
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 gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()

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

Returns a new gRPC builder for this class.

Returns
Type Description
ServiceUsageSettings.Builder

newBuilder(ClientContext clientContext)

public static ServiceUsageSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ServiceUsageSettings.Builder

newHttpJsonBuilder()

public static ServiceUsageSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
ServiceUsageSettings.Builder

Constructors

ServiceUsageSettings(ServiceUsageSettings.Builder settingsBuilder)

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

Methods

batchEnableServicesOperationSettings() (deprecated)

public OperationCallSettings<BatchEnableServicesRequest,Empty,OperationMetadata> batchEnableServicesOperationSettings()

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 batchEnableServices.

Returns
Type Description
OperationCallSettings<BatchEnableServicesRequest,Empty,OperationMetadata>

batchEnableServicesSettings() (deprecated)

public UnaryCallSettings<BatchEnableServicesRequest,Operation> batchEnableServicesSettings()

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 batchEnableServices.

Returns
Type Description
UnaryCallSettings<BatchEnableServicesRequest,Operation>

createAdminOverrideOperationSettings()

public OperationCallSettings<CreateAdminOverrideRequest,QuotaOverride,OperationMetadata> createAdminOverrideOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateAdminOverrideRequest,QuotaOverride,OperationMetadata>

createAdminOverrideSettings()

public UnaryCallSettings<CreateAdminOverrideRequest,Operation> createAdminOverrideSettings()

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

Returns
Type Description
UnaryCallSettings<CreateAdminOverrideRequest,Operation>

createConsumerOverrideOperationSettings()

public OperationCallSettings<CreateConsumerOverrideRequest,QuotaOverride,OperationMetadata> createConsumerOverrideOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateConsumerOverrideRequest,QuotaOverride,OperationMetadata>

createConsumerOverrideSettings()

public UnaryCallSettings<CreateConsumerOverrideRequest,Operation> createConsumerOverrideSettings()

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

Returns
Type Description
UnaryCallSettings<CreateConsumerOverrideRequest,Operation>

deleteAdminOverrideOperationSettings()

public OperationCallSettings<DeleteAdminOverrideRequest,Empty,OperationMetadata> deleteAdminOverrideOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteAdminOverrideRequest,Empty,OperationMetadata>

deleteAdminOverrideSettings()

public UnaryCallSettings<DeleteAdminOverrideRequest,Operation> deleteAdminOverrideSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteAdminOverrideRequest,Operation>

deleteConsumerOverrideOperationSettings()

public OperationCallSettings<DeleteConsumerOverrideRequest,Empty,OperationMetadata> deleteConsumerOverrideOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteConsumerOverrideRequest,Empty,OperationMetadata>

deleteConsumerOverrideSettings()

public UnaryCallSettings<DeleteConsumerOverrideRequest,Operation> deleteConsumerOverrideSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteConsumerOverrideRequest,Operation>

disableServiceOperationSettings() (deprecated)

public OperationCallSettings<DisableServiceRequest,Empty,OperationMetadata> disableServiceOperationSettings()

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 disableService.

Returns
Type Description
OperationCallSettings<DisableServiceRequest,Empty,OperationMetadata>

disableServiceSettings() (deprecated)

public UnaryCallSettings<DisableServiceRequest,Operation> disableServiceSettings()

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 disableService.

Returns
Type Description
UnaryCallSettings<DisableServiceRequest,Operation>

enableServiceOperationSettings() (deprecated)

public OperationCallSettings<EnableServiceRequest,Empty,OperationMetadata> enableServiceOperationSettings()

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 enableService.

Returns
Type Description
OperationCallSettings<EnableServiceRequest,Empty,OperationMetadata>

enableServiceSettings() (deprecated)

public UnaryCallSettings<EnableServiceRequest,Operation> enableServiceSettings()

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 enableService.

Returns
Type Description
UnaryCallSettings<EnableServiceRequest,Operation>

generateServiceIdentityOperationSettings()

public OperationCallSettings<GenerateServiceIdentityRequest,ServiceIdentity,Empty> generateServiceIdentityOperationSettings()

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

Returns
Type Description
OperationCallSettings<GenerateServiceIdentityRequest,ServiceIdentity,Empty>

generateServiceIdentitySettings()

public UnaryCallSettings<GenerateServiceIdentityRequest,Operation> generateServiceIdentitySettings()

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

Returns
Type Description
UnaryCallSettings<GenerateServiceIdentityRequest,Operation>

getConsumerQuotaLimitSettings()

public UnaryCallSettings<GetConsumerQuotaLimitRequest,ConsumerQuotaLimit> getConsumerQuotaLimitSettings()

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

Returns
Type Description
UnaryCallSettings<GetConsumerQuotaLimitRequest,ConsumerQuotaLimit>

getConsumerQuotaMetricSettings()

public UnaryCallSettings<GetConsumerQuotaMetricRequest,ConsumerQuotaMetric> getConsumerQuotaMetricSettings()

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

Returns
Type Description
UnaryCallSettings<GetConsumerQuotaMetricRequest,ConsumerQuotaMetric>

getServiceSettings() (deprecated)

public UnaryCallSettings<GetServiceRequest,Service> getServiceSettings()

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 getService.

Returns
Type Description
UnaryCallSettings<GetServiceRequest,Service>

importAdminOverridesOperationSettings()

public OperationCallSettings<ImportAdminOverridesRequest,ImportAdminOverridesResponse,ImportAdminOverridesMetadata> importAdminOverridesOperationSettings()

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

Returns
Type Description
OperationCallSettings<ImportAdminOverridesRequest,ImportAdminOverridesResponse,ImportAdminOverridesMetadata>

importAdminOverridesSettings()

public UnaryCallSettings<ImportAdminOverridesRequest,Operation> importAdminOverridesSettings()

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

Returns
Type Description
UnaryCallSettings<ImportAdminOverridesRequest,Operation>

importConsumerOverridesOperationSettings()

public OperationCallSettings<ImportConsumerOverridesRequest,ImportConsumerOverridesResponse,ImportConsumerOverridesMetadata> importConsumerOverridesOperationSettings()

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

Returns
Type Description
OperationCallSettings<ImportConsumerOverridesRequest,ImportConsumerOverridesResponse,ImportConsumerOverridesMetadata>

importConsumerOverridesSettings()

public UnaryCallSettings<ImportConsumerOverridesRequest,Operation> importConsumerOverridesSettings()

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

Returns
Type Description
UnaryCallSettings<ImportConsumerOverridesRequest,Operation>

listAdminOverridesSettings()

public PagedCallSettings<ListAdminOverridesRequest,ListAdminOverridesResponse,ServiceUsageClient.ListAdminOverridesPagedResponse> listAdminOverridesSettings()

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

Returns
Type Description
PagedCallSettings<ListAdminOverridesRequest,ListAdminOverridesResponse,ListAdminOverridesPagedResponse>

listConsumerOverridesSettings()

public PagedCallSettings<ListConsumerOverridesRequest,ListConsumerOverridesResponse,ServiceUsageClient.ListConsumerOverridesPagedResponse> listConsumerOverridesSettings()

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

Returns
Type Description
PagedCallSettings<ListConsumerOverridesRequest,ListConsumerOverridesResponse,ListConsumerOverridesPagedResponse>

listConsumerQuotaMetricsSettings()

public PagedCallSettings<ListConsumerQuotaMetricsRequest,ListConsumerQuotaMetricsResponse,ServiceUsageClient.ListConsumerQuotaMetricsPagedResponse> listConsumerQuotaMetricsSettings()

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

Returns
Type Description
PagedCallSettings<ListConsumerQuotaMetricsRequest,ListConsumerQuotaMetricsResponse,ListConsumerQuotaMetricsPagedResponse>

listServicesSettings() (deprecated)

public PagedCallSettings<ListServicesRequest,ListServicesResponse,ServiceUsageClient.ListServicesPagedResponse> listServicesSettings()

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 listServices.

Returns
Type Description
PagedCallSettings<ListServicesRequest,ListServicesResponse,ListServicesPagedResponse>

toBuilder()

public ServiceUsageSettings.Builder toBuilder()

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

Returns
Type Description
ServiceUsageSettings.Builder
Overrides

updateAdminOverrideOperationSettings()

public OperationCallSettings<UpdateAdminOverrideRequest,QuotaOverride,OperationMetadata> updateAdminOverrideOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateAdminOverrideRequest,QuotaOverride,OperationMetadata>

updateAdminOverrideSettings()

public UnaryCallSettings<UpdateAdminOverrideRequest,Operation> updateAdminOverrideSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateAdminOverrideRequest,Operation>

updateConsumerOverrideOperationSettings()

public OperationCallSettings<UpdateConsumerOverrideRequest,QuotaOverride,OperationMetadata> updateConsumerOverrideOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateConsumerOverrideRequest,QuotaOverride,OperationMetadata>

updateConsumerOverrideSettings()

public UnaryCallSettings<UpdateConsumerOverrideRequest,Operation> updateConsumerOverrideSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateConsumerOverrideRequest,Operation>