Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
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++.
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
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".
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 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
error |
String |
||||
code |
Integer |
int32 |
|||
message |
String |
||||
details |
List of ProtobufAny |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
retentionDurationDays |
Long |
int64 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
resolvedDeployRetentionDurationDays |
Integer |
int32 |
|||
deletedRuntimeRetentionDurationDays |
Integer |
This runtime alert retention configuration takes precedence after |
int32 |
||
allRuntimeRetentionDurationDays |
Integer |
This runtime alert retention configuration has highest precedence. All runtime alerts, including attempted alerts and deleted deployment alerts, are deleted even if respective retention is longer. |
int32 |
||
attemptedDeployRetentionDurationDays |
Integer |
int32 |
|||
attemptedRuntimeRetentionDurationDays |
Integer |
This runtime alert retention configuration has lowest precedence. |
int32 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
enabled |
Boolean |
||||
text |
String |
||||
size |
UNSET, SMALL, MEDIUM, LARGE, |
||||
color |
String |
||||
backgroundColor |
String |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
numDays |
Long |
int64 |
|||
enabled |
Boolean |
next available tag: 5
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
retentionDurationDays |
Integer |
int32 |
|||
ignoreClusterLabels |
Map of |
||||
lastUpdated |
Date |
date-time |
|||
createdAt |
Date |
date-time |
next available tag:9
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
DEPRECATEDAlertRetentionDurationDays |
Integer |
int32 |
|||
alertConfig |
|||||
imageRetentionDurationDays |
Integer |
int32 |
|||
expiredVulnReqRetentionDurationDays |
Integer |
int32 |
|||
decommissionedClusterRetention |
|||||
reportRetentionConfig |
|||||
vulnerabilityExceptionConfig |
|||||
administrationEventsConfig |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
loginNotice |
|||||
header |
|||||
footer |
|||||
telemetry |
next available tag: 4
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
historyRetentionDurationDays |
Long |
int64 |
|||
downloadableReportRetentionDays |
Long |
int64 |
|||
downloadableReportGlobalRetentionBytes |
Long |
int64 |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
enabled |
Boolean |
||||
lastSetTime |
Date |
date-time |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
expiryOptions |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
dayOptions |
List of StorageDayOption |
||||
fixableCveOptions |
|||||
customDate |
Boolean |
||||
indefinite |
Boolean |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
allFixable |
Boolean |
||||
anyFixable |
Boolean |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
config |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
config |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
config |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
dayOptions |
List of V1DayOption |
This allows users to set expiry interval based on number of days. |
|||
fixableCveOptions |
|||||
customDate |
Boolean |
This option, if true, allows UI to show a custom date picker for setting expiry date. |
|||
indefinite |
Boolean |
Field Name | Required | Nullable | Type | Description | Format |
---|---|---|---|---|---|
allFixable |
Boolean |
This options allows users to expire the vulnerability deferral request if and only if all vulnerabilities in the requests become fixable. |
|||
anyFixable |
Boolean |
This options allows users to expire the vulnerability deferral request if any vulnerability in the requests become fixable. |