Class ServiceUsageStubSettings (2.57.0)

publicclass ServiceUsageStubSettingsextendsStubSettings<ServiceUsageStubSettings>

Settings class to configure an instance of ServiceUsageStub.

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
ServiceUsageStubSettings.BuilderserviceUsageSettingsBuilder=
ServiceUsageStubSettings.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());
ServiceUsageStubSettingsserviceUsageSettings=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
ServiceUsageStubSettings.BuilderserviceUsageSettingsBuilder=
ServiceUsageStubSettings.newBuilder();
TimedRetryAlgorithmtimedRetryAlgorithm=
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
serviceUsageSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();

Inheritance

java.lang.Object > StubSettings > ServiceUsageStubSettings

Inherited Members

Static Methods

defaultApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultCredentialsProviderBuilder()

publicstaticGoogleCredentialsProvider.BuilderdefaultCredentialsProviderBuilder()

Returns a builder for the default credentials for this service.

Returns
Type Description
Builder

defaultExecutorProviderBuilder()

publicstaticInstantiatingExecutorProvider.BuilderdefaultExecutorProviderBuilder()

Returns a builder for the default ExecutorProvider for this service.

Returns
Type Description
Builder

defaultGrpcApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultGrpcApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultGrpcTransportProviderBuilder()

publicstaticInstantiatingGrpcChannelProvider.BuilderdefaultGrpcTransportProviderBuilder()

Returns a builder for the default gRPC ChannelProvider for this service.

Returns
Type Description
Builder

defaultHttpJsonApiClientHeaderProviderBuilder()

publicstaticApiClientHeaderProvider.BuilderdefaultHttpJsonApiClientHeaderProviderBuilder()
Returns
Type Description
Builder

defaultHttpJsonTransportProviderBuilder()

publicstaticInstantiatingHttpJsonChannelProvider.BuilderdefaultHttpJsonTransportProviderBuilder()

Returns a builder for the default REST ChannelProvider for this service.

Returns
Type Description
Builder

defaultTransportChannelProvider()

publicstaticTransportChannelProviderdefaultTransportChannelProvider()
Returns
Type Description
TransportChannelProvider

getDefaultEndpoint()

publicstaticStringgetDefaultEndpoint()

Returns the default service endpoint.

Returns
Type Description
String

getDefaultMtlsEndpoint()

publicstaticStringgetDefaultMtlsEndpoint()

Returns the default mTLS service endpoint.

Returns
Type Description
String

getDefaultServiceScopes()

publicstaticList<String>getDefaultServiceScopes()

Returns the default service scopes.

Returns
Type Description
List<String>

newBuilder()

publicstaticServiceUsageStubSettings.BuildernewBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
ServiceUsageStubSettings.Builder

newBuilder(ClientContext clientContext)

publicstaticServiceUsageStubSettings.BuildernewBuilder(ClientContextclientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ServiceUsageStubSettings.Builder

newHttpJsonBuilder()

publicstaticServiceUsageStubSettings.BuildernewHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
ServiceUsageStubSettings.Builder

Constructors

ServiceUsageStubSettings(ServiceUsageStubSettings.Builder settingsBuilder)

protectedServiceUsageStubSettings(ServiceUsageStubSettings.BuildersettingsBuilder)
Parameter
Name Description
settingsBuilder ServiceUsageStubSettings.Builder

Methods

batchEnableServicesOperationSettings()

publicOperationCallSettings<BatchEnableServicesRequest,BatchEnableServicesResponse,OperationMetadata>batchEnableServicesOperationSettings()

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

Returns
Type Description
OperationCallSettings<BatchEnableServicesRequest,BatchEnableServicesResponse,OperationMetadata>

batchEnableServicesSettings()

publicUnaryCallSettings<BatchEnableServicesRequest,Operation>batchEnableServicesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchEnableServicesRequest,Operation>

batchGetServicesSettings()

publicUnaryCallSettings<BatchGetServicesRequest,BatchGetServicesResponse>batchGetServicesSettings()

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

Returns
Type Description
UnaryCallSettings<BatchGetServicesRequest,BatchGetServicesResponse>

createStub()

publicServiceUsageStubcreateStub()
Returns
Type Description
ServiceUsageStub
Exceptions
Type Description
IOException

disableServiceOperationSettings()

publicOperationCallSettings<DisableServiceRequest,DisableServiceResponse,OperationMetadata>disableServiceOperationSettings()

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

Returns
Type Description
OperationCallSettings<DisableServiceRequest,DisableServiceResponse,OperationMetadata>

disableServiceSettings()

publicUnaryCallSettings<DisableServiceRequest,Operation>disableServiceSettings()

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

Returns
Type Description
UnaryCallSettings<DisableServiceRequest,Operation>

enableServiceOperationSettings()

publicOperationCallSettings<EnableServiceRequest,EnableServiceResponse,OperationMetadata>enableServiceOperationSettings()

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

Returns
Type Description
OperationCallSettings<EnableServiceRequest,EnableServiceResponse,OperationMetadata>

enableServiceSettings()

publicUnaryCallSettings<EnableServiceRequest,Operation>enableServiceSettings()

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

Returns
Type Description
UnaryCallSettings<EnableServiceRequest,Operation>

getServiceName()

publicStringgetServiceName()

Returns the default service name.

Returns
Type Description
String
Overrides

getServiceSettings()

publicUnaryCallSettings<GetServiceRequest,Service>getServiceSettings()

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

Returns
Type Description
UnaryCallSettings<GetServiceRequest,Service>

listServicesSettings()

publicPagedCallSettings<ListServicesRequest,ListServicesResponse,ServiceUsageClient.ListServicesPagedResponse>listServicesSettings()

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

Returns
Type Description
PagedCallSettings<ListServicesRequest,ListServicesResponse,ListServicesPagedResponse>

toBuilder()

publicServiceUsageStubSettings.BuildertoBuilder()

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

Returns
Type Description
ServiceUsageStubSettings.Builder
Overrides

Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025年11月19日 UTC.