en-US
en-US

Service: Watchdog (ntt.watchdog.v1alpha - v1alpha)

Service Watchdog

Index

Resources

Project

Project Resource

Fields
name
string

Name of Project

probe_status_exposure_mode
Project.ProbeStatusExposureMode

Behaviour mode for probeStatus. Note that this configuration affects all Proe resources in the project, To make this option work, enable PublicDeviceInfo

slack_webhook_url
string

InternetQualityRatings will be posted to this Slack webook URL when configured.

teams_webhook_url
string

InternetQualityRatings will be posted to this Microsoft Teams webook URL when configured.

Operations

GetProject
rpc GetProject(GetProjectRequest) returns (Project)

GetProject

BatchGetProjects
rpc BatchGetProjects(BatchGetProjectsRequest) returns (BatchGetProjectsResponse)

BatchGetProjects

ListProjects
rpc ListProjects(ListProjectsRequest) returns (ListProjectsResponse)

ListProjects

WatchProject
rpc WatchProject(WatchProjectRequest) returns (WatchProjectResponse)

WatchProject

WatchProjects
rpc WatchProjects(WatchProjectsRequest) returns (WatchProjectsResponse)

WatchProjects

CreateProject
rpc CreateProject(CreateProjectRequest) returns (Project)

CreateProject

UpdateProject
rpc UpdateProject(UpdateProjectRequest) returns (Project)

UpdateProject

DeleteProject
rpc DeleteProject(DeleteProjectRequest) returns (Empty)

DeleteProject

Messages

GetProjectRequest

Request message for method [GetProject][ntt.watchdog.v1alpha.GetProject]

Fields
name
string

Reference of ntt.watchdog.v1alpha.Project

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProjectsRequest

Request message for method [BatchGetProjects][ntt.watchdog.v1alpha.BatchGetProjects]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.Project

names
repeated string

Names of Projects

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProjectsResponse

BatchGetProjectsResponse

Fields
projects
repeated Project

found Projects

missing
repeated string

list of not found Projects

ListProjectsRequest

Request message for method [ListProjects][ntt.watchdog.v1alpha.ListProjects]

Fields
page_size
int32

Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProjectsResponse.next_page_token][ntt.watchdog.v1alpha.ListProjectsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProjectsResponse

Request message for method [ListProjects][ntt.watchdog.v1alpha.ListProjects]

Fields
projects
repeated Project

The list of Projects

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.watchdog.v1alpha.ListProjectsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProjectsRequest.page_token][ntt.watchdog.v1alpha.ListProjectsRequest.page_token]

WatchProjectRequest

Request message for method [WatchProject][ntt.watchdog.v1alpha.WatchProject]

Fields
name
string

Reference to ntt.watchdog.v1alpha.Project

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProjectResponse

WatchProjectResponse

Fields
change
ProjectChange
WatchProjectsRequest

Request message for method [WatchProjects][ntt.watchdog.v1alpha.WatchProjects]

Fields
page_size
int32

Requested page size. Server may return fewer Projects than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Project that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Project that don't affect any of masked fields won't be sent back.

WatchProjectsResponse

WatchProjectsResponse

Fields
project_changes
repeated ProjectChange

Changes of Projects

page_token_change
WatchProjectsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProjectsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProjectRequest

Request message for method [CreateProject][ntt.watchdog.v1alpha.CreateProject]

Fields
project
Project

Project resource body

UpdateProjectRequest

Request message for method [UpdateProject][ntt.watchdog.v1alpha.UpdateProject]

Fields
project
Project

Project resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProjectRequest

Request message for method [DeleteProject][ntt.watchdog.v1alpha.DeleteProject]

Fields
name
string

Reference of ntt.watchdog.v1alpha.Project

Enums

Project.ProbeStatusExposureMode
Values
ProbeStatusExposureModeUnspecified

Same as Private

Private

Probe status is not available for the public. Authentication and authorization is required.

InsecurePublic

Any internet users can access prove status including provisioning status, connection status and ISP names, from serial numbers without any authentication.

Tag

Tag Resource

Fields
name
string

Name of Tag. Id

display_name
string

User-friendly name of tag.

state
Tag.State

Tag state. Contains resource counters.

Operations

GetTag
rpc GetTag(GetTagRequest) returns (Tag)

GetTag

BatchGetTags
rpc BatchGetTags(BatchGetTagsRequest) returns (BatchGetTagsResponse)

BatchGetTags

ListTags
rpc ListTags(ListTagsRequest) returns (ListTagsResponse)

ListTags

WatchTag
rpc WatchTag(WatchTagRequest) returns (WatchTagResponse)

WatchTag

WatchTags
rpc WatchTags(WatchTagsRequest) returns (WatchTagsResponse)

WatchTags

CreateTag
rpc CreateTag(CreateTagRequest) returns (Tag)

CreateTag

UpdateTag
rpc UpdateTag(UpdateTagRequest) returns (Tag)

UpdateTag

DeleteTag
rpc DeleteTag(DeleteTagRequest) returns (Empty)

DeleteTag

Messages

Tag.State
Fields
resource_type_counters
int64

Counter per using resource type, e.g. "watchdog.edgelq.com/Probe": 32 indicates there are 32 agents associated with this tag via their metadata.tag field.

distributions_via_target_selector
repeated string

List of back-references to distributions pointing to this tag via target selector

distributions_via_probe_selector
repeated string

List og back-references to distributions pointing to this tag via probe selector

GetTagRequest

Request message for method [GetTag][ntt.watchdog.v1alpha.GetTag]

Fields
name
string

Reference of ntt.watchdog.v1alpha.Tag

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetTagsRequest

Request message for method [BatchGetTags][ntt.watchdog.v1alpha.BatchGetTags]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.Tag

names
repeated string

Names of Tags

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetTagsResponse

BatchGetTagsResponse

Fields
tags
repeated Tag

found Tags

missing
repeated string

list of not found Tags

ListTagsRequest

Request message for method [ListTags][ntt.watchdog.v1alpha.ListTags]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.Tag

page_size
int32

Requested page size. Server may return fewer Tags than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListTagsResponse.next_page_token][ntt.watchdog.v1alpha.ListTagsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListTagsResponse

Request message for method [ListTags][ntt.watchdog.v1alpha.ListTags]

Fields
tags
repeated Tag

The list of Tags

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListTagsRequest.page_token][ntt.watchdog.v1alpha.ListTagsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListTagsRequest.page_token][ntt.watchdog.v1alpha.ListTagsRequest.page_token]

WatchTagRequest

Request message for method [WatchTag][ntt.watchdog.v1alpha.WatchTag]

Fields
name
string

Reference to ntt.watchdog.v1alpha.Tag

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchTagResponse

WatchTagResponse

Fields
change
TagChange
WatchTagsRequest

Request message for method [WatchTags][ntt.watchdog.v1alpha.WatchTags]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.Tag

page_size
int32

Requested page size. Server may return fewer Tags than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Tag that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Tag that don't affect any of masked fields won't be sent back.

WatchTagsResponse

WatchTagsResponse

Fields
tag_changes
repeated TagChange

Changes of Tags

page_token_change
WatchTagsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchTagsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateTagRequest

Request message for method [CreateTag][ntt.watchdog.v1alpha.CreateTag]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.Tag

tag
Tag

Tag resource body

UpdateTagRequest

Request message for method [UpdateTag][ntt.watchdog.v1alpha.UpdateTag]

Fields
tag
Tag

Tag resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteTagRequest

Request message for method [DeleteTag][ntt.watchdog.v1alpha.DeleteTag]

Fields
name
string

Reference of ntt.watchdog.v1alpha.Tag

ProbeGroup

ProbeGroup Resource

Fields
name
string

Name of ProbeGroup

display_name
string

Display Name of ProbeGroup

state
ProbeGroup.State

state of group

Operations

GetProbeGroup
rpc GetProbeGroup(GetProbeGroupRequest) returns (ProbeGroup)

GetProbeGroup

BatchGetProbeGroups
rpc BatchGetProbeGroups(BatchGetProbeGroupsRequest) returns (BatchGetProbeGroupsResponse)

BatchGetProbeGroups

ListProbeGroups
rpc ListProbeGroups(ListProbeGroupsRequest) returns (ListProbeGroupsResponse)

ListProbeGroups

WatchProbeGroup
rpc WatchProbeGroup(WatchProbeGroupRequest) returns (WatchProbeGroupResponse)

WatchProbeGroup

WatchProbeGroups
rpc WatchProbeGroups(WatchProbeGroupsRequest) returns (WatchProbeGroupsResponse)

WatchProbeGroups

CreateProbeGroup
rpc CreateProbeGroup(CreateProbeGroupRequest) returns (ProbeGroup)

CreateProbeGroup

UpdateProbeGroup
rpc UpdateProbeGroup(UpdateProbeGroupRequest) returns (ProbeGroup)

UpdateProbeGroup

DeleteProbeGroup
rpc DeleteProbeGroup(DeleteProbeGroupRequest) returns (Empty)

DeleteProbeGroup

Messages

ProbeGroup.State

Group State

Fields
target_count
int64

total count of [Probes][ntt.watchdog.v1alpha.Probe] associated with this group

GetProbeGroupRequest

Request message for method [GetProbeGroup][ntt.watchdog.v1alpha.GetProbeGroup]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbeGroup

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbeGroupsRequest

Request message for method [BatchGetProbeGroups][ntt.watchdog.v1alpha.BatchGetProbeGroups]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.ProbeGroup

names
repeated string

Names of ProbeGroups

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbeGroupsResponse

BatchGetProbeGroupsResponse

Fields
probe_groups
repeated ProbeGroup

found ProbeGroups

missing
repeated string

list of not found ProbeGroups

ListProbeGroupsRequest

Request message for method [ListProbeGroups][ntt.watchdog.v1alpha.ListProbeGroups]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.ProbeGroup

page_size
int32

Requested page size. Server may return fewer ProbeGroups than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProbeGroupsResponse.next_page_token][ntt.watchdog.v1alpha.ListProbeGroupsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProbeGroupsResponse

Request message for method [ListProbeGroups][ntt.watchdog.v1alpha.ListProbeGroups]

Fields
probe_groups
repeated ProbeGroup

The list of ProbeGroups

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProbeGroupsRequest.page_token][ntt.watchdog.v1alpha.ListProbeGroupsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProbeGroupsRequest.page_token][ntt.watchdog.v1alpha.ListProbeGroupsRequest.page_token]

WatchProbeGroupRequest

Request message for method [WatchProbeGroup][ntt.watchdog.v1alpha.WatchProbeGroup]

Fields
name
string

Reference to ntt.watchdog.v1alpha.ProbeGroup

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProbeGroupResponse

WatchProbeGroupResponse

Fields
change
ProbeGroupChange
WatchProbeGroupsRequest

