Class LicenseManagerSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<LicenseManagerSettings>
com.google.cloud.licensemanager.v1.LicenseManagerSettings
@Generated("by gapic-generator-java")
public class LicenseManagerSettings
extends ClientSettings<LicenseManagerSettings>
Settings class to configure an instance of
LicenseManagerClient.
The default instance has everything set to sensible defaults:
- The default service address (licensemanager.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 getConfiguration:
// 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
LicenseManagerSettings.Builder licenseManagerSettingsBuilder =
LicenseManagerSettings.newBuilder();
licenseManagerSettingsBuilder
.getConfigurationSettings()
.setRetrySettings(
licenseManagerSettingsBuilder
.getConfigurationSettings()
.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());
LicenseManagerSettings licenseManagerSettings = licenseManagerSettingsBuilder.build();
Please refer to the [Client Side Retry
Guide](https://docs.cloud.google.com/java/docs/client-retries) 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 createConfiguration:
// 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
LicenseManagerSettings.Builder licenseManagerSettingsBuilder =
LicenseManagerSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
licenseManagerSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for LicenseManagerSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedLicenseManagerSettings(LicenseManagerSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionPagedCallSettings<AggregateUsageRequest,AggregateUsageResponse, LicenseManagerClient.AggregateUsagePagedResponse> Returns the object with the settings used for calls to aggregateUsage.static final LicenseManagerSettingsReturns the object with the settings used for calls to createConfiguration.Returns the object with the settings used for calls to createConfiguration.Returns the object with the settings used for calls to deactivateConfiguration.Returns the object with the settings used for calls to deactivateConfiguration.Returns a builder for the default credentials for this service.Returns a builder for the default ExecutorProvider for this service.Returns a builder for the default gRPC ChannelProvider for this service.Returns a builder for the default REST ChannelProvider for this service.static TransportChannelProviderOperationCallSettings<DeleteConfigurationRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteConfiguration.Returns the object with the settings used for calls to deleteConfiguration.Returns the object with the settings used for calls to getConfiguration.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getInstance.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getProduct.PagedCallSettings<ListConfigurationsRequest,ListConfigurationsResponse, LicenseManagerClient.ListConfigurationsPagedResponse> Returns the object with the settings used for calls to listConfigurations.PagedCallSettings<ListInstancesRequest,ListInstancesResponse, LicenseManagerClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, LicenseManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.PagedCallSettings<ListProductsRequest,ListProductsResponse, LicenseManagerClient.ListProductsPagedResponse> Returns the object with the settings used for calls to listProducts.Returns a new gRPC builder for this class.newBuilder(ClientContext clientContext) Returns a new builder for this class.Returns a new REST builder for this class.Returns the object with the settings used for calls to queryConfigurationLicenseUsage.Returns the object with the settings used for calls to reactivateConfiguration.Returns the object with the settings used for calls to reactivateConfiguration.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateConfiguration.Returns the object with the settings used for calls to updateConfiguration.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
-
Constructor Details
-
LicenseManagerSettings
- Throws:
IOException
-
-
Method Details
-
listConfigurationsSettings
public PagedCallSettings<ListConfigurationsRequest,ListConfigurationsResponse, listConfigurationsSettings()LicenseManagerClient.ListConfigurationsPagedResponse> Returns the object with the settings used for calls to listConfigurations. -
getConfigurationSettings
Returns the object with the settings used for calls to getConfiguration. -
createConfigurationSettings
Returns the object with the settings used for calls to createConfiguration. -
createConfigurationOperationSettings
public OperationCallSettings<CreateConfigurationRequest,Configuration, createConfigurationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createConfiguration. -
updateConfigurationSettings
Returns the object with the settings used for calls to updateConfiguration. -
updateConfigurationOperationSettings
public OperationCallSettings<UpdateConfigurationRequest,Configuration, updateConfigurationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateConfiguration. -
deleteConfigurationSettings
Returns the object with the settings used for calls to deleteConfiguration. -
deleteConfigurationOperationSettings
public OperationCallSettings<DeleteConfigurationRequest,com.google.protobuf.Empty, deleteConfigurationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteConfiguration. -
listInstancesSettings
public PagedCallSettings<ListInstancesRequest,ListInstancesResponse, listInstancesSettings()LicenseManagerClient.ListInstancesPagedResponse> Returns the object with the settings used for calls to listInstances. -
getInstanceSettings
Returns the object with the settings used for calls to getInstance. -
deactivateConfigurationSettings
public UnaryCallSettings<DeactivateConfigurationRequest,Operation> deactivateConfigurationSettings()Returns the object with the settings used for calls to deactivateConfiguration. -
deactivateConfigurationOperationSettings
public OperationCallSettings<DeactivateConfigurationRequest,Configuration, deactivateConfigurationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deactivateConfiguration. -
reactivateConfigurationSettings
public UnaryCallSettings<ReactivateConfigurationRequest,Operation> reactivateConfigurationSettings()Returns the object with the settings used for calls to reactivateConfiguration. -
reactivateConfigurationOperationSettings
public OperationCallSettings<ReactivateConfigurationRequest,Configuration, reactivateConfigurationOperationSettings()OperationMetadata> Returns the object with the settings used for calls to reactivateConfiguration. -
queryConfigurationLicenseUsageSettings
public UnaryCallSettings<QueryConfigurationLicenseUsageRequest,QueryConfigurationLicenseUsageResponse> queryConfigurationLicenseUsageSettings()Returns the object with the settings used for calls to queryConfigurationLicenseUsage. -
aggregateUsageSettings
public PagedCallSettings<AggregateUsageRequest,AggregateUsageResponse, aggregateUsageSettings()LicenseManagerClient.AggregateUsagePagedResponse> Returns the object with the settings used for calls to aggregateUsage. -
listProductsSettings
public PagedCallSettings<ListProductsRequest,ListProductsResponse, listProductsSettings()LicenseManagerClient.ListProductsPagedResponse> Returns the object with the settings used for calls to listProducts. -
getProductSettings
Returns the object with the settings used for calls to getProduct. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()LicenseManagerClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
create
public static final LicenseManagerSettings create(LicenseManagerStubSettings stub) throws IOException - Throws:
IOException
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultServiceScopes
Returns the default service scopes. -
defaultCredentialsProviderBuilder
Returns a builder for the default credentials for this service. -
defaultGrpcTransportProviderBuilder
Returns a builder for the default gRPC ChannelProvider for this service. -
defaultHttpJsonTransportProviderBuilder
@BetaApi public static InstantiatingHttpJsonChannelProvider.Builder defaultHttpJsonTransportProviderBuilder()Returns a builder for the default REST ChannelProvider for this service. -
defaultTransportChannelProvider
-
defaultApiClientHeaderProviderBuilder
-
newBuilder
Returns a new gRPC builder for this class. -
newHttpJsonBuilder
Returns a new REST builder for this class. -
newBuilder
Returns a new builder for this class. -
toBuilder
Returns a builder containing all the values of this settings class.- Specified by:
toBuilderin classClientSettings<LicenseManagerSettings>
-