ExploreSchemaRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request for ExploreSchema.
Attributes |
|
|---|---|
| Name | Description |
name |
str
Required. The name of the singleton domain schema resource. Format: projects/{project}/locations/{location}/domains/{domain}/schema
|
start_labels |
MutableSequence[str]
Optional. Starting label names to begin traversal. Substring, case-insensitive matches are performed against allowed label names in the schema. A maximum of 10 start_labels can be specified; providing more will
result in an INVALID_ARGUMENT error. If start_labels
is unset or empty, all authorized node types will be used as
the starting set.
|
depth |
int
Optional. The maximum depth of BFS traversal hops to perform from the starting node types or label names. Defaults to 0 if unspecified. |
page_size |
int
Optional. The maximum number of schema elements to return in a single page. - The service might return fewer elements than this value if adding another edge and its required endpoint nodes exceeds page_size.
- If omitted or set to 0, default (100) will be used.
- Minimum page_size is 3 to ensure at least one edge and its
endpoint nodes fit on a page; values below 3 (e.g. 1 or 2)
are changed to 3.
- Maximum value is 500.
|
page_token |
str
Optional. A page token received from a previous ExploreSchema call. Provide this to retrieve the
subsequent page.
When paginating, all other parameters (except page_size)
provided to ExploreSchema must match the call that
provided the page token.
|