Request message for method [WatchProbeGroups][ntt.watchdog.v1alpha.WatchProbeGroups]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbeGroup

page_size
int32

Requested page size. Server may return fewer ProbeGroups than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to ProbeGroup that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to ProbeGroup that don't affect any of masked fields won't be sent back.

WatchProbeGroupsResponse

WatchProbeGroupsResponse

Fields
probe_group_changes
repeated ProbeGroupChange

Changes of ProbeGroups

page_token_change
WatchProbeGroupsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProbeGroupsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProbeGroupRequest

Request message for method [CreateProbeGroup][ntt.watchdog.v1alpha.CreateProbeGroup]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbeGroup

probe_group
ProbeGroup

ProbeGroup resource body

UpdateProbeGroupRequest

Request message for method [UpdateProbeGroup][ntt.watchdog.v1alpha.UpdateProbeGroup]

Fields
probe_group
ProbeGroup

ProbeGroup resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProbeGroupRequest

Request message for method [DeleteProbeGroup][ntt.watchdog.v1alpha.DeleteProbeGroup]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbeGroup

Probe

Probe is a resource that represents a probing device.

Fields
name
string

Name of Probe

display_name
string

Display name for the probe

lower_display_name
string

Lower Display Name - only used for dashboard filtering

metadata
.ntt.types.Meta

metadata is additional information of the probe.

spec
Probe.Spec

spec describes the to-be state of the probe.

status
Probe.Status

status shows the current status of the probe.

memo
repeated .ntt.types.Memo

Memos

Operations

GetProbe
rpc GetProbe(GetProbeRequest) returns (Probe)

GetProbe

BatchGetProbes
rpc BatchGetProbes(BatchGetProbesRequest) returns (BatchGetProbesResponse)

BatchGetProbes

ListProbes
rpc ListProbes(ListProbesRequest) returns (ListProbesResponse)

ListProbes

WatchProbe
rpc WatchProbe(WatchProbeRequest) returns (WatchProbeResponse)

WatchProbe

WatchProbes
rpc WatchProbes(WatchProbesRequest) returns (WatchProbesResponse)

WatchProbes

CreateProbe
rpc CreateProbe(CreateProbeRequest) returns (Probe)

CreateProbe

UpdateProbe
rpc UpdateProbe(UpdateProbeRequest) returns (Probe)

UpdateProbe

DeleteProbe
rpc DeleteProbe(DeleteProbeRequest) returns (Empty)

DeleteProbe

ListMyProbes
rpc ListMyProbes(ListProbesRequest) returns (ListProbesResponse)

ListMyProbes

ResolveGeoIP
rpc ResolveGeoIP(ResolveGeoIPRequest) returns (ResolveGeoIPResponse)

ResolveGeoIP

BulkResolveGeoIP
rpc BulkResolveGeoIP(BulkResolveGeoIPRequest) returns (BulkResolveGeoIPResponse)

BulkResolveGeoIP

ResolveEnvironment
rpc ResolveEnvironment(ResolveEnvironmentRequest) returns (ResolveEnvironmentResponse)

ResolveEnvironment

SendActivationInvitation
rpc SendActivationInvitation(SendActivationInvitationRequest) returns (Empty)

SendActivationInvitation

ResetActivation
rpc ResetActivation(ResetActivationRequest) returns (Empty)

ResetActivation

Messages

Probe.Spec

Spec describes the to-be state of the probe. Fields in this message are useful to keep manual input values of the metadata of the probe. Note that some fields could be moved to metadata.annotations later.

Fields
probe_group
string

Probe Group allows optional grouping of probes.

device
string

device referes the device that assigned to the probe. When this field is empty, that means there is no asigned device yet. Devices resource is provided by the Devices service.

enabled
bool

Controls whether this Probe is available for scheduling Probings. Manually set it to false to switch-off Probings undergoing maintenance.

primary_location
Location

Address defines the expected address of the probe.

location_discovery
LocationDiscoverySpec
contact_info
ContactInformation

Contact Information

activation
Probe.Spec.ActivationSpec
disable_speedtest
bool
Probe.Spec.ActivationSpec
Fields
type
Probe.Spec.ActivationSpec.ActivationType
token
string

auto-generated or manually provided

send_invitation_on_create
bool

send activation email upon creation

reusable_token
bool

reusable token - determines if same token may be reused to reactivate probe even after activation was successful without admin or asset manager intervention. Convenient, but less secure configuration option.

Probe.Status

tatus describes the actual state of the Probe. Most fields are automatically resolved from the external_ip_address_v4, and clients don't need to fill up.

Fields
external_ip_address_v4
string

external_ip_address_v4 describes the actual external IPv4 address. The addresss is usually obtained from a STUN server by the probe agent

external_ip_address_v6
string

external_ip_address_v6 describes the actual external IPv6 address. The addresss is usually obtained from a STUN server by the probe agent

external_hostname
string

The hostname describes the hostname of the probe. The hostanme usually resolved from the external_ip_address_v4 by the service.

as_info
ASInfo

Asinfo describes the (ASN) details for the host This values usually resolved automatically by the service from the external_ip_address_v4.

carrier
Carrier

carrier describes mobile network carrier information

active_location
Location

The address describes the place where the probe is placed at. Note that the address is not always accurate.

software_version
SoftwareVersion

software version

system_info
Probe.Status.System
activation
Probe.Status.ActivationState
connection
Probe.Status.ConnectionStatus
connection_status_change_time
.google.protobuf.Timestamp

Last change of connection_status (edge activation)

bandwidth
Probe.Status.Bandwidth
Probe.Status.System
Fields
manufacturer
string
model
string
sku
string
family
string
serial_number
string
platform
string
architecture
string
os
Probe.Status.System.OS
host_name
string
Probe.Status.System.OS
Fields
name
string
version
string
build_version
string
kernel
string
Probe.Status.ActivationState
Fields
status
Probe.Status.ActivationState.Status
current_session
Probe.Status.ActivationState.Session

Session object stores required information about current activation session

service_account
string

Managed Service account reference

last_invitation
Probe.Status.ActivationState.InvitationState
Probe.Status.ActivationState.Session
Fields
client_cookie
string

current activation session cookie - allows avoiding collisions and ensure that only single client gets activated

lock_deadline
.google.protobuf.Timestamp

current session lock deadline for client identified with its cookie. after lock timestamp is exceeded, new clients may override cookie.

Probe.Status.ActivationState.InvitationState

activation invitation state

Fields
sent_date
.google.protobuf.Timestamp

sent date

sender
string

sender TODO: make it a formal reference

Probe.Status.Bandwidth

Internet speed

Fields
upload_mbps
double
download_mbps
double
test_server
string
last_reported
.google.protobuf.Timestamp
GetProbeRequest

Request message for method [GetProbe][ntt.watchdog.v1alpha.GetProbe]

Fields
name
string

Reference of ntt.watchdog.v1alpha.Probe

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbesRequest

Request message for method [BatchGetProbes][ntt.watchdog.v1alpha.BatchGetProbes]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.Probe

names
repeated string

Names of Probes

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbesResponse

BatchGetProbesResponse

Fields
probes
repeated Probe

found Probes

missing
repeated string

list of not found Probes

ListProbesRequest

Request message for method [ListProbes][ntt.watchdog.v1alpha.ListProbes]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.Probe

page_size
int32

Requested page size. Server may return fewer Probes than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProbesResponse.next_page_token][ntt.watchdog.v1alpha.ListProbesResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProbesResponse

Request message for method [ListProbes][ntt.watchdog.v1alpha.ListProbes]

Fields
probes
repeated Probe

The list of Probes

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProbesRequest.page_token][ntt.watchdog.v1alpha.ListProbesRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProbesRequest.page_token][ntt.watchdog.v1alpha.ListProbesRequest.page_token]

WatchProbeRequest

Request message for method [WatchProbe][ntt.watchdog.v1alpha.WatchProbe]

Fields
name
string

Reference to ntt.watchdog.v1alpha.Probe

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProbeResponse

WatchProbeResponse

Fields
change
ProbeChange
WatchProbesRequest

Request message for method [WatchProbes][ntt.watchdog.v1alpha.WatchProbes]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.Probe

page_size
int32

Requested page size. Server may return fewer Probes than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to Probe that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to Probe that don't affect any of masked fields won't be sent back.

WatchProbesResponse

WatchProbesResponse

Fields
probe_changes
repeated ProbeChange

Changes of Probes

page_token_change
WatchProbesResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProbesResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProbeRequest

Request message for method [CreateProbe][ntt.watchdog.v1alpha.CreateProbe]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.Probe

probe
Probe

Probe resource body

UpdateProbeRequest

Request message for method [UpdateProbe][ntt.watchdog.v1alpha.UpdateProbe]

Fields
probe
Probe

Probe resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProbeRequest

Request message for method [DeleteProbe][ntt.watchdog.v1alpha.DeleteProbe]

Fields
name
string

Reference of ntt.watchdog.v1alpha.Probe

ResolveGeoIPRequest

Request message for method [ResolveGeoIP][ntt.watchdog.v1alpha.ResolveGeoIP]

Fields
name
string

Name of Probe_Reference

address
string
ResolveGeoIPResponse

Response message for method [ResolveGeoIP][ntt.watchdog.v1alpha.ResolveGeoIP]

Fields
location
Location
isp
string
as_info
ASInfo
carrier
Carrier
access_provider
string
BulkResolveGeoIPRequest

Request message for method [BulkResolveGeoIP][ntt.watchdog.v1alpha.BulkResolveGeoIP]

Fields
name
string

Name of Probe_Reference

address
repeated string
BulkResolveGeoIPResponse

Response message for method [BulkResolveGeoIP][ntt.watchdog.v1alpha.BulkResolveGeoIP]

Fields
GeoIPInfo
repeated BulkResolveGeoIPResponse.GeoIPData
BulkResolveGeoIPResponse.GeoIPData
Fields
location
Location
isp
string
as_info
ASInfo
carrier
Carrier
access_provider
string
ip_address
string
ResolveEnvironmentRequest

Request message for method [ResolveEnvironment][ntt.watchdog.v1alpha.ResolveEnvironment]

Fields
name
string
address
string
wlans
repeated WLAN
ResolveEnvironmentResponse

Response message for method [ResolveEnvironment][ntt.watchdog.v1alpha.ResolveEnvironment]

Fields
location
Location
as_info
ASInfo
carrier
Carrier
SendActivationInvitationRequest

Request message for method [SendActivationInvitation][ntt.watchdog.v1alpha.SendActivationInvitation]

Fields
name
string
ResetActivationRequest

Request message for method [ResetActivation][ntt.watchdog.v1alpha.ResetActivation]

Fields
name
string

Target probe

token
string

Use token if set. Generates new token if left empty.

send_activation_invitation
bool

Reset action will additionally trigger invitation email to be sent

Enums

