/** * Copyright 2019 Google LLC * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at * * http://www.apache.org/licenses/LICENSE-2.0 * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * See the License for the specific language governing permissions and * limitations under the License. */ import { GaxiosPromise } from 'gaxios'; import { Compute, JWT, OAuth2Client, UserRefreshClient } from 'google-auth-library'; import { BodyResponseCallback, GlobalOptions, GoogleConfigurable, MethodOptions } from 'googleapis-common'; export declare namespace cloudsearch_v1 { interface Options extends GlobalOptions { version: 'v1'; } interface StandardParameters { /** * V1 error format. */ '$.xgafv'?: string; /** * OAuth access token. */ access_token?: string; /** * Data format for response. */ alt?: string; /** * JSONP */ callback?: string; /** * Selector specifying which fields to include in a partial response. */ fields?: string; /** * API key. Your API key identifies your project and provides you with API * access, quota, and reports. Required unless you provide an OAuth 2.0 * token. */ key?: string; /** * OAuth 2.0 token for the current user. */ oauth_token?: string; /** * Returns response with indentations and line breaks. */ prettyPrint?: boolean; /** * Available to use for quota purposes for server-side applications. Can be * any arbitrary string assigned to a user, but should not exceed 40 * characters. */ quotaUser?: string; /** * Legacy upload protocol for media (e.g. "media", "multipart"). */ uploadType?: string; /** * Upload protocol for media (e.g. "raw", "multipart"). */ upload_protocol?: string; } /** * Cloud Search API * * 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. * * @example * const {google} = require('googleapis'); * const cloudsearch = google.cloudsearch('v1'); * * @namespace cloudsearch * @type {Function} * @version v1 * @variation v1 * @param {object=} options Options for Cloudsearch */ class Cloudsearch { debug: Resource$Debug; indexing: Resource$Indexing; media: Resource$Media; operations: Resource$Operations; query: Resource$Query; settings: Resource$Settings; stats: Resource$Stats; constructor(options: GlobalOptions, google?: GoogleConfigurable); } /** * 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. */ interface Schema$BooleanOperatorOptions { /** * Indicates the operator name required in the query in order to isolate the * boolean property. For example, if operatorName is *closed* and the * property's name is *isClosed*, then queries like * *closed:&lt;value&gt;* will show results only where the value of * the property named *isClosed* matches *&lt;value&gt;*. By * contrast, a search that uses the same *&lt;value&gt;* without an * operator will return all items where *&lt;value&gt;* matches the * value of any String properties or text within the content field for the * item. The operator name can only contain lowercase letters (a-z). The * maximum length is 32 characters. */ operatorName?: string; } /** * Options for boolean properties. */ interface Schema$BooleanPropertyOptions { /** * If set, describes how the boolean should be used as a search operator. */ operatorOptions?: Schema$BooleanOperatorOptions; } interface Schema$CheckAccessResponse { /** * Returns true if principal has access. Returns false otherwise. */ hasAccess?: boolean; } interface Schema$CompositeFilter { /** * The logic operator of the sub filter. */ logicOperator?: string; /** * Sub filters. */ subFilters?: Schema$Filter[]; } /** * Aggregation of items by status code as of the specified date. */ interface Schema$CustomerIndexStats { /** * Date for which statistics were calculated. */ date?: Schema$Date; /** * Number of items aggregrated by status code. */ itemCountByStatus?: Schema$ItemCountByStatus[]; } /** * Data source is a logical namespace for items to be indexed. All items must * belong to a data source. This is the prerequisite before items can be * indexed into Cloud Search. */ interface Schema$DataSource { /** * If true, Indexing API rejects any modification calls to this data source * such as create, update, and delete. Disabling this does not imply halting * process of previously accepted data. */ disableModifications?: boolean; /** * Disable serving any search or assist results. */ disableServing?: boolean; /** * Required. Display name of the data source The maximum length is 300 * characters. */ displayName?: string; /** * List of service accounts that have indexing access. */ indexingServiceAccounts?: string[]; /** * This restricts visibility to items at a data source level to the * disjunction of users/groups mentioned with the field. Note that, this * does not ensure access to a specific item, as users need to have ACL * permissions on the contained items. This ensures a high level access on * the entire data source, and that the individual items are not shared * outside this visibility. */ itemsVisibility?: Schema$GSuitePrincipal[]; /** * Name of the data source resource. Format: datasources/{source_id}. <br * />The name is ignored when creating a data source. */ name?: string; /** * IDs of the Long Running Operations (LROs) currently running for this * schema. */ operationIds?: string[]; /** * A short name or alias for the source. This value will be used to match * the 'source' operator. For example, if the short name is * *&lt;value&gt;* then queries like *source:&lt;value&gt;* * will only return results for this source. The value must be unique across * all data sources. The value must only contain alphanumeric characters * (a-zA-Z0-9). The value cannot start with 'google' and cannot be * one of the following: mail, gmail, docs, drive, groups, sites, calendar, * hangouts, gplus, keep, people, teams. Its maximum length is 32 * characters. */ shortName?: string; } /** * Aggregation of items by status code as of the specified date. */ interface Schema$DataSourceIndexStats { /** * Date for which index stats were calculated. If the date of request is not * the current date then stats calculated on the next day are returned. * Stats are calculated close to mid night in this case. If date of request * is current date, then real time stats are returned. */ date?: Schema$Date; /** * Number of items aggregrated by status code. */ itemCountByStatus?: Schema$ItemCountByStatus[]; } /** * Restriction on Datasource. */ interface Schema$DataSourceRestriction { /** * Filter options restricting the results. If multiple filters are present, * they are grouped by object type before joining. Filters with the same * object type are joined conjunctively, then the resulting expressions are * joined disjunctively. The maximum number of elements is 20. */ filterOptions?: Schema$FilterOptions[]; /** * The source of restriction. */ source?: Schema$Source; } /** * 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](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The * date must be a valid calendar date between the year 1 and 9999. */ interface Schema$Date { /** * Day of month. Must be from 1 to 31 and valid for the year and month. */ day?: number; /** * Month of date. Must be from 1 to 12. */ month?: number; /** * Year of date. Must be from 1 to 9999. */ year?: number; } /** * 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. */ interface Schema$DateOperatorOptions { /** * Indicates the operator name required in the query in order to isolate the * date property using the greater-than operator. For example, if * greaterThanOperatorName is *closedafter* and the property's name is * *closeDate*, then queries like *closedafter:&lt;value&gt;* will * show results only where the value of the property named *closeDate* is * later than *&lt;value&gt;*. The operator name can only contain * lowercase letters (a-z). The maximum length is 32 characters. */ greaterThanOperatorName?: string; /** * Indicates the operator name required in the query in order to isolate the * date property using the less-than operator. For example, if * lessThanOperatorName is *closedbefore* and the property's name is * *closeDate*, then queries like *closedbefore:&lt;value&gt;* will * show results only where the value of the property named *closeDate* is * earlier than *&lt;value&gt;*. The operator name can only contain * lowercase letters (a-z). The maximum length is 32 characters. */ lessThanOperatorName?: string; /** * Indicates the actual string required in the query in order to isolate the * date property. For example, suppose an issue tracking schema object has a * property named *closeDate* that specifies an operator with an * operatorName of *closedon*. For searches on that data, queries like * *closedon:&lt;value&gt;* will show results only where the value * of the *closeDate* property matches *&lt;value&gt;*. By contrast, * a search that uses the same *&lt;value&gt;* without an operator * will return all items where *&lt;value&gt;* matches the value of * any String properties or text within the content field for the indexed * datasource. The operator name can only contain lowercase letters (a-z). * The maximum length is 32 characters. */ operatorName?: string; } /** * Options for date properties. */ interface Schema$DatePropertyOptions { /** * If set, describes how the date should be used as a search operator. */ operatorOptions?: Schema$DateOperatorOptions; } /** * List of date values. */ interface Schema$DateValues { values?: Schema$Date[]; } /** * Shared request debug options for all cloudsearch RPC methods. */ interface Schema$DebugOptions { /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ enableDebugging?: boolean; } interface Schema$DeleteQueueItemsRequest { /** * Name of connector making this call. <br />Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * Common debug options. */ debugOptions?: Schema$DebugOptions; /** * Name of a queue to delete items from. */ queue?: string; } /** * 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. */ interface Schema$DisplayedProperty { /** * The name of the top-level property as defined in a property definition * for the object. If the name is not a defined property in the schema, an * error will be given when attempting to update the schema. */ propertyName?: string; } /** * 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. */ interface Schema$DoubleOperatorOptions { /** * Indicates the operator name required in the query in order to use the * double property in sorting or as a facet. The operator name can only * contain lowercase letters (a-z). The maximum length is 32 characters. */ operatorName?: string; } /** * Options for double properties. */ interface Schema$DoublePropertyOptions { /** * If set, describes how the double should be used as a search operator. */ operatorOptions?: Schema$DoubleOperatorOptions; } /** * List of double values. */ interface Schema$DoubleValues { values?: number[]; } /** * Drive follow-up search restricts (e.g. "followup:suggestions"). */ interface Schema$DriveFollowUpRestrict { type?: string; } /** * Drive location search restricts (e.g. "is:starred"). */ interface Schema$DriveLocationRestrict { type?: string; } /** * Drive mime-type search restricts (e.g. "type:pdf"). */ interface Schema$DriveMimeTypeRestrict { type?: string; } /** * The time span search restrict (e.g. "after:2017-09-11 * before:2017-09-12"). */ interface Schema$DriveTimeSpanRestrict { type?: string; } /** * A person's email address. */ interface Schema$EmailAddress { /** * The email address. */ emailAddress?: string; } /** * 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*. */ interface Schema$EnumOperatorOptions { /** * Indicates the operator name required in the query in order to isolate the * enum property. For example, if operatorName is *priority* and the * property's name is *priorityVal*, then queries like * *priority:&lt;value&gt;* will show results only where the value * of the property named *priorityVal* matches *&lt;value&gt;*. By * contrast, a search that uses the same *&lt;value&gt;* without an * operator will return all items where *&lt;value&gt;* matches the * value of any String properties or text within the content field for the * item. The operator name can only contain lowercase letters (a-z). The * maximum length is 32 characters. */ operatorName?: string; } /** * 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*. */ interface Schema$EnumPropertyOptions { /** * If set, describes how the enum should be used as a search operator. */ operatorOptions?: Schema$EnumOperatorOptions; /** * Used to specify the ordered ranking for the enumeration that determines * how the integer values provided in the possible EnumValuePairs are used * to rank results. If specified, integer values must be provided for all * possible EnumValuePair values given for this property. Can only be used * if isRepeatable is false. */ orderedRanking?: string; /** * The list of possible values for the enumeration property. All * EnumValuePairs must provide a string value. If you specify an integer * value for one EnumValuePair, then all possible EnumValuePairs must * provide an integer value. Both the string value and integer value must be * unique over all possible values. Once set, possible values cannot be * removed or modified. If you supply an ordered ranking and think you might * insert additional enum values in the future, leave gaps in the initial * integer values to allow adding a value in between previously registered * values. The maximum number of elements is 100. */ possibleValues?: Schema$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. */ interface Schema$EnumValuePair { /** * The integer value of the EnumValuePair which must be non-negative. * Optional. */ integerValue?: number; /** * The string value of the EnumValuePair. The maximum length is 32 * characters. */ stringValue?: string; } /** * List of enum values. */ interface Schema$EnumValues { /** * The maximum allowable length for string values is 32 characters. */ values?: string[]; } /** * Error information about the response. */ interface Schema$ErrorInfo { errorMessages?: Schema$ErrorMessage[]; } /** * Error message per source response. */ interface Schema$ErrorMessage { errorMessage?: string; source?: Schema$Source; } /** * 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. */ interface Schema$FacetBucket { /** * Number of results that match the bucket value. */ count?: number; /** * Percent of results that match the bucket value. This value is between * (0-100]. This may not be accurate and is a best effort estimate. */ percentage?: number; value?: Schema$Value; } /** * Specifies operators to return facet results for. There will be one * FacetResult for every source_name/object_type/operator_name combination. */ interface Schema$FacetOptions { /** * If object_type is set, only those objects of that type will be used to * compute facets. If empty, then all objects will be used to compute * facets. */ objectType?: string; /** * Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions */ operatorName?: string; /** * Source name to facet on. Format: datasources/{source_id} If empty, all * data sources will be used. */ sourceName?: string; } /** * Source specific facet response */ interface Schema$FacetResult { /** * FacetBuckets for values in response containing atleast a single result. */ buckets?: Schema$FacetBucket[]; /** * Object type for which facet results are returned. Can be empty. */ objectType?: string; /** * Name of the operator chosen for faceting. @see cloudsearch.SchemaPropertyOptions */ operatorName?: string; /** * Source name for which facet results are returned. Will not be empty. */ sourceName?: string; } interface Schema$FieldViolation { /** * Description of the error. */ description?: string; /** * Path of field with violation. */ field?: string; } /** * 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. */ interface Schema$Filter { compositeFilter?: Schema$CompositeFilter; valueFilter?: Schema$ValueFilter; } /** * Filter options to be applied on query. */ interface Schema$FilterOptions { /** * Generic filter to restrict the search, such as `lang:en`, `site:xyz`. */ filter?: Schema$Filter; /** * If object_type is set, only objects of that type are returned. This * should correspond to the name of the object that was registered within * the definition of schema. The maximum length is 256 characters. */ objectType?: string; } /** * 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. */ interface Schema$FreshnessOptions { /** * The duration (in seconds) after which an object should be considered * stale. */ freshnessDuration?: string; /** * This property indicates the freshness level of the object in the index. * If set, this property must be a top-level property within the property * definitions and it must be a timestamp type or date type. Otherwise, the * Indexing API uses updateTime as the freshness indicator. The maximum * length is 256 characters. */ freshnessProperty?: string; } interface Schema$GetCustomerIndexStatsResponse { /** * Summary of indexed item counts, one for each day in the requested range. */ stats?: Schema$CustomerIndexStats[]; } interface Schema$GetDataSourceIndexStatsResponse { /** * Summary of indexed item counts, one for each day in the requested range. */ stats?: Schema$DataSourceIndexStats[]; } interface Schema$GSuitePrincipal { /** * This principal represents all users of the G Suite domain of the * customer. */ gsuiteDomain?: boolean; /** * This principal references a G Suite group account */ gsuiteGroupEmail?: string; /** * This principal references a G Suite user account */ gsuiteUserEmail?: string; } /** * 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. */ interface Schema$HtmlOperatorOptions { /** * Indicates the operator name required in the query in order to isolate the * html property. For example, if operatorName is *subject* and the * property's name is *subjectLine*, then queries like * *subject:&lt;value&gt;* will show results only where the value of * the property named *subjectLine* matches *&lt;value&gt;*. By * contrast, a search that uses the same *&lt;value&gt;* without an * operator will return all items where *&lt;value&gt;* matches the * value of any html properties or text within the content field for the * item. The operator name can only contain lowercase letters (a-z). The * maximum length is 32 characters. */ operatorName?: string; } /** * Options for html properties. */ interface Schema$HtmlPropertyOptions { /** * If set, describes how the property should be used as a search operator. */ operatorOptions?: Schema$HtmlOperatorOptions; /** * Indicates the search quality importance of the tokens within the field * when used for retrieval. Can only be set to DEFAULT or NONE. */ retrievalImportance?: Schema$RetrievalImportance; } /** * List of html values. */ interface Schema$HtmlValues { /** * The maximum allowable length for html values is 2048 characters. */ values?: string[]; } interface Schema$IndexItemRequest { /** * Name of connector making this call. <br />Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * Common debug options. */ debugOptions?: Schema$DebugOptions; /** * Name of the item. Format: datasources/{source_id}/items/{item_id} */ item?: Schema$Item; /** * Required. The RequestMode for this request. */ mode?: string; } /** * 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. */ interface Schema$IntegerOperatorOptions { /** * Indicates the operator name required in the query in order to isolate the * integer property using the greater-than operator. For example, if * greaterThanOperatorName is *priorityabove* and the property's name is * *priorityVal*, then queries like *priorityabove:&lt;value&gt;* * will show results only where the value of the property named * *priorityVal* is greater than *&lt;value&gt;*. The operator name * can only contain lowercase letters (a-z). The maximum length is 32 * characters. */ greaterThanOperatorName?: string; /** * Indicates the operator name required in the query in order to isolate the * integer property using the less-than operator. For example, if * lessThanOperatorName is *prioritybelow* and the property's name is * *priorityVal*, then queries like *prioritybelow:&lt;value&gt;* * will show results only where the value of the property named * *priorityVal* is less than *&lt;value&gt;*. The operator name can * only contain lowercase letters (a-z). The maximum length is 32 * characters. */ lessThanOperatorName?: string; /** * Indicates the operator name required in the query in order to isolate the * integer property. For example, if operatorName is *priority* and the * property's name is *priorityVal*, then queries like * *priority:&lt;value&gt;* will show results only where the value * of the property named *priorityVal* matches *&lt;value&gt;*. By * contrast, a search that uses the same *&lt;value&gt;* without an * operator will return all items where *&lt;value&gt;* matches the * value of any String properties or text within the content field for the * item. The operator name can only contain lowercase letters (a-z). The * maximum length is 32 characters. */ operatorName?: string; } /** * Options for integer properties. */ interface Schema$IntegerPropertyOptions { /** * The maximum value of the property. The minimum and maximum values for the * property are used to rank results according to the ordered ranking. * Indexing requests with values greater than the maximum are accepted and * ranked with the same weight as items indexed with the maximum value. */ maximumValue?: string; /** * The minimum value of the property. The minimum and maximum values for the * property are used to rank results according to the ordered ranking. * Indexing requests with values less than the minimum are accepted and * ranked with the same weight as items indexed with the minimum value. */ minimumValue?: string; /** * If set, describes how the integer should be used as a search operator. */ operatorOptions?: Schema$IntegerOperatorOptions; /** * Used to specify the ordered ranking for the integer. Can only be used if * isRepeatable is false. */ orderedRanking?: string; } /** * List of integer values. */ interface Schema$IntegerValues { values?: string[]; } /** * Represents an interaction between a user and an item. */ interface Schema$Interaction { /** * The time when the user acted on the item. If multiple actions of the * same type exist for a single user, only the most recent action is * recorded. */ interactionTime?: string; /** * The user that acted on the item. */ principal?: Schema$Principal; type?: string; } /** * Represents a single object that is an item in the search index, such as a * file, folder, or a database record. */ interface Schema$Item { /** * Access control list for this item. */ acl?: Schema$ItemAcl; /** * Item content to be indexed and made text searchable. */ content?: Schema$ItemContent; /** * Type for this item. */ itemType?: string; /** * Metadata information. */ metadata?: Schema$ItemMetadata; /** * Name of the Item. Format: datasources/{source_id}/items/{item_id} <br * />This is a required field. The maximum length is 1536 characters. */ name?: string; /** * Additional state connector can store for this item. The maximum length is * 10000 bytes. */ payload?: string; /** * Queue this item belongs to. The maximum length is 100 characters. */ queue?: string; /** * Status of the item. Output only field. */ status?: Schema$ItemStatus; /** * The structured data for the item that should conform to a registered * object definition in the schema for the data source. */ structuredData?: Schema$ItemStructuredData; /** * Required. The indexing system stores the version from the datasource as a * byte string and compares the Item version in the index to the version of * the queued Item using lexical ordering. <br /><br /> Cloud * Search Indexing won't index or delete any queued item with a version * value that is less than or equal to the version of the currently indexed * item. The maximum length for this field is 1024 bytes. */ version?: string; } /** * Access control list information for the item. For more information see * https://developers.google.com/cloud-search/docs/guides/index-your-data#acls */ interface Schema$ItemAcl { /** * Sets the type of access rules to apply when an item inherits its ACL from * a parent. This should always be set in tandem with the inheritAclFrom * field. Also, when the inheritAclFrom field is set, this field should be * set to a valid AclInheritanceType. */ aclInheritanceType?: string; /** * List of principals who are explicitly denied access to the item in search * results. While principals are denied access by default, use denied * readers to handle exceptions and override the list allowed readers. The * maximum number of elements is 100. */ deniedReaders?: Schema$Principal[]; /** * Name of the item to inherit the Access Permission List (ACL) from. Note: * ACL inheritance *only* provides access permissions to child items and * does not define structural relationships, nor does it provide convenient * ways to delete large groups of items. Deleting an ACL parent from the * index only alters the access permissions of child items that reference * the parent in the inheritAclFrom field. The item is still in the index, * but may not visible in search results. By contrast, deletion of a * container item also deletes all items that reference the container via * the containerName field. The maximum length for this field is 1536 * characters. */ inheritAclFrom?: string; /** * Optional. List of owners for the item. This field has no bearing on * document access permissions. It does, however, offer a slight ranking * boosts items where the querying user is an owner. The maximum number of * elements is 5. */ owners?: Schema$Principal[]; /** * List of principals who are allowed to see the item in search results. * Optional if inheriting permissions from another item or if the item is * not intended to be visible, such as virtual containers. The maximum * number of elements is 1000. */ readers?: Schema$Principal[]; } /** * Content of an item to be indexed and surfaced by Cloud Search. */ interface Schema$ItemContent { /** * Upload reference ID of a previously uploaded content via write method. */ contentDataRef?: Schema$UploadItemRef; contentFormat?: string; /** * Hashing info calculated and provided by the API client for content. Can * be used with the items.push method to calculate modified state. The * maximum length is 2048 characters. */ hash?: string; /** * Content that is supplied inlined within the update method. The maximum * length is 102400 bytes (100 KiB). */ inlineContent?: string; } interface Schema$ItemCountByStatus { /** * Number of items matching the status code. */ count?: string; /** * Status of the items. */ statusCode?: string; } /** * Available metadata fields for the item. */ interface Schema$ItemMetadata { /** * The name of the container for this item. Deletion of the container item * leads to automatic deletion of this item. Note: ACLs are not inherited * from a container item. To provide ACL inheritance for an item, use the * inheritAclFrom field. The maximum length is 1536 characters. */ containerName?: string; /** * The BCP-47 language code for the item, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The * maximum length is 32 characters. */ contentLanguage?: string; /** * The time when the item was created in the source repository. */ createTime?: string; /** * Hashing value provided by the API caller. This can be used with the * items.push method to calculate modified state. The maximum length is 2048 * characters. */ hash?: string; /** * A list of interactions for the item. Interactions are used to improve * Search quality, but are not exposed to end users. The maximum number of * elements is 1000. */ interactions?: Schema$Interaction[]; /** * Additional keywords or phrases that should match the item. Used * internally for user generated content. The maximum number of elements is * 100. The maximum length is 8192 characters. */ keywords?: string[]; /** * The original mime-type of ItemContent.content in the source repository. * The maximum length is 256 characters. */ mimeType?: string; /** * The type of the item. This should correspond to the name of an object * definition in the schema registered for the data source. For example, if * the schema for the data source contains an object definition with name * 'document', then item indexing requests for objects of that type * should set objectType to 'document'. The maximum length is 256 * characters. */ objectType?: string; /** * Additional search quality metadata of the item */ searchQualityMetadata?: Schema$SearchQualityMetadata; /** * Link to the source repository serving the data. &#83;earch results * apply this link to the title. The maximum length is 2048 characters. */ sourceRepositoryUrl?: string; /** * The title of the item. If given, this will be the displayed title of the * Search result. The maximum length is 2048 characters. */ title?: string; /** * The time when the item was last modified in the source repository. */ updateTime?: string; } /** * This contains item's status and any errors. */ interface Schema$ItemStatus { /** * Status code. */ code?: string; /** * Error details in case the item is in ERROR state. */ processingErrors?: Schema$ProcessingError[]; /** * Repository error reported by connector. */ repositoryErrors?: Schema$RepositoryError[]; } /** * Available structured data fields for the item. */ interface Schema$ItemStructuredData { /** * Hashing value provided by the API caller. This can be used with the * items.push method to calculate modified state. The maximum length is 2048 * characters. */ hash?: string; /** * The structured data object that should conform to a registered object * definition in the schema for the data source. */ object?: Schema$StructuredDataObject; } interface Schema$ListDataSourceResponse { /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; sources?: Schema$DataSource[]; } interface Schema$ListItemNamesForUnmappedIdentityResponse { itemNames?: string[]; /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; } interface Schema$ListItemsResponse { items?: Schema$Item[]; /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; } /** * List sources response. */ interface Schema$ListQuerySourcesResponse { nextPageToken?: string; sources?: Schema$QuerySource[]; } interface Schema$ListSearchApplicationsResponse { /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; searchApplications?: Schema$SearchApplication[]; } interface Schema$ListUnmappedIdentitiesResponse { /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; unmappedIdentities?: Schema$UnmappedIdentity[]; } /** * Matched range of a snippet [start, end). */ interface Schema$MatchRange { /** * End of the match in the snippet. */ end?: number; /** * Starting position of the match in the snippet. */ start?: number; } /** * Media resource. */ interface Schema$Media { /** * Name of the media resource. */ resourceName?: string; } /** * Metadata of a matched search result. */ interface Schema$Metadata { /** * The creation time for this document or object in the search result. */ createTime?: string; /** * Options that specify how to display a structured data search result. */ displayOptions?: Schema$ResultDisplayMetadata; /** * Indexed fields in structured data, returned as a generic named property. */ fields?: Schema$NamedProperty[]; /** * Mime type of the search result. */ mimeType?: string; /** * Object type of the search result. */ objectType?: string; /** * Owner (usually creator) of the document or object of the search result. */ owner?: Schema$Person; /** * The named source for the result, such as Gmail. */ source?: Schema$Source; /** * The last modified date for the object in the search result. */ updateTime?: string; } /** * A metaline is a list of properties that are displayed along with the search * result to provide context. */ interface Schema$Metaline { /** * The list of displayed properties for the metaline. */ properties?: Schema$DisplayedProperty[]; } /** * A person's name. */ interface Schema$Name { /** * The read-only display name formatted according to the locale specified by * the viewer's account or the <code>Accept-Language</code> * HTTP header. */ displayName?: string; } /** * 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`. */ interface Schema$NamedProperty { booleanValue?: boolean; dateValues?: Schema$DateValues; doubleValues?: Schema$DoubleValues; enumValues?: Schema$EnumValues; htmlValues?: Schema$HtmlValues; integerValues?: Schema$IntegerValues; /** * The name of the property. This name should correspond to the name of the * property that was registered for object definition in the schema. The * maximum allowable length for this property is 256 characters. */ name?: string; objectValues?: Schema$ObjectValues; textValues?: Schema$TextValues; timestampValues?: Schema$TimestampValues; } /** * The definition for an object within a data source. */ interface Schema$ObjectDefinition { /** * Name for the object, which then defines its type. Item indexing requests * should set the objectType field equal to this value. For example, if * *name* is *Document*, then indexing requests for items of type Document * should set objectType equal to *Document*. Each object definition must be * uniquely named within a schema. The name must start with a letter and can * only contain letters (A-Z, a-z) or numbers (0-9). The maximum length is * 256 characters. */ name?: string; /** * The optional object-specific options. */ options?: Schema$ObjectOptions; /** * The property definitions for the object. The maximum number of elements * is 1000. */ propertyDefinitions?: Schema$PropertyDefinition[]; } /** * The display options for an object. */ interface Schema$ObjectDisplayOptions { /** * Defines the properties that will be displayed in the metalines of the * search results. The property values will be displayed in the order given * here. If a property holds multiple values, all of the values will be * diplayed before the next properties. For this reason, it is a good * practice to specify singular properties before repeated properties in * this list. All of the properties must set is_returnable to true. The * maximum number of elements is 3. */ metalines?: Schema$Metaline[]; /** * The user friendly label to display in the search result to inidicate the * type of the item. This is OPTIONAL; if not given, an object label will * not be displayed on the context line of the search results. The maximum * length is 32 characters. */ objectDisplayLabel?: string; } /** * The options for an object. */ interface Schema$ObjectOptions { /** * Options that determine how the object is displayed in the Cloud Search * results page. */ displayOptions?: Schema$ObjectDisplayOptions; /** * The freshness options for an object. */ freshnessOptions?: Schema$FreshnessOptions; } /** * Options for object properties. */ interface Schema$ObjectPropertyOptions { /** * The properties of the sub-object. These properties represent a nested * object. For example, if this property represents a postal address, the * subobjectProperties might be named *street*, *city*, and *state*. The * maximum number of elements is 1000. */ subobjectProperties?: Schema$PropertyDefinition[]; } /** * List of object values. */ interface Schema$ObjectValues { values?: Schema$StructuredDataObject[]; } /** * This resource represents a long-running operation that is the result of a * network API call. */ interface Schema$Operation { /** * If the value is `false`, it means the operation is still in progress. If * `true`, the operation is completed, and either `error` or `response` is * available. */ done?: boolean; /** * The error result of the operation in case of failure or cancellation. */ error?: Schema$Status; /** * Service-specific metadata associated with the operation. It typically * contains progress information and common metadata such as create time. * Some services might not provide such metadata. Any method that returns a * long-running operation should document the metadata type, if any. */ metadata?: { [key: string]: any; }; /** * The server-assigned name, which is only unique within the same service * that originally returns it. If you use the default HTTP mapping, the * `name` should have the format of `operations/some/unique/name`. */ name?: string; /** * The normal response of the operation in case of success. If the original * method returns no data on success, such as `Delete`, the response is * `google.protobuf.Empty`. If the original method is standard * `Get`/`Create`/`Update`, the response should be the resource. For other * methods, the response should have the type `XxxResponse`, where `Xxx` is * the original method name. For example, if the original method name is * `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. */ response?: { [key: string]: any; }; } /** * A people suggestion. */ interface Schema$PeopleSuggestion { /** * Suggested person. All fields of the person object might not be populated. */ person?: Schema$Person; } /** * Object to represent a person. */ interface Schema$Person { /** * The person's email addresses */ emailAddresses?: Schema$EmailAddress[]; /** * The resource name of the person to provide information about. See <a * href="https://developers.google.com/people/api/rest/v1/people/get"> * People.get</a> from Google People API. */ name?: string; /** * Obfuscated ID of a person. */ obfuscatedId?: string; /** * The person's name */ personNames?: Schema$Name[]; /** * A person's read-only photo. A picture shown next to the person's * name to help others recognize the person in search results. */ photos?: Schema$Photo[]; } /** * A person's photo. */ interface Schema$Photo { /** * The URL of the photo. */ url?: string; } interface Schema$PollItemsRequest { /** * Name of connector making this call. <br />Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * Common debug options. */ debugOptions?: Schema$DebugOptions; /** * Maximum number of items to return. <br />The maximum and the * default value is 1000 */ limit?: number; /** * Queue name to fetch items from. If unspecified, PollItems will fetch * from 'default' queue. The maximum length is 100 characters. */ queue?: string; /** * Limit the items polled to the ones with these statuses. */ statusCodes?: string[]; } interface Schema$PollItemsResponse { /** * Set of items from the queue available for connector to process. <br * />These items have the following subset of fields populated: <br * /> <br />version <br />metadata.hash <br * />structured_data.hash <br />content.hash <br />payload * <br />status <br />queue */ items?: Schema$Item[]; } /** * Reference to a user, group, or domain. */ interface Schema$Principal { /** * This principal is a group identified using an external identity. The name * field must specify the group resource name with this format: * identitysources/{source_id}/groups/{ID} */ groupResourceName?: string; /** * This principal is a GSuite user, group or domain. */ gsuitePrincipal?: Schema$GSuitePrincipal; /** * This principal is a user identified using an external identity. The name * field must specify the user resource name with this format: * identitysources/{source_id}/users/{ID} */ userResourceName?: string; } interface Schema$ProcessingError { /** * Error code indicating the nature of the error. */ code?: string; /** * Description of the error. */ errorMessage?: string; /** * In case the item fields are invalid, this field contains the details * about the validation errors. */ fieldViolations?: Schema$FieldViolation[]; } /** * The definition of a property within an object. */ interface Schema$PropertyDefinition { booleanPropertyOptions?: Schema$BooleanPropertyOptions; datePropertyOptions?: Schema$DatePropertyOptions; /** * Options that determine how the property is displayed in the Cloud Search * results page if it is specified to be displayed in the object's * display options . */ displayOptions?: Schema$PropertyDisplayOptions; doublePropertyOptions?: Schema$DoublePropertyOptions; enumPropertyOptions?: Schema$EnumPropertyOptions; htmlPropertyOptions?: Schema$HtmlPropertyOptions; integerPropertyOptions?: Schema$IntegerPropertyOptions; /** * Indicates that the property can be used for generating facets. Cannot be * true for properties whose type is object. IsReturnable must be true to * set this option. Only supported for Boolean, Enum, and Text properties. */ isFacetable?: boolean; /** * Indicates that multiple values are allowed for the property. For example, * a document only has one description but can have multiple comments. * Cannot be true for properties whose type is a boolean. If set to false, * properties that contain more than one value will cause the indexing * request for that item to be rejected. */ isRepeatable?: boolean; /** * Indicates that the property identifies data that should be returned in * search results via the Query API. If set to *true*, indicates that Query * API users can use matching property fields in results. However, storing * fields requires more space allocation and uses more bandwidth for search * queries, which impacts performance over large datasets. Set to *true* * here only if the field is needed for search results. Cannot be true for * properties whose type is an object. */ isReturnable?: boolean; /** * Indicates that the property can be used for sorting. Cannot be true for * properties that are repeatable. Cannot be true for properties whose type * is object or user identifier. IsReturnable must be true to set this * option. Only supported for Boolean, Date, Double, Integer, and Timestamp * properties. */ isSortable?: boolean; /** * The name of the property. Item indexing requests sent to the Indexing API * should set the property name equal to this value. For example, if name is * *subject_line*, then indexing requests for document items with subject * fields should set the name for that field equal to *subject_line*. Use * the name as the identifier for the object property. Once registered as a * property for an object, you cannot re-use this name for another property * within that object. The name must start with a letter and can only * contain letters (A-Z, a-z) or numbers (0-9). The maximum length is 256 * characters. */ name?: string; objectPropertyOptions?: Schema$ObjectPropertyOptions; textPropertyOptions?: Schema$TextPropertyOptions; timestampPropertyOptions?: Schema$TimestampPropertyOptions; } /** * The display options for a property. */ interface Schema$PropertyDisplayOptions { /** * The user friendly label for the property that will be used if the * property is specified to be displayed in ObjectDisplayOptions. If given, * the display label will be shown in front of the property values when the * property is part of the object display options. For example, if the * property value is '1', the value by itself may not be useful * context for the user. If the display name given was 'priority', * then the user will see 'priority : 1' in the search results which * provides clear conext to search users. This is OPTIONAL; if not given, * only the property values will be displayed. The maximum length is 32 * characters. */ displayLabel?: string; } /** * Represents an item to be pushed to the indexing queue. */ interface Schema$PushItem { /** * Content hash of the item according to the repository. If specified, this * is used to determine how to modify this item's status. Setting this * field and the type field results in argument error. The maximum length is * 2048 characters. */ contentHash?: string; /** * Metadata hash of the item according to the repository. If specified, this * is used to determine how to modify this item's status. Setting this * field and the type field results in argument error. The maximum length is * 2048 characters. */ metadataHash?: string; /** * Provides additional document state information for the connector, such as * an alternate repository ID and other metadata. The maximum length is 8192 * bytes. */ payload?: string; /** * Queue to which this item belongs to. The * <code>default</code> queue is chosen if this field is not * specified. The maximum length is 512 characters. */ queue?: string; /** * Populate this field to store Connector or repository error details. This * information is displayed in the Admin Console. This field may only be * populated when the Type is REPOSITORY_ERROR. */ repositoryError?: Schema$RepositoryError; /** * Structured data hash of the item according to the repository. If * specified, this is used to determine how to modify this item's * status. Setting this field and the type field results in argument error. * The maximum length is 2048 characters. */ structuredDataHash?: string; /** * The type of the push operation that defines the push behavior. */ type?: string; } interface Schema$PushItemRequest { /** * Name of connector making this call. <br />Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * Common debug options. */ debugOptions?: Schema$DebugOptions; /** * Item to push onto the queue. */ item?: Schema$PushItem; } interface Schema$QueryInterpretation { interpretationType?: string; /** * The interpretation of the query used in search. For example, query * "email from john" will be interpreted as "from:john * source:mail" */ interpretedQuery?: string; } /** * Options to interpret user query. */ interface Schema$QueryInterpretationOptions { /** * Flag to disable natural language (NL) interpretation of queries. Default * is false, Set to true to disable natural language interpretation. NL * interpretation only applies to predefined datasources. */ disableNlInterpretation?: boolean; } /** * Information relevant only to a query entry. */ interface Schema$QueryItem { /** * True if the text was generated by means other than a previous user * search. */ isSynthetic?: boolean; } /** * The definition of a operator that can be used in a Search/Suggest request. */ interface Schema$QueryOperator { /** * Display name of the operator */ displayName?: string; /** * Potential list of values for the opeatror field. This field is only * filled when we can safely enumerate all the possible values of this * operator. */ enumValues?: string[]; /** * Indicates the operator name that can be used to isolate the property * using the greater-than operator. */ greaterThanOperatorName?: string; /** * Can this operator be used to get facets. */ isFacetable?: boolean; /** * Indicates if multiple values can be set for this property. */ isRepeatable?: boolean; /** * Will the property associated with this facet be returned as part of * search results. */ isReturnable?: boolean; /** * Can this operator be used to sort results. */ isSortable?: boolean; /** * Can get suggestions for this field. */ isSuggestable?: boolean; /** * Indicates the operator name that can be used to isolate the property * using the less-than operator. */ lessThanOperatorName?: string; /** * The name of the operator. */ operatorName?: string; /** * Type of the operator. */ type?: string; } /** * List of sources that the user can search using the query API. */ interface Schema$QuerySource { /** * Display name of the data source. */ displayName?: string; /** * List of all operators applicable for this source. */ operators?: Schema$QueryOperator[]; /** * A short name or alias for the source. This value can be used with the * 'source' operator. */ shortName?: string; /** * Name of the source */ source?: Schema$Source; } /** * A completed query suggestion. */ interface Schema$QuerySuggestion { } /** * Errors when the connector is communicating to the source repository. */ interface Schema$RepositoryError { /** * Message that describes the error. The maximum allowable length of the * message is 8192 characters. */ errorMessage?: string; /** * Error codes. Matches the definition of HTTP status codes. */ httpStatusCode?: number; /** * Type of error. */ type?: string; } /** * Shared request options for all RPC methods. */ interface Schema$RequestOptions { /** * Debug options of the request */ debugOptions?: Schema$DebugOptions; /** * The BCP-47 language code, such as "en-US" or * "sr-Latn". For more information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For * translations. */ languageCode?: string; /** * Id of the application created using SearchApplicationsService. */ searchApplicationId?: string; /** * Current user's time zone id, such as "America/Los_Angeles" * or "Australia/Sydney". These IDs are defined by [Unicode Common * Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and * currently available in the file * [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) */ timeZone?: string; } interface Schema$ResetSearchApplicationRequest { /** * Common debug options. */ debugOptions?: Schema$DebugOptions; } /** * Debugging information about the response. */ interface Schema$ResponseDebugInfo { /** * General debug info formatted for display. */ formattedDebugInfo?: string; } /** * Information relevant only to a restrict entry. NextId: 7 */ interface Schema$RestrictItem { driveFollowUpRestrict?: Schema$DriveFollowUpRestrict; driveLocationRestrict?: Schema$DriveLocationRestrict; driveMimeTypeRestrict?: Schema$DriveMimeTypeRestrict; driveTimeSpanRestrict?: Schema$DriveTimeSpanRestrict; /** * The search restrict (e.g. "after:2017-09-11 * before:2017-09-12"). */ searchOperator?: string; } /** * Result count information */ interface Schema$ResultCounts { /** * Result count information for each source with results. */ sourceResultCounts?: Schema$SourceResultCount[]; } /** * Debugging information about the result. */ interface Schema$ResultDebugInfo { /** * General debug info formatted for display. */ formattedDebugInfo?: string; } /** * Display Fields for Search Results */ interface Schema$ResultDisplayField { /** * The display label for the property. */ label?: string; /** * The operator name of the property. */ operatorName?: string; /** * The name value pair for the property. */ property?: Schema$NamedProperty; } /** * The collection of fields that make up a displayed line */ interface Schema$ResultDisplayLine { fields?: Schema$ResultDisplayField[]; } interface Schema$ResultDisplayMetadata { /** * The metalines content to be displayed with the result. */ metalines?: Schema$ResultDisplayLine[]; /** * The display label for the object. */ objectTypeLabel?: string; } interface Schema$RetrievalImportance { /** * Indicates the ranking importance given to property when it is matched * during retrieval. Once set, the token importance of a property cannot be * changed. */ importance?: string; } /** * The schema definition for a data source. */ interface Schema$Schema { /** * The list of top-level objects for the data source. The maximum number of * elements is 10. */ objectDefinitions?: Schema$ObjectDefinition[]; /** * IDs of the Long Running Operations (LROs) currently running for this * schema. After modifying the schema, wait for opeations to complete before * indexing additional content. */ operationIds?: string[]; } /** * Scoring configurations for a source while processing a Search or Suggest * request. */ interface Schema$ScoringConfig { /** * Whether to use freshness as a ranking signal. By default, freshness is * used as a ranking signal. */ disableFreshness?: boolean; /** * Whether to personalize the results. By default, personal signals will be * used to boost results. */ disablePersonalization?: boolean; } /** * SearchApplication */ interface Schema$SearchApplication { /** * Retrictions applied to the configurations. The maximum number of elements * is 10. */ dataSourceRestrictions?: Schema$DataSourceRestriction[]; /** * The default fields for returning facet results. The sources specified * here also have been included in data_source_restrictions above. */ defaultFacetOptions?: Schema$FacetOptions[]; /** * The default options for sorting the search results */ defaultSortOptions?: Schema$SortOptions; /** * Display name of the Search Application. The maximum length is 300 * characters. */ displayName?: string; /** * Name of the Search Application. <br />Format: * searchapplications/{application_id}. */ name?: string; /** * IDs of the Long Running Operations (LROs) currently running for this * schema. Output only field. */ operationIds?: string[]; /** * Configuration for ranking results. */ scoringConfig?: Schema$ScoringConfig; /** * Configuration for a sources specified in data_source_restrictions. */ sourceConfig?: Schema$SourceConfig[]; } interface Schema$SearchItemsByViewUrlRequest { /** * Common debug options. */ debugOptions?: Schema$DebugOptions; /** * The next_page_token value returned from a previous request, if any. */ pageToken?: string; /** * Specify the full view URL to find the corresponding item. The maximum * length is 2048 characters. */ viewUrl?: string; } interface Schema$SearchItemsByViewUrlResponse { items?: Schema$Item[]; /** * Token to retrieve the next page of results, or empty if there are no more * results in the list. */ nextPageToken?: string; } /** * Additional search quality metadata of the item. */ interface Schema$SearchQualityMetadata { /** * An indication of the quality of the item, used to influence search * quality. Value should be between 0.0 (lowest quality) and 1.0 (highest * quality). */ quality?: number; } /** * The search API request. */ interface Schema$SearchRequest { /** * The sources to use for querying. If not specified, all data sources from * the current search application are used. */ dataSourceRestrictions?: Schema$DataSourceRestriction[]; facetOptions?: Schema$FacetOptions[]; /** * Maximum number of search results to return in one page. Valid values are * between 1 and 100, inclusive. Default value is 10. */ pageSize?: number; /** * The raw query string. See supported search operators in the [Cloud search * Cheat * Sheet](https://gsuite.google.com/learning-center/products/cloudsearch/cheat-sheet/) */ query?: string; /** * Options to interpret the user query. */ queryInterpretationOptions?: Schema$QueryInterpretationOptions; /** * Request options, such as the search application and user timezone. */ requestOptions?: Schema$RequestOptions; /** * The options for sorting the search results */ sortOptions?: Schema$SortOptions; /** * Starting index of the results. */ start?: number; } /** * The search API response. */ interface Schema$SearchResponse { /** * Debugging information about the response. */ debugInfo?: Schema$ResponseDebugInfo; /** * Error information about the response. */ errorInfo?: Schema$ErrorInfo; /** * Repeated facet results. */ facetResults?: Schema$FacetResult[]; /** * Whether there are more search results matching the query. */ hasMoreResults?: boolean; /** * Query interpretation result for user query. Empty if query interpretation * is disabled. */ queryInterpretation?: Schema$QueryInterpretation; /** * The estimated result count for this query. */ resultCountEstimate?: string; /** * The exact result count for this query. */ resultCountExact?: string; /** * Expanded result count information. */ resultCounts?: Schema$ResultCounts; /** * Results from a search query. */ results?: Schema$SearchResult[]; /** * Suggested spelling for the query. */ spellResults?: Schema$SpellResult[]; /** * Structured results for the user query. These results are not counted * against the page_size. */ structuredResults?: Schema$StructuredResult[]; } /** * Results containing indexed information for a document. */ interface Schema$SearchResult { /** * If source is clustered, provide list of clustered results. There will * only be one level of clustered results. If current source is not enabled * for clustering, this field will be empty. */ clusteredResults?: Schema$SearchResult[]; /** * Debugging information about this search result. */ debugInfo?: Schema$ResultDebugInfo; /** * Metadata of the search result. */ metadata?: Schema$Metadata; /** * The concatenation of all snippets (summaries) available for this result. */ snippet?: Schema$Snippet; /** * Title of the search result. */ title?: string; /** * The URL of the result. */ url?: string; } /** * Snippet of the search result, which summarizes the content of the resulting * page. */ interface Schema$Snippet { /** * The matched ranges in the snippet. */ matchRanges?: Schema$MatchRange[]; /** * The snippet of the document. The snippet of the document. May contain * escaped HTML character that should be unescaped prior to rendering. */ snippet?: string; } interface Schema$SortOptions { /** * Name of the operator corresponding to the field to sort on. The * corresponding property must be marked as sortable. */ operatorName?: string; /** * Ascending is the default sort order */ sortOrder?: string; } /** * Defines sources for the suggest/search APIs. */ interface Schema$Source { /** * Source name for content indexed by the Indexing API. */ name?: string; /** * Predefined content source for Google Apps. */ predefinedSource?: string; } /** * Configurations for a source while processing a Search or Suggest request. */ interface Schema$SourceConfig { /** * The crowding configuration for the source. */ crowdingConfig?: Schema$SourceCrowdingConfig; /** * The scoring configuration for the source. */ scoringConfig?: Schema$SourceScoringConfig; /** * The source for which this configuration is to be used. */ source?: Schema$Source; } /** * 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. */ interface Schema$SourceCrowdingConfig { /** * Use a field to control results crowding. For example, if you want to * control overly similar results from Gmail topics, use `thread_id`. For * similar pages from Google Sites, you can use `webspace_id`. When matching * query results contain the same field value in `GenericMetadata`, crowding * limits are set on those records. */ field?: string; /** * Maximum number of results allowed from a source. No limits will be set on * results if this value is less than or equal to 0. */ numResults?: number; /** * Maximum number of suggestions allowed from a source. No limits will be * set on results if this value is less than or equal to 0. */ numSuggestions?: number; /** * Control results by content source. This option limits the total number of * results from a given source and ignores field-based crowding control. */ source?: boolean; } /** * Per source result count information. */ interface Schema$SourceResultCount { /** * Whether there are more search results for this source. */ hasMoreResults?: boolean; /** * The estimated result count for this source. */ resultCountEstimate?: string; /** * The exact result count for this source. */ resultCountExact?: string; /** * The source the result count information is associated with. */ source?: Schema$Source; } /** * Set the scoring configuration. This allows modifying the ranking of results * for a source. */ interface Schema$SourceScoringConfig { /** * Importance of the source. */ sourceImportance?: string; } interface Schema$SpellResult { /** * The suggested spelling of the query. */ suggestedQuery?: string; } /** * Start upload file request. */ interface Schema$StartUploadItemRequest { /** * Name of connector making this call. <br />Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * Common debug options. */ debugOptions?: Schema$DebugOptions; } /** * 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](https://github.com/grpc). The error model is designed to be: * - Simple to use and understand for most users - Flexible enough to meet * unexpected needs # Overview The `Status` message contains three pieces of * data: error code, error message, and error details. The error code should * be an enum value of google.rpc.Code, but it may accept additional error * codes if needed. The error message should be a developer-facing English * message that helps developers *understand* and *resolve* the error. If a * localized user-facing error message is needed, put the localized message in * the error details or localize it in the client. The optional error details * may contain arbitrary information about the error. There is a predefined * set of error detail types in the package `google.rpc` that can be used for * common error conditions. # Language mapping The `Status` message is the * logical representation of the error model, but it is not necessarily the * actual wire format. When the `Status` message is exposed in different * client libraries and different wire protocols, it can be mapped * differently. For example, it will likely be mapped to some exceptions in * Java, but more likely mapped to some error codes in C. # Other uses The * error model and the `Status` message can be used in a variety of * environments, either with or without APIs, to provide a consistent * developer experience across different environments. Example uses of this * error model include: - Partial errors. If a service needs to return * partial errors to the client, it may embed the `Status` in the normal * response to indicate the partial errors. - Workflow errors. A typical * workflow has multiple steps. Each step may have a `Status` message for * error reporting. - Batch operations. If a client uses batch request and * batch response, the `Status` message should be used directly inside * batch response, one for each error sub-response. - Asynchronous * operations. If an API call embeds asynchronous operation results in its * response, the status of those operations should be represented directly * using the `Status` message. - Logging. If some API errors are stored in * logs, the message `Status` could be used directly after any stripping * needed for security/privacy reasons. */ interface Schema$Status { /** * The status code, which should be an enum value of google.rpc.Code. */ code?: number; /** * A list of messages that carry the error details. There is a common set * of message types for APIs to use. */ details?: Array<{ [key: string]: any; }>; /** * A developer-facing error message, which should be in English. Any * user-facing error message should be localized and sent in the * google.rpc.Status.details field, or localized by the client. */ message?: string; } /** * A structured data object consisting of named properties. */ interface Schema$StructuredDataObject { /** * The properties for the object. The maximum number of elements is 1000. */ properties?: Schema$NamedProperty[]; } /** * Structured results that are returned as part of search request. */ interface Schema$StructuredResult { person?: Schema$Person; } /** * Request of suggest API. */ interface Schema$SuggestRequest { /** * The sources to use for suggestions. If not specified, all data sources * from the current search application are used. */ dataSourceRestrictions?: Schema$DataSourceRestriction[]; /** * Partial query for the completion suggestion. */ query?: string; /** * Request options, such as the search application and user timezone. */ requestOptions?: Schema$RequestOptions; } /** * Response of the suggest API. */ interface Schema$SuggestResponse { /** * List of suggestion results. */ suggestResults?: Schema$SuggestResult[]; } /** * One suggestion result. */ interface Schema$SuggestResult { peopleSuggestion?: Schema$PeopleSuggestion; querySuggestion?: Schema$QuerySuggestion; /** * The source of the suggestion. */ source?: Schema$Source; /** * The suggested query that will be used for search, when the user clicks on * the suggestion */ suggestedQuery?: string; } /** * 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. */ interface Schema$TextOperatorOptions { /** * If true, the text value will be tokenized as one atomic value in operator * searches and facet matches. For example, if the operator name is * "genre" and the value is "science-fiction" the query * restrictions "genre:science" and "genre:fiction" will * not match the item; "genre:science-fiction" will. Value * matching is case-sensitive and does not remove special characters. If * false, the text will be tokenized. For example, if the value is * "science-fiction" the queries "genre:science" and * "genre:fiction" will match the item. */ exactMatchWithOperator?: boolean; /** * Indicates the operator name required in the query in order to isolate the * text property. For example, if operatorName is *subject* and the * property's name is *subjectLine*, then queries like * *subject:&lt;value&gt;* will show results only where the value of * the property named *subjectLine* matches *&lt;value&gt;*. By * contrast, a search that uses the same *&lt;value&gt;* without an * operator will return all items where *&lt;value&gt;* matches the * value of any text properties or text within the content field for the * item. The operator name can only contain lowercase letters (a-z). The * maximum length is 32 characters. */ operatorName?: string; } /** * Options for text properties. */ interface Schema$TextPropertyOptions { /** * If set, describes how the property should be used as a search operator. */ operatorOptions?: Schema$TextOperatorOptions; /** * Indicates the search quality importance of the tokens within the field * when used for retrieval. */ retrievalImportance?: Schema$RetrievalImportance; } /** * List of text values. */ interface Schema$TextValues { /** * The maximum allowable length for text values is 2048 characters. */ values?: string[]; } /** * 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. */ interface Schema$TimestampOperatorOptions { /** * Indicates the operator name required in the query in order to isolate the * timestamp property using the greater-than operator. For example, if * greaterThanOperatorName is *closedafter* and the property's name is * *closeDate*, then queries like *closedafter:&lt;value&gt;* will * show results only where the value of the property named *closeDate* is * later than *&lt;value&gt;*. The operator name can only contain * lowercase letters (a-z). The maximum length is 32 characters. */ greaterThanOperatorName?: string; /** * Indicates the operator name required in the query in order to isolate the * timestamp property using the less-than operator. For example, if * lessThanOperatorName is *closedbefore* and the property's name is * *closeDate*, then queries like *closedbefore:&lt;value&gt;* will * show results only where the value of the property named *closeDate* is * earlier than *&lt;value&gt;*. The operator name can only contain * lowercase letters (a-z). The maximum length is 32 characters. */ lessThanOperatorName?: string; /** * Indicates the operator name required in the query in order to isolate the * timestamp property. For example, if operatorName is *closedon* and the * property's name is *closeDate*, then queries like * *closedon:&lt;value&gt;* will show results only where the value * of the property named *closeDate* matches *&lt;value&gt;*. By * contrast, a search that uses the same *&lt;value&gt;* without an * operator will return all items where *&lt;value&gt;* matches the * value of any String properties or text within the content field for the * item. The operator name can only contain lowercase letters (a-z). The * maximum length is 32 characters. */ operatorName?: string; } /** * Options for timestamp properties. */ interface Schema$TimestampPropertyOptions { /** * If set, describes how the timestamp should be used as a search operator. */ operatorOptions?: Schema$TimestampOperatorOptions; } /** * List of timestamp values. */ interface Schema$TimestampValues { values?: string[]; } interface Schema$UnmappedIdentity { /** * The resource name for an external user. */ externalIdentity?: Schema$Principal; /** * The resolution status for the external identity. */ resolutionStatusCode?: string; } interface Schema$UnreserveItemsRequest { /** * Name of connector making this call. <br />Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * Common debug options. */ debugOptions?: Schema$DebugOptions; /** * Name of a queue to unreserve items from. */ queue?: string; } interface Schema$UpdateDataSourceRequest { /** * Common debug options. */ debugOptions?: Schema$DebugOptions; source?: Schema$DataSource; } interface Schema$UpdateSchemaRequest { /** * Common debug options. */ debugOptions?: Schema$DebugOptions; /** * The new schema for the source. */ schema?: Schema$Schema; /** * If true, the request will be validated without side effects. */ validateOnly?: boolean; } /** * Represents an upload session reference. This reference is created via * upload method. Updating of item content may refer to this uploaded content * via contentDataRef. */ interface Schema$UploadItemRef { /** * Name of the content reference. The maximum length is 2048 characters. */ name?: string; } /** * Definition of a single value with generic type. */ interface Schema$Value { booleanValue?: boolean; dateValue?: Schema$Date; doubleValue?: number; integerValue?: string; stringValue?: string; timestampValue?: string; } interface Schema$ValueFilter { /** * 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: <br/><br/> 1. `operator_name`, where * the query filters results by the property that matches the value. * <br/> 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. */ operatorName?: string; /** * The value to be compared with. */ value?: Schema$Value; } class Resource$Debug { datasources: Resource$Debug$Datasources; identitysources: Resource$Debug$Identitysources; constructor(); } class Resource$Debug$Datasources { items: Resource$Debug$Datasources$Items; constructor(); } class Resource$Debug$Datasources$Items { unmappedids: Resource$Debug$Datasources$Items$Unmappedids; constructor(); /** * cloudsearch.debug.datasources.items.checkAccess * @desc Checks whether an item is accessible by specified principal. * @alias cloudsearch.debug.datasources.items.checkAccess * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name Item name, format: datasources/{source_id}/items/{item_id} * @param {().Principal} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ checkAccess(params?: Params$Resource$Debug$Datasources$Items$Checkaccess, options?: MethodOptions): GaxiosPromise; checkAccess(params: Params$Resource$Debug$Datasources$Items$Checkaccess, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; checkAccess(params: Params$Resource$Debug$Datasources$Items$Checkaccess, callback: BodyResponseCallback): void; checkAccess(callback: BodyResponseCallback): void; /** * cloudsearch.debug.datasources.items.searchByViewUrl * @desc Fetches the item whose viewUrl exactly matches that of the URL * provided in the request. * @alias cloudsearch.debug.datasources.items.searchByViewUrl * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Source name, format: datasources/{source_id} * @param {().SearchItemsByViewUrlRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ searchByViewUrl(params?: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, options?: MethodOptions): GaxiosPromise; searchByViewUrl(params: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; searchByViewUrl(params: Params$Resource$Debug$Datasources$Items$Searchbyviewurl, callback: BodyResponseCallback): void; searchByViewUrl(callback: BodyResponseCallback): void; } interface Params$Resource$Debug$Datasources$Items$Checkaccess extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Item name, format: datasources/{source_id}/items/{item_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$Principal; } interface Params$Resource$Debug$Datasources$Items$Searchbyviewurl extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Source name, format: datasources/{source_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$SearchItemsByViewUrlRequest; } class Resource$Debug$Datasources$Items$Unmappedids { constructor(); /** * cloudsearch.debug.datasources.items.unmappedids.list * @desc List all unmapped identities for a specific item. * @alias cloudsearch.debug.datasources.items.unmappedids.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. * @param {string} params.parent The name of the item, in the following format: datasources/{source_id}/items/{ID} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Debug$Datasources$Items$Unmappedids$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Debug$Datasources$Items$Unmappedids$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Debug$Datasources$Items$Unmappedids$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Debug$Datasources$Items$Unmappedids$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Maximum number of items to fetch in a request. Defaults to 100. */ pageSize?: number; /** * The next_page_token value returned from a previous List request, if any. */ pageToken?: string; /** * The name of the item, in the following format: * datasources/{source_id}/items/{ID} */ parent?: string; } class Resource$Debug$Identitysources { items: Resource$Debug$Identitysources$Items; unmappedids: Resource$Debug$Identitysources$Unmappedids; constructor(); } class Resource$Debug$Identitysources$Items { constructor(); /** * cloudsearch.debug.identitysources.items.listForunmappedidentity * @desc Lists names of items associated with an unmapped identity. * @alias cloudsearch.debug.identitysources.items.listForunmappedidentity * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string=} params.groupResourceName * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. * @param {string} params.parent The name of the identity source, in the following format: identitysources/{source_id}} * @param {string=} params.userResourceName * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ listForunmappedidentity(params?: Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, options?: MethodOptions): GaxiosPromise; listForunmappedidentity(params: Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; listForunmappedidentity(params: Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity, callback: BodyResponseCallback): void; listForunmappedidentity(callback: BodyResponseCallback): void; } interface Params$Resource$Debug$Identitysources$Items$Listforunmappedidentity extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * */ groupResourceName?: string; /** * Maximum number of items to fetch in a request. Defaults to 100. */ pageSize?: number; /** * The next_page_token value returned from a previous List request, if any. */ pageToken?: string; /** * The name of the identity source, in the following format: * identitysources/{source_id}} */ parent?: string; /** * */ userResourceName?: string; } class Resource$Debug$Identitysources$Unmappedids { constructor(); /** * cloudsearch.debug.identitysources.unmappedids.list * @desc Lists unmapped user identities for an identity source. * @alias cloudsearch.debug.identitysources.unmappedids.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {integer=} params.pageSize Maximum number of items to fetch in a request. Defaults to 100. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. * @param {string} params.parent The name of the identity source, in the following format: identitysources/{source_id} * @param {string=} params.resolutionStatusCode Limit users selection to this status. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Debug$Identitysources$Unmappedids$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Debug$Identitysources$Unmappedids$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Debug$Identitysources$Unmappedids$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Debug$Identitysources$Unmappedids$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Maximum number of items to fetch in a request. Defaults to 100. */ pageSize?: number; /** * The next_page_token value returned from a previous List request, if any. */ pageToken?: string; /** * The name of the identity source, in the following format: * identitysources/{source_id} */ parent?: string; /** * Limit users selection to this status. */ resolutionStatusCode?: string; } class Resource$Indexing { datasources: Resource$Indexing$Datasources; constructor(); } class Resource$Indexing$Datasources { items: Resource$Indexing$Datasources$Items; constructor(); /** * cloudsearch.indexing.datasources.deleteSchema * @desc Deletes the schema of a data source. * @alias cloudsearch.indexing.datasources.deleteSchema * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name Name of the data source to delete Schema. Format: datasources/{source_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ deleteSchema(params?: Params$Resource$Indexing$Datasources$Deleteschema, options?: MethodOptions): GaxiosPromise; deleteSchema(params: Params$Resource$Indexing$Datasources$Deleteschema, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; deleteSchema(params: Params$Resource$Indexing$Datasources$Deleteschema, callback: BodyResponseCallback): void; deleteSchema(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.getSchema * @desc Gets the schema of a data source. * @alias cloudsearch.indexing.datasources.getSchema * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name Name of the data source to get Schema. Format: datasources/{source_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ getSchema(params?: Params$Resource$Indexing$Datasources$Getschema, options?: MethodOptions): GaxiosPromise; getSchema(params: Params$Resource$Indexing$Datasources$Getschema, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getSchema(params: Params$Resource$Indexing$Datasources$Getschema, callback: BodyResponseCallback): void; getSchema(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.updateSchema * @desc Updates the schema of a data source. * @alias cloudsearch.indexing.datasources.updateSchema * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the data source to update Schema. Format: datasources/{source_id} * @param {().UpdateSchemaRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ updateSchema(params?: Params$Resource$Indexing$Datasources$Updateschema, options?: MethodOptions): GaxiosPromise; updateSchema(params: Params$Resource$Indexing$Datasources$Updateschema, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; updateSchema(params: Params$Resource$Indexing$Datasources$Updateschema, callback: BodyResponseCallback): void; updateSchema(callback: BodyResponseCallback): void; } interface Params$Resource$Indexing$Datasources$Deleteschema extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Name of the data source to delete Schema. Format: * datasources/{source_id} */ name?: string; } interface Params$Resource$Indexing$Datasources$Getschema extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Name of the data source to get Schema. Format: datasources/{source_id} */ name?: string; } interface Params$Resource$Indexing$Datasources$Updateschema extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the data source to update Schema. Format: * datasources/{source_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$UpdateSchemaRequest; } class Resource$Indexing$Datasources$Items { constructor(); /** * cloudsearch.indexing.datasources.items.delete * @desc Deletes Item resource for the specified resource name. * @alias cloudsearch.indexing.datasources.items.delete * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.connectorName Name of connector making this call.
Format: datasources/{source_id}/connectors/{ID} * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string=} params.mode Required. The RequestMode for this request. * @param {string} params.name Required. Name of the item to delete. Format: datasources/{source_id}/items/{item_id} * @param {string=} params.version Required. The incremented version of the item to delete from the index. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering.

Cloud Search Indexing won't delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Indexing$Datasources$Items$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Indexing$Datasources$Items$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Indexing$Datasources$Items$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.items.deleteQueueItems * @desc Deletes all items in a queue. This method is useful for deleting * stale items. * @alias cloudsearch.indexing.datasources.items.deleteQueueItems * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the Data Source to delete items in a queue. Format: datasources/{source_id} * @param {().DeleteQueueItemsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ deleteQueueItems(params?: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, options?: MethodOptions): GaxiosPromise; deleteQueueItems(params: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; deleteQueueItems(params: Params$Resource$Indexing$Datasources$Items$Deletequeueitems, callback: BodyResponseCallback): void; deleteQueueItems(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.items.get * @desc Gets Item resource by item name. * @alias cloudsearch.indexing.datasources.items.get * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.connectorName Name of connector making this call.
Format: datasources/{source_id}/connectors/{ID} * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name Name of the item to get info. Format: datasources/{source_id}/items/{item_id} * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Indexing$Datasources$Items$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Indexing$Datasources$Items$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Indexing$Datasources$Items$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.items.index * @desc Updates Item ACL, metadata, and content. It will insert the Item if * it does not exist. This method does not support partial updates. Fields * with no provided values are cleared out in the Cloud Search index. * @alias cloudsearch.indexing.datasources.items.index * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the Item. Format: datasources/{source_id}/items/{item_id}
This is a required field. The maximum length is 1536 characters. * @param {().IndexItemRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ index(params?: Params$Resource$Indexing$Datasources$Items$Index, options?: MethodOptions): GaxiosPromise; index(params: Params$Resource$Indexing$Datasources$Items$Index, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; index(params: Params$Resource$Indexing$Datasources$Items$Index, callback: BodyResponseCallback): void; index(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.items.list * @desc Lists all or a subset of Item resources. * @alias cloudsearch.indexing.datasources.items.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.brief When set to true, the indexing system only populates the following fields: name, version, metadata.hash, structured_data.hash, content.hash.
If this value is false, then all the fields are populated in Item. * @param {string=} params.connectorName Name of connector making this call.
Format: datasources/{source_id}/connectors/{ID} * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name Name of the Data Source to list Items. Format: datasources/{source_id} * @param {integer=} params.pageSize Maximum number of items to fetch in a request. The max value is 1000 when brief is true. The max value is 10 if brief is false.
The default value is 10 * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Indexing$Datasources$Items$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Indexing$Datasources$Items$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Indexing$Datasources$Items$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.items.poll * @desc Polls for unreserved items from the indexing queue and marks a set * as reserved, starting with items that have the oldest timestamp from the * highest priority ItemStatus. The priority order is as follows:
* ERROR
MODIFIED
NEW_ITEM
ACCEPTED
Reserving * items ensures that polling from other threads cannot create overlapping * sets. After handling the reserved items, the client should put items * back into the unreserved state, either by calling index, or by calling * push with the type REQUEUE. Items automatically become available * (unreserved) after 4 hours even if no update or push method is called. * @alias cloudsearch.indexing.datasources.items.poll * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the Data Source to poll items. Format: datasources/{source_id} * @param {().PollItemsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ poll(params?: Params$Resource$Indexing$Datasources$Items$Poll, options?: MethodOptions): GaxiosPromise; poll(params: Params$Resource$Indexing$Datasources$Items$Poll, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; poll(params: Params$Resource$Indexing$Datasources$Items$Poll, callback: BodyResponseCallback): void; poll(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.items.push * @desc Pushes an item onto a queue for later polling and updating. * @alias cloudsearch.indexing.datasources.items.push * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the item to push into the indexing queue.
Format: datasources/{source_id}/items/{ID}
This is a required field. The maximum length is 1536 characters. * @param {().PushItemRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ push(params?: Params$Resource$Indexing$Datasources$Items$Push, options?: MethodOptions): GaxiosPromise; push(params: Params$Resource$Indexing$Datasources$Items$Push, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; push(params: Params$Resource$Indexing$Datasources$Items$Push, callback: BodyResponseCallback): void; push(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.items.unreserve * @desc Unreserves all items from a queue, making them all eligible to be * polled. This method is useful for resetting the indexing queue after a * connector has been restarted. * @alias cloudsearch.indexing.datasources.items.unreserve * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the Data Source to unreserve all items. Format: datasources/{source_id} * @param {().UnreserveItemsRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ unreserve(params?: Params$Resource$Indexing$Datasources$Items$Unreserve, options?: MethodOptions): GaxiosPromise; unreserve(params: Params$Resource$Indexing$Datasources$Items$Unreserve, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; unreserve(params: Params$Resource$Indexing$Datasources$Items$Unreserve, callback: BodyResponseCallback): void; unreserve(callback: BodyResponseCallback): void; /** * cloudsearch.indexing.datasources.items.upload * @desc Creates an upload session for uploading item content. For items * smaller than 100 KiB, it's easier to embed the content inline within * update. * @alias cloudsearch.indexing.datasources.items.upload * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the Data Source to start a resumable upload. Format: datasources/{source_id} * @param {().StartUploadItemRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ upload(params?: Params$Resource$Indexing$Datasources$Items$Upload, options?: MethodOptions): GaxiosPromise; upload(params: Params$Resource$Indexing$Datasources$Items$Upload, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; upload(params: Params$Resource$Indexing$Datasources$Items$Upload, callback: BodyResponseCallback): void; upload(callback: BodyResponseCallback): void; } interface Params$Resource$Indexing$Datasources$Items$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of connector making this call.
Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Required. The RequestMode for this request. */ mode?: string; /** * Required. Name of the item to delete. Format: * datasources/{source_id}/items/{item_id} */ name?: string; /** * Required. The incremented version of the item to delete from the index. * The indexing system stores the version from the datasource as a byte * string and compares the Item version in the index to the version of the * queued Item using lexical ordering.

Cloud Search Indexing * won't delete any queued item with a version value that is less than or * equal to the version of the currently indexed item. The maximum length * for this field is 1024 bytes. */ version?: string; } interface Params$Resource$Indexing$Datasources$Items$Deletequeueitems extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the Data Source to delete items in a queue. Format: * datasources/{source_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$DeleteQueueItemsRequest; } interface Params$Resource$Indexing$Datasources$Items$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of connector making this call.
Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Name of the item to get info. Format: * datasources/{source_id}/items/{item_id} */ name?: string; } interface Params$Resource$Indexing$Datasources$Items$Index extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the Item. Format: datasources/{source_id}/items/{item_id}
This is a required field. The maximum length is 1536 characters. */ name?: string; /** * Request body metadata */ requestBody?: Schema$IndexItemRequest; } interface Params$Resource$Indexing$Datasources$Items$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * When set to true, the indexing system only populates the following * fields: name, version, metadata.hash, structured_data.hash, content.hash. *
If this value is false, then all the fields are populated in Item. */ brief?: boolean; /** * Name of connector making this call.
Format: * datasources/{source_id}/connectors/{ID} */ connectorName?: string; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Name of the Data Source to list Items. Format: datasources/{source_id} */ name?: string; /** * Maximum number of items to fetch in a request. The max value is 1000 when * brief is true. The max value is 10 if brief is false.
The default * value is 10 */ pageSize?: number; /** * The next_page_token value returned from a previous List request, if any. */ pageToken?: string; } interface Params$Resource$Indexing$Datasources$Items$Poll extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the Data Source to poll items. Format: datasources/{source_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$PollItemsRequest; } interface Params$Resource$Indexing$Datasources$Items$Push extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the item to push into the indexing queue.
Format: * datasources/{source_id}/items/{ID}
This is a required field. The * maximum length is 1536 characters. */ name?: string; /** * Request body metadata */ requestBody?: Schema$PushItemRequest; } interface Params$Resource$Indexing$Datasources$Items$Unreserve extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the Data Source to unreserve all items. Format: * datasources/{source_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$UnreserveItemsRequest; } interface Params$Resource$Indexing$Datasources$Items$Upload extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the Data Source to start a resumable upload. Format: * datasources/{source_id} */ name?: string; /** * Request body metadata */ requestBody?: Schema$StartUploadItemRequest; } class Resource$Media { constructor(); /** * cloudsearch.media.upload * @desc Uploads media for indexing. The upload endpoint supports direct * and resumable upload protocols and is intended for large items that can * not be inlined during index requests. To index large content: 1. Call * upload to begin a session and get the item reference. 1. Upload the * content using the item reference's resource name. 1. Call index with the * item reference as the content. For additional information, see * [Create a content connector using the REST * API](https://developers.google.com/cloud-search/docs/guides/content-connector#rest). * @alias cloudsearch.media.upload * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.resourceName Name of the media that is being downloaded. See ReadRequest.resource_name. * @param {object} params.resource Media resource metadata * @param {object} params.media Media object * @param {string} params.media.mimeType Media mime-type * @param {string|object} params.media.body Media body contents * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ upload(params?: Params$Resource$Media$Upload, options?: MethodOptions): GaxiosPromise; upload(params: Params$Resource$Media$Upload, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; upload(params: Params$Resource$Media$Upload, callback: BodyResponseCallback): void; upload(callback: BodyResponseCallback): void; } interface Params$Resource$Media$Upload extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the media that is being downloaded. See * ReadRequest.resource_name. */ resourceName?: string; /** * Request body metadata */ requestBody?: Schema$Media; /** * Media metadata */ media?: { /** * Media mime-type */ mediaType?: string; /** * Media body contents */ body?: any; }; } class Resource$Operations { constructor(); /** * cloudsearch.operations.get * @desc Gets the latest state of a long-running operation. Clients can use * this method to poll the operation result at intervals as recommended by * the API service. * @alias cloudsearch.operations.get * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the operation resource. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Operations$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Operations$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Operations$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; } interface Params$Resource$Operations$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the operation resource. */ name?: string; } class Resource$Query { sources: Resource$Query$Sources; constructor(); /** * cloudsearch.query.search * @desc The Cloud Search Query API provides the search method, which * returns the most relevant results from a user query. The results can * come from G Suite Apps, such as Gmail or Google Drive, or they can come * from data that you have indexed from a third party. * @alias cloudsearch.query.search * @memberOf! () * * @param {object} params Parameters for request * @param {().SearchRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ search(params?: Params$Resource$Query$Search, options?: MethodOptions): GaxiosPromise; search(params: Params$Resource$Query$Search, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; search(params: Params$Resource$Query$Search, callback: BodyResponseCallback): void; search(callback: BodyResponseCallback): void; /** * cloudsearch.query.suggest * @desc Provides suggestions for autocompleting the query. * @alias cloudsearch.query.suggest * @memberOf! () * * @param {object} params Parameters for request * @param {().SuggestRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ suggest(params?: Params$Resource$Query$Suggest, options?: MethodOptions): GaxiosPromise; suggest(params: Params$Resource$Query$Suggest, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; suggest(params: Params$Resource$Query$Suggest, callback: BodyResponseCallback): void; suggest(callback: BodyResponseCallback): void; } interface Params$Resource$Query$Search extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$SearchRequest; } interface Params$Resource$Query$Suggest extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$SuggestRequest; } class Resource$Query$Sources { constructor(); /** * cloudsearch.query.sources.list * @desc Returns list of sources that user can use for Search and Suggest * APIs. * @alias cloudsearch.query.sources.list * @memberOf! () * * @param {object} params Parameters for request * @param {string=} params.pageToken Number of sources to return in the response. * @param {boolean=} params.requestOptions.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string=} params.requestOptions.languageCode The BCP-47 language code, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For translations. * @param {string=} params.requestOptions.searchApplicationId Id of the application created using SearchApplicationsService. * @param {string=} params.requestOptions.timeZone Current user's time zone id, such as "America/Los_Angeles" or "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data Repository (CLDR)](http://cldr.unicode.org/) project, and currently available in the file [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Query$Sources$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Query$Sources$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Query$Sources$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; } interface Params$Resource$Query$Sources$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Number of sources to return in the response. */ pageToken?: string; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'requestOptions.debugOptions.enableDebugging'?: boolean; /** * The BCP-47 language code, such as "en-US" or "sr-Latn". For more * information, see * http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. For * translations. */ 'requestOptions.languageCode'?: string; /** * Id of the application created using SearchApplicationsService. */ 'requestOptions.searchApplicationId'?: string; /** * Current user's time zone id, such as "America/Los_Angeles" or * "Australia/Sydney". These IDs are defined by [Unicode Common Locale Data * Repository (CLDR)](http://cldr.unicode.org/) project, and currently * available in the file * [timezone.xml](http://unicode.org/repos/cldr/trunk/common/bcp47/timezone.xml) */ 'requestOptions.timeZone'?: string; } class Resource$Settings { datasources: Resource$Settings$Datasources; searchapplications: Resource$Settings$Searchapplications; constructor(); } class Resource$Settings$Datasources { constructor(); /** * cloudsearch.settings.datasources.create * @desc Creates data source. * @alias cloudsearch.settings.datasources.create * @memberOf! () * * @param {object} params Parameters for request * @param {().DataSource} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Settings$Datasources$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Settings$Datasources$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Settings$Datasources$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * cloudsearch.settings.datasources.delete * @desc Deletes a data source. * @alias cloudsearch.settings.datasources.delete * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name Name of the data source. Format: datasources/{source_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Settings$Datasources$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Settings$Datasources$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Settings$Datasources$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * cloudsearch.settings.datasources.get * @desc Gets a data source. * @alias cloudsearch.settings.datasources.get * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name Name of the data source resource. Format: datasources/{source_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Settings$Datasources$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Settings$Datasources$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Settings$Datasources$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * cloudsearch.settings.datasources.list * @desc Lists data sources. * @alias cloudsearch.settings.datasources.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {integer=} params.pageSize Maximum number of data sources to fetch in a request. The max value is 100.
The default value is 10 * @param {string=} params.pageToken Starting index of the results. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Settings$Datasources$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Settings$Datasources$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Settings$Datasources$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * cloudsearch.settings.datasources.update * @desc Updates a data source. * @alias cloudsearch.settings.datasources.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the data source resource. Format: datasources/{source_id}.
The name is ignored when creating a data source. * @param {().UpdateDataSourceRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: Params$Resource$Settings$Datasources$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Settings$Datasources$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Settings$Datasources$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Settings$Datasources$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$DataSource; } interface Params$Resource$Settings$Datasources$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Name of the data source. Format: datasources/{source_id}. */ name?: string; } interface Params$Resource$Settings$Datasources$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Name of the data source resource. Format: datasources/{source_id}. */ name?: string; } interface Params$Resource$Settings$Datasources$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Maximum number of data sources to fetch in a request. The max value is * 100.
The default value is 10 */ pageSize?: number; /** * Starting index of the results. */ pageToken?: string; } interface Params$Resource$Settings$Datasources$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the data source resource. Format: datasources/{source_id}.
The name is ignored when creating a data source. */ name?: string; /** * Request body metadata */ requestBody?: Schema$UpdateDataSourceRequest; } class Resource$Settings$Searchapplications { constructor(); /** * cloudsearch.settings.searchapplications.create * @desc Creates a search application. * @alias cloudsearch.settings.searchapplications.create * @memberOf! () * * @param {object} params Parameters for request * @param {().SearchApplication} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ create(params?: Params$Resource$Settings$Searchapplications$Create, options?: MethodOptions): GaxiosPromise; create(params: Params$Resource$Settings$Searchapplications$Create, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; create(params: Params$Resource$Settings$Searchapplications$Create, callback: BodyResponseCallback): void; create(callback: BodyResponseCallback): void; /** * cloudsearch.settings.searchapplications.delete * @desc Deletes a search application. * @alias cloudsearch.settings.searchapplications.delete * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name The name of the search application to be deleted.
Format: applications/{application_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ delete(params?: Params$Resource$Settings$Searchapplications$Delete, options?: MethodOptions): GaxiosPromise; delete(params: Params$Resource$Settings$Searchapplications$Delete, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; delete(params: Params$Resource$Settings$Searchapplications$Delete, callback: BodyResponseCallback): void; delete(callback: BodyResponseCallback): void; /** * cloudsearch.settings.searchapplications.get * @desc Gets the specified search application. * @alias cloudsearch.settings.searchapplications.get * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {string} params.name Name of the search application.
Format: applications/{application_id}. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Settings$Searchapplications$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Settings$Searchapplications$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Settings$Searchapplications$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; /** * cloudsearch.settings.searchapplications.list * @desc Lists all search applications. * @alias cloudsearch.settings.searchapplications.list * @memberOf! () * * @param {object} params Parameters for request * @param {boolean=} params.debugOptions.enableDebugging If set, the request will enable debugging features of Cloud Search. Only turn on this field, if asked by Google to help with debugging. * @param {integer=} params.pageSize The maximum number of items to return. * @param {string=} params.pageToken The next_page_token value returned from a previous List request, if any.
The default value is 10 * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ list(params?: Params$Resource$Settings$Searchapplications$List, options?: MethodOptions): GaxiosPromise; list(params: Params$Resource$Settings$Searchapplications$List, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; list(params: Params$Resource$Settings$Searchapplications$List, callback: BodyResponseCallback): void; list(callback: BodyResponseCallback): void; /** * cloudsearch.settings.searchapplications.reset * @desc Resets a search application to default settings. This will return * an empty response. * @alias cloudsearch.settings.searchapplications.reset * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name The name of the search application to be reset.
Format: applications/{application_id}. * @param {().ResetSearchApplicationRequest} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ reset(params?: Params$Resource$Settings$Searchapplications$Reset, options?: MethodOptions): GaxiosPromise; reset(params: Params$Resource$Settings$Searchapplications$Reset, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; reset(params: Params$Resource$Settings$Searchapplications$Reset, callback: BodyResponseCallback): void; reset(callback: BodyResponseCallback): void; /** * cloudsearch.settings.searchapplications.update * @desc Updates a search application. * @alias cloudsearch.settings.searchapplications.update * @memberOf! () * * @param {object} params Parameters for request * @param {string} params.name Name of the Search Application.
Format: searchapplications/{application_id}. * @param {().SearchApplication} params.resource Request body data * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ update(params?: Params$Resource$Settings$Searchapplications$Update, options?: MethodOptions): GaxiosPromise; update(params: Params$Resource$Settings$Searchapplications$Update, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; update(params: Params$Resource$Settings$Searchapplications$Update, callback: BodyResponseCallback): void; update(callback: BodyResponseCallback): void; } interface Params$Resource$Settings$Searchapplications$Create extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Request body metadata */ requestBody?: Schema$SearchApplication; } interface Params$Resource$Settings$Searchapplications$Delete extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * The name of the search application to be deleted.
Format: * applications/{application_id}. */ name?: string; } interface Params$Resource$Settings$Searchapplications$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * Name of the search application.
Format: * applications/{application_id}. */ name?: string; } interface Params$Resource$Settings$Searchapplications$List extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * If set, the request will enable debugging features of Cloud Search. Only * turn on this field, if asked by Google to help with debugging. */ 'debugOptions.enableDebugging'?: boolean; /** * The maximum number of items to return. */ pageSize?: number; /** * The next_page_token value returned from a previous List request, if any. *
The default value is 10 */ pageToken?: string; } interface Params$Resource$Settings$Searchapplications$Reset extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * The name of the search application to be reset.
Format: * applications/{application_id}. */ name?: string; /** * Request body metadata */ requestBody?: Schema$ResetSearchApplicationRequest; } interface Params$Resource$Settings$Searchapplications$Update extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Name of the Search Application.
Format: * searchapplications/{application_id}. */ name?: string; /** * Request body metadata */ requestBody?: Schema$SearchApplication; } class Resource$Stats { index: Resource$Stats$Index; constructor(); /** * cloudsearch.stats.getIndex * @desc Gets indexed item statistics aggreggated across all data sources. * @alias cloudsearch.stats.getIndex * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ getIndex(params?: Params$Resource$Stats$Getindex, options?: MethodOptions): GaxiosPromise; getIndex(params: Params$Resource$Stats$Getindex, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; getIndex(params: Params$Resource$Stats$Getindex, callback: BodyResponseCallback): void; getIndex(callback: BodyResponseCallback): void; } interface Params$Resource$Stats$Getindex extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Day of month. Must be from 1 to 31 and valid for the year and month. */ 'fromDate.day'?: number; /** * Month of date. Must be from 1 to 12. */ 'fromDate.month'?: number; /** * Year of date. Must be from 1 to 9999. */ 'fromDate.year'?: number; /** * Day of month. Must be from 1 to 31 and valid for the year and month. */ 'toDate.day'?: number; /** * Month of date. Must be from 1 to 12. */ 'toDate.month'?: number; /** * Year of date. Must be from 1 to 9999. */ 'toDate.year'?: number; } class Resource$Stats$Index { datasources: Resource$Stats$Index$Datasources; constructor(); } class Resource$Stats$Index$Datasources { constructor(); /** * cloudsearch.stats.index.datasources.get * @desc Gets indexed item statistics for a single data source. * @alias cloudsearch.stats.index.datasources.get * @memberOf! () * * @param {object} params Parameters for request * @param {integer=} params.fromDate.day Day of month. Must be from 1 to 31 and valid for the year and month. * @param {integer=} params.fromDate.month Month of date. Must be from 1 to 12. * @param {integer=} params.fromDate.year Year of date. Must be from 1 to 9999. * @param {string} params.name The resource id of the data source to retrieve statistics for, in the following format: "datasources/{source_id}" * @param {integer=} params.toDate.day Day of month. Must be from 1 to 31 and valid for the year and month. * @param {integer=} params.toDate.month Month of date. Must be from 1 to 12. * @param {integer=} params.toDate.year Year of date. Must be from 1 to 9999. * @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`. * @param {callback} callback The callback that handles the response. * @return {object} Request object */ get(params?: Params$Resource$Stats$Index$Datasources$Get, options?: MethodOptions): GaxiosPromise; get(params: Params$Resource$Stats$Index$Datasources$Get, options: MethodOptions | BodyResponseCallback, callback: BodyResponseCallback): void; get(params: Params$Resource$Stats$Index$Datasources$Get, callback: BodyResponseCallback): void; get(callback: BodyResponseCallback): void; } interface Params$Resource$Stats$Index$Datasources$Get extends StandardParameters { /** * Auth client or API Key for the request */ auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient; /** * Day of month. Must be from 1 to 31 and valid for the year and month. */ 'fromDate.day'?: number; /** * Month of date. Must be from 1 to 12. */ 'fromDate.month'?: number; /** * Year of date. Must be from 1 to 9999. */ 'fromDate.year'?: number; /** * The resource id of the data source to retrieve statistics for, in the * following format: "datasources/{source_id}" */ name?: string; /** * Day of month. Must be from 1 to 31 and valid for the year and month. */ 'toDate.day'?: number; /** * Month of date. Must be from 1 to 12. */ 'toDate.month'?: number; /** * Year of date. Must be from 1 to 9999. */ 'toDate.year'?: number; } }