The following API calls are available for the Google Cloud Injector Module and can be executed within any of the available Ignition scopes.

APIs

  • system.cirruslink.gcp.cloud.createConfig(type, props) → void
    • Parameters
      • String type

        • The type of configuration to create with valid options:

          • Cloud IoT Core
          • Sets
          • Agents
      • Map props
        • Dictionary of properties making up the configuration with the following keys and datatypes:
          • Cloud IoT Core

            • Id (Long)(cannot be null)

            • 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" or "Disk_Backed" (added 4.0.17)

            • MessageCapacity (int)(deprecated 4.0.19)

            • HistoryMaxSize (int)(added 4.0.22)
            • HistoryMaxAge (int)(added 4.0.19)
            • FlushPeriod (long)
            • H2dbDirectory (str)(added 4.0.25)
            • H2dbPort (int)(added 4.0.22)
            • ProxyType (str) "NONE", "HTTP" or HTTPS" 
            • ProxyHostname (str)
            • ProxyPort (int)
            • KeepAlive (int)

            • MaxSize (int)

            • Expiration (int)
          • Sets

            • Id (long)(cannot be null)

            • Name (str)

            • Description (str)

            • PushPolicy (str) "PUSH_TO_ALL" or "PUSH_TO_ANY"

          • Agents
            • Id (long)(cannot be null)
            • Name (str) (added 4.0.17)
            • Enabled (bool) (added 4.0.17)

            • TagProvider (str)

            • TagPath (str)

            • PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"

            • TagPacingPeriod (long)

            • ConvertUdts (bool)

            • PublishUdtDefinitions (bool)

            • OptimizeUdts (bool)

            • GoogleCloudSetId (long)

            • GroupId (str)

            • EdgeNodeId (str)

            • DeviceId (str)

            • FilteredProperties (str)

            • SendAllProps (bool)(added 4.0.25)
    • Return Value
      • A map representing the newly created configuration after it has been written to the database. (added 4.0.16)
  • system.cirruslink.gcp.cloud.readConfig(type) → List
    • Parameters
      • String type

        • The type of configuration to read with valid options:

          • General
          • Cloud 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)
        • Cloud 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" or "Disk_Backed" (added 4.0.17)

          • MessageCapacity (int)(deprecated 4.0.19)

          • HistoryMaxSize (int)(added 4.0.22)
          • HistoryMaxAge (int)(added 4.0.19)
          • FlushPeriod (long)
          • H2dbDirectory (str)(added 4.0.25)
          • H2dbPort (int)(added 4.0.22)
          • 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)
          • Name (str) (added 4.0.17)
          • Enabled (bool) (added 4.0.17)
          • TagProvider (str)
          • TagPath (str)

          • PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"

          • TagPacingPeriod (long)

          • ConvertUdts (bool)

          • PublishUdtDefinitions (bool)

          • OptimizeUdts (bool)

          • GoogleCloudSetId (long)

          • GroupId (str)

          • EdgeNodeId (str)

          • DeviceId (str)

          • FilteredProperties (str)

          • SendAllProps (bool)(added 4.0.25)
  • system.cirruslink.gcp.cloud.updateConfig(type, id, collisionPolicy, props) → void
    • Parameters
      • String type
        • The type of configuration to update with valid options:
          • General
          • Cloud 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)
          • Cloud 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" or "Disk_Backed" (added 4.0.17)

            • MessageCapacity (int)(deprecated 4.0.19)

            • HistoryMaxSize (int)(added 4.0.22)
            • HistoryMaxAge (int)(added 4.0.19)
            • FlushPeriod (long)
            • H2dbDirectory (str)(added 4.0.25)
            • H2dbPort (int)(added 4.0.22)
            • 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)
            • Name (str) (added 4.0.17)
            • Enabled (bool) (added 4.0.17)
            • TagProvider (str)
            • TagPath (str)
            • PushTrigger (str) "EVENT_DRIVEN" or "PERIODIC"
            • TagPacingPeriod (long)
            • ConvertUdts (bool)
            • PublishUdtDefinitions (bool)
            • OptimizeUdts (bool)
            • GoogleCloudSetId (long)
            • GroupId (str)
            • EdgeNodeId (str)
            • DeviceId (str)
            • FilteredProperties (str)
            • SendAllProps (bool)(added 4.0.25)
    • Return Value
      • A map representing the updated configuration after it has been written to the database. (added 4.0.16)
  • system.cirruslink.gcp.cloud.deleteConfig(type, id) → void
    • Parameters
      • String type
        • The type of configuration to delete with valid options:
          • Cloud IoT Core
          • Sets
          • Agents
      • Long id
        • The ID of the record to delete
    • Return value
      • True if the record was successfully deleted otherwise False is returned (added 4.0.16)
  • No labels

New to MQTT? Start Here!