com.google.irm.service.v1alpha2.api

Interface SearchIncidentsRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

SearchIncidentsRequest, SearchIncidentsRequest.Builder

public interface SearchIncidentsRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getPageSize() Number of incidents to return.
String	getPageToken() Page token from an earlier query, as returned in `next_page_token`.
ByteString	getPageTokenBytes() Page token from an earlier query, as returned in `next_page_token`.
String	getParent() Required.
ByteString	getParentBytes() Required.
String	getQuery() An expression that defines which incidents to return.
ByteString	getQueryBytes() An expression that defines which incidents to return.
String	getTimeZone() The time zone name.
ByteString	getTimeZoneBytes() The time zone name.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getParent

String getParent()

 Required. The resource name of the hosting Stackdriver project which requested
 incidents belong to.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The parent.

getParentBytes

ByteString getParentBytes()

 Required. The resource name of the hosting Stackdriver project which requested
 incidents belong to.
 

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns:

The bytes for parent.

getQuery

String getQuery()

 An expression that defines which incidents to return.
 Search atoms can be used to match certain specific fields.  Otherwise,
 plain text will match text fields in the incident.
 Search atoms:
 * `start` - (timestamp) The time the incident started.
 * `stage` - The stage of the incident, one of detected, triaged, mitigated,
   resolved, documented, or duplicate (which correspond to values in the
   Incident.Stage enum). These are ordered, so `stage<resolved` is
   equivalent to `stage:detected OR stage:triaged OR stage:mitigated`.
 * `severity` - (Incident.Severity) The severity of the incident.
    + Supports matching on a specific severity (for example,
    `severity:major`) or on a range (for example, `severity>medium`,
    `severity<=minor`, etc.).
 Timestamp formats:
 * yyyy-MM-dd - an absolute date, treated as a calendar-day-wide window.
   In other words, the "<" operator will match dates before that date, the
   ">" operator will match dates after that date, and the ":" or "="
   operators will match the entire day.
 * Nd (for example, 7d) - a relative number of days ago, treated as a moment
   in time (as opposed to a day-wide span). A multiple of 24 hours ago (as
   opposed to calendar days).  In the case of daylight savings time, it will
   apply the current timezone to both ends of the range.  Note that exact
   matching (for example, `start:7d`) is unlikely to be useful because that
   would only match incidents created precisely at a particular instant in
   time.
 Examples:
 * `foo` - matches incidents containing the word "foo"
 * `"foo bar"` - matches incidents containing the phrase "foo bar"
 * `foo bar` or `foo AND bar` - matches incidents containing the words "foo"
   and "bar"
 * `foo -bar` or `foo AND NOT bar` - matches incidents containing the word
   "foo" but not the word "bar"
 * `foo OR bar` - matches incidents containing the word "foo" or the word
   "bar"
 * `start>2018-11-28` - matches incidents which started after November 11,
   2018.
 * `start<=2018-11-28` - matches incidents which started on or before
   November 11, 2018.
 * `start:2018-11-28` - matches incidents which started on November 11,
   2018.
 * `start>7d` - matches incidents which started after the point in time 7*24
   hours ago
 * `start>180d` - similar to 7d, but likely to cross the daylight savings
   time boundary, so the end time will be 1 hour different from "now."
 * `foo AND start>90d AND stage<resolved` - unresolved incidents from the
   past 90 days containing the word "foo"
 

string query = 2;

Returns:

The query.

getQueryBytes

ByteString getQueryBytes()

 An expression that defines which incidents to return.
 Search atoms can be used to match certain specific fields.  Otherwise,
 plain text will match text fields in the incident.
 Search atoms:
 * `start` - (timestamp) The time the incident started.
 * `stage` - The stage of the incident, one of detected, triaged, mitigated,
   resolved, documented, or duplicate (which correspond to values in the
   Incident.Stage enum). These are ordered, so `stage<resolved` is
   equivalent to `stage:detected OR stage:triaged OR stage:mitigated`.
 * `severity` - (Incident.Severity) The severity of the incident.
    + Supports matching on a specific severity (for example,
    `severity:major`) or on a range (for example, `severity>medium`,
    `severity<=minor`, etc.).
 Timestamp formats:
 * yyyy-MM-dd - an absolute date, treated as a calendar-day-wide window.
   In other words, the "<" operator will match dates before that date, the
   ">" operator will match dates after that date, and the ":" or "="
   operators will match the entire day.
 * Nd (for example, 7d) - a relative number of days ago, treated as a moment
   in time (as opposed to a day-wide span). A multiple of 24 hours ago (as
   opposed to calendar days).  In the case of daylight savings time, it will
   apply the current timezone to both ends of the range.  Note that exact
   matching (for example, `start:7d`) is unlikely to be useful because that
   would only match incidents created precisely at a particular instant in
   time.
 Examples:
 * `foo` - matches incidents containing the word "foo"
 * `"foo bar"` - matches incidents containing the phrase "foo bar"
 * `foo bar` or `foo AND bar` - matches incidents containing the words "foo"
   and "bar"
 * `foo -bar` or `foo AND NOT bar` - matches incidents containing the word
   "foo" but not the word "bar"
 * `foo OR bar` - matches incidents containing the word "foo" or the word
   "bar"
 * `start>2018-11-28` - matches incidents which started after November 11,
   2018.
 * `start<=2018-11-28` - matches incidents which started on or before
   November 11, 2018.
 * `start:2018-11-28` - matches incidents which started on November 11,
   2018.
 * `start>7d` - matches incidents which started after the point in time 7*24
   hours ago
 * `start>180d` - similar to 7d, but likely to cross the daylight savings
   time boundary, so the end time will be 1 hour different from "now."
 * `foo AND start>90d AND stage<resolved` - unresolved incidents from the
   past 90 days containing the word "foo"
 

string query = 2;

Returns:

The bytes for query.

getPageSize

int getPageSize()

 Number of incidents to return.
 

int32 page_size = 3;

Returns:

The pageSize.

getPageToken

String getPageToken()

 Page token from an earlier query, as returned in `next_page_token`.
 

string page_token = 4;

Returns:

The pageToken.

getPageTokenBytes

ByteString getPageTokenBytes()

 Page token from an earlier query, as returned in `next_page_token`.
 

string page_token = 4;

Returns:

The bytes for pageToken.

getTimeZone

String getTimeZone()

 The time zone name. It should be an IANA TZ name, such as
 "America/Los_Angeles". For more information,
 see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
 If no time zone is specified, the default is UTC.
 

string time_zone = 5;

Returns:

The timeZone.

getTimeZoneBytes

ByteString getTimeZoneBytes()

 The time zone name. It should be an IANA TZ name, such as
 "America/Los_Angeles". For more information,
 see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.
 If no time zone is specified, the default is UTC.
 

string time_zone = 5;

Returns:

The bytes for timeZone.