com.emc.vipr.client.core

Class Initiators

java.lang.Object

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

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

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

com.emc.vipr.client.core.Initiators

All Implemented Interfaces:

BulkResources<InitiatorRestRep>, Resources<InitiatorRestRep>

public class Initiators
extends AbstractCoreBulkResources<InitiatorRestRep>

Initiators resources.

Base URL: /compute/initiators

Constructor Summary

Constructors

Constructor and Description
Initiators(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
Task<InitiatorRestRep>	create(java.net.URI hostId, InitiatorCreateParam input) Creates an initiator for the given host.
Task<InitiatorRestRep>	deactivate(java.net.URI id) Deactivates the given initiator by ID.
InitiatorRestRep	deregister(java.net.URI id) De-registers the given initiator by ID.
java.util.List<InitiatorRestRep>	getByHost(java.net.URI hostId) Gets a list of initiators for the given host.
java.util.List<InitiatorRestRep>	getByHost(java.net.URI hostId, ResourceFilter<InitiatorRestRep> filter) Gets the list of initiators for the given host, optionally filtering the results.
java.util.List<InitiatorRestRep>	getByNetwork(java.net.URI networkId) Gets the list of initiators in the given network.
java.util.List<InitiatorRestRep>	getByNetwork(java.net.URI networkId, ResourceFilter<InitiatorRestRep> filter) Gets the list of initiators in the given network, optionally filtering the results.
java.util.List<ITLRestRep>	getExports(java.net.URI id) Gets the exports associated with the given initiator.
java.util.List<NamedRelatedResourceRep>	listByHost(java.net.URI hostId) Lists the initiators for the given host.
java.util.List<NamedRelatedResourceRep>	listByNetwork(java.net.URI networkId) Lists the initiators in the given network.
InitiatorRestRep	register(java.net.URI id) Registers the given initiator by ID.
InitiatorRestRep	update(java.net.URI id, InitiatorUpdateParam input) Updates an initiator.
Initiators	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
Initiators	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

Initiators

public Initiators(ViPRCoreClient parent,
                  RestClient client)

Method Detail

withInactive

public Initiators withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<InitiatorRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public Initiators withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<InitiatorRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

create

public Task<InitiatorRestRep> create(java.net.URI hostId,
                                     InitiatorCreateParam input)

Creates an initiator for the given host.

API Call: POST /compute/hosts/{hostId}/initiators

Parameters:

hostId - the ID of the host.

input - the initiator configuration.

Returns:

a task for monitoring the progress of the initiator creation.

update

public InitiatorRestRep update(java.net.URI id,
                               InitiatorUpdateParam input)

Updates an initiator.

API Call: PUT /compute/initiators/{id}

Parameters:

id - the ID of the initiator.

input - the updated configuration.

Returns:

the updated initiator.

deactivate

public Task<InitiatorRestRep> deactivate(java.net.URI id)

Deactivates the given initiator by ID.

API Call: POST /compute/initiators/{id}/deactivate

Parameters:

id - the ID of the initiator.

Returns:

a task for monitoring the progress of the initiator de-activation.

getExports

public java.util.List<ITLRestRep> getExports(java.net.URI id)

Gets the exports associated with the given initiator.

API Call: GET /compute/initiators/{id}/exports

Parameters:

id - the ID of the initiator.

Returns:

the list of exports for the initiator.

listByHost

public java.util.List<NamedRelatedResourceRep> listByHost(java.net.URI hostId)

Lists the initiators for the given host.

API Call: GET /compute/hosts/{hostId}/initiators

Parameters:

hostId - the ID of the host.

Returns:

the list of initiator references.

getByHost

public java.util.List<InitiatorRestRep> getByHost(java.net.URI hostId)

Gets a list of initiators for the given host.

Parameters:

hostId - the ID of the host.

Returns:

the list of initiators.

getByHost

public java.util.List<InitiatorRestRep> getByHost(java.net.URI hostId,
                                                  ResourceFilter<InitiatorRestRep> filter)

Gets the list of initiators for the given host, optionally filtering the results.

Parameters:

hostId - the ID of the host.

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

Returns:

the list of initiators.

listByNetwork

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

Lists the initiators in the given network.

API Call: GET /vdc/networks/{networkId}/initiators

Parameters:

networkId - the ID of the network.

Returns:

the list of initiator references.

getByNetwork

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

Gets the list of initiators in the given network.

Parameters:

networkId - the ID of the network.

Returns:

the list of initiators.

getByNetwork

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

Gets the list of initiators in the given network, optionally filtering the results.

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 initiators.

register

public InitiatorRestRep register(java.net.URI id)

Registers the given initiator by ID.

API Call: POST /compute/initiators/{id}/register

Parameters:

id - the ID of the initiator.

Returns:

the updated initiator.

deregister

public InitiatorRestRep deregister(java.net.URI id)

De-registers the given initiator by ID.

API Call: POST /computer/initiators/{id}/deregister

Parameters:

id - the ID of the initiator.

Returns:

the updated initiator.