com.emc.vipr.client.core

Class StoragePorts

java.lang.Object

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

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

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

com.emc.vipr.client.core.StoragePorts

All Implemented Interfaces:

BulkResources<StoragePortRestRep>, Resources<StoragePortRestRep>, TopLevelResources<StoragePortRestRep>

public class StoragePorts
extends AbstractCoreBulkResources<StoragePortRestRep>
implements TopLevelResources<StoragePortRestRep>

Storage Ports resources.

Base URL: /vdc/storage-ports

Constructor Summary

Constructors

Constructor and Description
StoragePorts(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
StoragePortRestRep	create(java.net.URI id, StoragePortRequestParam input) Creates the given storage port.
StoragePortRestRep	deregister(java.net.URI id) De-registers a storage port.
java.util.List<StoragePortRestRep>	getAll() Gets a list of all storage ports.
java.util.List<StoragePortRestRep>	getAll(ResourceFilter<StoragePortRestRep> filter) Gets a list of all storage ports, optionally filtering the results.
java.util.List<StoragePortRestRep>	getByNetwork(java.net.URI networkId) Gets the list of storage ports for the given network by ID.
java.util.List<StoragePortRestRep>	getByNetwork(java.net.URI networkId, ResourceFilter<StoragePortRestRep> filter) Gets the list of storage ports for the given network by ID, optionally filtering the results.
java.util.List<StoragePortRestRep>	getByStorageSystem(java.net.URI storageSystemId) Gets the list of storage ports for the given storage system by ID.
java.util.List<StoragePortRestRep>	getByStorageSystem(java.net.URI storageSystemId, ResourceFilter<StoragePortRestRep> filter) Gets the list of storage ports for the given storage system by ID, optionally filtering the results.
java.util.List<StoragePortRestRep>	getByVirtualArray(java.net.URI virtualArrayId) Gets the list of storage ports for the given virtual array by ID.
java.util.List<StoragePortRestRep>	getByVirtualArray(java.net.URI virtualArrayId, ResourceFilter<StoragePortRestRep> filter) Gets the list of storage ports for the given virtual array by ID, optionally filtering the results.
java.util.List<NamedRelatedResourceRep>	list() Lists all storage ports.
java.util.List<NamedRelatedResourceRep>	listByNetwork(java.net.URI networkId) Lists the storage ports for the given network by ID.
java.util.List<NamedRelatedResourceRep>	listByStorageSystem(java.net.URI storageSystemId) Lists the storage ports for the given storage system by ID.
java.util.List<NamedRelatedResourceRep>	listByVirtualArray(java.net.URI virtualArrayId) Lists the storage ports for the given virtual array by ID.
StoragePortRestRep	register(java.net.URI portId, java.net.URI storageSystemId) Registers a storage port with the given storage system by ID.
StoragePortRestRep	update(java.net.URI id, StoragePortUpdate input) Updates the given storage port by ID.
StoragePorts	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
StoragePorts	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

StoragePorts

public StoragePorts(ViPRCoreClient parent,
                    RestClient client)

Method Detail

withInactive

public StoragePorts withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<StoragePortRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public StoragePorts withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<StoragePortRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

list

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

Lists all storage ports.

API Call: GET /vdc/storage-ports

Specified by:

list in interface TopLevelResources<StoragePortRestRep>

Returns:

the list of storage port references.

getAll

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

Gets a list of all storage ports. This is a convenience method for getByRefs(list()).

Specified by:

getAll in interface TopLevelResources<StoragePortRestRep>

Returns:

the list of all storage ports.

See Also:

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

getAll

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

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

Specified by:

getAll in interface TopLevelResources<StoragePortRestRep>

Parameters:

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

Returns:

the list of all storage ports.

See Also:

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

create

public StoragePortRestRep create(java.net.URI id,
                                 StoragePortRequestParam input)

Creates the given storage port.

API call: POST

Parameters:

id - the storage system Id

input - the storage port

Returns:

the new storage port

update

public StoragePortRestRep update(java.net.URI id,
                                 StoragePortUpdate input)

Updates the given storage port by ID.

API Call: PUT /vdc/storage-ports/{id}

Parameters:

id - the ID of the storage port to update.

input - the update configuration.

Returns:

the updated storage port.

register

public StoragePortRestRep register(java.net.URI portId,
                                   java.net.URI storageSystemId)

Registers a storage port with the given storage system by ID.

API Call: POST /vdc/storage-systems/{storageSystemId}/storage-ports/{portId}/register

Parameters:

portId - the ID of the storage port.

storageSystemId - the ID of the storage system.

Returns:

the updated storage port.

deregister

public StoragePortRestRep deregister(java.net.URI id)

De-registers a storage port.

API Call: POST /vdc/storage-ports/{id}/deregister

Parameters:

id - the ID of the storage port to de-register.

listByStorageSystem

public java.util.List<NamedRelatedResourceRep> listByStorageSystem(java.net.URI storageSystemId)

Lists the storage ports for the given storage system by ID.

API Call: GET /vdc/storage-systems/{storageSystemId}/storage-ports

Parameters:

storageSystemId - the ID of the storage system.

Returns:

the list of storage port references.

getByStorageSystem

public java.util.List<StoragePortRestRep> getByStorageSystem(java.net.URI storageSystemId)

Gets the list of storage ports for the given storage system by ID. This is a convenience method for: getByRefs(listByStorageSystem(storageSystemId)).

Parameters:

storageSystemId - the ID of the storage system.

Returns:

the list of storage ports.

getByStorageSystem

public java.util.List<StoragePortRestRep> getByStorageSystem(java.net.URI storageSystemId,
                                                             ResourceFilter<StoragePortRestRep> filter)

Gets the list of storage ports for the given storage system by ID, optionally filtering the results. This is a convenience method for: getByRefs(listByStorageSystem(storageSystemId), filter).

Parameters:

storageSystemId - the ID of the storage system.

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

Returns:

the list of storage ports.

listByNetwork

public java.util.List<NamedRelatedResourceRep> listByNetwork(java.net.URI networkId)

Lists the storage ports for the given network by ID.

API Call: GET /vdc/networks/{networkId}/storage-ports

Parameters:

networkId - the ID of the network.

Returns:

the list of storage port references.

getByNetwork

public java.util.List<StoragePortRestRep> getByNetwork(java.net.URI networkId)

Gets the list of storage ports for the given network by ID. This is a convenience method for: getByRefs(listByNetwork(networkId))

Parameters:

networkId - the ID of the network.

Returns:

the list of storage ports.

getByNetwork

public java.util.List<StoragePortRestRep> getByNetwork(java.net.URI networkId,
                                                       ResourceFilter<StoragePortRestRep> filter)

Gets the list of storage ports for the given network by ID, optionally filtering the results. This is a convenience method for: getByRefs(listByNetwork(networkId), filter)

Parameters:

networkId - the ID of the network.

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

Returns:

the list of storage ports.

listByVirtualArray

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

Lists the storage ports for the given virtual array by ID.

API Call: GET /vdc/varrays/{virtualArrayId}/storage-ports

Parameters:

virtualArrayId - the ID of the virtual array.

Returns:

the list of storage port references.

getByVirtualArray

public java.util.List<StoragePortRestRep> getByVirtualArray(java.net.URI virtualArrayId)

Gets the list of storage ports for the given virtual array by ID. This is a convenience method for: getByRefs(listByVirtualArray(virtualArrayId))

Parameters:

virtualArrayId - the ID of the virtual array.

Returns:

the list of storage ports.

getByVirtualArray

public java.util.List<StoragePortRestRep> getByVirtualArray(java.net.URI virtualArrayId,
                                                            ResourceFilter<StoragePortRestRep> filter)

Gets the list of storage ports for the given virtual array by ID, optionally filtering the results. This is a convenience method for: getByRefs(listByVirtualArray(virtualArrayId), filter)

Parameters:

virtualArrayId - the ID of the virtual array.

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

Returns:

the list of storage ports.