\PoolsAPI

All URIs are relative to /candlepin

Method	HTTP request	Description
DeletePool	Delete /pools/{pool_id}
GetPool	Get /pools/{pool_id}
GetPoolCdn	Get /pools/{pool_id}/cdn
GetPoolEntitlements	Get /pools/{pool_id}/entitlements
GetSubCert	Get /pools/{pool_id}/cert
ListEntitledConsumerUuids	Get /pools/{pool_id}/entitlements/consumer_uuids
ListPools	Get /pools

DeletePool

DeletePool(ctx, poolId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	poolId := "poolId_example" // string | Pool ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	r, err := apiClient.PoolsAPI.DeletePool(context.Background(), poolId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PoolsAPI.DeletePool``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
}

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiDeletePoolRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

(empty response body)

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetPool

PoolDTO GetPool(ctx, poolId).Consumer(consumer).Activeon(activeon).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	poolId := "poolId_example" // string | Pool ID
	consumer := "consumer_example" // string | Consumer UUID (optional)
	activeon := "activeon_example" // string | Uses ISO 8601 format (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PoolsAPI.GetPool(context.Background(), poolId).Consumer(consumer).Activeon(activeon).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PoolsAPI.GetPool``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetPool`: PoolDTO
	fmt.Fprintf(os.Stdout, "Response from `PoolsAPI.GetPool`: %v\n", resp)
}

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiGetPoolRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

PoolDTO

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetPoolCdn

CdnDTO GetPoolCdn(ctx, poolId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	poolId := "poolId_example" // string | Pool ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PoolsAPI.GetPoolCdn(context.Background(), poolId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PoolsAPI.GetPoolCdn``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetPoolCdn`: CdnDTO
	fmt.Fprintf(os.Stdout, "Response from `PoolsAPI.GetPoolCdn`: %v\n", resp)
}

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiGetPoolCdnRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

CdnDTO

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetPoolEntitlements

[]EntitlementDTO GetPoolEntitlements(ctx, poolId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	poolId := "poolId_example" // string | Pool ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PoolsAPI.GetPoolEntitlements(context.Background(), poolId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PoolsAPI.GetPoolEntitlements``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetPoolEntitlements`: []EntitlementDTO
	fmt.Fprintf(os.Stdout, "Response from `PoolsAPI.GetPoolEntitlements`: %v\n", resp)
}

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiGetPoolEntitlementsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]EntitlementDTO

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

GetSubCert

map[string]interface{} GetSubCert(ctx, poolId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	poolId := "poolId_example" // string | Pool ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PoolsAPI.GetSubCert(context.Background(), poolId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PoolsAPI.GetSubCert``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `GetSubCert`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `PoolsAPI.GetSubCert`: %v\n", resp)
}

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiGetSubCertRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

map[string]interface{}

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: text/plain, application/json

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

ListEntitledConsumerUuids

[]string ListEntitledConsumerUuids(ctx, poolId).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	poolId := "poolId_example" // string | Pool ID

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PoolsAPI.ListEntitledConsumerUuids(context.Background(), poolId).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PoolsAPI.ListEntitledConsumerUuids``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListEntitledConsumerUuids`: []string
	fmt.Fprintf(os.Stdout, "Response from `PoolsAPI.ListEntitledConsumerUuids`: %v\n", resp)
}

Path Parameters

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

Other Parameters

Other parameters are passed through a pointer to a apiListEntitledConsumerUuidsRequest struct via the builder pattern

Name	Type	Description	Notes

Return type

[]string

Authorization

basicAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

ListPools

[]PoolDTO ListPools(ctx).Owner(owner).Consumer(consumer).Product(product).Listall(listall).Activeon(activeon).Page(page).PerPage(perPage).Order(order).SortBy(sortBy).Execute()

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/content-services/caliri/release/v4"
)

func main() {
	owner := "owner_example" // string | Owner ID (optional)
	consumer := "consumer_example" // string | Consumer UUID (optional)
	product := "product_example" // string | Product ID (optional)
	listall := true // bool | Use with consumerUuid to list all pools available to the consumer. This will include pools which would otherwise be omitted due to a rules warning. (i.e. not recommended) Pools that trigger an error however will still be omitted. (no entitlements available, consumer type mismatch, etc)  (optional) (default to false)
	activeon := "activeon_example" // string | Uses ISO 8601 format (optional)
	page := int32(2) // int32 | Page index to return (optional)
	perPage := int32(10) // int32 | Number of items to return per page (optional)
	order := "asc" // string | Direction of ordering (optional)
	sortBy := "name" // string | Property to use for ordering (optional)

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.PoolsAPI.ListPools(context.Background()).Owner(owner).Consumer(consumer).Product(product).Listall(listall).Activeon(activeon).Page(page).PerPage(perPage).Order(order).SortBy(sortBy).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `PoolsAPI.ListPools``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListPools`: []PoolDTO
	fmt.Fprintf(os.Stdout, "Response from `PoolsAPI.ListPools`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiListPoolsRequest struct via the builder pattern

Name	Type	Description	Notes
owner	string	Owner ID
consumer	string	Consumer UUID
product	string	Product ID
listall	bool	Use with consumerUuid to list all pools available to the consumer. This will include pools which would otherwise be omitted due to a rules warning. (i.e. not recommended) Pools that trigger an error however will still be omitted. (no entitlements available, consumer type mismatch, etc)	[default to false]
activeon	string	Uses ISO 8601 format
page	int32	Page index to return
perPage	int32	Number of items to return per page
order	string	Direction of ordering
sortBy	string	Property to use for ordering

Return type

[]PoolDTO

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

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

Files

PoolsAPI.md

Latest commit

History

PoolsAPI.md

File metadata and controls

\PoolsAPI

DeletePool

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetPool

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetPoolCdn

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetPoolEntitlements

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

GetSubCert

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListEntitledConsumerUuids

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers

ListPools

Example

Path Parameters

Other Parameters

Return type

Authorization

HTTP request headers