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.



434
435
436
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 434

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:



344
345
346
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 344

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:



349
350
351
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 349

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) 


355
356
357
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 355

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) 


362
363
364
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 362

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:



367
368
369
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 367

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) 


373
374
375
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 373

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) 


384
385
386
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 384

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) 


392
393
394
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 392

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:



397
398
399
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 397

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:



402
403
404
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 402

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) 


407
408
409
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 407

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:



412
413
414
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 412

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) 


420
421
422
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 420

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) 


432
433
434
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 432

def user_specified_type
  @user_specified_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 439

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