Managed Service for Apache Kafka API . projects . locations . clusters . consumerGroups

Instance Methods

close()

Close httplib2 connections.

delete(name, x__xgafv=None)

Deletes a single consumer group.

get(name, x__xgafv=None)

Returns the properties of a single consumer group.

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists the consumer groups in a given cluster.

list_next()

Retrieves the next page of results.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates the properties of a single consumer group.

Method Details

close()
Close httplib2 connections.
delete(name, x__xgafv=None)
Deletes a single consumer group.

Args:
  name: string, Required. The name of the consumer group to delete. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}
get(name, x__xgafv=None)
Returns the properties of a single consumer group.

Args:
  name: string, Required. The name of the consumer group whose configuration to return. `projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumerGroup}`. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Kafka consumer group in a given cluster.
  "name": "A String", # Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
  "topics": { # Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
    "a_key": { # Metadata for a consumer group corresponding to a specific topic.
      "partitions": { # Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.
        "a_key": { # Metadata for a consumer group corresponding to a specific partition.
          "metadata": "A String", # Optional. The associated metadata for this partition, or empty if it does not exist.
          "offset": "A String", # Required. The current offset for this partition, or 0 if no offset has been committed.
        },
      },
    },
  },
}
list(parent, pageSize=None, pageToken=None, x__xgafv=None)
Lists the consumer groups in a given cluster.

Args:
  parent: string, Required. The parent cluster whose consumer groups are to be listed. Structured like `projects/{project}/locations/{location}/clusters/{cluster}`. (required)
  pageSize: integer, Optional. The maximum number of consumer groups to return. The service may return fewer than this value. If unset or zero, all consumer groups for the parent is returned.
  pageToken: string, Optional. A page token, received from a previous `ListConsumerGroups` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConsumerGroups` must match the call that provided the page token.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Response for ListConsumerGroups.
  "consumerGroups": [ # The list of consumer group in the requested parent. The order of the consumer groups is unspecified.
    { # A Kafka consumer group in a given cluster.
      "name": "A String", # Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
      "topics": { # Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
        "a_key": { # Metadata for a consumer group corresponding to a specific topic.
          "partitions": { # Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.
            "a_key": { # Metadata for a consumer group corresponding to a specific partition.
              "metadata": "A String", # Optional. The associated metadata for this partition, or empty if it does not exist.
              "offset": "A String", # Required. The current offset for this partition, or 0 if no offset has been committed.
            },
          },
        },
      },
    },
  ],
  "nextPageToken": "A String", # A token that can be sent as `page_token` to retrieve the next page of results. If this field is omitted, there are no more results.
}
list_next()
Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.
        
patch(name, body=None, updateMask=None, x__xgafv=None)
Updates the properties of a single consumer group.

Args:
  name: string, Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group} (required)
  body: object, The request body.
    The object takes the form of:

{ # A Kafka consumer group in a given cluster.
  "name": "A String", # Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
  "topics": { # Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
    "a_key": { # Metadata for a consumer group corresponding to a specific topic.
      "partitions": { # Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.
        "a_key": { # Metadata for a consumer group corresponding to a specific partition.
          "metadata": "A String", # Optional. The associated metadata for this partition, or empty if it does not exist.
          "offset": "A String", # Required. The current offset for this partition, or 0 if no offset has been committed.
        },
      },
    },
  },
}

  updateMask: string, 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.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A Kafka consumer group in a given cluster.
  "name": "A String", # Identifier. The name of the consumer group. The `consumer_group` segment is used when connecting directly to the cluster. Structured like: projects/{project}/locations/{location}/clusters/{cluster}/consumerGroups/{consumer_group}
  "topics": { # Optional. Metadata for this consumer group for all topics it has metadata for. The key of the map is a topic name, structured like: projects/{project}/locations/{location}/clusters/{cluster}/topics/{topic}
    "a_key": { # Metadata for a consumer group corresponding to a specific topic.
      "partitions": { # Optional. Metadata for this consumer group and topic for all partition indexes it has metadata for.
        "a_key": { # Metadata for a consumer group corresponding to a specific partition.
          "metadata": "A String", # Optional. The associated metadata for this partition, or empty if it does not exist.
          "offset": "A String", # Required. The current offset for this partition, or 0 if no offset has been committed.
        },
      },
    },
  },
}