org.openstack4j.api.manila

Interface ShareNetworkService

All Superinterfaces:

RestService

All Known Implementing Classes:

ShareNetworkServiceImpl

public interface ShareNetworkService
extends RestService

Share Networks Service for Manila Shared File Systems.

Author:

Daniel Gonzalez Nothnagel

Method Summary

Modifier and Type	Method and Description
ShareNetwork	addSecurityService(String shareNetworkId, String securityServiceId) Adds a security service to a share network.
ShareNetwork	create(ShareNetworkCreate shareNetworkCreate) Creates a share network.
ActionResponse	delete(String shareNetworkId) Deletes a share network.
ShareNetwork	get(String shareNetworkId) Shows details for a share network.
List<? extends ShareNetwork>	list() Lists all share networks.
List<? extends ShareNetwork>	listDetails() Lists all share networks with details.
ShareNetwork	removeSecurityService(String shareNetworkId, String securityServiceId) Removes a security service from a share network.
ShareNetworkCreateBuilder	shareNetworkCreateBuilder()
ShareNetwork	update(String shareNetworkId, ShareNetworkUpdateOptions shareNetworkUpdateOptions) Updates a share network.

Method Detail

create

ShareNetwork create(ShareNetworkCreate shareNetworkCreate)

Creates a share network.

Parameters:

shareNetworkCreate - the share network to create

Returns:

the created share network

list

List<? extends ShareNetwork> list()

Lists all share networks.

Returns:

list of all share networks

listDetails

List<? extends ShareNetwork> listDetails()

Lists all share networks with details.

Returns:

list of all share networks with details

get

ShareNetwork get(String shareNetworkId)

Shows details for a share network.

Parameters:

shareNetworkId - the share network ID

Returns:

the share network or null if not found

update

ShareNetwork update(String shareNetworkId,
                    ShareNetworkUpdateOptions shareNetworkUpdateOptions)

Updates a share network.

Parameters:

shareNetworkId - the share network ID

shareNetworkUpdateOptions - the options to update on the share network

Returns:

the updated share network

delete

ActionResponse delete(String shareNetworkId)

Deletes a share network.

Parameters:

shareNetworkId - the share network ID

Returns:

the action response

addSecurityService

ShareNetwork addSecurityService(String shareNetworkId,
                                String securityServiceId)

Adds a security service to a share network.

Parameters:

shareNetworkId - the share network ID

securityServiceId - the security service ID

Returns:

the share network the security service was added to

removeSecurityService

ShareNetwork removeSecurityService(String shareNetworkId,
                                   String securityServiceId)

Removes a security service from a share network.

Parameters:

shareNetworkId - the share network ID

securityServiceId - the security service ID

Returns:

the share network the security service was removed from

shareNetworkCreateBuilder

ShareNetworkCreateBuilder shareNetworkCreateBuilder()

Returns:

a builder to create a share network