public class Networks extends AbstractCoreBulkResources<NetworkRestRep> implements TopLevelResources<NetworkRestRep>
Base URL: /vdc/networks
Constructor and Description |
---|
Networks(ViPRCoreClient parent,
RestClient client) |
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.
|
getByIds, getByRefs, listBulkIds
addTags, get, get, getByIds, getByRefs, getTags, performSearch, performSearchBy, removeTags, search, updateTags
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
getByIds, getByRefs
addTags, get, get, getTags, removeTags, search, updateTags
public Networks(ViPRCoreClient parent, RestClient client)
public Networks withInactive(boolean inactive)
AbstractResources
withInactive
in class AbstractResources<NetworkRestRep>
inactive
- whether to include inactive resources.public Networks withInternal(boolean internal)
AbstractResources
withInternal
in class AbstractResources<NetworkRestRep>
internal
- whether to include internal resources.public java.util.List<NamedRelatedResourceRep> list()
API Call: GET /vdc/networks
list
in interface TopLevelResources<NetworkRestRep>
public java.util.List<NetworkRestRep> getAll()
getAll
in interface TopLevelResources<NetworkRestRep>
TopLevelResources.list()
,
Resources.getByRefs(java.util.Collection)
public java.util.List<NetworkRestRep> getAll(ResourceFilter<NetworkRestRep> filter)
getAll
in interface TopLevelResources<NetworkRestRep>
filter
- the resource filter to apply to the results as they are returned (optional).TopLevelResources.list()
,
Resources.getByRefs(java.util.Collection, ResourceFilter)
public java.util.List<NamedRelatedResourceRep> listByVirtualArray(java.net.URI varrayId)
API Call: GET /vdc/varrays/{id}/networks
varrayId
- the ID of the virtual array.public java.util.List<NetworkRestRep> getByVirtualArray(java.net.URI varrayId)
varrayId
- the ID of the virtual array.listByVirtualArray(URI)
,
AbstractResources.getByRefs(java.util.Collection)
public java.util.List<NetworkRestRep> getByVirtualArray(java.net.URI varrayId, ResourceFilter<NetworkRestRep> filter)
varrayId
- the ID of the virtual array.filter
- the resource filter to apply to the results as they are returned (optional).listByVirtualArray(URI)
,
AbstractResources.getByRefs(java.util.Collection)
public NetworkRestRep create(NetworkCreate input)
API Call: POST /vdc/networks
input
- the create configuration.@Deprecated public NetworkRestRep create(java.net.URI virtualArrayId, NetworkCreate input)
create(NetworkCreate)
instead.API Call: POST /vdc/varrays/{virtualArrayId}/networks
virtualArrayId
- the ID of the virtual array.input
- the create configuration.public NetworkRestRep update(java.net.URI id, NetworkUpdate input)
API Call: PUT /vdc/networks/{id}
id
- the ID of the network to update.input
- the update configuration.public void deactivate(java.net.URI id)
API Call: POST /vdc/networks/{id}/deactivate?force=false
id
- the ID of the network to deactivate.public void deactivate(java.net.URI id, boolean force)
API Call: POST /vdc/networks/{id}/deactivate?force={force}
id
- the ID of the network to deactivate.force
- if true, will delete manually created network.public void deactivate(NetworkRestRep value)
public NetworkRestRep register(java.net.URI id)
API Call: POST /vdc/networks/{id}/register
id
- the ID of the network to register.public NetworkRestRep deregister(java.net.URI id)
API Call: POST /vdc/networks/{id}/deregister
id
- the ID of the network to deregister.@Deprecated public NetworkRestRep updateEndpoints(java.net.URI id, NetworkEndpointParam input)
API Call: PUT /vdc/networks/{id}/endpoints
id
- the ID of the network.input
- the endpoint configuration.update(java.net.URI, com.emc.storageos.model.varray.NetworkUpdate)