Probe.Spec.ActivationSpec.ActivationType
Values
ACTIVATION_TYPE_UNSPECIFIED
INDIVIDUAL_TOKEN
SELF_ACTIVATION

SHARED_TOKEN = 2;

Probe.Status.ConnectionStatus
Values
CONNECTION_STATUS_UNSPECIFIED
ONLINE
OFFLINE
Probe.Status.ActivationState.Status
Values
ACTIVATION_STATUS_UNSPECIFIED
INACTIVE
PENDING_INVITATION
PENDING_APPROVAL
IN_PROGRESS
ACTIVE

SharedToken

SharedToken Resource

Fields
name
string

Name of SharedToken

display_name
string

Human readable name of SharedToken.

quota
int32

Maximium number of probes provisioned through the SharedToken. Any negative value is interpreted as no quota.

probe_template
SharedToken.ProbeTemplate

probe_template describes pre defined values for probes to be generated. Note that some fieds will be overritten by the system. Template values may include place holders that will be substituted by the system with values from probes.

deduplication_field_paths
repeated string

deduplication_field_paths ensures that if there is an existing Probe resource that matches all of the paths provided, the resource will be reused, instaed of creating a new Probe resource. When the existing Probe resource has a service account provisioned, it will be revoked.

secret
string

secret hods the string of the sahred token. Do disclose the value. This filed cannot be updated.

Operations

GetSharedToken
rpc GetSharedToken(GetSharedTokenRequest) returns (SharedToken)

GetSharedToken

BatchGetSharedTokens
rpc BatchGetSharedTokens(BatchGetSharedTokensRequest) returns (BatchGetSharedTokensResponse)

BatchGetSharedTokens

ListSharedTokens
rpc ListSharedTokens(ListSharedTokensRequest) returns (ListSharedTokensResponse)

ListSharedTokens

WatchSharedToken
rpc WatchSharedToken(WatchSharedTokenRequest) returns (WatchSharedTokenResponse)

WatchSharedToken

WatchSharedTokens
rpc WatchSharedTokens(WatchSharedTokensRequest) returns (WatchSharedTokensResponse)

WatchSharedTokens

CreateSharedToken
rpc CreateSharedToken(CreateSharedTokenRequest) returns (SharedToken)

CreateSharedToken

UpdateSharedToken
rpc UpdateSharedToken(UpdateSharedTokenRequest) returns (SharedToken)

UpdateSharedToken

DeleteSharedToken
rpc DeleteSharedToken(DeleteSharedTokenRequest) returns (Empty)

DeleteSharedToken

RegisterProbe
rpc RegisterProbe(RegisterProbeRequest) returns (RegisterProbeResponse)

RegisterProbe

Messages

SharedToken.ProbeTemplate
Fields
metadata
SharedToken.ProbeTemplate.Meta
display_name
string
spec
SharedToken.ProbeTemplate.Spec
SharedToken.ProbeTemplate.Meta
Fields
tags
repeated string
labels
string
annotations
string
SharedToken.ProbeTemplate.Spec
Fields
probe_group
string

Probe Group allows optional grouping of probes.

primary_location
Location

Address defines the expected address of the probe.

location_discovery
LocationDiscoverySpec
contact_info
ContactInformation

Contact Information

disable_speedtest
bool
GetSharedTokenRequest

Request message for method [GetSharedToken][ntt.watchdog.v1alpha.GetSharedToken]

Fields
name
string

Reference of ntt.watchdog.v1alpha.SharedToken

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetSharedTokensRequest

Request message for method [BatchGetSharedTokens][ntt.watchdog.v1alpha.BatchGetSharedTokens]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.SharedToken

names
repeated string

Names of SharedTokens

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetSharedTokensResponse

BatchGetSharedTokensResponse

Fields
shared_tokens
repeated SharedToken

found SharedTokens

missing
repeated string

list of not found SharedTokens

ListSharedTokensRequest

Request message for method [ListSharedTokens][ntt.watchdog.v1alpha.ListSharedTokens]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.SharedToken

page_size
int32

Requested page size. Server may return fewer SharedTokens than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListSharedTokensResponse.next_page_token][ntt.watchdog.v1alpha.ListSharedTokensResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListSharedTokensResponse

Request message for method [ListSharedTokens][ntt.watchdog.v1alpha.ListSharedTokens]

Fields
shared_tokens
repeated SharedToken

The list of SharedTokens

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListSharedTokensRequest.page_token][ntt.watchdog.v1alpha.ListSharedTokensRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListSharedTokensRequest.page_token][ntt.watchdog.v1alpha.ListSharedTokensRequest.page_token]

WatchSharedTokenRequest

Request message for method [WatchSharedToken][ntt.watchdog.v1alpha.WatchSharedToken]

Fields
name
string

Reference to ntt.watchdog.v1alpha.SharedToken

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchSharedTokenResponse

WatchSharedTokenResponse

Fields
change
SharedTokenChange
WatchSharedTokensRequest

Request message for method [WatchSharedTokens][ntt.watchdog.v1alpha.WatchSharedTokens]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.SharedToken

page_size
int32

Requested page size. Server may return fewer SharedTokens than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to SharedToken that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to SharedToken that don't affect any of masked fields won't be sent back.

WatchSharedTokensResponse

WatchSharedTokensResponse

Fields
shared_token_changes
repeated SharedTokenChange

Changes of SharedTokens

page_token_change
WatchSharedTokensResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchSharedTokensResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateSharedTokenRequest

Request message for method [CreateSharedToken][ntt.watchdog.v1alpha.CreateSharedToken]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.SharedToken

shared_token
SharedToken

SharedToken resource body

UpdateSharedTokenRequest

Request message for method [UpdateSharedToken][ntt.watchdog.v1alpha.UpdateSharedToken]

Fields
shared_token
SharedToken

SharedToken resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteSharedTokenRequest

Request message for method [DeleteSharedToken][ntt.watchdog.v1alpha.DeleteSharedToken]

Fields
name
string

Reference of ntt.watchdog.v1alpha.SharedToken

RegisterProbeRequest

Request message for method [RegisterProbe][ntt.watchdog.v1alpha.RegisterProbe]

Fields
name
string

reference of ntt.watchdog.v1alpha.SharedToken

values
string

Key value pairs to be used to substitute placeholders in template values.

status
Probe.Status

The current probe status.

RegisterProbeResponse

Response message for method [RegisterProbe][ntt.watchdog.v1alpha.RegisterProbe]

Fields
service_account
.ntt.api.ServiceAccount

The service account generated for the request.

probe
string

The name of probe generated for the request.

InternetQualityRating

InternetQualityRating Resource

Fields
name
string

Name of InternetQualityRating

rating
InternetQualityRating.Rating
timestamp
.google.protobuf.Timestamp

Operations

GetInternetQualityRating
rpc GetInternetQualityRating(GetInternetQualityRatingRequest) returns (InternetQualityRating)

GetInternetQualityRating

BatchGetInternetQualityRatings
rpc BatchGetInternetQualityRatings(BatchGetInternetQualityRatingsRequest) returns (BatchGetInternetQualityRatingsResponse)

BatchGetInternetQualityRatings

ListInternetQualityRatings
rpc ListInternetQualityRatings(ListInternetQualityRatingsRequest) returns (ListInternetQualityRatingsResponse)

ListInternetQualityRatings

WatchInternetQualityRating
rpc WatchInternetQualityRating(WatchInternetQualityRatingRequest) returns (WatchInternetQualityRatingResponse)

WatchInternetQualityRating

WatchInternetQualityRatings
rpc WatchInternetQualityRatings(WatchInternetQualityRatingsRequest) returns (WatchInternetQualityRatingsResponse)

WatchInternetQualityRatings

CreateInternetQualityRating
rpc CreateInternetQualityRating(CreateInternetQualityRatingRequest) returns (InternetQualityRating)

CreateInternetQualityRating

UpdateInternetQualityRating
rpc UpdateInternetQualityRating(UpdateInternetQualityRatingRequest) returns (InternetQualityRating)

UpdateInternetQualityRating

DeleteInternetQualityRating
rpc DeleteInternetQualityRating(DeleteInternetQualityRatingRequest) returns (Empty)

DeleteInternetQualityRating

Messages

GetInternetQualityRatingRequest

Request message for method [GetInternetQualityRating][ntt.watchdog.v1alpha.GetInternetQualityRating]

Fields
name
string

Reference of ntt.watchdog.v1alpha.InternetQualityRating

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetInternetQualityRatingsRequest

Request message for method [BatchGetInternetQualityRatings][ntt.watchdog.v1alpha.BatchGetInternetQualityRatings]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.InternetQualityRating

names
repeated string

Names of InternetQualityRatings

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetInternetQualityRatingsResponse

BatchGetInternetQualityRatingsResponse

Fields
internet_quality_ratings
repeated InternetQualityRating

found InternetQualityRatings

missing
repeated string

list of not found InternetQualityRatings

ListInternetQualityRatingsRequest

Request message for method [ListInternetQualityRatings][ntt.watchdog.v1alpha.ListInternetQualityRatings]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.InternetQualityRating

page_size
int32

Requested page size. Server may return fewer InternetQualityRatings than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListInternetQualityRatingsResponse.next_page_token][ntt.watchdog.v1alpha.ListInternetQualityRatingsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListInternetQualityRatingsResponse

Request message for method [ListInternetQualityRatings][ntt.watchdog.v1alpha.ListInternetQualityRatings]

Fields
internet_quality_ratings
repeated InternetQualityRating

The list of InternetQualityRatings

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListInternetQualityRatingsRequest.page_token][ntt.watchdog.v1alpha.ListInternetQualityRatingsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListInternetQualityRatingsRequest.page_token][ntt.watchdog.v1alpha.ListInternetQualityRatingsRequest.page_token]

WatchInternetQualityRatingRequest

Request message for method [WatchInternetQualityRating][ntt.watchdog.v1alpha.WatchInternetQualityRating]

Fields
name
string

Reference to ntt.watchdog.v1alpha.InternetQualityRating

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchInternetQualityRatingResponse

WatchInternetQualityRatingResponse

Fields
change
InternetQualityRatingChange
WatchInternetQualityRatingsRequest

Request message for method [WatchInternetQualityRatings][ntt.watchdog.v1alpha.WatchInternetQualityRatings]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.InternetQualityRating

page_size
int32

Requested page size. Server may return fewer InternetQualityRatings than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to InternetQualityRating that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to InternetQualityRating that don't affect any of masked fields won't be sent back.

WatchInternetQualityRatingsResponse

WatchInternetQualityRatingsResponse

Fields
internet_quality_rating_changes
repeated InternetQualityRatingChange

Changes of InternetQualityRatings

page_token_change
WatchInternetQualityRatingsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchInternetQualityRatingsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateInternetQualityRatingRequest

