com.emc.vipr.client.core

Class SchedulePolicies

java.lang.Object

com.emc.vipr.client.core.AbstractResources<T>

com.emc.vipr.client.core.AbstractBulkResources<T>

com.emc.vipr.client.core.AbstractCoreBulkResources<SchedulePolicyRestRep>

com.emc.vipr.client.core.SchedulePolicies

All Implemented Interfaces:

BulkResources<SchedulePolicyRestRep>, Resources<SchedulePolicyRestRep>, TenantResources<SchedulePolicyRestRep>

public class SchedulePolicies
extends AbstractCoreBulkResources<SchedulePolicyRestRep>
implements TenantResources<SchedulePolicyRestRep>

Constructor Summary

Constructors

Constructor and Description
SchedulePolicies(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
void	assignPolicyToFileSystem(java.net.URI fileSystemId, java.net.URI policyId) This method assigns a policy to a file system.
SchedulePolicyRestRep	create(java.net.URI tenantId, PolicyParam input) Creates a Schedule Policy in the given tenant.
void	delete(java.net.URI id) Deletes the given schedule policy by ID.
java.util.List<SchedulePolicyRestRep>	getByTenant(java.net.URI tenantId) Gets the resources associated with a given tenant.
java.util.List<SchedulePolicyRestRep>	getByTenant(java.net.URI tenantId, ResourceFilter<SchedulePolicyRestRep> filter) Gets the resources associated with a given tenant, optionally filtering the results as they are returned.
java.util.List<SchedulePolicyRestRep>	getByUserTenant() Convenience method for retrieving by user's current tenant.
java.util.List<SchedulePolicyRestRep>	getByUserTenant(ResourceFilter<SchedulePolicyRestRep> filter) Convenience method for retrieving by user's current tenant.
java.util.List<FilePolicyRestRep>	listByFileSystem(java.net.URI fileSystemId) Lists the file Schedule Snapshot policies for the given file system by ID.
java.util.List<NamedRelatedResourceRep>	listByTenant(java.net.URI tenantId) Lists resources associated with a given tenant.
java.util.List<NamedRelatedResourceRep>	listByUserTenant() Convenience method for listing by the user's current tenant.
void	unassignPolicyToFileSystem(java.net.URI fileSystemId, java.net.URI policyId) This method unassigna policy from the file system.
void	update(java.net.URI id, PolicyParam input) Updates the given Schedule Policy by ID.

Methods inherited from class com.emc.vipr.client.core.AbstractBulkResources

getByIds, getByRefs, listBulkIds

Methods inherited from class com.emc.vipr.client.core.AbstractResources

addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags, withInactive, withInternal

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.emc.vipr.client.core.BulkResources

getByIds, getByRefs

Methods inherited from interface com.emc.vipr.client.core.Resources

addTags, get, get, getTags, removeTags, search, updateTags

Constructor Detail

SchedulePolicies

public SchedulePolicies(ViPRCoreClient parent,
                        RestClient client)

Method Detail

delete

public void delete(java.net.URI id)

Deletes the given schedule policy by ID.

API Call: DELETE /schedule-policies/{policyId}

Parameters:

id - the ID of policy to deactivate.

create

public SchedulePolicyRestRep create(java.net.URI tenantId,
                                    PolicyParam input)

Creates a Schedule Policy in the given tenant.

API Call: POST /tenants/{tenantId}/schedule-policies

Parameters:

tenantId - the ID of the tenant.

input - the Policy configuration.

Returns:

the newly created schedule policy.

update

public void update(java.net.URI id,
                   PolicyParam input)

Updates the given Schedule Policy by ID.

API Call: PUT /schedule-policies/{policyId}

Parameters:

id - the ID of the policy to update.

input - the update configuration.

listByFileSystem

public java.util.List<FilePolicyRestRep> listByFileSystem(java.net.URI fileSystemId)

Lists the file Schedule Snapshot policies for the given file system by ID.

API Call: GET /file/filesystems/{fileSystemId}/file-policies

Parameters:

fileSystemId - the ID of the file system.

Returns:

the list of file policies references for the file system.

assignPolicyToFileSystem

public void assignPolicyToFileSystem(java.net.URI fileSystemId,
                                     java.net.URI policyId)

This method assigns a policy to a file system.

API Call: PUT /file/filesystems/{fs_id}/assign-file-policy/{policy_id}

Parameters:

fileSystemId - the ID of the file system.

policyId - the ID of the policy.

unassignPolicyToFileSystem

public void unassignPolicyToFileSystem(java.net.URI fileSystemId,
                                       java.net.URI policyId)

This method unassigna policy from the file system.

API Call: PUT /file/filesystems/{fs_id}/unassign-file-policy/{policy_id}

Parameters:

fileSystemId - the ID of the file system.

policyId - the ID of the policy.

listByUserTenant

public java.util.List<NamedRelatedResourceRep> listByUserTenant()

Description copied from interface: TenantResources

Convenience method for listing by the user's current tenant.

Equivalent to: listByTenant(client.getUserTenant())

Specified by:

listByUserTenant in interface TenantResources<SchedulePolicyRestRep>

See Also:

TenantResources.listByTenant(URI)

getByUserTenant

public java.util.List<SchedulePolicyRestRep> getByUserTenant()

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant())

Specified by:

getByUserTenant in interface TenantResources<SchedulePolicyRestRep>

See Also:

TenantResources.getByTenant(URI)

getByUserTenant

public java.util.List<SchedulePolicyRestRep> getByUserTenant(ResourceFilter<SchedulePolicyRestRep> filter)

Description copied from interface: TenantResources

Convenience method for retrieving by user's current tenant.

Equivalent to: getByTenant(client.getUserTenant(), filter)

Specified by:

getByUserTenant in interface TenantResources<SchedulePolicyRestRep>

See Also:

TenantResources.getByTenant(URI, ResourceFilter)

listByTenant

public java.util.List<NamedRelatedResourceRep> listByTenant(java.net.URI tenantId)

Description copied from interface: TenantResources

Lists resources associated with a given tenant.

Specified by:

listByTenant in interface TenantResources<SchedulePolicyRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resource references.

getByTenant

public java.util.List<SchedulePolicyRestRep> getByTenant(java.net.URI tenantId)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant.

Specified by:

getByTenant in interface TenantResources<SchedulePolicyRestRep>

Parameters:

tenantId - the tenant ID.

Returns:

the list of resources for this tenant.

See Also:

Resources.getByRefs(java.util.Collection)

getByTenant

public java.util.List<SchedulePolicyRestRep> getByTenant(java.net.URI tenantId,
                                                         ResourceFilter<SchedulePolicyRestRep> filter)

Description copied from interface: TenantResources

Gets the resources associated with a given tenant, optionally filtering the results as they are returned.

Specified by:

getByTenant in interface TenantResources<SchedulePolicyRestRep>

Parameters:

tenantId - the tenant ID.

filter - the resource filter to apply to the results as they are returned (optional).

Returns:

the list of resources for the tenant.

See Also:

Resources.getByRefs(java.util.Collection, ResourceFilter)