org.cloudfoundry.client.v3.domains.DomainsV3 Maven / Gradle / Ivy

Go to download
/*
 * 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.v3.domains;

import reactor.core.publisher.Mono;

/**
 * Main entry point to the Cloud Foundry Domains V3 Client API
 */
public interface DomainsV3 {

    /**
     * Makes the Check Reserved Routes request
     *
     * @param request the Check Reserved Routes request
     * @return the response from the Check Reserved Routes request
     */
    Mono checkReservedRoutes(CheckReservedRoutesRequest request);

    /**
     * Makes the Create a domain request
     *
     * @param request the Create a Domain request
     * @return the response from the Create a Domain request
     */
    Mono create(CreateDomainRequest request);

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

    /**
     * Makes Get Domain request
     *
     * @param request The Get Domain request
     * @return the response from the Get Domain request
     */
    Mono get(GetDomainRequest request);

    /**
     * Makes List all Domains request
     *
     * @param request the List all Domains request
     * @return the response from the List all Domains request
     */
    Mono list(ListDomainsRequest request);

    /**
     * Makes Share a Domain request
     *
     * @param request The Share a Domain request
     * @return the response from the Share a Domain request
     */
    Mono share(ShareDomainRequest request);

    /**
     * Makes Unshare a Domain request
     *
     * @param request The Unshare a Domain request
     * @return the response from the Unshare a Domain request
     */
    Mono unshare(UnshareDomainRequest request);

    /**
     * Makes the Create a domain request
     *
     * @param request the Update a Domain request
     * @return the response from the Update a Domain request
     */
    Mono update(UpdateDomainRequest request);
}