Class SearchSession.Builder (0.41.0)

public static final class SearchSession.Builder extends GeneratedMessage.Builder<SearchSession.Builder> implements SearchSessionOrBuilder

SearchSession represents an asynchronous search session.

Protobuf type google.cloud.chronicle.v1.SearchSession

Static Methods

getDescriptor()

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

Methods

build()

public SearchSession build()
Returns
Type Description
SearchSession

buildPartial()

public SearchSession buildPartial()
Returns
Type Description
SearchSession

clear()

public SearchSession.Builder clear()
Returns
Type Description
SearchSession.Builder
Overrides

clearDialect()

public SearchSession.Builder clearDialect()

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
SearchSession.Builder

This builder for chaining.

clearDraftDataAccessScope()

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

clearMetadata()

public SearchSession.Builder clearMetadata()

Output only. Metadata about the search session.

.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SearchSession.Builder

clearName()

public SearchSession.Builder clearName()

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
SearchSession.Builder

This builder for chaining.

clearQuery()

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

This builder for chaining.

clearTimeRange()

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

getDefaultInstanceForType()

public SearchSession getDefaultInstanceForType()
Returns
Type Description
SearchSession

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

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

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.

getMetadataBuilder()

public SearchSessionMetadata.Builder getMetadataBuilder()

Output only. Metadata about the search session.

.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SearchSessionMetadata.Builder

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.

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.

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.

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDraftDataAccessScope(DataAccessScope value)

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

mergeFrom(SearchSession other)

public SearchSession.Builder mergeFrom(SearchSession other)
Parameter
Name Description
other SearchSession
Returns
Type Description
SearchSession.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public SearchSession.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
SearchSession.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public SearchSession.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
SearchSession.Builder
Overrides

mergeMetadata(SearchSessionMetadata value)

public SearchSession.Builder mergeMetadata(SearchSessionMetadata value)

Output only. Metadata about the search session.

.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SearchSessionMetadata
Returns
Type Description
SearchSession.Builder

mergeTimeRange(Interval value)

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

setDialect(QueryDialect value)

public SearchSession.Builder setDialect(QueryDialect value)

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];

Parameter
Name Description
value QueryDialect

The dialect to set.

Returns
Type Description
SearchSession.Builder

This builder for chaining.

setDialectValue(int value)

public SearchSession.Builder setDialectValue(int value)

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];

Parameter
Name Description
value int

The enum numeric value on the wire for dialect to set.

Returns
Type Description
SearchSession.Builder

This builder for chaining.

setDraftDataAccessScope(DataAccessScope value)

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

setDraftDataAccessScope(DataAccessScope.Builder builderForValue)

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

setMetadata(SearchSessionMetadata value)

public SearchSession.Builder setMetadata(SearchSessionMetadata value)

Output only. Metadata about the search session.

.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value SearchSessionMetadata
Returns
Type Description
SearchSession.Builder

setMetadata(SearchSessionMetadata.Builder builderForValue)

public SearchSession.Builder setMetadata(SearchSessionMetadata.Builder builderForValue)

Output only. Metadata about the search session.

.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue SearchSessionMetadata.Builder
Returns
Type Description
SearchSession.Builder

setName(String value)

public SearchSession.Builder setName(String value)

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];

Parameter
Name Description
value String

The name to set.

Returns
Type Description
SearchSession.Builder

This builder for chaining.

setNameBytes(ByteString value)

public SearchSession.Builder setNameBytes(ByteString value)

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];

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
SearchSession.Builder

This builder for chaining.

setQuery(String value)

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

The query to set.

Returns
Type Description
SearchSession.Builder

This builder for chaining.

setQueryBytes(ByteString value)

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

The bytes for query to set.

Returns
Type Description
SearchSession.Builder

This builder for chaining.

setTimeRange(Interval value)

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

setTimeRange(Interval.Builder builderForValue)

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