Class SearchSessionMetadata (0.41.0)

public final class SearchSessionMetadata extends GeneratedMessage implements SearchSessionMetadataOrBuilder

Metadata about the search session.

Protobuf type google.cloud.chronicle.v1.SearchSessionMetadata

Static Fields

END_TIME_FIELD_NUMBER

public static final int END_TIME_FIELD_NUMBER
Field Value
Type Description
int

EXPIRE_TIME_FIELD_NUMBER

public static final int EXPIRE_TIME_FIELD_NUMBER
Field Value
Type Description
int

MORE_DATA_AVAILABLE_FIELD_NUMBER

public static final int MORE_DATA_AVAILABLE_FIELD_NUMBER
Field Value
Type Description
int

OPERATION_ID_FIELD_NUMBER

public static final int OPERATION_ID_FIELD_NUMBER
Field Value
Type Description
int

RESULT_ROW_COUNT_FIELD_NUMBER

public static final int RESULT_ROW_COUNT_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchSessionMetadata getDefaultInstance()
Returns
Type Description
SearchSessionMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(SearchSessionMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public SearchSessionMetadata getDefaultInstanceForType()
Returns
Type Description
SearchSessionMetadata

getEndTime()

public Timestamp getEndTime()

Output only. The end time of the session, if done.

.google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The endTime.

getEndTimeOrBuilder()

public TimestampOrBuilder getEndTimeOrBuilder()

Output only. The end time of the session, if done.

.google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getExpireTime()

public Timestamp getExpireTime()

Output only. The time when the search results expire.

.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The expireTime.

getExpireTimeOrBuilder()

public TimestampOrBuilder getExpireTimeOrBuilder()

Output only. The time when the search results expire.

.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getMoreDataAvailable()

public boolean getMoreDataAvailable()

Output only. If true, there are more search results available than what can be returned and have been omitted.

bool more_data_available = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

The moreDataAvailable.

getOperationId()

public String getOperationId()

Output only. The operation id corresponding to the search session which can be used to poll the operation resource to know its state and progress.

string operation_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The operationId.

getOperationIdBytes()

public ByteString getOperationIdBytes()

Output only. The operation id corresponding to the search session which can be used to poll the operation resource to know its state and progress.

string operation_id = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for operationId.

getParserForType()

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

getResultRowCount()

public int getResultRowCount()

Output only. Total number of rows returned in the search session.

int32 result_row_count = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The resultRowCount.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. The start time of the session.

.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The startTime.

getStartTimeOrBuilder()

public TimestampOrBuilder getStartTimeOrBuilder()

Output only. The start time of the session.

.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasEndTime()

public boolean hasEndTime()

Output only. The end time of the session, if done.

.google.protobuf.Timestamp end_time = 3 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the endTime field is set.

hasExpireTime()

public boolean hasExpireTime()

Output only. The time when the search results expire.

.google.protobuf.Timestamp expire_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the expireTime field is set.

hasStartTime()

public boolean hasStartTime()

Output only. The start time of the session.

.google.protobuf.Timestamp start_time = 2 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the startTime 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 SearchSessionMetadata.Builder newBuilderForType()
Returns
Type Description
SearchSessionMetadata.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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