Firebase

Kubemq firebase target Connector
Kubemq gcp-firebase target connector allows services using kubemq server to access google firebase server.
Prerequisites
The following required to run the gcp-firebase target connector:
kubemq cluster
gcp-firebase set up
kubemq-source deployment
Configuration
firebase target connector configuration properties:
Properties Key
Required
Description
Example
project_id
yes
gcp firebase project_id
"/myproject"
credentials
yes
gcp credentials files
"<google json credentials"
db_client
no
initialize db client if true
true/false
db_url
no
gcp db full path
<google db url"
auth_client
no
initialize auth client if true
true/false
messaging_client
no
initialize messaging client
true/false
defaultmsg
no
default Firebase Cloud Messaging
json
defaultmultimsg
no
default Firebase Cloud MulticastMessage
json
defaultmsg - can be used for common message settings defaultmultimsg - can be used for common message settings
Example:
bindings:
  - name: kubemq-query-gcp-firebase
    source:
      kind: kubemq.query
      name: kubemq-query
      properties:
        address: "kubemq-cluster:50000"
        client_id: "kubemq-query-gcp-firebase-connector"
        auth_token: ""
        channel: "query.gcp.firebase"
        group:   ""
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind: gcp.firebase
      name: gcp-firebase
      properties:
        project_id: "project_id"
        credentials: 'json'
        db_client: "true"
        db_url: "db_url"
        auth_client: "true"
Usage
DB:
Get DB
Get DB metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
get_db
ref_path
yes
ref path for the data
valid string
child_ref
no
path for child ref data
valid string
Example:
{
  "metadata": {
    "method": "get_db",
    "ref_path": "string"
  },
  "data": null
}
Set DB
Set DB metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
set_db
ref_path
yes
ref path for the data
valid string
child_ref
no
path for child ref data
valid string
Example:
{
  "metadata": {
    "method": "get_db",
    "ref_path": "string"
  },
  "data": null
}
Update DB
Update DB metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
update_db
ref_path
yes
ref path for the data
valid string
child_ref
no
path for child ref data
valid string
Example:
{
  "metadata": {
    "method": "delete_db",
    "ref_path": "string"
  },
  "data": "updated_string"
}
Delete DB
Kubemq firebase target Connector
Kubemq gcp-firebase target connector allows services using kubemq server to access google firebase server.
Prerequisites
The following required to run the gcp-firebase target connector:
kubemq cluster
gcp-firebase set up
kubemq-source deployment
Configuration
firebase target connector configuration properties:
Properties Key
Required
Description
Example
project_id
yes
gcp firebase project_id
"/myproject"
credentials
yes
gcp credentials files
"<google json credentials"
db_client
no
initialize db client if true
true/false
db_url
no
gcp db full path
<google db url"
auth_client
no
initialize auth client if true
true/false
messaging_client
no
initialize messaging client
true/false
defaultmsg
no
default Firebase Cloud Messaging
json
defaultmultimsg
no
default Firebase Cloud MulticastMessage
json
defaultmsg - can be used for common message settings defaultmultimsg - can be used for common message settings
Example:
bindings:
  - name: kubemq-query-gcp-firebase
    source:
      kind: kubemq.query
      name: kubemq-query
      properties:
        address: "kubemq-cluster:50000"
        client_id: "kubemq-query-gcp-firebase-connector"
        auth_token: ""
        channel: "query.gcp.firebase"
        group:   ""
        auto_reconnect: "true"
        reconnect_interval_seconds: "1"
        max_reconnects: "0"
    target:
      kind:gcp.firebase
      name: gcp-firebase
      properties:
        project_id: "project_id"
        credentials: 'json'
        db_client: "true"
        db_url: "db_url"
        auth_client: "true"
Usage
DB:
Get DB
Get DB metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
get_db
ref_path
yes
ref path for the data
valid string
child_ref
no
path for child ref data
valid string
Example:
{
  "metadata": {
    "method": "get_db",
    "ref_path": "string"
  },
  "data": null
}
Set DB
Set DB metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
set_db
ref_path
yes
ref path for the data
valid string
child_ref
no
path for child ref data
valid string
Example:
{
  "metadata": {
    "method": "get_db",
    "ref_path": "string"
  },
  "data": null
}
Update DB
Update DB metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
update_db
ref_path
yes
ref path for the data
valid string
child_ref
no
path for child ref data
valid string
Example:
{
  "metadata": {
    "method": "update_db",
    "ref_path": "string"
  },
  "data": "dXBkYXRlIGRiIHN0cmluZw=="
}
Delete DB
Delete DB metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
delete_db
ref_path
yes
ref path for the data
valid string
child_ref
no
path for child ref data
valid string
Example:
{
  "metadata": {
    "method": "delete_db",
    "ref_path": "string"
  },
  "data": null
}
User:
Create User
Create User metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
create_user
Example:
{
  "metadata": {
    "method": "create_user"
  },
  "data": "eyJlbWFpbCI6IkpvaG5AZHVlLmNvbSIsICJwYXNzd29yZCI6MzAsICJkaXNwbGF5X25hbWUiOiJKb2huIn0="
}
Retrieve User
Retrieve User metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
retrieve_user
retrieve_by
yes
type of retrieval
by_email ,by_uid,by_phone
uid
no
valid unique string
string
phone
no
valid phone number
string
email
no
valid email
string
Example:
{
  "metadata": {
    "method": "retrieve_user",
    "retrieve_by": "uid",
    "uid": "1223131"
  },
  "data": null
}
Delete User
Delete User metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
delete_user
uid
yes
valid unique string
string
Example:
{
  "metadata": {
    "method": "delete_user",
    "uid": "1223131"
  },
  "data": null
}
Delete Multiple Users
Delete Multiple Users metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
delete_multiple_users
Example:
{
  "metadata": {
    "method": "delete_multiple_users"
  },
  "data": "WyAidXNlcjEiLCAidXNlcjIiLCAidXNlcjMiIF0="
}
Update User
Update User metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
update_user
uid
yes
valid unique string
string
Example:
{
  "metadata": {
    "method": "update_user",
    "uid": "1223131"
  },
  "data": "eyJlbWFpbCI6IkpvaG5AZHVlLmNvbSIsICJwYXNzd29yZCI6MzAsICJkaXNwbGF5X25hbWUiOiJKb2huIn0="
}
List Users
List User metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
list_users
Example:
{
  "metadata": {
    "method": "list_users"
  },
  "data": null
}
Token:
Custom Token
Custom Token metadata setting:
Metadata Key
Required
Description
Possible values
​
​
method
yes
method type
custom_token
​
​
uid
yes
valid unique string
string
​
​
Example:
{
  "metadata": {
    "method": "custom_token",
    "token_id": "some-uid"
  },
  "data": null
}
Verify Token
Verify Token metadata setting:
Metadata Key
Required
Description
Possible values
​
​
method
yes
method type
verify_token
​
​
uid
yes
valid unique string
string
​
​
Example:
{
  "metadata": {
    "method": "verify_token",
    "token_id": "some-uid"
  },
  "data": null
}
Messaging:
Firebase messaging will send a FCM message or send the message to multiple devices.
message https://firebase.google.com/docs/reference/fcm/rest/v1/projects.messages​
multi https://firebase.google.com/docs/cloud-messaging/send-message#go_1​
Send Message
Create User metadata setting:
Metadata Key
Required
Description
Possible values
method
yes
method type
send_message/send_multi
Example: send_message
{
  "metadata": {
    "method": "send_message"
  },
  "data": "ewoiVG9waWMiOiJ0ZXN0IiwKImRhdGEiOiB7ImtleTEiOiJ2YWx1ZTEifQp9"
}
​
* data value is base64  {
  "Topic":"test",
  "data": {"key1":"value1"}
  }
Example: send_multi
{
  "metadata": {
    "method": "send_multi"
  },
  "data": "ewogICAgInRvcGljIjoiYXBwIHRvcGljIiwKICAgICAiZGF0YSI6eyJUb2tlbnMiOlsiMTIzIiwiNDU2Il0sIkRhdGEiOnsia2V5IjoidmFsIn0sIk5vdGlmaWNhdGlvbiI6eyJ0aXRsZSI6InRpdGxlIn19CiB9"
}
​
* data value is base64  {
    "topic":"app_topic",
     "data":{"Tokens":["123","456"],"Data":{"key":"val"},"Notification":{"title":"title"}}
  }

Spanner

Pub/Sub

Last modified 2yr ago

Properties Key	Required	Description	Example
project_id	yes	gcp firebase project_id	"/myproject"
credentials	yes	gcp credentials files	"<google json credentials"
db_client	no	initialize db client if true	true/false
db_url	no	gcp db full path	<google db url"
auth_client	no	initialize auth client if true	true/false
messaging_client	no	initialize messaging client	true/false
defaultmsg	no	default Firebase Cloud Messaging	json
defaultmultimsg	no	default Firebase Cloud MulticastMessage	json

Metadata Key	Required	Description	Possible values
method	yes	method type	get_db
ref_path	yes	ref path for the data	valid string
child_ref	no	path for child ref data	valid string