Chronicle V1 API - Class Google::Cloud::Chronicle::V1::ListSearchedResultsRequest (v1.4.0)

Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::ListSearchedResultsRequest.

Request message for the ListSearchedResults method.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#order_by

def order_by() -> ::String
Returns
  • (::String) — Optional. The column to sort the results on. Example: "event_timestamp desc", "principal.hostname asc". Multi-columnar sorting is not supported.

#order_by=

def order_by=(value) -> ::String
Parameter
  • value (::String) — Optional. The column to sort the results on. Example: "event_timestamp desc", "principal.hostname asc". Multi-columnar sorting is not supported.
Returns
  • (::String) — Optional. The column to sort the results on. Example: "event_timestamp desc", "principal.hostname asc". Multi-columnar sorting is not supported.

#page_size

def page_size() -> ::Integer
Returns
  • (::Integer) — Optional. The maximum number of results to return. The service may return fewer. If unspecified, at most 100 results will be returned. The maximum value is 1000.

#page_size=

def page_size=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The maximum number of results to return. The service may return fewer. If unspecified, at most 100 results will be returned. The maximum value is 1000.
Returns
  • (::Integer) — Optional. The maximum number of results to return. The service may return fewer. If unspecified, at most 100 results will be returned. The maximum value is 1000.

#page_token

def page_token() -> ::String
Returns
  • (::String) — Optional. A page token, received from a previous ListSearchedResults call. Provide this to retrieve the subsequent page.

#page_token=

def page_token=(value) -> ::String
Parameter
  • value (::String) — Optional. A page token, received from a previous ListSearchedResults call. Provide this to retrieve the subsequent page.
Returns
  • (::String) — Optional. A page token, received from a previous ListSearchedResults call. Provide this to retrieve the subsequent page.

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent SearchSession resource name. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent SearchSession resource name. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
Returns
  • (::String) — Required. The parent SearchSession resource name. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}

#skip

def skip() -> ::Integer
Returns
  • (::Integer) — Optional. The number of results to skip before starting to return results. This field should not be used in conjunction with page_token.

#skip=

def skip=(value) -> ::Integer
Parameter
  • value (::Integer) — Optional. The number of results to skip before starting to return results. This field should not be used in conjunction with page_token.
Returns
  • (::Integer) — Optional. The number of results to skip before starting to return results. This field should not be used in conjunction with page_token.