/*
 * Copyright 2019 Red Hat Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.vertx.kafka.admin;

import io.vertx.codegen.annotations.DataObject;
import io.vertx.core.json.JsonObject;
import io.vertx.kafka.client.common.Node;
import org.apache.kafka.common.ConsumerGroupState;

import java.util.List;

A detailed description of a single consumer group in the cluster
/**
 * A detailed description of a single consumer group in the cluster
 */
@DataObject(generateConverter = true)
public class ConsumerGroupDescription  {

  private String groupId;
  private boolean isSimpleConsumerGroup;
  private Node coordinator;
  private List<MemberDescription> members;
  private String partitionAssignor;
  private ConsumerGroupState state;

  
Constructor
/**
   * Constructor
   */
  public ConsumerGroupDescription() {

  }

  
Constructor
Params:
groupId – the id of the consumer group
isSimpleConsumerGroup – if consumer group is simple or not
members – a list of the members of the consumer group
partitionAssignor – the consumer group partition assignor
state – the consumer group state, or UNKNOWN if the state is too new for us to parse
coordinator – the consumer group coordinator, or null if the coordinator is not known/**
   * Constructor
   *
   * @param groupId the id of the consumer group
   * @param isSimpleConsumerGroup if consumer group is simple or not
   * @param members a list of the members of the consumer group
   * @param partitionAssignor the consumer group partition assignor
   * @param state the consumer group state, or UNKNOWN if the state is too new for us to parse
   * @param coordinator the consumer group coordinator, or null if the coordinator is not known
   */
  public ConsumerGroupDescription(String groupId, boolean isSimpleConsumerGroup, List<MemberDescription> members,
                                  String partitionAssignor, ConsumerGroupState state, Node coordinator) {
    this.groupId = groupId;
    this.isSimpleConsumerGroup = isSimpleConsumerGroup;
    this.members = members;
    this.partitionAssignor = partitionAssignor;
    this.state = state;
    this.coordinator = coordinator;
  }

  
Constructor (from JSON representation)
Params:
json –  JSON representation/**
   * Constructor (from JSON representation)
   *
   * @param json  JSON representation
   */
  public ConsumerGroupDescription(JsonObject json) {

    ConsumerGroupDescriptionConverter.fromJson(json, this);
  }

  
Returns:
the id of the consumer group/**
   * @return the id of the consumer group
   */
  public String getGroupId() {
    return groupId;
  }

  
Set the id of the consumer group
Params:
groupId – the id of the consumer group
Returns:
current instance of the class to be fluent/**
   * Set the id of the consumer group
   *
   * @param groupId the id of the consumer group
   * @return current instance of the class to be fluent
   */
  public ConsumerGroupDescription setGroupId(String groupId) {
    this.groupId = groupId;
    return this;
  }

  
Returns:
if consumer group is simple or not/**
   * @return if consumer group is simple or not
   */
  public boolean isSimpleConsumerGroup() {
    return isSimpleConsumerGroup;
  }

  
Set if consumer group is simple or not
Params:
isSimpleConsumerGroup – if consumer group is simple or not
Returns:
current instance of the class to be fluent/**
   * Set if consumer group is simple or not
   *
   * @param isSimpleConsumerGroup if consumer group is simple or not
   * @return current instance of the class to be fluent
   */
  public ConsumerGroupDescription setSimpleConsumerGroup(boolean isSimpleConsumerGroup) {
    this.isSimpleConsumerGroup = isSimpleConsumerGroup;
    return this;
  }

  
Returns:
the consumer group coordinator, or null if the coordinator is not known/**
   * @return the consumer group coordinator, or null if the coordinator is not known
   */
  public Node getCoordinator() {
    return coordinator;
  }

  
Set the consumer group coordinator, or null if the coordinator is not known
Params:
coordinator – the consumer group coordinator, or null if the coordinator is not known
Returns:
current instance of the class to be fluent/**
   * Set the consumer group coordinator, or null if the coordinator is not known
   *
   * @param coordinator the consumer group coordinator, or null if the coordinator is not known
   * @return current instance of the class to be fluent
   */
  public ConsumerGroupDescription setCoordinator(Node coordinator) {
    this.coordinator = coordinator;
    return this;
  }

  
Returns:
a list of the members of the consumer group/**
   * @return a list of the members of the consumer group
   */
  public List<MemberDescription> getMembers() {
    return members;
  }

  
Set a list of the members of the consumer group
Params:
members – a list of the members of the consumer group
Returns:
current instance of the class to be fluent/**
   * Set a list of the members of the consumer group
   *
   * @param members a list of the members of the consumer group
   * @return current instance of the class to be fluent
   */
  public ConsumerGroupDescription setMembers(List<MemberDescription> members) {
    this.members = members;
    return this;
  }

  
Returns:
the consumer group partition assignor/**
   * @return the consumer group partition assignor
   */
  public String getPartitionAssignor() {
    return partitionAssignor;
  }

  
Set the consumer group partition assignor
Params:
partitionAssignor – the consumer group partition assignor
Returns:
current instance of the class to be fluent/**
   * Set the consumer group partition assignor
   *
   * @param partitionAssignor the consumer group partition assignor
   * @return current instance of the class to be fluent
   */
  public ConsumerGroupDescription setPartitionAssignor(String partitionAssignor) {
    this.partitionAssignor = partitionAssignor;
    return this;
  }

  
Returns:
the consumer group state, or UNKNOWN if the state is too new for us to parse/**
   * @return the consumer group state, or UNKNOWN if the state is too new for us to parse
   */
  public ConsumerGroupState getState() {
    return state;
  }

  
Set the consumer group state, or UNKNOWN if the state is too new for us to parse
Params:
state – the consumer group state, or UNKNOWN if the state is too new for us to parse
Returns:
current instance of the class to be fluent/**
   * Set the consumer group state, or UNKNOWN if the state is too new for us to parse
   *
   * @param state the consumer group state, or UNKNOWN if the state is too new for us to parse
   * @return current instance of the class to be fluent
   */
  public ConsumerGroupDescription setState(ConsumerGroupState state) {
    this.state = state;
    return this;
  }

  
Convert object to JSON representation
Returns:
 JSON representation/**
   * Convert object to JSON representation
   *
   * @return  JSON representation
   */
  public JsonObject toJson() {

    JsonObject json = new JsonObject();
    ConsumerGroupDescriptionConverter.toJson(this, json);
    return json;
  }

  @Override
  public String toString() {

    return "ConsumerGroupDescription{" +
      "groupId=" + this.groupId +
      ",isSimpleConsumerGroup=" + this.isSimpleConsumerGroup +
      ",coordinator=" + this.coordinator +
      ",members=" + this.members +
      ",partitionAssignor=" + this.partitionAssignor +
      ",state=" + this.state +
      "}";
  }
}