API Reference google_api_cloud_search v0.10.0

Modules

API client metadata for GoogleApi.CloudSearch.V1.

API calls for all endpoints tagged Debug.

API calls for all endpoints tagged Indexing.

API calls for all endpoints tagged Media.

API calls for all endpoints tagged Operations.

API calls for all endpoints tagged Query.

API calls for all endpoints tagged Settings.

API calls for all endpoints tagged Stats.

Handle Tesla connections for GoogleApi.CloudSearch.V1.

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.

Attributes

  • hasAccess (type: boolean(), default: nil) - Returns true if principal has access. Returns false otherwise.

Attributes

  • logicOperator (type: String.t, default: nil) - The logic operator of the sub filter.
  • subFilters (type: list(GoogleApi.CloudSearch.V1.Model.Filter.t), default: nil) - Sub filters.

Aggregation of items by status code as of the specified date.

Attributes

  • date (type: GoogleApi.CloudSearch.V1.Model.Date.t, default: nil) - Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.
  • queryCountByStatus (type: list(GoogleApi.CloudSearch.V1.Model.QueryCountByStatus.t), default: nil) -

Attributes

  • date (type: GoogleApi.CloudSearch.V1.Model.Date.t, default: nil) - Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
  • searchSessionsCount (type: String.t, default: nil) - The count of search sessions on the day

Represents settings at a customer level.

Attributes

  • date (type: GoogleApi.CloudSearch.V1.Model.Date.t, default: nil) - Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
  • oneDayActiveUsersCount (type: String.t, default: nil) - The count of unique active users in the past one day
  • sevenDaysActiveUsersCount (type: String.t, default: nil) - The count of unique active users in the past seven days
  • thirtyDaysActiveUsersCount (type: String.t, default: nil) - The count of unique active users in the past thirty days

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.

Aggregation of items by status code as of the specified 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.

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.

Shared request debug options for all cloudsearch RPC methods.

Attributes

  • connectorName (type: String.t, default: nil) - Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.
  • queue (type: String.t, default: nil) - Name of a queue to delete items from.

A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown.

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.

Drive follow-up search restricts (e.g. "followup:suggestions").

Drive location search restricts (e.g. "is:starred").

Drive mime-type search restricts (e.g. "type:pdf").

The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12").

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

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.

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.

Error information about the response.

Error message per source response.

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.

Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.

Source specific facet response

Attributes

  • description (type: String.t, default: nil) - Description of the error.
  • field (type: String.t, default: nil) - Path of field with violation.

A generic way of expressing filters in a query, which supports two approaches: 1. Setting a ValueFilter. The name must match an operator_name defined in the schema for your data source. 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.

Filter options to be applied on query.

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.

Attributes

  • gsuiteDomain (type: boolean(), default: nil) - This principal represents all users of the G Suite domain of the customer.
  • gsuiteGroupEmail (type: String.t, default: nil) - This principal references a G Suite group account
  • gsuiteUserEmail (type: String.t, default: nil) - This principal references a G Suite user account

Attributes

  • stats (type: list(GoogleApi.CloudSearch.V1.Model.CustomerIndexStats.t), default: nil) - Summary of indexed item counts, one for each day in the requested range.

Attributes

  • stats (type: list(GoogleApi.CloudSearch.V1.Model.CustomerQueryStats.t), default: nil) -

Attributes

  • stats (type: list(GoogleApi.CloudSearch.V1.Model.CustomerSessionStats.t), default: nil) -

Attributes

  • stats (type: list(GoogleApi.CloudSearch.V1.Model.CustomerUserStats.t), default: nil) -

Attributes

  • stats (type: list(GoogleApi.CloudSearch.V1.Model.DataSourceIndexStats.t), default: nil) - Summary of indexed item counts, one for each day in the requested range.

Attributes

  • stats (type: list(GoogleApi.CloudSearch.V1.Model.SearchApplicationQueryStats.t), default: nil) -

Attributes

  • stats (type: list(GoogleApi.CloudSearch.V1.Model.SearchApplicationSessionStats.t), default: nil) -

Attributes

  • stats (type: list(GoogleApi.CloudSearch.V1.Model.SearchApplicationUserStats.t), default: nil) -

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.

Attributes

  • allowUnknownGsuitePrincipals (type: boolean(), default: nil) - Specifies if the index request should allow gsuite principals that do not exist or are deleted in the index request.

