_create_time |
Timestamp of resource creation |
EpochMsTimestamp |
Readonly Sortable |
_create_user |
ID of the user who created this resource |
string |
Readonly |
_last_modified_time |
Timestamp of last modification |
EpochMsTimestamp |
Readonly Sortable |
_last_modified_user |
ID of the user who last modified this resource |
string |
Readonly |
_links |
References related to this resource
The server will populate this field when returing the resource. Ignored on PUT and POST. |
array of ResourceLink |
Readonly |
_protection |
Indicates protection status of this resource
Protection status is one of the following:
PROTECTED - the client who retrieved the entity is not allowed
to modify it.
NOT_PROTECTED - the client who retrieved the entity is allowed
to modify it
REQUIRE_OVERRIDE - the client who retrieved the entity is a super
user and can modify it, but only when providing
the request header X-Allow-Overwrite=true.
UNKNOWN - the _protection field could not be determined for this
entity.
|
string |
Readonly |
_revision |
Generation of this resource config
The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected. |
int |
|
_schema |
Schema for this resource |
string |
Readonly |
_self |
Link to this resource |
SelfResourceLink |
Readonly |
_system_owned |
Indicates system owned resource |
boolean |
Readonly |
ceip_acceptance |
Flag to indicate if CEIP has been accepted
Enable this flag to participate in the Customer Experience Improvement Program.
|
boolean |
Required |
description |
Description of this resource |
string |
Maximum length: 1024 Sortable |
display_name |
Identifier to use when displaying entity in logs or GUI
Defaults to ID if not set |
string |
Maximum length: 255 Sortable |
id |
Unique identifier of this resource |
string |
Sortable |
proxy_enabled |
Flag to indicate if proxy has been configured
Enable this flag to specify a proxy, and provide the proxy settings. |
boolean |
Default: "False" |
resource_type |
Must be set to the value TelemetryConfig |
string |
|
schedule_enabled |
Flag to indicate if data collection is enabled
Enable this to schedule data collection and upload times. If enabled,
and a schedule is not provided, a default schedule (WEEKLY, Sunday at 2:00 a.m)
will be applied.
|
boolean |
Required |
tags |
Opaque identifiers meaningful to the API user |
array of Tag |
Maximum items: 30 |
telemetry_proxy |
Set config for proxy to be used to send out telemetry data
Specify the proxy configuration (scheme, server, port) here. |
TelemetryProxy |
|
telemetry_schedule |
Set schedule for when telemetry data should be collected
Specify one of Daily, Weekly or Monthly schedules. |
TelemetrySchedule (Abstract type: pass one of the following concrete types) DailyTelemetrySchedule MonthlyTelemetrySchedule WeeklyTelemetrySchedule |
|