Skip to content

Latest commit

 

History

History
204 lines (118 loc) · 5.11 KB

PoolApi.md

File metadata and controls

204 lines (118 loc) · 5.11 KB
Raw

\PoolApi

All URIs are relative to http://localhost

Method HTTP request Description
ConstraintList Get /1.3/constraints
ConstraintSet Put /1.3/constraints
PoolCreate Post /1.0/pools
PoolDelete Delete /pools/{pool}
PoolGet Get /pools/{pool}
PoolList Get /1.0/pools
PoolUpdate Put /pools/{pool}

ConstraintList

[]PoolConstraint ConstraintList(ctx, )

List pool constraints

Required Parameters

This endpoint does not need any parameter.

Return type

[]PoolConstraint

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ConstraintSet

ConstraintSet(ctx, poolConstraintSet)

Update a service instance

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
poolConstraintSet PoolConstraintSet

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PoolCreate

PoolCreate(ctx, poolCreateData)

Creates a pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
poolCreateData PoolCreateData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PoolDelete

PoolDelete(ctx, pool)

Deletes a pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pool string

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PoolGet

Pool PoolGet(ctx, pool)

Get pool information

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pool string

Return type

Pool

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PoolList

[]Pool PoolList(ctx, )

List pools.

Required Parameters

This endpoint does not need any parameter.

Return type

[]Pool

Authorization

Bearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

PoolUpdate

PoolUpdate(ctx, pool, poolUpdateData)

Updates a pool.

Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
pool string
poolUpdateData PoolUpdateData

Return type

(empty response body)

Authorization

Bearer

HTTP request headers

  • Content-Type: application/json
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]