Interface ListEntitiesRequestOrBuilder (1.26.0)

Version 1.26.0

• 1.51.0 (latest)
• 1.50.0
• 1.49.0
• 1.47.0
• 1.46.0
• 1.45.0
• 1.44.0
• 1.43.0
• 1.42.0
• 1.41.0
• 1.40.0
• 1.39.0
• 1.38.0
• 1.37.0
• 1.35.0
• 1.34.0
• 1.33.0
• 1.32.0
• 1.31.0
• 1.30.0
• 1.29.0
• 1.28.0
• 1.27.0
• 1.26.0
• 1.25.0
• 1.22.0
• 1.21.0
• 1.20.0
• 1.19.0
• 1.18.0
• 1.17.0
• 1.16.0
• 1.15.0
• 1.14.0
• 1.13.0
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.2
• 1.0.1
• 0.2.2

public interface ListEntitiesRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getFilter()

public abstract String 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"

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The filter.

getFilterBytes()

public abstract ByteString getFilterBytes()

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"

string filter = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for filter.

getPageSize()

public abstract int 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.

int32 page_size = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The pageSize.

getPageToken()

public abstract String 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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The pageToken.

getPageTokenBytes()

public abstract ByteString getPageTokenBytes()

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.

string page_token = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for pageToken.

getParent()

public abstract String getParent()

Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
String	The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
ByteString	The bytes for parent.

getView()

public abstract ListEntitiesRequest.EntityView getView()

Required. Specify the entity view to make a partial list request.

.google.cloud.dataplex.v1.ListEntitiesRequest.EntityView view = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
ListEntitiesRequest.EntityView	The view.

getViewValue()

public abstract int getViewValue()

Required. Specify the entity view to make a partial list request.

.google.cloud.dataplex.v1.ListEntitiesRequest.EntityView view = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
int	The enum numeric value on the wire for view.