Class LicenseManagerSettings (0.5.0) 

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 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 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();

Inheritance

java.lang.Object > ClientSettings > LicenseManagerSettings

Static Methods

create(LicenseManagerStubSettings stub)

public static final LicenseManagerSettings create(LicenseManagerStubSettings stub)
Parameter
Name Description
stub LicenseManagerStubSettings
Returns
Type Description
LicenseManagerSettings
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 LicenseManagerSettings.Builder newBuilder()

Returns a new gRPC builder for this class.

Returns
Type Description
LicenseManagerSettings.Builder

newBuilder(ClientContext clientContext)

public static LicenseManagerSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
LicenseManagerSettings.Builder

newHttpJsonBuilder()

public static LicenseManagerSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
LicenseManagerSettings.Builder

Constructors

LicenseManagerSettings(LicenseManagerSettings.Builder settingsBuilder)

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

Methods

aggregateUsageSettings()

public PagedCallSettings<AggregateUsageRequest,AggregateUsageResponse,LicenseManagerClient.AggregateUsagePagedResponse> aggregateUsageSettings()

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

Returns
Type Description
PagedCallSettings<AggregateUsageRequest,AggregateUsageResponse,AggregateUsagePagedResponse>

createConfigurationOperationSettings()

public OperationCallSettings<CreateConfigurationRequest,Configuration,OperationMetadata> createConfigurationOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateConfigurationRequest,Configuration,OperationMetadata>

createConfigurationSettings()

public UnaryCallSettings<CreateConfigurationRequest,Operation> createConfigurationSettings()

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

Returns
Type Description
UnaryCallSettings<CreateConfigurationRequest,Operation>

deactivateConfigurationOperationSettings()

public OperationCallSettings<DeactivateConfigurationRequest,Configuration,OperationMetadata> deactivateConfigurationOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeactivateConfigurationRequest,Configuration,OperationMetadata>

deactivateConfigurationSettings()

public UnaryCallSettings<DeactivateConfigurationRequest,Operation> deactivateConfigurationSettings()

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

Returns
Type Description
UnaryCallSettings<DeactivateConfigurationRequest,Operation>

deleteConfigurationOperationSettings()

public OperationCallSettings<DeleteConfigurationRequest,Empty,OperationMetadata> deleteConfigurationOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteConfigurationRequest,Empty,OperationMetadata>

deleteConfigurationSettings()

public UnaryCallSettings<DeleteConfigurationRequest,Operation> deleteConfigurationSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteConfigurationRequest,Operation>

getConfigurationSettings()

public UnaryCallSettings<GetConfigurationRequest,Configuration> getConfigurationSettings()

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

Returns
Type Description
UnaryCallSettings<GetConfigurationRequest,Configuration>

getInstanceSettings()

public UnaryCallSettings<GetInstanceRequest,Instance> getInstanceSettings()

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

Returns
Type Description
UnaryCallSettings<GetInstanceRequest,Instance>

getLocationSettings()

public UnaryCallSettings<GetLocationRequest,Location> getLocationSettings()

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

Returns
Type Description
UnaryCallSettings<com.google.cloud.location.GetLocationRequest,com.google.cloud.location.Location>

getProductSettings()

public UnaryCallSettings<GetProductRequest,Product> getProductSettings()

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

Returns
Type Description
UnaryCallSettings<GetProductRequest,Product>

listConfigurationsSettings()

public PagedCallSettings<ListConfigurationsRequest,ListConfigurationsResponse,LicenseManagerClient.ListConfigurationsPagedResponse> listConfigurationsSettings()

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

Returns
Type Description
PagedCallSettings<ListConfigurationsRequest,ListConfigurationsResponse,ListConfigurationsPagedResponse>

listInstancesSettings()

public PagedCallSettings<ListInstancesRequest,ListInstancesResponse,LicenseManagerClient.ListInstancesPagedResponse> listInstancesSettings()

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

Returns
Type Description
PagedCallSettings<ListInstancesRequest,ListInstancesResponse,ListInstancesPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,LicenseManagerClient.ListLocationsPagedResponse> listLocationsSettings()

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

Returns
Type Description
PagedCallSettings<com.google.cloud.location.ListLocationsRequest,com.google.cloud.location.ListLocationsResponse,ListLocationsPagedResponse>

listProductsSettings()

public PagedCallSettings<ListProductsRequest,ListProductsResponse,LicenseManagerClient.ListProductsPagedResponse> listProductsSettings()

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

Returns
Type Description
PagedCallSettings<ListProductsRequest,ListProductsResponse,ListProductsPagedResponse>

queryConfigurationLicenseUsageSettings()

public UnaryCallSettings<QueryConfigurationLicenseUsageRequest,QueryConfigurationLicenseUsageResponse> queryConfigurationLicenseUsageSettings()

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

Returns
Type Description
UnaryCallSettings<QueryConfigurationLicenseUsageRequest,QueryConfigurationLicenseUsageResponse>

reactivateConfigurationOperationSettings()

public OperationCallSettings<ReactivateConfigurationRequest,Configuration,OperationMetadata> reactivateConfigurationOperationSettings()

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

Returns
Type Description
OperationCallSettings<ReactivateConfigurationRequest,Configuration,OperationMetadata>

reactivateConfigurationSettings()

public UnaryCallSettings<ReactivateConfigurationRequest,Operation> reactivateConfigurationSettings()

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

Returns
Type Description
UnaryCallSettings<ReactivateConfigurationRequest,Operation>

toBuilder()

public LicenseManagerSettings.Builder toBuilder()

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

Returns
Type Description
LicenseManagerSettings.Builder
Overrides

updateConfigurationOperationSettings()

public OperationCallSettings<UpdateConfigurationRequest,Configuration,OperationMetadata> updateConfigurationOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateConfigurationRequest,Configuration,OperationMetadata>

updateConfigurationSettings()

public UnaryCallSettings<UpdateConfigurationRequest,Operation> updateConfigurationSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateConfigurationRequest,Operation>