Reference documentation and code samples for the Chronicle V1 API class Google::Cloud::Chronicle::V1::SearchSession.
SearchSession represents an asynchronous search session.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#dialect
def dialect() -> ::Google::Cloud::Chronicle::V1::QueryDialect
Returns
- (::Google::Cloud::Chronicle::V1::QueryDialect) — Optional. Specifies how to parse the 'query' string. If not specified, the query will be parsed as YL2.
#dialect=
def dialect=(value) -> ::Google::Cloud::Chronicle::V1::QueryDialect
Parameter
- value (::Google::Cloud::Chronicle::V1::QueryDialect) — Optional. Specifies how to parse the 'query' string. If not specified, the query will be parsed as YL2.
Returns
- (::Google::Cloud::Chronicle::V1::QueryDialect) — Optional. Specifies how to parse the 'query' string. If not specified, the query will be parsed as YL2.
#draft_data_access_scope
def draft_data_access_scope() -> ::Google::Cloud::Chronicle::V1::DataAccessScope
Returns
- (::Google::Cloud::Chronicle::V1::DataAccessScope) — Optional. Data access scope used to filter events. This is intended to be used by admins to preview in-development scopes. Should only be called by users with global access. If the caller does not have global access, the request will fail.
#draft_data_access_scope=
def draft_data_access_scope=(value) -> ::Google::Cloud::Chronicle::V1::DataAccessScope
Parameter
- value (::Google::Cloud::Chronicle::V1::DataAccessScope) — Optional. Data access scope used to filter events. This is intended to be used by admins to preview in-development scopes. Should only be called by users with global access. If the caller does not have global access, the request will fail.
Returns
- (::Google::Cloud::Chronicle::V1::DataAccessScope) — Optional. Data access scope used to filter events. This is intended to be used by admins to preview in-development scopes. Should only be called by users with global access. If the caller does not have global access, the request will fail.
#metadata
def metadata() -> ::Google::Cloud::Chronicle::V1::SearchSessionMetadata
Returns
- (::Google::Cloud::Chronicle::V1::SearchSessionMetadata) — Output only. Metadata about the search session.
#name
def name() -> ::String
Returns
- (::String) — Identifier. The resource name of the search session. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Identifier. The resource name of the search session. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
Returns
- (::String) — Identifier. The resource name of the search session. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
#query
def query() -> ::String
Returns
-
(::String) — Required. The search query, in the dialect set in
dialect. Example: 'ip=/172.*/ AND metadata.event_type!="NETWORK_CONNECTION" AND ( target.ip = "3.225.179.73" OR target.ip = "23.47.48.70")'
#query=
def query=(value) -> ::String
Parameter
-
value (::String) — Required. The search query, in the dialect set in
dialect. Example: 'ip=/172.*/ AND metadata.event_type!="NETWORK_CONNECTION" AND ( target.ip = "3.225.179.73" OR target.ip = "23.47.48.70")'
Returns
-
(::String) — Required. The search query, in the dialect set in
dialect. Example: 'ip=/172.*/ AND metadata.event_type!="NETWORK_CONNECTION" AND ( target.ip = "3.225.179.73" OR target.ip = "23.47.48.70")'
#time_range
def time_range() -> ::Google::Type::Interval
Returns
- (::Google::Type::Interval) — Required. Time range to search for [Inclusive start time, exclusive end time).
#time_range=
def time_range=(value) -> ::Google::Type::Interval
Parameter
- value (::Google::Type::Interval) — Required. Time range to search for [Inclusive start time, exclusive end time).
Returns
- (::Google::Type::Interval) — Required. Time range to search for [Inclusive start time, exclusive end time).