Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileField

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

Overview

A field within a table.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1DataProfileResultProfileField

Returns a new instance of GoogleCloudDataplexV1DataProfileResultProfileField.



1680
1681
1682
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1680

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

Instance Attribute Details

#mode ⇒ String

The mode of the field. Possible values include: REQUIRED, if it is a required field. NULLABLE, if it is an optional field. REPEATED, if it is a repeated field. Corresponds to the JSON property mode

Returns:

  • (String) 


1659
1660
1661
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1659

def mode
  @mode
end

#name ⇒ String

The name of the field. Corresponds to the JSON property name

Returns:

  • (String) 


1664
1665
1666
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1664

def name
  @name
end

#profile ⇒ Google::Apis::DataplexV1::GoogleCloudDataplexV1DataProfileResultProfileFieldProfileInfo

The profile information for each field type. Corresponds to the JSON property profile

Returns:



1669
1670
1671
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1669

def profile
  @profile
end

#type ⇒ String

The data type retrieved from the schema of the data source. For instance, for a BigQuery native table, it is the BigQuery Table Schema (https://cloud.google. com/bigquery/docs/reference/rest/v2/tables#tablefieldschema). For a Dataplex Entity, it is the Entity Schema (https://cloud.google.com/dataplex/docs/ reference/rpc/google.cloud.dataplex.v1#type_3). Corresponds to the JSON property type

Returns:

  • (String) 


1678
1679
1680
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1678

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1685
1686
1687
1688
1689
1690
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1685

def update!(**args)
  @mode = args[:mode] if args.key?(:mode)
  @name = args[:name] if args.key?(:name)
  @profile = args[:profile] if args.key?(:profile)
  @type = args[:type] if args.key?(:type)
end