public interface SearchRequestOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getDialect()
public abstract QueryDialect getDialect()Optional. Specifies the dialect the Search Query is written in. 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 the dialect the Search Query is written in. 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 |
|
getParent()
public abstract String getParent()Required. The resource name of the instance on which to perform the search. Format: projects/{project}/locations/{location}/instances/{instance}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
String |
The parent. |
getParentBytes()
public abstract ByteString getParentBytes()Required. The resource name of the instance on which to perform the search. Format: projects/{project}/locations/{location}/instances/{instance}
string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for parent. |
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. |
getResultLimit()
public abstract int getResultLimit() Optional. Requested maximum number of rows to materialize. The service may
return fewer. If unspecified, a server-side default of 10,000 is used. The
maximum value is 1,000,000. Some dialects have a lower maximum; see
QueryDialect.
int32 result_limit = 6 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The resultLimit. |
getSimulatedDataVisibility()
public abstract SimulatedDataVisibility getSimulatedDataVisibility()Optional. Specifies visibility of simulated data to include in search results.
.google.cloud.chronicle.v1.SimulatedDataVisibility simulated_data_visibility = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
SimulatedDataVisibility |
The simulatedDataVisibility. |
getSimulatedDataVisibilityValue()
public abstract int getSimulatedDataVisibilityValue()Optional. Specifies visibility of simulated data to include in search results.
.google.cloud.chronicle.v1.SimulatedDataVisibility simulated_data_visibility = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for simulatedDataVisibility. |
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. |
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. |