library/com.gabrielfeo.gradle.enterprise.api/TestDistributionApi

TestDistributionApi

Functions

@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:

createTestDistributionAgentPool

@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:

deleteTestDistributionAgentPool

@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:

generateTestDistributionApiKey

@POST(value = "api/test-distribution/api-keys")

abstract suspend fun generateTestDistributionApiKey(@Body testDistributionApiKeyDescription: TestDistributionApiKeyDescription? = null): TestDistributionApiKey

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

getTestDistributionAgentPool

@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:

getTestDistributionAgentPoolStatus

@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:

getTestDistributionApiKey

@GET(value = "api/test-distribution/api-keys/{keyPrefix}")

abstract suspend fun getTestDistributionApiKey(@Path(value = "keyPrefix") keyPrefix: String): TestDistributionApiKeyPrefix

Get a Test Distribution API keyPrefix information. Returns information about a Test Distribution API keyPrefix. Responses:

insertTestDistributionApiKey

@PUT(value = "api/test-distribution/api-keys/{keyPrefix}")

abstract suspend fun insertTestDistributionApiKey(@Path(value = "keyPrefix") keyPrefix: String, @Body testDistributionApiKey: TestDistributionApiKey): TestDistributionApiKeyPrefix

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

listTestDistributionAgentPools

@GET(value = "api/test-distribution/agent-pools")

abstract suspend fun listTestDistributionAgentPools(): TestDistributionAgentPoolPage

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

listTestDistributionApiKeys

@GET(value = "api/test-distribution/api-keys")

abstract suspend fun listTestDistributionApiKeys(): TestDistributionApiKeyPrefixPage

Lists Test Distribution API keys. Returns a list of all Test Distribution API key prefixes. Responses:

revokeTestDistributionApiKey

@DELETE(value = "api/test-distribution/api-keys/{keyPrefix}")

abstract suspend fun revokeTestDistributionApiKey(@Path(value = "keyPrefix") keyPrefix: String)

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