Request message for method [CreateInternetQualityRating][ntt.watchdog.v1alpha.CreateInternetQualityRating]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.InternetQualityRating

internet_quality_rating
InternetQualityRating

InternetQualityRating resource body

UpdateInternetQualityRatingRequest

Request message for method [UpdateInternetQualityRating][ntt.watchdog.v1alpha.UpdateInternetQualityRating]

Fields
internet_quality_rating
InternetQualityRating

InternetQualityRating resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteInternetQualityRatingRequest

Request message for method [DeleteInternetQualityRating][ntt.watchdog.v1alpha.DeleteInternetQualityRating]

Fields
name
string

Reference of ntt.watchdog.v1alpha.InternetQualityRating

Enums

InternetQualityRating.Rating
Values
RATING_UNSPECIFIED
BAD
POOR
FAIR
GOOD
EXCELLENT

ProbingTargetGroup

ProbingTargetGroup Resource

Fields
name
string

Name of ProbingTargetGroup

display_name
string

Human-readable name

state
ProbingTargetGroup.State

state of group

Operations

GetProbingTargetGroup
rpc GetProbingTargetGroup(GetProbingTargetGroupRequest) returns (ProbingTargetGroup)

GetProbingTargetGroup

BatchGetProbingTargetGroups
rpc BatchGetProbingTargetGroups(BatchGetProbingTargetGroupsRequest) returns (BatchGetProbingTargetGroupsResponse)

BatchGetProbingTargetGroups

ListProbingTargetGroups
rpc ListProbingTargetGroups(ListProbingTargetGroupsRequest) returns (ListProbingTargetGroupsResponse)

ListProbingTargetGroups

WatchProbingTargetGroup
rpc WatchProbingTargetGroup(WatchProbingTargetGroupRequest) returns (WatchProbingTargetGroupResponse)

WatchProbingTargetGroup

WatchProbingTargetGroups
rpc WatchProbingTargetGroups(WatchProbingTargetGroupsRequest) returns (WatchProbingTargetGroupsResponse)

WatchProbingTargetGroups

CreateProbingTargetGroup
rpc CreateProbingTargetGroup(CreateProbingTargetGroupRequest) returns (ProbingTargetGroup)

CreateProbingTargetGroup

UpdateProbingTargetGroup
rpc UpdateProbingTargetGroup(UpdateProbingTargetGroupRequest) returns (ProbingTargetGroup)

UpdateProbingTargetGroup

DeleteProbingTargetGroup
rpc DeleteProbingTargetGroup(DeleteProbingTargetGroupRequest) returns (Empty)

DeleteProbingTargetGroup

Messages

ProbingTargetGroup.State

Group State

Fields
target_count
int64

total count of [ProbingTargets][ntt.watchdog.v1alpha.ProbingTarget] associated with this group

GetProbingTargetGroupRequest

Request message for method [GetProbingTargetGroup][ntt.watchdog.v1alpha.GetProbingTargetGroup]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbingTargetGroup

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbingTargetGroupsRequest

Request message for method [BatchGetProbingTargetGroups][ntt.watchdog.v1alpha.BatchGetProbingTargetGroups]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.ProbingTargetGroup

names
repeated string

Names of ProbingTargetGroups

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbingTargetGroupsResponse

BatchGetProbingTargetGroupsResponse

Fields
probing_target_groups
repeated ProbingTargetGroup

found ProbingTargetGroups

missing
repeated string

list of not found ProbingTargetGroups

ListProbingTargetGroupsRequest

Request message for method [ListProbingTargetGroups][ntt.watchdog.v1alpha.ListProbingTargetGroups]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.ProbingTargetGroup

page_size
int32

Requested page size. Server may return fewer ProbingTargetGroups than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProbingTargetGroupsResponse.next_page_token][ntt.watchdog.v1alpha.ListProbingTargetGroupsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProbingTargetGroupsResponse

Request message for method [ListProbingTargetGroups][ntt.watchdog.v1alpha.ListProbingTargetGroups]

Fields
probing_target_groups
repeated ProbingTargetGroup

The list of ProbingTargetGroups

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProbingTargetGroupsRequest.page_token][ntt.watchdog.v1alpha.ListProbingTargetGroupsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProbingTargetGroupsRequest.page_token][ntt.watchdog.v1alpha.ListProbingTargetGroupsRequest.page_token]

WatchProbingTargetGroupRequest

Request message for method [WatchProbingTargetGroup][ntt.watchdog.v1alpha.WatchProbingTargetGroup]

Fields
name
string

Reference to ntt.watchdog.v1alpha.ProbingTargetGroup

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProbingTargetGroupResponse

WatchProbingTargetGroupResponse

Fields
change
ProbingTargetGroupChange
WatchProbingTargetGroupsRequest

Request message for method [WatchProbingTargetGroups][ntt.watchdog.v1alpha.WatchProbingTargetGroups]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbingTargetGroup

page_size
int32

Requested page size. Server may return fewer ProbingTargetGroups than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to ProbingTargetGroup that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to ProbingTargetGroup that don't affect any of masked fields won't be sent back.

WatchProbingTargetGroupsResponse

WatchProbingTargetGroupsResponse

Fields
probing_target_group_changes
repeated ProbingTargetGroupChange

Changes of ProbingTargetGroups

page_token_change
WatchProbingTargetGroupsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProbingTargetGroupsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProbingTargetGroupRequest

Request message for method [CreateProbingTargetGroup][ntt.watchdog.v1alpha.CreateProbingTargetGroup]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbingTargetGroup

probing_target_group
ProbingTargetGroup

ProbingTargetGroup resource body

UpdateProbingTargetGroupRequest

Request message for method [UpdateProbingTargetGroup][ntt.watchdog.v1alpha.UpdateProbingTargetGroup]

Fields
probing_target_group
ProbingTargetGroup

ProbingTargetGroup resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProbingTargetGroupRequest

Request message for method [DeleteProbingTargetGroup][ntt.watchdog.v1alpha.DeleteProbingTargetGroup]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbingTargetGroup

ProbingTarget

ProbingTarget Resource

Fields
name
string

Name of ProbingTarget

display_name
string

Display name is a human readable representation of the target

metadata
.ntt.types.Meta

Metadata

group
string

group reference

mode
ProbingMode

mode defines the mode for this probe target - icmp/udp/http/tcp

ip_version
IpVersion

ip_version defines which IP version should be used.

address
string

address is the actual target for the probe - IP addreses/http endpoint

category
string

Additional Category Name to enrich data

location_type
LocationType

Target location type

location
Location

Specific location if applicable

probing_constraint
ProbingConstraint

per-target constraints

default_probing_settings
ProbingSettings

Default Probing Settings like interval, tos, window size, path probing

Operations

GetProbingTarget
rpc GetProbingTarget(GetProbingTargetRequest) returns (ProbingTarget)

GetProbingTarget

BatchGetProbingTargets
rpc BatchGetProbingTargets(BatchGetProbingTargetsRequest) returns (BatchGetProbingTargetsResponse)

BatchGetProbingTargets

ListProbingTargets
rpc ListProbingTargets(ListProbingTargetsRequest) returns (ListProbingTargetsResponse)

ListProbingTargets

WatchProbingTarget
rpc WatchProbingTarget(WatchProbingTargetRequest) returns (WatchProbingTargetResponse)

WatchProbingTarget

WatchProbingTargets
rpc WatchProbingTargets(WatchProbingTargetsRequest) returns (WatchProbingTargetsResponse)

WatchProbingTargets

CreateProbingTarget
rpc CreateProbingTarget(CreateProbingTargetRequest) returns (ProbingTarget)

CreateProbingTarget

UpdateProbingTarget
rpc UpdateProbingTarget(UpdateProbingTargetRequest) returns (ProbingTarget)

UpdateProbingTarget

DeleteProbingTarget
rpc DeleteProbingTarget(DeleteProbingTargetRequest) returns (Empty)

DeleteProbingTarget

Messages

GetProbingTargetRequest

Request message for method [GetProbingTarget][ntt.watchdog.v1alpha.GetProbingTarget]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbingTarget

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbingTargetsRequest

Request message for method [BatchGetProbingTargets][ntt.watchdog.v1alpha.BatchGetProbingTargets]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.ProbingTarget

names
repeated string

Names of ProbingTargets

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbingTargetsResponse

BatchGetProbingTargetsResponse

Fields
probing_targets
repeated ProbingTarget

found ProbingTargets

missing
repeated string

list of not found ProbingTargets

ListProbingTargetsRequest

Request message for method [ListProbingTargets][ntt.watchdog.v1alpha.ListProbingTargets]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.ProbingTarget

page_size
int32

Requested page size. Server may return fewer ProbingTargets than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProbingTargetsResponse.next_page_token][ntt.watchdog.v1alpha.ListProbingTargetsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProbingTargetsResponse

Request message for method [ListProbingTargets][ntt.watchdog.v1alpha.ListProbingTargets]

Fields
probing_targets
repeated ProbingTarget

The list of ProbingTargets

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProbingTargetsRequest.page_token][ntt.watchdog.v1alpha.ListProbingTargetsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProbingTargetsRequest.page_token][ntt.watchdog.v1alpha.ListProbingTargetsRequest.page_token]

WatchProbingTargetRequest

Request message for method [WatchProbingTarget][ntt.watchdog.v1alpha.WatchProbingTarget]

Fields
name
string

Reference to ntt.watchdog.v1alpha.ProbingTarget

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProbingTargetResponse

WatchProbingTargetResponse

Fields
change
ProbingTargetChange
WatchProbingTargetsRequest

Request message for method [WatchProbingTargets][ntt.watchdog.v1alpha.WatchProbingTargets]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbingTarget

page_size
int32

Requested page size. Server may return fewer ProbingTargets than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to ProbingTarget that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to ProbingTarget that don't affect any of masked fields won't be sent back.

WatchProbingTargetsResponse

WatchProbingTargetsResponse

Fields
probing_target_changes
repeated ProbingTargetChange

Changes of ProbingTargets

page_token_change
WatchProbingTargetsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProbingTargetsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProbingTargetRequest

Request message for method [CreateProbingTarget][ntt.watchdog.v1alpha.CreateProbingTarget]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbingTarget

probing_target
ProbingTarget

ProbingTarget resource body

UpdateProbingTargetRequest

Request message for method [UpdateProbingTarget][ntt.watchdog.v1alpha.UpdateProbingTarget]

Fields
probing_target
ProbingTarget

ProbingTarget resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProbingTargetRequest

Request message for method [DeleteProbingTarget][ntt.watchdog.v1alpha.DeleteProbingTarget]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbingTarget

ProbingConfig

A ProbingConfig defines a configuration for a Probe to check a probing target. ProbingConfigs are usually automatically generaated from ProbingDistributions.

Fields
name
string

Name of ProbingConfig

display_name
string

Display name of ProbingConfig

metadata
.ntt.types.Meta

metadata describes additional information of the probing config.

spec
ProbingConfig.Spec

spec describes the to-be state of the probing config.

status
ProbingConfig.Status

status shows the current status of the probing config.

Operations

GetProbingConfig
rpc GetProbingConfig(GetProbingConfigRequest) returns (ProbingConfig)

GetProbingConfig

BatchGetProbingConfigs
rpc BatchGetProbingConfigs(BatchGetProbingConfigsRequest) returns (BatchGetProbingConfigsResponse)

BatchGetProbingConfigs

ListProbingConfigs
rpc ListProbingConfigs(ListProbingConfigsRequest) returns (ListProbingConfigsResponse)

ListProbingConfigs

WatchProbingConfig
rpc WatchProbingConfig(WatchProbingConfigRequest) returns (WatchProbingConfigResponse)

WatchProbingConfig

WatchProbingConfigs
rpc WatchProbingConfigs(WatchProbingConfigsRequest) returns (WatchProbingConfigsResponse)

WatchProbingConfigs

CreateProbingConfig
rpc CreateProbingConfig(CreateProbingConfigRequest) returns (ProbingConfig)

CreateProbingConfig

UpdateProbingConfig
rpc UpdateProbingConfig(UpdateProbingConfigRequest) returns (ProbingConfig)

UpdateProbingConfig

DeleteProbingConfig
rpc DeleteProbingConfig(DeleteProbingConfigRequest) returns (Empty)

DeleteProbingConfig

Messages

ProbingConfig.Spec

describes how to probe a target

Fields
probe
string

probe is the probe resource which is expexted to execute the probe config.

probing_sessions
repeated ProbingSession

probing target defines a single probe destination target.

speedtest
ProbingConfig.Spec.SpeedTest
ProbingConfig.Spec.SpeedTest
Fields
enabled
bool

enabled defines whether to enable or disable the speedtest

interval_minutes
int64

(deprecated) interval_minutes defines the periodic interval for repeating speedtest

interval
.google.protobuf.Duration

interval defines the periodic interval for repeating speedtest

servers
repeated ProbingConfig.Spec.SpeedTest.Server

servers list down all the available servers for speedtest. The agent chooses the active server nearest to it for running the test This might be a temporary api and we might have a discovery api later

ProbingConfig.Spec.SpeedTest.Server

Server defines the information about a speedtest server

Fields
name
string

label or name of the server to use for speedtest

ip_addresses
repeated string

Could be a dns name or ip addresses. can provide both v4 and v6 addresses

location
Location

Location of the server. For now the agent would choose the nearest server

ProbingConfig.Status
Fields
none
GetProbingConfigRequest

Request message for method [GetProbingConfig][ntt.watchdog.v1alpha.GetProbingConfig]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbingConfig

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbingConfigsRequest

Request message for method [BatchGetProbingConfigs][ntt.watchdog.v1alpha.BatchGetProbingConfigs]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.ProbingConfig

names
repeated string

Names of ProbingConfigs

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbingConfigsResponse

BatchGetProbingConfigsResponse

Fields
probing_configs
repeated ProbingConfig

found ProbingConfigs

missing
repeated string

list of not found ProbingConfigs

ListProbingConfigsRequest

Request message for method [ListProbingConfigs][ntt.watchdog.v1alpha.ListProbingConfigs]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.ProbingConfig

page_size
int32

Requested page size. Server may return fewer ProbingConfigs than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProbingConfigsResponse.next_page_token][ntt.watchdog.v1alpha.ListProbingConfigsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProbingConfigsResponse

Request message for method [ListProbingConfigs][ntt.watchdog.v1alpha.ListProbingConfigs]

Fields
probing_configs
repeated ProbingConfig

The list of ProbingConfigs

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProbingConfigsRequest.page_token][ntt.watchdog.v1alpha.ListProbingConfigsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProbingConfigsRequest.page_token][ntt.watchdog.v1alpha.ListProbingConfigsRequest.page_token]

WatchProbingConfigRequest

Request message for method [WatchProbingConfig][ntt.watchdog.v1alpha.WatchProbingConfig]

Fields
name
string

Reference to ntt.watchdog.v1alpha.ProbingConfig

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProbingConfigResponse

WatchProbingConfigResponse

Fields
change
ProbingConfigChange
WatchProbingConfigsRequest

Request message for method [WatchProbingConfigs][ntt.watchdog.v1alpha.WatchProbingConfigs]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbingConfig

page_size
int32

Requested page size. Server may return fewer ProbingConfigs than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to ProbingConfig that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to ProbingConfig that don't affect any of masked fields won't be sent back.

WatchProbingConfigsResponse

WatchProbingConfigsResponse

Fields
probing_config_changes
repeated ProbingConfigChange

Changes of ProbingConfigs

page_token_change
WatchProbingConfigsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProbingConfigsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProbingConfigRequest

Request message for method [CreateProbingConfig][ntt.watchdog.v1alpha.CreateProbingConfig]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbingConfig

probing_config
ProbingConfig

ProbingConfig resource body

UpdateProbingConfigRequest

Request message for method [UpdateProbingConfig][ntt.watchdog.v1alpha.UpdateProbingConfig]

Fields
probing_config
ProbingConfig

ProbingConfig resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProbingConfigRequest

Request message for method [DeleteProbingConfig][ntt.watchdog.v1alpha.DeleteProbingConfig]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbingConfig

ProbingDistribution

ProbingDistribution defines ProbingConfigs that will be applied to mutiple Probes.

Fields
name
string

Name of ProbingDistribution

display_name
string

Display Name

metadata
.ntt.types.Meta

Metadata

spec
ProbingDistribution.Spec

Spec

status
ProbingDistribution.Status

Status

Operations

GetProbingDistribution
rpc GetProbingDistribution(GetProbingDistributionRequest) returns (ProbingDistribution)

GetProbingDistribution

BatchGetProbingDistributions
rpc BatchGetProbingDistributions(BatchGetProbingDistributionsRequest) returns (BatchGetProbingDistributionsResponse)

BatchGetProbingDistributions

ListProbingDistributions
rpc ListProbingDistributions(ListProbingDistributionsRequest) returns (ListProbingDistributionsResponse)

ListProbingDistributions

WatchProbingDistribution
rpc WatchProbingDistribution(WatchProbingDistributionRequest) returns (WatchProbingDistributionResponse)

WatchProbingDistribution

WatchProbingDistributions
rpc WatchProbingDistributions(WatchProbingDistributionsRequest) returns (WatchProbingDistributionsResponse)

WatchProbingDistributions

CreateProbingDistribution
rpc CreateProbingDistribution(CreateProbingDistributionRequest) returns (ProbingDistribution)

CreateProbingDistribution

UpdateProbingDistribution
rpc UpdateProbingDistribution(UpdateProbingDistributionRequest) returns (ProbingDistribution)

UpdateProbingDistribution

DeleteProbingDistribution
rpc DeleteProbingDistribution(DeleteProbingDistributionRequest) returns (Empty)

DeleteProbingDistribution

Messages

ProbingDistribution.Spec

Spec

Fields
enabled
bool

In order to effectively distribute targets to probes this flag must be set

probe_selector
string

Probe selector is a filter used to select Agents to distribute targets to

Examples:

  • specific agent group: spec.probe_group = "projects/xyz/probeGroups/infra"
  • tags: metadata.tags CONTAINS "vpn-65552"
  • only deploy to probes in USA: status.active_location.admin_hierarchy.country = "adminAreas/US"

See [Probe definition][ntt.watchdog.v1alpha.Probe] for full reference.

target_selector
string

Target filter is a filter used to select targets for distribution

Examples:

  • specific target group: group = "projects/xyz/probingTargetGroups/public-cdns"
  • speed tests: mode = "SPEED_TEST"

See [ProbingTarget][ntt.watchdog.v1alpha.ProbingTarget] for full reference.

constraint
ProbingConstraint

Additional distribution constraints. Allows limiting the number of agents probing within geographical location or site (public ip) in order to:

  • avoid unnecessary cost after securing reasonable sample size; or
  • getting blocked from publicly available service.
probing_settings
ProbingSettings

Settings include session overrides. All settings are optional. Only present settings are overridden

ProbingDistribution.Status

Status

Fields
total_number
int64

total number of probes that have been assigned to this distribution.

GetProbingDistributionRequest

Request message for method [GetProbingDistribution][ntt.watchdog.v1alpha.GetProbingDistribution]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbingDistribution

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbingDistributionsRequest

Request message for method [BatchGetProbingDistributions][ntt.watchdog.v1alpha.BatchGetProbingDistributions]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.ProbingDistribution

names
repeated string

Names of ProbingDistributions

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetProbingDistributionsResponse

BatchGetProbingDistributionsResponse

Fields
probing_distributions
repeated ProbingDistribution

found ProbingDistributions

missing
repeated string

list of not found ProbingDistributions

ListProbingDistributionsRequest

Request message for method [ListProbingDistributions][ntt.watchdog.v1alpha.ListProbingDistributions]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.ProbingDistribution

page_size
int32

Requested page size. Server may return fewer ProbingDistributions than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListProbingDistributionsResponse.next_page_token][ntt.watchdog.v1alpha.ListProbingDistributionsResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListProbingDistributionsResponse

Request message for method [ListProbingDistributions][ntt.watchdog.v1alpha.ListProbingDistributions]

Fields
probing_distributions
repeated ProbingDistribution

The list of ProbingDistributions

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListProbingDistributionsRequest.page_token][ntt.watchdog.v1alpha.ListProbingDistributionsRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListProbingDistributionsRequest.page_token][ntt.watchdog.v1alpha.ListProbingDistributionsRequest.page_token]

WatchProbingDistributionRequest

Request message for method [WatchProbingDistribution][ntt.watchdog.v1alpha.WatchProbingDistribution]

Fields
name
string

Reference to ntt.watchdog.v1alpha.ProbingDistribution

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchProbingDistributionResponse

WatchProbingDistributionResponse

Fields
change
ProbingDistributionChange
WatchProbingDistributionsRequest

Request message for method [WatchProbingDistributions][ntt.watchdog.v1alpha.WatchProbingDistributions]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbingDistribution

page_size
int32

Requested page size. Server may return fewer ProbingDistributions than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to ProbingDistribution that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to ProbingDistribution that don't affect any of masked fields won't be sent back.

WatchProbingDistributionsResponse

WatchProbingDistributionsResponse

Fields
probing_distribution_changes
repeated ProbingDistributionChange

Changes of ProbingDistributions

page_token_change
WatchProbingDistributionsResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchProbingDistributionsResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateProbingDistributionRequest

Request message for method [CreateProbingDistribution][ntt.watchdog.v1alpha.CreateProbingDistribution]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.ProbingDistribution

probing_distribution
ProbingDistribution

