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.



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

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) 


1657
1658
1659
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1657

def mode
  @mode
end

#name ⇒ String

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

Returns:

  • (String) 


1662
1663
1664
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1662

def name
  @name
end

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

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

Returns:



1667
1668
1669
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1667

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) 


1676
1677
1678
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 1676

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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

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