public sealed class ListEntitiesRequest : IMessage<ListEntitiesRequest>, IEquatable<ListEntitiesRequest>, IDeepCloneable<ListEntitiesRequest>, IBufferMessage, IMessage, IPageRequestReference documentation and code samples for the Cloud Dataplex v1 API class ListEntitiesRequest.
List metadata entities request.
Implements
IMessageListEntitiesRequest, IEquatableListEntitiesRequest, IDeepCloneableListEntitiesRequest, IBufferMessage, IMessage, IPageRequestNamespace
Google.Cloud.Dataplex.V1Assembly
Google.Cloud.Dataplex.V1.dll
Constructors
ListEntitiesRequest()
public ListEntitiesRequest()ListEntitiesRequest(ListEntitiesRequest)
public ListEntitiesRequest(ListEntitiesRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
ListEntitiesRequest |
Properties
Filter
public string Filter { get; set; }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"
| Property Value | |
|---|---|
| Type | Description |
string |
|
PageSize
public int PageSize { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
int |
|
PageToken
public string PageToken { get; set; }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.
| Property Value | |
|---|---|
| Type | Description |
string |
|
Parent
public string Parent { get; set; }Required. The resource name of the parent zone:
projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
| Property Value | |
|---|---|
| Type | Description |
string |
|
ParentAsZoneName
public ZoneName ParentAsZoneName { get; set; }| Property Value | |
|---|---|
| Type | Description |
ZoneName |
|
View
public ListEntitiesRequest.Types.EntityView View { get; set; }Required. Specify the entity view to make a partial list request.
| Property Value | |
|---|---|
| Type | Description |
ListEntitiesRequestTypesEntityView |
|