Google Cloud Datastream V1 Client - Class ListStreamObjectsRequest (1.5.5)

Reference documentation and code samples for the Google Cloud Datastream V1 Client class ListStreamObjectsRequest.

Request for listing all objects for a specific stream.

Generated from protobuf message google.cloud.datastream.v1.ListStreamObjectsRequest

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent stream that owns the collection of objects.

↳ page_size
int

Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token
string

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

getParent

Required. The parent stream that owns the collection of objects.

Returns
Type
Description
string

setParent

Required. The parent stream that owns the collection of objects.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Maximum number of objects to return. Default is 50.

The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type
Description
int

setPageSize

Maximum number of objects to return. Default is 50.

The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name
Description
var
int
Returns
Type
Description
$this

getPageToken

Page token received from a previous ListStreamObjectsRequest call.

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

Returns
Type
Description
string

setPageToken

Page token received from a previous ListStreamObjectsRequest call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListStreamObjectsRequest 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 stream that owns the collection of objects. Please see Google\Cloud\Datastream\V1\DatastreamClient::streamName() for help formatting this field.

Design a Mobile Site
View Site in Mobile | Classic
Share by: