Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Entry

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/datacatalog_v1beta1/classes.rb,
lib/google/apis/datacatalog_v1beta1/representations.rb,
lib/google/apis/datacatalog_v1beta1/representations.rb

Overview

Entry Metadata. A Data Catalog Entry resource represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic), or outside of Google Cloud Platform. Clients can use the linked_resource field in the Entry resource to refer to the original resource ID of the source system. An Entry resource contains resource details, such as its schema. An Entry can also be used to attach flexible metadata, such as a Tag.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1beta1Entry

Returns a new instance of GoogleCloudDatacatalogV1beta1Entry.



2242
2243
2244
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2242

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#bigquery_date_sharded_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1BigQueryDateShardedSpec

Spec for a group of BigQuery tables with name pattern [prefix]YYYYMMDD. Context: https://cloud.google.com/bigquery/docs/partitioned-tables# partitioning_versus_sharding Corresponds to the JSON property bigqueryDateShardedSpec

Returns:



2152
2153
2154
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2152

def bigquery_date_sharded_spec
  @bigquery_date_sharded_spec
end

#bigquery_table_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1BigQueryTableSpec

Describes a BigQuery table. Corresponds to the JSON property bigqueryTableSpec

Returns:



2157
2158
2159
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2157

def bigquery_table_spec
  @bigquery_table_spec
end

#description ⇒ String

Entry description, which can consist of several sentences or paragraphs that describe entry contents. Default value is an empty string. Corresponds to the JSON property description

Returns:

  • (String) 


2163
2164
2165
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2163

def description
  @description
end

#display_name ⇒ String

Display information such as title and description. A short name to identify the entry, for example, "Analytics Data - Jan 2011". Default value is an empty string. Corresponds to the JSON property displayName

Returns:

  • (String) 


2170
2171
2172
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2170

def display_name
  @display_name
end

#gcs_fileset_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1GcsFilesetSpec

Describes a Cloud Storage fileset entry. Corresponds to the JSON property gcsFilesetSpec

Returns:



2175
2176
2177
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2175

def gcs_fileset_spec
  @gcs_fileset_spec
end

#integrated_system ⇒ String

Output only. This field indicates the entry's source system that Data Catalog integrates with, such as BigQuery or Pub/Sub. Corresponds to the JSON property integratedSystem

Returns:

  • (String) 


2181
2182
2183
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2181

def integrated_system
  @integrated_system
end

#linked_resource ⇒ String

The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the full name of the resource. For example, the linked_resource for a table resource from BigQuery is: * //bigquery. googleapis.com/projects/projectId/datasets/datasetId/tables/tableId Output only when Entry is of type in the EntryType enum. For entries with user_specified_type, this field is optional and defaults to an empty string. Corresponds to the JSON property linkedResource

Returns:

  • (String) 


2192
2193
2194
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2192

def linked_resource
  @linked_resource
end

#name ⇒ String

Output only. The Data Catalog resource name of the entry in URL format. Example: * projects/project_id/locations/location/entryGroups/ entry_group_id/entries/entry_id Note that this Entry and its child resources may not actually be stored in the location in this name. Corresponds to the JSON property name

Returns:

  • (String) 


2200
2201
2202
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2200

def name
  @name
end

#schema ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1Schema

Represents a schema (e.g. BigQuery, GoogleSQL, Avro schema). Corresponds to the JSON property schema

Returns:



2205
2206
2207
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2205

def schema
  @schema
end

#source_system_timestamps ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1SystemTimestamps

Timestamps about this resource according to a particular system. Corresponds to the JSON property sourceSystemTimestamps

Returns:



2210
2211
2212
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2210

def source_system_timestamps
  @source_system_timestamps
end

#type ⇒ String

The type of the entry. Only used for Entries with types in the EntryType enum. Corresponds to the JSON property type

Returns:

  • (String) 


2215
2216
2217
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2215

def type
  @type
end

#usage_signal ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1beta1UsageSignal

The set of all usage signals that we store in Data Catalog. Corresponds to the JSON property usageSignal

Returns:



2220
2221
2222
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2220

def usage_signal
  @usage_signal
end

#user_specified_system ⇒ String

This field indicates the entry's source system that Data Catalog does not integrate with. user_specified_system strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Corresponds to the JSON property userSpecifiedSystem

Returns:

  • (String) 


2228
2229
2230
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2228

def user_specified_system
  @user_specified_system
end

#user_specified_type ⇒ String

Entry type if it does not fit any of the input-allowed values listed in EntryType enum above. When creating an entry, users should check the enum values first, if nothing matches the entry to be created, then provide a custom value, for example "my_special_type". user_specified_type strings must begin with a letter or underscore and can only contain letters, numbers, and underscores; are case insensitive; must be at least 1 character and at most 64 characters long. Currently, only FILESET enum value is allowed. All other entries created through Data Catalog must use user_specified_type. Corresponds to the JSON property userSpecifiedType

Returns:

  • (String) 


2240
2241
2242
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2240

def user_specified_type
  @user_specified_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 2247

def update!(**args)
  @bigquery_date_sharded_spec = args[:bigquery_date_sharded_spec] if args.key?(:bigquery_date_sharded_spec)
  @bigquery_table_spec = args[:bigquery_table_spec] if args.key?(:bigquery_table_spec)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @gcs_fileset_spec = args[:gcs_fileset_spec] if args.key?(:gcs_fileset_spec)
  @integrated_system = args[:integrated_system] if args.key?(:integrated_system)
  @linked_resource = args[:linked_resource] if args.key?(:linked_resource)
  @name = args[:name] if args.key?(:name)
  @schema = args[:schema] if args.key?(:schema)
  @source_system_timestamps = args[:source_system_timestamps] if args.key?(:source_system_timestamps)
  @type = args[:type] if args.key?(:type)
  @usage_signal = args[:usage_signal] if args.key?(:usage_signal)
  @user_specified_system = args[:user_specified_system] if args.key?(:user_specified_system)
  @user_specified_type = args[:user_specified_type] if args.key?(:user_specified_type)
end