googleapis.cloudsearch.v1 library

Classes

BooleanOperatorOptions
Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
BooleanPropertyOptions
Options for boolean properties.
ByteRange
Specifies a range of media.
CheckAccessResponse
CloudsearchApi
Cloud Search provides cloud-based search capabilities over G Suite data. The Cloud Search API allows indexing of non-G Suite data into Cloud Search.
CompositeFilter
CustomerIndexStats
Aggregation of items by status code as of the specified date.
DataSource
Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
DataSourceIndexStats
Aggregation of items by status code as of the specified date.
DataSourceRestriction
Restriction on Datasource.
Date
Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar. The date must be a valid calendar date between the year 1 and 9999.
DateOperatorOptions
Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
DatePropertyOptions
Options for date properties.
DateValues
List of date values.
DebugDatasourcesItemsResourceApi
DebugDatasourcesItemsUnmappedidsResourceApi
DebugDatasourcesResourceApi
DebugIdentitysourcesItemsResourceApi
DebugIdentitysourcesResourceApi
DebugIdentitysourcesUnmappedidsResourceApi
DebugOptions
Shared request debug options for all cloudsearch RPC methods.
DebugResourceApi
DeleteQueueItemsRequest
DisplayedProperty
A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties will be displayed in the search results along with the dislpay label for that property if one is specified. If a display label is not specified, only the values will be shown.
DoubleOperatorOptions
Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
DoublePropertyOptions
Options for double properties.
DoubleValues
List of double values.
DownloadOptions
Represents options for downloading media. [...]
DriveFollowUpRestrict
Drive follow-up search restricts (e.g. "followup:suggestions").
DriveLocationRestrict
Drive location search restricts (e.g. "is:starred").
DriveMimeTypeRestrict
Drive mime-type search restricts (e.g. "type:pdf").
DriveTimeSpanRestrict
The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12").
EmailAddress
A person's email address.
EnumOperatorOptions
Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a priority enum property with possible values p0 and p1, a query that contains the term p0 will return items that have p0 as the value of the priority property, as well as any items that contain the string p0 in other fields. If you provide an operator name for the enum, such as priority, then search users can use that operator to refine results to only items that have p0 as this property's value, with the query priority:p0.
EnumPropertyOptions
Options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define p0 as an allowable enum value and tie this enum to the operator name priority so that search users could add priority:p0 to their query to restrict the set of results to only those items indexed with the value p0.
EnumValuePair
The enumeration value pair defines two things: a required string value and an optional integer value. The string value defines the necessary query term required to retrieve that item, such as p0 for a priority item. The integer value determines the ranking of that string value relative to other enumerated values for the same property. For example, you might associate p0 with 0 and define another enum pair such as p1 and 1. You must use the integer value in combination with ordered ranking to set the ranking of a given value relative to other enumerated values for the same property name. Here, a ranking order of DESCENDING for priority properties results in a ranking boost for items indexed with a value of p0 compared to items indexed with a value of p1. Without a specified ranking order, the integer value has no effect on item ranking.
EnumValues
List of enum values.
ErrorInfo
Error information about the response.
ErrorMessage
Error message per source response.
FacetBucket
A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.
FacetOptions
Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
FacetResult
Source specific facet response
FieldViolation
Filter
A generic way of expressing filters in a query, which supports two approaches: <br/><br/> 1. Setting a ValueFilter. The name must match an operator_name defined in the schema for your data source. <br/> 2. Setting a CompositeFilter. The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.
FilterOptions
Filter options to be applied on query.
FreshnessOptions
Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.
GetCustomerIndexStatsResponse
GetDataSourceIndexStatsResponse
GmailActionRestrict
Gmail Action restricts (i.e. read/replied/snoozed).
GmailAttachmentRestrict
Gmail Attachment restricts (i.e. has:attachment, has:drive, filename:pdf).
GmailFolderRestrict
Gmail Folder restricts (i.e. in Drafts/Sent/Chats/User Generated Labels).
GmailIntelligentRestrict
Gmail Intelligent restricts (i.e. smartlabels, important).
GmailTimeRestrict
Gmail Time restricts (i.e. received today, this week).
GSuitePrincipal
HtmlOperatorOptions
Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
HtmlPropertyOptions
Options for html properties.
HtmlValues
List of html values.
IndexingDatasourcesItemsResourceApi
IndexingDatasourcesResourceApi
IndexingResourceApi
IndexItemOptions
IndexItemRequest
IntegerOperatorOptions
Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
IntegerPropertyOptions
Options for integer properties.
IntegerValues
List of integer values.
Interaction
Represents an interaction between a user and an item.
Item
Represents a single object that is an item in the search index, such as a file, folder, or a database record.
ItemAcl
Access control list information for the item. For more information see https://developers.google.com/cloud-search/docs/guides/index-your-data#acls
ItemContent
Content of an item to be indexed and surfaced by Cloud Search.
ItemCountByStatus
ItemMetadata
Available metadata fields for the item.
ItemStatus
This contains item's status and any errors.
ItemStructuredData
Available structured data fields for the item.
ListDataSourceResponse
ListItemNamesForUnmappedIdentityResponse
ListItemsResponse
ListQuerySourcesResponse
List sources response.
ListSearchApplicationsResponse
ListUnmappedIdentitiesResponse
MatchRange
Matched range of a snippet [start, end).
Media
Media resource.
MediaResourceApi
Metadata
Metadata of a matched search result.
Metaline
A metaline is a list of properties that are displayed along with the search result to provide context.
Name
A person's name.
NamedProperty
A typed name-value pair for structured data. The type of the value should be the same as the registered type for the name property in the object definition of objectType.
ObjectDefinition
The definition for an object within a data source.
ObjectDisplayOptions
The display options for an object.
ObjectOptions
The options for an object.
ObjectPropertyOptions
Options for object properties.
ObjectValues
List of object values.
Operation
This resource represents a long-running operation that is the result of a network API call.
OperationsResourceApi
PartialDownloadOptions
Options for downloading a Media.
PeopleSuggestion
This field contains information about the person being suggested.
Person
Object to represent a person.
Photo
A person's photo.
PollItemsRequest
PollItemsResponse
Principal
Reference to a user, group, or domain.
ProcessingError
PropertyDefinition
The definition of a property within an object.
PropertyDisplayOptions
The display options for a property.
PushItem
Represents an item to be pushed to the indexing queue.
PushItemRequest
QueryInterpretation
QueryInterpretationOptions
Options to interpret user query.
QueryItem
Information relevant only to a query entry.
QueryOperator
The definition of a operator that can be used in a Search/Suggest request.
QueryResourceApi
QuerySource
List of sources that the user can search using the query API.
QuerySourcesResourceApi
QuerySuggestion
This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.
RepositoryError
Errors when the connector is communicating to the source repository.
RequestOptions
Shared request options for all RPC methods.
ResetSearchApplicationRequest
ResponseDebugInfo
Debugging information about the response.
RestrictItem
Information relevant only to a restrict entry. NextId: 12
ResultCounts
Result count information
ResultDebugInfo
Debugging information about the result.
ResultDisplayField
Display Fields for Search Results
ResultDisplayLine
The collection of fields that make up a displayed line
ResultDisplayMetadata
ResumableUploadOptions
Specifies options for resumable uploads.
RetrievalImportance
Schema
The schema definition for a data source.
ScoringConfig
Scoring configurations for a source while processing a Search or Suggest request.
SearchApplication
SearchApplication
SearchItemsByViewUrlRequest
SearchItemsByViewUrlResponse
SearchQualityMetadata
Additional search quality metadata of the item.
SearchRequest
The search API request.
SearchResponse
The search API response.
SearchResult
Results containing indexed information for a document.
SettingsDatasourcesResourceApi
SettingsResourceApi
SettingsSearchapplicationsResourceApi
Snippet
Snippet of the search result, which summarizes the content of the resulting page.
SortOptions
Source
Defines sources for the suggest/search APIs.
SourceConfig
Configurations for a source while processing a Search or Suggest request.
SourceCrowdingConfig
Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.
SourceResultCount
Per source result count information.
SourceScoringConfig
Set the scoring configuration. This allows modifying the ranking of results for a source.
SpellResult
StartUploadItemRequest
Start upload file request.
StatsIndexDatasourcesResourceApi
StatsIndexResourceApi
StatsResourceApi
Status
The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. [...]
StructuredDataObject
A structured data object consisting of named properties.
StructuredResult
Structured results that are returned as part of search request.
SuggestRequest
Request of suggest API.
SuggestResponse
Response of the suggest API.
SuggestResult
One suggestion result.
TextOperatorOptions
Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
TextPropertyOptions
Options for text properties.
TextValues
List of text values.
TimestampOperatorOptions
Used to provide a search operator for timestamp properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
TimestampPropertyOptions
Options for timestamp properties.
TimestampValues
List of timestamp values.
UnmappedIdentity
UnreserveItemsRequest
UpdateDataSourceRequest
UpdateSchemaRequest
UploadItemRef
Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef.
UploadOptions
Represents options for uploading a Media.
Value
Definition of a single value with generic type.
ValueFilter

Constants

USER_AGENT → const String
'dart-api-client cloudsearch/v1'

Exceptions / Errors

ApiRequestError
Represents a general error reported by the API endpoint.
DetailedApiRequestError
Represents a specific error reported by the API endpoint.