Class: Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1Entry

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 represents another resource in Google Cloud Platform (such as a BigQuery dataset or a Pub/Sub topic) or outside of it. You 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, for example, its schema. Additionally, you can attach flexible metadata to an entry in the form of a Tag.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDatacatalogV1Entry

Returns a new instance of GoogleCloudDatacatalogV1Entry.



1142
1143
1144
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1142

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

Instance Attribute Details

#bigquery_date_sharded_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1BigQueryDateShardedSpec

Specification for a group of BigQuery tables with the [prefix]YYYYMMDD name pattern. For more information, see Introduction to partitioned tables. Corresponds to the JSON property bigqueryDateShardedSpec

Returns:



954
955
956
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 954

def bigquery_date_sharded_spec
  @bigquery_date_sharded_spec
end

#bigquery_table_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1BigQueryTableSpec

Describes a BigQuery table. Corresponds to the JSON property bigqueryTableSpec

Returns:



959
960
961
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 959

def bigquery_table_spec
  @bigquery_table_spec
end

#business_context ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1BusinessContext

Business Context of the entry. Corresponds to the JSON property businessContext

Returns:



964
965
966
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 964

def business_context
  @business_context
end

#cloud_bigtable_system_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1CloudBigtableSystemSpec

Specification that applies to all entries that are part of CLOUD_BIGTABLE system (user_specified_type) Corresponds to the JSON property cloudBigtableSystemSpec

Returns:



970
971
972
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 970

def cloud_bigtable_system_spec
  @cloud_bigtable_system_spec
end

#data_source ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1DataSource

Physical location of an entry. Corresponds to the JSON property dataSource

Returns:



975
976
977
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 975

def data_source
  @data_source
end

#data_source_connection_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1DataSourceConnectionSpec

Specification that applies to a data source connection. Valid only for entries with the DATA_SOURCE_CONNECTION type. Only one of internal specs can be set at the time, and cannot be changed later. Corresponds to the JSON property dataSourceConnectionSpec

Returns:



982
983
984
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 982

def data_source_connection_spec
  @data_source_connection_spec
end

#database_table_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1DatabaseTableSpec

Specification that applies to a table resource. Valid only for entries with the TABLE type. Corresponds to the JSON property databaseTableSpec

Returns:



988
989
990
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 988

def database_table_spec
  @database_table_spec
end

#dataset_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1DatasetSpec

Specification that applies to a dataset. Valid only for entries with the DATASET type. Corresponds to the JSON property datasetSpec

Returns:



994
995
996
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 994

def dataset_spec
  @dataset_spec
end

#description ⇒ String

Entry description that can consist of several sentences or paragraphs that describe entry contents. The description must not contain Unicode non- characters as well as C0 and C1 control codes except tabs (HT), new lines (LF), carriage returns (CR), and page breaks (FF). The maximum size is 2000 bytes when encoded in UTF-8. Default value is an empty string. Corresponds to the JSON property description

Returns:

  • (String) 


1003
1004
1005
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1003

def description
  @description
end

#display_name ⇒ String

Display name of an entry. The maximum size is 500 bytes when encoded in UTF-8. Default value is an empty string. Corresponds to the JSON property displayName

Returns:

  • (String) 


1009
1010
1011
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1009

def display_name
  @display_name
end

#fileset_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1FilesetSpec

Specification that applies to a fileset. Valid only for entries with the ' FILESET' type. Corresponds to the JSON property filesetSpec

Returns:



1015
1016
1017
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1015

def fileset_spec
  @fileset_spec
end

#fully_qualified_name ⇒ String

Fully Qualified Name (FQN) of the resource. Set automatically for entries representing resources from synced systems. Settable only during creation, and read-only later. Can be used for search and lookup of the entries. Corresponds to the JSON property fullyQualifiedName

Returns:

  • (String) 


1023
1024
1025
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1023

def fully_qualified_name
  @fully_qualified_name
end

#gcs_fileset_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1GcsFilesetSpec

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

Returns:



1028
1029
1030
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1028

def gcs_fileset_spec
  @gcs_fileset_spec
end

#integrated_system ⇒ String

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

Returns:

  • (String) 


1034
1035
1036
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1034

def integrated_system
  @integrated_system
end

#labels ⇒ Hash<String,String>

Cloud labels attached to the entry. In Data Catalog, you can create and modify labels attached only to custom entries. Synced entries have unmodifiable labels that come from the source system. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


1041
1042
1043
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1041

def labels
  @labels
end

#linked_resource ⇒ String

The resource this metadata entry refers to. For Google Cloud Platform resources, linked_resource is the Full Resource Name. For example, the linked_resource for a table resource from BigQuery is: //bigquery.googleapis. com/projects/PROJECT_ID/datasets/DATASET_ID/tables/TABLE_ID`Output only when the entry is one of the types in theEntryTypeenum. For entries with a user_specified_type`, this field is optional and defaults to an empty string. The resource string must contain only letters (a-z, A-Z), numbers (0-9), underscores (_), periods (.), colons (:), slashes (/), dashes (-), and hashes (

). The maximum size is 200 bytes when encoded in UTF-8.

Corresponds to the JSON property linkedResource

Returns:

  • (String) 


1055
1056
1057
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1055

def linked_resource
  @linked_resource
end

#looker_system_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1LookerSystemSpec

Specification that applies to entries that are part LOOKER system ( user_specified_type) Corresponds to the JSON property lookerSystemSpec

Returns:



1061
1062
1063
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1061

def looker_system_spec
  @looker_system_spec
end

#model_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1ModelSpec

Specification that applies to a model. Valid only for entries with the MODEL type. Corresponds to the JSON property modelSpec

Returns:



1067
1068
1069
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1067

def model_spec
  @model_spec
end

#name ⇒ String

Output only. The resource name of an entry in URL format. Note: The entry itself and its child resources might not be stored in the location specified in its name. Corresponds to the JSON property name

Returns:

  • (String) 


1074
1075
1076
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1074

def name
  @name
end

#personal_details ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1PersonalDetails

Entry metadata relevant only to the user and private to them. Corresponds to the JSON property personalDetails

Returns:



1079
1080
1081
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1079

def personal_details
  @personal_details
end

#routine_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1RoutineSpec

Specification that applies to a routine. Valid only for entries with the ROUTINE type. Corresponds to the JSON property routineSpec

Returns:



1085
1086
1087
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1085

def routine_spec
  @routine_spec
end

#schema ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1Schema

Represents a schema, for example, a BigQuery, GoogleSQL, or Avro schema. Corresponds to the JSON property schema

Returns:



1090
1091
1092
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1090

def schema
  @schema
end

#service_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1ServiceSpec

Specification that applies to a Service resource. Valid only for entries with the SERVICE type. Corresponds to the JSON property serviceSpec

Returns:



1096
1097
1098
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1096

def service_spec
  @service_spec
end

#source_system_timestamps ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1SystemTimestamps

Timestamps associated with this resource in a particular system. Corresponds to the JSON property sourceSystemTimestamps

Returns:



1101
1102
1103
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1101

def source_system_timestamps
  @source_system_timestamps
end

#sql_database_system_spec ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1SqlDatabaseSystemSpec

Specification that applies to entries that are part SQL_DATABASE system ( user_specified_type) Corresponds to the JSON property sqlDatabaseSystemSpec

Returns:



1107
1108
1109
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1107

def sql_database_system_spec
  @sql_database_system_spec
end

#type ⇒ String

The type of the entry. For details, see EntryType. Corresponds to the JSON property type

Returns:

  • (String) 


1112
1113
1114
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1112

def type
  @type
end

#usage_signal ⇒ Google::Apis::DatacatalogV1beta1::GoogleCloudDatacatalogV1UsageSignal

The set of all usage signals that Data Catalog stores. Note: Usually, these signals are updated daily. In rare cases, an update may fail but will be performed again on the next day. Corresponds to the JSON property usageSignal

Returns:



1119
1120
1121
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1119

def usage_signal
  @usage_signal
end

#user_specified_system ⇒ String

Indicates the entry's source system that Data Catalog doesn't automatically integrate with. The user_specified_system string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. Corresponds to the JSON property userSpecifiedSystem

Returns:

  • (String) 


1128
1129
1130
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1128

def user_specified_system
  @user_specified_system
end

#user_specified_type ⇒ String

Custom entry type that doesn't match any of the values allowed for input and listed in the EntryType enum. When creating an entry, first check the type values in the enum. If there are no appropriate types for the new entry, provide a custom value, for example, my_special_type. The user_specified_type string has the following limitations: * Is case insensitive. * Must begin with a letter or underscore. * Can only contain letters, numbers, and underscores. * Must be at least 1 character and at most 64 characters long. Corresponds to the JSON property userSpecifiedType

Returns:

  • (String) 


1140
1141
1142
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1140

def user_specified_type
  @user_specified_type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
 
# File 'lib/google/apis/datacatalog_v1beta1/classes.rb', line 1147

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)
  @business_context = args[:business_context] if args.key?(:business_context)
  @cloud_bigtable_system_spec = args[:cloud_bigtable_system_spec] if args.key?(:cloud_bigtable_system_spec)
  @data_source = args[:data_source] if args.key?(:data_source)
  @data_source_connection_spec = args[:data_source_connection_spec] if args.key?(:data_source_connection_spec)
  @database_table_spec = args[:database_table_spec] if args.key?(:database_table_spec)
  @dataset_spec = args[:dataset_spec] if args.key?(:dataset_spec)
  @description = args[:description] if args.key?(:description)
  @display_name = args[:display_name] if args.key?(:display_name)
  @fileset_spec = args[:fileset_spec] if args.key?(:fileset_spec)
  @fully_qualified_name = args[:fully_qualified_name] if args.key?(:fully_qualified_name)
  @gcs_fileset_spec = args[:gcs_fileset_spec] if args.key?(:gcs_fileset_spec)
  @integrated_system = args[:integrated_system] if args.key?(:integrated_system)
  @labels = args[:labels] if args.key?(:labels)
  @linked_resource = args[:linked_resource] if args.key?(:linked_resource)
  @looker_system_spec = args[:looker_system_spec] if args.key?(:looker_system_spec)
  @model_spec = args[:model_spec] if args.key?(:model_spec)
  @name = args[:name] if args.key?(:name)
  @personal_details = args[:personal_details] if args.key?(:personal_details)
  @routine_spec = args[:routine_spec] if args.key?(:routine_spec)
  @schema = args[:schema] if args.key?(:schema)
  @service_spec = args[:service_spec] if args.key?(:service_spec)
  @source_system_timestamps = args[:source_system_timestamps] if args.key?(:source_system_timestamps)
  @sql_database_system_spec = args[:sql_database_system_spec] if args.key?(:sql_database_system_spec)
  @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