Class: Google::Apis::DataplexV1::GoogleCloudDataplexV1Schema

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

Schema information describing the structure and layout of the data.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudDataplexV1Schema

Returns a new instance of GoogleCloudDataplexV1Schema.



4303
4304
4305
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4303

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

Instance Attribute Details

#fields ⇒ Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1SchemaSchemaField>

Optional. The sequence of fields describing data in table entities. Note: BigQuery SchemaFields are immutable. Corresponds to the JSON property fields

Returns:



4277
4278
4279
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4277

def fields
  @fields
end

#partition_fields ⇒ Array<Google::Apis::DataplexV1::GoogleCloudDataplexV1SchemaPartitionField>

Optional. The sequence of fields describing the partition structure in entities. If this field is empty, there are no partitions within the data. Corresponds to the JSON property partitionFields

Returns:



4283
4284
4285
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4283

def partition_fields
  @partition_fields
end

#partition_style ⇒ String

Optional. The structure of paths containing partition data within the entity. Corresponds to the JSON property partitionStyle

Returns:

  • (String) 


4288
4289
4290
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4288

def partition_style
  @partition_style
end

#user_managed ⇒ Boolean Also known as: user_managed?

Required. Set to true if user-managed or false if managed by Dataplex. The default is false (managed by Dataplex). Set to falseto enable Dataplex discovery to update the schema. including new data discovery, schema inference, and schema evolution. Users retain the ability to input and edit the schema. Dataplex treats schema input by the user as though produced by a previous Dataplex discovery operation, and it will evolve the schema and take action based on that treatment. Set to true to fully manage the entity schema. This setting guarantees that Dataplex will not change schema fields. Corresponds to the JSON property userManaged

Returns:

  • (Boolean) 


4300
4301
4302
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4300

def user_managed
  @user_managed
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4308
4309
4310
4311
4312
4313
 
# File 'lib/google/apis/dataplex_v1/classes.rb', line 4308

def update!(**args)
  @fields = args[:fields] if args.key?(:fields)
  @partition_fields = args[:partition_fields] if args.key?(:partition_fields)
  @partition_style = args[:partition_style] if args.key?(:partition_style)
  @user_managed = args[:user_managed] if args.key?(:user_managed)
end