org.cloudfoundry.client.v2.routes.Routes Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of cloudfoundry-client Show documentation
The newest version!
/*
 * Copyright 2013-2021 the original author or authors.
 *
 * 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.cloudfoundry.client.v2.routes;

import reactor.core.publisher.Mono;

/**
 * Main entry point to the Cloud Foundry Routes V2 Client API
 */
public interface Routes {

    /**
     * Makes the Associate Application with the Route request
     *
     * @param request the Associate an Application with the Route request
     * @return the response from the Associate an Application with the Route request
     */
    Mono associateApplication(
            AssociateRouteApplicationRequest request);

    /**
     * Makes the Creating a Route request
     *
     * @param request the Creating a Route request
     * @return the response from the Creating a Route request
     */
    Mono create(CreateRouteRequest request);

    /**
     * Makes the Delete a Particular Route request
     *
     * @param request the Delete a Particular Route request
     * @return the response from the Delete a Particular Route request
     */
    Mono delete(DeleteRouteRequest request);

    /**
     * Makes the Check a Route exists request
     *
     * @param request the Check a Route exists request
     * @return the response from the Check a Route exists request
     */
    Mono exists(RouteExistsRequest request);

    /**
     * Makes the Retrieve a Particular Route request
     *
     * @param request the Retrieve a Particular Route request
     * @return the response from the Retrieve a Particular Route request
     */
    Mono get(GetRouteRequest request);

    /**
     * Makes the List all Routes request
     *
     * @param request the List all Applications for the Route request
     * @return the response from the List all Applications for the Route request
     */
    Mono list(ListRoutesRequest request);

    /**
     * Makes the List all Applications for the Route request
     *
     * @param request the List all Applications for the Route request
     * @return the response from the List all Applications for the Route request
     */
    Mono listApplications(ListRouteApplicationsRequest request);

    /**
     * Makes the List all Route Mappings for the Route request
     *
     * @param request the List all Route Mappings for the Route request
     * @return the response from the List all Route Mappings for the Route request
     */
    Mono listMappings(ListRouteMappingsRequest request);

    /**
     * Makes the Remove Application from the Route request
     *
     * @param request the Remove Application from the Route request
     * @return the response from the Remove Application from the Route request
     */
    Mono removeApplication(RemoveRouteApplicationRequest request);

    /**
     * Makes the Update a Route request
     *
     * @param request the Update a Route request
     * @return the response from the Update a Route request
     */
    Mono update(UpdateRouteRequest request);
}