Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListGlossaryCategoriesRequest.
List GlossaryCategories Request
Generated from protobuf message google.cloud.dataplex.v1.ListGlossaryCategoriesRequest
Namespace
Google \ Cloud \ Dataplex \ V1Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region. |
↳ page_size |
int
Optional. The maximum number of GlossaryCategories to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000. |
↳ page_token |
string
Optional. A page token, received from a previous |
↳ filter |
string
Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields: - immediate_parent Examples of using a filter are: - |
↳ order_by |
string
Optional. Order by expression that orders GlossaryCategories listed in the response. Order by fields are: |
getParent
Required. The parent, which has this collection of GlossaryCategories.
Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.
| Returns | |
|---|---|
| Type | Description |
string |
|
setParent
Required. The parent, which has this collection of GlossaryCategories.
Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageSize
Optional. The maximum number of GlossaryCategories to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Returns | |
|---|---|
| Type | Description |
int |
|
setPageSize
Optional. The maximum number of GlossaryCategories to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryCategories will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPageToken
Optional. A page token, received from a previous ListGlossaryCategories
call. Provide this to retrieve the subsequent page. When paginating, all
other parameters provided to ListGlossaryCategories must match the call
that provided the page token.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPageToken
Optional. A page token, received from a previous ListGlossaryCategories
call. Provide this to retrieve the subsequent page. When paginating, all
other parameters provided to ListGlossaryCategories must match the call
that provided the page token.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFilter
Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:
- immediate_parent
Examples of using a filter are:
-
immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"-immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"This will only return the GlossaryCategories that are directly nested under the specified parent.
| Returns | |
|---|---|
| Type | Description |
string |
|
setFilter
Optional. Filter expression that filters GlossaryCategories listed in the response. Filters are supported on the following fields:
- immediate_parent
Examples of using a filter are:
-
immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}"-immediate_parent="projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}/categories/{category_id}"This will only return the GlossaryCategories that are directly nested under the specified parent.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getOrderBy
Optional. Order by expression that orders GlossaryCategories listed in the
response. Order by fields are: name or create_time for the result. If
not specified, the ordering is undefined.
| Returns | |
|---|---|
| Type | Description |
string |
|
setOrderBy
Optional. Order by expression that orders GlossaryCategories listed in the
response. Order by fields are: name or create_time for the result. If
not specified, the ordering is undefined.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
static::build
| Parameter | |
|---|---|
| Name | Description |
parent |
string
Required. The parent, which has this collection of GlossaryCategories. Format: projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id} Location is the Google Cloud region. Please see BusinessGlossaryServiceClient::glossaryName() for help formatting this field. |
| Returns | |
|---|---|
| Type | Description |
ListGlossaryCategoriesRequest |
|