public final class SearchSession extends GeneratedMessage implements SearchSessionOrBuilder
SearchSession represents an asynchronous search session.
Protobuf type google.cloud.chronicle.v1.SearchSession
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
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 |
|
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()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static SearchSession.Builder newBuilder()
newBuilder(SearchSession prototype)
public static SearchSession.Builder newBuilder(SearchSession prototype)
public static SearchSession parseDelimitedFrom(InputStream input)
public static SearchSession parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static SearchSession parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SearchSession parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static SearchSession parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchSession parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SearchSession parseFrom(CodedInputStream input)
public static SearchSession parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SearchSession parseFrom(InputStream input)
public static SearchSession parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static SearchSession parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SearchSession parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<SearchSession> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public SearchSession getDefaultInstanceForType()
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];
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];
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];
public SearchSessionMetadata getMetadata()
Output only. Metadata about the search session.
.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
public SearchSessionMetadataOrBuilder getMetadataOrBuilder()
Output only. Metadata about the search session.
.google.cloud.chronicle.v1.SearchSessionMetadata metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
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()
Overrides
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.
|
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()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public SearchSession.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected SearchSession.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public SearchSession.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides