Skip to main content
Version: 8.9 (unreleased)

Type Alias: SearchClusterVariablesData

type SearchClusterVariablesData = object;

Defined in: gen/types.gen.ts:8759

Properties​

body?​

optional body: SearchQueryRequest & object;

Defined in: gen/types.gen.ts:8763

Cluster variable search query request.

Type Declaration​

filter?​
optional filter: object;

Cluster variable filter request.

filter.isTruncated?​
optional isTruncated: boolean;

Filter cluster variables by truncation status of their stored values. When true, returns only variables whose stored values are truncated (i.e., the value exceeds the storage size limit and is truncated in storage). When false, returns only variables with non-truncated stored values. This filter is based on the underlying storage characteristic, not the response format.

filter.name?​
optional name: StringFilterProperty;

Name of the cluster variable.

filter.scope?​
optional scope:
  | ClusterVariableScopeEnum
  | {
  $eq?: ClusterVariableScopeEnum;
  $exists?: boolean;
  $in?: ClusterVariableScopeEnum[];
  $like?: LikeFilter;
  $neq?: ClusterVariableScopeEnum;
};

ClusterVariableScopeEnum property with full advanced search capabilities.

Type Declaration​

ClusterVariableScopeEnum

{
  $eq?: ClusterVariableScopeEnum;
  $exists?: boolean;
  $in?: ClusterVariableScopeEnum[];
  $like?: LikeFilter;
  $neq?: ClusterVariableScopeEnum;
}
filter.tenantId?​
optional tenantId: StringFilterProperty;

Tenant ID of this variable.

filter.value?​
optional value: StringFilterProperty;

The value of the cluster variable.

sort?​
optional sort: ClusterVariableSearchQuerySortRequest[];

Sort field criteria.

path?​

optional path: never;

Defined in: gen/types.gen.ts:8813

query?​

optional query: object;

Defined in: gen/types.gen.ts:8814

truncateValues?​

optional truncateValues: boolean;

When true (default), long variable values in the response are truncated. When false, full variable values are returned.

url​

url: "/cluster-variables/search";

Defined in: gen/types.gen.ts:8820