ProbingDistribution resource body

UpdateProbingDistributionRequest

Request message for method [UpdateProbingDistribution][ntt.watchdog.v1alpha.UpdateProbingDistribution]

Fields
probing_distribution
ProbingDistribution

ProbingDistribution resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteProbingDistributionRequest

Request message for method [DeleteProbingDistribution][ntt.watchdog.v1alpha.DeleteProbingDistribution]

Fields
name
string

Reference of ntt.watchdog.v1alpha.ProbingDistribution

QualityProfile

QualityProfile Resource

Fields
name
string

Name of QualityProfile

display_name
string
description
string
source_project
string
profiles
repeated Profile

list of root-level profiles.

Operations

GetQualityProfile
rpc GetQualityProfile(GetQualityProfileRequest) returns (QualityProfile)

GetQualityProfile

BatchGetQualityProfiles
rpc BatchGetQualityProfiles(BatchGetQualityProfilesRequest) returns (BatchGetQualityProfilesResponse)

BatchGetQualityProfiles

ListQualityProfiles
rpc ListQualityProfiles(ListQualityProfilesRequest) returns (ListQualityProfilesResponse)

ListQualityProfiles

WatchQualityProfile
rpc WatchQualityProfile(WatchQualityProfileRequest) returns (WatchQualityProfileResponse)

WatchQualityProfile

WatchQualityProfiles
rpc WatchQualityProfiles(WatchQualityProfilesRequest) returns (WatchQualityProfilesResponse)

WatchQualityProfiles

CreateQualityProfile
rpc CreateQualityProfile(CreateQualityProfileRequest) returns (QualityProfile)

CreateQualityProfile

UpdateQualityProfile
rpc UpdateQualityProfile(UpdateQualityProfileRequest) returns (QualityProfile)

UpdateQualityProfile

DeleteQualityProfile
rpc DeleteQualityProfile(DeleteQualityProfileRequest) returns (Empty)

DeleteQualityProfile

Messages

GetQualityProfileRequest

Request message for method [GetQualityProfile][ntt.watchdog.v1alpha.GetQualityProfile]

Fields
name
string

Reference of ntt.watchdog.v1alpha.QualityProfile

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetQualityProfilesRequest

Request message for method [BatchGetQualityProfiles][ntt.watchdog.v1alpha.BatchGetQualityProfiles]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.QualityProfile

names
repeated string

Names of QualityProfiles

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetQualityProfilesResponse

BatchGetQualityProfilesResponse

Fields
quality_profiles
repeated QualityProfile

found QualityProfiles

missing
repeated string

list of not found QualityProfiles

ListQualityProfilesRequest

Request message for method [ListQualityProfiles][ntt.watchdog.v1alpha.ListQualityProfiles]

Fields
parent
string

Parent name of ntt.watchdog.v1alpha.QualityProfile

page_size
int32

Requested page size. Server may return fewer QualityProfiles than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListQualityProfilesResponse.next_page_token][ntt.watchdog.v1alpha.ListQualityProfilesResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListQualityProfilesResponse

Request message for method [ListQualityProfiles][ntt.watchdog.v1alpha.ListQualityProfiles]

Fields
quality_profiles
repeated QualityProfile

The list of QualityProfiles

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListQualityProfilesRequest.page_token][ntt.watchdog.v1alpha.ListQualityProfilesRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListQualityProfilesRequest.page_token][ntt.watchdog.v1alpha.ListQualityProfilesRequest.page_token]

WatchQualityProfileRequest

Request message for method [WatchQualityProfile][ntt.watchdog.v1alpha.WatchQualityProfile]

Fields
name
string

Reference to ntt.watchdog.v1alpha.QualityProfile

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchQualityProfileResponse

WatchQualityProfileResponse

Fields
change
QualityProfileChange
WatchQualityProfilesRequest

Request message for method [WatchQualityProfiles][ntt.watchdog.v1alpha.WatchQualityProfiles]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.QualityProfile

page_size
int32

Requested page size. Server may return fewer QualityProfiles than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to QualityProfile that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to QualityProfile that don't affect any of masked fields won't be sent back.

WatchQualityProfilesResponse

WatchQualityProfilesResponse

Fields
quality_profile_changes
repeated QualityProfileChange

Changes of QualityProfiles

page_token_change
WatchQualityProfilesResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchQualityProfilesResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateQualityProfileRequest

Request message for method [CreateQualityProfile][ntt.watchdog.v1alpha.CreateQualityProfile]

Fields
parent
string

Parent reference of ntt.watchdog.v1alpha.QualityProfile

quality_profile
QualityProfile

QualityProfile resource body

UpdateQualityProfileRequest

Request message for method [UpdateQualityProfile][ntt.watchdog.v1alpha.UpdateQualityProfile]

Fields
quality_profile
QualityProfile

QualityProfile resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteQualityProfileRequest

Request message for method [DeleteQualityProfile][ntt.watchdog.v1alpha.DeleteQualityProfile]

Fields
name
string

Reference of ntt.watchdog.v1alpha.QualityProfile

AdminArea

AdminArea Resource

Fields
name
string

Name of AdminArea - uses stringified feature id

display_name
string

Display Name, e.g. United States

hierarchy
AdminHierarchy

hierarchy is populated with parent areas

type
AdminArea.Type

Admin Area type

label_geometry
Geometry

Label geometry - optional, but when present it's better to use it, rather than geometry.

geometry
Geometry

Geometry - center and bounding box

Operations

GetAdminArea
rpc GetAdminArea(GetAdminAreaRequest) returns (AdminArea)

GetAdminArea

BatchGetAdminAreas
rpc BatchGetAdminAreas(BatchGetAdminAreasRequest) returns (BatchGetAdminAreasResponse)

BatchGetAdminAreas

ListAdminAreas
rpc ListAdminAreas(ListAdminAreasRequest) returns (ListAdminAreasResponse)

ListAdminAreas

WatchAdminArea
rpc WatchAdminArea(WatchAdminAreaRequest) returns (WatchAdminAreaResponse)

WatchAdminArea

WatchAdminAreas
rpc WatchAdminAreas(WatchAdminAreasRequest) returns (WatchAdminAreasResponse)

WatchAdminAreas

CreateAdminArea
rpc CreateAdminArea(CreateAdminAreaRequest) returns (AdminArea)

CreateAdminArea

UpdateAdminArea
rpc UpdateAdminArea(UpdateAdminAreaRequest) returns (AdminArea)

UpdateAdminArea

DeleteAdminArea
rpc DeleteAdminArea(DeleteAdminAreaRequest) returns (Empty)

DeleteAdminArea

Messages

GetAdminAreaRequest

Request message for method [GetAdminArea][ntt.watchdog.v1alpha.GetAdminArea]

Fields
name
string

Reference of ntt.watchdog.v1alpha.AdminArea

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetAdminAreasRequest

Request message for method [BatchGetAdminAreas][ntt.watchdog.v1alpha.BatchGetAdminAreas]

Fields
parent
string

Optional parent ntt.watchdog.v1alpha.AdminArea

names
repeated string

Names of AdminAreas

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

BatchGetAdminAreasResponse

BatchGetAdminAreasResponse

Fields
admin_areas
repeated AdminArea

found AdminAreas

missing
repeated string

list of not found AdminAreas

ListAdminAreasRequest

Request message for method [ListAdminAreas][ntt.watchdog.v1alpha.ListAdminAreas]

Fields
page_size
int32

Requested page size. Server may return fewer AdminAreas than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return. Typically, this is the value of [ListAdminAreasResponse.next_page_token][ntt.watchdog.v1alpha.ListAdminAreasResponse.next_page_token]

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination list of field path with order directive, either 'asc' or 'desc'. If direction is not provided, 'asc' is assumed. e.g. "state.nested_field asc, state.something.else desc, theme"

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

skip_cache
bool

If true, server will skip checking if query result is present in it's cache

ListAdminAreasResponse

Request message for method [ListAdminAreas][ntt.watchdog.v1alpha.ListAdminAreas]

Fields
admin_areas
repeated AdminArea

The list of AdminAreas

prev_page_token
string

A token to retrieve previous page of results. Pass this value in the [ListAdminAreasRequest.page_token][ntt.watchdog.v1alpha.ListAdminAreasRequest.page_token]

next_page_token
string

A token to retrieve next page of results. Pass this value in the [ListAdminAreasRequest.page_token][ntt.watchdog.v1alpha.ListAdminAreasRequest.page_token]

WatchAdminAreaRequest

Request message for method [WatchAdminArea][ntt.watchdog.v1alpha.WatchAdminArea]

Fields
name
string

Reference to ntt.watchdog.v1alpha.AdminArea

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask

WatchAdminAreaResponse

WatchAdminAreaResponse

Fields
change
AdminAreaChange
WatchAdminAreasRequest

Request message for method [WatchAdminAreas][ntt.watchdog.v1alpha.WatchAdminAreas]

Fields
page_size
int32

Requested page size. Server may return fewer AdminAreas than requested. If unspecified, server will pick an appropriate default.

page_token
string

A token identifying a page of results the server should return.

order_by
string

Order By - https://cloud.google.com/apis/design/design_patterns#list_pagination

filter
string

Filter - filter results by field criteria. Simplified SQL-like syntax with following operators: <=, >=, =, !=, <, >, LIKE, CONTAINS (aliases CONTAIN, HAS, HAVE), IN, IS [NOT] NULL | NaN . Combine conditions with OR | AND example: 'meta.labels CONTAINS "severity:important" OR (state.last_error_time > "2018-11-15T10:00:00Z" AND state.status = "ERROR")'

field_mask
.google.protobuf.FieldMask

A list of extra fields to be obtained for each response item on top of fields defined by request field view Changes to AdminArea that don't affect any of masked fields won't be sent back.

view
.goten.view.View

View defines list of standard response fields present in response items. Additional fields can be amended by request field field_mask Changes to AdminArea that don't affect any of masked fields won't be sent back.

WatchAdminAreasResponse

WatchAdminAreasResponse

Fields
admin_area_changes
repeated AdminAreaChange

Changes of AdminAreas

page_token_change
WatchAdminAreasResponse.PageTokenChange

When present, PageTokens used for page navigation should be updated.

WatchAdminAreasResponse.PageTokenChange
Fields
prev_page_token
string

New token to retrieve previous page of results.

next_page_token
string

New token to retrieve next page of results.

CreateAdminAreaRequest

Request message for method [CreateAdminArea][ntt.watchdog.v1alpha.CreateAdminArea]

Fields
admin_area
AdminArea

AdminArea resource body

UpdateAdminAreaRequest

Request message for method [UpdateAdminArea][ntt.watchdog.v1alpha.UpdateAdminArea]

Fields
admin_area
AdminArea

AdminArea resource body

update_mask
.google.protobuf.FieldMask

FieldMask applied to request - change will be applied only for fields in the mask

