Class: Aws::IoTTwinMaker::Types::PropertyRequest

Inherits:

Struct

• Object
• Struct
• Aws::IoTTwinMaker::Types::PropertyRequest

Includes:

Structure

Defined in:

lib/aws-sdk-iottwinmaker/types.rb

Overview

Note:

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

{
  definition: {
    data_type: {
      type: "RELATIONSHIP", # required, accepts RELATIONSHIP, STRING, LONG, BOOLEAN, INTEGER, DOUBLE, LIST, MAP
      nested_type: {
        # recursive DataType
      },
      allowed_values: [
        {
          boolean_value: false,
          double_value: 1.0,
          integer_value: 1,
          long_value: 1,
          string_value: "String",
          list_value: {
            # recursive DataValueList
          },
          map_value: {
            "String" => {
              # recursive DataValue
            },
          },
          relationship_value: {
            target_entity_id: "EntityId",
            target_component_name: "Name",
          },
          expression: "Expression",
        },
      ],
      unit_of_measure: "String",
      relationship: {
        target_component_type_id: "ComponentTypeId",
        relationship_type: "String",
      },
    },
    is_required_in_entity: false,
    is_external_id: false,
    is_stored_externally: false,
    is_time_series: false,
    default_value: {
      boolean_value: false,
      double_value: 1.0,
      integer_value: 1,
      long_value: 1,
      string_value: "String",
      list_value: [
        {
          # recursive DataValue
        },
      ],
      map_value: {
        "String" => {
          # recursive DataValue
        },
      },
      relationship_value: {
        target_entity_id: "EntityId",
        target_component_name: "Name",
      },
      expression: "Expression",
    },
    configuration: {
      "Name" => "Value",
    },
  },
  value: {
    boolean_value: false,
    double_value: 1.0,
    integer_value: 1,
    long_value: 1,
    string_value: "String",
    list_value: [
      {
        # recursive DataValue
      },
    ],
    map_value: {
      "String" => {
        # recursive DataValue
      },
    },
    relationship_value: {
      target_entity_id: "EntityId",
      target_component_name: "Name",
    },
    expression: "Expression",
  },
  update_type: "UPDATE", # accepts UPDATE, DELETE, CREATE
}

An object that sets information about a property.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #definition ⇒ Types::PropertyDefinitionRequest

  An object that specifies information about a property.

• #update_type ⇒ String

  The update type of the update property request.

• #value ⇒ Types::DataValue

  The value of the property.

Instance Attribute Details

#definition ⇒ Types::PropertyDefinitionRequest

An object that specifies information about a property.

Returns:

• (Types::PropertyDefinitionRequest)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 3183

class PropertyRequest < Struct.new(
  :definition,
  :value,
  :update_type)
  SENSITIVE = []
  include Aws::Structure
end

#update_type ⇒ String

The update type of the update property request.

Returns:

• (String)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 3183

class PropertyRequest < Struct.new(
  :definition,
  :value,
  :update_type)
  SENSITIVE = []
  include Aws::Structure
end

#value ⇒ Types::DataValue

The value of the property.

Returns:

• (Types::DataValue)

# File 'lib/aws-sdk-iottwinmaker/types.rb', line 3183

class PropertyRequest < Struct.new(
  :definition,
  :value,
  :update_type)
  SENSITIVE = []
  include Aws::Structure
end