Class: Aws::IoTThingsGraph::Types::UploadEntityDefinitionsRequest

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

Overview

Note:

When making an API call, you may pass UploadEntityDefinitionsRequest data as a hash:

{
  document: {
    language: "GRAPHQL", # required, accepts GRAPHQL
    text: "DefinitionText", # required
  },
  sync_with_public_namespace: false,
  deprecate_existing_entities: false,
}

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#deprecate_existing_entities ⇒ Boolean

A Boolean that specifies whether to deprecate all entities in the latest version before uploading the new DefinitionDocument. If set to true, the upload will create a new namespace version.

Returns:

  • (Boolean) 


2064
2065
2066
2067
2068
2069
2070
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 2064

class UploadEntityDefinitionsRequest < Struct.new(
  :document,
  :sync_with_public_namespace,
  :deprecate_existing_entities)
  SENSITIVE = []
  include Aws::Structure
end

#document ⇒ Types::DefinitionDocument

The DefinitionDocument that defines the updated entities.

Returns:



2064
2065
2066
2067
2068
2069
2070
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 2064

class UploadEntityDefinitionsRequest < Struct.new(
  :document,
  :sync_with_public_namespace,
  :deprecate_existing_entities)
  SENSITIVE = []
  include Aws::Structure
end

#sync_with_public_namespace ⇒ Boolean

A Boolean that specifies whether to synchronize with the latest version of the public namespace. If set to true, the upload will create a new namespace version.

Returns:

  • (Boolean) 


2064
2065
2066
2067
2068
2069
2070
 
# File 'gems/aws-sdk-iotthingsgraph/lib/aws-sdk-iotthingsgraph/types.rb', line 2064

class UploadEntityDefinitionsRequest < Struct.new(
  :document,
  :sync_with_public_namespace,
  :deprecate_existing_entities)
  SENSITIVE = []
  include Aws::Structure
end