Interface SearchSessionMetadataOrBuilder (0.41.0)

public interface SearchSessionMetadataOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getEndTime()

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