Interface ListChannelsRequestOrBuilder (1.54.0)

public interface ListChannelsRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getOrderBy()

public abstract String getOrderBy()

The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, channel_id.

string order_by = 4;

Returns
Type Description
String

The orderBy.

getOrderByBytes()

public abstract ByteString getOrderByBytes()

The sorting order of the resources returned. Value should be a comma-separated list of fields. The default sorting order is ascending. To specify descending order for a field, append a desc suffix; for example: name desc, channel_id.

string order_by = 4;

Returns
Type Description
ByteString

The bytes for orderBy.

getPageSize()

public abstract int getPageSize()

The maximum number of channels to return on each page.

Note: The service may send fewer.

int32 page_size = 2;

Returns
Type Description
int

The pageSize.

getPageToken()

public abstract String getPageToken()

The page token; provide the value from the next_page_token field in a previous ListChannels call to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannels must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
String

The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

The page token; provide the value from the next_page_token field in a previous ListChannels call to retrieve the subsequent page.

When paginating, all other parameters provided to ListChannels must match the call that provided the page token.

string page_token = 3;

Returns
Type Description
ByteString

The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The parent collection to list channels on.

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

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent collection to list channels on.

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

Returns
Type Description
ByteString

The bytes for parent.