Google Cloud Discovery Engine V1 Client - Class ListSchemasRequest (1.0.0-RC1)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ListSchemasRequest.

Request message for SchemaService.ListSchemas method.

Generated from protobuf message google.cloud.discoveryengine.v1.ListSchemasRequest

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ parent string

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

↳ page_size int

The maximum number of Schemas to return. The service may return fewer than this value. If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.

↳ page_token string

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

getParent

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

Returns
Type Description
string

setParent

Required. The parent data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

The maximum number of Schemas to return. The service may return fewer than this value.

If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.

Returns
Type Description
int

setPageSize

The maximum number of Schemas to return. The service may return fewer than this value.

If unspecified, at most 100 Schemas are returned. The maximum value is 1000; values above 1000 are set to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SchemaService.ListSchemas must match the call that provided the page token.

Returns
Type Description
string

setPageToken

A page token, received from a previous SchemaService.ListSchemas call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to SchemaService.ListSchemas 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 data store resource name, in the format of projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}. Please see Google\Cloud\DiscoveryEngine\V1\SchemaServiceClient::dataStoreName() for help formatting this field.

Returns
Type Description
Google\Cloud\DiscoveryEngine\V1\ListSchemasRequest