# Functions
MakeDatasetFromFederatedDataset creates a new Dataset from an instance of FederatedDataset.
MakeDatasetFromIndexDataset creates a new Dataset from an instance of IndexDataset.
MakeDatasetFromKvCollectionDataset creates a new Dataset from an instance of KvCollectionDataset.
MakeDatasetFromLookupDataset creates a new Dataset from an instance of LookupDataset.
MakeDatasetFromMetricDataset creates a new Dataset from an instance of MetricDataset.
MakeDatasetFromRawInterface creates a new Dataset from a raw interface{}.
MakeDatasetPatchFromFederatedDatasetPatch creates a new DatasetPatch from an instance of FederatedDatasetPatch.
MakeDatasetPatchFromIndexDatasetPatch creates a new DatasetPatch from an instance of IndexDatasetPatch.
MakeDatasetPatchFromKvCollectionDatasetPatch creates a new DatasetPatch from an instance of KvCollectionDatasetPatch.
MakeDatasetPatchFromLookupDatasetPatch creates a new DatasetPatch from an instance of LookupDatasetPatch.
MakeDatasetPatchFromMetricDatasetPatch creates a new DatasetPatch from an instance of MetricDatasetPatch.
MakeDatasetPatchFromRawInterface creates a new DatasetPatch from a raw interface{}.
NewIterator creates a new reference to the iterator object.
NewService creates a new search service client from the given Config.
# Constants
List of ExportResultsoutputMode values.
List of ExportResultsoutputMode values.
List of FederatedDatasetKind.
List of FieldDataType.
List of FieldDataType.
List of FieldDataType.
List of FieldDataType.
List of FieldDataType.
List of FieldPrevalence.
List of FieldPrevalence.
List of FieldPrevalence.
List of FieldType.
List of FieldType.
List of FieldType.
List of IndexDatasetKind.
List of KVCollectionDatasetKind.
List of LookupDatasetExternalKind.
List of LookupDatasetKind.
List of MessageType.
List of MessageType.
List of MessageType.
List of MessageType.
List of MetricDatasetKind.
List of SearchStatus.
List of SearchStatus.
List of SearchStatus.
List of SearchStatus.
List of SearchStatus.
List of UpdateJobStatus.
List of UpdateJobStatus.
# Structs
Dataset : A complete dataset as rendered in POST, PATCH responses.
Properties that are common across all Dataset kinds rendered in POST, PATCH, and GET responses.
DatasetPatch : Property values to be set in an existing dataset using a PATCH request.
Properties that are common across all Dataset kinds to be set in an existing dataset using a PATCH request.
Properties that are common across all Dataset kinds for creating a new dataset using a POST request.
Created and Modified date-time properties for inclusion in other objects.
A delete search job, including read-only fields that includes the required properties.
ExportResultsQueryParams represents valid query parameters for the ExportResults operation For convenience ExportResultsQueryParams can be formed in a single statement, for example: `v := ExportResultsQueryParams{}.SetCount(...).SetFilename(...).SetOutputMode(...)`.
A fully constructed federated connection object.
The property values for creating a new federated connection using a PUT or POST request.
A complete federated dataset as rendered in POST, PATCH, and GET responses.
Property values to be set in an existing federated dataset using a PATCH request.
Properties of job datasets which may be read, set, and changed through the API.
Initial property values for creating a new field using a POST request.
Properties of fields which can be read, set, and changed through the API.
A statistical summary of the fields in the events to date, for the search ID (SID).
A complete index dataset as rendered in POST, PATCH, and GET responses.
Property values to be set in an existing index dataset using a PATCH request.
Properties of job datasets which may be read, set, and changed through the API.
Properties of index datasets which can only be read through the API.
Iterator is the result of a search query.
A complete kvcollection dataset as rendered in POST, PATCH, and GET responses.
Property values to be set in an existing kvcollection dataset using a PATCH request.
Properties of kvcollection datasets which may be read, set, and changed through the API.
A list of fully constructed datasets.
ListEventsSummaryQueryParams represents valid query parameters for the ListEventsSummary operation For convenience ListEventsSummaryQueryParams can be formed in a single statement, for example: `v := ListEventsSummaryQueryParams{}.SetCount(...).SetEarliest(...).SetField(...).SetLatest(...).SetOffset(...)`.
ListFieldsSummaryQueryParams represents valid query parameters for the ListFieldsSummary operation For convenience ListFieldsSummaryQueryParams can be formed in a single statement, for example: `v := ListFieldsSummaryQueryParams{}.SetEarliest(...).SetLatest(...)`.
ListJobsQueryParams represents valid query parameters for the ListJobs operation For convenience ListJobsQueryParams can be formed in a single statement, for example: `v := ListJobsQueryParams{}.SetCount(...).SetFilter(...).SetStatus(...)`.
ListPreviewResultsQueryParams represents valid query parameters for the ListPreviewResults operation For convenience ListPreviewResultsQueryParams can be formed in a single statement, for example: `v := ListPreviewResultsQueryParams{}.SetCount(...).SetOffset(...)`.
The structure of the response body for the preview search results that is returned for the job with the specified search ID (SID).
No description provided by the author
ListResultsQueryParams represents valid query parameters for the ListResults operation For convenience ListResultsQueryParams can be formed in a single statement, for example: `v := ListResultsQueryParams{}.SetCount(...).SetField(...).SetOffset(...)`.
The structure of the search results or events metadata that is returned for the job with the specified search ID (SID).
A complete lookup dataset as rendered in POST, PATCH, and GET responses.
Property values to be set in an existing lookup dataset using a PATCH request.
Properties of lookup datasets which may be read, set, and changed through the API.
The message field in search results or search jobs.
Created, createdby, modified, modifiedby, and owner properties for inclusion in other objects.
A complete metric dataset as rendered in POST, PATCH, and GET responses.
Property values to be set in an existing metric dataset using a PATCH request.
Properties of metric datasets which may be read, set, and changed through the API.
Properties of metric datasets which can only be read through the API.
Represents parameters on the search job such as 'earliest' and 'latest'.
A search job, including read-only fields that includes the required properties.
Summary of each field.
The summary of events for a single time bucket.
Summary of the value in a field.
A timeline metadata model of the event distribution.
Updates a search job with a status.
Owner, createdby, and modifiedby user name properties for inclusion in other objects.
# Interfaces
Servicer represents the interface for implementing all endpoints for this service.
ServicerGenerated represents the interface for implementing all endpoints for this service.
# Type aliases
ExportResultsoutputMode : Specifies the format for the returned output.
FederatedDatasetKind : The dataset kind.
FieldDataType : The type of data in the field.
FieldPrevalence : How frequent the field appears in the dataset.
FieldType : The type of field.
IndexDatasetKind : The dataset kind.
KvCollectionDatasetKind : The dataset kind.
A list of federated connections.
LookupDatasetExternalKind : The type of the external lookup.
LookupDatasetKind : The dataset kind.
No description provided by the author
MetricDatasetKind : The dataset kind.
QueryFunc is the function to be executed in each Next call of the iterator.
SearchStatus : The current status of the search job.
No description provided by the author
UpdateJobStatus : Modify the status of an existing search job using PATCH.