Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
×
NetworkPolicyService
ApplyNetworkPolicy
ApplyNetworkPolicyYamlForDeployment
GenerateNetworkPolicies
GetAllowedPeersFromCurrentPolicyForDeployment
GetBaselineGeneratedNetworkPolicyForDeployment
GetDiffFlowsBetweenPolicyAndBaselineForDeployment
GetDiffFlowsFromUndoModificationForDeployment
GetNetworkGraph
GetNetworkGraphEpoch
GetNetworkPolicies
GetNetworkPolicy
GetUndoModification
GetUndoModificationForDeployment
SendNetworkPolicyYAML
SimulateNetworkGraph
Common object reference
DeploymentListenPort
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
port |
Long |
int64 |
|||
l4protocol |
L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY, |
GenerateNetworkPoliciesRequestDeleteExistingPoliciesMode
| Enum Values |
|---|
UNKNOWN |
NONE |
GENERATED_ONLY |
ALL |
NetworkEntityInfoExternalSource
Update normalizeDupNameExtSrcs(…) in central/networkgraph/aggregator/aggregator.go whenever this message is updated.
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
||||
cidr |
String |
||||
default |
Boolean |
|
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 |
RuntimeError
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
error |
String |
||||
code |
Integer |
int32 |
|||
message |
String |
||||
details |
List of ProtobufAny |
StorageIPBlock
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
cidr |
String |
||||
except |
List of |
StorageL4Protocol
| Enum Values |
|---|
L4_PROTOCOL_UNKNOWN |
L4_PROTOCOL_TCP |
L4_PROTOCOL_UDP |
L4_PROTOCOL_ICMP |
L4_PROTOCOL_RAW |
L4_PROTOCOL_SCTP |
L4_PROTOCOL_ANY |
StorageLabelSelector
Label selector components are joined with logical AND, see https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
matchLabels |
Map of |
This is actually a oneof, but we can’t make it one due to backwards compatibility constraints. |
|||
requirements |
List of StorageLabelSelectorRequirement |
StorageLabelSelectorRequirement
Next available tag: 4
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
key |
String |
||||
op |
UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS, |
||||
values |
List of |
StorageNetworkBaselineConnectionProperties
NetworkBaselineConnectionProperties represents information about a baseline connection next available tag: 4
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
ingress |
Boolean |
||||
port |
Long |
int64 |
|||
protocol |
L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY, |
StorageNetworkEntityInfo
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
type |
UNKNOWN_TYPE, DEPLOYMENT, INTERNET, LISTEN_ENDPOINT, EXTERNAL_SOURCE, INTERNAL_ENTITIES, |
||||
id |
String |
||||
deployment |
|||||
externalSource |
StorageNetworkEntityInfoDeployment
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
||||
namespace |
String |
||||
cluster |
String |
||||
listenPorts |
List of DeploymentListenPort |
StorageNetworkEntityInfoType
-
INTERNAL_ENTITIES: INTERNAL_ENTITIES is for grouping all internal entities under a single network graph node
| Enum Values |
|---|
UNKNOWN_TYPE |
DEPLOYMENT |
INTERNET |
LISTEN_ENDPOINT |
EXTERNAL_SOURCE |
INTERNAL_ENTITIES |
StorageNetworkPolicy
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
name |
String |
||||
clusterId |
String |
||||
clusterName |
String |
||||
namespace |
String |
||||
labels |
Map of |
||||
annotations |
Map of |
||||
spec |
|||||
yaml |
String |
||||
apiVersion |
String |
||||
created |
Date |
date-time |
StorageNetworkPolicyApplicationUndoRecord
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
clusterId |
String |
||||
user |
String |
||||
applyTimestamp |
Date |
date-time |
|||
originalModification |
|||||
undoModification |
StorageNetworkPolicyEgressRule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
ports |
List of StorageNetworkPolicyPort |
||||
to |
List of StorageNetworkPolicyPeer |
StorageNetworkPolicyingressRule
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
ports |
List of StorageNetworkPolicyPort |
||||
from |
List of StorageNetworkPolicyPeer |
StorageNetworkPolicyModification
Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
applyYaml |
String |
||||
toDelete |
List of StorageNetworkPolicyReference |
StorageNetworkPolicyPeer
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
podSelector |
|||||
namespaceSelector |
|||||
ipBlock |
StorageNetworkPolicyPort
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
protocol |
UNSET_PROTOCOL, TCP_PROTOCOL, UDP_PROTOCOL, SCTP_PROTOCOL, |
||||
port |
Integer |
int32 |
|||
portName |
String |
StorageNetworkPolicyReference
Next available tag: 3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
namespace |
String |
||||
name |
String |
StorageNetworkPolicySpec
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
podSelector |
|||||
ingress |
List of StorageNetworkPolicyingressRule |
||||
egress |
List of StorageNetworkPolicyEgressRule |
||||
policyTypes |
List of StorageNetworkPolicyType |
StorageNetworkPolicyType
| Enum Values |
|---|
UNSET_NETWORK_POLICY_TYPE |
ingress_NETWORK_POLICY_TYPE |
EGRESS_NETWORK_POLICY_TYPE |
V1ApplyNetworkPolicyYamlForDeploymentRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
deploymentId |
String |
||||
modification |
V1GenerateNetworkPoliciesResponse
Next available tag: 2
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
modification |
V1GetAllowedPeersFromCurrentPolicyForDeploymentResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
allowedPeers |
List of V1NetworkBaselineStatusPeer |
V1GetBaselineGeneratedPolicyForDeploymentRequest
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
deploymentId |
String |
||||
deleteExisting |
UNKNOWN, NONE, GENERATED_ONLY, ALL, |
||||
includePorts |
Boolean |
V1GetBaselineGeneratedPolicyForDeploymentResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
modification |
V1GetDiffFlowsReconciledFlow
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
entity |
|||||
added |
|||||
removed |
|||||
unchanged |
V1GetDiffFlowsResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
added |
List of V1GetDiffFlowsGroupedFlow |
||||
removed |
List of V1GetDiffFlowsGroupedFlow |
||||
reconciled |
List of V1GetDiffFlowsReconciledFlow |
V1GetUndoModificationForDeploymentResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
undoRecord |
V1NetworkBaselinePeerEntity
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
type |
UNKNOWN_TYPE, DEPLOYMENT, INTERNET, LISTEN_ENDPOINT, EXTERNAL_SOURCE, INTERNAL_ENTITIES, |
V1NetworkBaselineStatusPeer
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
entity |
|||||
port |
Long |
The port and protocol of the destination of the given connection. |
int64 |
||
protocol |
L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY, |
||||
ingress |
Boolean |
A boolean representing whether the query is for an ingress or egress connection. This is defined with respect to the current deployment. Thus: - If the connection in question is in the outEdges of the current deployment, this should be false. - If it is in the outEdges of the peer deployment, this should be true. |
V1NetworkEdgeProperties
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
port |
Long |
int64 |
|||
protocol |
L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY, |
||||
lastActiveTimestamp |
Date |
date-time |
V1NetworkEdgePropertiesBundle
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
properties |
List of V1NetworkEdgeProperties |
V1NetworkGraph
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
epoch |
Long |
int64 |
|||
nodes |
List of V1NetworkNode |
V1NetworkGraphDiff
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
DEPRECATEDNodeDiffs |
Map of V1NetworkNodeDiff |
||||
nodeDiffs |
Map of V1NetworkNodeDiff |
V1NetworkNode
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
entity |
|||||
internetAccess |
Boolean |
||||
policyIds |
List of |
||||
nonIsolatedingress |
Boolean |
||||
nonIsolatedEgress |
Boolean |
||||
queryMatch |
Boolean |
||||
outEdges |
V1NetworkNodeDiff
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
policyIds |
List of |
||||
DEPRECATEDOutEdges |
|||||
outEdges |
|||||
nonIsolatedingress |
Boolean |
||||
nonIsolatedEgress |
Boolean |
V1NetworkPoliciesResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
networkPolicies |
List of StorageNetworkPolicy |
V1NetworkPolicyInSimulation
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
policy |
|||||
status |
INVALID, UNCHANGED, MODIFIED, ADDED, DELETED, |
||||
oldPolicy |
V1SimulateNetworkGraphResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
simulatedGraph |
|||||
policies |
List of V1NetworkPolicyInSimulation |
||||
added |
|||||
removed |