Attributes

  • connectorName (type: String.t, default: nil) - Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.
  • indexItemOptions (type: GoogleApi.CloudSearch.V1.Model.IndexItemOptions.t, default: nil) -
  • item (type: GoogleApi.CloudSearch.V1.Model.Item.t, default: nil) - Name of the item. Format: datasources/{source_id}/items/{item_id}
  • mode (type: String.t, default: nil) - Required. The RequestMode for this request.

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.

Represents an interaction between a user and an item.

Represents a single object that is an item in the search index, such as a file, folder, or a database record.

Access control list information for the item. For more information see Map ACLs.

Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.

Attributes

  • count (type: String.t, default: nil) - Number of items matching the status code.
  • statusCode (type: String.t, default: nil) - Status of the items.

Available metadata fields for the item.

This contains item's status and any errors.

Available structured data fields for the item.

Attributes

  • nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.
  • sources (type: list(GoogleApi.CloudSearch.V1.Model.DataSource.t), default: nil) -

Attributes

  • itemNames (type: list(String.t), default: nil) -
  • nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Attributes

  • items (type: list(GoogleApi.CloudSearch.V1.Model.Item.t), default: nil) -
  • nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

The response message for Operations.ListOperations.

Attributes

  • nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.
  • searchApplications (type: list(GoogleApi.CloudSearch.V1.Model.SearchApplication.t), default: nil) -

Attributes

  • nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.
  • unmappedIdentities (type: list(GoogleApi.CloudSearch.V1.Model.UnmappedIdentity.t), default: nil) -

Matched range of a snippet [start, end).

Metadata of a matched search result.

A metaline is a list of properties that are displayed along with the search result to provide context.

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.

The definition for an object within a data source.

The display options for an object.

This resource represents a long-running operation that is the result of a network API call.

This field contains information about the person being suggested.

Object to represent a person.

Attributes

  • connectorName (type: String.t, default: nil) - Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.
  • limit (type: integer(), default: nil) - Maximum number of items to return. The maximum value is 100 and the default value is 20.
  • queue (type: String.t, default: nil) - Queue name to fetch items from. If unspecified, PollItems will fetch from 'default' queue. The maximum length is 100 characters.
  • statusCodes (type: list(String.t), default: nil) - Limit the items polled to the ones with these statuses.

Attributes

  • items (type: list(GoogleApi.CloudSearch.V1.Model.Item.t), default: nil) - Set of items from the queue available for connector to process. These items have the following subset of fields populated: version metadata.hash structured_data.hash content.hash payload status queue

Reference to a user, group, or domain.

Attributes

  • code (type: String.t, default: nil) - Error code indicating the nature of the error.
  • errorMessage (type: String.t, default: nil) - Description of the error.
  • fieldViolations (type: list(GoogleApi.CloudSearch.V1.Model.FieldViolation.t), default: nil) - In case the item fields are invalid, this field contains the details about the validation errors.

The definition of a property within an object.

The display options for a property.

Represents an item to be pushed to the indexing queue.

Attributes

  • connectorName (type: String.t, default: nil) - Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.
  • item (type: GoogleApi.CloudSearch.V1.Model.PushItem.t, default: nil) - Item to push onto the queue.

Attributes

  • count (type: String.t, default: nil) -
  • statusCode (type: integer(), default: nil) - This represents the http status code.

Attributes

  • interpretationType (type: String.t, default: nil) -
  • interpretedQuery (type: String.t, default: nil) - The interpretation of the query used in search. For example, queries with natural language intent like "email from john" will be interpreted as "from:john source:mail". This field will not be filled when the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.
  • reason (type: String.t, default: nil) - The reason for interpretation of the query. This field will not be UNSPECIFIED if the interpretation type is not NONE.

Information relevant only to a query entry.

The definition of a operator that can be used in a Search/Suggest request.

List of sources that the user can search using the query API.

This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.

Errors when the connector is communicating to the source repository.

Shared request options for all RPC methods.

Attributes

  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.

Debugging information about the response.

Information relevant only to a restrict entry. NextId: 12

Debugging information about the result.

Display Fields for Search Results

The collection of fields that make up a displayed line

