Package com.azure.resourcemanager.orbital.models

Interface Spacecrafts

public interface Spacecrafts
Resource collection API of Spacecrafts.

  • Method Details

    • list

      com.azure.core.http.rest.PagedIterable<Spacecraft> list()
      Returns list of spacecrafts by subscription.
      Returns:
      response for the ListSpacecrafts API service call as paginated response with PagedIterable.
      Throws:
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • list

      com.azure.core.http.rest.PagedIterable<Spacecraft> list(String skiptoken, com.azure.core.util.Context context)
      Returns list of spacecrafts by subscription.
      Parameters:
      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.
      context - The context to associate with this operation.
      Returns:
      response for the ListSpacecrafts API service call as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Spacecraft> listByResourceGroup(String resourceGroupName)
      Returns list of spacecrafts by resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      Returns:
      response for the ListSpacecrafts API service call as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listByResourceGroup

      com.azure.core.http.rest.PagedIterable<Spacecraft> listByResourceGroup(String resourceGroupName, String skiptoken, com.azure.core.util.Context context)
      Returns list of spacecrafts by resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      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.
      context - The context to associate with this operation.
      Returns:
      response for the ListSpacecrafts API service call as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByResourceGroup

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

    • getByResourceGroupWithResponse

      com.azure.core.http.rest.Response<Spacecraft> getByResourceGroupWithResponse(String resourceGroupName, String spacecraftName, com.azure.core.util.Context context)
      Gets the specified spacecraft in a specified resource group.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      spacecraftName - Spacecraft ID.
      context - The context to associate with this operation.
      Returns:
      the specified spacecraft in a specified resource group along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteByResourceGroup

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

    • delete

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

    • listAvailableContacts

      com.azure.core.http.rest.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.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      spacecraftName - Spacecraft ID.
      parameters - The parameters to provide for the contacts.
      Returns:
      response for the ListAvailableContacts API service call as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • listAvailableContacts

      com.azure.core.http.rest.PagedIterable<AvailableContacts> listAvailableContacts(String resourceGroupName, String spacecraftName, ContactParameters parameters, com.azure.core.util.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.
      Parameters:
      resourceGroupName - The name of the resource group. The name is case insensitive.
      spacecraftName - Spacecraft ID.
      parameters - The parameters to provide for the contacts.
      context - The context to associate with this operation.
      Returns:
      response for the ListAvailableContacts API service call as paginated response with PagedIterable.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getById

      Spacecraft getById(String id)
      Gets the specified spacecraft in a specified resource group.
      Parameters:
      id - the resource ID.
      Returns:
      the specified spacecraft in a specified resource group along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • getByIdWithResponse

      com.azure.core.http.rest.Response<Spacecraft> getByIdWithResponse(String id, com.azure.core.util.Context context)
      Gets the specified spacecraft in a specified resource group.
      Parameters:
      id - the resource ID.
      context - The context to associate with this operation.
      Returns:
      the specified spacecraft in a specified resource group along with Response.
      Throws:
      IllegalArgumentException - thrown if parameters fail the validation.
      com.azure.core.management.exception.ManagementException - thrown if the request is rejected by server.
      RuntimeException - all other wrapped checked exceptions if the request fails to be sent.

    • deleteById

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

    • deleteByIdWithResponse

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

    • define

      Spacecraft.DefinitionStages.Blank define(String name)
      Begins definition for a new Spacecraft resource.
      Parameters:
      name - resource name.
      Returns:
      the first stage of the new Spacecraft definition.