Class SearchOperationMetadata (0.41.0)

public final class SearchOperationMetadata extends GeneratedMessage implements SearchOperationMetadataOrBuilder

Metadata for the google.longrunning.Operation returned by the Search method.

Protobuf type google.cloud.chronicle.v1.SearchOperationMetadata

Static Fields

DATATABLE_EXPORT_METADATA_FIELD_NUMBER

public static final int DATATABLE_EXPORT_METADATA_FIELD_NUMBER
Field Value
Type Description
int

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

PROGRESS_FIELD_NUMBER

public static final int PROGRESS_FIELD_NUMBER
Field Value
Type Description
int

START_TIME_FIELD_NUMBER

public static final int START_TIME_FIELD_NUMBER
Field Value
Type Description
int

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static SearchOperationMetadata getDefaultInstance()
Returns
Type Description
SearchOperationMetadata

getDescriptor()

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

newBuilder()

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

newBuilder(SearchOperationMetadata prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDatatableExportMetadata()

public DataTableExportMetadata getDatatableExportMetadata()

Output only. Metadata of the data table export operation if the search results are written to a Data Table.

.google.cloud.chronicle.v1.DataTableExportMetadata datatable_export_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataTableExportMetadata

The datatableExportMetadata.

getDatatableExportMetadataOrBuilder()

public DataTableExportMetadataOrBuilder getDatatableExportMetadataOrBuilder()

Output only. Metadata of the data table export operation if the search results are written to a Data Table.

.google.cloud.chronicle.v1.DataTableExportMetadata datatable_export_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
DataTableExportMetadataOrBuilder

getDefaultInstanceForType()

public SearchOperationMetadata getDefaultInstanceForType()
Returns
Type Description
SearchOperationMetadata

getEndTime()

public Timestamp getEndTime()

Output only. The end time of the search, 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 search, 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

getParserForType()

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

getProgress()

public int getProgress()

Output only. Progress Percentage of the search LRO, ranges from 0 to 100.

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

Returns
Type Description
int

The progress.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStartTime()

public Timestamp getStartTime()

Output only. The start time of the search.

.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 search.

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

Returns
Type Description
TimestampOrBuilder

getState()

public SearchOperationMetadata.State getState()

Output only. State of the Search operation.

.google.cloud.chronicle.v1.SearchOperationMetadata.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
SearchOperationMetadata.State

The state.

getStateValue()

public int getStateValue()

Output only. State of the Search operation.

.google.cloud.chronicle.v1.SearchOperationMetadata.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The enum numeric value on the wire for state.

hasDatatableExportMetadata()

public boolean hasDatatableExportMetadata()

Output only. Metadata of the data table export operation if the search results are written to a Data Table.

.google.cloud.chronicle.v1.DataTableExportMetadata datatable_export_metadata = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the datatableExportMetadata field is set.

hasEndTime()

public boolean hasEndTime()

Output only. The end time of the search, 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 search.

.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 SearchOperationMetadata.Builder newBuilderForType()
Returns
Type Description
SearchOperationMetadata.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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