cloudsearch/v1 library

Cloud Search API - v1

Cloud Search provides cloud-based search capabilities over Google Workspace data. The Cloud Search API allows indexing of non-Google Workspace data into Cloud Search.

For more information, see developers.google.com/cloud-search/docs/guides/

Create an instance of CloudSearchApi to access these resources:

Classes

AuditLoggingSettings: Represents the settings for Cloud audit logging
BooleanOperatorOptions: Used to provide a search operator for boolean properties.
BooleanPropertyOptions: The options for boolean properties.
ByteRange: Specifies a range of media.
CheckAccessResponse
CloudSearchApi: Cloud Search provides cloud-based search capabilities over Google Workspace data.
CompositeFilter
ContextAttribute: A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
CustomerIndexStats: Aggregation of items by status code as of the specified date.
CustomerQueryStats
CustomerSearchApplicationStats: Search application stats for a customer for the given date.
CustomerSessionStats
CustomerSettings: Represents settings at a customer level.
CustomerUserStats
DataSource: Datasource is a logical namespace for items to be indexed.
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.
DateOperatorOptions: Provides a search operator for date properties.
DatePropertyOptions: The options for date properties.
DateValues: List of date values.
DebugDatasourcesItemsResource
DebugDatasourcesItemsUnmappedidsResource
DebugDatasourcesResource
DebugIdentitysourcesItemsResource
DebugIdentitysourcesResource
DebugIdentitysourcesUnmappedidsResource
DebugOptions: Shared request debug options for all cloudsearch RPC methods.
DebugResource
DeleteQueueItemsRequest
DisplayedProperty: A reference to a top-level property within the object that should be displayed in search results.
DoubleOperatorOptions: Used to provide a search operator for double properties.
DoublePropertyOptions: The options for double properties.
DoubleValues: List of double values.
DownloadOptions: Represents options for downloading media.
EmailAddress: A person's email address.
EnumOperatorOptions: Used to provide a search operator for enum properties.
EnumPropertyOptions: The 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.
EnumValuePair: The enumeration value pair defines two things: a required string value and an optional integer value.
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.
FacetOptions: Specifies operators to return facet results for.
FacetResult: Source specific facet response
FieldViolation
Filter: A generic way of expressing filters in a query, which supports two approaches: **1.
FilterOptions: Filter options to be applied on query.
FreshnessOptions: Indicates which freshness property to use when adjusting search ranking for an item.
GetCustomerIndexStatsResponse
GetCustomerQueryStatsResponse
GetCustomerSearchApplicationStatsResponse: Response format for search application stats for a customer.
GetCustomerSessionStatsResponse
GetCustomerUserStatsResponse
GetDataSourceIndexStatsResponse
GetSearchApplicationQueryStatsResponse: Response format for getting query stats for a search application between given dates.
GetSearchApplicationSessionStatsResponse
GetSearchApplicationUserStatsResponse
GSuitePrincipal
HtmlOperatorOptions: Used to provide a search operator for html properties.
HtmlPropertyOptions: The options for html properties.
HtmlValues: List of html values.
IndexingDatasourcesItemsResource
IndexingDatasourcesResource
IndexingResource
IndexItemOptions
IndexItemRequest
IntegerFacetingOptions: Used to specify integer faceting options.
IntegerOperatorOptions: Used to provide a search operator for integer properties.
IntegerPropertyOptions: The 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.
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
ListOperationsResponse: The response message for Operations.ListOperations.
ListQuerySourcesResponse: List sources response.
ListSearchApplicationsResponse
ListUnmappedIdentitiesResponse
MatchRange: Matched range of a snippet [start, end).
MediaResource
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.
ObjectDefinition: The definition for an object within a data source.
ObjectDisplayOptions: The display options for an object.
ObjectOptions: The options for an object.
ObjectPropertyOptions: The 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.
OperationsLroResource
OperationsResource
PartialDownloadOptions: Options for downloading a Media.
PeopleSuggestion: This field contains information about the person being suggested.
Person: Object to represent a person.
PhoneNumber: A person's Phone Number
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
QueryActivity: Details about a user's query activity.
QueryCountByStatus
QueryInterpretation
QueryInterpretationConfig: Default options to interpret user query.
QueryInterpretationOptions: Options to interpret user query.
QueryOperator: The definition of a operator that can be used in a Search/Suggest request.
QueryResource
QuerySource: List of sources that the user can search using the query API.
QuerySourcesResource
RemoveActivityRequest: Remove Logged Activity Request.
RepositoryError: Errors when the connector is communicating to the source repository.
RequestOptions: Shared request options for all RPC methods.
ResetSearchApplicationRequest
ResultCounts: Result count information
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
SafeHtmlProto: IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script.
Schema: The schema definition for a data source.
ScoringConfig: Scoring configurations for a source while processing a Search or Suggest request.
SearchApplication: SearchApplication
SearchApplicationQueryStats: Search application level query stats per date
SearchApplicationSessionStats
SearchApplicationUserStats
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.
SettingsDatasourcesResource
SettingsResource
SettingsSearchapplicationsResource
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.
SourceResultCount: Per source result count information.
SourceScoringConfig: Set the scoring configuration.
SpellResult
StartUploadItemRequest: Start upload file request.
StatsIndexDatasourcesResource
StatsIndexResource
StatsQueryResource
StatsQuerySearchapplicationsResource
StatsResource
StatsSessionResource
StatsSessionSearchapplicationsResource
StatsUserResource
StatsUserSearchapplicationsResource
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.
TextPropertyOptions: The options for text properties.
TextValues: List of text values.
TimestampOperatorOptions: Used to provide a search operator for timestamp properties.
TimestampPropertyOptions: The options for timestamp properties.
TimestampValues: List of timestamp values.
UnmappedIdentity
UnreserveItemsRequest
UpdateDataSourceRequest
UpdateSchemaRequest
UploadItemRef: Represents an upload session reference.
UploadOptions: Represents options for uploading a Media.
UserActivity: User's single or bulk query activity.
V1Resource
Value: Definition of a single value with generic type.
ValueFilter
VPCSettings

Typedefs

InitializeCustomerRequest = $Empty: Request message for InitializeCustomer method.
Media = $Media: Media resource.
QuerySuggestion = $Empty: This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.
RemoveActivityResponse = $Empty: Remove Logged Activity Response.
ResponseDebugInfo = $DebugInfo: Debugging information about the response.
ResultDebugInfo = $DebugInfo: Debugging information about the result.
Status = $Status: The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs.

Exceptions / Errors

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

cloudsearch/v1 library

Classes

Typedefs

Exceptions / Errors

googleapis package

v1 library