Class: Aws::Appflow::Types::ConnectorEntity

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

Overview

The high-level entity that can be queried in Amazon AppFlow. For example, a Salesforce entity might be an Account or Opportunity, whereas a ServiceNow entity might be an Incident.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#has_nested_entitiesBoolean

Specifies whether the connector entity is a parent or a category and has more entities nested underneath it. If another call is made with entitiesPath = "the_current_entity_name_with_hasNestedEntities_true", then it returns the nested entities underneath it. This provides a way to retrieve all supported entities in a recursive fashion.

Returns:

  • (Boolean)


229
230
231
232
233
234
235
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 229

class ConnectorEntity < Struct.new(
  :name,
  :label,
  :has_nested_entities)
  SENSITIVE = []
  include Aws::Structure
end

#labelString

The label applied to the connector entity.

Returns:

  • (String)


229
230
231
232
233
234
235
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 229

class ConnectorEntity < Struct.new(
  :name,
  :label,
  :has_nested_entities)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the connector entity.

Returns:

  • (String)


229
230
231
232
233
234
235
# File 'gems/aws-sdk-appflow/lib/aws-sdk-appflow/types.rb', line 229

class ConnectorEntity < Struct.new(
  :name,
  :label,
  :has_nested_entities)
  SENSITIVE = []
  include Aws::Structure
end