Google Cloud Managed Kafka V1 Client - Class ListTopicsRequest (0.5.0)

Reference documentation and code samples for the Google Cloud Managed Kafka V1 Client class ListTopicsRequest.

Request for ListTopics.

Generated from protobuf message google.cloud.managedkafka.v1.ListTopicsRequest

Namespace

Google \ Cloud \ ManagedKafka \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

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

↳ page_size
int

Optional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned.

↳ page_token
string

Optional. A page token, received from a previous ListTopics call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTopics must match the call that provided the page token.

getParent

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

Returns
Type
Description
string

setParent

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

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Optional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned.

Returns
Type
Description
int

setPageSize

Optional. The maximum number of topics to return. The service may return fewer than this value. If unset or zero, all topics for the parent is returned.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

Optional. A page token, received from a previous ListTopics call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTopics must match the call that provided the page token.

Returns
Type
Description
string

setPageToken

Optional. A page token, received from a previous ListTopics call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListTopics must match the call that provided the page token.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

static::build

Parameter
Name
Description
parent
string

Required. The parent cluster whose topics are to be listed. Structured like projects/{project}/locations/{location}/clusters/{cluster} . Please see ManagedKafkaClient::clusterName() for help formatting this field.

Returns
Type
Description
Design a Mobile Site
View Site in Mobile | Classic
Share by: