com.google.irm.service.v1alpha2.api

Interface SearchSignalsRequestOrBuilder

All Superinterfaces:

MessageLiteOrBuilder, MessageOrBuilder

All Known Implementing Classes:

SearchSignalsRequest, SearchSignalsRequest.Builder

public interface SearchSignalsRequestOrBuilder
extends MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
int	getPageSize() Maximum number of `signals` to return in the response.
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 signals to return.
ByteString	getQueryBytes() An expression that defines which signals to return.

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 signals to return.
 Search atoms can be used to match certain specific fields.  Otherwise,
 plain text will match text fields in the signal.
 Search atoms:
 * `start` - (timestamp) The time the signal was created.
 * `title` - The title of the signal.
 * `signal_state` - `open` or `closed`. State of the signal.
   (e.g., `signal_state:open`)
 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 ":" operator will
   match the entire day.
 * yyyy-MM-ddTHH:mm - Same as above, but with minute resolution.
 * yyyy-MM-ddTHH:mm:ss - Same as above, but with second resolution.
 * Nd (e.g. 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
   (e.g. `start:7d`) is unlikely to be useful because that would only match
   signals created precisely at a particular instant in time.
 The absolute timestamp formats (everything starting with a year) can
 optionally be followed with a UTC offset in +/-hh:mm format.  Also, the 'T'
 separating dates and times can optionally be replaced with a space. Note
 that any timestamp containing a space or colon will need to be quoted.
 Examples:
 * `foo` - matches signals containing the word "foo"
 * `"foo bar"` - matches signals containing the phrase "foo bar"
 * `foo bar` or `foo AND bar` - matches signals containing the words
   "foo" and "bar"
 * `foo -bar` or `foo AND NOT bar` - matches signals containing the
   word
   "foo" but not the word "bar"
 * `foo OR bar` - matches signals containing the word "foo" or the
   word "bar"
 * `start>2018-11-28` - matches signals which started after November
   11, 2018.
 * `start<=2018-11-28` - matches signals which started on or before
   November 11, 2018.
 * `start:2018-11-28` - matches signals which started on November 11,
   2018.
 * `start>"2018-11-28 01:02:03+04:00"` - matches signals which started
   after November 11, 2018 at 1:02:03 AM according to the UTC+04 time
   zone.
 * `start>7d` - matches signals 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 signals from
   the past 90 days containing the word "foo"
 

string query = 2;

Returns:

The query.

getQueryBytes

ByteString getQueryBytes()

 An expression that defines which signals to return.
 Search atoms can be used to match certain specific fields.  Otherwise,
 plain text will match text fields in the signal.
 Search atoms:
 * `start` - (timestamp) The time the signal was created.
 * `title` - The title of the signal.
 * `signal_state` - `open` or `closed`. State of the signal.
   (e.g., `signal_state:open`)
 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 ":" operator will
   match the entire day.
 * yyyy-MM-ddTHH:mm - Same as above, but with minute resolution.
 * yyyy-MM-ddTHH:mm:ss - Same as above, but with second resolution.
 * Nd (e.g. 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
   (e.g. `start:7d`) is unlikely to be useful because that would only match
   signals created precisely at a particular instant in time.
 The absolute timestamp formats (everything starting with a year) can
 optionally be followed with a UTC offset in +/-hh:mm format.  Also, the 'T'
 separating dates and times can optionally be replaced with a space. Note
 that any timestamp containing a space or colon will need to be quoted.
 Examples:
 * `foo` - matches signals containing the word "foo"
 * `"foo bar"` - matches signals containing the phrase "foo bar"
 * `foo bar` or `foo AND bar` - matches signals containing the words
   "foo" and "bar"
 * `foo -bar` or `foo AND NOT bar` - matches signals containing the
   word
   "foo" but not the word "bar"
 * `foo OR bar` - matches signals containing the word "foo" or the
   word "bar"
 * `start>2018-11-28` - matches signals which started after November
   11, 2018.
 * `start<=2018-11-28` - matches signals which started on or before
   November 11, 2018.
 * `start:2018-11-28` - matches signals which started on November 11,
   2018.
 * `start>"2018-11-28 01:02:03+04:00"` - matches signals which started
   after November 11, 2018 at 1:02:03 AM according to the UTC+04 time
   zone.
 * `start>7d` - matches signals 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 signals from
   the past 90 days containing the word "foo"
 

string query = 2;

Returns:

The bytes for query.

getPageSize

int getPageSize()

 Maximum number of `signals` to return in the response.
 

int32 page_size = 3;

Returns:

The pageSize.

getPageToken

String getPageToken()

 Page token from an earlier query, as returned in `next_page_token`. All
 field values except for page_size and page_token should be the same as the
 original query (may return an error or unexpected data otherwise).
 

string page_token = 4;

Returns:

The pageToken.

getPageTokenBytes

ByteString getPageTokenBytes()

 Page token from an earlier query, as returned in `next_page_token`. All
 field values except for page_size and page_token should be the same as the
 original query (may return an error or unexpected data otherwise).
 

string page_token = 4;

Returns:

The bytes for pageToken.