Google Cloud Datastream V1 Client - Class ListStreamObjectsRequest (1.3.0)

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
NameDescription
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
TypeDescription
string

setParent

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

Parameter
NameDescription
var string
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var int
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
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.

Returns
TypeDescription
Google\Cloud\Datastream\V1\ListStreamObjectsRequest