Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
×
NotifierService
DeleteNotifier
GetNotifier
GetNotifiers
PostNotifier
PutNotifier
PUT /v1/notifiers/{id}
PutNotifier modifies a given notifier, without using stored credential reconciliation.
TestNotifier
TestUpdatedNotifier
POST /v1/notifiers/test/updated
TestUpdatedNotifier checks if the given notifier is correctly configured, with optional stored credential reconciliation.
UpdateNotifier
PATCH /v1/notifiers/{notifier.id}
UpdateNotifier modifies a given notifier, with optional stored credential reconciliation.
Common object reference
JiraPriorityMapping
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
severity |
UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, |
||||
priorityName |
String |
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 |
StorageAWSSecurityHub
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
region |
String |
||||
credentials |
|||||
accountId |
String |
StorageAWSSecurityHubCredentials
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
accessKeyId |
String |
||||
secretAccessKey |
String |
||||
stsEnabled |
Boolean |
StorageCSCC
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
serviceAccount |
String |
The service account for the integration. The server will mask the value of this credential in responses and logs. |
|||
sourceId |
String |
||||
wifEnabled |
Boolean |
StorageEmail
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
server |
String |
||||
sender |
String |
||||
username |
String |
||||
password |
String |
The password for the integration. The server will mask the value of this credential in responses and logs. |
|||
disableTLS |
Boolean |
||||
DEPRECATEDUseStartTLS |
Boolean |
||||
from |
String |
||||
startTLSAuthMethod |
DISABLED, PLAIN, LOGIN, |
||||
allowUnauthenticatedSmtp |
Boolean |
StorageGeneric
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
endpoint |
String |
||||
skipTLSVerify |
Boolean |
||||
caCert |
String |
||||
username |
String |
||||
password |
String |
The password for the integration. The server will mask the value of this credential in responses and logs. |
|||
headers |
List of StorageKeyValuePair |
||||
extraFields |
List of StorageKeyValuePair |
||||
auditLoggingEnabled |
Boolean |
StorageJira
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
url |
String |
||||
username |
String |
||||
password |
String |
The password for the integration. The server will mask the value of this credential in responses and logs. |
|||
issueType |
String |
||||
priorityMappings |
List of JiraPriorityMapping |
||||
defaultFieldsJson |
String |
||||
disablePriority |
Boolean |
StorageNotifier
Next Tag: 19
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
||||
name |
String |
||||
type |
String |
||||
uiEndpoint |
String |
||||
labelKey |
String |
||||
labelDefault |
String |
||||
jira |
|||||
cscc |
|||||
splunk |
|||||
pagerduty |
|||||
generic |
|||||
sumologic |
|||||
awsSecurityHub |
|||||
syslog |
|||||
notifierSecret |
String |
||||
traits |
StoragePagerDuty
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
apiKey |
String |
The API key for the integration. The server will mask the value of this credential in responses and logs. |
StorageSeverity
| Enum Values |
|---|
UNSET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
StorageSplunk
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
httpToken |
String |
The HTTP token for the integration. The server will mask the value of this credential in responses and logs. |
|||
httpEndpoint |
String |
||||
insecure |
Boolean |
||||
truncate |
String |
int64 |
|||
auditLoggingEnabled |
Boolean |
||||
derivedSourceType |
Boolean |
||||
sourceTypes |
Map of |
StorageSumoLogic
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
httpSourceAddress |
String |
||||
skipTLSVerify |
Boolean |
StorageSyslog
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
localFacility |
LOCAL0, LOCAL1, LOCAL2, LOCAL3, LOCAL4, LOCAL5, LOCAL6, LOCAL7, |
||||
tcpConfig |
|||||
extraFields |
List of StorageKeyValuePair |
||||
messageFormat |
LEGACY, CEF, |
StorageTraits
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
mutabilityMode |
ALLOW_MUTATE, ALLOW_MUTATE_FORCED, |
||||
visibility |
VISIBLE, HIDDEN, |
||||
origin |
IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
SyslogTCPConfig
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
hostname |
String |
||||
port |
Integer |
int32 |
|||
skipTlsVerify |
Boolean |
||||
useTls |
Boolean |
TraitsMutabilityMode
EXPERIMENTAL. NOTE: Please refer from using MutabilityMode for the time being. It will be replaced in the future (ROX-14276). MutabilityMode specifies whether and how an object can be modified. Default is ALLOW_MUTATE and means there are no modification restrictions; this is equivalent to the absence of MutabilityMode specification. ALLOW_MUTATE_FORCED forbids all modifying operations except object removal with force bit on.
Be careful when changing the state of this field. For example, modifying an object from ALLOW_MUTATE to ALLOW_MUTATE_FORCED is allowed but will prohibit any further changes to it, including modifying it back to ALLOW_MUTATE.
| Enum Values |
|---|
ALLOW_MUTATE |
ALLOW_MUTATE_FORCED |
TraitsOrigin
Origin specifies the origin of an object. Objects can have four different origins: - IMPERATIVE: the object was created via the API. This is assumed by default. - DEFAULT: the object is a default object, such as default roles, access scopes etc. - DECLARATIVE: the object is created via declarative configuration. - DECLARATIVE_ORPHANED: the object is created via declarative configuration and then unsuccessfully deleted(for example, because it is referenced by another object) Based on the origin, different rules apply to the objects. Objects with the DECLARATIVE origin are not allowed to be modified via API, only via declarative configuration. Additionally, they may not reference objects with the IMPERATIVE origin. Objects with the DEFAULT origin are not allowed to be modified via either API or declarative configuration. They may be referenced by all other objects. Objects with the IMPERATIVE origin are allowed to be modified via API, not via declarative configuration. They may reference all other objects. Objects with the DECLARATIVE_ORPHANED origin are not allowed to be modified via either API or declarative configuration. DECLARATIVE_ORPHANED resource can become DECLARATIVE again if it is redefined in declarative configuration. Objects with this origin will be cleaned up from the system immediately after they are not referenced by other resources anymore. They may be referenced by all other objects.
| Enum Values |
|---|
IMPERATIVE |
DEFAULT |
DECLARATIVE |
DECLARATIVE_ORPHANED |
TraitsVisibility
EXPERIMENTAL. visibility allows to specify whether the object should be visible for certain APIs.
| Enum Values |
|---|
VISIBLE |
HIDDEN |
V1GetNotifiersResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
notifiers |
List of StorageNotifier |