Google Cloud App Topology V1 Client - Class ExploreSchemaRequest (0.2.0)

Reference documentation and code samples for the Google Cloud App Topology V1 Client class ExploreSchemaRequest.

Request for ExploreSchema.

Generated from protobuf message google.cloud.apptopology.v1.ExploreSchemaRequest

Namespace

Google \ Cloud \ AppTopology \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`data`	`array` Optional. Data for populating the Message object.
`↳ name`	`string` Required. The name of the singleton domain schema resource. Format: `projects/{project}/locations/{location}/domains/{domain}/schema`
`↳ start_labels`	`string[]` 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`	`string` 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.

getName

Required. The name of the singleton domain schema resource.

Format: projects/{project}/locations/{location}/domains/{domain}/schema

Returns
Type	Description
`string`

setName

Required. The name of the singleton domain schema resource.

Format: projects/{project}/locations/{location}/domains/{domain}/schema

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getStartLabels

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.

Returns
Type	Description
`Google\Protobuf\RepeatedField<string>`

setStartLabels

Optional. Starting label names to begin traversal.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDepth

Optional. The maximum depth of BFS traversal hops to perform from the starting node types or label names. Defaults to 0 if unspecified.

Returns
Type	Description
`int`

setDepth

Optional. The maximum depth of BFS traversal hops to perform from the starting node types or label names. Defaults to 0 if unspecified.

Parameter
Name	Description
`var`	`int`

Returns
Type	Description
`$this`

getPageSize

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.

Returns
Type	Description
`int`

setPageSize