Class SearchSession (0.41.0)

public final class SearchSession extends GeneratedMessage implements SearchSessionOrBuilder

SearchSession represents an asynchronous search session.

Protobuf type google.cloud.chronicle.v1.SearchSession

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

METADATA_FIELD_NUMBER

public static final int METADATA_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_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 SearchSession getDefaultInstance()
Returns
Type Description
SearchSession

getDescriptor()

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

newBuilder()

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

newBuilder(SearchSession prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchSession getDefaultInstanceForType()
Returns
Type Description
SearchSession

getDialect()

public 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 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 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

getMetadata()

public 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 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 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 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.

getParserForType()

public Parser<SearchSession> getParserForType()
Returns
Type Description
Parser<SearchSession>
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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hasMetadata()

public 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 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 SearchSession.Builder newBuilderForType()
Returns
Type Description
SearchSession.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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