SearchIpResourcesRequest

import type { SearchIpResourcesRequest } from "https://googleapis.deno.dev/v1/cloudnumberregistry:v1alpha.ts";

Message for searching IP resources

interface SearchIpResourcesRequest {

orderBy?: string;

pageSize?: number;

pageToken?: string;

query?: string;

searchResourceTypes?: "SEARCH_RESOURCE_TYPE_UNSPECIFIED" | "RANGES" | "REALMS"[];

showUtilization?: boolean;

}

§Properties

orderBy?: string

[src]

Optional. Hint for how to order the results

pageSize?: number

[src]

Optional. Requested page size. Server may return fewer items than requested. If unspecified, server will pick an appropriate default.

pageToken?: string

[src]

Optional. A token identifying a page of results the server should return.

query?: string

[src]

Optional. Search query. This string filters resources in an AIP-160-like format. It has some limitations. You can only specify top level conjunctions or attribute level negations. Each restriction can only be used once except the attribute restriction. The available restrictions for ranges are: - realm: The realm name to search in. - ip_address: The IP address to search for within ranges. - ip_version: The IP version to filter by (e.g., "IPV4", "IPV6"). - parent_range: The parent range of the range to search for. - attribute_text: The attribute text to search for within ranges. - attribute: The attribute key and value to filter by. The available restrictions for realms are: - ip_version: The IP version to search for. Only one of attribute_text or multiple attribute filters can be specified. Examples: - realm=test-realm - realm=test-realm AND ip_address=10.0.0.0 - realm=test-realm AND ip_version=IPV6 - realm=test-realm AND attribute_text=test - ip_address=10.0.0.0 AND attribute:(key1=value1) AND attribute:(key2=value2) - attribute_text=test AND parent_range=projects/123/locations/global/discoveredRanges/test-parent-range

searchResourceTypes?: "SEARCH_RESOURCE_TYPE_UNSPECIFIED" | "RANGES" | "REALMS"[]

[src]

Optional. The type of resources to search for. If not specified, the server will return ranges.

showUtilization?: boolean

[src]

Optional. Whether to show the utilization of the ranges in the response.