org.openstack4j.model.manila.ShareNetwork Maven / Gradle / Ivy

package org.openstack4j.model.manila;

import com.fasterxml.jackson.annotation.JsonCreator;
import com.fasterxml.jackson.annotation.JsonValue;
import org.openstack4j.model.ModelEntity;

/**
 * A share network stores network information that share servers can use where shares are hosted.
 * A share network has these attributes:
 * 
 * The IP block in Classless Inter-Domain Routing (CIDR) notation from which to allocate the network.
 * The IP version of the network.
 * The network type, which is {@code vlan}, {@code vxlan}, {@code gre}, or {@code flat}.
 * If the network uses segmentation, a segmentation identifier. For example, VLAN, VXLAN,
 * and GRE networks use segmentation.
 * 
 *
 * @author Daniel Gonzalez Nothnagel
 */
public interface ShareNetwork extends ModelEntity {
    enum NetworkType {
        VLAN, VXLAN, GRE, FLAT;

        @JsonCreator
        public static NetworkType value(String v) {
            return valueOf(v.toUpperCase());
        }

        @JsonValue
        public String value() {
            return name().toLowerCase();
        }
    }

    /**
     * @return the share network ID
     */
    String getId();

    /**
     * @return the UUID of the project where the share network was created
     */
    String getProjectId();

    /**
     * @return the neutron network ID
     */
    String getNeutronNetId();

    /**
     * @return the neutron subnet ID
     */
    String getNeutronSubnetId();

    /**
     * @return the nova network ID
     */
    String getNovaNetId();

    /**
     * @return the network type
     */
    NetworkType getNetworkType();

    /**
     * @return the segmentation ID
     */
    Integer getSegmentationId();

    /**
     * @return the CIDR
     */
    String getCidr();

    /**
     * @return the IP version of the network
     */
    Integer getIpVersion();

    /**
     * @return the share network name
     */
    String getName();

    /**
     * @return the share network description
     */
    String getDescription();

    /**
     * @return the date and time stamp when the share network was created
     */
    String getCreatedAt();

    /**
     * @return the date and time stamp when the share network was updated
     */
    String getUpdatedAt();
}