GCI: Python Scripting

The following API calls are available for the Google Cloud Injector Module and can be executed within the Ignition Designer Script Console.

`APIs`

system.cirruslink.GoogleCloudInjector.createConfig(type, props) → void
- Parameters
  - String type
    - The type of configuration to create with valid options:
      - IoT Core
      - Sets
      - Agents
  - Map props
    - Dictionary of properties making up the configuration with the following keys and datatypes:
      - IoT Core
        Id (Long)
        Name (str)
        Enabled (bool)
        ProjectId (str)
        CloudRegion (str)
        RegistryId (str)
        DeviceId (str)
        PrivateKeyFileContents (str)
        Algorithm (str) "RS256" or "ES256"
        GoogleCloudSetId (long)
        HistoryEnabled (bool)
        HistoryStoreType (str) "In_Memory"
        MessageCapacity (int)
        FlushPeriod (long)
        ProxyType (str) "NONE", "HTTP" or HTTPS"
        ProxyHostname (str)
        ProxyPort (int)
        KeepAlive (int)
        MaxSize (int)
        Expiration (int)
      - Sets
        Id (long)
        Name (str)
        Description (str)
        PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
      - Agents
        Id (long)
        TagProvider (str)
        TagPath (str)
        PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"
        TagPacingPeriod (long)
        ConvertUdts (bool)
        PublishUdtDefinitions (bool)
        OptimizeUdts (bool)
        GoogleCloudSetId (long)
        AutoDiscover (bool)
        GroupId (str)
        EdgeNodeId (str)
        DeviceId (str)
        FilteredProperties (str)
- Return Value
  - None
system.cirruslink.GoogleCloudInjector.readConfig(type) → List
- Parameters
  - String type
    - The type of configuration to read with valid options:
      - General
      - IoT Core
      - Sets
      - Agents
- Return Value
  - A List of the Dictionaries of properties making up the configurations with the following keys and datatypes:
    - General
      - Id (long)
      - Enabled (bool)
    - IoT Core
      - Name (str)
      - Enabled (bool)
      - ProjectId (str)
      - CloudRegion (str)
      - RegistryId (str)
      - DeviceId (str)
      - PrivateKeyFileContents (str)
      - Algoritm (str) "RS256" or "ES256"
      - GoogleCloudSetId (long)
      - HistoryEnabled (bool)
      - HistoryStoreType (str) "In_Memory"
      - MessageCapacity (int)
      - FlushPeriod (long)
      - ProxyType (str) "NONE", "HTTP", "HTTPS"
      - ProxyHostname (str)
      - ProxyPort (int)
      - KeepAlive (int)
      - MaxSize (int)
      - Expiration (int)
    - Sets
      - Id (long)
      - Name (str)
      - Description (str)
      - PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
    - Agents
      - Id (long)
      - TagProvider (str)
      - TagPath (str)
      - PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"
      - TagPacingPeriod (long)
      - ConvertUdts (bool)
      - PublishUdtDefinitions (bool)
      - OptimizeUdts (bool)
      - GoogleCloudSetId (long)
      - AutoDiscover (bool)
      - GroupId (str)
      - EdgeNodeId (str)
      - DeviceId (str)
      - FilteredProperties (str)
system.cirruslink.GoogleCloudInjector.updateConfig(type, id, collisionPolicy, props) → void
- Parameters
  - String type
    - The type of configuration to update with valid options:
      - General
      - IoT Core
      - Sets
      - Agents
  - Long id
    - The ID of the record to update
  - String collisionPolicy
    - "MergeOverwrite" or "Overwrite"
      - "MergeOverwrite" will replace the existing properties in the record ID with only those included in the call
      - "Overwrite" will replace all properties in the record ID with those in the call
  - Map props
    - Dictionary of properties making up the configuration with the following keys and datatypes:
      - General
        Id (long)
        Enabled (bool)
      - IoT Core
        Name (str)
        Enabled (bool)
        ProjectId (str)
        CloudRegion (str)
        RegsitryId (str)
        DeviceId (str)
        PrivateKeyFileContents (str)
        Algoritm (str) "RS256" or "ES256"
        GoogleCloudSetId (long)
        HistoryEnabled (bool)
        HistoryStoreType (str) "In_Memory"
        MessageCapacity (int)
        FlushPeriod (long)
        ProxyType (str) "NONE", "HTTP" or "HTTPS"
        ProxyHostname (str)
        ProxyPort (int)
        KeepAlive (int)
        MaxSize (int)
        Expiration (int)
      - Sets
        Id (long)
        Name (str)
        Description (str)
        PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"
      - Agents
        Id (long)
        TagProvider (str)
        TagPath (str)
        PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"
        TagPacingPeriod (long)
        ConvertUdts (bool)
        PublishUdtDefinitions (bool)
        OptimizeUdts (bool)
        GoogleCloudSetId (long)
        AutoDiscover (bool)
        GroupId (str)
        EdgeNodeId (str)
        DeviceId (str)
        FilteredProperties (str)
- Return Value
  - None
system.cirruslink.GoogleCloudInjector.deleteConfig(type, id) → void
- Parameters
  - String type
    - The type of configuration to delete with valid options:
      - IoT Core
      - Sets
      - Agents
  - Long id
    - The ID of the record to delete
- Return value
  - None

Contents

Cirrus Link Resources

Inductive Resources

`APIs`