Namespace Google.Apis.CloudSearch.v1.Data

Classes

AuditLoggingSettings

Represents the settings for Cloud audit logging

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.

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.

CustomerSearchApplicationStats

Search application stats for a customer for the given date.

CustomerSettings

Represents settings at a customer level.

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.

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

The options for date properties.

DateValues

List of date values.

DebugOptions

Shared request debug options for all cloudsearch RPC methods.

DebugResponse

Debug Search Response.

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

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

The options for double properties.

DoubleValues

List of double values.

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.

EnterpriseTopazFrontendTeamsLink

EnterpriseTopazFrontendTeamsPersonCorePhoneNumber

EnterpriseTopazSidekickAgendaEntry

An AgendaEntry, e.g., a Calendar Event.

EnterpriseTopazSidekickAgendaGroupCardProto

EnterpriseTopazSidekickAgendaGroupCardProtoContext

The context that resulted in the generation of the card.

EnterpriseTopazSidekickAgendaItem

EnterpriseTopazSidekickAnswerAnswerList

A list of answers represented as free text.

EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer

An answer with a corresponding label.

EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard

Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. "what can I search for?").

EnterpriseTopazSidekickAnswerSuggestedQueryCategory

Contains a list of suggested queries for a single category.

EnterpriseTopazSidekickAssistCardProto

Wrapper proto for the Assist cards.

EnterpriseTopazSidekickCardMetadata

Card metadata.

EnterpriseTopazSidekickCommonDebugInfo

Container of debugging information in all object levels. Extend as needed.

EnterpriseTopazSidekickCommonDocument

Representation of a document. NEXT_TAG: 15

EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata

Meta data for drive documents.

EnterpriseTopazSidekickCommonDocumentJustification

Justification of why we are reporting the document.

EnterpriseTopazSidekickCommonPerson

Common representation of a person.

EnterpriseTopazSidekickCommonPersonBirthday

EnterpriseTopazSidekickConflictingEventsCardProto

Conflicting meetings card proto.

EnterpriseTopazSidekickDocumentGroup

Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage.

EnterpriseTopazSidekickDocumentPerCategoryList

EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry

EnterpriseTopazSidekickFindMeetingTimeCardProto

Response to find meeting time among a set of people.

EnterpriseTopazSidekickGap

EnterpriseTopazSidekickGenericAnswerCard

EnterpriseTopazSidekickGetAndKeepAheadCardProto

Get and keep ahead card

EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents

A list of events where all guests declined.

EnterpriseTopazSidekickMeetingNotesCardError

Errors in the creation of meeting notes.

EnterpriseTopazSidekickMeetingNotesCardProto

Information about the meeting notes created.

EnterpriseTopazSidekickMeetingNotesCardRequest

Meeting notes card request.

EnterpriseTopazSidekickNlpMetadata

Metadata about the NLP interpretation of the query.

EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo

Metadata for disambiguation.

EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson

A person that also matches the query, but was not selected due to a lower affinity with the requesting user.

EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader

Recommended header to display for the card.

EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard

An answer card for a single person.

EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard

An answer card for a list of people that are related to the subject of the query.

EnterpriseTopazSidekickPeopleDisambiguationCard

EnterpriseTopazSidekickPerson

Person.

EnterpriseTopazSidekickPersonProfileCard

EnterpriseTopazSidekickPersonProfileCardRelatedPeople

EnterpriseTopazSidekickPersonalizedDocsCardProto

Personalized docs card proto.

EnterpriseTopazSidekickRankingParams

Ranking params.

EnterpriseTopazSidekickRecentDocumentsCardProto

EnterpriseTopazSidekickScheduledMeeting

Details about scheduled meetings.

EnterpriseTopazSidekickShareMeetingDocsCardProto

Share meeting docs card proto.

EnterpriseTopazSidekickTimeSlot

Slot of time.

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

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

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.

GSuitePrincipal

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

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

The options for html properties.

HtmlValues

List of html values.

IndexItemOptions

IndexItemRequest

InitializeCustomerRequest

Request message for InitializeCustomer method.

IntegerFacetingOptions

Used to specify integer faceting options.

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

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. For more information see Map ACLs.

ItemContent

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.

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

MapInfo

Geo information used for rendering a map that shows the user's work location.

MapTile

Information used to render a map tile image in the proper location on a map.

MatchRange

Matched range of a snippet [start, end).

Media

Media resource.

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

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.

PeoplePromotionCard

PeopleSuggestion

This field contains information about the person being suggested.

Person

Object to represent a person.

PersonCore

Information for rendering a person. NEXT ID: 37

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.

QueryItem

Information relevant only to a query entry.

QueryOperator

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

QuerySource

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

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.

RemoveActivityRequest

Remove Logged Activity Request.

RemoveActivityResponse

Remove Logged Activity Response. will return an empty response for now. Will be revisited in later phases.

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

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. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.

SafeUrlProto

Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code.

Schema

The schema definition for a data source.

ScoringConfig

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

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. NEXT ID: 17

SearchResponse

The search API response. NEXT ID: 17

SearchResult

Results containing indexed information for a document.

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.

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