DeleteAdminAreaRequest

Request message for method [DeleteAdminArea][ntt.watchdog.v1alpha.DeleteAdminArea]

Fields
name
string

Reference of ntt.watchdog.v1alpha.AdminArea

Enums

AdminArea.Type
Values
TYPE_UNSPECIFIED
CONTINENT
COUNTRY
ADMIN1
ADMIN2
ADMIN3
ADMIN4
ADMIN5

Shared Resources

Operations
ProbeStatus
rpc ProbeStatus(ProbeStatusRequest) returns (ProbeStatusResponse)

ProbeStatus

Activation
rpc Activation(ActivationRequest) returns (ActivationResponse)

Activation

ASInfo
Fields
asn
string

AS Number string example AS7018

name
string

AS Owner name example AT&T Services, Inc.

domain
string

Domain name example att.com

routes
repeated string

Routes exported from this ASN example 12.128.0.0/9

asn_type
string

ASN Owner type example isp(AT&T) / hosting(google)/ business (Amazon)

ActivationRequest

Request message for method [Activation][ntt.watchdog.v1alpha.Activation]

Fields
activate
ActivationRequest.Activate

onboard is sent by client. Depending on configured onboarding policy, response may be immediate or take a long time (manual confirmation)

confirm_activation
ActivationRequest.ConfirmActivation

ACK message is required to complete onboarding process

ActivationRequest.Activate
Fields
token
string

Token - either individual or shared

client_cookie
string

Random cookie string generated by client to identify its session

probe
Probe

Optional probe data (required when using shared token).

metadata
string

Additional key value pairs to be used to substitute placeholders of the probe generation template.

ActivationRequest.ConfirmActivation
Fields
client_cookie
string

Acknowledgment after receiving activation response. Confirmation is required, otherwise received previously ServiceAccountKey won't be usable

ActivationResponse

Response message for method [Activation][ntt.watchdog.v1alpha.Activation]

Fields
activated
ActivationResponse.Activated
confirm_activation_ack
ActivationResponse.ConfirmActivationAck

after receiving this message it's safe to close the onboarding stream

ActivationResponse.Activated
Fields
probe
Probe

Onboarded Probe resource

service_account_key
.ntt.iam.v1alpha.ServiceAccountKey

ServiceAccountKey to use with PrivateKeyData

ActivationResponse.ConfirmActivationAck
Fields
none
Address
Fields
postal_code
string

Postal code

country_code
string

Country code example US, JP

continent
string

Continent, e.g. North America, Asia

country
string

Country name example United States, Japan

admin_area1
string

Probe Location Administrative Area level 1 name, e.g. California (state), Chiba (prefecture)

admin_area2
string

Probe Location Administrative Area level 2 name, e.g. Santa Clara (county), Tateyama (town)

admin_area3
string

Probe Location Administrative Area level 3 name, e.g. Sunnyvale (city)

admin_area4
string

Probe Location Administrative Area level 4 name, e.g. Sunnyvale (city)

street_address
string

Street Address

AdminAreaChange

AdminAreaChange is used by Watch notifications Responses to describe change of single AdminArea One of Added, Modified, Removed

Fields
added
AdminAreaChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
AdminAreaChange.Modified

Modified is returned when watched document is modified

removed
AdminAreaChange.Removed

Removed is returned when AdminArea is deleted or leaves Query view

AdminAreaChange.Added

AdminArea has been added to query view

Fields
admin_area
AdminArea
view_index
int32

Integer describing index of added AdminArea in resulting query view.

AdminAreaChange.Modified

AdminArea changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified AdminArea

admin_area
AdminArea

