Method: propertySchemaDefinitions.list

Full name: projects.locations.instances.propertySchemaDefinitions.list

Lists PropertySchemaDefinitions.

HTTP request


Path parameters

Parameters
parent

string

Required. The instance to list PropertySchemaDefinitions for. Format: projects/{project}/locations/{location}/instances/{instance}/propertySchemaDefinitions

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of PropertySchemaDefinitions to return. The service may return fewer than this value. If unspecified, at most 50 PropertySchemaDefinitions will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. A page token, received from a previous propertySchemaDefinitions.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListBooks must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of PropertySchemaDefinitions. Supported filter fields: * raw_field_title: Filter by the raw field title. * displayName: Filter by the display label. * group_title: Filter by the group title. * prefix: Filter by the prefix. * trimPrefix: Filter by the trim prefix. * system: Filter by the system. * highlighted: Filter by the highlighted. Example: filter="prefix='some_prefix'"
orderBy

string

Optional. Configures ordering of PropertySchemaDefinitions in the response. If not specified, PropertySchemaDefinitions are returned in descending order of their create time. The default ordering is by create time in descending order. The orderBy string is a comma separated list of fields. Supported sort fields: * raw_field_title * displayName * group_title * prefix * trimPrefix * system * highlighted example: "prefix desc, system"

Request body

The request body must be empty.

Response body

Response message for propertySchemaDefinitions.list.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "propertySchemaDefinitions": [
    {
      object (PropertySchemaDefinition)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
propertySchemaDefinitions[]

object (PropertySchemaDefinition)

The list of PropertySchemaDefinitions.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

The total number of PropertySchemaDefinitions.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.