com.box.sdk

Class BoxStoragePolicyAssignment

Object

BoxResource

BoxStoragePolicyAssignment

@BoxResourceType(value="storage_policy_assignment")
public class BoxStoragePolicyAssignment
extends BoxResource

Represents a BoxStoragePolicyAssignment.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	BoxStoragePolicyAssignment.Info Contains information about a BoxStoragePolicyAssignment.

Field Summary

Fields

Modifier and Type	Field and Description
static URLTemplate	STORAGE_POLICY_ASSIGNMENT_URL_TEMPLATE Storage Policies Assignment URL Template.
static URLTemplate	STORAGE_POLICY_ASSIGNMENT_WITH_ID_URL_TEMPLATE Storage Policy Assignment URL Template.

Constructor Summary

Constructors

Constructor and Description
BoxStoragePolicyAssignment(BoxAPIConnection api, String id) Constructs a BoxStoragePolicyAssignment for a BoxStoragePolicy with a givenID.

Method Summary

Modifier and Type	Method and Description
static BoxStoragePolicyAssignment.Info	assign(BoxAPIConnection api, String storagePolicyID, String userID) Checks if there is already a Storage Policy Assignment and creates one if one does not exist.
static BoxStoragePolicyAssignment.Info	create(BoxAPIConnection api, String policyID, String userID) Create a BoxStoragePolicyAssignment for a BoxStoragePolicy.
void	delete() Deletes this BoxStoragePolicyAssignment.
static BoxStoragePolicyAssignment.Info	getAssignmentForTarget(BoxAPIConnection api, String resolvedForType, String resolvedForID) Returns a BoxStoragePolicyAssignment information.
BoxStoragePolicyAssignment.Info	getInfo()
void	updateInfo(BoxStoragePolicyAssignment.Info info) Updates the information about the BoxStoragePolicyAssignment with any info fields that have been modified locally.

Methods inherited from class BoxResource

equals, getAPI, getID, getResourceType, hashCode

Methods inherited from class Object

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

Field Detail

STORAGE_POLICY_ASSIGNMENT_URL_TEMPLATE

public static final URLTemplate STORAGE_POLICY_ASSIGNMENT_URL_TEMPLATE

Storage Policies Assignment URL Template.

STORAGE_POLICY_ASSIGNMENT_WITH_ID_URL_TEMPLATE

public static final URLTemplate STORAGE_POLICY_ASSIGNMENT_WITH_ID_URL_TEMPLATE

Storage Policy Assignment URL Template.

Constructor Detail

BoxStoragePolicyAssignment

public BoxStoragePolicyAssignment(BoxAPIConnection api,
                                  String id)

Constructs a BoxStoragePolicyAssignment for a BoxStoragePolicy with a givenID.

Parameters:

api - the API connection to be used by the file.

id - the ID of the file.

Method Detail

create

public static BoxStoragePolicyAssignment.Info create(BoxAPIConnection api,
                                                     String policyID,
                                                     String userID)

Create a BoxStoragePolicyAssignment for a BoxStoragePolicy.

Parameters:

api - the API connection to be used by the resource.

policyID - the policy ID of the BoxStoragePolicy.

userID - the user ID of the to assign the BoxStoragePolicy to.

Returns:

the information about the BoxStoragePolicyAssignment created.

getAssignmentForTarget

public static BoxStoragePolicyAssignment.Info getAssignmentForTarget(BoxAPIConnection api,
                                                                     String resolvedForType,
                                                                     String resolvedForID)

Returns a BoxStoragePolicyAssignment information.

Parameters:

api - the API connection to be used by the resource.

resolvedForType - the assigned entity type for the storage policy.

resolvedForID - the assigned entity id for the storage policy.

Returns:

information about this BoxStoragePolicyAssignment.

assign

public static BoxStoragePolicyAssignment.Info assign(BoxAPIConnection api,
                                                     String storagePolicyID,
                                                     String userID)

Checks if there is already a Storage Policy Assignment and creates one if one does not exist.

Parameters:

api - the API connection to be used by the resource.

storagePolicyID - the ID of the Storage Policy you want to assign to user.

userID - the ID of the user you want to assign the Storage Policy to.

Returns:

information about this BoxStoragePolicyAssignment.

updateInfo

public void updateInfo(BoxStoragePolicyAssignment.Info info)

Updates the information about the BoxStoragePolicyAssignment with any info fields that have been modified locally.

Parameters:

info - the updated info.

getInfo

public BoxStoragePolicyAssignment.Info getInfo()

Returns:

information about this BoxStoragePolicyAssignment.

delete

public void delete()

Deletes this BoxStoragePolicyAssignment.