Class: Google::Cloud::ManagedKafka::V1::ListConsumerGroupsRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/managedkafka/v1/managed_kafka.rb

Overview

Request for ListConsumerGroups.

Instance Attribute Summary collapse

Instance Attribute Details

#page_size::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.

Returns:

  • (::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.



284
285
286
287
# File 'proto_docs/google/cloud/managedkafka/v1/managed_kafka.rb', line 284

class ListConsumerGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#page_token::String

Returns 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.

Returns:

  • (::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.



284
285
286
287
# File 'proto_docs/google/cloud/managedkafka/v1/managed_kafka.rb', line 284

class ListConsumerGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent::String

Returns Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.

Returns:

  • (::String)

    Required. The parent cluster whose consumer groups are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster}.



284
285
286
287
# File 'proto_docs/google/cloud/managedkafka/v1/managed_kafka.rb', line 284

class ListConsumerGroupsRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end