Skip to main content
GET
ListSqlTestDeploymentRules

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sources
enum<string>[]
Available options:
SOURCE_APP,
SOURCE_API
configsFilter.ids
string[]
ruleIds
string[]
ruleTypes
enum<string>[]

Filter by rule type. When empty, rules of every type are returned. When set, only rules whose type is listed are returned. The filter is applied server-side before paging, so every page reflects only the selected types.

SqlTestDeploymentRuleType identifies which kind of selection a deployment rule uses. The value corresponds to the populated config oneof arm on SqlTestDeploymentRule / SqlTestDeploymentRuleView. Use it with ListSqlTestDeploymentRulesRequest.rule_types to return only rules of selected kinds.

Available options:
SQL_TEST_DEPLOYMENT_RULE_TYPE_UNSPECIFIED,
SQL_TEST_DEPLOYMENT_RULE_TYPE_QUERY,
SQL_TEST_DEPLOYMENT_RULE_TYPE_EXCLUSIVE_QUERY,
SQL_TEST_DEPLOYMENT_RULE_TYPE_STATIC,
SQL_TEST_DEPLOYMENT_RULE_TYPE_EXCLUSIVE_STATIC
pagination.cursor
string

Opaque cursor token for the next page of results. If not provided, returns the first page. This is an encoded token that should be passed as-is from the previous PageInfo.last_id.

pagination.pageSize
integer<int32>

Maximum number of items to return in a single page. If not provided, defaults vary per API.

Required range: x >= 0

Response

200 - application/json

Success

pageInfo
PageInfo · object
required

Paging information for this response. Always populated. This response carries at most one bounded page of rules, never the full set. The cursor is the paging contract: to retrieve every rule, repeat the request passing page_info.last_id as pagination.cursor until last_id comes back empty.

deploymentRules
SqlTestDeploymentRuleView · object[]

SqlTestDeploymentRuleView is a SqlTestDeploymentRule together with a summary of how many tests it currently has deployed.