io.keen.client.java

Class KeenProject

java.lang.Object

io.keen.client.java.KeenProject

public class KeenProject
extends java.lang.Object

Encapsulation of a single Keen project, including read/write/master keys.

Since:

2.0.0

Constructor Summary

Constructors

Constructor and Description
KeenProject()
KeenProject(java.lang.String projectId, java.lang.String writeKey, java.lang.String readKey) Construct a Keen project.
KeenProject(java.lang.String projectId, java.lang.String writeKey, java.lang.String readKey, java.lang.String masterKey) Construct a Keen project.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMasterKey() Getter for the Keen Master Key associated with this project.
java.lang.String	getProjectId() Getter for the Keen Project Id associated with this project.
java.lang.String	getReadKey() Getter for the Keen Read Key associated with this project.
java.lang.String	getWriteKey() Getter for the Keen Write Key associated with this project.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

KeenProject

public KeenProject()

KeenProject

public KeenProject(java.lang.String projectId,
                   java.lang.String writeKey,
                   java.lang.String readKey)

Construct a Keen project.

Parameters:

projectId - The Keen IO Project ID.

writeKey - Your Keen IO Write Key. This may be null if this project will only be used for reading events.

readKey - Your Keen IO Read Key. This may be null if this project will only be used for writing events.

KeenProject

public KeenProject(java.lang.String projectId,
                   java.lang.String writeKey,
                   java.lang.String readKey,
                   java.lang.String masterKey)

Construct a Keen project.

Parameters:

projectId - The Keen IO Project ID.

writeKey - Your Keen IO Write Key. This may be null if this project will only be used for reading events.

readKey - Your Keen IO Read Key. This may be null if this project will only be used for writing events.

masterKey - Your Keen IO Master Key. This may be null if not using administrative functionality that requires such a key.

Method Detail

getProjectId

public java.lang.String getProjectId()

Getter for the Keen Project Id associated with this project.

Returns:

the Keen Project Id

getReadKey

public java.lang.String getReadKey()

Getter for the Keen Read Key associated with this project.

Returns:

the Keen Read Key

getWriteKey

public java.lang.String getWriteKey()

Getter for the Keen Write Key associated with this project.

Returns:

the Keen Write Key

getMasterKey

public java.lang.String getMasterKey()

Getter for the Keen Master Key associated with this project.

Returns:

the Keen Master Key