TenantsResource (knock-client 0.2.3 API)

java.lang.Object
- app.knock.api.resources.TenantsResource

public final class TenantsResource
extends java.lang.Object

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class TenantsResource.QueryParams

Constructor Summary

Constructors
Constructor Description

TenantsResource(KnockHttp knockHttp)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`delete(java.lang.String tenantId)`	Delete a specific Tenant
`boolean`	`equals(java.lang.Object o)`
`Tenant`	`get(java.lang.String tenantId)`	Retrieve a Tenant
`KnockHttp`	`getKnockHttp()`
`int`	`hashCode()`
`CursorResult<Tenant>`	`list(TenantsResource.QueryParams queryParams)`	Retrieve Tenants
`Tenant`	`set(java.lang.String tenantId, java.util.Map<java.lang.String,java.lang.Object> tenantData)`	Set a map of data for a specific Tenant.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TenantsResource
```
public TenantsResource(KnockHttp knockHttp)
```
- Method Detail
  - list
```
public CursorResult<Tenant> list(TenantsResource.QueryParams queryParams)
```
    Retrieve Tenants
    
    Parameters:
    
    queryParams -
    
    Returns:
    
    a cursor result of tenants
    
    Throws:
    
    KnockClientResourceException
  - get
```
public Tenant get(java.lang.String tenantId)
```
    Retrieve a Tenant
    
    Parameters:
    
    tenantId -
    
    Returns:
    
    Tenant
    
    Throws:
    
    KnockClientResourceException - Unable able to retrieve Tenant from the resource
  - set
```
public Tenant set(java.lang.String tenantId,
                  java.util.Map<java.lang.String,java.lang.Object> tenantData)
```
    Set a map of data for a specific Tenant.
    
    Parameters:
    
    tenantId -
    
    tenantData -
    
    Returns:
  - delete
```
public void delete(java.lang.String tenantId)
```
    Delete a specific Tenant
    
    Parameters:
    
    tenantId -
  - getKnockHttp
```
public KnockHttp getKnockHttp()
```
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object o)
```
    Overrides:
    
    equals in class java.lang.Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object