SubspaceProductAPI.Api.AcceleratorService (subspace_openapi_client v1.0.3)
API calls for all endpoints tagged AcceleratorService
.
Link to this section Summary
Functions
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- body (Body): Required parameters to create a new PacketAccelerator. NOTE- only subspace_port is optional
- opts (KeywordList): [optional] Optional parameters
- :idempotency_key (String.t): Value is the returned etag of a get request. If a retry sends an Idempotency-Key that has been seen before, the existing accelerator is returned with the status code of 200
Returns
- :idempotency_key (String.t): Value is the returned etag of a get request. If a retry sends an Idempotency-Key that has been seen before, the existing accelerator is returned with the status code of 200
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
- :before (String.t):
- :limit (integer()):
Returns
on success {:error, Tesla.Env.t} on failure
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- id (String.t):
- body1 (Body1): Parameters to update an existing PacketAccelerator, minimum requirement of one of them defined to update
- opts (KeywordList): [optional] Optional parameters
- :if_match (integer()):
Returns
- :if_match (integer()):
on success {:error, Tesla.Env.t} on failure
Link to this section Functions
Link to this function
accelerator_service_create(connection, body, opts \\ [])
Specs
accelerator_service_create( Tesla.Env.client(), SubspaceProductAPI.Model.Body.t(), keyword() ) :: {:ok, SubspaceProductAPI.Model.V1Accelerator.t()} | {:ok, Map.t()} | {:ok, String.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- body (Body): Required parameters to create a new PacketAccelerator. NOTE- only subspace_port is optional
- opts (KeywordList): [optional] Optional parameters
on success {:error, Tesla.Env.t} on failure
Link to this function
accelerator_service_delete(connection, id, opts \\ [])
Specs
accelerator_service_delete(Tesla.Env.client(), String.t(), keyword()) :: {:ok, Map.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
accelerator_service_get(connection, id, opts \\ [])
Specs
accelerator_service_get(Tesla.Env.client(), String.t(), keyword()) :: {:ok, SubspaceProductAPI.Model.V1Accelerator.t()} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- id (String.t):
- opts (KeywordList): [optional] Optional parameters
Returns
on success {:error, Tesla.Env.t} on failure
Link to this function
accelerator_service_list(connection, opts \\ [])
Specs
accelerator_service_list(Tesla.Env.client(), keyword()) :: {:ok, SubspaceProductAPI.Model.V1ListAcceleratorResponse.t()} | {:ok, Map.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- opts (KeywordList): [optional] Optional parameters
on success {:error, Tesla.Env.t} on failure
Link to this function
accelerator_service_update(connection, id, body1, opts \\ [])
Specs
accelerator_service_update( Tesla.Env.client(), String.t(), SubspaceProductAPI.Model.Body1.t(), keyword() ) :: {:ok, SubspaceProductAPI.Model.V1Accelerator.t()} | {:ok, Map.t()} | {:ok, String.t()} | {:error, Tesla.Env.t()}
Parameters
- connection (SubspaceProductAPI.Connection): Connection to server
- id (String.t):
- body1 (Body1): Parameters to update an existing PacketAccelerator, minimum requirement of one of them defined to update
- opts (KeywordList): [optional] Optional parameters
on success {:error, Tesla.Env.t} on failure