Class ManagedKafkaSettings (0.10.0) 

public class ManagedKafkaSettings extends ClientSettings<ManagedKafkaSettings>

Settings class to configure an instance of ManagedKafkaClient.

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 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
 ManagedKafkaSettings.Builder managedKafkaSettingsBuilder = ManagedKafkaSettings.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());
 ManagedKafkaSettings managedKafkaSettings = managedKafkaSettingsBuilder.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 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
 ManagedKafkaSettings.Builder managedKafkaSettingsBuilder = ManagedKafkaSettings.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();

Inheritance

java.lang.Object > ClientSettings > ManagedKafkaSettings

Static Methods

create(ManagedKafkaStubSettings stub)

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

Returns a new gRPC builder for this class.

Returns
Type Description
ManagedKafkaSettings.Builder

newBuilder(ClientContext clientContext)

public static ManagedKafkaSettings.Builder newBuilder(ClientContext clientContext)

Returns a new builder for this class.

Parameter
Name Description
clientContext ClientContext
Returns
Type Description
ManagedKafkaSettings.Builder

newHttpJsonBuilder()

public static ManagedKafkaSettings.Builder newHttpJsonBuilder()

Returns a new REST builder for this class.

Returns
Type Description
ManagedKafkaSettings.Builder

Constructors

ManagedKafkaSettings(ManagedKafkaSettings.Builder settingsBuilder)

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

Methods

createClusterOperationSettings()

public OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationSettings()

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

Returns
Type Description
OperationCallSettings<CreateClusterRequest,Cluster,OperationMetadata>

createClusterSettings()

public UnaryCallSettings<CreateClusterRequest,Operation> createClusterSettings()

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

Returns
Type Description
UnaryCallSettings<CreateClusterRequest,Operation>

createTopicSettings()

public UnaryCallSettings<CreateTopicRequest,Topic> createTopicSettings()

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

Returns
Type Description
UnaryCallSettings<CreateTopicRequest,Topic>

deleteClusterOperationSettings()

public OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata> deleteClusterOperationSettings()

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

Returns
Type Description
OperationCallSettings<DeleteClusterRequest,Empty,OperationMetadata>

deleteClusterSettings()

public UnaryCallSettings<DeleteClusterRequest,Operation> deleteClusterSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteClusterRequest,Operation>

deleteConsumerGroupSettings()

public UnaryCallSettings<DeleteConsumerGroupRequest,Empty> deleteConsumerGroupSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteConsumerGroupRequest,Empty>

deleteTopicSettings()

public UnaryCallSettings<DeleteTopicRequest,Empty> deleteTopicSettings()

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

Returns
Type Description
UnaryCallSettings<DeleteTopicRequest,Empty>

getClusterSettings()

public UnaryCallSettings<GetClusterRequest,Cluster> getClusterSettings()

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

Returns
Type Description
UnaryCallSettings<GetClusterRequest,Cluster>

getConsumerGroupSettings()

public UnaryCallSettings<GetConsumerGroupRequest,ConsumerGroup> getConsumerGroupSettings()

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

Returns
Type Description
UnaryCallSettings<GetConsumerGroupRequest,ConsumerGroup>

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>

getTopicSettings()

public UnaryCallSettings<GetTopicRequest,Topic> getTopicSettings()

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

Returns
Type Description
UnaryCallSettings<GetTopicRequest,Topic>

listClustersSettings()

public PagedCallSettings<ListClustersRequest,ListClustersResponse,ManagedKafkaClient.ListClustersPagedResponse> listClustersSettings()

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

Returns
Type Description
PagedCallSettings<ListClustersRequest,ListClustersResponse,ListClustersPagedResponse>

listConsumerGroupsSettings()

public PagedCallSettings<ListConsumerGroupsRequest,ListConsumerGroupsResponse,ManagedKafkaClient.ListConsumerGroupsPagedResponse> listConsumerGroupsSettings()

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

Returns
Type Description
PagedCallSettings<ListConsumerGroupsRequest,ListConsumerGroupsResponse,ListConsumerGroupsPagedResponse>

listLocationsSettings()

public PagedCallSettings<ListLocationsRequest,ListLocationsResponse,ManagedKafkaClient.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>

listTopicsSettings()

public PagedCallSettings<ListTopicsRequest,ListTopicsResponse,ManagedKafkaClient.ListTopicsPagedResponse> listTopicsSettings()

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

Returns
Type Description
PagedCallSettings<ListTopicsRequest,ListTopicsResponse,ListTopicsPagedResponse>

toBuilder()

public ManagedKafkaSettings.Builder toBuilder()

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

Returns
Type Description
ManagedKafkaSettings.Builder
Overrides

updateClusterOperationSettings()

public OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationSettings()

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

Returns
Type Description
OperationCallSettings<UpdateClusterRequest,Cluster,OperationMetadata>

updateClusterSettings()

public UnaryCallSettings<UpdateClusterRequest,Operation> updateClusterSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateClusterRequest,Operation>

updateConsumerGroupSettings()

public UnaryCallSettings<UpdateConsumerGroupRequest,ConsumerGroup> updateConsumerGroupSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateConsumerGroupRequest,ConsumerGroup>

updateTopicSettings()

public UnaryCallSettings<UpdateTopicRequest,Topic> updateTopicSettings()

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

Returns
Type Description
UnaryCallSettings<UpdateTopicRequest,Topic>