// Copyright (c) Microsoft Corporation. All rights reserved.
// Licensed under the MIT License.
// Code generated by Microsoft (R) AutoRest Code Generator.

package com.azure.resourcemanager.orbital.models;

import com.azure.core.http.rest.PagedIterable;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;

/** Resource collection API of Spacecrafts. */
public interface Spacecrafts {
    /**
     * Returns list of spacecrafts by subscription.
     *
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return response for the ListSpacecrafts API service call as paginated response with {@link PagedIterable}.
     */
    PagedIterable<Spacecraft> list();

    /**
     * Returns list of spacecrafts by subscription.
     *
     * @param skiptoken An opaque string that the resource provider uses to skip over previously-returned results. This
     *     is used when a previous list operation call returned a partial result. If a previous response contains a
     *     nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a
     *     starting point to use for subsequent calls.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return response for the ListSpacecrafts API service call as paginated response with {@link PagedIterable}.
     */
    PagedIterable<Spacecraft> list(String skiptoken, Context context);

    /**
     * Returns list of spacecrafts by resource group.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return response for the ListSpacecrafts API service call as paginated response with {@link PagedIterable}.
     */
    PagedIterable<Spacecraft> listByResourceGroup(String resourceGroupName);

    /**
     * Returns list of spacecrafts by resource group.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param skiptoken An opaque string that the resource provider uses to skip over previously-returned results. This
     *     is used when a previous list operation call returned a partial result. If a previous response contains a
     *     nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a
     *     starting point to use for subsequent calls.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return response for the ListSpacecrafts API service call as paginated response with {@link PagedIterable}.
     */
    PagedIterable<Spacecraft> listByResourceGroup(String resourceGroupName, String skiptoken, Context context);

    /**
     * Gets the specified spacecraft in a specified resource group.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param spacecraftName Spacecraft ID.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the specified spacecraft in a specified resource group along with {@link Response}.
     */
    Response<Spacecraft> getByResourceGroupWithResponse(
        String resourceGroupName, String spacecraftName, Context context);

    /**
     * Gets the specified spacecraft in a specified resource group.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param spacecraftName Spacecraft ID.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the specified spacecraft in a specified resource group.
     */
    Spacecraft getByResourceGroup(String resourceGroupName, String spacecraftName);

    /**
     * Deletes a specified spacecraft resource.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param spacecraftName Spacecraft ID.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void deleteByResourceGroup(String resourceGroupName, String spacecraftName);

    /**
     * Deletes a specified spacecraft resource.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param spacecraftName Spacecraft ID.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void delete(String resourceGroupName, String spacecraftName, Context context);

    /**
     * Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station
     * for more than the minimum viable contact duration provided in the contact profile.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param spacecraftName Spacecraft ID.
     * @param parameters The parameters to provide for the contacts.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return response for the ListAvailableContacts API service call as paginated response with {@link PagedIterable}.
     */
    PagedIterable<AvailableContacts> listAvailableContacts(
        String resourceGroupName, String spacecraftName, ContactParameters parameters);

    /**
     * Returns list of available contacts. A contact is available if the spacecraft is visible from the ground station
     * for more than the minimum viable contact duration provided in the contact profile.
     *
     * @param resourceGroupName The name of the resource group. The name is case insensitive.
     * @param spacecraftName Spacecraft ID.
     * @param parameters The parameters to provide for the contacts.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return response for the ListAvailableContacts API service call as paginated response with {@link PagedIterable}.
     */
    PagedIterable<AvailableContacts> listAvailableContacts(
        String resourceGroupName, String spacecraftName, ContactParameters parameters, Context context);

    /**
     * Gets the specified spacecraft in a specified resource group.
     *
     * @param id the resource ID.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the specified spacecraft in a specified resource group along with {@link Response}.
     */
    Spacecraft getById(String id);

    /**
     * Gets the specified spacecraft in a specified resource group.
     *
     * @param id the resource ID.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     * @return the specified spacecraft in a specified resource group along with {@link Response}.
     */
    Response<Spacecraft> getByIdWithResponse(String id, Context context);

    /**
     * Deletes a specified spacecraft resource.
     *
     * @param id the resource ID.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void deleteById(String id);

    /**
     * Deletes a specified spacecraft resource.
     *
     * @param id the resource ID.
     * @param context The context to associate with this operation.
     * @throws IllegalArgumentException thrown if parameters fail the validation.
     * @throws com.azure.core.management.exception.ManagementException thrown if the request is rejected by server.
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent.
     */
    void deleteByIdWithResponse(String id, Context context);

    /**
     * Begins definition for a new Spacecraft resource.
     *
     * @param name resource name.
     * @return the first stage of the new Spacecraft definition.
     */
    Spacecraft.DefinitionStages.Blank define(String name);
}
