com.emc.vipr.client.core

Class Networks

java.lang.Object

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

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

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

com.emc.vipr.client.core.Networks

All Implemented Interfaces:

BulkResources<NetworkRestRep>, Resources<NetworkRestRep>, TopLevelResources<NetworkRestRep>

public class Networks
extends AbstractCoreBulkResources<NetworkRestRep>
implements TopLevelResources<NetworkRestRep>

Networks resources.

Base URL: /vdc/networks

Constructor Summary

Constructors

Constructor and Description
Networks(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
NetworkRestRep	create(NetworkCreate input) Creates a network.
NetworkRestRep	create(java.net.URI virtualArrayId, NetworkCreate input) Deprecated. use create(NetworkCreate) instead.
void	deactivate(NetworkRestRep value)
void	deactivate(java.net.URI id) Deactivates a network by ID.
void	deactivate(java.net.URI id, boolean force) Deactivates a network by ID.
NetworkRestRep	deregister(java.net.URI id) Deregisters the given network by ID.
java.util.List<NetworkRestRep>	getAll() Gets the list of all networks.
java.util.List<NetworkRestRep>	getAll(ResourceFilter<NetworkRestRep> filter) Gets the list of all networks, optionally filtering the results.
java.util.List<NetworkRestRep>	getByVirtualArray(java.net.URI varrayId) Gets the networks that are associated with the given virtual array.
java.util.List<NetworkRestRep>	getByVirtualArray(java.net.URI varrayId, ResourceFilter<NetworkRestRep> filter) Gets the networks that are associated with the given virtual array.
java.util.List<NamedRelatedResourceRep>	list() Lists all networks.
java.util.List<NamedRelatedResourceRep>	listByVirtualArray(java.net.URI varrayId) Lists the networks that are associated with the given virtual array.
NetworkRestRep	register(java.net.URI id) Registers the given network by ID.
NetworkRestRep	update(java.net.URI id, NetworkUpdate input) Updates the given network by ID.
NetworkRestRep	updateEndpoints(java.net.URI id, NetworkEndpointParam input) Deprecated. Use main update() call to update endpoints
Networks	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
Networks	withInternal(boolean internal) Configures the fetch operations to include internal resources.

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

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

Networks

public Networks(ViPRCoreClient parent,
                RestClient client)

Method Detail

withInactive

public Networks withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<NetworkRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public Networks withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<NetworkRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

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

Lists all networks.

API Call: GET /vdc/networks

Specified by:

list in interface TopLevelResources<NetworkRestRep>

Returns:

the list of network references.

getAll

public java.util.List<NetworkRestRep> getAll()

Gets the list of all networks. This is a convenience method for: getByRefs(list()).

Specified by:

getAll in interface TopLevelResources<NetworkRestRep>

Returns:

the list of all networks.

See Also:

TopLevelResources.list(), Resources.getByRefs(java.util.Collection)

getAll

public java.util.List<NetworkRestRep> getAll(ResourceFilter<NetworkRestRep> filter)

Gets the list of all networks, optionally filtering the results. This is a convenience method for: getByRefs(list(), filter) .

Specified by:

getAll in interface TopLevelResources<NetworkRestRep>

Parameters:

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

Returns:

the list of all networks.

See Also:

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

listByVirtualArray

public java.util.List<NamedRelatedResourceRep> listByVirtualArray(java.net.URI varrayId)

Lists the networks that are associated with the given virtual array.

API Call: GET /vdc/varrays/{id}/networks

Parameters:

varrayId - the ID of the virtual array.

Returns:

the list of network references.

getByVirtualArray

public java.util.List<NetworkRestRep> getByVirtualArray(java.net.URI varrayId)

Gets the networks that are associated with the given virtual array. Convenience method for calling getByRefs(listByVirtualArray(varrayId)).

Parameters:

varrayId - the ID of the virtual array.

Returns:

the list of networks.

See Also:

listByVirtualArray(URI), AbstractResources.getByRefs(java.util.Collection)

getByVirtualArray

public java.util.List<NetworkRestRep> getByVirtualArray(java.net.URI varrayId,
                                                        ResourceFilter<NetworkRestRep> filter)

Gets the networks that are associated with the given virtual array. Convenience method for calling getByRefs(listByVirtualArray(varrayId)).

Parameters:

varrayId - the ID of the virtual array.

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

Returns:

the list of networks.

See Also:

listByVirtualArray(URI), AbstractResources.getByRefs(java.util.Collection)

create

public NetworkRestRep create(NetworkCreate input)

Creates a network.

API Call: POST /vdc/networks

Parameters:

input - the create configuration.

Returns:

the newly created network.

create

@Deprecated
public NetworkRestRep create(java.net.URI virtualArrayId,
                                          NetworkCreate input)

Deprecated. use create(NetworkCreate) instead.

Creates a network in the given virtual array.

API Call: POST /vdc/varrays/{virtualArrayId}/networks

Parameters:

virtualArrayId - the ID of the virtual array.

input - the create configuration.

Returns:

the newly created network.

update

public NetworkRestRep update(java.net.URI id,
                             NetworkUpdate input)

Updates the given network by ID.

API Call: PUT /vdc/networks/{id}

Parameters:

id - the ID of the network to update.

input - the update configuration.

Returns:

the updated network.

deactivate

public void deactivate(java.net.URI id)

Deactivates a network by ID.

API Call: POST /vdc/networks/{id}/deactivate?force=false

Parameters:

id - the ID of the network to deactivate.

deactivate

public void deactivate(java.net.URI id,
                       boolean force)

Deactivates a network by ID.

API Call: POST /vdc/networks/{id}/deactivate?force={force}

Parameters:

id - the ID of the network to deactivate.

force - if true, will delete manually created network.

deactivate

public void deactivate(NetworkRestRep value)

register

public NetworkRestRep register(java.net.URI id)

Registers the given network by ID.

API Call: POST /vdc/networks/{id}/register

Parameters:

id - the ID of the network to register.

deregister

public NetworkRestRep deregister(java.net.URI id)

Deregisters the given network by ID.

API Call: POST /vdc/networks/{id}/deregister

Parameters:

id - the ID of the network to deregister.

updateEndpoints

@Deprecated
public NetworkRestRep updateEndpoints(java.net.URI id,
                                                   NetworkEndpointParam input)

Deprecated. Use main update() call to update endpoints

Updates an endpoint for the given network.

API Call: PUT /vdc/networks/{id}/endpoints

Parameters:

id - the ID of the network.

input - the endpoint configuration.

Returns:

the updated network.

See Also:

update(java.net.URI, com.emc.storageos.model.varray.NetworkUpdate)