library/com.gabrielfeo.develocity.api/TestDistributionApi

TestDistributionApi

@JvmSuppressWildcards
interface TestDistributionApi

Functions

Link copied to clipboard
@PUT(value = "api/test-distribution/agent-pools/{poolId}")
abstract suspend fun createOrUpdateTestDistributionAgentPool(@Path(value = "poolId") poolId: String, @Body testDistributionAgentPoolConfiguration: TestDistributionAgentPoolConfiguration): TestDistributionAgentPoolConfigurationWithId

Create or update an Agent Pool. Create a new Agent Pool in Develocity or update the configuration of an existing one. The orderIndex element is optional and can be used to specify the priority order in which the Agent Pool is considered. When not specified, the Agent Pool will be either added last on creation, or will not change position on update. When specified, the Agent Pool will be added at/moved to the specified index and all other Agent Pools will be moved down. If the specified index is out of bounds, the Agent Pool will be added last with the orderIndex adjusted accordingly. Responses:

Link copied to clipboard
@POST(value = "api/test-distribution/agent-pools")
abstract suspend fun createTestDistributionAgentPool(@Body testDistributionAgentPoolConfiguration: TestDistributionAgentPoolConfiguration): TestDistributionAgentPoolConfigurationWithId

Create an Agent Pool. Create a new Agent Pool in Develocity. The orderIndex element is optional and can be used to specify the priority order in which the Agent Pool is considered. When not specified, the Agent Pool will be added last. When specified, the Agent Pool will be added at the specified index and all other Agent Pools will be moved down. If the specified index is out of bounds, the Agent Pool will be added last with the orderIndex adjusted accordingly. Responses:

Link copied to clipboard
@DELETE(value = "api/test-distribution/agent-pools/{poolId}")
abstract suspend fun deleteTestDistributionAgentPool(@Path(value = "poolId") poolId: String)

Delete an Agent Pool. Delete an existing Agent Pool. Responses:

@POST(value = "api/test-distribution/agent-pools/{poolId}/registration-keys")
abstract suspend fun generateTestDistributionAgentPoolRegistrationKey(@Path(value = "poolId") poolId: String, @Body testDistributionAgentPoolRegistrationKeyDescription: TestDistributionAgentPoolRegistrationKeyDescription? = null): TestDistributionAgentPoolRegistrationKey

Generate a new Test Distribution pool-specific agent registration key. Generate a new Test Distribution pool-specific agent registration key to connect agents and query the agent pool API. Responses:

Link copied to clipboard
@GET(value = "api/test-distribution/agent-pools/{poolId}")
abstract suspend fun getTestDistributionAgentPool(@Path(value = "poolId") poolId: String): TestDistributionAgentPoolConfigurationWithId

View the properties of an Agent Pool View the identifier, capabilities and size of an Agent Pool. Responses:

@GET(value = "api/test-distribution/agent-pools/{poolId}/registration-keys/{keyPrefix}")
abstract suspend fun getTestDistributionAgentPoolRegistrationKey(@Path(value = "poolId") poolId: String, @Path(value = "keyPrefix") keyPrefix: String): TestDistributionAgentPoolRegistrationKeyPrefix

Get a Test Distribution pool-specific agent registration keyPrefix information. Returns information about a Test Distribution pool-specific agent registration keyPrefix. Responses:

Link copied to clipboard
@GET(value = "api/test-distribution/agent-pools/{poolId}/status")
abstract suspend fun getTestDistributionAgentPoolStatus(@Path(value = "poolId") poolId: String): TestDistributionAgentPoolStatus

View the status of an Agent Pool View the status of an Agent Pool, such as its current size. To access this endpoint the user requires the `Test Distribution` permission. Responses:

@PUT(value = "api/test-distribution/agent-pools/{poolId}/registration-keys/{keyPrefix}")
abstract suspend fun insertTestDistributionAgentPoolRegistrationKey(@Path(value = "poolId") poolId: String, @Path(value = "keyPrefix") keyPrefix: String, @Body testDistributionAgentPoolRegistrationKey: TestDistributionAgentPoolRegistrationKey): TestDistributionAgentPoolRegistrationKeyPrefix

Insert a specific Test Distribution pool-specific agent registration key. Inserts a specific Test Distribution pool-specific agent registration key to connect agents and query the agent pool API. If a key with the same prefix but different key already exists (regardless of which pool it belongs to), it will return 400. Responses:

@GET(value = "api/test-distribution/agent-pools/{poolId}/registration-keys")
abstract suspend fun listTestDistributionAgentPoolRegistrationKeys(@Path(value = "poolId") poolId: String): TestDistributionAgentPoolRegistrationKeyPrefixPage

Lists Test Distribution pool-specific agent registration keys. Returns a list of all Test Distribution pool-specific agent registration key prefixes. Responses:

Link copied to clipboard
@GET(value = "api/test-distribution/agent-pools")
abstract suspend fun listTestDistributionAgentPools(): TestDistributionAgentPoolPage

Lists Agent Pools. Returns a list of all Agent Pools. Responses:

@DELETE(value = "api/test-distribution/agent-pools/{poolId}/registration-keys/{keyPrefix}")
abstract suspend fun revokeTestDistributionAgentPoolRegistrationKey(@Path(value = "poolId") poolId: String, @Path(value = "keyPrefix") keyPrefix: String)

Revoke a Test Distribution pool-specific agent registration key. Revoke the Test Distribution pool-specific agent registration key for the given prefix which uniquely identifies a Test Distribution pool-specific agent registration key. A revoked key can no longer be used to connect agents, but it will still be queryable and returned in the list. Responses: