Package com.google.cloud.config.v1
Class ConfigSettings
@Generated("by gapic-generator-java")
public class ConfigSettings
extends ClientSettings<ConfigSettings>
Settings class to configure an instance of
ConfigClient.
The default instance has everything set to sensible defaults:
- The default service address (config.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 getDeployment:
// 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
ConfigSettings.Builder configSettingsBuilder = ConfigSettings.newBuilder();
configSettingsBuilder
.getDeploymentSettings()
.setRetrySettings(
configSettingsBuilder
.getDeploymentSettings()
.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());
ConfigSettings configSettings = configSettingsBuilder.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 createDeployment:
// 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
ConfigSettings.Builder configSettingsBuilder = ConfigSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
configSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested Classes -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionstatic final ConfigSettingscreate(ConfigStubSettings stub) Returns the object with the settings used for calls to createDeploymentGroup.Returns the object with the settings used for calls to createDeploymentGroup.Returns the object with the settings used for calls to createDeployment.Returns the object with the settings used for calls to createDeployment.Returns the object with the settings used for calls to createPreview.Returns the object with the settings used for calls to createPreview.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 TransportChannelProviderReturns the object with the settings used for calls to deleteDeploymentGroup.Returns the object with the settings used for calls to deleteDeploymentGroup.Returns the object with the settings used for calls to deleteDeployment.Returns the object with the settings used for calls to deleteDeployment.Returns the object with the settings used for calls to deletePreview.Returns the object with the settings used for calls to deletePreview.UnaryCallSettings<DeleteStatefileRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteStatefile.Returns the object with the settings used for calls to deprovisionDeploymentGroup.Returns the object with the settings used for calls to deprovisionDeploymentGroup.Returns the object with the settings used for calls to exportDeploymentStatefile.Returns the object with the settings used for calls to exportLockInfo.Returns the object with the settings used for calls to exportPreviewResult.Returns the object with the settings used for calls to exportRevisionStatefile.Returns the object with the settings used for calls to getAutoMigrationConfig.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getDeploymentGroupRevision.Returns the object with the settings used for calls to getDeploymentGroup.Returns the object with the settings used for calls to getDeployment.Returns the object with the settings used for calls to getIamPolicy.Returns the object with the settings used for calls to getLocation.Returns the object with the settings used for calls to getPreview.Returns the object with the settings used for calls to getResourceChange.Returns the object with the settings used for calls to getResourceDrift.Returns the object with the settings used for calls to getResource.Returns the object with the settings used for calls to getRevision.Returns the object with the settings used for calls to getTerraformVersion.Returns the object with the settings used for calls to importStatefile.PagedCallSettings<ListDeploymentGroupRevisionsRequest,ListDeploymentGroupRevisionsResponse, ConfigClient.ListDeploymentGroupRevisionsPagedResponse> Returns the object with the settings used for calls to listDeploymentGroupRevisions.PagedCallSettings<ListDeploymentGroupsRequest,ListDeploymentGroupsResponse, ConfigClient.ListDeploymentGroupsPagedResponse> Returns the object with the settings used for calls to listDeploymentGroups.PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse, ConfigClient.ListDeploymentsPagedResponse> Returns the object with the settings used for calls to listDeployments.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ConfigClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to listPreviews.PagedCallSettings<ListResourceChangesRequest,ListResourceChangesResponse, ConfigClient.ListResourceChangesPagedResponse> Returns the object with the settings used for calls to listResourceChanges.PagedCallSettings<ListResourceDriftsRequest,ListResourceDriftsResponse, ConfigClient.ListResourceDriftsPagedResponse> Returns the object with the settings used for calls to listResourceDrifts.PagedCallSettings<ListResourcesRequest,ListResourcesResponse, ConfigClient.ListResourcesPagedResponse> Returns the object with the settings used for calls to listResources.PagedCallSettings<ListRevisionsRequest,ListRevisionsResponse, ConfigClient.ListRevisionsPagedResponse> Returns the object with the settings used for calls to listRevisions.PagedCallSettings<ListTerraformVersionsRequest,ListTerraformVersionsResponse, ConfigClient.ListTerraformVersionsPagedResponse> Returns the object with the settings used for calls to listTerraformVersions.Returns the object with the settings used for calls to lockDeployment.Returns the object with the settings used for calls to lockDeployment.static ConfigSettings.BuilderReturns a new gRPC builder for this class.static ConfigSettings.BuildernewBuilder(ClientContext clientContext) Returns a new builder for this class.static ConfigSettings.BuilderReturns a new REST builder for this class.Returns the object with the settings used for calls to provisionDeploymentGroup.Returns the object with the settings used for calls to provisionDeploymentGroup.Returns the object with the settings used for calls to setIamPolicy.Returns the object with the settings used for calls to testIamPermissions.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to unlockDeployment.Returns the object with the settings used for calls to unlockDeployment.Returns the object with the settings used for calls to updateAutoMigrationConfig.Returns the object with the settings used for calls to updateAutoMigrationConfig.Returns the object with the settings used for calls to updateDeploymentGroup.Returns the object with the settings used for calls to updateDeploymentGroup.Returns the object with the settings used for calls to updateDeployment.Returns the object with the settings used for calls to updateDeployment.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
-
ConfigSettings
- Throws:
IOException
-
-
Method Details
-
listDeploymentsSettings
public PagedCallSettings<ListDeploymentsRequest,ListDeploymentsResponse, listDeploymentsSettings()ConfigClient.ListDeploymentsPagedResponse> Returns the object with the settings used for calls to listDeployments. -
getDeploymentSettings
Returns the object with the settings used for calls to getDeployment. -
createDeploymentSettings
Returns the object with the settings used for calls to createDeployment. -
createDeploymentOperationSettings
public OperationCallSettings<CreateDeploymentRequest,Deployment, createDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createDeployment. -
updateDeploymentSettings
Returns the object with the settings used for calls to updateDeployment. -
updateDeploymentOperationSettings
public OperationCallSettings<UpdateDeploymentRequest,Deployment, updateDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDeployment. -
deleteDeploymentSettings
Returns the object with the settings used for calls to deleteDeployment. -
deleteDeploymentOperationSettings
public OperationCallSettings<DeleteDeploymentRequest,Deployment, deleteDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteDeployment. -
listRevisionsSettings
public PagedCallSettings<ListRevisionsRequest,ListRevisionsResponse, listRevisionsSettings()ConfigClient.ListRevisionsPagedResponse> Returns the object with the settings used for calls to listRevisions. -
getRevisionSettings
Returns the object with the settings used for calls to getRevision. -
getResourceSettings
Returns the object with the settings used for calls to getResource. -
listResourcesSettings
public PagedCallSettings<ListResourcesRequest,ListResourcesResponse, listResourcesSettings()ConfigClient.ListResourcesPagedResponse> Returns the object with the settings used for calls to listResources. -
exportDeploymentStatefileSettings
public UnaryCallSettings<ExportDeploymentStatefileRequest,Statefile> exportDeploymentStatefileSettings()Returns the object with the settings used for calls to exportDeploymentStatefile. -
exportRevisionStatefileSettings
public UnaryCallSettings<ExportRevisionStatefileRequest,Statefile> exportRevisionStatefileSettings()Returns the object with the settings used for calls to exportRevisionStatefile. -
importStatefileSettings
Returns the object with the settings used for calls to importStatefile. -
deleteStatefileSettings
public UnaryCallSettings<DeleteStatefileRequest,com.google.protobuf.Empty> deleteStatefileSettings()Returns the object with the settings used for calls to deleteStatefile. -
lockDeploymentSettings
Returns the object with the settings used for calls to lockDeployment. -
lockDeploymentOperationSettings
public OperationCallSettings<LockDeploymentRequest,Deployment, lockDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to lockDeployment. -
unlockDeploymentSettings
Returns the object with the settings used for calls to unlockDeployment. -
unlockDeploymentOperationSettings
public OperationCallSettings<UnlockDeploymentRequest,Deployment, unlockDeploymentOperationSettings()OperationMetadata> Returns the object with the settings used for calls to unlockDeployment. -
exportLockInfoSettings
Returns the object with the settings used for calls to exportLockInfo. -
createPreviewSettings
Returns the object with the settings used for calls to createPreview. -
createPreviewOperationSettings
public OperationCallSettings<CreatePreviewRequest,Preview, createPreviewOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createPreview. -
getPreviewSettings
Returns the object with the settings used for calls to getPreview. -
listPreviewsSettings
public PagedCallSettings<ListPreviewsRequest,ListPreviewsResponse, listPreviewsSettings()ConfigClient.ListPreviewsPagedResponse> Returns the object with the settings used for calls to listPreviews. -
deletePreviewSettings
Returns the object with the settings used for calls to deletePreview. -
deletePreviewOperationSettings
public OperationCallSettings<DeletePreviewRequest,Preview, deletePreviewOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deletePreview. -
exportPreviewResultSettings
public UnaryCallSettings<ExportPreviewResultRequest,ExportPreviewResultResponse> exportPreviewResultSettings()Returns the object with the settings used for calls to exportPreviewResult. -
listTerraformVersionsSettings
public PagedCallSettings<ListTerraformVersionsRequest,ListTerraformVersionsResponse, listTerraformVersionsSettings()ConfigClient.ListTerraformVersionsPagedResponse> Returns the object with the settings used for calls to listTerraformVersions. -
getTerraformVersionSettings
Returns the object with the settings used for calls to getTerraformVersion. -
listResourceChangesSettings
public PagedCallSettings<ListResourceChangesRequest,ListResourceChangesResponse, listResourceChangesSettings()ConfigClient.ListResourceChangesPagedResponse> Returns the object with the settings used for calls to listResourceChanges. -
getResourceChangeSettings
Returns the object with the settings used for calls to getResourceChange. -
listResourceDriftsSettings
public PagedCallSettings<ListResourceDriftsRequest,ListResourceDriftsResponse, listResourceDriftsSettings()ConfigClient.ListResourceDriftsPagedResponse> Returns the object with the settings used for calls to listResourceDrifts. -
getResourceDriftSettings
Returns the object with the settings used for calls to getResourceDrift. -
getAutoMigrationConfigSettings
public UnaryCallSettings<GetAutoMigrationConfigRequest,AutoMigrationConfig> getAutoMigrationConfigSettings()Returns the object with the settings used for calls to getAutoMigrationConfig. -
updateAutoMigrationConfigSettings
public UnaryCallSettings<UpdateAutoMigrationConfigRequest,Operation> updateAutoMigrationConfigSettings()Returns the object with the settings used for calls to updateAutoMigrationConfig. -
updateAutoMigrationConfigOperationSettings
public OperationCallSettings<UpdateAutoMigrationConfigRequest,AutoMigrationConfig, updateAutoMigrationConfigOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateAutoMigrationConfig. -
getDeploymentGroupSettings
Returns the object with the settings used for calls to getDeploymentGroup. -
createDeploymentGroupSettings
Returns the object with the settings used for calls to createDeploymentGroup. -
createDeploymentGroupOperationSettings
public OperationCallSettings<CreateDeploymentGroupRequest,DeploymentGroup, createDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createDeploymentGroup. -
updateDeploymentGroupSettings
Returns the object with the settings used for calls to updateDeploymentGroup. -
updateDeploymentGroupOperationSettings
public OperationCallSettings<UpdateDeploymentGroupRequest,DeploymentGroup, updateDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateDeploymentGroup. -
deleteDeploymentGroupSettings
Returns the object with the settings used for calls to deleteDeploymentGroup. -
deleteDeploymentGroupOperationSettings
public OperationCallSettings<DeleteDeploymentGroupRequest,DeploymentGroup, deleteDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteDeploymentGroup. -
listDeploymentGroupsSettings
public PagedCallSettings<ListDeploymentGroupsRequest,ListDeploymentGroupsResponse, listDeploymentGroupsSettings()ConfigClient.ListDeploymentGroupsPagedResponse> Returns the object with the settings used for calls to listDeploymentGroups. -
provisionDeploymentGroupSettings
public UnaryCallSettings<ProvisionDeploymentGroupRequest,Operation> provisionDeploymentGroupSettings()Returns the object with the settings used for calls to provisionDeploymentGroup. -
provisionDeploymentGroupOperationSettings
public OperationCallSettings<ProvisionDeploymentGroupRequest,DeploymentGroup, provisionDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to provisionDeploymentGroup. -
deprovisionDeploymentGroupSettings
public UnaryCallSettings<DeprovisionDeploymentGroupRequest,Operation> deprovisionDeploymentGroupSettings()Returns the object with the settings used for calls to deprovisionDeploymentGroup. -
deprovisionDeploymentGroupOperationSettings
public OperationCallSettings<DeprovisionDeploymentGroupRequest,DeploymentGroup, deprovisionDeploymentGroupOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deprovisionDeploymentGroup. -
getDeploymentGroupRevisionSettings
public UnaryCallSettings<GetDeploymentGroupRevisionRequest,DeploymentGroupRevision> getDeploymentGroupRevisionSettings()Returns the object with the settings used for calls to getDeploymentGroupRevision. -
listDeploymentGroupRevisionsSettings
public PagedCallSettings<ListDeploymentGroupRevisionsRequest,ListDeploymentGroupRevisionsResponse, listDeploymentGroupRevisionsSettings()ConfigClient.ListDeploymentGroupRevisionsPagedResponse> Returns the object with the settings used for calls to listDeploymentGroupRevisions. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ConfigClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
setIamPolicySettings
Returns the object with the settings used for calls to setIamPolicy. -
getIamPolicySettings
Returns the object with the settings used for calls to getIamPolicy. -
testIamPermissionsSettings
public UnaryCallSettings<TestIamPermissionsRequest,TestIamPermissionsResponse> testIamPermissionsSettings()Returns the object with the settings used for calls to testIamPermissions. -
create
- 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<ConfigSettings>
-