Attributes

  • metalines (type: list(GoogleApi.CloudSearch.V1.Model.ResultDisplayLine.t), default: nil) - The metalines content to be displayed with the result.
  • objectTypeLabel (type: String.t, default: nil) - The display label for the object.

Attributes

  • importance (type: String.t, default: nil) - Indicates the ranking importance given to property when it is matched during retrieval. Once set, the token importance of a property cannot be changed.

The schema definition for a data source.

Scoring configurations for a source while processing a Search or Suggest request.

Attributes

  • date (type: GoogleApi.CloudSearch.V1.Model.Date.t, default: nil) - Date for which query stats were calculated. Stats calculated on the next day close to midnight are returned.
  • queryCountByStatus (type: list(GoogleApi.CloudSearch.V1.Model.QueryCountByStatus.t), default: nil) -

Attributes

  • date (type: GoogleApi.CloudSearch.V1.Model.Date.t, default: nil) - Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
  • searchSessionsCount (type: String.t, default: nil) - The count of search sessions on the day

Attributes

  • date (type: GoogleApi.CloudSearch.V1.Model.Date.t, default: nil) - Date for which session stats were calculated. Stats calculated on the next day close to midnight are returned.
  • oneDayActiveUsersCount (type: String.t, default: nil) - The count of unique active users in the past one day
  • sevenDaysActiveUsersCount (type: String.t, default: nil) - The count of unique active users in the past seven days
  • thirtyDaysActiveUsersCount (type: String.t, default: nil) - The count of unique active users in the past thirty days

Attributes

  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.
  • pageToken (type: String.t, default: nil) - The next_page_token value returned from a previous request, if any.
  • viewUrl (type: String.t, default: nil) - Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.

Attributes

  • items (type: list(GoogleApi.CloudSearch.V1.Model.Item.t), default: nil) -
  • nextPageToken (type: String.t, default: nil) - Token to retrieve the next page of results, or empty if there are no more results in the list.

Additional search quality metadata of the item.

Results containing indexed information for a document.

Snippet of the search result, which summarizes the content of the resulting page.

Attributes

  • operatorName (type: String.t, default: nil) - Name of the operator corresponding to the field to sort on. The corresponding property must be marked as sortable.
  • sortOrder (type: String.t, default: nil) - Ascending is the default sort order

Defines sources for the suggest/search APIs.

Configurations for a source while processing a Search or Suggest request.

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.

Per source result count information.

Set the scoring configuration. This allows modifying the ranking of results for a source.

Attributes

  • suggestedQuery (type: String.t, default: nil) - The suggested spelling of the query.

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. You can find out more about this error model and how to work with it in the API Design Guide.

A structured data object consisting of named properties.

Structured results that are returned as part of search request.

Response of the suggest API.

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.

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.

Attributes

  • externalIdentity (type: GoogleApi.CloudSearch.V1.Model.Principal.t, default: nil) - The resource name for an external user.
  • resolutionStatusCode (type: String.t, default: nil) - The resolution status for the external identity.

Attributes

  • connectorName (type: String.t, default: nil) - Name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.
  • queue (type: String.t, default: nil) - Name of a queue to unreserve items from.

Attributes

  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.
  • source (type: GoogleApi.CloudSearch.V1.Model.DataSource.t, default: nil) -

Attributes

  • debugOptions (type: GoogleApi.CloudSearch.V1.Model.DebugOptions.t, default: nil) - Common debug options.
  • schema (type: GoogleApi.CloudSearch.V1.Model.Schema.t, default: nil) - The new schema for the source.
  • validateOnly (type: boolean(), default: nil) - If true, the schema will be checked for validity, but will not be registered with the data source, even if valid.

Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef.

Attributes

  • project (type: String.t, default: nil) - The resource name of the GCP Project to be used for VPC SC policy check. VPC security settings on this project will be honored for Cloud Search APIs after project_name has been updated through CustomerService. Format: projects/{project_id}

Definition of a single value with generic type.

Attributes

  • operatorName (type: String.t, default: nil) - The operator_name applied to the query, such as price_greater_than. The filter can work against both types of filters defined in the schema for your data source: 1. operator_name, where the query filters results by the property that matches the value. 2. greater_than_operator_name or less_than_operator_name in your schema. The query filters the results for the property values that are greater than or less than the supplied value in the query.
  • value (type: GoogleApi.CloudSearch.V1.Model.Value.t, default: nil) - The value to be compared with.