Method: visualFamilies.list

Full name: projects.locations.instances.ontologyRecords.visualFamilies.list

Lists VisualFamilies in a given ontology record.

HTTP request


Path parameters

Parameters
parent

string

Required. The onotlogy record to list VisualFamilies for. Format: projects/{project}/locations/{location}/instances/{instance}/ontologyRecords/{ontologyRecord}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of VisualFamilies to return. The service may return fewer than this value. If unspecified, at most 50 VisualFamilies 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 visualFamilies.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to visualFamilies.list must match the call that provided the page token.
filter

string

Optional. A filter to apply to the list of VisualFamilies.
orderBy

string

Optional. Configures ordering of VisualFamilies in the response.

Request body

The request body must be empty.

Response body

Response message for visualFamilies.list.

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

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

object (VisualFamily)

The list of VisualFamilies. Ordered by Id by default.
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 VisualFamilies includes filter without pagination.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.