Method: projects.locations.aspectTypes.list

Lists AspectType resources in a project and location.

HTTP request

GET https://dataplex.googleapis.com/v1/{parent=projects/*/locations/*}/aspectTypes

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{locationId} where locationId refers to a Google Cloud region.

Authorization requires the following IAM permission on the specified resource parent:

  • dataplex.aspectTypes.list

Query parameters

Parameters
pageSize

integer

Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

Optional. Page token received from a previous aspectTypes.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to aspectTypes.list must match the call that provided the page token.
filter

string

Optional. Filter request. Filters are case-sensitive. The service supports the following formats:

  • labels.key1 = "value1"
  • labels:key1
  • name = "value"

These restrictions can be conjoined with AND, OR, and NOT conjunctions.
orderBy

string

Optional. Orders the result by name or createTime fields. If not specified, the ordering is undefined.

Request body

The request body must be empty.

Response body

List AspectTypes response.

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

JSON representation 
{
  "aspectTypes": [
    {
      object (AspectType)
    }
  ],
  "nextPageToken": string,
  "unreachableLocations": [
    string
  ]
}
Fields
aspectTypes[]

object (AspectType)

AspectTypes under the given parent location.
nextPageToken

string

Token to retrieve the next page of results, or empty if there are no more results in the list.
unreachableLocations[]

string

Locations that the service couldn't reach.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • dataplex.aspectTypes.list

For more information, see the IAM documentation.