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.



944
945
946
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 944

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>) 


902
903
904
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 902

def additional_details
  @additional_details
end

#data_type ⇒ String

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

Returns:

  • (String) 


907
908
909
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 907

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) 


913
914
915
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 913

def default_value
  @default_value
end

#description ⇒ String

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

Returns:

  • (String) 


918
919
920
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 918

def description
  @description
end

#field ⇒ String

Name of the Field. Corresponds to the JSON property field

Returns:

  • (String) 


923
924
925
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 923

def field
  @field
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) 


929
930
931
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 929

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) 


935
936
937
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 935

def nullable
  @nullable
end

#readonly ⇒ Boolean Also known as: readonly?

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

Returns:

  • (Boolean) 


941
942
943
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 941

def readonly
  @readonly
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



949
950
951
952
953
954
955
956
957
958
 
# File 'lib/google/apis/connectors_v1/classes.rb', line 949

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)
  @key = args[:key] if args.key?(:key)
  @nullable = args[:nullable] if args.key?(:nullable)
  @readonly = args[:readonly] if args.key?(:readonly)
end