Tgstation.Server.Client.InstanceManagerClient Class Reference

More...

Inheritance diagram for Tgstation.Server.Client.InstanceManagerClient:

Collaboration diagram for Tgstation.Server.Client.InstanceManagerClient:

Public Member Functions
	InstanceManagerClient (IApiClient apiClient)
	Initializes a new instance of the InstanceManagerClient class.
ValueTask< InstanceResponse >	CreateOrAttach (InstanceCreateRequest instance, CancellationToken cancellationToken)
	Create or attach an instance . Parameters instance The InstanceCreateRequest. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in the created or attached Instance.
ValueTask	Detach (EntityId instance, CancellationToken cancellationToken)
	Deletes an instance . Parameters instance The EntityId of the Instance to delete. cancellationToken The CancellationToken for the operation. Returns A ValueTask representing the running operation.
ValueTask< List< InstanceResponse > >	List (PaginationSettings? paginationSettings, CancellationToken cancellationToken)
	Get all IInstanceClients for Instances the user can view. Parameters paginationSettings The optional PaginationSettings for the operation. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in a List<T> of all Instances the user can view.
ValueTask< InstanceResponse >	Update (InstanceUpdateRequest instance, CancellationToken cancellationToken)
	Relocates, renamed, and/or on/offlines an instance . Parameters instance The InstanceUpdateRequest. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in the updated Instance.
ValueTask< InstanceResponse >	GetId (EntityId instance, CancellationToken cancellationToken)
	Get a specific instance . Parameters instance The Instance to get. cancellationToken The CancellationToken for the operation. Returns A ValueTask<TResult> resulting in the Instance.
ValueTask	GrantPermissions (EntityId instance, CancellationToken cancellationToken)
	Gives the user full permissions on an instance . Parameters instance The EntityId of the Instance to grant permissions on. cancellationToken The CancellationToken for the operation. Returns A ValueTask representing the running operation.
IInstanceClient	CreateClient (Instance instance)
	Create an IInstanceClient for a given Instance. Parameters instance The EntityId of the Instance to create an IInstanceClient for. Returns A new IInstanceClient.
Public Member Functions inherited from Tgstation.Server.Client.PaginatedClient
	PaginatedClient (IApiClient apiClient)
	Initializes a new instance of the PaginatedClient class.

Private Member Functions
ValueTask< InstanceResponse >	InstanceResponse (Routes.InstanceManager, instance ?? throw new ArgumentNullException(nameof(instance)), cancellationToken)
ValueTask< InstanceResponse >	InstanceResponse (Routes.InstanceManager, instance ?? throw new ArgumentNullException(nameof(instance)), cancellationToken)

Additional Inherited Members
Protected Member Functions inherited from Tgstation.Server.Client.PaginatedClient
async ValueTask< List< TModel > >	ReadPaged< TModel > (PaginationSettings? paginationSettings, string route, long? instanceId, CancellationToken cancellationToken)
	Reads a given route with paged results.
Properties inherited from Tgstation.Server.Client.PaginatedClient
IApiClient	ApiClient [get]
	The IApiClient for the PaginatedClient.

Detailed Description

Definition at line 15 of file InstanceManagerClient.cs.

Constructor & Destructor Documentation

InstanceManagerClient()

Tgstation.Server.Client.InstanceManagerClient.InstanceManagerClient

(

IApiClient

apiClient

)

Initializes a new instance of the InstanceManagerClient class.

Parameters

apiClient

The IApiClient for the PaginatedClient.

Definition at line 21 of file InstanceManagerClient.cs.

            : base(apiClient)
        {
        }

Member Function Documentation

CreateClient()

IInstanceClient Tgstation.Server.Client.InstanceManagerClient.CreateClient

(

Instance

instance

)

Create an IInstanceClient for a given Instance.

Parameters

instance

The EntityId of the Instance to create an IInstanceClient for.

Returns

A new IInstanceClient.

Implements Tgstation.Server.Client.IInstanceManagerClient.

Definition at line 46 of file InstanceManagerClient.cs.

        {
            if (instance == null)
                throw new ArgumentNullException(nameof(instance));
 
            if (!instance.Id.HasValue)
                throw new ArgumentException("Instance missing Id!", nameof(instance));
 
            return new InstanceClient(
                ApiClient,
                instance);
        }

References Tgstation.Server.Api.Models.EntityId.Id, and Tgstation.Server.Client.InstanceManagerClient.List().

Here is the call graph for this function:

CreateOrAttach()

ValueTask< InstanceResponse > Tgstation.Server.Client.InstanceManagerClient.CreateOrAttach	(	InstanceCreateRequest	instance,
		CancellationToken	cancellationToken
	)

Create or attach an instance .

Parameters

instance	The InstanceCreateRequest.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the created or attached Instance.

Implements Tgstation.Server.Client.IInstanceManagerClient.

Detach()

ValueTask Tgstation.Server.Client.InstanceManagerClient.Detach	(	EntityId	instance,
		CancellationToken	cancellationToken
	)

Deletes an instance .

Parameters

instance	The EntityId of the Instance to delete.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask representing the running operation.

Implements Tgstation.Server.Client.IInstanceManagerClient.

GetId()

ValueTask< InstanceResponse > Tgstation.Server.Client.InstanceManagerClient.GetId	(	EntityId	instance,
		CancellationToken	cancellationToken
	)

Get a specific instance .

Parameters

instance	The Instance to get.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the Instance.

Implements Tgstation.Server.Client.IInstanceManagerClient.

GrantPermissions()

ValueTask Tgstation.Server.Client.InstanceManagerClient.GrantPermissions	(	EntityId	instance,
		CancellationToken	cancellationToken
	)

Gives the user full permissions on an instance .

Parameters

instance	The EntityId of the Instance to grant permissions on.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask representing the running operation.

Implements Tgstation.Server.Client.IInstanceManagerClient.

InstanceResponse() [1/2]

ValueTask< InstanceResponse > Tgstation.Server.Client.InstanceManagerClient.InstanceResponse ( Routes.  InstanceManager, instance ?? throw new   ArgumentNullExceptionnameof(instance), cancellationToken    )

private

InstanceResponse() [2/2]

ValueTask< InstanceResponse > Tgstation.Server.Client.InstanceManagerClient.InstanceResponse ( Routes.  InstanceManager, instance ?? throw new   ArgumentNullExceptionnameof(instance), cancellationToken    )

private

List()

ValueTask< List< InstanceResponse > > Tgstation.Server.Client.InstanceManagerClient.List	(	PaginationSettings?	paginationSettings,
		CancellationToken	cancellationToken
	)

Get all IInstanceClients for Instances the user can view.

Parameters

paginationSettings	The optional PaginationSettings for the operation.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in a List<T> of all Instances the user can view.

Implements Tgstation.Server.Client.IInstanceManagerClient.

Referenced by Tgstation.Server.Client.InstanceManagerClient.CreateClient().

Here is the caller graph for this function:

Update()

ValueTask< InstanceResponse > Tgstation.Server.Client.InstanceManagerClient.Update	(	InstanceUpdateRequest	instance,
		CancellationToken	cancellationToken
	)

Relocates, renamed, and/or on/offlines an instance .

Parameters

instance	The InstanceUpdateRequest.
cancellationToken	The CancellationToken for the operation.

Returns

A ValueTask<TResult> resulting in the updated Instance.

Implements Tgstation.Server.Client.IInstanceManagerClient.

---

The documentation for this class was generated from the following file:

• src/Tgstation.Server.Client/InstanceManagerClient.cs