New version of AdminArea or masked difference, depending on mask_changes instrumentation of issued [WatchAdminAreaRequest] or [WatchAdminAreasRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified AdminArea. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying AdminArea new index in resulting query view.

AdminAreaChange.Removed

Removed is returned when AdminArea is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed AdminArea index.

AdminHierarchy
Fields
continent
string
country
string
admin1
string
admin2
string
admin3
string
admin4
string
admin5
string
BBox
Fields
south_west
.google.type.LatLng
north_east
.google.type.LatLng
Carrier
Fields
name
string

Mobile network carrier name example AT&T

mobile_country_code
string

Mobile country code example 214

mobile_network_code
string

Mobile network code example 7

location_area_code
string

Mobile location area code example 2862

ContactInformation
Fields
full_name
string
email
string
phones
repeated ContactInformation.PhoneNumber
ContactInformation.PhoneNumber
Fields
number
string
type
ContactInformation.PhoneType
Geometry
Fields
center
.google.type.LatLng
bbox
BBox
InternetQualityRatingChange

InternetQualityRatingChange is used by Watch notifications Responses to describe change of single InternetQualityRating One of Added, Modified, Removed

Fields
added
InternetQualityRatingChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
InternetQualityRatingChange.Modified

Modified is returned when watched document is modified

removed
InternetQualityRatingChange.Removed

Removed is returned when InternetQualityRating is deleted or leaves Query view

InternetQualityRatingChange.Added

InternetQualityRating has been added to query view

Fields
internet_quality_rating
InternetQualityRating
view_index
int32

Integer describing index of added InternetQualityRating in resulting query view.

InternetQualityRatingChange.Modified

InternetQualityRating changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified InternetQualityRating

internet_quality_rating
InternetQualityRating

New version of InternetQualityRating or masked difference, depending on mask_changes instrumentation of issued [WatchInternetQualityRatingRequest] or [WatchInternetQualityRatingsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified InternetQualityRating. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying InternetQualityRating new index in resulting query view.

InternetQualityRatingChange.Removed

Removed is returned when InternetQualityRating is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed InternetQualityRating index.

Location

Location - address names the locations of Probes

Fields
address
Address

Address

admin_hierarchy
AdminHierarchy

Admin Area Hierarchy

coordinates
.google.type.LatLng

coordinates

accuracy
double

location accuracy in meters

LocationDiscoverySpec
Fields
type
LocationDiscoverySpec.Type

Location discovery type - use PREFER_PRIMARY if unspecified

required_accuracy
double

Discovered address won't be reported as Active, unless accuracy value is below or equal to this threshold When it's not set, 100m is used.

PathProbe

Path Tracing settings

Fields
enabled
bool
mode
ProbingMode
interval
.google.protobuf.Duration

interval

interval_sec
int64

(deprecated) interval in seconds

ProbeChange

ProbeChange is used by Watch notifications Responses to describe change of single Probe One of Added, Modified, Removed

Fields
added
ProbeChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProbeChange.Modified

Modified is returned when watched document is modified

removed
ProbeChange.Removed

Removed is returned when Probe is deleted or leaves Query view

ProbeChange.Added

Probe has been added to query view

Fields
probe
Probe
view_index
int32

Integer describing index of added Probe in resulting query view.

ProbeChange.Modified

Probe changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Probe

probe
Probe

New version of Probe or masked difference, depending on mask_changes instrumentation of issued [WatchProbeRequest] or [WatchProbesRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Probe. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Probe new index in resulting query view.

ProbeChange.Removed

Removed is returned when Probe is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Probe index.

ProbeGroupChange

ProbeGroupChange is used by Watch notifications Responses to describe change of single ProbeGroup One of Added, Modified, Removed

Fields
added
ProbeGroupChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProbeGroupChange.Modified

Modified is returned when watched document is modified

removed
ProbeGroupChange.Removed

Removed is returned when ProbeGroup is deleted or leaves Query view

ProbeGroupChange.Added

ProbeGroup has been added to query view

Fields
probe_group
ProbeGroup
view_index
int32

Integer describing index of added ProbeGroup in resulting query view.

ProbeGroupChange.Modified

ProbeGroup changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified ProbeGroup

probe_group
ProbeGroup

New version of ProbeGroup or masked difference, depending on mask_changes instrumentation of issued [WatchProbeGroupRequest] or [WatchProbeGroupsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified ProbeGroup. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying ProbeGroup new index in resulting query view.

ProbeGroupChange.Removed

Removed is returned when ProbeGroup is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed ProbeGroup index.

ProbeStatusRequest

Request message for method [ProbeStatus][ntt.watchdog.v1alpha.ProbeStatus]

Fields
serial_number
string

The serial number to query about

ProbeStatusResponse

Response message for method [ProbeStatus][ntt.watchdog.v1alpha.ProbeStatus]

Fields
serial_number
string

The serial number queried

last_heart_beat_time
.google.protobuf.Timestamp

The last heart beat time from the Device.

isp_name
string

ISP Name resolevd from the IP address of the Device. This value always comes from dynamic resolusion by the IP address of the device. Manual input for the Probe resource is not used. Empty when no Probe resource has been provisioned or not yet reported by the agent.

os_version
string

The current OS veresion of the Device reported by the agent (status.device_info.os_version). Empty when no Device resource has been provisioned.

hardware_name
string

The hardware name reported from the agent on the Device.

ProbingConfigChange

ProbingConfigChange is used by Watch notifications Responses to describe change of single ProbingConfig One of Added, Modified, Removed

Fields
added
ProbingConfigChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProbingConfigChange.Modified

Modified is returned when watched document is modified

removed
ProbingConfigChange.Removed

Removed is returned when ProbingConfig is deleted or leaves Query view

ProbingConfigChange.Added

ProbingConfig has been added to query view

Fields
probing_config
ProbingConfig
view_index
int32

Integer describing index of added ProbingConfig in resulting query view.

ProbingConfigChange.Modified

ProbingConfig changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified ProbingConfig

probing_config
ProbingConfig

New version of ProbingConfig or masked difference, depending on mask_changes instrumentation of issued [WatchProbingConfigRequest] or [WatchProbingConfigsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified ProbingConfig. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying ProbingConfig new index in resulting query view.

ProbingConfigChange.Removed

Removed is returned when ProbingConfig is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed ProbingConfig index.

ProbingConstraint

ProbingConstraints provides definition for per-target or per-distribution configuration

Fields
max_sessions_per_agent_location
ProbingConstraint.AdminHierachy

Limits distribution of probing targets not to exceed given sample size in location. Zero values are ignored.

max_sessions_per_agent_public_ip_address
int32

Limits number of sessions from same ip address (to avoid blacklisting). Zero is ignored.

ProbingConstraint.AdminHierachy
Fields
country
int32
admin1
int32
admin2
int32
admin3
int32
admin4
int32
ProbingDistributionChange

ProbingDistributionChange is used by Watch notifications Responses to describe change of single ProbingDistribution One of Added, Modified, Removed

Fields
added
ProbingDistributionChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProbingDistributionChange.Modified

Modified is returned when watched document is modified

removed
ProbingDistributionChange.Removed

Removed is returned when ProbingDistribution is deleted or leaves Query view

ProbingDistributionChange.Added

ProbingDistribution has been added to query view

Fields
probing_distribution
ProbingDistribution
view_index
int32

Integer describing index of added ProbingDistribution in resulting query view.

ProbingDistributionChange.Modified

ProbingDistribution changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified ProbingDistribution

probing_distribution
ProbingDistribution

New version of ProbingDistribution or masked difference, depending on mask_changes instrumentation of issued [WatchProbingDistributionRequest] or [WatchProbingDistributionsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified ProbingDistribution. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying ProbingDistribution new index in resulting query view.

ProbingDistributionChange.Removed

Removed is returned when ProbingDistribution is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed ProbingDistribution index.

ProbingSession

ProbingSession is target

Fields
target
string

Name of ProbingTarget

target_display_name
string

Display name is a human readable representation of the target

target_group
string

group reference

mode
ProbingMode

mode defines the mode for this probe target - icmp/udp/http/tcp

ip_version
IpVersion

ip_version defines which IP version should be used.

address
string

address is the actual target for the probe - IP addreses/http endpoint

group_name
string

Additional Group Name to enrich data.

category
string

Additional Category Name to enrich data

location_type
LocationType

Target location type

location
Location

Specific location if applicable

interval_sec
int64

(deprecated) Interval defines the interval of probing in seconds.

interval
.google.protobuf.Duration

Interval defines probing interval

tos
uint32s

TOS for ipv4 or Traffic class for ipv6. Don't set it (use defaults or distribution overrides)

window_size
uint32s

Window size. Don't set it (use default_settings or distribution overrides)

path_probing
PathProbe

Path Probing settings. Don't set it (use default_settings or distribution overrides)

ProbingSettings

ProbingSetting contains optional config per target

Fields
interval
.google.protobuf.Duration

probing interval (optional). If not specified, default target interval is used. minimal allowed interval is 100ms, default value is 30s.

tos
.google.protobuf.UInt32Value

TOS for ipv4 or Traffic class for ipv6.

window_size
.google.protobuf.UInt32Value

if present overrides target window_size.

path_probing
PathProbe

Path probing settings.

ProbingTargetChange

ProbingTargetChange is used by Watch notifications Responses to describe change of single ProbingTarget One of Added, Modified, Removed

Fields
added
ProbingTargetChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProbingTargetChange.Modified

Modified is returned when watched document is modified

removed
ProbingTargetChange.Removed

Removed is returned when ProbingTarget is deleted or leaves Query view

ProbingTargetChange.Added

ProbingTarget has been added to query view

Fields
probing_target
ProbingTarget
view_index
int32

Integer describing index of added ProbingTarget in resulting query view.

ProbingTargetChange.Modified

ProbingTarget changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified ProbingTarget

probing_target
ProbingTarget

New version of ProbingTarget or masked difference, depending on mask_changes instrumentation of issued [WatchProbingTargetRequest] or [WatchProbingTargetsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified ProbingTarget. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying ProbingTarget new index in resulting query view.

ProbingTargetChange.Removed

Removed is returned when ProbingTarget is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed ProbingTarget index.

ProbingTargetGroupChange

ProbingTargetGroupChange is used by Watch notifications Responses to describe change of single ProbingTargetGroup One of Added, Modified, Removed

Fields
added
ProbingTargetGroupChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProbingTargetGroupChange.Modified

Modified is returned when watched document is modified

removed
ProbingTargetGroupChange.Removed

Removed is returned when ProbingTargetGroup is deleted or leaves Query view

ProbingTargetGroupChange.Added

ProbingTargetGroup has been added to query view

Fields
probing_target_group
ProbingTargetGroup
view_index
int32

Integer describing index of added ProbingTargetGroup in resulting query view.

ProbingTargetGroupChange.Modified

ProbingTargetGroup changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified ProbingTargetGroup

probing_target_group
ProbingTargetGroup

New version of ProbingTargetGroup or masked difference, depending on mask_changes instrumentation of issued [WatchProbingTargetGroupRequest] or [WatchProbingTargetGroupsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified ProbingTargetGroup. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying ProbingTargetGroup new index in resulting query view.

ProbingTargetGroupChange.Removed

Removed is returned when ProbingTargetGroup is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed ProbingTargetGroup index.

Profile
Fields
display_name
string

Display Name

description
string

Optional explanation for this Profile

filter
Profile.Filter
metric_thresholds
repeated Profile.MetricThreshold

Collection of metric thresholds to describe state of network for this Profile, example:

overrides
repeated Profile

Overrides defines sub-profiles with more specific filters Note: each level filters must be guaranteed to non-overlapping and use more specific filter than its parent Example: Given parent with filter <<locations: , targets: <google.com,amazon.com,ntt.com>>, it's ok to specify overrides that slice by Prefecture, Source ISP, like <<locations: <Japan/Tokyo, Japan/Kyoto>, asns: <OCN, Docomo>, targets: <google.com,amazon.com,ntt.com>>; and <<locations: <Japan/Chiba>, asns: <OCN, Softbank>, targets: <google.com,amazon.com,ntt.com>> but not: <<locations: , asns: , targets: <google.com,amazon.com,ntt.com>>, since it might be overlapping OCN filter in Tokyo defined above</p> </td></tr> </tbody> </table>

Profile.Filter
Fields
source_locations
repeated Profile.Location
source_asn_names
repeated string
targets
repeated string
Profile.Location
Fields
country_name
string

Country name according to ISO 3166, e.g. "Japan", "United States"

administrative_area_level1_name
string

Administrative name level 1, e.g. "Chiba" (prefecture), "California" (state)

administrative_area_level2_name
string

Administrative name level 2, e.g. "San Mateo" (county) or "Tateyama" (town)

administrative_area_level3_name
string

Administrative name level 3, e.g. "Sunnyvale" (city)

Profile.MetricThreshold
Fields
aggregation_reducer
.ntt.monitoring.v3.Aggregation.Reducer

aggregation reducer for selected viewport and filter criteria. common reducers: REDUCE_MEAN, REDUCE_PERCENTILE_95, REDUCE_PERCENTILE_99

metric_type
string

Selected metric type. One of:

  • watchdog.ntt.com/probe/target/active
  • watchdog.ntt.com/probe/target/loss
  • watchdog.ntt.com/probe/target/latency
  • watchdog.ntt.com/probe/target/jitter
value
double

Threshold value of reduced metric

ProjectChange

ProjectChange is used by Watch notifications Responses to describe change of single Project One of Added, Modified, Removed

Fields
added
ProjectChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
ProjectChange.Modified

Modified is returned when watched document is modified

removed
ProjectChange.Removed

Removed is returned when Project is deleted or leaves Query view

ProjectChange.Added

Project has been added to query view

Fields
project
Project
view_index
int32

Integer describing index of added Project in resulting query view.

ProjectChange.Modified

Project changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Project

project
Project

New version of Project or masked difference, depending on mask_changes instrumentation of issued [WatchProjectRequest] or [WatchProjectsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Project. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Project new index in resulting query view.

ProjectChange.Removed

Removed is returned when Project is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Project index.

QualityProfileChange

QualityProfileChange is used by Watch notifications Responses to describe change of single QualityProfile One of Added, Modified, Removed

Fields
added
QualityProfileChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
QualityProfileChange.Modified

Modified is returned when watched document is modified

removed
QualityProfileChange.Removed

Removed is returned when QualityProfile is deleted or leaves Query view

QualityProfileChange.Added

QualityProfile has been added to query view

Fields
quality_profile
QualityProfile
view_index
int32

Integer describing index of added QualityProfile in resulting query view.

QualityProfileChange.Modified

QualityProfile changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified QualityProfile

quality_profile
QualityProfile

New version of QualityProfile or masked difference, depending on mask_changes instrumentation of issued [WatchQualityProfileRequest] or [WatchQualityProfilesRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified QualityProfile. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying QualityProfile new index in resulting query view.

QualityProfileChange.Removed

Removed is returned when QualityProfile is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed QualityProfile index.

SharedTokenChange

SharedTokenChange is used by Watch notifications Responses to describe change of single SharedToken One of Added, Modified, Removed

Fields
added
SharedTokenChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
SharedTokenChange.Modified

Modified is returned when watched document is modified

removed
SharedTokenChange.Removed

Removed is returned when SharedToken is deleted or leaves Query view

SharedTokenChange.Added

SharedToken has been added to query view

Fields
shared_token
SharedToken
view_index
int32

Integer describing index of added SharedToken in resulting query view.

SharedTokenChange.Modified

SharedToken changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified SharedToken

shared_token
SharedToken

New version of SharedToken or masked difference, depending on mask_changes instrumentation of issued [WatchSharedTokenRequest] or [WatchSharedTokensRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified SharedToken. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying SharedToken new index in resulting query view.

SharedTokenChange.Removed

Removed is returned when SharedToken is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed SharedToken index.

SoftwareVersion
Fields
version
string
commit_id
string
build_date
string
TagChange

TagChange is used by Watch notifications Responses to describe change of single Tag One of Added, Modified, Removed

Fields
added
TagChange.Added

Added is returned when watched document is added, either created or enters Query view

modified
TagChange.Modified

Modified is returned when watched document is modified

removed
TagChange.Removed

Removed is returned when Tag is deleted or leaves Query view

TagChange.Added

Tag has been added to query view

Fields
tag
Tag
view_index
int32

Integer describing index of added Tag in resulting query view.

TagChange.Modified

Tag changed some of it's fields - contains either full document or masked change

Fields
name
string

Name of modified Tag

tag
Tag

New version of Tag or masked difference, depending on mask_changes instrumentation of issued [WatchTagRequest] or [WatchTagsRequest]

field_mask
.google.protobuf.FieldMask

Used when mask_changes is set, contains field paths of modified properties.

previous_view_index
int32

Previous view index specifies previous position of modified Tag. When modification doesn't affect sorted order, value will remain identical to [view_index].

view_index
int32

Integer specifying Tag new index in resulting query view.

TagChange.Removed

Removed is returned when Tag is deleted or leaves Query view

Fields
name
string
view_index
int32

Integer specifying removed Tag index.

WLAN

WLAN

Fields
mac
string
signal
int32

Enums

ContactInformation.PhoneType
Values
UNSPECIFIED
MOBILE
HOME
WORK
IpVersion
Values
IP_VERSION_UNSPECIFIED
IPV4
IPV6
LocationDiscoverySpec.Type
Values
TYPE_UNSPECIFIED
ONLY_PRIMARY
PREFER_PRIMARY
PREFER_DISCOVERED
LocationType

Whether target is located in specific site, region or is globally distributed (anycast)

Values
LOCATION_TYPE_UNSPECIFIED
SITE
REGION
ANYCAST
ProbingMode
Values
PROBING_MODE_UNSPECIFIED
ICMP
HTTP
UDP
TCP
SPEED_TEST