com.okta.sdk.impl.resource.group.rule

Class DefaultGroupRule

java.lang.Object

com.okta.sdk.impl.resource.AbstractPropertyRetriever

com.okta.sdk.impl.resource.AbstractResource

com.okta.sdk.impl.resource.AbstractInstanceResource<GroupRule>

com.okta.sdk.impl.resource.group.rule.DefaultGroupRule

All Implemented Interfaces:

Deletable, ExtensibleResource, GroupRule, PropertyRetriever, Resource, Saveable<GroupRule>, Map<String,Object>

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00")
public class DefaultGroupRule
extends AbstractInstanceResource<GroupRule>
implements GroupRule

GroupRule

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Field Summary

Fields inherited from class com.okta.sdk.impl.resource.AbstractResource

properties

Fields inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

readLock, writeLock

Constructor Summary

Constructors

Constructor and Description
DefaultGroupRule(InternalDataStore dataStore)
DefaultGroupRule(InternalDataStore dataStore, Map<String,Object> properties)

Method Summary

Modifier and Type	Method and Description
void	activate() Activate a group Rule Activates a specific group rule by id from your organization
void	deactivate() Deactivate a group Rule Deactivates a specific group rule by id from your organization
void	delete() Delete a group Rule Removes a specific group rule by id from your organization
void	delete(Boolean removeUsers) Delete a group Rule Removes a specific group rule by id from your organization
GroupRuleAction	getActions()
GroupRuleConditions	getConditions()
Date	getCreated()
String	getId()
Date	getLastUpdated()
String	getName()
Map<String,Property>	getPropertyDescriptors()
Class<? extends Resource>	getResourceClass() Returns the class this resource represents.
GroupRuleStatus	getStatus()
String	getType()
GroupRule	setActions(GroupRuleAction actions)
GroupRule	setConditions(GroupRuleConditions conditions)
GroupRule	setName(String name)
GroupRule	setType(String type)
GroupRule	update() Updates a group rule.

Methods inherited from class com.okta.sdk.impl.resource.AbstractInstanceResource

save

Methods inherited from class com.okta.sdk.impl.resource.AbstractResource

clear, containsKey, containsValue, createPropertyDescriptorMap, createPropertyDescriptorMap, entrySet, equals, get, getDataStore, getDeletedPropertyNames, getInternalProperties, getParamsFromHref, getProperty, getPropertyNames, getResourceHref, getResourceListProperty, getResourceProperty, getUpdatedPropertyNames, hashCode, hasProperty, isDirty, isEmpty, isPrintableProperty, keySet, materialize, put, putAll, remove, setInternalProperties, setProperty, setProperty, setResourceHref, size, toString, values

Methods inherited from class com.okta.sdk.impl.resource.AbstractPropertyRetriever

getBoolean, getBoolean, getBooleanProperty, getCharArray, getDateProperty, getDoubleProperty, getDoubleProperty, getEnumListProperty, getEnumProperty, getEnumProperty, getInt, getInteger, getIntegerList, getIntProperty, getIntProperty, getListProperty, getListProperty, getMap, getMapProperty, getNonEmptyMap, getNullableBoolean, getNullableBooleanProperty, getNumber, getNumberList, getString, getString, getStringList, getStringProperty, setProperty, setProperty

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.okta.sdk.resource.Resource

getResourceHref, setResourceHref

Methods inherited from interface com.okta.sdk.resource.PropertyRetriever

getBoolean, getInteger, getIntegerList, getNumber, getNumberList, getString, getStringList

Methods inherited from interface java.util.Map

clear, compute, computeIfAbsent, computeIfPresent, containsKey, containsValue, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keySet, merge, put, putAll, putIfAbsent, remove, remove, replace, replace, replaceAll, size, values

Constructor Detail

DefaultGroupRule

public DefaultGroupRule(InternalDataStore dataStore)

DefaultGroupRule

public DefaultGroupRule(InternalDataStore dataStore,
                        Map<String,Object> properties)

Method Detail

getPropertyDescriptors

public Map<String,Property> getPropertyDescriptors()

Specified by:

getPropertyDescriptors in class AbstractResource

getResourceClass

public Class<? extends Resource> getResourceClass()

Description copied from class: AbstractInstanceResource

Returns the class this resource represents. This is used when you need to figure out what the main type of Resource this object is. For example, DefaultFoo, ImplFoo, and SuperFoo may all represent the Resource of Foo, in this case this method may return Foo.class. (Defaults to getClass().)

Overrides:

getResourceClass in class AbstractInstanceResource<GroupRule>

Returns:

The type of resource this class represents.

getActions

public GroupRuleAction getActions()

Specified by:

getActions in interface GroupRule

setActions

public GroupRule setActions(GroupRuleAction actions)

Specified by:

setActions in interface GroupRule

getConditions

public GroupRuleConditions getConditions()

Specified by:

getConditions in interface GroupRule

setConditions

public GroupRule setConditions(GroupRuleConditions conditions)

Specified by:

setConditions in interface GroupRule

getCreated

public Date getCreated()

Specified by:

getCreated in interface GroupRule

getId

public String getId()

Specified by:

getId in interface GroupRule

getLastUpdated

public Date getLastUpdated()

Specified by:

getLastUpdated in interface GroupRule

getName

public String getName()

Specified by:

getName in interface GroupRule

setName

public GroupRule setName(String name)

Specified by:

setName in interface GroupRule

getStatus

public GroupRuleStatus getStatus()

Specified by:

getStatus in interface GroupRule

getType

public String getType()

Specified by:

getType in interface GroupRule

setType

public GroupRule setType(String type)

Specified by:

setType in interface GroupRule

deactivate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/groups/rules/{ruleId}/lifecycle/deactivate")
public void deactivate()

Deactivate a group Rule Deactivates a specific group rule by id from your organization

Specified by:

deactivate in interface GroupRule

update

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="PUT - /api/v1/groups/rules/{ruleId}")
public GroupRule update()

Updates a group rule. Only `INACTIVE` rules can be updated.

Specified by:

update in interface GroupRule

Returns:

GroupRule

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/groups/rules/{ruleId}")
public void delete(Boolean removeUsers)

Delete a group Rule Removes a specific group rule by id from your organization

Specified by:

delete in interface GroupRule

Parameters:

removeUsers - Indicates whether to keep or remove users from groups assigned by this rule. (optional)

delete

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="DELETE - /api/v1/groups/rules/{ruleId}")
public void delete()

Delete a group Rule Removes a specific group rule by id from your organization

Specified by:

delete in interface Deletable

Specified by:

delete in interface GroupRule

Overrides:

delete in class AbstractInstanceResource<GroupRule>

activate

@Generated(value="com.okta.swagger.codegen.OktaJavaClientImplCodegen",
           date="2023-07-07T09:07:53.917-05:00",
           comments="POST - /api/v1/groups/rules/{ruleId}/lifecycle/activate")
public void activate()

Activate a group Rule Activates a specific group rule by id from your organization

Specified by:

activate in interface GroupRule