descDir: {"description":{"description":"GroupQuery represents a query against a group of control planes."},"properties":{"response":{"description":{"description":"Expected response from GroupQueries."},"properties":{"count":{"description":{"description":"count is the total number of objects that match the query."}},"cursor":{"description":{"description":"cursor is cursor to the next page of results."},"properties":{"next":{"description":{"description":"cursor is the cursor to the next page of results. If empty, there are no more,"}},"page":{"description":{"description":"page is the page number of the cursor."}},"pageSize":{"description":{"description":"pageSize is the number of objects per page, i.e. the limit of the query."}},"position":{"description":{"description":"position is the position of the first object in the list of matching objects\nat the time the first cursor was created. Due to creation and deletion of\nobjects before the cursor this value might be outdated."}}}},"incomplete":{"description":{"description":"incomplete is true if the query was (potentially) limited before all\nmatching objects. If a non-empty spec.page.cursor has been used, or\nobjects have been skipped through non-zero spec.page.first, this value\nis always true."}},"objects":{"description":{"description":"objects is the list of objects returned by the query.\n\nObjects is mutual exclusive with Tables."},"items":{"description":{"description":"QueryResponseObject is one object returned by the query."},"properties":{"$errors":{"description":{"description":"errors is the list of errors that occurred while processing the object."},"items":{"description":{"description":""}}},"controlPlane":{"description":{"description":"controlPlane is the name and namespace of the object."},"properties":{"name":{"description":{"description":"name is the name of the controlplane of the object."}},"namespace":{"description":{"description":"namespace is the namespace of the controlplane of the object."}}}},"errors":{"description":{"description":"errors is the list of errors that occurred while processing the object."},"items":{"description":{"description":""}}},"id":{"description":{"description":"id indentifies the object. The id is opaque, i.e. the format is\nundefined. It's only valid for comparison within the response and as part\nof the spec.ids field in immediately following queries. The format of the\nid might change between releases."}},"mutablePath":{"description":{"description":"mutablePath is the mutable path of the object, i.e. the path to the\nobject in the controlplane Kubernetes API."},"properties":{"basePath":{"description":{"description":"basePath is the base URL of the controlplane, i.e. the Kubernetes API\nendpoint."}},"group":{"description":{"description":""}},"resource":{"description":{"description":""}},"version":{"description":{"description":""}}}},"object":{"description":{"description":"object is the sparse representation of the object."}},"relations":{"description":{"description":"relations is the list of objects related to the object."}}}}},"tables":{"description":{"description":"tables is the list of tables returned by the query. Objects are grouped\nas specified in the query. Hence, potentially multiple tables are returned.\n\nObjects is mutual exclusive with Tables."},"items":{"description":{"description":"QueryResponseTable is a table representation of a set of API resources."},"properties":{"columns":{"description":{"description":"columns is the list of columns in the table."},"items":{"description":{"description":"TableColumnDefinition contains information about a column returned in the Table."},"properties":{"description":{"description":{"description":"description is a human readable description of this column."}},"format":{"description":{"description":"format is an optional OpenAPI type modifier for this column. A format modifies the type and\nimposes additional rules, like date or time formatting for a string. The 'name' format is applied\nto the primary identifier column which has type 'string' to assist in clients identifying column\nis the resource name.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more."}},"name":{"description":{"description":"name is a human readable name for the column."}},"priority":{"description":{"description":"priority is an integer defining the relative importance of this column compared to others. Lower\nnumbers are considered higher priority. Columns that may be omitted in limited space scenarios\nshould be given a higher priority."}},"type":{"description":{"description":"type is an OpenAPI type definition for this column, such as number, integer, string, or\narray.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more."}}}}},"groupVersionKind":{"description":{"description":"groupVersionKind is the group, version, and kind of the objects in the table."},"properties":{"group":{"description":{"description":""}},"kind":{"description":{"description":""}},"version":{"description":{"description":""}}}},"rows":{"description":{"description":"rows is the list of rows in the table."},"items":{"description":{"description":"TableRow is an individual row in a table."},"properties":{"cells":{"description":{"description":"cells will be as wide as the column definitions array and may contain strings, numbers (float64 or\nint64), booleans, simple maps, lists, or null. See the type field of the column definition for a\nmore detailed description."},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions describe additional status of a row that are relevant for a human user. These conditions\napply to the row, not to the object, and will be specific to table output. The only defined\ncondition type is 'Completed', for a row that indicates a resource that has run to completion and\ncan be given less visual priority."},"items":{"description":{"description":"TableRowCondition allows a row to be marked with additional information."},"properties":{"message":{"description":{"description":"Human readable message indicating details about last transition."}},"reason":{"description":{"description":"(brief) machine readable reason for the condition's last transition."}},"status":{"description":{"description":"Status of the condition, one of True, False, Unknown."}},"type":{"description":{"description":"Type of row condition. The only defined value is 'Completed' indicating that the\nobject this row represents has reached a completed state and may be given less visual\npriority than other rows. Clients are not required to honor any conditions but should\nbe consistent where possible about handling the conditions."}}}}},"object":{"description":{"description":"This field contains the requested additional information about each object based on the includeObject\npolicy when requesting the Table. If 'None', this field is empty, if 'Object' this will be the\ndefault serialization of the object for the current API version, and if 'Metadata' (the default) will\ncontain the object metadata. Check the returned kind and apiVersion of the object before parsing.\nThe media type of the object will always match the enclosing list - if this as a JSON table, these\nwill be JSON encoded objects."}}}}}}}},"warnings":{"description":{"description":"warnings is a list of warnings that occurred while processing the query.\nThe query is still executed, but these warnings indicate problems. It\nis recommended to print these to the user."},"items":{"description":{"description":""}}}}},"spec":{"description":{"description":"A QuerySpec specifies what to query."},"properties":{"count":{"description":{"description":"count specifies whether to return the number of objects. Note that\ncomputing the count is expensive and should only be done if necessary.\nCount is the remaining objects that match the query after paging."}},"cursor":{"description":{"description":"Cursor specifies the cursor of the first object to return. This value is\nopaque and is only valid when passed into spec.page.cursor in a subsequent\nquery. The format of the cursor might change between releases."}},"filter":{"description":{"description":"filter specifies how to filter the returned objects."},"properties":{"categories":{"description":{"description":"categories is a list of categories to query. If empty, all categories are\nqueried in the given scope.\nExamples: all, managed, composite, claim"},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions is a list of conditions to query. If empty, all conditions are\nqueried in the given scope."},"items":{"description":{"description":"A QueryCondition specifies how to query a condition."},"properties":{"status":{"description":{"description":"status is the status of condition to query. This is either True, False\nor Unknown."}},"type":{"description":{"description":"type is the type of condition to query.\nExamples: Ready, Synced"}}}}},"controlPlane":{"description":{"description":"controlPlane specifies which control planes to query. If empty, all\ncontrol planes are queried in the given scope."},"properties":{"group":{"description":{"description":"group is the group of the control plane to query. If empty, all groups\nare queried in the given scope."}},"name":{"description":{"description":"name is the name of the control plane to query. If empty, all control planes\nare queried in the given scope."}},"namespace":{"description":{"description":"namespace is the namespace of the controlplane to query. If empty, all\nnamespaces are queried in the given scope."}}}},"group":{"description":{"description":"group is the API group to query. If empty, all groups are queried in the\ngiven scope."}},"ids":{"description":{"description":"ids: ['id1','id2'] # to get objects explicitly by id."},"items":{"description":{"description":""}}},"kind":{"description":{"description":"kind is the API kind to query. If empty, all kinds are queried in the\ngiven scope. The kind is case-insensitive. The kind also matches plural\nresources."}},"name":{"description":{"description":"name is the name of the object to query. If empty, all objects are queried\nin the given scope."}},"namespace":{"description":{"description":"namespace is the namespace WITHIN a controlplane to query. If empty,\nall namespaces are queried in the given scope."}},"objects":{"description":{"description":"objects specifies what to filter. Objects in the query response will\nmatch all criteria in at least one of the specified filters."},"items":{"description":{"description":"QueryFilter specifies what to filter. Objects in the query response will\nmatch all criteria specified in the filter."},"properties":{"categories":{"description":{"description":"categories is a list of categories to query.\nExamples: all, managed, composite, claim"},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions is a list of conditions to query."},"items":{"description":{"description":"A QueryCondition specifies how to query a condition."},"properties":{"reason":{"description":{"description":"reason queries based on the reason field of the condition."}},"status":{"description":{"description":"status is the status of condition to query. This is either True, False\nor Unknown."}},"type":{"description":{"description":"type is the type of condition to query.\nExamples: Ready, Synced"}}}}},"creationTimestamp":{"description":{"description":"creationTimestamp queries for objects with a range of creation times."},"properties":{"after":{"description":{"description":""}},"before":{"description":{"description":""}}}},"groupKind":{"description":{"description":"groupKind is the GroupKinds of objects to query."},"properties":{"apiGroup":{"description":{"description":"apiGroup is the API group to query. If empty all groups will be queried."}},"kind":{"description":{"description":"kind is kind to query. Kinds are case-insensitive and also match plural\nresources. If empty all kinds will be queried."}}}},"id":{"description":{"description":"id is the object ID to query."}},"jsonpath":{"description":{"description":"jsonpath is a JSONPath filter expression that will be applied to objects\nas a filter. It must return a boolean; no objects will be matched if it\nreturns any other type. jsonpath should be used as a last resort; using\nthe other filter fields will generally be more efficient."}},"labels":{"description":{"description":"labels are the labels of objects to query."}},"name":{"description":{"description":"name is the name of objects to query."}},"namespace":{"description":{"description":"namespace is the namespace WITHIN a control plane to query."}}}}},"owners":{"description":{"description":"owners is a list of owners to query. An object matches if it has at least\none owner in the list."},"items":{"description":{"description":"A QueryOwner specifies how to query by owner."},"properties":{"group":{"description":{"description":"name is the name of the owner to match."}},"kind":{"description":{"description":"kind is the kind of the owner to match."}},"uid":{"description":{"description":"uid is the uid of the owner to match."}}}}},"sql":{"description":{"description":"sql is a SQL query to query. If empty, all objects are queried in the\ngiven scope.\n\n\nThe current object can be referenced by the alias 'o'.\n\n\nWARNING: The where clause is highly dependent on the database\nschema and might change at any time. The schema is not documented."}}}},"freshness":{"description":{"description":"freshness specifies resource versions per control plane to wait for before\nreturning results. It's helpful to ensure consistency for read-after-write."},"items":{"description":{"description":"Freshness specifies a resource version per control plane to wait for before\nreturning results. It's helpful to ensure consistency for read-after-write."},"properties":{"controlPlane":{"description":{"description":"controlPlane is the name of the control plane to check for freshness of the data.\nIn case of Query, the name is defaulted and must match the control plane\nname of the request."}},"group":{"description":{"description":"group is the group of the control plane to check for freshness of\nthe data. In case of GroupQuery or Query, the group is defaulted and\nmust match the group of the request."}},"resourceVersion":{"description":{"description":"resourceVersion is the resource version of the specified control plane\nto wait for before executing the query. Normal request timeouts apply.\nThe resourceVersion is a large integer, returned by previous queries or\nby requests against the control plane Kubernetes API.\n\nNote that resource versions between control planes are not correlated."}}}}},"limit":{"description":{"description":"limit is the maximal number of objects to return. Defaulted to 100.\n\nNote that a limit in a relation subsumes all the children of all parents,\ni.e. a small limit only makes sense if there is only a single parent,\ne.g. selected via spec.IDs."}},"objects":{"description":{"description":"objects specifies how to return the objects."},"properties":{"controlPlane":{"description":{"description":"controlPlane specifies that the control plane name and namespace of the\nobject should be returned."}},"id":{"description":{"description":"id specifies whether to return the id of the object. The id is opaque,\ni.e. the format is undefined. It's only valid for comparison within the\nresponse and as part of the spec.ids field in immediately following queries.\nThe format of the id might change between releases."}},"mutablePath":{"description":{"description":"mutablePath specifies whether to return the mutable path of the object,\ni.e. the path to the object in the control plane Kubernetes API."}},"object":{"description":{"description":"object specifies how to return the object, i.e. a sparse skeleton of\nfields. A value of true means that all descendants of that field should\nbe returned. Other primitive values are not allowed. If the type of\na field does not match the schema (e.g. an array instead of an object),\nthe field is ignored."}},"relations":{"description":{"description":"relations specifies which relations to query and what to return.\nRelation names are predefined strings relative to the release of\nSpaces.\n\nExamples: owners, descendants, resources, events, or their transitive\nequivalents owners+, descendants+, resources+."}},"table":{"description":{"description":"table specifies whether to return the object in a table format."},"properties":{"grouping":{"description":{"description":"grouping specifies how to group the returned objects into multiple\ntables where every table can have different sets of columns."}}}}}},"order":{"description":{"description":"order specifies how to order the returned objects. The first element\nspecifies the primary order, the second element specifies the secondary,\netc."},"items":{"description":{"description":"A QueryOrder specifies how to order. Exactly one of the fields must be set."},"properties":{"apiGroup":{"description":{"description":"APIGroup specifies how to order by API group."}},"cluster":{"description":{"description":"controlPlane specifies how to order by control plane name."}},"creationTimestamp":{"description":{"description":"creationTimestamp specifies how to order by creation timestamp."}},"group":{"description":{"description":"group specifies how to order by control plane group."}},"kind":{"description":{"description":"kind specifies how to order by kind."}},"name":{"description":{"description":"name specifies how to order by name."}},"namespace":{"description":{"description":"namespace specifies how to order by namespace."}}}}},"page":{"description":{"description":"Page specifies how to page the returned objects."},"properties":{"cursor":{"description":{"description":"cursor is the cursor of the first object to return. This value is opaque,\nthe format cannot be relied on. It is returned by the server in the\nresponse to a previous query. If neither first nor cursor is specified,\nobjects are returned from the beginning.\n\nNote that cursor values are not stable under different orderings."}},"first":{"description":{"description":"first is the number of the first object to return relative to the cursor.\nIf neither first nor cursor is specified, objects are returned from the\nbeginning."}}}}}}}}
spaces.upbound.io/v1alpha2
Expand All
Collapse All
GroupQuery represents a query against a group of control planes.
descDir: {"description":{"description":"Query represents a query against one control plane, the one with the same\nname and namespace as the query."},"properties":{"response":{"properties":{"count":{"description":{"description":"count is the total number of objects that match the query."}},"cursor":{"description":{"description":"cursor is cursor to the next page of results."},"properties":{"next":{"description":{"description":"cursor is the cursor to the next page of results. If empty, there are no more,"}},"page":{"description":{"description":"page is the page number of the cursor."}},"pageSize":{"description":{"description":"pageSize is the number of objects per page, i.e. the limit of the query."}},"position":{"description":{"description":"position is the position of the first object in the list of matching objects\nat the time the first cursor was created. Due to creation and deletion of\nobjects before the cursor this value might be outdated."}}}},"incomplete":{"description":{"description":"incomplete is true if the query was (potentially) limited before all\nmatching objects. If a non-empty spec.page.cursor has been used, or\nobjects have been skipped through non-zero spec.page.first, this value\nis always true."}},"objects":{"description":{"description":"objects is the list of objects returned by the query.\n\nObjects is mutual exclusive with Tables."},"items":{"description":{"description":"QueryResponseObject is one object returned by the query."},"properties":{"$errors":{"description":{"description":"errors is the list of errors that occurred while processing the object."},"items":{"description":{"description":""}}},"controlPlane":{"description":{"description":"controlPlane is the name and namespace of the object."},"properties":{"name":{"description":{"description":"name is the name of the controlplane of the object."}},"namespace":{"description":{"description":"namespace is the namespace of the controlplane of the object."}}}},"errors":{"description":{"description":"errors is the list of errors that occurred while processing the object."},"items":{"description":{"description":""}}},"id":{"description":{"description":"id indentifies the object. The id is opaque, i.e. the format is\nundefined. It's only valid for comparison within the response and as part\nof the spec.ids field in immediately following queries. The format of the\nid might change between releases."}},"mutablePath":{"description":{"description":"mutablePath is the mutable path of the object, i.e. the path to the\nobject in the controlplane Kubernetes API."},"properties":{"basePath":{"description":{"description":"basePath is the base URL of the controlplane, i.e. the Kubernetes API\nendpoint."}},"group":{"description":{"description":""}},"resource":{"description":{"description":""}},"version":{"description":{"description":""}}}},"object":{"description":{"description":"object is the sparse representation of the object."}},"relations":{"description":{"description":"relations is the list of objects related to the object."}}}}},"tables":{"description":{"description":"tables is the list of tables returned by the query. Objects are grouped\nas specified in the query. Hence, potentially multiple tables are returned.\n\nObjects is mutual exclusive with Tables."},"items":{"description":{"description":"QueryResponseTable is a table representation of a set of API resources."},"properties":{"columns":{"description":{"description":"columns is the list of columns in the table."},"items":{"description":{"description":"TableColumnDefinition contains information about a column returned in the Table."},"properties":{"description":{"description":{"description":"description is a human readable description of this column."}},"format":{"description":{"description":"format is an optional OpenAPI type modifier for this column. A format modifies the type and\nimposes additional rules, like date or time formatting for a string. The 'name' format is applied\nto the primary identifier column which has type 'string' to assist in clients identifying column\nis the resource name.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more."}},"name":{"description":{"description":"name is a human readable name for the column."}},"priority":{"description":{"description":"priority is an integer defining the relative importance of this column compared to others. Lower\nnumbers are considered higher priority. Columns that may be omitted in limited space scenarios\nshould be given a higher priority."}},"type":{"description":{"description":"type is an OpenAPI type definition for this column, such as number, integer, string, or\narray.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more."}}}}},"groupVersionKind":{"description":{"description":"groupVersionKind is the group, version, and kind of the objects in the table."},"properties":{"group":{"description":{"description":""}},"kind":{"description":{"description":""}},"version":{"description":{"description":""}}}},"rows":{"description":{"description":"rows is the list of rows in the table."},"items":{"description":{"description":"TableRow is an individual row in a table."},"properties":{"cells":{"description":{"description":"cells will be as wide as the column definitions array and may contain strings, numbers (float64 or\nint64), booleans, simple maps, lists, or null. See the type field of the column definition for a\nmore detailed description."},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions describe additional status of a row that are relevant for a human user. These conditions\napply to the row, not to the object, and will be specific to table output. The only defined\ncondition type is 'Completed', for a row that indicates a resource that has run to completion and\ncan be given less visual priority."},"items":{"description":{"description":"TableRowCondition allows a row to be marked with additional information."},"properties":{"message":{"description":{"description":"Human readable message indicating details about last transition."}},"reason":{"description":{"description":"(brief) machine readable reason for the condition's last transition."}},"status":{"description":{"description":"Status of the condition, one of True, False, Unknown."}},"type":{"description":{"description":"Type of row condition. The only defined value is 'Completed' indicating that the\nobject this row represents has reached a completed state and may be given less visual\npriority than other rows. Clients are not required to honor any conditions but should\nbe consistent where possible about handling the conditions."}}}}},"object":{"description":{"description":"This field contains the requested additional information about each object based on the includeObject\npolicy when requesting the Table. If 'None', this field is empty, if 'Object' this will be the\ndefault serialization of the object for the current API version, and if 'Metadata' (the default) will\ncontain the object metadata. Check the returned kind and apiVersion of the object before parsing.\nThe media type of the object will always match the enclosing list - if this as a JSON table, these\nwill be JSON encoded objects."}}}}}}}},"warnings":{"description":{"description":"warnings is a list of warnings that occurred while processing the query.\nThe query is still executed, but these warnings indicate problems. It\nis recommended to print these to the user."},"items":{"description":{"description":""}}}}},"spec":{"description":{"description":"A QuerySpec specifies what to query."},"properties":{"count":{"description":{"description":"count specifies whether to return the number of objects. Note that\ncomputing the count is expensive and should only be done if necessary.\nCount is the remaining objects that match the query after paging."}},"cursor":{"description":{"description":"Cursor specifies the cursor of the first object to return. This value is\nopaque and is only valid when passed into spec.page.cursor in a subsequent\nquery. The format of the cursor might change between releases."}},"filter":{"description":{"description":"filter specifies how to filter the returned objects."},"properties":{"categories":{"description":{"description":"categories is a list of categories to query. If empty, all categories are\nqueried in the given scope.\nExamples: all, managed, composite, claim"},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions is a list of conditions to query. If empty, all conditions are\nqueried in the given scope."},"items":{"description":{"description":"A QueryCondition specifies how to query a condition."},"properties":{"status":{"description":{"description":"status is the status of condition to query. This is either True, False\nor Unknown."}},"type":{"description":{"description":"type is the type of condition to query.\nExamples: Ready, Synced"}}}}},"controlPlane":{"description":{"description":"controlPlane specifies which control planes to query. If empty, all\ncontrol planes are queried in the given scope."},"properties":{"group":{"description":{"description":"group is the group of the control plane to query. If empty, all groups\nare queried in the given scope."}},"name":{"description":{"description":"name is the name of the control plane to query. If empty, all control planes\nare queried in the given scope."}},"namespace":{"description":{"description":"namespace is the namespace of the controlplane to query. If empty, all\nnamespaces are queried in the given scope."}}}},"group":{"description":{"description":"group is the API group to query. If empty, all groups are queried in the\ngiven scope."}},"ids":{"description":{"description":"ids: ['id1','id2'] # to get objects explicitly by id."},"items":{"description":{"description":""}}},"kind":{"description":{"description":"kind is the API kind to query. If empty, all kinds are queried in the\ngiven scope. The kind is case-insensitive. The kind also matches plural\nresources."}},"name":{"description":{"description":"name is the name of the object to query. If empty, all objects are queried\nin the given scope."}},"namespace":{"description":{"description":"namespace is the namespace WITHIN a controlplane to query. If empty,\nall namespaces are queried in the given scope."}},"objects":{"description":{"description":"objects specifies what to filter. Objects in the query response will\nmatch all criteria in at least one of the specified filters."},"items":{"description":{"description":"QueryFilter specifies what to filter. Objects in the query response will\nmatch all criteria specified in the filter."},"properties":{"categories":{"description":{"description":"categories is a list of categories to query.\nExamples: all, managed, composite, claim"},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions is a list of conditions to query."},"items":{"description":{"description":"A QueryCondition specifies how to query a condition."},"properties":{"reason":{"description":{"description":"reason queries based on the reason field of the condition."}},"status":{"description":{"description":"status is the status of condition to query. This is either True, False\nor Unknown."}},"type":{"description":{"description":"type is the type of condition to query.\nExamples: Ready, Synced"}}}}},"creationTimestamp":{"description":{"description":"creationTimestamp queries for objects with a range of creation times."},"properties":{"after":{"description":{"description":""}},"before":{"description":{"description":""}}}},"groupKind":{"description":{"description":"groupKind is the GroupKinds of objects to query."},"properties":{"apiGroup":{"description":{"description":"apiGroup is the API group to query. If empty all groups will be queried."}},"kind":{"description":{"description":"kind is kind to query. Kinds are case-insensitive and also match plural\nresources. If empty all kinds will be queried."}}}},"id":{"description":{"description":"id is the object ID to query."}},"jsonpath":{"description":{"description":"jsonpath is a JSONPath filter expression that will be applied to objects\nas a filter. It must return a boolean; no objects will be matched if it\nreturns any other type. jsonpath should be used as a last resort; using\nthe other filter fields will generally be more efficient."}},"labels":{"description":{"description":"labels are the labels of objects to query."}},"name":{"description":{"description":"name is the name of objects to query."}},"namespace":{"description":{"description":"namespace is the namespace WITHIN a control plane to query."}}}}},"owners":{"description":{"description":"owners is a list of owners to query. An object matches if it has at least\none owner in the list."},"items":{"description":{"description":"A QueryOwner specifies how to query by owner."},"properties":{"group":{"description":{"description":"name is the name of the owner to match."}},"kind":{"description":{"description":"kind is the kind of the owner to match."}},"uid":{"description":{"description":"uid is the uid of the owner to match."}}}}},"sql":{"description":{"description":"sql is a SQL query to query. If empty, all objects are queried in the\ngiven scope.\n\n\nThe current object can be referenced by the alias 'o'.\n\n\nWARNING: The where clause is highly dependent on the database\nschema and might change at any time. The schema is not documented."}}}},"freshness":{"description":{"description":"freshness specifies resource versions per control plane to wait for before\nreturning results. It's helpful to ensure consistency for read-after-write."},"items":{"description":{"description":"Freshness specifies a resource version per control plane to wait for before\nreturning results. It's helpful to ensure consistency for read-after-write."},"properties":{"controlPlane":{"description":{"description":"controlPlane is the name of the control plane to check for freshness of the data.\nIn case of Query, the name is defaulted and must match the control plane\nname of the request."}},"group":{"description":{"description":"group is the group of the control plane to check for freshness of\nthe data. In case of GroupQuery or Query, the group is defaulted and\nmust match the group of the request."}},"resourceVersion":{"description":{"description":"resourceVersion is the resource version of the specified control plane\nto wait for before executing the query. Normal request timeouts apply.\nThe resourceVersion is a large integer, returned by previous queries or\nby requests against the control plane Kubernetes API.\n\nNote that resource versions between control planes are not correlated."}}}}},"limit":{"description":{"description":"limit is the maximal number of objects to return. Defaulted to 100.\n\nNote that a limit in a relation subsumes all the children of all parents,\ni.e. a small limit only makes sense if there is only a single parent,\ne.g. selected via spec.IDs."}},"objects":{"description":{"description":"objects specifies how to return the objects."},"properties":{"controlPlane":{"description":{"description":"controlPlane specifies that the control plane name and namespace of the\nobject should be returned."}},"id":{"description":{"description":"id specifies whether to return the id of the object. The id is opaque,\ni.e. the format is undefined. It's only valid for comparison within the\nresponse and as part of the spec.ids field in immediately following queries.\nThe format of the id might change between releases."}},"mutablePath":{"description":{"description":"mutablePath specifies whether to return the mutable path of the object,\ni.e. the path to the object in the control plane Kubernetes API."}},"object":{"description":{"description":"object specifies how to return the object, i.e. a sparse skeleton of\nfields. A value of true means that all descendants of that field should\nbe returned. Other primitive values are not allowed. If the type of\na field does not match the schema (e.g. an array instead of an object),\nthe field is ignored."}},"relations":{"description":{"description":"relations specifies which relations to query and what to return.\nRelation names are predefined strings relative to the release of\nSpaces.\n\nExamples: owners, descendants, resources, events, or their transitive\nequivalents owners+, descendants+, resources+."}},"table":{"description":{"description":"table specifies whether to return the object in a table format."},"properties":{"grouping":{"description":{"description":"grouping specifies how to group the returned objects into multiple\ntables where every table can have different sets of columns."}}}}}},"order":{"description":{"description":"order specifies how to order the returned objects. The first element\nspecifies the primary order, the second element specifies the secondary,\netc."},"items":{"description":{"description":"A QueryOrder specifies how to order. Exactly one of the fields must be set."},"properties":{"apiGroup":{"description":{"description":"APIGroup specifies how to order by API group."}},"cluster":{"description":{"description":"controlPlane specifies how to order by control plane name."}},"creationTimestamp":{"description":{"description":"creationTimestamp specifies how to order by creation timestamp."}},"group":{"description":{"description":"group specifies how to order by control plane group."}},"kind":{"description":{"description":"kind specifies how to order by kind."}},"name":{"description":{"description":"name specifies how to order by name."}},"namespace":{"description":{"description":"namespace specifies how to order by namespace."}}}}},"page":{"description":{"description":"Page specifies how to page the returned objects."},"properties":{"cursor":{"description":{"description":"cursor is the cursor of the first object to return. This value is opaque,\nthe format cannot be relied on. It is returned by the server in the\nresponse to a previous query. If neither first nor cursor is specified,\nobjects are returned from the beginning.\n\nNote that cursor values are not stable under different orderings."}},"first":{"description":{"description":"first is the number of the first object to return relative to the cursor.\nIf neither first nor cursor is specified, objects are returned from the\nbeginning."}}}}}}}}
spaces.upbound.io/v1alpha2
Expand All
Collapse All
Query represents a query against one control plane, the one with the same
name and namespace as the query.
descDir: {"description":{"description":"SpaceQuery represents a query against all control planes."},"properties":{"response":{"properties":{"count":{"description":{"description":"count is the total number of objects that match the query."}},"cursor":{"description":{"description":"cursor is cursor to the next page of results."},"properties":{"next":{"description":{"description":"cursor is the cursor to the next page of results. If empty, there are no more,"}},"page":{"description":{"description":"page is the page number of the cursor."}},"pageSize":{"description":{"description":"pageSize is the number of objects per page, i.e. the limit of the query."}},"position":{"description":{"description":"position is the position of the first object in the list of matching objects\nat the time the first cursor was created. Due to creation and deletion of\nobjects before the cursor this value might be outdated."}}}},"incomplete":{"description":{"description":"incomplete is true if the query was (potentially) limited before all\nmatching objects. If a non-empty spec.page.cursor has been used, or\nobjects have been skipped through non-zero spec.page.first, this value\nis always true."}},"objects":{"description":{"description":"objects is the list of objects returned by the query.\n\nObjects is mutual exclusive with Tables."},"items":{"description":{"description":"QueryResponseObject is one object returned by the query."},"properties":{"$errors":{"description":{"description":"errors is the list of errors that occurred while processing the object."},"items":{"description":{"description":""}}},"controlPlane":{"description":{"description":"controlPlane is the name and namespace of the object."},"properties":{"name":{"description":{"description":"name is the name of the controlplane of the object."}},"namespace":{"description":{"description":"namespace is the namespace of the controlplane of the object."}}}},"errors":{"description":{"description":"errors is the list of errors that occurred while processing the object."},"items":{"description":{"description":""}}},"id":{"description":{"description":"id indentifies the object. The id is opaque, i.e. the format is\nundefined. It's only valid for comparison within the response and as part\nof the spec.ids field in immediately following queries. The format of the\nid might change between releases."}},"mutablePath":{"description":{"description":"mutablePath is the mutable path of the object, i.e. the path to the\nobject in the controlplane Kubernetes API."},"properties":{"basePath":{"description":{"description":"basePath is the base URL of the controlplane, i.e. the Kubernetes API\nendpoint."}},"group":{"description":{"description":""}},"resource":{"description":{"description":""}},"version":{"description":{"description":""}}}},"object":{"description":{"description":"object is the sparse representation of the object."}},"relations":{"description":{"description":"relations is the list of objects related to the object."}}}}},"tables":{"description":{"description":"tables is the list of tables returned by the query. Objects are grouped\nas specified in the query. Hence, potentially multiple tables are returned.\n\nObjects is mutual exclusive with Tables."},"items":{"description":{"description":"QueryResponseTable is a table representation of a set of API resources."},"properties":{"columns":{"description":{"description":"columns is the list of columns in the table."},"items":{"description":{"description":"TableColumnDefinition contains information about a column returned in the Table."},"properties":{"description":{"description":{"description":"description is a human readable description of this column."}},"format":{"description":{"description":"format is an optional OpenAPI type modifier for this column. A format modifies the type and\nimposes additional rules, like date or time formatting for a string. The 'name' format is applied\nto the primary identifier column which has type 'string' to assist in clients identifying column\nis the resource name.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more."}},"name":{"description":{"description":"name is a human readable name for the column."}},"priority":{"description":{"description":"priority is an integer defining the relative importance of this column compared to others. Lower\nnumbers are considered higher priority. Columns that may be omitted in limited space scenarios\nshould be given a higher priority."}},"type":{"description":{"description":"type is an OpenAPI type definition for this column, such as number, integer, string, or\narray.\nSee https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#data-types for more."}}}}},"groupVersionKind":{"description":{"description":"groupVersionKind is the group, version, and kind of the objects in the table."},"properties":{"group":{"description":{"description":""}},"kind":{"description":{"description":""}},"version":{"description":{"description":""}}}},"rows":{"description":{"description":"rows is the list of rows in the table."},"items":{"description":{"description":"TableRow is an individual row in a table."},"properties":{"cells":{"description":{"description":"cells will be as wide as the column definitions array and may contain strings, numbers (float64 or\nint64), booleans, simple maps, lists, or null. See the type field of the column definition for a\nmore detailed description."},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions describe additional status of a row that are relevant for a human user. These conditions\napply to the row, not to the object, and will be specific to table output. The only defined\ncondition type is 'Completed', for a row that indicates a resource that has run to completion and\ncan be given less visual priority."},"items":{"description":{"description":"TableRowCondition allows a row to be marked with additional information."},"properties":{"message":{"description":{"description":"Human readable message indicating details about last transition."}},"reason":{"description":{"description":"(brief) machine readable reason for the condition's last transition."}},"status":{"description":{"description":"Status of the condition, one of True, False, Unknown."}},"type":{"description":{"description":"Type of row condition. The only defined value is 'Completed' indicating that the\nobject this row represents has reached a completed state and may be given less visual\npriority than other rows. Clients are not required to honor any conditions but should\nbe consistent where possible about handling the conditions."}}}}},"object":{"description":{"description":"This field contains the requested additional information about each object based on the includeObject\npolicy when requesting the Table. If 'None', this field is empty, if 'Object' this will be the\ndefault serialization of the object for the current API version, and if 'Metadata' (the default) will\ncontain the object metadata. Check the returned kind and apiVersion of the object before parsing.\nThe media type of the object will always match the enclosing list - if this as a JSON table, these\nwill be JSON encoded objects."}}}}}}}},"warnings":{"description":{"description":"warnings is a list of warnings that occurred while processing the query.\nThe query is still executed, but these warnings indicate problems. It\nis recommended to print these to the user."},"items":{"description":{"description":""}}}}},"spec":{"description":{"description":"A QuerySpec specifies what to query."},"properties":{"count":{"description":{"description":"count specifies whether to return the number of objects. Note that\ncomputing the count is expensive and should only be done if necessary.\nCount is the remaining objects that match the query after paging."}},"cursor":{"description":{"description":"Cursor specifies the cursor of the first object to return. This value is\nopaque and is only valid when passed into spec.page.cursor in a subsequent\nquery. The format of the cursor might change between releases."}},"filter":{"description":{"description":"filter specifies how to filter the returned objects."},"properties":{"categories":{"description":{"description":"categories is a list of categories to query. If empty, all categories are\nqueried in the given scope.\nExamples: all, managed, composite, claim"},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions is a list of conditions to query. If empty, all conditions are\nqueried in the given scope."},"items":{"description":{"description":"A QueryCondition specifies how to query a condition."},"properties":{"status":{"description":{"description":"status is the status of condition to query. This is either True, False\nor Unknown."}},"type":{"description":{"description":"type is the type of condition to query.\nExamples: Ready, Synced"}}}}},"controlPlane":{"description":{"description":"controlPlane specifies which control planes to query. If empty, all\ncontrol planes are queried in the given scope."},"properties":{"group":{"description":{"description":"group is the group of the control plane to query. If empty, all groups\nare queried in the given scope."}},"name":{"description":{"description":"name is the name of the control plane to query. If empty, all control planes\nare queried in the given scope."}},"namespace":{"description":{"description":"namespace is the namespace of the controlplane to query. If empty, all\nnamespaces are queried in the given scope."}}}},"group":{"description":{"description":"group is the API group to query. If empty, all groups are queried in the\ngiven scope."}},"ids":{"description":{"description":"ids: ['id1','id2'] # to get objects explicitly by id."},"items":{"description":{"description":""}}},"kind":{"description":{"description":"kind is the API kind to query. If empty, all kinds are queried in the\ngiven scope. The kind is case-insensitive. The kind also matches plural\nresources."}},"name":{"description":{"description":"name is the name of the object to query. If empty, all objects are queried\nin the given scope."}},"namespace":{"description":{"description":"namespace is the namespace WITHIN a controlplane to query. If empty,\nall namespaces are queried in the given scope."}},"objects":{"description":{"description":"objects specifies what to filter. Objects in the query response will\nmatch all criteria in at least one of the specified filters."},"items":{"description":{"description":"QueryFilter specifies what to filter. Objects in the query response will\nmatch all criteria specified in the filter."},"properties":{"categories":{"description":{"description":"categories is a list of categories to query.\nExamples: all, managed, composite, claim"},"items":{"description":{"description":""}}},"conditions":{"description":{"description":"conditions is a list of conditions to query."},"items":{"description":{"description":"A QueryCondition specifies how to query a condition."},"properties":{"reason":{"description":{"description":"reason queries based on the reason field of the condition."}},"status":{"description":{"description":"status is the status of condition to query. This is either True, False\nor Unknown."}},"type":{"description":{"description":"type is the type of condition to query.\nExamples: Ready, Synced"}}}}},"creationTimestamp":{"description":{"description":"creationTimestamp queries for objects with a range of creation times."},"properties":{"after":{"description":{"description":""}},"before":{"description":{"description":""}}}},"groupKind":{"description":{"description":"groupKind is the GroupKinds of objects to query."},"properties":{"apiGroup":{"description":{"description":"apiGroup is the API group to query. If empty all groups will be queried."}},"kind":{"description":{"description":"kind is kind to query. Kinds are case-insensitive and also match plural\nresources. If empty all kinds will be queried."}}}},"id":{"description":{"description":"id is the object ID to query."}},"jsonpath":{"description":{"description":"jsonpath is a JSONPath filter expression that will be applied to objects\nas a filter. It must return a boolean; no objects will be matched if it\nreturns any other type. jsonpath should be used as a last resort; using\nthe other filter fields will generally be more efficient."}},"labels":{"description":{"description":"labels are the labels of objects to query."}},"name":{"description":{"description":"name is the name of objects to query."}},"namespace":{"description":{"description":"namespace is the namespace WITHIN a control plane to query."}}}}},"owners":{"description":{"description":"owners is a list of owners to query. An object matches if it has at least\none owner in the list."},"items":{"description":{"description":"A QueryOwner specifies how to query by owner."},"properties":{"group":{"description":{"description":"name is the name of the owner to match."}},"kind":{"description":{"description":"kind is the kind of the owner to match."}},"uid":{"description":{"description":"uid is the uid of the owner to match."}}}}},"sql":{"description":{"description":"sql is a SQL query to query. If empty, all objects are queried in the\ngiven scope.\n\n\nThe current object can be referenced by the alias 'o'.\n\n\nWARNING: The where clause is highly dependent on the database\nschema and might change at any time. The schema is not documented."}}}},"freshness":{"description":{"description":"freshness specifies resource versions per control plane to wait for before\nreturning results. It's helpful to ensure consistency for read-after-write."},"items":{"description":{"description":"Freshness specifies a resource version per control plane to wait for before\nreturning results. It's helpful to ensure consistency for read-after-write."},"properties":{"controlPlane":{"description":{"description":"controlPlane is the name of the control plane to check for freshness of the data.\nIn case of Query, the name is defaulted and must match the control plane\nname of the request."}},"group":{"description":{"description":"group is the group of the control plane to check for freshness of\nthe data. In case of GroupQuery or Query, the group is defaulted and\nmust match the group of the request."}},"resourceVersion":{"description":{"description":"resourceVersion is the resource version of the specified control plane\nto wait for before executing the query. Normal request timeouts apply.\nThe resourceVersion is a large integer, returned by previous queries or\nby requests against the control plane Kubernetes API.\n\nNote that resource versions between control planes are not correlated."}}}}},"limit":{"description":{"description":"limit is the maximal number of objects to return. Defaulted to 100.\n\nNote that a limit in a relation subsumes all the children of all parents,\ni.e. a small limit only makes sense if there is only a single parent,\ne.g. selected via spec.IDs."}},"objects":{"description":{"description":"objects specifies how to return the objects."},"properties":{"controlPlane":{"description":{"description":"controlPlane specifies that the control plane name and namespace of the\nobject should be returned."}},"id":{"description":{"description":"id specifies whether to return the id of the object. The id is opaque,\ni.e. the format is undefined. It's only valid for comparison within the\nresponse and as part of the spec.ids field in immediately following queries.\nThe format of the id might change between releases."}},"mutablePath":{"description":{"description":"mutablePath specifies whether to return the mutable path of the object,\ni.e. the path to the object in the control plane Kubernetes API."}},"object":{"description":{"description":"object specifies how to return the object, i.e. a sparse skeleton of\nfields. A value of true means that all descendants of that field should\nbe returned. Other primitive values are not allowed. If the type of\na field does not match the schema (e.g. an array instead of an object),\nthe field is ignored."}},"relations":{"description":{"description":"relations specifies which relations to query and what to return.\nRelation names are predefined strings relative to the release of\nSpaces.\n\nExamples: owners, descendants, resources, events, or their transitive\nequivalents owners+, descendants+, resources+."}},"table":{"description":{"description":"table specifies whether to return the object in a table format."},"properties":{"grouping":{"description":{"description":"grouping specifies how to group the returned objects into multiple\ntables where every table can have different sets of columns."}}}}}},"order":{"description":{"description":"order specifies how to order the returned objects. The first element\nspecifies the primary order, the second element specifies the secondary,\netc."},"items":{"description":{"description":"A QueryOrder specifies how to order. Exactly one of the fields must be set."},"properties":{"apiGroup":{"description":{"description":"APIGroup specifies how to order by API group."}},"cluster":{"description":{"description":"controlPlane specifies how to order by control plane name."}},"creationTimestamp":{"description":{"description":"creationTimestamp specifies how to order by creation timestamp."}},"group":{"description":{"description":"group specifies how to order by control plane group."}},"kind":{"description":{"description":"kind specifies how to order by kind."}},"name":{"description":{"description":"name specifies how to order by name."}},"namespace":{"description":{"description":"namespace specifies how to order by namespace."}}}}},"page":{"description":{"description":"Page specifies how to page the returned objects."},"properties":{"cursor":{"description":{"description":"cursor is the cursor of the first object to return. This value is opaque,\nthe format cannot be relied on. It is returned by the server in the\nresponse to a previous query. If neither first nor cursor is specified,\nobjects are returned from the beginning.\n\nNote that cursor values are not stable under different orderings."}},"first":{"description":{"description":"first is the number of the first object to return relative to the cursor.\nIf neither first nor cursor is specified, objects are returned from the\nbeginning."}}}}}}}}
spaces.upbound.io/v1alpha2
Expand All
Collapse All
SpaceQuery represents a query against all control planes.