Spacecrafts Interface

Package:

com.azure.resourcemanager.orbital.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-orbital:1.0.0-beta.3

public interface Spacecrafts

Resource collection API of Spacecrafts.

Method Summary

Modifier and Type	Method and Description
abstract Blank	define(String name) Begins definition for a new Spacecraft resource.
abstract void	delete(String resourceGroupName, String spacecraftName, Context context) Deletes a specified spacecraft resource.
abstract void	deleteById(String id) Deletes a specified spacecraft resource.
abstract void	deleteByIdWithResponse(String id, Context context) Deletes a specified spacecraft resource.
abstract void	deleteByResourceGroup(String resourceGroupName, String spacecraftName) Deletes a specified spacecraft resource.
abstract Spacecraft	getById(String id) Gets the specified spacecraft in a specified resource group.
abstract Response<Spacecraft>	getByIdWithResponse(String id, Context context) Gets the specified spacecraft in a specified resource group.
abstract Spacecraft	getByResourceGroup(String resourceGroupName, String spacecraftName) Gets the specified spacecraft in a specified resource group.
abstract Response<Spacecraft>	getByResourceGroupWithResponse(String resourceGroupName, String spacecraftName, Context context) Gets the specified spacecraft in a specified resource group.
abstract PagedIterable<Spacecraft>	list() Returns list of spacecrafts by subscription.
abstract PagedIterable<Spacecraft>	list(String skiptoken, Context context) Returns list of spacecrafts by subscription.
abstract PagedIterable<AvailableContacts>	listAvailableContacts(String resourceGroupName, String spacecraftName, ContactParameters parameters) Returns list of available contacts.
abstract PagedIterable<AvailableContacts>	listAvailableContacts(String resourceGroupName, String spacecraftName, ContactParameters parameters, Context context) Returns list of available contacts.
abstract PagedIterable<Spacecraft>	listByResourceGroup(String resourceGroupName) Returns list of spacecrafts by resource group.
abstract PagedIterable<Spacecraft>	listByResourceGroup(String resourceGroupName, String skiptoken, Context context) Returns list of spacecrafts by resource group.

Method Details

define

public abstract 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.

delete

public abstract void delete(String resourceGroupName, String spacecraftName, 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.

deleteById

public abstract void deleteById(String id)

Deletes a specified spacecraft resource.

Parameters:

id - the resource ID.

deleteByIdWithResponse

public abstract void deleteByIdWithResponse(String id, Context context)

Deletes a specified spacecraft resource.

Parameters:

id - the resource ID.

context - The context to associate with this operation.

deleteByResourceGroup

public abstract 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.

getById

public abstract 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<T>.

getByIdWithResponse

public abstract Response<Spacecraft> getByIdWithResponse(String id, 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<T>.

getByResourceGroup

public abstract 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.

getByResourceGroupWithResponse

public abstract Response<Spacecraft> getByResourceGroupWithResponse(String resourceGroupName, String spacecraftName, 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<T>.

list

public abstract PagedIterable<Spacecraft> list()

Returns list of spacecrafts by subscription.

Returns:

response for the ListSpacecrafts API service call as paginated response with PagedIterable<T>.

list

public abstract PagedIterable<Spacecraft> list(String skiptoken, 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<T>.

listAvailableContacts

public abstract 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<T>.

listAvailableContacts

public abstract PagedIterable<AvailableContacts> listAvailableContacts(String resourceGroupName, String spacecraftName, ContactParameters parameters, 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<T>.

listByResourceGroup

public abstract 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<T>.

listByResourceGroup

public abstract PagedIterable<Spacecraft> listByResourceGroup(String resourceGroupName, String skiptoken, 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<T>.