public static final class SearchRequest.Builder extends GeneratedMessage.Builder<SearchRequest.Builder> implements SearchRequestOrBuilderRequest message for the Search method.
Protobuf type google.cloud.chronicle.v1.SearchRequest
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > SearchRequest.BuilderImplements
SearchRequestOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public SearchRequest build()| Returns | |
|---|---|
| Type | Description |
SearchRequest |
|
buildPartial()
public SearchRequest buildPartial()| Returns | |
|---|---|
| Type | Description |
SearchRequest |
|
clear()
public SearchRequest.Builder clear()| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
clearDialect()
public SearchRequest.Builder clearDialect()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 |
SearchRequest.Builder |
This builder for chaining. |
clearDraftDataAccessScope()
public SearchRequest.Builder clearDraftDataAccessScope()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 |
SearchRequest.Builder |
|
clearParent()
public SearchRequest.Builder clearParent()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 |
SearchRequest.Builder |
This builder for chaining. |
clearQuery()
public SearchRequest.Builder clearQuery() 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 |
SearchRequest.Builder |
This builder for chaining. |
clearResultLimit()
public SearchRequest.Builder clearResultLimit() 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 |
SearchRequest.Builder |
This builder for chaining. |
clearSimulatedDataVisibility()
public SearchRequest.Builder clearSimulatedDataVisibility()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 |
SearchRequest.Builder |
This builder for chaining. |
clearTimeRange()
public SearchRequest.Builder clearTimeRange()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 |
SearchRequest.Builder |
|
getDefaultInstanceForType()
public SearchRequest getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SearchRequest |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDialect()
public 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 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 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. |
getDraftDataAccessScopeBuilder()
public DataAccessScope.Builder getDraftDataAccessScopeBuilder()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.Builder |
|
getDraftDataAccessScopeOrBuilder()
public 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 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 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 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 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 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 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 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 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. |
getTimeRangeBuilder()
public Interval.Builder getTimeRangeBuilder()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.Builder |
|
getTimeRangeOrBuilder()
public 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeDraftDataAccessScope(DataAccessScope value)
public SearchRequest.Builder mergeDraftDataAccessScope(DataAccessScope value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
DataAccessScope |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
mergeFrom(SearchRequest other)
public SearchRequest.Builder mergeFrom(SearchRequest other)| Parameter | |
|---|---|
| Name | Description |
other |
SearchRequest |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public SearchRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public SearchRequest.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
mergeTimeRange(Interval value)
public SearchRequest.Builder mergeTimeRange(Interval value)Required. Time range to search for [Inclusive start time, exclusive end time).
.google.type.Interval time_range = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Interval |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setDialect(QueryDialect value)
public SearchRequest.Builder setDialect(QueryDialect value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
QueryDialectThe dialect to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setDialectValue(int value)
public SearchRequest.Builder setDialectValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for dialect to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setDraftDataAccessScope(DataAccessScope value)
public SearchRequest.Builder setDraftDataAccessScope(DataAccessScope value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
DataAccessScope |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setDraftDataAccessScope(DataAccessScope.Builder builderForValue)
public SearchRequest.Builder setDraftDataAccessScope(DataAccessScope.Builder builderForValue)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];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
DataAccessScope.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setParent(String value)
public SearchRequest.Builder setParent(String value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe parent to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setParentBytes(ByteString value)
public SearchRequest.Builder setParentBytes(ByteString value)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) = { ... }
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for parent to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setQuery(String value)
public SearchRequest.Builder setQuery(String value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setQueryBytes(ByteString value)
public SearchRequest.Builder setQueryBytes(ByteString value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for query to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setResultLimit(int value)
public SearchRequest.Builder setResultLimit(int value) 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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe resultLimit to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setSimulatedDataVisibility(SimulatedDataVisibility value)
public SearchRequest.Builder setSimulatedDataVisibility(SimulatedDataVisibility value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
SimulatedDataVisibilityThe simulatedDataVisibility to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setSimulatedDataVisibilityValue(int value)
public SearchRequest.Builder setSimulatedDataVisibilityValue(int value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for simulatedDataVisibility to set. |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
This builder for chaining. |
setTimeRange(Interval value)
public SearchRequest.Builder setTimeRange(Interval value)Required. Time range to search for [Inclusive start time, exclusive end time).
.google.type.Interval time_range = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Interval |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|
setTimeRange(Interval.Builder builderForValue)
public SearchRequest.Builder setTimeRange(Interval.Builder builderForValue)Required. Time range to search for [Inclusive start time, exclusive end time).
.google.type.Interval time_range = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.Interval.Builder |
| Returns | |
|---|---|
| Type | Description |
SearchRequest.Builder |
|