Package com.ibm.cloud.cloudant.v1.model

Class PutSecurityOptions

java.lang.Object

com.ibm.cloud.sdk.core.service.model.GenericModel

com.ibm.cloud.cloudant.v1.model.PutSecurityOptions

All Implemented Interfaces:

com.ibm.cloud.sdk.core.service.model.ObjectModel

public class PutSecurityOptions
extends com.ibm.cloud.sdk.core.service.model.GenericModel

The putSecurity options.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	PutSecurityOptions.Builder	Builder.

Method Summary

Modifier and Type	Method	Description
SecurityObject	admins()	Gets the admins.
Map<String,List<String>>	cloudant()	Gets the cloudant.
Boolean	couchdbAuthOnly()	Gets the couchdbAuthOnly.
String	db()	Gets the db.
SecurityObject	members()	Gets the members.
PutSecurityOptions.Builder	newBuilder()	New builder.

Methods inherited from class com.ibm.cloud.sdk.core.service.model.GenericModel

equals, hashCode, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

newBuilder

public PutSecurityOptions.Builder newBuilder()

New builder.

Returns:

a PutSecurityOptions builder

db

public String db()

Gets the db. Path parameter to specify the database name.

Returns:

the db

admins

public SecurityObject admins()

Gets the admins. Schema for names and roles to map to a database permission.

Returns:

the admins

members

public SecurityObject members()

Gets the members. Schema for names and roles to map to a database permission.

Returns:

the members

cloudant

public Map<String,List<String>> cloudant()

Gets the cloudant. Database permissions for Cloudant users and/or API keys.

Returns:

the cloudant

couchdbAuthOnly

public Boolean couchdbAuthOnly()

Gets the couchdbAuthOnly. Manage permissions using the `_users` database only.

Returns:

the couchdbAuthOnly