public sealed class ListGlossaryTermsRequest : IMessage<ListGlossaryTermsRequest>, IEquatable<ListGlossaryTermsRequest>, IDeepCloneable<ListGlossaryTermsRequest>, IBufferMessage, IMessage, IPageRequest
Reference documentation and code samples for the Cloud Dataplex v1 API class ListGlossaryTermsRequest.
List GlossaryTerms Request
Implements
IMessageListGlossaryTermsRequest, IEquatableListGlossaryTermsRequest, IDeepCloneableListGlossaryTermsRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
ListGlossaryTermsRequest()
public ListGlossaryTermsRequest()
ListGlossaryTermsRequest(ListGlossaryTermsRequest)
public ListGlossaryTermsRequest(ListGlossaryTermsRequest other)
Parameter | |
---|---|
Name | Description |
other |
ListGlossaryTermsRequest |
Properties
Filter
public string Filter { get; set; }
Optional. Filter expression that filters GlossaryTerms 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 GlossaryTerms that are directly nested under the specified parent.
Property Value | |
---|---|
Type | Description |
string |
OrderBy
public string OrderBy { get; set; }
Optional. Order by expression that orders GlossaryTerms listed in the
response. Order by fields are: name
or create_time
for the result. If
not specified, the ordering is undefined.
Property Value | |
---|---|
Type | Description |
string |
PageSize
public int PageSize { get; set; }
Optional. The maximum number of GlossaryTerms to return. The service may return fewer than this value. If unspecified, at most 50 GlossaryTerms will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
Property Value | |
---|---|
Type | Description |
int |
PageToken
public string PageToken { get; set; }
Optional. A page token, received from a previous ListGlossaryTerms
call.
Provide this to retrieve the subsequent page.
When paginating, all other parameters provided to ListGlossaryTerms
must
match the call that provided the page token.
Property Value | |
---|---|
Type | Description |
string |
Parent
public string Parent { get; set; }
Required. The parent, which has this collection of GlossaryTerms.
Format:
projects/{project_id_or_number}/locations/{location_id}/glossaries/{glossary_id}
where location_id
refers to a Google Cloud region.
Property Value | |
---|---|
Type | Description |
string |
ParentAsGlossaryName
public GlossaryName ParentAsGlossaryName { get; set; }
GlossaryName-typed view over the Parent resource name property.
Property Value | |
---|---|
Type | Description |
GlossaryName |