Class: Aws::Appflow::Types::ConnectorEntityField

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb

Overview

Describes the data model of a connector field. For example, for an account entity, the fields would be account name, account ID, and so on.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#custom_propertiesHash<String,String>

A map that has specific properties related to the ConnectorEntityField.

Returns:

  • (Hash<String,String>)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#default_valueString

Default value that can be assigned to this field.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the connector entity field.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#destination_propertiesTypes::DestinationFieldProperties

The properties applied to a field when the connector is being used as a destination.



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#identifierString

The unique identifier of the connector field.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#is_deprecatedBoolean

Booelan value that indicates whether this field is deprecated or not.

Returns:

  • (Boolean)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#is_primary_keyBoolean

Booelan value that indicates whether this field can be used as a primary key.

Returns:

  • (Boolean)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#labelString

The label applied to a connector entity field.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#parent_identifierString

The parent identifier of the connector field.

Returns:

  • (String)


572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#source_propertiesTypes::SourceFieldProperties

The properties that can be applied to a field when the connector is being used as a source.



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end

#supported_field_type_detailsTypes::SupportedFieldTypeDetails

Contains details regarding the supported FieldType, including the corresponding filterOperators and supportedValues.



572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 572

class ConnectorEntityField < Struct.new(
  :identifier,
  :parent_identifier,
  :label,
  :is_primary_key,
  :default_value,
  :is_deprecated,
  :supported_field_type_details,
  :description,
  :source_properties,
  :destination_properties,
  :custom_properties)
  SENSITIVE = []
  include Aws::Structure
end