Class: Google::Cloud::Dataplex::V1::ListEntitiesRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dataplex/v1/metadata.rb

Overview

List metadata entities request.

Defined Under Namespace

Modules: EntityView

Instance Attribute Summary collapse

Instance Attribute Details

#filter ⇒ ::String

Returns 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"


101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 101

class ListEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Entity views.
  module EntityView
    # The default unset value. Return both table and fileset entities
    # if unspecified.
    ENTITY_VIEW_UNSPECIFIED = 0

    # Only list table entities.
    TABLES = 1

    # Only list fileset entities.
    FILESETS = 2
  end
end

#page_size ⇒ ::Integer

Returns 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.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 101

class ListEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Entity views.
  module EntityView
    # The default unset value. Return both table and fileset entities
    # if unspecified.
    ENTITY_VIEW_UNSPECIFIED = 0

    # Only list table entities.
    TABLES = 1

    # Only list fileset entities.
    FILESETS = 2
  end
end

#page_token ⇒ ::String

Returns 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.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 101

class ListEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Entity views.
  module EntityView
    # The default unset value. Return both table and fileset entities
    # if unspecified.
    ENTITY_VIEW_UNSPECIFIED = 0

    # Only list table entities.
    TABLES = 1

    # Only list fileset entities.
    FILESETS = 2
  end
end

#parent ⇒ ::String

Returns 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}.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 101

class ListEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Entity views.
  module EntityView
    # The default unset value. Return both table and fileset entities
    # if unspecified.
    ENTITY_VIEW_UNSPECIFIED = 0

    # Only list table entities.
    TABLES = 1

    # Only list fileset entities.
    FILESETS = 2
  end
end

#view ⇒ ::Google::Cloud::Dataplex::V1::ListEntitiesRequest::EntityView

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

Returns:



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 101

class ListEntitiesRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Entity views.
  module EntityView
    # The default unset value. Return both table and fileset entities
    # if unspecified.
    ENTITY_VIEW_UNSPECIFIED = 0

    # Only list table entities.
    TABLES = 1

    # Only list fileset entities.
    FILESETS = 2
  end
end