public interface SearchSessionOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDialect()
public abstract QueryDialect getDialect()Optional. Specifies how to parse the 'query' string. If not specified, the query will be parsed as YL2.
.google.cloud.chronicle.v1.QueryDialect dialect = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
QueryDialect |
The dialect. |
getDialectValue()
public abstract int getDialectValue()Optional. Specifies how to parse the 'query' string. If not specified, the query will be parsed as YL2.
.google.cloud.chronicle.v1.QueryDialect dialect = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for dialect. |
getDraftDataAccessScope()
public abstract DataAccessScope getDraftDataAccessScope()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.
.google.cloud.chronicle.v1.DataAccessScope draft_data_access_scope = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataAccessScope |
The draftDataAccessScope. |
getDraftDataAccessScopeOrBuilder()
public abstract DataAccessScopeOrBuilder getDraftDataAccessScopeOrBuilder()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.
.google.cloud.chronicle.v1.DataAccessScope draft_data_access_scope = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
DataAccessScopeOrBuilder |
|
getMetadata()
public abstract SearchSessionMetadata getMetadata()Output only. Metadata about the search session.
.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SearchSessionMetadata |
The metadata. |
getMetadataOrBuilder()
public abstract SearchSessionMetadataOrBuilder getMetadataOrBuilder()Output only. Metadata about the search session.
.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
SearchSessionMetadataOrBuilder |
|
getName()
public abstract String getName()Identifier. The resource name of the search session. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()Identifier. The resource name of the search session. Format: projects/{project}/locations/{location}/instances/{instance}/searchSessions/{search_session}
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getQuery()
public abstract String getQuery() 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")'
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
String |
The query. |
getQueryBytes()
public abstract ByteString getQueryBytes() 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")'
string query = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for query. |
getTimeRange()
public abstract Interval getTimeRange()Required. Time range to search for [Inclusive start time, exclusive end time).
.google.type.Interval time_range = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
com.google.type.Interval |
The timeRange. |
getTimeRangeOrBuilder()
public abstract IntervalOrBuilder getTimeRangeOrBuilder()Required. Time range to search for [Inclusive start time, exclusive end time).
.google.type.Interval time_range = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
com.google.type.IntervalOrBuilder |
|
hasDraftDataAccessScope()
public abstract boolean hasDraftDataAccessScope()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.
.google.cloud.chronicle.v1.DataAccessScope draft_data_access_scope = 5 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the draftDataAccessScope field is set. |
hasMetadata()
public abstract boolean hasMetadata()Output only. Metadata about the search session.
.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the metadata field is set. |
hasTimeRange()
public abstract boolean hasTimeRange()Required. Time range to search for [Inclusive start time, exclusive end time).
.google.type.Interval time_range = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the timeRange field is set. |