Dataplex V1 API - Class Google::Cloud::Dataplex::V1::ListEntitiesRequest (v0.20.0)

Reference documentation and code samples for the Dataplex V1 API class Google::Cloud::Dataplex::V1::ListEntitiesRequest.

List metadata entities request.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#filter

def filter() -> ::String
Returns
  • (::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"

#filter=

def filter=(value) -> ::String
Parameter
  • value (::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"
Returns
  • (::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"

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — 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_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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

def page_token() -> ::String
Returns
  • (::String) — 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.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — 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.
Returns
  • (::String) — 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.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.
Returns
  • (::String) — Required. The resource name of the parent zone: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}.

#view

def view() -> ::Google::Cloud::Dataplex::V1::ListEntitiesRequest::EntityView
Returns

#view=

def view=(value) -> ::Google::Cloud::Dataplex::V1::ListEntitiesRequest::EntityView
Parameter
Returns