Reference documentation and code samples for the Google Cloud Dataplex V1 Client class ListEntitiesRequest.
List metadata entities request.
Generated from protobuf message google.cloud.dataplex.v1.ListEntitiesRequest
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ parent |
string
Required. The resource name of the parent zone: |
↳ view |
int
Required. Specify the entity view to make a partial list request. |
↳ page_size |
int
Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500. |
↳ page_token |
string
Optional. Page token received from a previous |
↳ filter |
string
Optional. The following filter parameters can be added to the URL to limit the entities returned by the API: - Entity ID: ?filter="id=entityID" - Asset ID: ?filter="asset=assetID" - Data path ?filter="data_path=gs://my-bucket" - Is HIVE compatible: ?filter=”hive_compatible=true” - Is BigQuery compatible: ?filter=”bigquery_compatible=true” |
getParent
Required. The resource name of the parent zone:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Returns | |
|---|---|
| Type | Description |
string | |
setParent
Required. The resource name of the parent zone:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
Generated from protobuf field string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = {
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getView
Required. Specify the entity view to make a partial list request.
Generated from protobuf field .google.cloud.dataplex.v1.ListEntitiesRequest.EntityView view = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int | |
setView
Required. Specify the entity view to make a partial list request.
Generated from protobuf field .google.cloud.dataplex.v1.ListEntitiesRequest.EntityView view = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageSize
Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500.
Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int | |
setPageSize
Optional. Maximum number of entities to return. The service may return fewer than this value. If unspecified, 100 entities will be returned by default. The maximum value is 500; larger values will will be truncated to 500.
Generated from protobuf field int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getPageToken
Optional. Page token received from a previous ListEntities call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListEntities must match the call that provided the
page token.
Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setPageToken
Optional. Page token received from a previous ListEntities call. Provide
this to retrieve the subsequent page. When paginating, all other parameters
provided to ListEntities must match the call that provided the
page token.
Generated from protobuf field string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getFilter
Optional. The following filter parameters can be added to the URL to limit the entities returned by the API:
- Entity ID: ?filter="id=entityID"
- Asset ID: ?filter="asset=assetID"
- Data path ?filter="data_path=gs://my-bucket"
- Is HIVE compatible: ?filter=”hive_compatible=true”
- Is BigQuery compatible: ?filter=”bigquery_compatible=true”
Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setFilter
Optional. The following filter parameters can be added to the URL to limit the entities returned by the API:
- Entity ID: ?filter="id=entityID"
- Asset ID: ?filter="asset=assetID"
- Data path ?filter="data_path=gs://my-bucket"
- Is HIVE compatible: ?filter=”hive_compatible=true”
- Is BigQuery compatible: ?filter=”bigquery_compatible=true”
Generated from protobuf field string filter = 5 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |