Google Cloud Dataplex V1 Client - Class ListAspectTypesRequest (1.11.0)

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

List AspectTypes request.

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

Namespace

Google \ Cloud \ Dataplex \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.
↳ page_size int

Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.
↳ page_token string

Optional. Page token received from a previous ListAspectTypes call. Provide this to retrieve the subsequent page. When paginating, all other parameters you provide to ListAspectTypes must match the call that provided the page token.
↳ filter string

Optional. Filter request. Filters are case-sensitive. The service supports the following formats: * * labels.key1 = "value1" * * labels:key1 * * name = "value" These restrictions can be conjoined with AND, OR, and NOT conjunctions.
↳ order_by string

Optional. Orders the result by name or create_time fields. If not specified, the ordering is undefined.

getParent

Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.

Returns
Type Description
string

setParent

Required. The resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region.

Parameter
Name Description
var string
Returns
Type Description
$this

getPageSize

Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.

Returns
Type Description
int

setPageSize

Optional. Maximum number of AspectTypes to return. The service may return fewer than this value. If unspecified, the service returns at most 10 AspectTypes. The maximum value is 1000; values above 1000 will be coerced to 1000.

Parameter
Name Description
var int
Returns
Type Description
$this

getPageToken

Optional. Page token received from a previous ListAspectTypes call.

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

Returns
Type Description
string

setPageToken

Optional. Page token received from a previous ListAspectTypes call.

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

Parameter
Name Description
var string
Returns
Type Description
$this

getFilter

Optional. Filter request. Filters are case-sensitive.

The service supports the following formats:

  • labels.key1 = "value1"
  • labels:key1
  • name = "value" These restrictions can be conjoined with AND, OR, and NOT conjunctions.
Returns
Type Description
string

setFilter

Optional. Filter request. Filters are case-sensitive.

The service supports the following formats:

  • labels.key1 = "value1"
  • labels:key1
  • name = "value" These restrictions can be conjoined with AND, OR, and NOT conjunctions.
Parameter
Name Description
var string
Returns
Type Description
$this

getOrderBy

Optional. Orders the result by name or create_time fields.

If not specified, the ordering is undefined.

Returns
Type Description
string

setOrderBy

Optional. Orders the result by name or create_time fields.

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 resource name of the AspectType location, of the form: projects/{project_number}/locations/{location_id} where location_id refers to a Google Cloud region. Please see CatalogServiceClient::locationName() for help formatting this field.
Returns
Type Description
ListAspectTypesRequest