Google Cloud Datastream V1 Client - Class ListStreamsRequest (1.3.0)

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

Request message for listing streams.

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

Namespace

Google \ Cloud \ Datastream \ V1

Methods

__construct

Constructor.

Parameters
NameDescription
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent that owns the collection of streams.

↳ page_size int

Maximum number of streams to return. If unspecified, at most 50 streams will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

↳ page_token string

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

↳ filter string

Filter request.

↳ order_by string

Order by fields for the result.

getParent

Required. The parent that owns the collection of streams.

Returns
TypeDescription
string

setParent

Required. The parent that owns the collection of streams.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getPageSize

Maximum number of streams to return.

If unspecified, at most 50 streams will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
TypeDescription
int

setPageSize

Maximum number of streams to return.

If unspecified, at most 50 streams will be returned. 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 ListStreams call.

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

Returns
TypeDescription
string

setPageToken

Page token received from a previous ListStreams call.

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

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getFilter

Filter request.

Returns
TypeDescription
string

setFilter

Filter request.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

getOrderBy

Order by fields for the result.

Returns
TypeDescription
string

setOrderBy

Order by fields for the result.

Parameter
NameDescription
var string
Returns
TypeDescription
$this

static::build

Parameter
NameDescription
parent string

Required. The parent that owns the collection of streams. Please see Google\Cloud\Datastream\V1\DatastreamClient::locationName() for help formatting this field.

Returns
TypeDescription
Google\Cloud\Datastream\V1\ListStreamsRequest