Class ListConsumerGroupsRequest.Builder (0.5.0)

public static final class ListConsumerGroupsRequest.Builder extends GeneratedMessageV3.Builder<ListConsumerGroupsRequest.Builder> implements ListConsumerGroupsRequestOrBuilder

Request for ListConsumerGroups.

Protobuf type google.cloud.managedkafka.v1.ListConsumerGroupsRequest

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public ListConsumerGroupsRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

build()

public ListConsumerGroupsRequest build()
Returns
Type Description
ListConsumerGroupsRequest

buildPartial()

public ListConsumerGroupsRequest buildPartial()
Returns
Type Description
ListConsumerGroupsRequest

clear()

public ListConsumerGroupsRequest.Builder clear()
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public ListConsumerGroupsRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public ListConsumerGroupsRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

clearPageSize()

public ListConsumerGroupsRequest.Builder clearPageSize()

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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListConsumerGroupsRequest.Builder

This builder for chaining.

clearPageToken()

public ListConsumerGroupsRequest.Builder clearPageToken()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ListConsumerGroupsRequest.Builder

This builder for chaining.

clearParent()

public ListConsumerGroupsRequest.Builder clearParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ListConsumerGroupsRequest.Builder

This builder for chaining.

clone()

public ListConsumerGroupsRequest.Builder clone()
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

getDefaultInstanceForType()

public ListConsumerGroupsRequest getDefaultInstanceForType()
Returns
Type Description
ListConsumerGroupsRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getPageSize()

public int getPageSize()

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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The pageSize.

getPageToken()

public String getPageToken()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public ByteString getPageTokenBytes()

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public String getParent()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public ByteString getParentBytes()

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(ListConsumerGroupsRequest other)

public ListConsumerGroupsRequest.Builder mergeFrom(ListConsumerGroupsRequest other)
Parameter
Name Description
other ListConsumerGroupsRequest
Returns
Type Description
ListConsumerGroupsRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public ListConsumerGroupsRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public ListConsumerGroupsRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final ListConsumerGroupsRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public ListConsumerGroupsRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

setPageSize(int value)

public ListConsumerGroupsRequest.Builder setPageSize(int value)

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.

int32 page_size = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value int

The pageSize to set.

Returns
Type Description
ListConsumerGroupsRequest.Builder

This builder for chaining.

setPageToken(String value)

public ListConsumerGroupsRequest.Builder setPageToken(String value)

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The pageToken to set.

Returns
Type Description
ListConsumerGroupsRequest.Builder

This builder for chaining.

setPageTokenBytes(ByteString value)

public ListConsumerGroupsRequest.Builder setPageTokenBytes(ByteString value)

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.

string page_token = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for pageToken to set.

Returns
Type Description
ListConsumerGroupsRequest.Builder

This builder for chaining.

setParent(String value)

public ListConsumerGroupsRequest.Builder setParent(String value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value String

The parent to set.

Returns
Type Description
ListConsumerGroupsRequest.Builder

This builder for chaining.

setParentBytes(ByteString value)

public ListConsumerGroupsRequest.Builder setParentBytes(ByteString value)

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

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Parameter
Name Description
value ByteString

The bytes for parent to set.

Returns
Type Description
ListConsumerGroupsRequest.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public ListConsumerGroupsRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final ListConsumerGroupsRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
ListConsumerGroupsRequest.Builder
Overrides