Class ManagedKafkaStubSettings
java.lang.Object
com.google.api.gax.rpc.StubSettings<ManagedKafkaStubSettings>
com.google.cloud.managedkafka.v1.stub.ManagedKafkaStubSettings
@Generated("by gapic-generator-java")
public class ManagedKafkaStubSettings
extends StubSettings<ManagedKafkaStubSettings>
Settings class to configure an instance of
ManagedKafkaStub.
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 getCluster:
// 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
ManagedKafkaStubSettings.Builder managedKafkaSettingsBuilder =
ManagedKafkaStubSettings.newBuilder();
managedKafkaSettingsBuilder
.getClusterSettings()
.setRetrySettings(
managedKafkaSettingsBuilder
.getClusterSettings()
.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());
ManagedKafkaStubSettings managedKafkaSettings = managedKafkaSettingsBuilder.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 createCluster:
// 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
ManagedKafkaStubSettings.Builder managedKafkaSettingsBuilder =
ManagedKafkaStubSettings.newBuilder();
TimedRetryAlgorithm timedRetryAlgorithm =
OperationalTimedPollAlgorithm.create(
RetrySettings.newBuilder()
.setInitialRetryDelayDuration(Duration.ofMillis(500))
.setRetryDelayMultiplier(1.5)
.setMaxRetryDelayDuration(Duration.ofMillis(5000))
.setTotalTimeoutDuration(Duration.ofHours(24))
.build());
managedKafkaSettingsBuilder
.createClusterOperationSettings()
.setPollingAlgorithm(timedRetryAlgorithm)
.build();
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic classBuilder for ManagedKafkaStubSettings. -
Constructor Summary
ConstructorsModifierConstructorDescriptionprotectedManagedKafkaStubSettings(ManagedKafkaStubSettings.Builder settingsBuilder) -
Method Summary
Modifier and TypeMethodDescriptionReturns the object with the settings used for calls to addAclEntry.Returns the object with the settings used for calls to createAcl.Returns the object with the settings used for calls to createCluster.Returns the object with the settings used for calls to createCluster.Returns the object with the settings used for calls to createTopic.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 TransportChannelProviderUnaryCallSettings<DeleteAclRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteAcl.OperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty, OperationMetadata> Returns the object with the settings used for calls to deleteCluster.Returns the object with the settings used for calls to deleteCluster.UnaryCallSettings<DeleteConsumerGroupRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteConsumerGroup.UnaryCallSettings<DeleteTopicRequest,com.google.protobuf.Empty> Returns the object with the settings used for calls to deleteTopic.Returns the object with the settings used for calls to getAcl.Returns the object with the settings used for calls to getCluster.Returns the object with the settings used for calls to getConsumerGroup.static StringReturns the default service endpoint.static StringReturns the default mTLS service endpoint.Returns the default service scopes.protected LibraryMetadataReturns the object with the settings used for calls to getLocation.Returns the default service name.Returns the object with the settings used for calls to getTopic.Returns the object with the settings used for calls to listAcls.PagedCallSettings<ListClustersRequest,ListClustersResponse, ManagedKafkaClient.ListClustersPagedResponse> Returns the object with the settings used for calls to listClusters.PagedCallSettings<ListConsumerGroupsRequest,ListConsumerGroupsResponse, ManagedKafkaClient.ListConsumerGroupsPagedResponse> Returns the object with the settings used for calls to listConsumerGroups.PagedCallSettings<ListLocationsRequest,ListLocationsResponse, ManagedKafkaClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations.Returns the object with the settings used for calls to listTopics.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 removeAclEntry.Returns a builder containing all the values of this settings class.Returns the object with the settings used for calls to updateAcl.Returns the object with the settings used for calls to updateCluster.Returns the object with the settings used for calls to updateCluster.Returns the object with the settings used for calls to updateConsumerGroup.Returns the object with the settings used for calls to updateTopic.Methods inherited from class com.google.api.gax.rpc.StubSettings
getApiKey, getBackgroundExecutorProvider, getClock, getCredentialsProvider, getEndpoint, getExecutorProvider, getGdchApiAudience, getHeaderProvider, getInternalHeaderProvider, getMtlsEndpoint, getQuotaProjectId, getStreamWatchdogCheckInterval, getStreamWatchdogCheckIntervalDuration, getStreamWatchdogProvider, getTracerFactory, getTransportChannelProvider, getUniverseDomain, toString
-
Constructor Details
-
ManagedKafkaStubSettings
protected ManagedKafkaStubSettings(ManagedKafkaStubSettings.Builder settingsBuilder) throws IOException - Throws:
IOException
-
-
Method Details
-
listClustersSettings
public PagedCallSettings<ListClustersRequest,ListClustersResponse, listClustersSettings()ManagedKafkaClient.ListClustersPagedResponse> Returns the object with the settings used for calls to listClusters. -
getClusterSettings
Returns the object with the settings used for calls to getCluster. -
createClusterSettings
Returns the object with the settings used for calls to createCluster. -
createClusterOperationSettings
public OperationCallSettings<CreateClusterRequest,Cluster, createClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to createCluster. -
updateClusterSettings
Returns the object with the settings used for calls to updateCluster. -
updateClusterOperationSettings
public OperationCallSettings<UpdateClusterRequest,Cluster, updateClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to updateCluster. -
deleteClusterSettings
Returns the object with the settings used for calls to deleteCluster. -
deleteClusterOperationSettings
public OperationCallSettings<DeleteClusterRequest,com.google.protobuf.Empty, deleteClusterOperationSettings()OperationMetadata> Returns the object with the settings used for calls to deleteCluster. -
listTopicsSettings
public PagedCallSettings<ListTopicsRequest,ListTopicsResponse, listTopicsSettings()ManagedKafkaClient.ListTopicsPagedResponse> Returns the object with the settings used for calls to listTopics. -
getTopicSettings
Returns the object with the settings used for calls to getTopic. -
createTopicSettings
Returns the object with the settings used for calls to createTopic. -
updateTopicSettings
Returns the object with the settings used for calls to updateTopic. -
deleteTopicSettings
Returns the object with the settings used for calls to deleteTopic. -
listConsumerGroupsSettings
public PagedCallSettings<ListConsumerGroupsRequest,ListConsumerGroupsResponse, listConsumerGroupsSettings()ManagedKafkaClient.ListConsumerGroupsPagedResponse> Returns the object with the settings used for calls to listConsumerGroups. -
getConsumerGroupSettings
Returns the object with the settings used for calls to getConsumerGroup. -
updateConsumerGroupSettings
Returns the object with the settings used for calls to updateConsumerGroup. -
deleteConsumerGroupSettings
public UnaryCallSettings<DeleteConsumerGroupRequest,com.google.protobuf.Empty> deleteConsumerGroupSettings()Returns the object with the settings used for calls to deleteConsumerGroup. -
listAclsSettings
public PagedCallSettings<ListAclsRequest,ListAclsResponse, listAclsSettings()ManagedKafkaClient.ListAclsPagedResponse> Returns the object with the settings used for calls to listAcls. -
getAclSettings
Returns the object with the settings used for calls to getAcl. -
createAclSettings
Returns the object with the settings used for calls to createAcl. -
updateAclSettings
Returns the object with the settings used for calls to updateAcl. -
deleteAclSettings
Returns the object with the settings used for calls to deleteAcl. -
addAclEntrySettings
Returns the object with the settings used for calls to addAclEntry. -
removeAclEntrySettings
Returns the object with the settings used for calls to removeAclEntry. -
listLocationsSettings
public PagedCallSettings<ListLocationsRequest,ListLocationsResponse, listLocationsSettings()ManagedKafkaClient.ListLocationsPagedResponse> Returns the object with the settings used for calls to listLocations. -
getLocationSettings
Returns the object with the settings used for calls to getLocation. -
createStub
- Throws:
IOException
-
getServiceName
Returns the default service name.- Overrides:
getServiceNamein classStubSettings<ManagedKafkaStubSettings>
-
defaultExecutorProviderBuilder
Returns a builder for the default ExecutorProvider for this service. -
getDefaultEndpoint
Returns the default service endpoint. -
getDefaultMtlsEndpoint
Returns the default mTLS 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
-
defaultGrpcApiClientHeaderProviderBuilder
-
defaultHttpJsonApiClientHeaderProviderBuilder
-
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 classStubSettings<ManagedKafkaStubSettings>
-
getLibraryMetadata
- Overrides:
getLibraryMetadatain classStubSettings<ManagedKafkaStubSettings>
-