Cloud PubSub V1 Client - Class ListSchemasRequest (2.3.0)

Reference documentation and code samples for the Cloud PubSub V1 Client class ListSchemasRequest.

Request for the ListSchemas method.

Generated from protobuf message google.pubsub.v1.ListSchemasRequest

Namespace

Google \ Cloud \ PubSub \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ parent`	`string` Required. The name of the project in which to list schemas. Format is `projects/{project-id}`.
`↳ view`	`int` The set of Schema fields to return in the response. If not set, returns Schemas with `name` and `type`, but not `definition`. Set to `FULL` to retrieve all fields.
`↳ page_size`	`int` Maximum number of schemas to return.
`↳ page_token`	`string` The value returned by the last `ListSchemasResponse`; indicates that this is a continuation of a prior `ListSchemas` call, and that the system should return the next page of data.

getParent

Required. The name of the project in which to list schemas.

Format is projects/{project-id}.

Returns
Type	Description
`string`

setParent

Required. The name of the project in which to list schemas.

Format is projects/{project-id}.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getView

The set of Schema fields to return in the response. If not set, returns Schemas with name and type, but not definition. Set to FULL to retrieve all fields.

Returns
Type	Description
`int`

setView

The set of Schema fields to return in the response. If not set, returns Schemas with name and type, but not definition. Set to FULL to retrieve all fields.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageSize

Maximum number of schemas to return.

Returns
Type	Description
`int`

setPageSize

Maximum number of schemas to return.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageToken

The value returned by the last ListSchemasResponse; indicates that this is a continuation of a prior ListSchemas call, and that the system should return the next page of data.

Returns
Type	Description
`string`

setPageToken

The value returned by the last ListSchemasResponse; indicates that this is a continuation of a prior ListSchemas call, and that the system should return the next page of data.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

static::build

Parameter
Name	Description
`parent`	`string` Required. The name of the project in which to list schemas. Format is `projects/{project-id}`. Please see Google\Cloud\PubSub\V1\SchemaServiceClient::projectName() for help formatting this field.

Returns
Type	Description
`Google\Cloud\PubSub\V1\ListSchemasRequest`