Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
×
CollectionService
CreateCollection
DeleteCollection
DryRunCollection
GetCollection
GeT /v1/collections/{id}
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
options.withMatches |
- |
null |
||
options.filterQuery.query |
- |
null |
||
options.filterQuery.pagination.limit |
- |
null |
||
options.filterQuery.pagination.offset |
- |
null |
||
options.filterQuery.pagination.sortOption.field |
- |
null |
||
options.filterQuery.pagination.sortOption.reversed |
- |
null |
||
options.filterQuery.pagination.sortOption.aggregateBy.aggrFunc |
- |
UNSeT |
||
options.filterQuery.pagination.sortOption.aggregateBy.distinct |
- |
null |
GetCollectionCount
GeT /v1/collectionscount
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
query.query |
- |
null |
||
query.pagination.limit |
- |
null |
||
query.pagination.offset |
- |
null |
||
query.pagination.sortOption.field |
- |
null |
||
query.pagination.sortOption.reversed |
- |
null |
||
query.pagination.sortOption.aggregateBy.aggrFunc |
- |
UNSeT |
||
query.pagination.sortOption.aggregateBy.distinct |
- |
null |
ListCollectionSelectors
ListCollections
GeT /v1/collections
Parameters
Query Parameters
| Name | Description | Required | Default | Pattern |
|---|---|---|---|---|
query.query |
- |
null |
||
query.pagination.limit |
- |
null |
||
query.pagination.offset |
- |
null |
||
query.pagination.sortOption.field |
- |
null |
||
query.pagination.sortOption.reversed |
- |
null |
||
query.pagination.sortOption.aggregateBy.aggrFunc |
- |
UNSeT |
||
query.pagination.sortOption.aggregateBy.distinct |
- |
null |
UpdateCollection
Common object reference
ProtobufAny
Any contains an arbitrary serialized protocol buffer message along with a
URL that describes the type of the serialized message.
Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.
example 1: Pack and unpack a message in C++.
example 2: Pack and unpack a message in Java.
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DeSCRIPTOR): any.Unpack(foo) ...
example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".
JSON representation
The JSON representation of an Any value uses the regular
representation of the deserialized, embedded message, with an
additional field @type which contains the type URL. example:
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
If the embedded message type is well-known and has a custom JSON
representation, that representation will be embedded adding a field
value which holds the custom JSON in addition to the @type
field. example (for message [google.protobuf.Duration][]):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
typeUrl |
String |
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in |
|||
value |
byte[] |
Must be a valid serialized protocol buffer of the above specified type. |
byte |
ResourceCollectionembeddedResourceCollection
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
Runtimeerror
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
error |
String |
||||
code |
Integer |
int32 |
|||
message |
String |
||||
details |
List of ProtobufAny |
StorageListDeployment
Next available tag: 9
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
hash |
String |
uint64 |
|||
name |
String |
||||
cluster |
String |
||||
clusterId |
String |
||||
namespace |
String |
||||
created |
Date |
date-time |
|||
priority |
String |
int64 |
StorageResourceCollection
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
name |
String |
||||
description |
String |
||||
createdAt |
Date |
date-time |
|||
lastUpdated |
Date |
date-time |
|||
createdBy |
|||||
updatedBy |
|||||
resourceSelectors |
List of StorageResourceSelector |
|
|||
embeddedCollections |
StorageResourceSelector
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
rules |
List of StorageSelectorRule |
|
StorageRuleValue
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
value |
String |
||||
matchType |
eXACT, ReGeX, |
StorageSelectorRule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
fieldName |
String |
||||
operator |
OR, AND, |
||||
values |
List of StorageRuleValue |
|
V1AggregateBy
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
aggrFunc |
UNSeT, COUNT, MIN, MAX, |
||||
distinct |
Boolean |
V1CollectionDeploymentMatchOptions
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
withMatches |
Boolean |
||||
filterQuery |
V1CreateCollectionRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
||||
description |
String |
||||
resourceSelectors |
List of StorageResourceSelector |
||||
embeddedCollectionIds |
List of |
V1DryRunCollectionRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
||||
id |
String |
||||
description |
String |
||||
resourceSelectors |
List of StorageResourceSelector |
||||
embeddedCollectionIds |
List of |
||||
options |
V1DryRunCollectionResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
deployments |
List of StorageListDeployment |
V1GetCollectionCountResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
count |
Integer |
int32 |
V1GetCollectionResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
collection |
|||||
deployments |
List of StorageListDeployment |
V1ListCollectionSelectorsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
selectors |
List of |
V1ListCollectionsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
collections |
List of StorageResourceCollection |
V1Pagination
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
limit |
Integer |
int32 |
|||
offset |
Integer |
int32 |
|||
sortOption |
|||||
sortOptions |
List of V1SortOption |
This field is under development. It is not supported on any ReST APIs. |
V1RawQuery
RawQuery represents the search query string. The format of the query string is "<field name>:<value,value,…><field name>:<value, value,...>…" For example: To search for deployments named "central" and "sensor" in the namespace "stackrox", the query string would be "Deployment:central,sensor+Namespace:stackrox" RawQuery is used in ListAPIs to search for a particular object.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
query |
String |
||||
pagination |
V1SortOption
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
field |
String |
||||
reversed |
Boolean |
||||
aggregateBy |
V1UpdateCollectionRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
name |
String |
||||
description |
String |
||||
resourceSelectors |
List of StorageResourceSelector |
||||
embeddedCollectionIds |
List of |