Package com.google.cloud.managedkafka.v1

Class ManagedKafkaClient

java.lang.Object
com.google.cloud.managedkafka.v1.ManagedKafkaClient
All Implemented Interfaces:
BackgroundResource, AutoCloseable
@Generated("by gapic-generator-java") public class ManagedKafkaClient extends Object implements BackgroundResource
Service Description: The service that a client application uses to manage Apache Kafka clusters, topics and consumer groups.

This class provides the ability to make remote calls to the backing service through method calls that map to API methods. Sample code to get started: 


 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   Cluster response = managedKafkaClient.getCluster(name);
 }

Note: close() needs to be called on the ManagedKafkaClient object to clean up resources such as threads. In the example above, try-with-resources is used, which automatically calls close().

Methods
Method Description Method Variants

ListClusters

Lists the clusters in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listClusters(ListClustersRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listClusters(LocationName parent)

  • listClusters(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listClustersPagedCallable()

  • listClustersCallable()

GetCluster

Returns the properties of a single cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getCluster(GetClusterRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getCluster(ClusterName name)

  • getCluster(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getClusterCallable()

CreateCluster

Creates a new cluster in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createClusterAsync(CreateClusterRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • createClusterAsync(LocationName parent, Cluster cluster, String clusterId)

  • createClusterAsync(String parent, Cluster cluster, String clusterId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createClusterOperationCallable()

  • createClusterCallable()

UpdateCluster

Updates the properties of a single cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateClusterAsync(UpdateClusterRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • updateClusterAsync(Cluster cluster, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateClusterOperationCallable()

  • updateClusterCallable()

DeleteCluster

Deletes a single cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteClusterAsync(DeleteClusterRequest request)

Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.

  • deleteClusterAsync(ClusterName name)

  • deleteClusterAsync(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteClusterOperationCallable()

  • deleteClusterCallable()

ListTopics

Lists the topics in a given cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listTopics(ListTopicsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listTopics(ClusterName parent)

  • listTopics(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listTopicsPagedCallable()

  • listTopicsCallable()

GetTopic

Returns the properties of a single topic.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getTopic(GetTopicRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getTopic(TopicName name)

  • getTopic(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getTopicCallable()

CreateTopic

Creates a new topic in a given project and location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createTopic(CreateTopicRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createTopic(ClusterName parent, Topic topic, String topicId)

  • createTopic(String parent, Topic topic, String topicId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createTopicCallable()

UpdateTopic

Updates the properties of a single topic.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateTopic(UpdateTopicRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateTopic(Topic topic, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateTopicCallable()

DeleteTopic

Deletes a single topic.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteTopic(DeleteTopicRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteTopic(TopicName name)

  • deleteTopic(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteTopicCallable()

ListConsumerGroups

Lists the consumer groups in a given cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listConsumerGroups(ListConsumerGroupsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listConsumerGroups(ClusterName parent)

  • listConsumerGroups(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listConsumerGroupsPagedCallable()

  • listConsumerGroupsCallable()

GetConsumerGroup

Returns the properties of a single consumer group.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getConsumerGroup(GetConsumerGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getConsumerGroup(ConsumerGroupName name)

  • getConsumerGroup(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getConsumerGroupCallable()

UpdateConsumerGroup

Updates the properties of a single consumer group.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateConsumerGroup(UpdateConsumerGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateConsumerGroup(ConsumerGroup consumerGroup, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateConsumerGroupCallable()

DeleteConsumerGroup

Deletes a single consumer group.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteConsumerGroup(DeleteConsumerGroupRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteConsumerGroup(ConsumerGroupName name)

  • deleteConsumerGroup(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteConsumerGroupCallable()

ListAcls

Lists the acls in a given cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listAcls(ListAclsRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • listAcls(ClusterName parent)

  • listAcls(String parent)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listAclsPagedCallable()

  • listAclsCallable()

GetAcl

Returns the properties of a single acl.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getAcl(GetAclRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • getAcl(AclName name)

  • getAcl(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getAclCallable()

CreateAcl

Creates a new acl in the given project, location, and cluster.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • createAcl(CreateAclRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • createAcl(ClusterName parent, Acl acl, String aclId)

  • createAcl(String parent, Acl acl, String aclId)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • createAclCallable()

UpdateAcl

Updates the properties of a single acl.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • updateAcl(UpdateAclRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • updateAcl(Acl acl, FieldMask updateMask)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • updateAclCallable()

DeleteAcl

Deletes an acl.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • deleteAcl(DeleteAclRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • deleteAcl(AclName name)

  • deleteAcl(String name)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • deleteAclCallable()

AddAclEntry

Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • addAclEntry(AddAclEntryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • addAclEntry(AclName acl, AclEntry aclEntry)

  • addAclEntry(String acl, AclEntry aclEntry)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • addAclEntryCallable()

RemoveAclEntry

Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • removeAclEntry(RemoveAclEntryRequest request)

"Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.

  • removeAclEntry(AclName acl, AclEntry aclEntry)

  • removeAclEntry(String acl, AclEntry aclEntry)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • removeAclEntryCallable()

ListLocations

Lists information about the supported locations for this service.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • listLocations(ListLocationsRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • listLocationsPagedCallable()

  • listLocationsCallable()

GetLocation

Gets information about a location.

Request object method variants only take one parameter, a request object, which must be constructed before the call.

  • getLocation(GetLocationRequest request)

Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.

  • getLocationCallable()

See the individual methods for example code.

Many parameters require resource names to be formatted in a particular way. To assist with these names, this class includes a format method for each type of name, and additionally a parse method to extract the individual identifiers contained within names that are returned.

This class can be customized by passing in a custom instance of ManagedKafkaSettings to create(). For example:

To customize credentials: 


 // 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 managedKafkaSettings =
     ManagedKafkaSettings.newBuilder()
         .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
         .build();
 ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create(managedKafkaSettings);

To customize the endpoint: 


 // 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 managedKafkaSettings =
     ManagedKafkaSettings.newBuilder().setEndpoint(myEndpoint).build();
 ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create(managedKafkaSettings);

To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over the wire: 


 // 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 managedKafkaSettings = ManagedKafkaSettings.newHttpJsonBuilder().build();
 ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create(managedKafkaSettings);

Please refer to the GitHub repository's samples for more quickstart code snippets.

  • Constructor Details

    • ManagedKafkaClient

      protected ManagedKafkaClient(ManagedKafkaSettings settings) throws IOException
      Constructs an instance of ManagedKafkaClient, using the given settings. This is protected so that it is easy to make a subclass, but otherwise, the static factory methods should be preferred.
      Throws:
      IOException

    • ManagedKafkaClient

      protected ManagedKafkaClient(ManagedKafkaStub stub)

  • Method Details

    • create

      public static final ManagedKafkaClient create() throws IOException
      Constructs an instance of ManagedKafkaClient with default settings.
      Throws:
      IOException

    • create

      public static final ManagedKafkaClient create(ManagedKafkaSettings settings) throws IOException
      Constructs an instance of ManagedKafkaClient, using the given settings. The channels are created based on the settings passed in, or defaults for any settings that are not set.
      Throws:
      IOException

    • create

      public static final ManagedKafkaClient create(ManagedKafkaStub stub)
      Constructs an instance of ManagedKafkaClient, using the given stub for making calls. This is for advanced usage - prefer using create(ManagedKafkaSettings).

    • getSettings

      public final ManagedKafkaSettings getSettings()

    • getStub

      public ManagedKafkaStub getStub()

    • getOperationsClient

      public final OperationsClient getOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

    • getHttpJsonOperationsClient

      @BetaApi public final OperationsClient getHttpJsonOperationsClient()
      Returns the OperationsClient that can be used to query the status of a long-running operation returned by another API method call.

    • listClusters

      public final ManagedKafkaClient.ListClustersPagedResponse listClusters(LocationName parent)
      Lists the clusters in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   for (Cluster element : managedKafkaClient.listClusters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent location whose clusters are to be listed. Structured like `projects/{project}/locations/{location}`.
      Throws:
      ApiException - if the remote call fails

    • listClusters

      public final ManagedKafkaClient.ListClustersPagedResponse listClusters(String parent)
      Lists the clusters in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   for (Cluster element : managedKafkaClient.listClusters(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent location whose clusters are to be listed. Structured like `projects/{project}/locations/{location}`.
      Throws:
      ApiException - if the remote call fails

    • listClusters

      public final ManagedKafkaClient.ListClustersPagedResponse listClusters(ListClustersRequest request)
      Lists the clusters in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   for (Cluster element : managedKafkaClient.listClusters(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listClustersPagedCallable

      public final UnaryCallable<ListClustersRequest,ManagedKafkaClient.ListClustersPagedResponse> listClustersPagedCallable()
      Lists the clusters in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   ApiFuture<Cluster> future =
       managedKafkaClient.listClustersPagedCallable().futureCall(request);
   // Do something.
   for (Cluster element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listClustersCallable

      public final UnaryCallable<ListClustersRequest,ListClustersResponse> listClustersCallable()
      Lists the clusters in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListClustersRequest request =
       ListClustersRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .setFilter("filter-1274492040")
           .setOrderBy("orderBy-1207110587")
           .build();
   while (true) {
     ListClustersResponse response = managedKafkaClient.listClustersCallable().call(request);
     for (Cluster element : response.getClustersList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getCluster

      public final Cluster getCluster(ClusterName name)
      Returns the properties of a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   Cluster response = managedKafkaClient.getCluster(name);
 }
      Parameters:
      name - Required. The name of the cluster whose configuration to return.
      Throws:
      ApiException - if the remote call fails

    • getCluster

      public final Cluster getCluster(String name)
      Returns the properties of a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   Cluster response = managedKafkaClient.getCluster(name);
 }
      Parameters:
      name - Required. The name of the cluster whose configuration to return.
      Throws:
      ApiException - if the remote call fails

    • getCluster

      public final Cluster getCluster(GetClusterRequest request)
      Returns the properties of a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   Cluster response = managedKafkaClient.getCluster(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getClusterCallable

      public final UnaryCallable<GetClusterRequest,Cluster> getClusterCallable()
      Returns the properties of a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetClusterRequest request =
       GetClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .build();
   ApiFuture<Cluster> future = managedKafkaClient.getClusterCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }

    • createClusterAsync

      public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(LocationName parent, Cluster cluster, String clusterId)
      Creates a new cluster in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   LocationName parent = LocationName.of("[PROJECT]", "[LOCATION]");
   Cluster cluster = Cluster.newBuilder().build();
   String clusterId = "clusterId561939637";
   Cluster response = managedKafkaClient.createClusterAsync(parent, cluster, clusterId).get();
 }
      Parameters:
      parent - Required. The parent region in which to create the cluster. Structured like `projects/{project}/locations/{location}`.
      cluster - Required. Configuration of the cluster to create. Its `name` field is ignored.
      clusterId - Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035.

      This value is structured like: `my-cluster-id`.

      Throws:
      ApiException - if the remote call fails

    • createClusterAsync

      public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(String parent, Cluster cluster, String clusterId)
      Creates a new cluster in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String parent = LocationName.of("[PROJECT]", "[LOCATION]").toString();
   Cluster cluster = Cluster.newBuilder().build();
   String clusterId = "clusterId561939637";
   Cluster response = managedKafkaClient.createClusterAsync(parent, cluster, clusterId).get();
 }
      Parameters:
      parent - Required. The parent region in which to create the cluster. Structured like `projects/{project}/locations/{location}`.
      cluster - Required. Configuration of the cluster to create. Its `name` field is ignored.
      clusterId - Required. The ID to use for the cluster, which will become the final component of the cluster's name. The ID must be 1-63 characters long, and match the regular expression `[a-z]([-a-z0-9]*[a-z0-9])?` to comply with RFC 1035.

      This value is structured like: `my-cluster-id`.

      Throws:
      ApiException - if the remote call fails

    • createClusterAsync

      public final OperationFuture<Cluster,OperationMetadata> createClusterAsync(CreateClusterRequest request)
      Creates a new cluster in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Cluster response = managedKafkaClient.createClusterAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createClusterOperationCallable

      public final OperationCallable<CreateClusterRequest,Cluster,OperationMetadata> createClusterOperationCallable()
      Creates a new cluster in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Cluster, OperationMetadata> future =
       managedKafkaClient.createClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }

    • createClusterCallable

      public final UnaryCallable<CreateClusterRequest,Operation> createClusterCallable()
      Creates a new cluster in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   CreateClusterRequest request =
       CreateClusterRequest.newBuilder()
           .setParent(LocationName.of("[PROJECT]", "[LOCATION]").toString())
           .setClusterId("clusterId561939637")
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = managedKafkaClient.createClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • updateClusterAsync

      public final OperationFuture<Cluster,OperationMetadata> updateClusterAsync(Cluster cluster, com.google.protobuf.FieldMask updateMask)
      Updates the properties of a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   Cluster cluster = Cluster.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Cluster response = managedKafkaClient.updateClusterAsync(cluster, updateMask).get();
 }
      Parameters:
      cluster - Required. The cluster to update. Its `name` field must be populated.
      updateMask - Required. Field mask is used to specify the fields to be overwritten in the cluster resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
      Throws:
      ApiException - if the remote call fails

    • updateClusterAsync

      public final OperationFuture<Cluster,OperationMetadata> updateClusterAsync(UpdateClusterRequest request)
      Updates the properties of a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   Cluster response = managedKafkaClient.updateClusterAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateClusterOperationCallable

      public final OperationCallable<UpdateClusterRequest,Cluster,OperationMetadata> updateClusterOperationCallable()
      Updates the properties of a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Cluster, OperationMetadata> future =
       managedKafkaClient.updateClusterOperationCallable().futureCall(request);
   // Do something.
   Cluster response = future.get();
 }

    • updateClusterCallable

      public final UnaryCallable<UpdateClusterRequest,Operation> updateClusterCallable()
      Updates the properties of a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateClusterRequest request =
       UpdateClusterRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setCluster(Cluster.newBuilder().build())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = managedKafkaClient.updateClusterCallable().futureCall(request);
   // Do something.
   Operation response = future.get();
 }

    • deleteClusterAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteClusterAsync(ClusterName name)
      Deletes a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ClusterName name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   managedKafkaClient.deleteClusterAsync(name).get();
 }
      Parameters:
      name - Required. The name of the cluster to delete.
      Throws:
      ApiException - if the remote call fails

    • deleteClusterAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteClusterAsync(String name)
      Deletes a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String name = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   managedKafkaClient.deleteClusterAsync(name).get();
 }
      Parameters:
      name - Required. The name of the cluster to delete.
      Throws:
      ApiException - if the remote call fails

    • deleteClusterAsync

      public final OperationFuture<com.google.protobuf.Empty,OperationMetadata> deleteClusterAsync(DeleteClusterRequest request)
      Deletes a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setRequestId("requestId693933066")
           .build();
   managedKafkaClient.deleteClusterAsync(request).get();
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteClusterOperationCallable

      public final OperationCallable<DeleteClusterRequest,com.google.protobuf.Empty,OperationMetadata> deleteClusterOperationCallable()
      Deletes a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setRequestId("requestId693933066")
           .build();
   OperationFuture<Empty, OperationMetadata> future =
       managedKafkaClient.deleteClusterOperationCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • deleteClusterCallable

      public final UnaryCallable<DeleteClusterRequest,Operation> deleteClusterCallable()
      Deletes a single cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteClusterRequest request =
       DeleteClusterRequest.newBuilder()
           .setName(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setRequestId("requestId693933066")
           .build();
   ApiFuture<Operation> future = managedKafkaClient.deleteClusterCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • listTopics

      public final ManagedKafkaClient.ListTopicsPagedResponse listTopics(ClusterName parent)
      Lists the topics in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   for (Topic element : managedKafkaClient.listTopics(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent cluster whose topics are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      Throws:
      ApiException - if the remote call fails

    • listTopics

      public final ManagedKafkaClient.ListTopicsPagedResponse listTopics(String parent)
      Lists the topics in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   for (Topic element : managedKafkaClient.listTopics(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent cluster whose topics are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      Throws:
      ApiException - if the remote call fails

    • listTopics

      public final ManagedKafkaClient.ListTopicsPagedResponse listTopics(ListTopicsRequest request)
      Lists the topics in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListTopicsRequest request =
       ListTopicsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Topic element : managedKafkaClient.listTopics(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listTopicsPagedCallable

      public final UnaryCallable<ListTopicsRequest,ManagedKafkaClient.ListTopicsPagedResponse> listTopicsPagedCallable()
      Lists the topics in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListTopicsRequest request =
       ListTopicsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Topic> future = managedKafkaClient.listTopicsPagedCallable().futureCall(request);
   // Do something.
   for (Topic element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listTopicsCallable

      public final UnaryCallable<ListTopicsRequest,ListTopicsResponse> listTopicsCallable()
      Lists the topics in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListTopicsRequest request =
       ListTopicsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListTopicsResponse response = managedKafkaClient.listTopicsCallable().call(request);
     for (Topic element : response.getTopicsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getTopic

      public final Topic getTopic(TopicName name)
      Returns the properties of a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   TopicName name = TopicName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]");
   Topic response = managedKafkaClient.getTopic(name);
 }
      Parameters:
      name - Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
      Throws:
      ApiException - if the remote call fails

    • getTopic

      public final Topic getTopic(String name)
      Returns the properties of a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String name = TopicName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]").toString();
   Topic response = managedKafkaClient.getTopic(name);
 }
      Parameters:
      name - Required. The name of the topic whose configuration to return. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}.
      Throws:
      ApiException - if the remote call fails

    • getTopic

      public final Topic getTopic(GetTopicRequest request)
      Returns the properties of a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetTopicRequest request =
       GetTopicRequest.newBuilder()
           .setName(TopicName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]").toString())
           .build();
   Topic response = managedKafkaClient.getTopic(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getTopicCallable

      public final UnaryCallable<GetTopicRequest,Topic> getTopicCallable()
      Returns the properties of a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetTopicRequest request =
       GetTopicRequest.newBuilder()
           .setName(TopicName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]").toString())
           .build();
   ApiFuture<Topic> future = managedKafkaClient.getTopicCallable().futureCall(request);
   // Do something.
   Topic response = future.get();
 }

    • createTopic

      public final Topic createTopic(ClusterName parent, Topic topic, String topicId)
      Creates a new topic in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   Topic topic = Topic.newBuilder().build();
   String topicId = "topicId-1139259734";
   Topic response = managedKafkaClient.createTopic(parent, topic, topicId);
 }
      Parameters:
      parent - Required. The parent cluster in which to create the topic. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      topic - Required. Configuration of the topic to create. Its `name` field is ignored.
      topicId - Required. The ID to use for the topic, which will become the final component of the topic's name.

      This value is structured like: `my-topic-name`.

      Throws:
      ApiException - if the remote call fails

    • createTopic

      public final Topic createTopic(String parent, Topic topic, String topicId)
      Creates a new topic in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   Topic topic = Topic.newBuilder().build();
   String topicId = "topicId-1139259734";
   Topic response = managedKafkaClient.createTopic(parent, topic, topicId);
 }
      Parameters:
      parent - Required. The parent cluster in which to create the topic. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      topic - Required. Configuration of the topic to create. Its `name` field is ignored.
      topicId - Required. The ID to use for the topic, which will become the final component of the topic's name.

      This value is structured like: `my-topic-name`.

      Throws:
      ApiException - if the remote call fails

    • createTopic

      public final Topic createTopic(CreateTopicRequest request)
      Creates a new topic in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   CreateTopicRequest request =
       CreateTopicRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setTopicId("topicId-1139259734")
           .setTopic(Topic.newBuilder().build())
           .build();
   Topic response = managedKafkaClient.createTopic(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createTopicCallable

      public final UnaryCallable<CreateTopicRequest,Topic> createTopicCallable()
      Creates a new topic in a given project and location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   CreateTopicRequest request =
       CreateTopicRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setTopicId("topicId-1139259734")
           .setTopic(Topic.newBuilder().build())
           .build();
   ApiFuture<Topic> future = managedKafkaClient.createTopicCallable().futureCall(request);
   // Do something.
   Topic response = future.get();
 }

    • updateTopic

      public final Topic updateTopic(Topic topic, com.google.protobuf.FieldMask updateMask)
      Updates the properties of a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   Topic topic = Topic.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Topic response = managedKafkaClient.updateTopic(topic, updateMask);
 }
      Parameters:
      topic - Required. The topic to update. Its `name` field must be populated.
      updateMask - Required. Field mask is used to specify the fields to be overwritten in the Topic resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
      Throws:
      ApiException - if the remote call fails

    • updateTopic

      public final Topic updateTopic(UpdateTopicRequest request)
      Updates the properties of a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateTopicRequest request =
       UpdateTopicRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTopic(Topic.newBuilder().build())
           .build();
   Topic response = managedKafkaClient.updateTopic(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateTopicCallable

      public final UnaryCallable<UpdateTopicRequest,Topic> updateTopicCallable()
      Updates the properties of a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateTopicRequest request =
       UpdateTopicRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setTopic(Topic.newBuilder().build())
           .build();
   ApiFuture<Topic> future = managedKafkaClient.updateTopicCallable().futureCall(request);
   // Do something.
   Topic response = future.get();
 }

    • deleteTopic

      public final void deleteTopic(TopicName name)
      Deletes a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   TopicName name = TopicName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]");
   managedKafkaClient.deleteTopic(name);
 }
      Parameters:
      name - Required. The name of the topic to delete. `projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}`.
      Throws:
      ApiException - if the remote call fails

    • deleteTopic

      public final void deleteTopic(String name)
      Deletes a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String name = TopicName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]").toString();
   managedKafkaClient.deleteTopic(name);
 }
      Parameters:
      name - Required. The name of the topic to delete. `projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}`.
      Throws:
      ApiException - if the remote call fails

    • deleteTopic

      public final void deleteTopic(DeleteTopicRequest request)
      Deletes a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteTopicRequest request =
       DeleteTopicRequest.newBuilder()
           .setName(TopicName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]").toString())
           .build();
   managedKafkaClient.deleteTopic(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteTopicCallable

      public final UnaryCallable<DeleteTopicRequest,com.google.protobuf.Empty> deleteTopicCallable()
      Deletes a single topic.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteTopicRequest request =
       DeleteTopicRequest.newBuilder()
           .setName(TopicName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[TOPIC]").toString())
           .build();
   ApiFuture<Empty> future = managedKafkaClient.deleteTopicCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • listConsumerGroups

      public final ManagedKafkaClient.ListConsumerGroupsPagedResponse listConsumerGroups(ClusterName parent)
      Lists the consumer groups in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   for (ConsumerGroup element : managedKafkaClient.listConsumerGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent cluster whose consumer groups are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      Throws:
      ApiException - if the remote call fails

    • listConsumerGroups

      public final ManagedKafkaClient.ListConsumerGroupsPagedResponse listConsumerGroups(String parent)
      Lists the consumer groups in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   for (ConsumerGroup element : managedKafkaClient.listConsumerGroups(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent cluster whose consumer groups are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      Throws:
      ApiException - if the remote call fails

    • listConsumerGroups

      public final ManagedKafkaClient.ListConsumerGroupsPagedResponse listConsumerGroups(ListConsumerGroupsRequest request)
      Lists the consumer groups in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListConsumerGroupsRequest request =
       ListConsumerGroupsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (ConsumerGroup element : managedKafkaClient.listConsumerGroups(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listConsumerGroupsPagedCallable

      public final UnaryCallable<ListConsumerGroupsRequest,ManagedKafkaClient.ListConsumerGroupsPagedResponse> listConsumerGroupsPagedCallable()
      Lists the consumer groups in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListConsumerGroupsRequest request =
       ListConsumerGroupsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<ConsumerGroup> future =
       managedKafkaClient.listConsumerGroupsPagedCallable().futureCall(request);
   // Do something.
   for (ConsumerGroup element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listConsumerGroupsCallable

      public final UnaryCallable<ListConsumerGroupsRequest,ListConsumerGroupsResponse> listConsumerGroupsCallable()
      Lists the consumer groups in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListConsumerGroupsRequest request =
       ListConsumerGroupsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListConsumerGroupsResponse response =
         managedKafkaClient.listConsumerGroupsCallable().call(request);
     for (ConsumerGroup element : response.getConsumerGroupsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getConsumerGroup

      public final ConsumerGroup getConsumerGroup(ConsumerGroupName name)
      Returns the properties of a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ConsumerGroupName name =
       ConsumerGroupName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]");
   ConsumerGroup response = managedKafkaClient.getConsumerGroup(name);
 }
      Parameters:
      name - Required. The name of the consumer group whose configuration to return. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
      Throws:
      ApiException - if the remote call fails

    • getConsumerGroup

      public final ConsumerGroup getConsumerGroup(String name)
      Returns the properties of a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String name =
       ConsumerGroupName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]")
           .toString();
   ConsumerGroup response = managedKafkaClient.getConsumerGroup(name);
 }
      Parameters:
      name - Required. The name of the consumer group whose configuration to return. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
      Throws:
      ApiException - if the remote call fails

    • getConsumerGroup

      public final ConsumerGroup getConsumerGroup(GetConsumerGroupRequest request)
      Returns the properties of a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetConsumerGroupRequest request =
       GetConsumerGroupRequest.newBuilder()
           .setName(
               ConsumerGroupName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]")
                   .toString())
           .build();
   ConsumerGroup response = managedKafkaClient.getConsumerGroup(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getConsumerGroupCallable

      public final UnaryCallable<GetConsumerGroupRequest,ConsumerGroup> getConsumerGroupCallable()
      Returns the properties of a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetConsumerGroupRequest request =
       GetConsumerGroupRequest.newBuilder()
           .setName(
               ConsumerGroupName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]")
                   .toString())
           .build();
   ApiFuture<ConsumerGroup> future =
       managedKafkaClient.getConsumerGroupCallable().futureCall(request);
   // Do something.
   ConsumerGroup response = future.get();
 }

    • updateConsumerGroup

      public final ConsumerGroup updateConsumerGroup(ConsumerGroup consumerGroup, com.google.protobuf.FieldMask updateMask)
      Updates the properties of a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ConsumerGroup consumerGroup = ConsumerGroup.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   ConsumerGroup response = managedKafkaClient.updateConsumerGroup(consumerGroup, updateMask);
 }
      Parameters:
      consumerGroup - Required. The consumer group to update. Its `name` field must be populated.
      updateMask - Required. Field mask is used to specify the fields to be overwritten in the ConsumerGroup resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. The mask is required and a value of * will update all fields.
      Throws:
      ApiException - if the remote call fails

    • updateConsumerGroup

      public final ConsumerGroup updateConsumerGroup(UpdateConsumerGroupRequest request)
      Updates the properties of a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateConsumerGroupRequest request =
       UpdateConsumerGroupRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setConsumerGroup(ConsumerGroup.newBuilder().build())
           .build();
   ConsumerGroup response = managedKafkaClient.updateConsumerGroup(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateConsumerGroupCallable

      public final UnaryCallable<UpdateConsumerGroupRequest,ConsumerGroup> updateConsumerGroupCallable()
      Updates the properties of a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateConsumerGroupRequest request =
       UpdateConsumerGroupRequest.newBuilder()
           .setUpdateMask(FieldMask.newBuilder().build())
           .setConsumerGroup(ConsumerGroup.newBuilder().build())
           .build();
   ApiFuture<ConsumerGroup> future =
       managedKafkaClient.updateConsumerGroupCallable().futureCall(request);
   // Do something.
   ConsumerGroup response = future.get();
 }

    • deleteConsumerGroup

      public final void deleteConsumerGroup(ConsumerGroupName name)
      Deletes a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ConsumerGroupName name =
       ConsumerGroupName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]");
   managedKafkaClient.deleteConsumerGroup(name);
 }
      Parameters:
      name - Required. The name of the consumer group to delete. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
      Throws:
      ApiException - if the remote call fails

    • deleteConsumerGroup

      public final void deleteConsumerGroup(String name)
      Deletes a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String name =
       ConsumerGroupName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]")
           .toString();
   managedKafkaClient.deleteConsumerGroup(name);
 }
      Parameters:
      name - Required. The name of the consumer group to delete. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`.
      Throws:
      ApiException - if the remote call fails

    • deleteConsumerGroup

      public final void deleteConsumerGroup(DeleteConsumerGroupRequest request)
      Deletes a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteConsumerGroupRequest request =
       DeleteConsumerGroupRequest.newBuilder()
           .setName(
               ConsumerGroupName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]")
                   .toString())
           .build();
   managedKafkaClient.deleteConsumerGroup(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteConsumerGroupCallable

      public final UnaryCallable<DeleteConsumerGroupRequest,com.google.protobuf.Empty> deleteConsumerGroupCallable()
      Deletes a single consumer group.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteConsumerGroupRequest request =
       DeleteConsumerGroupRequest.newBuilder()
           .setName(
               ConsumerGroupName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[CONSUMER_GROUP]")
                   .toString())
           .build();
   ApiFuture<Empty> future =
       managedKafkaClient.deleteConsumerGroupCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • listAcls

      public final ManagedKafkaClient.ListAclsPagedResponse listAcls(ClusterName parent)
      Lists the acls in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   for (Acl element : managedKafkaClient.listAcls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent cluster whose acls are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      Throws:
      ApiException - if the remote call fails

    • listAcls

      public final ManagedKafkaClient.ListAclsPagedResponse listAcls(String parent)
      Lists the acls in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   for (Acl element : managedKafkaClient.listAcls(parent).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      parent - Required. The parent cluster whose acls are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      Throws:
      ApiException - if the remote call fails

    • listAcls

      public final ManagedKafkaClient.ListAclsPagedResponse listAcls(ListAclsRequest request)
      Lists the acls in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListAclsRequest request =
       ListAclsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Acl element : managedKafkaClient.listAcls(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listAclsPagedCallable

      public final UnaryCallable<ListAclsRequest,ManagedKafkaClient.ListAclsPagedResponse> listAclsPagedCallable()
      Lists the acls in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListAclsRequest request =
       ListAclsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Acl> future = managedKafkaClient.listAclsPagedCallable().futureCall(request);
   // Do something.
   for (Acl element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listAclsCallable

      public final UnaryCallable<ListAclsRequest,ListAclsResponse> listAclsCallable()
      Lists the acls in a given cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListAclsRequest request =
       ListAclsRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListAclsResponse response = managedKafkaClient.listAclsCallable().call(request);
     for (Acl element : response.getAclsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getAcl

      public final Acl getAcl(AclName name)
      Returns the properties of a single acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   AclName name = AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]");
   Acl response = managedKafkaClient.getAcl(name);
 }
      Parameters:
      name - Required. The name of the acl to return. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.

      The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.

      Throws:
      ApiException - if the remote call fails

    • getAcl

      public final Acl getAcl(String name)
      Returns the properties of a single acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String name = AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString();
   Acl response = managedKafkaClient.getAcl(name);
 }
      Parameters:
      name - Required. The name of the acl to return. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.

      The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.

      Throws:
      ApiException - if the remote call fails

    • getAcl

      public final Acl getAcl(GetAclRequest request)
      Returns the properties of a single acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetAclRequest request =
       GetAclRequest.newBuilder()
           .setName(AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString())
           .build();
   Acl response = managedKafkaClient.getAcl(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getAclCallable

      public final UnaryCallable<GetAclRequest,Acl> getAclCallable()
      Returns the properties of a single acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetAclRequest request =
       GetAclRequest.newBuilder()
           .setName(AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString())
           .build();
   ApiFuture<Acl> future = managedKafkaClient.getAclCallable().futureCall(request);
   // Do something.
   Acl response = future.get();
 }

    • createAcl

      public final Acl createAcl(ClusterName parent, Acl acl, String aclId)
      Creates a new acl in the given project, location, and cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ClusterName parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]");
   Acl acl = Acl.newBuilder().build();
   String aclId = "aclId92636997";
   Acl response = managedKafkaClient.createAcl(parent, acl, aclId);
 }
      Parameters:
      parent - Required. The parent cluster in which to create the acl. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      acl - Required. Configuration of the acl to create. Its `name` field is ignored.
      aclId - Required. The ID to use for the acl, which will become the final component of the acl's name. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following:

      For acls on the cluster: `cluster`

      For acls on a single resource within the cluster: `topic/{resource_name}` `consumerGroup/{resource_name}` `transactionalId/{resource_name}`

      For acls on all resources that match a prefix: `topicPrefixed/{resource_name}` `consumerGroupPrefixed/{resource_name}` `transactionalIdPrefixed/{resource_name}`

      For acls on all resources of a given type (i.e. the wildcard literal "*"): `allTopics` (represents `topic/*`) `allConsumerGroups` (represents `consumerGroup/*`) `allTransactionalIds` (represents `transactionalId/*`)

      Throws:
      ApiException - if the remote call fails

    • createAcl

      public final Acl createAcl(String parent, Acl acl, String aclId)
      Creates a new acl in the given project, location, and cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String parent = ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString();
   Acl acl = Acl.newBuilder().build();
   String aclId = "aclId92636997";
   Acl response = managedKafkaClient.createAcl(parent, acl, aclId);
 }
      Parameters:
      parent - Required. The parent cluster in which to create the acl. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`.
      acl - Required. Configuration of the acl to create. Its `name` field is ignored.
      aclId - Required. The ID to use for the acl, which will become the final component of the acl's name. The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. `acl_id` is structured like one of the following:

      For acls on the cluster: `cluster`

      For acls on a single resource within the cluster: `topic/{resource_name}` `consumerGroup/{resource_name}` `transactionalId/{resource_name}`

      For acls on all resources that match a prefix: `topicPrefixed/{resource_name}` `consumerGroupPrefixed/{resource_name}` `transactionalIdPrefixed/{resource_name}`

      For acls on all resources of a given type (i.e. the wildcard literal "*"): `allTopics` (represents `topic/*`) `allConsumerGroups` (represents `consumerGroup/*`) `allTransactionalIds` (represents `transactionalId/*`)

      Throws:
      ApiException - if the remote call fails

    • createAcl

      public final Acl createAcl(CreateAclRequest request)
      Creates a new acl in the given project, location, and cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   CreateAclRequest request =
       CreateAclRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setAclId("aclId92636997")
           .setAcl(Acl.newBuilder().build())
           .build();
   Acl response = managedKafkaClient.createAcl(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • createAclCallable

      public final UnaryCallable<CreateAclRequest,Acl> createAclCallable()
      Creates a new acl in the given project, location, and cluster.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   CreateAclRequest request =
       CreateAclRequest.newBuilder()
           .setParent(ClusterName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]").toString())
           .setAclId("aclId92636997")
           .setAcl(Acl.newBuilder().build())
           .build();
   ApiFuture<Acl> future = managedKafkaClient.createAclCallable().futureCall(request);
   // Do something.
   Acl response = future.get();
 }

    • updateAcl

      public final Acl updateAcl(Acl acl, com.google.protobuf.FieldMask updateMask)
      Updates the properties of a single acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   Acl acl = Acl.newBuilder().build();
   FieldMask updateMask = FieldMask.newBuilder().build();
   Acl response = managedKafkaClient.updateAcl(acl, updateMask);
 }
      Parameters:
      acl - Required. The updated acl. Its `name` and `etag` fields must be populated. `acl_entries` must not be empty in the updated acl; to remove all acl entries for an acl, use DeleteAcl.
      updateMask - Optional. Field mask is used to specify the fields to be overwritten in the Acl resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask.
      Throws:
      ApiException - if the remote call fails

    • updateAcl

      public final Acl updateAcl(UpdateAclRequest request)
      Updates the properties of a single acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateAclRequest request =
       UpdateAclRequest.newBuilder()
           .setAcl(Acl.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   Acl response = managedKafkaClient.updateAcl(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • updateAclCallable

      public final UnaryCallable<UpdateAclRequest,Acl> updateAclCallable()
      Updates the properties of a single acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   UpdateAclRequest request =
       UpdateAclRequest.newBuilder()
           .setAcl(Acl.newBuilder().build())
           .setUpdateMask(FieldMask.newBuilder().build())
           .build();
   ApiFuture<Acl> future = managedKafkaClient.updateAclCallable().futureCall(request);
   // Do something.
   Acl response = future.get();
 }

    • deleteAcl

      public final void deleteAcl(AclName name)
      Deletes an acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   AclName name = AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]");
   managedKafkaClient.deleteAcl(name);
 }
      Parameters:
      name - Required. The name of the acl to delete. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.

      The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.

      Throws:
      ApiException - if the remote call fails

    • deleteAcl

      public final void deleteAcl(String name)
      Deletes an acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String name = AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString();
   managedKafkaClient.deleteAcl(name);
 }
      Parameters:
      name - Required. The name of the acl to delete. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.

      The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.

      Throws:
      ApiException - if the remote call fails

    • deleteAcl

      public final void deleteAcl(DeleteAclRequest request)
      Deletes an acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteAclRequest request =
       DeleteAclRequest.newBuilder()
           .setName(AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString())
           .build();
   managedKafkaClient.deleteAcl(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • deleteAclCallable

      public final UnaryCallable<DeleteAclRequest,com.google.protobuf.Empty> deleteAclCallable()
      Deletes an acl.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   DeleteAclRequest request =
       DeleteAclRequest.newBuilder()
           .setName(AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString())
           .build();
   ApiFuture<Empty> future = managedKafkaClient.deleteAclCallable().futureCall(request);
   // Do something.
   future.get();
 }

    • addAclEntry

      public final AddAclEntryResponse addAclEntry(AclName acl, AclEntry aclEntry)
      Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   AclName acl = AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]");
   AclEntry aclEntry = AclEntry.newBuilder().build();
   AddAclEntryResponse response = managedKafkaClient.addAclEntry(acl, aclEntry);
 }
      Parameters:
      acl - Required. The name of the acl to add the acl entry to. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.

      The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.

      aclEntry - Required. The acl entry to add.
      Throws:
      ApiException - if the remote call fails

    • addAclEntry

      public final AddAclEntryResponse addAclEntry(String acl, AclEntry aclEntry)
      Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String acl = AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString();
   AclEntry aclEntry = AclEntry.newBuilder().build();
   AddAclEntryResponse response = managedKafkaClient.addAclEntry(acl, aclEntry);
 }
      Parameters:
      acl - Required. The name of the acl to add the acl entry to. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.

      The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.

      aclEntry - Required. The acl entry to add.
      Throws:
      ApiException - if the remote call fails

    • addAclEntry

      public final AddAclEntryResponse addAclEntry(AddAclEntryRequest request)
      Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   AddAclEntryRequest request =
       AddAclEntryRequest.newBuilder()
           .setAcl(AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString())
           .setAclEntry(AclEntry.newBuilder().build())
           .build();
   AddAclEntryResponse response = managedKafkaClient.addAclEntry(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • addAclEntryCallable

      public final UnaryCallable<AddAclEntryRequest,AddAclEntryResponse> addAclEntryCallable()
      Incremental update: Adds an acl entry to an acl. Creates the acl if it does not exist yet.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   AddAclEntryRequest request =
       AddAclEntryRequest.newBuilder()
           .setAcl(AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString())
           .setAclEntry(AclEntry.newBuilder().build())
           .build();
   ApiFuture<AddAclEntryResponse> future =
       managedKafkaClient.addAclEntryCallable().futureCall(request);
   // Do something.
   AddAclEntryResponse response = future.get();
 }

    • removeAclEntry

      public final RemoveAclEntryResponse removeAclEntry(AclName acl, AclEntry aclEntry)
      Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   AclName acl = AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]");
   AclEntry aclEntry = AclEntry.newBuilder().build();
   RemoveAclEntryResponse response = managedKafkaClient.removeAclEntry(acl, aclEntry);
 }
      Parameters:
      acl - Required. The name of the acl to remove the acl entry from. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.

      The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.

      aclEntry - Required. The acl entry to remove.
      Throws:
      ApiException - if the remote call fails

    • removeAclEntry

      public final RemoveAclEntryResponse removeAclEntry(String acl, AclEntry aclEntry)
      Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   String acl = AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString();
   AclEntry aclEntry = AclEntry.newBuilder().build();
   RemoveAclEntryResponse response = managedKafkaClient.removeAclEntry(acl, aclEntry);
 }
      Parameters:
      acl - Required. The name of the acl to remove the acl entry from. Structured like: `projects/{project}/locations/{location}/clusters/{cluster}/acls/{acl_id}`.

      The structure of `acl_id` defines the Resource Pattern (resource_type, resource_name, pattern_type) of the acl. See `Acl.name` for details.

      aclEntry - Required. The acl entry to remove.
      Throws:
      ApiException - if the remote call fails

    • removeAclEntry

      public final RemoveAclEntryResponse removeAclEntry(RemoveAclEntryRequest request)
      Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   RemoveAclEntryRequest request =
       RemoveAclEntryRequest.newBuilder()
           .setAcl(AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString())
           .setAclEntry(AclEntry.newBuilder().build())
           .build();
   RemoveAclEntryResponse response = managedKafkaClient.removeAclEntry(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • removeAclEntryCallable

      public final UnaryCallable<RemoveAclEntryRequest,RemoveAclEntryResponse> removeAclEntryCallable()
      Incremental update: Removes an acl entry from an acl. Deletes the acl if its acl entries become empty (i.e. if the removed entry was the last one in the acl).

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   RemoveAclEntryRequest request =
       RemoveAclEntryRequest.newBuilder()
           .setAcl(AclName.of("[PROJECT]", "[LOCATION]", "[CLUSTER]", "[ACL]").toString())
           .setAclEntry(AclEntry.newBuilder().build())
           .build();
   ApiFuture<RemoveAclEntryResponse> future =
       managedKafkaClient.removeAclEntryCallable().futureCall(request);
   // Do something.
   RemoveAclEntryResponse response = future.get();
 }

    • listLocations

      public final ManagedKafkaClient.ListLocationsPagedResponse listLocations(ListLocationsRequest request)
      Lists information about the supported locations for this service.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   for (Location element : managedKafkaClient.listLocations(request).iterateAll()) {
     // doThingsWith(element);
   }
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • listLocationsPagedCallable

      public final UnaryCallable<ListLocationsRequest,ManagedKafkaClient.ListLocationsPagedResponse> listLocationsPagedCallable()
      Lists information about the supported locations for this service.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   ApiFuture<Location> future =
       managedKafkaClient.listLocationsPagedCallable().futureCall(request);
   // Do something.
   for (Location element : future.get().iterateAll()) {
     // doThingsWith(element);
   }
 }

    • listLocationsCallable

      public final UnaryCallable<ListLocationsRequest,ListLocationsResponse> listLocationsCallable()
      Lists information about the supported locations for this service.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   ListLocationsRequest request =
       ListLocationsRequest.newBuilder()
           .setName("name3373707")
           .setFilter("filter-1274492040")
           .setPageSize(883849137)
           .setPageToken("pageToken873572522")
           .build();
   while (true) {
     ListLocationsResponse response = managedKafkaClient.listLocationsCallable().call(request);
     for (Location element : response.getLocationsList()) {
       // doThingsWith(element);
     }
     String nextPageToken = response.getNextPageToken();
     if (!Strings.isNullOrEmpty(nextPageToken)) {
       request = request.toBuilder().setPageToken(nextPageToken).build();
     } else {
       break;
     }
   }
 }

    • getLocation

      public final Location getLocation(GetLocationRequest request)
      Gets information about a location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   Location response = managedKafkaClient.getLocation(request);
 }
      Parameters:
      request - The request object containing all of the parameters for the API call.
      Throws:
      ApiException - if the remote call fails

    • getLocationCallable

      public final UnaryCallable<GetLocationRequest,Location> getLocationCallable()
      Gets information about a location.

      Sample code: 

      
 // 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
 try (ManagedKafkaClient managedKafkaClient = ManagedKafkaClient.create()) {
   GetLocationRequest request = GetLocationRequest.newBuilder().setName("name3373707").build();
   ApiFuture<Location> future = managedKafkaClient.getLocationCallable().futureCall(request);
   // Do something.
   Location response = future.get();
 }

    • close

      public final void close()
      Specified by:
      close in interface AutoCloseable

    • shutdown

      public void shutdown()
      Specified by:
      shutdown in interface BackgroundResource

    • isShutdown

      public boolean isShutdown()
      Specified by:
      isShutdown in interface BackgroundResource

    • isTerminated

      public boolean isTerminated()
      Specified by:
      isTerminated in interface BackgroundResource

    • shutdownNow

      public void shutdownNow()
      Specified by:
      shutdownNow in interface BackgroundResource

    • awaitTermination

      public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException
      Specified by:
      awaitTermination in interface BackgroundResource
      Throws:
      InterruptedException