org.openstack4j.api.senlin.SenlinPolicyService Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of openstack4j-core Show documentation

OpenStack Java API

The newest version!

package org.openstack4j.api.senlin;

import org.openstack4j.model.common.ActionResponse;
import org.openstack4j.model.senlin.Policy;
import org.openstack4j.model.senlin.PolicyCreate;

import java.util.List;

/**
 * This interface defines all methods for the manipulation of Policy
 * 
 * @author lion
 * 
 */
public interface SenlinPolicyService {
	
	/**
	 * Gets a list of currently existing {@link Policy}s.
	 * 
	 * @return the list of {@link Policy}s
	 */
	List list();

	/**
	 * POST /v1/policies

	 *
	 * Creates a new {@link Policy} out of a {@link PolicyCreate} object
	 *
	 * @param newPolicy
	 *            {@link PolicyCreate} object out of which policy is to be created
	 * @return new {@link Policy} as returned from the server
	 */
	Policy create(PolicyCreate newPolicy);

	/**
	 * returns details of a {@link Policy}.
	 *
	 * @param policyID
	 *            Id of {@link Policy}
	 * @return Policy
	 */
	Policy get(String policyID);

	/**
	 * PATCH /v1/policies/{policy_id}

	 *
	 * Update a {@link Policy} out of a {@link PolicyCreate} object
	 *
	 * @param policyID
	 *             Id of {@link Policy}
	 * @param newPolicy
	 *            {@link PolicyCreate} object out of which stack is to be update
	 * @return new {@link Policy} as returned from the server
	 */
	Policy update(String policyID, PolicyCreate newPolicy);

	/**
	 * Deletes the specified {@link Policy} from the server.
	 *
	 * @param policyID
	 *            Id of {@link Policy}
	 * @return the action response
	 */
	ActionResponse delete(String policyID);
}