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 messagegoogle.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 previousListStreamObjectsRequestcall. Provide this to retrieve the subsequent page. When paginating, all other parameters provided toListStreamObjectsRequestmust 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 previousListStreamObjectsRequestcall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListStreamObjectsRequestmust match the call that provided the page
token.
Returns
Type
Description
string
setPageToken
Page token received from a previousListStreamObjectsRequestcall.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided toListStreamObjectsRequestmust 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 seeDatastreamClient::streamName()for help formatting this field.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud Datastream V1 Client - Class ListStreamObjectsRequest (2.4.0)\n\nVersion latestkeyboard_arrow_down\n\n- [2.4.0 (latest)](/php/docs/reference/cloud-datastream/latest/V1.ListStreamObjectsRequest)\n- [2.3.1](/php/docs/reference/cloud-datastream/2.3.1/V1.ListStreamObjectsRequest)\n- [2.2.0](/php/docs/reference/cloud-datastream/2.2.0/V1.ListStreamObjectsRequest)\n- [2.1.1](/php/docs/reference/cloud-datastream/2.1.1/V1.ListStreamObjectsRequest)\n- [2.0.1](/php/docs/reference/cloud-datastream/2.0.1/V1.ListStreamObjectsRequest)\n- [1.5.5](/php/docs/reference/cloud-datastream/1.5.5/V1.ListStreamObjectsRequest)\n- [1.4.2](/php/docs/reference/cloud-datastream/1.4.2/V1.ListStreamObjectsRequest)\n- [1.3.0](/php/docs/reference/cloud-datastream/1.3.0/V1.ListStreamObjectsRequest)\n- [1.2.1](/php/docs/reference/cloud-datastream/1.2.1/V1.ListStreamObjectsRequest)\n- [1.1.0](/php/docs/reference/cloud-datastream/1.1.0/V1.ListStreamObjectsRequest)\n- [1.0.5](/php/docs/reference/cloud-datastream/1.0.5/V1.ListStreamObjectsRequest) \nReference documentation and code samples for the Google Cloud Datastream V1 Client class ListStreamObjectsRequest.\n\nRequest for listing all objects for a specific stream.\n\nGenerated from protobuf message `google.cloud.datastream.v1.ListStreamObjectsRequest`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ Datastream \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getParent\n\nRequired. The parent stream that owns the collection of objects.\n\n### setParent\n\nRequired. The parent stream that owns the collection of objects.\n\n### getPageSize\n\nMaximum number of objects to return. Default is 50.\n\nThe maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### setPageSize\n\nMaximum number of objects to return. Default is 50.\n\nThe maximum value is 1000; values above 1000 will be coerced to 1000.\n\n### getPageToken\n\nPage token received from a previous `ListStreamObjectsRequest` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to\n`ListStreamObjectsRequest` must match the call that provided the page\ntoken.\n\n### setPageToken\n\nPage token received from a previous `ListStreamObjectsRequest` call.\n\nProvide this to retrieve the subsequent page.\nWhen paginating, all other parameters provided to\n`ListStreamObjectsRequest` must match the call that provided the page\ntoken.\n\n### static::build"]]
