Package com.google.cloud.managedkafka.v1
Class ManagedKafkaConnectSettings
java.lang.Object
com.google.api.gax.rpc.ClientSettings<ManagedKafkaConnectSettings>
com.google.cloud.managedkafka.v1.ManagedKafkaConnectSettings
@Generated("by gapic-generator-java")
public class ManagedKafkaConnectSettings
extends ClientSettings<ManagedKafkaConnectSettings>
Settings class to configure an instance of
ManagedKafkaConnectClient.
The default instance has everything set to sensible defaults:
- The default service address (managedkafka.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 getConnectCluster:
// 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
ManagedKafkaConnectSettings.Builder managedKafkaConnectSettingsBuilder =
ManagedKafkaConnectSettings.newBuilder();
managedKafkaConnectSettingsBuilder
.getConnectClusterSettings()
.setRetrySettings(
managedKafkaConnectSettingsBuilder
.getConnectClusterSettings()
.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());
ManagedKafkaConnectSettings managedKafkaConnectSettings =
managedKafkaConnectSettingsBuilder.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 createConnectCluster:
// 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
ManagedKafkaConnectSettings.Builder managedKafkaConnectSettingsBuilder =
ManagedKafkaConnectSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
managedKafkaConnectSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ManagedKafkaConnectSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedManagedKafkaConnectSettings(ManagedKafkaConnectSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionstatic final ManagedKafkaConnectSettingsReturns the object with the settings used for calls to createConnectCluster.Returns the object with the settings used for calls to createConnectCluster.Returns the object with the settings used for calls to createConnector.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<DeleteConnectClusterRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteConnectCluster.Returns the object with the settings used for calls to deleteConnectCluster.UnaryCallSettings<DeleteConnectorRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteConnector.Returns the object with the settings used for calls to getConnectCluster.Returns the object with the settings used for calls to getConnector.static StringReturns the default service endpoint.Returns the default service scopes.Returns the object with the settings used for calls to getLocation.PagedCallSettings<ListConnectClustersRequest,ListConnectClustersResponse, ManagedKafkaConnectClient.ListConnectClustersPagedResponse> Returns the object with the settings used for calls to listConnectClusters.PagedCallSettings<ListConnectorsRequest,ListConnectorsResponse, ManagedKafkaConnectClient.ListConnectorsPagedResponse> Returns the object with the settings used for calls to listConnectors.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ManagedKafkaConnectClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.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 pauseConnector.Returns the object with the settings used for calls to restartConnector.Returns the object with the settings used for calls to resumeConnector.Returns the object with the settings used for calls to stopConnector.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateConnectCluster.Returns the object with the settings used for calls to updateConnectCluster.Returns the object with the settings used for calls to updateConnector.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
-
ManagedKafkaConnectSettings
protected ManagedKafkaConnectSettings(ManagedKafkaConnectSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listConnectClustersSettings
public PagedCallSettings<ListConnectClustersRequest,ListConnectClustersResponse, listConnectClustersSettings()ManagedKafkaConnectClient.ListConnectClustersPagedResponse> Returns the object with the settings used for calls to listConnectClusters. -
getConnectClusterSettings
Returns the object with the settings used for calls to getConnectCluster. -
createConnectClusterSettings
Returns the object with the settings used for calls to createConnectCluster. -
createConnectClusterOperationSettings
public OperationCallSettings<CreateConnectClusterRequest,ConnectCluster, createConnectClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createConnectCluster. -
updateConnectClusterSettings
Returns the object with the settings used for calls to updateConnectCluster. -
updateConnectClusterOperationSettings
public OperationCallSettings<UpdateConnectClusterRequest,ConnectCluster, updateConnectClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateConnectCluster. -
deleteConnectClusterSettings
Returns the object with the settings used for calls to deleteConnectCluster. -
deleteConnectClusterOperationSettings
public OperationCallSettings<DeleteConnectClusterRequest,com.google.protobuf.Empty, deleteConnectClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteConnectCluster. -
listConnectorsSettings
public PagedCallSettings<ListConnectorsRequest,ListConnectorsResponse, listConnectorsSettings()ManagedKafkaConnectClient.ListConnectorsPagedResponse> Returns the object with the settings used for calls to listConnectors. -
getConnectorSettings
Returns the object with the settings used for calls to getConnector. -
createConnectorSettings
Returns the object with the settings used for calls to createConnector. -
updateConnectorSettings
Returns the object with the settings used for calls to updateConnector. -
deleteConnectorSettings
public UnaryCallSettings<DeleteConnectorRequest,com.google.protobuf.Empty> deleteConnectorSettings()Returns the object with the settings used for calls to deleteConnector. -
pauseConnectorSettings
Returns the object with the settings used for calls to pauseConnector. -
resumeConnectorSettings
Returns the object with the settings used for calls to resumeConnector. -
restartConnectorSettings
public UnaryCallSettings<RestartConnectorRequest,RestartConnectorResponse> restartConnectorSettings()Returns the object with the settings used for calls to restartConnector. -
stopConnectorSettings
Returns the object with the settings used for calls to stopConnector. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ManagedKafkaConnectClient.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 ManagedKafkaConnectSettings create(ManagedKafkaConnectStubSettings 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<ManagedKafkaConnectSettings>
-