Interface Share

  • All Superinterfaces:
    ModelEntity, Serializable
    All Known Implementing Classes:
    ManilaShare

    public interface Share
    extends ModelEntity
    A share is a remote, mountable file system. You can mount a share to and access a share from several hosts by several users at a time.
    Author:
    Daniel Gonzalez Nothnagel
    • Method Detail

      • getId

        String getId()
        Returns:
        The UUID of the share
      • getStatus

        Share.Status getStatus()
        Returns:
        The share status
      • getLinks

        List<? extends Link> getLinks()
        Returns:
        The share links
      • getProjectId

        String getProjectId()
        Returns:
        The UUID of the project in which the share was created
      • getShareProto

        Share.Protocol getShareProto()
        Returns:
        The Shared File Systems protocol
      • getSize

        Integer getSize()
        Returns:
        The share size, in GBs
      • getName

        String getName()
        Returns:
        The share name
      • getDescription

        String getDescription()
        Returns:
        The share description
      • getDisplayName

        String getDisplayName()
        Returns:
        The share name
      • getDisplayDescription

        String getDisplayDescription()
        Returns:
        The share description.
      • getShareType

        String getShareType()
        Returns:
        The UUID of the share type
      • getShareTypeName

        String getShareTypeName()
        Returns:
        The share type name
      • getVolumeType

        String getVolumeType()
        Returns:
        The volume type
      • getSnapshotId

        String getSnapshotId()
        Returns:
        The UUID of the snapshot from which to create the share
      • isPublic

        Boolean isPublic()
        Returns:
        The level of visibility for the share
      • getMetadata

        Map<String,​String> getMetadata()
        Returns:
        One or more metadata key and value pairs as a dictionary of strings
      • getShareNetworkId

        String getShareNetworkId()
        Returns:
        The UUID of the share network
      • getAvailabilityZone

        String getAvailabilityZone()
        Returns:
        The availability zone
      • getExportLocation

        String getExportLocation()
        Returns:
        The export location
      • getExportLocations

        List<String> getExportLocations()
        Returns:
        A list of export locations
      • getHost

        String getHost()
        Returns:
        The share host name
      • getTaskState

        Share.TaskState getTaskState()
        Returns:
        For the share migration, the migration task state
      • getShareServerId

        String getShareServerId()
        Returns:
        The UUID of the share server
      • getConsistencyGroupId

        String getConsistencyGroupId()
        Returns:
        The UUID of the consistency group where the share was created
      • getSnapshotSupport

        Boolean getSnapshotSupport()
        Returns:
        An extra specification that filters back ends by whether they do or do not support share snapshots
      • getSourceCgsnapshotMemberId

        String getSourceCgsnapshotMemberId()
        Returns:
        If the share was created with consistency_group_id attribute, the snapshot member ID
      • getCreatedAt

        String getCreatedAt()
        Returns:
        The date and time stamp when the share was created