apps/k8s-networking/api/src/main/java/org/onosproject/k8snetworking/api/K8sIpam.java

/*
 * Copyright 2019-present Open Networking Foundation
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.onosproject.k8snetworking.api;

import org.onlab.packet.IpAddress;

/**
 * Representation of kubernetes IPAM.
 */
public interface K8sIpam {

    /**
     * Returns the IPAM identifier.
     *
     * @return IPAM identifier
     */
    String ipamId();

    /**
     * Returns the IP address.
     *
     * @return IP address
     */
    IpAddress ipAddress();

    /**
     * Returns the kubernetes network ID.
     *
     * @return kubernetes network ID
     */
    String networkId();
}