Class SearchOperationMetadata.Builder (0.41.0)

public static final class SearchOperationMetadata.Builder extends GeneratedMessage.Builder<SearchOperationMetadata.Builder> implements SearchOperationMetadataOrBuilder

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

Protobuf type google.cloud.chronicle.v1.SearchOperationMetadata

Static Methods

getDescriptor()

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

Methods

build()

public SearchOperationMetadata build()
Returns
Type Description
SearchOperationMetadata

buildPartial()

public SearchOperationMetadata buildPartial()
Returns
Type Description
SearchOperationMetadata

clear()

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

clearDatatableExportMetadata()

public SearchOperationMetadata.Builder clearDatatableExportMetadata()

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

clearEndTime()

public SearchOperationMetadata.Builder clearEndTime()

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

clearExpireTime()

public SearchOperationMetadata.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
SearchOperationMetadata.Builder

clearProgress()

public SearchOperationMetadata.Builder clearProgress()

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

This builder for chaining.

clearStartTime()

public SearchOperationMetadata.Builder clearStartTime()

Output only. The start time of the search.

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

Returns
Type Description
SearchOperationMetadata.Builder

clearState()

public SearchOperationMetadata.Builder clearState()

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

This builder for chaining.

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.

getDatatableExportMetadataBuilder()

public DataTableExportMetadata.Builder getDatatableExportMetadataBuilder()

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

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

getDescriptorForType()

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

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.

getEndTimeBuilder()

public Timestamp.Builder getEndTimeBuilder()

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
Builder

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.

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

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.

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.

getStartTimeBuilder()

public Timestamp.Builder getStartTimeBuilder()

Output only. The start time of the search.

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

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDatatableExportMetadata(DataTableExportMetadata value)

public SearchOperationMetadata.Builder mergeDatatableExportMetadata(DataTableExportMetadata value)

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

Parameter
Name Description
value DataTableExportMetadata
Returns
Type Description
SearchOperationMetadata.Builder

mergeEndTime(Timestamp value)

public SearchOperationMetadata.Builder mergeEndTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchOperationMetadata.Builder

mergeExpireTime(Timestamp value)

public SearchOperationMetadata.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
SearchOperationMetadata.Builder

mergeFrom(SearchOperationMetadata other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeStartTime(Timestamp value)

public SearchOperationMetadata.Builder mergeStartTime(Timestamp value)

Output only. The start time of the search.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchOperationMetadata.Builder

setDatatableExportMetadata(DataTableExportMetadata value)

public SearchOperationMetadata.Builder setDatatableExportMetadata(DataTableExportMetadata value)

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

Parameter
Name Description
value DataTableExportMetadata
Returns
Type Description
SearchOperationMetadata.Builder

setDatatableExportMetadata(DataTableExportMetadata.Builder builderForValue)

public SearchOperationMetadata.Builder setDatatableExportMetadata(DataTableExportMetadata.Builder builderForValue)

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

Parameter
Name Description
builderForValue DataTableExportMetadata.Builder
Returns
Type Description
SearchOperationMetadata.Builder

setEndTime(Timestamp value)

public SearchOperationMetadata.Builder setEndTime(Timestamp value)

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

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchOperationMetadata.Builder

setEndTime(Timestamp.Builder builderForValue)

public SearchOperationMetadata.Builder setEndTime(Timestamp.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SearchOperationMetadata.Builder

setExpireTime(Timestamp value)

public SearchOperationMetadata.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
SearchOperationMetadata.Builder

setExpireTime(Timestamp.Builder builderForValue)

public SearchOperationMetadata.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
SearchOperationMetadata.Builder

setProgress(int value)

public SearchOperationMetadata.Builder setProgress(int value)

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

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

Parameter
Name Description
value int

The progress to set.

Returns
Type Description
SearchOperationMetadata.Builder

This builder for chaining.

setStartTime(Timestamp value)

public SearchOperationMetadata.Builder setStartTime(Timestamp value)

Output only. The start time of the search.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
SearchOperationMetadata.Builder

setStartTime(Timestamp.Builder builderForValue)

public SearchOperationMetadata.Builder setStartTime(Timestamp.Builder builderForValue)

Output only. The start time of the search.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
SearchOperationMetadata.Builder

setState(SearchOperationMetadata.State value)

public SearchOperationMetadata.Builder setState(SearchOperationMetadata.State value)

Output only. State of the Search operation.

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

Parameter
Name Description
value SearchOperationMetadata.State

The state to set.

Returns
Type Description
SearchOperationMetadata.Builder

This builder for chaining.

setStateValue(int value)

public SearchOperationMetadata.Builder setStateValue(int value)

Output only. State of the Search operation.

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

Parameter
Name Description
value int

The enum numeric value on the wire for state to set.

Returns
Type Description
SearchOperationMetadata.Builder

This builder for chaining.