Class: Google::Apis::ConnectorsV1::Field

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

Overview

Metadata of an entity field.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Field

Returns a new instance of Field.



2553
2554
2555
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2553

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

Instance Attribute Details

#additional_details ⇒ Hash<String,Object>

The following map contains fields that are not explicitly mentioned above,this give connectors the flexibility to add new metadata fields. Corresponds to the JSON property additionalDetails

Returns:

  • (Hash<String,Object>) 


2506
2507
2508
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2506

def additional_details
  @additional_details
end

#data_type ⇒ String

The data type of the Field. Corresponds to the JSON property dataType

Returns:

  • (String) 


2511
2512
2513
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2511

def data_type
  @data_type
end

#default_value ⇒ Object

The following field specifies the default value of the Field provided by the external system if a value is not provided. Corresponds to the JSON property defaultValue

Returns:

  • (Object) 


2517
2518
2519
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2517

def default_value
  @default_value
end

#description ⇒ String

A brief description of the Field. Corresponds to the JSON property description

Returns:

  • (String) 


2522
2523
2524
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2522

def description
  @description
end

#field ⇒ String

Name of the Field. Corresponds to the JSON property field

Returns:

  • (String) 


2527
2528
2529
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2527

def field
  @field
end

#json_schema ⇒ Google::Apis::ConnectorsV1::JsonSchema

JsonSchema representation of schema metadata Corresponds to the JSON property jsonSchema

Returns:



2532
2533
2534
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2532

def json_schema
  @json_schema
end

#key ⇒ Boolean Also known as: key?

The following boolean field specifies if the current Field acts as a primary key or id if the parent is of type entity. Corresponds to the JSON property key

Returns:

  • (Boolean) 


2538
2539
2540
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2538

def key
  @key
end

#nullable ⇒ Boolean Also known as: nullable?

Specifies whether a null value is allowed. Corresponds to the JSON property nullable

Returns:

  • (Boolean) 


2544
2545
2546
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2544

def nullable
  @nullable
end

#readonly ⇒ Boolean Also known as: readonly?

Specifies if the Field is readonly. Corresponds to the JSON property readonly

Returns:

  • (Boolean) 


2550
2551
2552
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2550

def readonly
  @readonly
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 2558

def update!(**args)
  @additional_details = args[:additional_details] if args.key?(:additional_details)
  @data_type = args[:data_type] if args.key?(:data_type)
  @default_value = args[:default_value] if args.key?(:default_value)
  @description = args[:description] if args.key?(:description)
  @field = args[:field] if args.key?(:field)
  @json_schema = args[:json_schema] if args.key?(:json_schema)
  @key = args[:key] if args.key?(:key)
  @nullable = args[:nullable] if args.key?(:nullable)
  @readonly = args[:readonly] if args.key?(:readonly)
end