Google Cloud Dataplex V1 Client - Class ListGlossariesRequest (1.11.0)

Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListGlossariesRequest.

List Glossaries Request

Generated from protobuf message google.cloud.dataplex.v1.ListGlossariesRequest

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name
Description
data
array

Optional. Data for populating the Message object.

↳ parent
string

Required. The parent, which has this collection of Glossaries. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.

↳ page_size
int

Optional. The maximum number of Glossaries to return. The service may return fewer than this value. If unspecified, at most 50 Glossaries 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 ListGlossaries call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaries must match the call that provided the page token.

↳ filter
string

Optional. Filter expression that filters Glossaries listed in the response. Filters on proto fields of Glossary are supported. Examples of using a filter are: - display_name="my-glossary" - categoryCount=1 - termCount=0

↳ order_by
string

Optional. Order by expression that orders Glossaries listed in the response. Order by fields are: name or create_time for the result. If not specified, the ordering is undefined.

getParent

Required. The parent, which has this collection of Glossaries.

Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.

Returns
Type
Description
string

setParent

Required. The parent, which has this collection of Glossaries.

Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getPageSize

Optional. The maximum number of Glossaries to return. The service may return fewer than this value. If unspecified, at most 50 Glossaries 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 Glossaries to return. The service may return fewer than this value. If unspecified, at most 50 Glossaries 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 ListGlossaries call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaries must match the call that provided the page token.

Returns
Type
Description
string

setPageToken

Optional. A page token, received from a previous ListGlossaries call.

Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListGlossaries must match the call that provided the page token.

Parameter
Name
Description
var
string
Returns
Type
Description
$this

getFilter

Optional. Filter expression that filters Glossaries listed in the response.

Filters on proto fields of Glossary are supported. Examples of using a filter are:

  • display_name="my-glossary"
  • categoryCount=1
  • termCount=0
Returns
Type
Description
string

setFilter

Optional. Filter expression that filters Glossaries listed in the response.

Filters on proto fields of Glossary are supported. Examples of using a filter are:

  • display_name="my-glossary"
  • categoryCount=1
  • termCount=0
Parameter
Name
Description
var
string
Returns
Type
Description
$this

getOrderBy

Optional. Order by expression that orders Glossaries 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 Glossaries 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 Glossaries. Format: projects/{project_id_or_number}/locations/{location_id} where location_id refers to a Google Cloud region. Please see BusinessGlossaryServiceClient::locationName() for help formatting this field.

Returns
Type
Description
Create a Mobile Website
View Site in Mobile | Classic
Share by: