Skip to content
qibdo qibdo
v1
API version
  • v1
Theme
Book a demo

List Filter Schemas

GET
/network/v1/schemas/filter
curl --request GET \
--url https://example.com/network/v1/schemas/filter

Returns the query surface of every Network resource.

page_size
integer format: int32

The maximum number of filter schemas to return. The service may return fewer than this value. If unspecified, at most 20 filter schemas will be returned. The maximum value is 100; values above 100 will be coerced to 100.

page_token
string

A page token, received from a previous ListFilterSchemas call. Provide this to retrieve the subsequent page. When paginating, all other parameters must match the call that provided the page token.

filter
string

AIP-160 filter expression. Partial matches (:, a quoted wildcard, contains/startsWith/endsWith) ignore capitalisation; = and the relational operators are exact. Filterable fields: resource, version.

order_by
string

AIP-132 order_by expression. Sortable fields: resource, version.

skip
string

AIP-158 offset mode: number of resources to skip from the start of the filtered, sorted set. Use EITHER skip (offset paging) OR page_token (cursor paging) — never both in the same request. Supplying both is an invalid request. Default 0 (no skip).

OK

Media type application/json

ListNetworkFilterSchemasResponse

Response message for ListFilterSchemas.

object
filter_schemas

Filter Schemas

The query surface of every resource, ordered by resource token.

Array<object>

NetworkResourceFilterSchema

The complete query surface of one resource — every field its List operation accepts in filter and order_by.

object
resource

Resource

The resource token this schema describes, as used in the request path.

stringOutput only
version

Version

The contract version this schema belongs to (for example v1). It names the version of the API contract, not of the schema’s content: it does not change when a field is added, and it must not be used to detect that a schema changed — read the schema again instead.

stringOutput only
fields

Fields

Every filterable field of the resource, ordered by name.

Array<object>Output only

NetworkFilterFieldSchema

One field of a resource’s query surface: the token a caller may use in a filter expression, its value type, whether it may also be used in order_by, and the comparison operators it accepts.

object
name

Name

The field token as it appears in a filter or order_by expression (for example status or cpu.topology.threads_per_core).

stringOutput only
value_type

Value Type

The type a literal compared against this field must have. One of string, integer, long, double, decimal, boolean, uuid, timestamp.

stringOutput only
sortable

Sortable

Whether this field may appear in an order_by expression. When sort_depends_on_filter is non-empty the sort is accepted only if the request’s filter pins each named field to a single value.

booleanOutput only
repeated_field

Repeated Field

Whether the field holds a list of values. A repeated field is matched with the containment operator and is never sortable.

booleanOutput only
operators

Operators

The comparison operators accepted for this field. Presence (field:*) is accepted for every field and is not listed here.

Array<string>Output only
sort_depends_on_filter

Sort Depends On Filter

Field names whose values the request’s filter must each pin to a single value before this field may be used in order_by. Empty for an unconditional sort.

Array<string>Output only
valid_values

Valid Values

The closed set of values this field accepts, when it has one. Empty means any value of value_type is accepted — never that the vocabulary is unknown. A value outside this set is rejected with INVALID_ARGUMENT.

Array<string>Output only
next_page_token

A token, which can be sent as page_token to retrieve the next page. If this field is empty, there are no subsequent pages.

string
total_size

Exact count of filter schemas matching the request’s filter and scope (both pagination modes).

string
Example generated
{
"filter_schemas": [
{}
],
"next_page_token": "example",
"total_size": "example"
}

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object
code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32
message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string
details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object
@type

The type of the serialized message.

string
key
additional properties
any
Example generated
{
"code": 1,
"message": "example",
"details": [
{
"@type": "example"
}
]
}