public class Initiators extends AbstractCoreBulkResources<InitiatorRestRep>
Base URL: /compute/initiators
Constructor and Description |
---|
Initiators(ViPRCoreClient parent,
RestClient client) |
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.
|
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 Initiators(ViPRCoreClient parent, RestClient client)
public Initiators withInactive(boolean inactive)
AbstractResources
withInactive
in class AbstractResources<InitiatorRestRep>
inactive
- whether to include inactive resources.public Initiators withInternal(boolean internal)
AbstractResources
withInternal
in class AbstractResources<InitiatorRestRep>
internal
- whether to include internal resources.public Task<InitiatorRestRep> create(java.net.URI hostId, InitiatorCreateParam input)
API Call: POST /compute/hosts/{hostId}/initiators
hostId
- the ID of the host.input
- the initiator configuration.public InitiatorRestRep update(java.net.URI id, InitiatorUpdateParam input)
API Call: PUT /compute/initiators/{id}
id
- the ID of the initiator.input
- the updated configuration.public Task<InitiatorRestRep> deactivate(java.net.URI id)
API Call: POST /compute/initiators/{id}/deactivate
id
- the ID of the initiator.public java.util.List<ITLRestRep> getExports(java.net.URI id)
API Call: GET /compute/initiators/{id}/exports
id
- the ID of the initiator.public java.util.List<NamedRelatedResourceRep> listByHost(java.net.URI hostId)
API Call: GET /compute/hosts/{hostId}/initiators
hostId
- the ID of the host.public java.util.List<InitiatorRestRep> getByHost(java.net.URI hostId)
hostId
- the ID of the host.public java.util.List<InitiatorRestRep> getByHost(java.net.URI hostId, ResourceFilter<InitiatorRestRep> filter)
hostId
- the ID of the host.filter
- the resource filter to apply to the results as they are returned (optional).public java.util.List<NamedRelatedResourceRep> listByNetwork(java.net.URI networkId)
API Call: GET /vdc/networks/{networkId}/initiators
networkId
- the ID of the network.public java.util.List<InitiatorRestRep> getByNetwork(java.net.URI networkId)
networkId
- the ID of the network.public java.util.List<InitiatorRestRep> getByNetwork(java.net.URI networkId, ResourceFilter<InitiatorRestRep> filter)
networkId
- the ID of the network.filter
- the resource filter to apply to the results as they are returned (optional).public InitiatorRestRep register(java.net.URI id)
API Call: POST /compute/initiators/{id}/register
id
- the ID of the initiator.public InitiatorRestRep deregister(java.net.URI id)
API Call: POST /computer/initiators/{id}/deregister
id
- the ID of the initiator.