Class SearchSessionMetadata.Builder (0.41.0)

public static final class SearchSessionMetadata.Builder extends GeneratedMessage.Builder<SearchSessionMetadata.Builder> implements SearchSessionMetadataOrBuilder

Metadata about the search session.

Protobuf type google.cloud.chronicle.v1.SearchSessionMetadata

Static Methods

getDescriptor()

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

Methods

build()

public SearchSessionMetadata build()
Returns
Type Description
SearchSessionMetadata

buildPartial()

public SearchSessionMetadata buildPartial()
Returns
Type Description
SearchSessionMetadata

clear()

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

clearEndTime()

public SearchSessionMetadata.Builder clearEndTime()

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

clearExpireTime()

public SearchSessionMetadata.Builder clearExpireTime()

Output only. The time when the search results expire.

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

Returns
Type Description
SearchSessionMetadata.Builder

clearMoreDataAvailable()

public SearchSessionMetadata.Builder clearMoreDataAvailable()

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

This builder for chaining.

clearOperationId()

public SearchSessionMetadata.Builder clearOperationId()

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

This builder for chaining.

clearResultRowCount()

public SearchSessionMetadata.Builder clearResultRowCount()

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

This builder for chaining.

clearStartTime()

public SearchSessionMetadata.Builder clearStartTime()

Output only. The start time of the session.

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

Returns
Type Description
SearchSessionMetadata.Builder

getDefaultInstanceForType()

public SearchSessionMetadata getDefaultInstanceForType()
Returns
Type Description
SearchSessionMetadata

getDescriptorForType()

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

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

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.

getExpireTimeBuilder()

public Timestamp.Builder getExpireTimeBuilder()

Output only. The time when the search results expire.

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

Returns
Type Description
Builder

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.

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.

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. The start time of the session.

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

Returns
Type Description
Builder

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeEndTime(Timestamp value)

public SearchSessionMetadata.Builder mergeEndTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchSessionMetadata.Builder

mergeExpireTime(Timestamp value)

public SearchSessionMetadata.Builder mergeExpireTime(Timestamp value)

Output only. The time when the search results expire.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchSessionMetadata.Builder

mergeFrom(SearchSessionMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeStartTime(Timestamp value)

public SearchSessionMetadata.Builder mergeStartTime(Timestamp value)

Output only. The start time of the session.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchSessionMetadata.Builder

setEndTime(Timestamp value)

public SearchSessionMetadata.Builder setEndTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchSessionMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public SearchSessionMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SearchSessionMetadata.Builder

setExpireTime(Timestamp value)

public SearchSessionMetadata.Builder setExpireTime(Timestamp value)

Output only. The time when the search results expire.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchSessionMetadata.Builder

setExpireTime(Timestamp.Builder builderForValue)

public SearchSessionMetadata.Builder setExpireTime(Timestamp.Builder builderForValue)

Output only. The time when the search results expire.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SearchSessionMetadata.Builder

setMoreDataAvailable(boolean value)

public SearchSessionMetadata.Builder setMoreDataAvailable(boolean value)

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

Parameter
Name Description
value boolean

The moreDataAvailable to set.

Returns
Type Description
SearchSessionMetadata.Builder

This builder for chaining.

setOperationId(String value)

public SearchSessionMetadata.Builder setOperationId(String value)

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

Parameter
Name Description
value String

The operationId to set.

Returns
Type Description
SearchSessionMetadata.Builder

This builder for chaining.

setOperationIdBytes(ByteString value)

public SearchSessionMetadata.Builder setOperationIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for operationId to set.

Returns
Type Description
SearchSessionMetadata.Builder

This builder for chaining.

setResultRowCount(int value)

public SearchSessionMetadata.Builder setResultRowCount(int value)

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

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

Parameter
Name Description
value int

The resultRowCount to set.

Returns
Type Description
SearchSessionMetadata.Builder

This builder for chaining.

setStartTime(Timestamp value)

public SearchSessionMetadata.Builder setStartTime(Timestamp value)

Output only. The start time of the session.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchSessionMetadata.Builder

setStartTime(Timestamp.Builder builderForValue)

public SearchSessionMetadata.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. The start time of the session.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SearchSessionMetadata.Builder