Class SearchRequest (0.41.0)

public final class SearchRequest extends GeneratedMessage implements SearchRequestOrBuilder

Request message for the Search method.

Protobuf type google.cloud.chronicle.v1.SearchRequest

Static Fields

DIALECT_FIELD_NUMBER

public static final int DIALECT_FIELD_NUMBER
Field Value
Type Description
int

DRAFT_DATA_ACCESS_SCOPE_FIELD_NUMBER

public static final int DRAFT_DATA_ACCESS_SCOPE_FIELD_NUMBER
Field Value
Type Description
int

PARENT_FIELD_NUMBER

public static final int PARENT_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

RESULT_LIMIT_FIELD_NUMBER

public static final int RESULT_LIMIT_FIELD_NUMBER
Field Value
Type Description
int

SIMULATED_DATA_VISIBILITY_FIELD_NUMBER

public static final int SIMULATED_DATA_VISIBILITY_FIELD_NUMBER
Field Value
Type Description
int

TIME_RANGE_FIELD_NUMBER

public static final int TIME_RANGE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchRequest getDefaultInstance()
Returns
Type Description
SearchRequest

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static SearchRequest.Builder newBuilder()
Returns
Type Description
SearchRequest.Builder

newBuilder(SearchRequest prototype)

public static SearchRequest.Builder newBuilder(SearchRequest prototype)
Parameter
Name Description
prototype SearchRequest
Returns
Type Description
SearchRequest.Builder

parseDelimitedFrom(InputStream input)

public static SearchRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static SearchRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SearchRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SearchRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static SearchRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static SearchRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SearchRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<SearchRequest> parser()
Returns
Type Description
Parser<SearchRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public SearchRequest getDefaultInstanceForType()
Returns
Type Description
SearchRequest

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.

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.

getParserForType()

public Parser<SearchRequest> getParserForType()
Returns
Type Description
Parser<SearchRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public SearchRequest.Builder newBuilderForType()
Returns
Type Description
SearchRequest.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected SearchRequest.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
SearchRequest.Builder
Overrides

toBuilder()

public SearchRequest.Builder toBuilder()
Returns
Type Description
SearchRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException