CreateGroupRequestBody (Box Java SDK)

Object
- NullableFieldTracker
- - SerializableObject
  - - CreateGroupRequestBody

All Implemented Interfaces:: Serializable

public class CreateGroupRequestBody
extends SerializableObject

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CreateGroupRequestBody.Builder

Nested Classes
Modifier and Type	Class and Description
`static class`	`CreateGroupRequestBody.Builder`

Field Summary

Fields
Modifier and Type	Field and Description
`protected String`	`description` A human readable description of the group.
`protected String`	`externalSyncIdentifier` An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.
`protected EnumWrapper<CreateGroupRequestBodyInvitabilityLevelField>`	`invitabilityLevel` Specifies who can invite the group to collaborate on folders.
`protected EnumWrapper<CreateGroupRequestBodyMemberViewabilityLevelField>`	`memberViewabilityLevel` Specifies who can see the members of the group.
`protected String`	`name` The name of the new group to be created.
`protected String`	`provenance` Keeps track of which external source this group is coming, for example `Active Directory`, or `Okta`.

Fields inherited from class NullableFieldTracker
explicitlySetNullableFields

Constructor Summary

Constructors
Modifier Constructor and Description

protected CreateGroupRequestBody(CreateGroupRequestBody.Builder builder)

CreateGroupRequestBody(String name)

Constructors
Modifier	Constructor and Description
`protected`	`CreateGroupRequestBody(CreateGroupRequestBody.Builder builder)`
	`CreateGroupRequestBody(String name)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object o)`
`String`	`getDescription()`
`String`	`getExternalSyncIdentifier()`
`EnumWrapper<CreateGroupRequestBodyInvitabilityLevelField>`	`getInvitabilityLevel()`
`EnumWrapper<CreateGroupRequestBodyMemberViewabilityLevelField>`	`getMemberViewabilityLevel()`
`String`	`getName()`
`String`	`getProvenance()`
`int`	`hashCode()`
`String`	`toString()`

Methods inherited from class SerializableObject
getRawData, setRawData

Methods inherited from class NullableFieldTracker
getExplicitlySetNullableFields, isFieldExplicitlySet, markNullableFieldAsSet, markNullableFieldsAsSet

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

- Field Detail
  - name
```
protected final String name
```
    The name of the new group to be created. This name must be unique within the enterprise.
  - provenance
```
protected String provenance
```
    Keeps track of which external source this group is coming, for example `Active Directory`, or `Okta`.
    Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application.
    This is desirable for one-way syncing of groups.
  - externalSyncIdentifier
```
protected String externalSyncIdentifier
```
    An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group.
    Example values of this field could be an **Active Directory Object ID** or a **Google Group ID**.
    We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
  - description
```
protected String description
```
    A human readable description of the group.
  - invitabilityLevel
```
protected EnumWrapper<CreateGroupRequestBodyInvitabilityLevelField> invitabilityLevel
```
    Specifies who can invite the group to collaborate on folders.
    When set to `admins_only` the enterprise admin, co-admins, and the group's admin can invite the group.
    When set to `admins_and_members` all the admins listed above and group members can invite the group.
    When set to `all_managed_users` all managed users in the enterprise can invite the group.
  - memberViewabilityLevel
```
protected EnumWrapper<CreateGroupRequestBodyMemberViewabilityLevelField> memberViewabilityLevel
```
    Specifies who can see the members of the group.
    * `admins_only` - the enterprise admin, co-admins, group's group admin. * `admins_and_members` - all admins and group members. * `all_managed_users` - all managed users in the enterprise.
- Constructor Detail
  - CreateGroupRequestBody
```
public CreateGroupRequestBody(String name)
```
  - CreateGroupRequestBody
```
protected CreateGroupRequestBody(CreateGroupRequestBody.Builder builder)
```
- Method Detail
  - getName
```
public String getName()
```
  - getProvenance
```
public String getProvenance()
```
  - getExternalSyncIdentifier
```
public String getExternalSyncIdentifier()
```
  - getDescription
```
public String getDescription()
```
  - getInvitabilityLevel
```
public EnumWrapper<CreateGroupRequestBodyInvitabilityLevelField> getInvitabilityLevel()
```
  - getMemberViewabilityLevel
```
public EnumWrapper<CreateGroupRequestBodyMemberViewabilityLevelField> getMemberViewabilityLevel()
```
  - equals
```
public boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class CreateGroupRequestBody

Nested Class Summary

Field Summary

Fields inherited from class NullableFieldTracker

Constructor Summary

Method Summary

Methods inherited from class SerializableObject

Methods inherited from class NullableFieldTracker

Methods inherited from class Object

Field Detail

name

provenance

externalSyncIdentifier

description

invitabilityLevel

memberViewabilityLevel

Constructor Detail

CreateGroupRequestBody

CreateGroupRequestBody

Method Detail

getName

getProvenance

getExternalSyncIdentifier

getDescription

getInvitabilityLevel

getMemberViewabilityLevel

equals

hashCode

toString