Class: Google::Cloud::Dataplex::V1::GetEntityRequest

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

Overview

Get metadata entity request.

Defined Under Namespace

Modules: EntityView

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ ::String

Returns Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}..

Returns:

  • (::String) —

    Required. The resource name of the entity: projects/{project_number}/locations/{location_id}/lakes/{lake_id}/zones/{zone_id}/entities/{entity_id}.



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 141

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

  # Entity views for get entity partial result.
  module EntityView
    # The API will default to the `BASIC` view.
    ENTITY_VIEW_UNSPECIFIED = 0

    # Minimal view that does not include the schema.
    BASIC = 1

    # Include basic information and schema.
    SCHEMA = 2

    # Include everything. Currently, this is the same as the SCHEMA view.
    FULL = 4
  end
end

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

Returns Optional. Used to select the subset of entity information to return. Defaults to BASIC.

Returns:



141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
 
# File 'proto_docs/google/cloud/dataplex/v1/metadata.rb', line 141

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

  # Entity views for get entity partial result.
  module EntityView
    # The API will default to the `BASIC` view.
    ENTITY_VIEW_UNSPECIFIED = 0

    # Minimal view that does not include the schema.
    BASIC = 1

    # Include basic information and schema.
    SCHEMA = 2

    # Include everything. Currently, this is the same as the SCHEMA view.
    FULL = 4
  end
end