com.emc.vipr.client.core

Class IpInterfaces

java.lang.Object

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

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

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

com.emc.vipr.client.core.IpInterfaces

All Implemented Interfaces:

BulkResources<IpInterfaceRestRep>, Resources<IpInterfaceRestRep>

public class IpInterfaces
extends AbstractCoreBulkResources<IpInterfaceRestRep>

IP Interfaces resources.

Base URL: /compute/ip-interfaces

Constructor Summary

Constructors

Constructor and Description
IpInterfaces(ViPRCoreClient parent, RestClient client)

Method Summary

Modifier and Type	Method and Description
IpInterfaceRestRep	create(java.net.URI hostId, IpInterfaceCreateParam input) Creates an IP interface for the given host.
void	deactivate(java.net.URI id) Deactivates the given IP interface.
IpInterfaceRestRep	deregister(java.net.URI id) De-registers the given IP interface by ID.
java.util.List<IpInterfaceRestRep>	getByHost(java.net.URI hostId) Gets the list of IP interfaces for the given host.
java.util.List<IpInterfaceRestRep>	getByHost(java.net.URI hostId, ResourceFilter<IpInterfaceRestRep> filter) Gets the list of IP interfaces for the given host, optionally filtering the results.
java.util.List<IpInterfaceRestRep>	getByNetwork(java.net.URI networkId) Gets the list of IP interfaces in the given network.
java.util.List<IpInterfaceRestRep>	getByNetwork(java.net.URI networkId, ResourceFilter<IpInterfaceRestRep> filter) Gets the list of IP interfaces in the given network, optionally filtering the results.
java.util.List<NamedRelatedResourceRep>	listByHost(java.net.URI hostId) Lists the IP interfaces for the given host.
java.util.List<NamedRelatedResourceRep>	listByNetwork(java.net.URI networkId) Lists the IP interfaces in the given network.
IpInterfaceRestRep	register(java.net.URI id) Registers the given IP interface by ID.
IpInterfaceRestRep	update(java.net.URI id, IpInterfaceUpdateParam input) Updates the given IP interface.
IpInterfaces	withInactive(boolean inactive) Configures the fetch operations to include inactive resources.
IpInterfaces	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

IpInterfaces

public IpInterfaces(ViPRCoreClient parent,
                    RestClient client)

Method Detail

withInactive

public IpInterfaces withInactive(boolean inactive)

Description copied from class: AbstractResources

Configures the fetch operations to include inactive resources.

Overrides:

withInactive in class AbstractResources<IpInterfaceRestRep>

Parameters:

inactive - whether to include inactive resources.

Returns:

this AbstractResources.

withInternal

public IpInterfaces withInternal(boolean internal)

Description copied from class: AbstractResources

Configures the fetch operations to include internal resources.

Overrides:

withInternal in class AbstractResources<IpInterfaceRestRep>

Parameters:

internal - whether to include internal resources.

Returns:

this AbstractResources.

create

public IpInterfaceRestRep create(java.net.URI hostId,
                                 IpInterfaceCreateParam input)

Creates an IP interface for the given host.

API Call: POST /compute/hosts/{hostId}/ip-interfaces

Parameters:

hostId - the ID of the host.

input - the create configuration.

Returns:

the created IP interface.

update

public IpInterfaceRestRep update(java.net.URI id,
                                 IpInterfaceUpdateParam input)

Updates the given IP interface.

API Call: PUT /compute/ip-interfaces/{id}

Parameters:

id - the ID of the IP interface.

input - the updated configuration.

Returns:

the updated IP interface.

deactivate

public void deactivate(java.net.URI id)

Deactivates the given IP interface.

API Call: POST /compute/ip-interfaces/{id}

Parameters:

id - the ID of the IP interface.

listByHost

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

Lists the IP interfaces for the given host.

API Call: GET /compute/hosts/{hostId}/ip-interfaces

Parameters:

hostId - the ID of the host.

Returns:

the list of IP interface references.

getByHost

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

Gets the list of IP interfaces for the given host.

Parameters:

hostId - the ID of the host.

Returns:

the list of IP interfaces.

getByHost

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

Gets the list of IP interfaces 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 IP interfaces.

listByNetwork

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

Lists the IP interfaces in the given network.

API Call: GET /vdc/networks/{networkId}/ip-interfaces

Parameters:

networkId - the ID of the network.

Returns:

the list of IP interface references in the given network.

getByNetwork

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

Gets the list of IP interfaces in the given network.

Parameters:

networkId - the ID of the network.

Returns:

the list of IP interfaces in the given network.

getByNetwork

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

Gets the list of IP interfaces 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 IP interfaces in the given network.

register

public IpInterfaceRestRep register(java.net.URI id)

Registers the given IP interface by ID.

API Call: POST /compute/ip-interfaces/{id}/register

Parameters:

id - the ID of the IP interface.

Returns:

the updated IP interface.

deregister

public IpInterfaceRestRep deregister(java.net.URI id)

De-registers the given IP interface by ID.

API Call: POST /computer/ip-interfaces/{id}/deregister

Parameters:

id - the ID of the IP interface.

Returns:

the updated IP interface.