OAuth2 scopes used by this API.
const (
// Index and serve your organization's data with Cloud Search
CloudSearchScope = "https://www.googleapis.com/auth/cloud_search"
// Index and serve your organization's data with Cloud Search
CloudSearchDebugScope = "https://www.googleapis.com/auth/cloud_search.debug"
// Index and serve your organization's data with Cloud Search
CloudSearchIndexingScope = "https://www.googleapis.com/auth/cloud_search.indexing"
// Search your organization's data in the Cloud Search index
CloudSearchQueryScope = "https://www.googleapis.com/auth/cloud_search.query"
// Index and serve your organization's data with Cloud Search
CloudSearchSettingsScope = "https://www.googleapis.com/auth/cloud_search.settings"
// Index and serve your organization's data with Cloud Search
CloudSearchSettingsIndexingScope = "https://www.googleapis.com/auth/cloud_search.settings.indexing"
// Index and serve your organization's data with Cloud Search
CloudSearchSettingsQueryScope = "https://www.googleapis.com/auth/cloud_search.settings.query"
// Index and serve your organization's data with Cloud Search
CloudSearchStatsScope = "https://www.googleapis.com/auth/cloud_search.stats"
// Index and serve your organization's data with Cloud Search
CloudSearchStatsIndexingScope = "https://www.googleapis.com/auth/cloud_search.stats.indexing"
)
type Action struct {
// Title: [Required] Title of the action.
Title string `json:"title,omitempty"`
// Url: [Optional] Url of the action.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "Title") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Title") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Action) MarshalJSON() ([]byte, error)
AuditLoggingSettings: Represents the settings for Cloud audit logging
type AuditLoggingSettings struct {
// LogAdminReadActions: Indicates whether audit logging is on/off for admin
// activity read APIs i.e. Get/List DataSources, Get/List SearchApplications
// etc.
LogAdminReadActions bool `json:"logAdminReadActions,omitempty"`
// LogDataReadActions: Indicates whether audit logging is on/off for data
// access read APIs i.e. ListItems, GetItem etc.
LogDataReadActions bool `json:"logDataReadActions,omitempty"`
// LogDataWriteActions: Indicates whether audit logging is on/off for data
// access write APIs i.e. IndexItem etc.
LogDataWriteActions bool `json:"logDataWriteActions,omitempty"`
// Project: The resource name of the GCP Project to store audit logs. Cloud
// audit logging will be enabled after project_name has been updated through
// CustomerService. Format: projects/{project_id}
Project string `json:"project,omitempty"`
// ForceSendFields is a list of field names (e.g. "LogAdminReadActions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "LogAdminReadActions") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *AuditLoggingSettings) MarshalJSON() ([]byte, error)
type BackgroundColoredText struct {
// BackgroundColor: [Optional] Color of the background. The text color can
// change depending on the selected background color, and the client does not
// have control over this. If missing, the background will be WHITE.
//
// Possible values:
// "UNKNOWN_COLOR"
// "WHITE"
// "YELLOW"
// "ORANGE"
// "GREEN"
// "BLUE"
// "GREY"
BackgroundColor string `json:"backgroundColor,omitempty"`
// Text: [Required] The text to display.
Text string `json:"text,omitempty"`
// ForceSendFields is a list of field names (e.g. "BackgroundColor") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BackgroundColor") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BackgroundColoredText) MarshalJSON() ([]byte, error)
BooleanOperatorOptions: Used to provide a search operator for boolean properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
type BooleanOperatorOptions struct {
// OperatorName: 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:<value>* show
// results only where the value of the property named *isClosed* matches
// *<value>*. By contrast, a search that uses the same *<value>* without an
// operator returns all items where *<value>* 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 `json:"operatorName,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BooleanOperatorOptions) MarshalJSON() ([]byte, error)
BooleanPropertyOptions: The options for boolean properties.
type BooleanPropertyOptions struct {
// OperatorOptions: If set, describes how the boolean should be used as a
// search operator.
OperatorOptions *BooleanOperatorOptions `json:"operatorOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *BooleanPropertyOptions) MarshalJSON() ([]byte, error)
type CheckAccessResponse struct {
// HasAccess: Returns true if principal has access. Returns false otherwise.
HasAccess bool `json:"hasAccess,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "HasAccess") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "HasAccess") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CheckAccessResponse) MarshalJSON() ([]byte, error)
type CompositeFilter struct {
// LogicOperator: The logic operator of the sub filter.
//
// Possible values:
// "AND" - Logical operators, which can only be applied to sub filters.
// "OR"
// "NOT" - NOT can only be applied on a single sub filter.
LogicOperator string `json:"logicOperator,omitempty"`
// SubFilters: Sub filters.
SubFilters []*Filter `json:"subFilters,omitempty"`
// ForceSendFields is a list of field names (e.g. "LogicOperator") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "LogicOperator") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CompositeFilter) MarshalJSON() ([]byte, error)
type Content struct {
// Actions: [Optional] Actions for this card.
Actions []*Action `json:"actions,omitempty"`
// Description: [Optional] Description of the card.
Description *SafeHtmlProto `json:"description,omitempty"`
// Subtitle: [Optional] Subtitle of the card.
Subtitle *BackgroundColoredText `json:"subtitle,omitempty"`
// Title: [Optional] Title of the card.
Title *BackgroundColoredText `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "Actions") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Actions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Content) MarshalJSON() ([]byte, error)
type Context struct {
// App: [Optional] App where the card should be shown. If missing, the card
// will be shown in TOPAZ.
//
// Possible values:
// "UNKNOWN_APP"
// "TOPAZ"
// "MOMA"
App []string `json:"app,omitempty"`
// DayOfWeek: [Optional] Day of week when the card should be shown, where 0 is
// Monday.
DayOfWeek []int64 `json:"dayOfWeek,omitempty"`
// EndDateSec: [Optional] Date (in seconds since epoch) when the card should
// stop being shown. If missing, end_date_sec will be set to Jan 1st, 2100.
EndDateSec int64 `json:"endDateSec,omitempty,string"`
// EndDayOffsetSec: [Optional] End time in seconds, within a day, when the card
// should stop being shown if it's within [start_date_sec, end_date_sec]. If
// missing, this is set to 86400 (24 hours x 3600 sec/hour), i.e., midnight
// next day.
EndDayOffsetSec int64 `json:"endDayOffsetSec,omitempty,string"`
// Locale: [Optional] The locales for which the card should be triggered (e.g.,
// en_US and en_CA). If missing, the card is going to show to clients
// regardless of their locale.
Locale []string `json:"locale,omitempty"`
// Location: [Optional] Text-free locations where the card should be shown.
// This is expected to match the user's location in focus. If no location is
// specified, the card will be shown for any location.
Location []string `json:"location,omitempty"`
// Query: [Required only for Answer and RHS cards - will be ignored for
// Homepage] cards. It's the exact case-insensitive queries that will trigger
// the Answer or RHS card.
Query []string `json:"query,omitempty"`
// StartDateSec: [Optional] Date (in seconds since epoch) when the card should
// start being shown. If missing, start_date_sec will be Jan 1st, 1970 UTC.
StartDateSec int64 `json:"startDateSec,omitempty,string"`
// StartDayOffsetSec: [Optional] Start time in seconds, within a day, when the
// card should be shown if it's within [start_date_sec, end_date_sec]. If 0,
// the card will be shown from 12:00am on.
StartDayOffsetSec int64 `json:"startDayOffsetSec,omitempty,string"`
// Surface: [Optional] Surface where the card should be shown in. If missing,
// the card will be shown in any surface.
//
// Possible values:
// "UNKNOWN_SURFACE"
// "DESKTOP"
// "ANDROID"
// "IOS"
// "MOBILE" - Any mobile device.
// "ANY"
Surface []string `json:"surface,omitempty"`
// Type: [Required] Type of the card (homepage, Answer or RHS).
//
// Possible values:
// "UNKNOWN_CARD_TYPE"
// "HOMEPAGE_CARD"
// "ANSWER_CARD"
// "RHS_CARD"
Type []string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "App") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "App") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Context) MarshalJSON() ([]byte, error)
ContextAttribute: A named attribute associated with an item which can be used for influencing the ranking of the item based on the context in the request.
type ContextAttribute struct {
// Name: The name of the attribute. It should not be empty. The maximum length
// is 32 characters. The name must start with a letter and can only contain
// letters (A-Z, a-z) or numbers (0-9). The name will be normalized
// (lower-cased) before being matched.
Name string `json:"name,omitempty"`
// Values: Text values of the attribute. The maximum number of elements is 10.
// The maximum length of an element in the array is 32 characters. The value
// will be normalized (lower-cased) before being matched.
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ContextAttribute) MarshalJSON() ([]byte, error)
CustomerIndexStats: Aggregation of items by status code as of the specified date.
type CustomerIndexStats struct {
// Date: The date for which statistics were calculated.
Date *Date `json:"date,omitempty"`
// ItemCountByStatus: Number of items aggregrated by status code.
ItemCountByStatus []*ItemCountByStatus `json:"itemCountByStatus,omitempty"`
// ForceSendFields is a list of field names (e.g. "Date") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Date") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerIndexStats) MarshalJSON() ([]byte, error)
type CustomerQueryStats struct {
// Date: The date for which query stats were calculated. Stats calculated on
// the next day close to midnight are returned.
Date *Date `json:"date,omitempty"`
QueryCountByStatus []*QueryCountByStatus `json:"queryCountByStatus,omitempty"`
// ForceSendFields is a list of field names (e.g. "Date") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Date") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerQueryStats) MarshalJSON() ([]byte, error)
CustomerSearchApplicationStats: Search application stats for a customer for the given date.
type CustomerSearchApplicationStats struct {
// Count: The count of search applications for the date.
Count int64 `json:"count,omitempty,string"`
// Date: The date for which search application stats were calculated.
Date *Date `json:"date,omitempty"`
// ForceSendFields is a list of field names (e.g. "Count") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Count") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerSearchApplicationStats) MarshalJSON() ([]byte, error)
type CustomerSessionStats struct {
// Date: The date for which session stats were calculated. Stats are calculated
// on the following day, close to midnight PST, and then returned.
Date *Date `json:"date,omitempty"`
// SearchSessionsCount: The count of search sessions on the day
SearchSessionsCount int64 `json:"searchSessionsCount,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Date") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Date") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerSessionStats) MarshalJSON() ([]byte, error)
CustomerSettings: Represents settings at a customer level.
type CustomerSettings struct {
// AuditLoggingSettings: Audit Logging settings for the customer. If
// update_mask is empty then this field will be updated based on
// UpdateCustomerSettings request.
AuditLoggingSettings *AuditLoggingSettings `json:"auditLoggingSettings,omitempty"`
// VpcSettings: VPC SC settings for the customer. If update_mask is empty then
// this field will be updated based on UpdateCustomerSettings request.
VpcSettings *VPCSettings `json:"vpcSettings,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AuditLoggingSettings") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AuditLoggingSettings") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerSettings) MarshalJSON() ([]byte, error)
type CustomerUserStats struct {
// Date: The date for which session stats were calculated. Stats calculated on
// the next day close to midnight are returned.
Date *Date `json:"date,omitempty"`
// OneDayActiveUsersCount: The count of unique active users in the past one day
OneDayActiveUsersCount int64 `json:"oneDayActiveUsersCount,omitempty,string"`
// SevenDaysActiveUsersCount: The count of unique active users in the past
// seven days
SevenDaysActiveUsersCount int64 `json:"sevenDaysActiveUsersCount,omitempty,string"`
// ThirtyDaysActiveUsersCount: The count of unique active users in the past
// thirty days
ThirtyDaysActiveUsersCount int64 `json:"thirtyDaysActiveUsersCount,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Date") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Date") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *CustomerUserStats) MarshalJSON() ([]byte, error)
DataSource: Datasource is a logical namespace for items to be indexed. All items must belong to a datasource. This is the prerequisite before items can be indexed into Cloud Search.
type DataSource struct {
// DisableModifications: If true, sets the datasource to read-only mode. In
// read-only mode, the Indexing API rejects any requests to index or delete
// items in this source. Enabling read-only mode does not stop the processing
// of previously accepted data.
DisableModifications bool `json:"disableModifications,omitempty"`
// DisableServing: Disable serving any search or assist results.
DisableServing bool `json:"disableServing,omitempty"`
// DisplayName: Required. Display name of the datasource The maximum length is
// 300 characters.
DisplayName string `json:"displayName,omitempty"`
// IndexingServiceAccounts: List of service accounts that have indexing access.
IndexingServiceAccounts []string `json:"indexingServiceAccounts,omitempty"`
// ItemsVisibility: This field restricts visibility to items at the datasource
// level. Items within the datasource are restricted to the union of users and
// groups included in this 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 datasource, and that the
// individual items are not shared outside this visibility.
ItemsVisibility []*GSuitePrincipal `json:"itemsVisibility,omitempty"`
// Name: The name of the datasource resource. Format: datasources/{source_id}.
// The name is ignored when creating a datasource.
Name string `json:"name,omitempty"`
// OperationIds: IDs of the Long Running Operations (LROs) currently running
// for this schema.
OperationIds []string `json:"operationIds,omitempty"`
// ReturnThumbnailUrls: Can a user request to get thumbnail URI for Items
// indexed in this data source.
ReturnThumbnailUrls bool `json:"returnThumbnailUrls,omitempty"`
// ShortName: 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 *<value>*
// then queries like *source:<value>* will only return results for this source.
// The value must be unique across all datasources. 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 `json:"shortName,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DisableModifications") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisableModifications") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DataSource) MarshalJSON() ([]byte, error)
DataSourceIndexStats: Aggregation of items by status code as of the specified date.
type DataSourceIndexStats struct {
// Date: The 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 *Date `json:"date,omitempty"`
// ItemCountByStatus: Number of items aggregrated by status code.
ItemCountByStatus []*ItemCountByStatus `json:"itemCountByStatus,omitempty"`
// ForceSendFields is a list of field names (e.g. "Date") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Date") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DataSourceIndexStats) MarshalJSON() ([]byte, error)
DataSourceRestriction: Restriction on Datasource.
type DataSourceRestriction struct {
// FilterOptions: 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.
// NOTE: Suggest API supports only few filters at the moment: "objecttype",
// "type" and "mimetype". For now, schema specific filters cannot be used to
// filter suggestions.
FilterOptions []*FilterOptions `json:"filterOptions,omitempty"`
// Source: The source of restriction.
Source *Source `json:"source,omitempty"`
// ForceSendFields is a list of field names (e.g. "FilterOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FilterOptions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DataSourceRestriction) MarshalJSON() ([]byte, error)
Date: Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the Proleptic Gregorian Calendar (https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.
type Date struct {
// Day: Day of month. Must be from 1 to 31 and valid for the year and month.
Day int64 `json:"day,omitempty"`
// Month: Month of date. Must be from 1 to 12.
Month int64 `json:"month,omitempty"`
// Year: Year of date. Must be from 1 to 9999.
Year int64 `json:"year,omitempty"`
// ForceSendFields is a list of field names (e.g. "Day") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Day") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Date) MarshalJSON() ([]byte, error)
DateOperatorOptions: Optional. Provides a search operator for date properties. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
type DateOperatorOptions struct {
// GreaterThanOperatorName: 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:<value>* show results only
// where the value of the property named *closeDate* is later than *<value>*.
// The operator name can only contain lowercase letters (a-z). The maximum
// length is 32 characters.
GreaterThanOperatorName string `json:"greaterThanOperatorName,omitempty"`
// LessThanOperatorName: 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:<value>* show results only
// where the value of the property named *closeDate* is earlier than *<value>*.
// The operator name can only contain lowercase letters (a-z). The maximum
// length is 32 characters.
LessThanOperatorName string `json:"lessThanOperatorName,omitempty"`
// OperatorName: 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:<value>* show results only where the value of the *closeDate*
// property matches *<value>*. By contrast, a search that uses the same
// *<value>* without an operator returns all items where *<value>* 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 `json:"operatorName,omitempty"`
// ForceSendFields is a list of field names (e.g. "GreaterThanOperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "GreaterThanOperatorName") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DateOperatorOptions) MarshalJSON() ([]byte, error)
DatePropertyOptions: The options for date properties.
type DatePropertyOptions struct {
// OperatorOptions: If set, describes how the date should be used as a search
// operator.
OperatorOptions *DateOperatorOptions `json:"operatorOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DatePropertyOptions) MarshalJSON() ([]byte, error)
DateValues: List of date values.
type DateValues struct {
Values []*Date `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DateValues) MarshalJSON() ([]byte, error)
type DebugDatasourcesItemsCheckAccessCall struct {
// contains filtered or unexported fields
}
func (c *DebugDatasourcesItemsCheckAccessCall) Context(ctx context.Context) *DebugDatasourcesItemsCheckAccessCall
Context sets the context to be used in this call's Do method.
func (c *DebugDatasourcesItemsCheckAccessCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *DebugDatasourcesItemsCheckAccessCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *DebugDatasourcesItemsCheckAccessCall) Do(opts ...googleapi.CallOption) (*CheckAccessResponse, error)
Do executes the "cloudsearch.debug.datasources.items.checkAccess" call. Any non-2xx status code is an error. Response headers are in either *CheckAccessResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DebugDatasourcesItemsCheckAccessCall) Fields(s ...googleapi.Field) *DebugDatasourcesItemsCheckAccessCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DebugDatasourcesItemsCheckAccessCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type DebugDatasourcesItemsSearchByViewUrlCall struct {
// contains filtered or unexported fields
}
func (c *DebugDatasourcesItemsSearchByViewUrlCall) Context(ctx context.Context) *DebugDatasourcesItemsSearchByViewUrlCall
Context sets the context to be used in this call's Do method.
func (c *DebugDatasourcesItemsSearchByViewUrlCall) Do(opts ...googleapi.CallOption) (*SearchItemsByViewUrlResponse, error)
Do executes the "cloudsearch.debug.datasources.items.searchByViewUrl" call. Any non-2xx status code is an error. Response headers are in either *SearchItemsByViewUrlResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DebugDatasourcesItemsSearchByViewUrlCall) Fields(s ...googleapi.Field) *DebugDatasourcesItemsSearchByViewUrlCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DebugDatasourcesItemsSearchByViewUrlCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DebugDatasourcesItemsSearchByViewUrlCall) Pages(ctx context.Context, f func(*SearchItemsByViewUrlResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type DebugDatasourcesItemsService struct {
Unmappedids *DebugDatasourcesItemsUnmappedidsService
// contains filtered or unexported fields
}
func NewDebugDatasourcesItemsService(s *Service) *DebugDatasourcesItemsService
func (r *DebugDatasourcesItemsService) CheckAccess(name string, principal *Principal) *DebugDatasourcesItemsCheckAccessCall
CheckAccess: Checks whether an item is accessible by specified principal. Principal must be a user; groups and domain values aren't supported. **Note:** This API requires an admin account to execute.
- name: Item name, format: datasources/{source_id}/items/{item_id}.
func (r *DebugDatasourcesItemsService) SearchByViewUrl(name string, searchitemsbyviewurlrequest *SearchItemsByViewUrlRequest) *DebugDatasourcesItemsSearchByViewUrlCall
SearchByViewUrl: Fetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute.
- name: Source name, format: datasources/{source_id}.
type DebugDatasourcesItemsUnmappedidsListCall struct {
// contains filtered or unexported fields
}
func (c *DebugDatasourcesItemsUnmappedidsListCall) Context(ctx context.Context) *DebugDatasourcesItemsUnmappedidsListCall
Context sets the context to be used in this call's Do method.
func (c *DebugDatasourcesItemsUnmappedidsListCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *DebugDatasourcesItemsUnmappedidsListCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *DebugDatasourcesItemsUnmappedidsListCall) Do(opts ...googleapi.CallOption) (*ListUnmappedIdentitiesResponse, error)
Do executes the "cloudsearch.debug.datasources.items.unmappedids.list" call. Any non-2xx status code is an error. Response headers are in either *ListUnmappedIdentitiesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DebugDatasourcesItemsUnmappedidsListCall) Fields(s ...googleapi.Field) *DebugDatasourcesItemsUnmappedidsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DebugDatasourcesItemsUnmappedidsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DebugDatasourcesItemsUnmappedidsListCall) IfNoneMatch(entityTag string) *DebugDatasourcesItemsUnmappedidsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *DebugDatasourcesItemsUnmappedidsListCall) PageSize(pageSize int64) *DebugDatasourcesItemsUnmappedidsListCall
PageSize sets the optional parameter "pageSize": Maximum number of items to fetch in a request. Defaults to 100.
func (c *DebugDatasourcesItemsUnmappedidsListCall) PageToken(pageToken string) *DebugDatasourcesItemsUnmappedidsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *DebugDatasourcesItemsUnmappedidsListCall) Pages(ctx context.Context, f func(*ListUnmappedIdentitiesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type DebugDatasourcesItemsUnmappedidsService struct {
// contains filtered or unexported fields
}
func NewDebugDatasourcesItemsUnmappedidsService(s *Service) *DebugDatasourcesItemsUnmappedidsService
func (r *DebugDatasourcesItemsUnmappedidsService) List(parent string) *DebugDatasourcesItemsUnmappedidsListCall
List: List all unmapped identities for a specific item. **Note:** This API requires an admin account to execute.
type DebugDatasourcesService struct {
Items *DebugDatasourcesItemsService
// contains filtered or unexported fields
}
func NewDebugDatasourcesService(s *Service) *DebugDatasourcesService
type DebugIdentitysourcesItemsListForunmappedidentityCall struct {
// contains filtered or unexported fields
}
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) Context(ctx context.Context) *DebugIdentitysourcesItemsListForunmappedidentityCall
Context sets the context to be used in this call's Do method.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *DebugIdentitysourcesItemsListForunmappedidentityCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) Do(opts ...googleapi.CallOption) (*ListItemNamesForUnmappedIdentityResponse, error)
Do executes the "cloudsearch.debug.identitysources.items.listForunmappedidentity" call. Any non-2xx status code is an error. Response headers are in either *ListItemNamesForUnmappedIdentityResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) Fields(s ...googleapi.Field) *DebugIdentitysourcesItemsListForunmappedidentityCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) GroupResourceName(groupResourceName string) *DebugIdentitysourcesItemsListForunmappedidentityCall
GroupResourceName sets the optional parameter "groupResourceName":
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) IfNoneMatch(entityTag string) *DebugIdentitysourcesItemsListForunmappedidentityCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) PageSize(pageSize int64) *DebugIdentitysourcesItemsListForunmappedidentityCall
PageSize sets the optional parameter "pageSize": Maximum number of items to fetch in a request. Defaults to 100.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) PageToken(pageToken string) *DebugIdentitysourcesItemsListForunmappedidentityCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) Pages(ctx context.Context, f func(*ListItemNamesForUnmappedIdentityResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (c *DebugIdentitysourcesItemsListForunmappedidentityCall) UserResourceName(userResourceName string) *DebugIdentitysourcesItemsListForunmappedidentityCall
UserResourceName sets the optional parameter "userResourceName":
type DebugIdentitysourcesItemsService struct {
// contains filtered or unexported fields
}
func NewDebugIdentitysourcesItemsService(s *Service) *DebugIdentitysourcesItemsService
func (r *DebugIdentitysourcesItemsService) ListForunmappedidentity(parent string) *DebugIdentitysourcesItemsListForunmappedidentityCall
ListForunmappedidentity: Lists names of items associated with an unmapped identity. **Note:** This API requires an admin account to execute.
type DebugIdentitysourcesService struct {
Items *DebugIdentitysourcesItemsService
Unmappedids *DebugIdentitysourcesUnmappedidsService
// contains filtered or unexported fields
}
func NewDebugIdentitysourcesService(s *Service) *DebugIdentitysourcesService
type DebugIdentitysourcesUnmappedidsListCall struct {
// contains filtered or unexported fields
}
func (c *DebugIdentitysourcesUnmappedidsListCall) Context(ctx context.Context) *DebugIdentitysourcesUnmappedidsListCall
Context sets the context to be used in this call's Do method.
func (c *DebugIdentitysourcesUnmappedidsListCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *DebugIdentitysourcesUnmappedidsListCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *DebugIdentitysourcesUnmappedidsListCall) Do(opts ...googleapi.CallOption) (*ListUnmappedIdentitiesResponse, error)
Do executes the "cloudsearch.debug.identitysources.unmappedids.list" call. Any non-2xx status code is an error. Response headers are in either *ListUnmappedIdentitiesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *DebugIdentitysourcesUnmappedidsListCall) Fields(s ...googleapi.Field) *DebugIdentitysourcesUnmappedidsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *DebugIdentitysourcesUnmappedidsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *DebugIdentitysourcesUnmappedidsListCall) IfNoneMatch(entityTag string) *DebugIdentitysourcesUnmappedidsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *DebugIdentitysourcesUnmappedidsListCall) PageSize(pageSize int64) *DebugIdentitysourcesUnmappedidsListCall
PageSize sets the optional parameter "pageSize": Maximum number of items to fetch in a request. Defaults to 100.
func (c *DebugIdentitysourcesUnmappedidsListCall) PageToken(pageToken string) *DebugIdentitysourcesUnmappedidsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *DebugIdentitysourcesUnmappedidsListCall) Pages(ctx context.Context, f func(*ListUnmappedIdentitiesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (c *DebugIdentitysourcesUnmappedidsListCall) ResolutionStatusCode(resolutionStatusCode string) *DebugIdentitysourcesUnmappedidsListCall
ResolutionStatusCode sets the optional parameter "resolutionStatusCode": Limit users selection to this status.
Possible values:
"CODE_UNSPECIFIED" - Input-only value. Used to list all unmapped
identities regardless of status.
"NOT_FOUND" - The unmapped identity was not found in IDaaS, and needs to
be provided by the user.
"IDENTITY_SOURCE_NOT_FOUND" - The identity source associated with the
identity was either not found or deleted.
"IDENTITY_SOURCE_MISCONFIGURED" - IDaaS does not understand the identity
source, probably because the schema was modified in a non compatible way.
"TOO_MANY_MAPPINGS_FOUND" - The number of users associated with the
external identity is too large.
"INTERNAL_ERROR" - Internal error.
type DebugIdentitysourcesUnmappedidsService struct {
// contains filtered or unexported fields
}
func NewDebugIdentitysourcesUnmappedidsService(s *Service) *DebugIdentitysourcesUnmappedidsService
func (r *DebugIdentitysourcesUnmappedidsService) List(parent string) *DebugIdentitysourcesUnmappedidsListCall
List: Lists unmapped user identities for an identity source. **Note:** This API requires an admin account to execute.
DebugOptions: Shared request debug options for all cloudsearch RPC methods.
type DebugOptions struct {
// EnableDebugging: If you are asked by Google to help with debugging, set this
// field. Otherwise, ignore this field.
EnableDebugging bool `json:"enableDebugging,omitempty"`
// ForceSendFields is a list of field names (e.g. "EnableDebugging") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EnableDebugging") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DebugOptions) MarshalJSON() ([]byte, error)
type DebugService struct {
Datasources *DebugDatasourcesService
Identitysources *DebugIdentitysourcesService
// contains filtered or unexported fields
}
func NewDebugService(s *Service) *DebugService
type DeleteQueueItemsRequest struct {
// ConnectorName: The name of connector making this call. Format:
// datasources/{source_id}/connectors/{ID}
ConnectorName string `json:"connectorName,omitempty"`
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// Queue: The name of a queue to delete items from.
Queue string `json:"queue,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConnectorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConnectorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DeleteQueueItemsRequest) MarshalJSON() ([]byte, error)
DisplayedProperty: A reference to a top-level property within the object that should be displayed in search results. The values of the chosen properties is displayed in the search results along with the display label for that property if one is specified. If a display label is not specified, only the values is shown.
type DisplayedProperty struct {
// PropertyName: 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 is given when attempting to update the schema.
PropertyName string `json:"propertyName,omitempty"`
// ForceSendFields is a list of field names (e.g. "PropertyName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PropertyName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DisplayedProperty) MarshalJSON() ([]byte, error)
DoubleOperatorOptions: Used to provide a search operator for double properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
type DoubleOperatorOptions struct {
// OperatorName: 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 `json:"operatorName,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DoubleOperatorOptions) MarshalJSON() ([]byte, error)
DoublePropertyOptions: The options for double properties.
type DoublePropertyOptions struct {
// OperatorOptions: If set, describes how the double should be used as a search
// operator.
OperatorOptions *DoubleOperatorOptions `json:"operatorOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DoublePropertyOptions) MarshalJSON() ([]byte, error)
DoubleValues: List of double values.
type DoubleValues struct {
Values []float64 `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DoubleValues) MarshalJSON() ([]byte, error)
func (s *DoubleValues) UnmarshalJSON(data []byte) error
DriveFollowUpRestrict: Drive follow-up search restricts (e.g. "followup:suggestions").
type DriveFollowUpRestrict struct {
// Possible values:
// "UNSPECIFIED"
// "FOLLOWUP_SUGGESTIONS"
// "FOLLOWUP_ACTION_ITEMS"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Type") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Type") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DriveFollowUpRestrict) MarshalJSON() ([]byte, error)
DriveLocationRestrict: Drive location search restricts (e.g. "is:starred").
type DriveLocationRestrict struct {
// Possible values:
// "UNSPECIFIED"
// "TRASHED"
// "STARRED"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Type") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Type") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DriveLocationRestrict) MarshalJSON() ([]byte, error)
DriveMimeTypeRestrict: Drive mime-type search restricts (e.g. "type:pdf").
type DriveMimeTypeRestrict struct {
// Possible values:
// "UNSPECIFIED"
// "PDF"
// "DOCUMENT"
// "PRESENTATION"
// "SPREADSHEET"
// "FORM"
// "DRAWING"
// "SCRIPT"
// "MAP"
// "IMAGE"
// "AUDIO"
// "VIDEO"
// "FOLDER"
// "ARCHIVE"
// "SITE"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Type") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Type") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DriveMimeTypeRestrict) MarshalJSON() ([]byte, error)
DriveTimeSpanRestrict: The time span search restrict (e.g. "after:2017-09-11 before:2017-09-12").
type DriveTimeSpanRestrict struct {
// Possible values:
// "UNSPECIFIED"
// "TODAY"
// "YESTERDAY"
// "LAST_7_DAYS"
// "LAST_30_DAYS" - Not Enabled
// "LAST_90_DAYS" - Not Enabled
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "Type") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Type") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *DriveTimeSpanRestrict) MarshalJSON() ([]byte, error)
EmailAddress: A person's email address.
type EmailAddress struct {
// CustomType: If the value of type is custom, this property contains the
// custom type string.
CustomType string `json:"customType,omitempty"`
// EmailAddress: The email address.
EmailAddress string `json:"emailAddress,omitempty"`
// EmailUrl: The URL to send email.
EmailUrl string `json:"emailUrl,omitempty"`
// Primary: Indicates if this is the user's primary email. Only one entry can
// be marked as primary.
Primary bool `json:"primary,omitempty"`
// Type: The type of the email account. Acceptable values are: "custom",
// "home", "other", "work".
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "CustomType") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CustomType") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EmailAddress) MarshalJSON() ([]byte, error)
type EnterpriseTopazFrontendTeamsLink struct {
// Type: The identifying link type
Type string `json:"type,omitempty"`
Url *SafeUrlProto `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "Type") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Type") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazFrontendTeamsLink) MarshalJSON() ([]byte, error)
type EnterpriseTopazFrontendTeamsPersonCorePhoneNumber struct {
// PhoneNumber: Phone number in no particular format (as comes from the Focus
// profile).
PhoneNumber string `json:"phoneNumber,omitempty"`
// PhoneUrl: Phone number URL
PhoneUrl *SafeUrlProto `json:"phoneUrl,omitempty"`
// Possible values:
// "UNKNOWN"
// "MOBILE"
// "OFFICE"
// "OTHER"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "PhoneNumber") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PhoneNumber") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazFrontendTeamsPersonCorePhoneNumber) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickAgendaEntry: An AgendaEntry, e.g., a Calendar Event.
type EnterpriseTopazSidekickAgendaEntry struct {
// AgendaItemUrl: URL of the agenda item.
AgendaItemUrl string `json:"agendaItemUrl,omitempty"`
// Chronology: The chronology from the present.
//
// Possible values:
// "STALE" - Stale.
// "ALL_DAY" - All day.
// "PAST" - Past.
// "RECENTLY_PAST" - Recently past.
// "PRESENT" - Present.
// "NEAR_FUTURE" - Near future.
// "FUTURE" - Future.
Chronology string `json:"chronology,omitempty"`
// Creator: Person who created the event.
Creator *EnterpriseTopazSidekickPerson `json:"creator,omitempty"`
// CurrentUserAttendingStatus: Attendance status for the current user making
// the request. This is a convenience data member in order to avoid figuring
// out the same by iterating the invitee list above on the caller side.
//
// Possible values:
// "AWAITING" - Awaiting for the user to set the status.
// "YES" - Attending.
// "NO" - Not attending.
// "MAYBE" - Tentatively attending.
CurrentUserAttendingStatus string `json:"currentUserAttendingStatus,omitempty"`
// Description: Description of the agenda item (i.e., typically, summary in
// calendar event).
Description string `json:"description,omitempty"`
// Document: Items related to the current AgendaEntry. E.g., related
// drive/mail/groups documents.
Document []*EnterpriseTopazSidekickCommonDocument `json:"document,omitempty"`
// EndDate: End date "Friday, August 26" in the user's timezone.
EndDate string `json:"endDate,omitempty"`
// EndTime: End time (HH:mm) in the user's timezone.
EndTime string `json:"endTime,omitempty"`
// EndTimeMs: End time in milliseconds
EndTimeMs int64 `json:"endTimeMs,omitempty,string"`
// EventId: Event id provided by Calendar API.
EventId string `json:"eventId,omitempty"`
// GuestsCanInviteOthers: Whether the guests can invite other guests.
GuestsCanInviteOthers bool `json:"guestsCanInviteOthers,omitempty"`
// GuestsCanModify: Whether the guests can modify the event.
GuestsCanModify bool `json:"guestsCanModify,omitempty"`
// GuestsCanSeeGuests: Whether the guests of the event can be seen. If false,
// the user is going to be reported as the only attendee to the meeting, even
// though there may be more attendees.
GuestsCanSeeGuests bool `json:"guestsCanSeeGuests,omitempty"`
// HangoutId: Hangout meeting identifier.
HangoutId string `json:"hangoutId,omitempty"`
// HangoutUrl: Absolute URL for the Hangout meeting.
HangoutUrl string `json:"hangoutUrl,omitempty"`
// Invitee: People attending the meeting.
Invitee []*EnterpriseTopazSidekickPerson `json:"invitee,omitempty"`
// IsAllDay: Whether the entry lasts all day.
IsAllDay bool `json:"isAllDay,omitempty"`
// LastModificationTimeMs: Last time the event was modified.
LastModificationTimeMs int64 `json:"lastModificationTimeMs,omitempty,string"`
// Location: Agenda item location.
Location string `json:"location,omitempty"`
// NotifyToUser: Whether this should be notified to the user.
NotifyToUser bool `json:"notifyToUser,omitempty"`
// OtherAttendeesExcluded: Whether guest list is not returned because number of
// attendees is too large.
OtherAttendeesExcluded bool `json:"otherAttendeesExcluded,omitempty"`
// RequesterIsOwner: Whether the requester is the owner of the agenda entry.
RequesterIsOwner bool `json:"requesterIsOwner,omitempty"`
// ShowFullEventDetailsToUse: Whether the details of this entry should be
// displayed to the user.
ShowFullEventDetailsToUse bool `json:"showFullEventDetailsToUse,omitempty"`
// StartDate: Start date "Friday, August 26" in the user's timezone.
StartDate string `json:"startDate,omitempty"`
// StartTime: Start time (HH:mm) in the user's timezone.
StartTime string `json:"startTime,omitempty"`
// StartTimeMs: Start time in milliseconds.
StartTimeMs int64 `json:"startTimeMs,omitempty,string"`
// TimeZone: User's calendar timezone;
TimeZone string `json:"timeZone,omitempty"`
// Title: Title of the agenda item.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgendaItemUrl") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgendaItemUrl") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAgendaEntry) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickAgendaGroupCardProto struct {
AgendaItem []*EnterpriseTopazSidekickAgendaItem `json:"agendaItem,omitempty"`
Context *EnterpriseTopazSidekickAgendaGroupCardProtoContext `json:"context,omitempty"`
CurrentAgendaItem *EnterpriseTopazSidekickAgendaItem `json:"currentAgendaItem,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgendaItem") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgendaItem") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAgendaGroupCardProto) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickAgendaGroupCardProtoContext: The context that resulted in the generation of the card.
type EnterpriseTopazSidekickAgendaGroupCardProtoContext struct {
// Context: User friendly free text that describes the context of the card
// (e.g. "Next meeting with Bob"). This is largely only applicable when the
// card is generated from a query.
Context string `json:"context,omitempty"`
// Date: Localized free text that describes the dates represented by the card.
// Currently, the card will only represent a single day.
Date string `json:"date,omitempty"`
// EventsRestrict: Represents restrictions applied to the events requested in
// the user's query.
//
// Possible values:
// "NONE" - No specific event was requested.
// "NEXT_MEETING" - The next meeting was requested.
EventsRestrict string `json:"eventsRestrict,omitempty"`
// ForceSendFields is a list of field names (e.g. "Context") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Context") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAgendaGroupCardProtoContext) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickAgendaItem struct {
ConflictedGroup *EnterpriseTopazSidekickConflictingEventsCardProto `json:"conflictedGroup,omitempty"`
GapBefore *EnterpriseTopazSidekickGap `json:"gapBefore,omitempty"`
Meeting *EnterpriseTopazSidekickAgendaEntry `json:"meeting,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConflictedGroup") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConflictedGroup") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAgendaItem) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickAnswerAnswerList: A list of answers represented as free text.
type EnterpriseTopazSidekickAnswerAnswerList struct {
// LabeledAnswer: Answers that have a corresponding label.
LabeledAnswer []*EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer `json:"labeledAnswer,omitempty"`
// Type: Answer type.
//
// Possible values:
// "UNKNOWN"
// "PERSON_ADDRESS"
// "PERSON_BIRTHDAY"
// "PERSON_DEPARTMENT"
// "PERSON_DESK_LOCATION"
// "PERSON_EMAIL"
// "PERSON_JOB_TITLE"
// "PERSON_PHONE"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "LabeledAnswer") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "LabeledAnswer") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAnswerAnswerList) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer: An answer with a corresponding label.
type EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer struct {
// Answer: The free text answer.
Answer string `json:"answer,omitempty"`
// Label: A localized label for the answer (e.g. "Cell phone" vs "Desk phone").
Label string `json:"label,omitempty"`
// ForceSendFields is a list of field names (e.g. "Answer") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Answer") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAnswerAnswerListLabeledAnswer) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard: Contains a list of suggested queries. Allows the user to determine what natural language queries they can ask Cloud Search (e.g. "what can I search for?").
type EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard struct {
// SuggestedQueryCategory: A list of queries to suggest.
SuggestedQueryCategory []*EnterpriseTopazSidekickAnswerSuggestedQueryCategory `json:"suggestedQueryCategory,omitempty"`
// ForceSendFields is a list of field names (e.g. "SuggestedQueryCategory") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SuggestedQueryCategory") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickAnswerSuggestedQueryCategory: Contains a list of suggested queries for a single category.
type EnterpriseTopazSidekickAnswerSuggestedQueryCategory struct {
// Category: The query list category.
//
// Possible values:
// "UNKNOWN" - Unknown.
// "CALENDAR" - Calendar based queries (e.g. "my agenda for tomorrow").
// "DOCUMENT" - Document based queries (e.g. "files shared with me").
// "PEOPLE" - People based queries (e.g. "what is x's email address?").
Category string `json:"category,omitempty"`
// IsEnabled: Whether this category is enabled.
IsEnabled bool `json:"isEnabled,omitempty"`
// Query: List of suggested queries to show the user.
Query []string `json:"query,omitempty"`
// ForceSendFields is a list of field names (e.g. "Category") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Category") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAnswerSuggestedQueryCategory) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickAssistCardProto: Wrapper proto for the Assist cards.
type EnterpriseTopazSidekickAssistCardProto struct {
// AgendaGroupCardProto: Agenda group card.
AgendaGroupCardProto *EnterpriseTopazSidekickAgendaGroupCardProto `json:"agendaGroupCardProto,omitempty"`
// CardMetadata: Card metadata such as chronology and render mode of the card.
CardMetadata *EnterpriseTopazSidekickCardMetadata `json:"cardMetadata,omitempty"`
// CardType: Card type.
//
// Possible values:
// "UNKNOWN_TYPE" - The default type, an unknown card type.
// "AGENDA" - The user's agenda for the day.
// "CHANGELISTS" - Changelists.
// "CONFLICTING_MEETINGS" - Any group of meetings for the day that are
// overlapping.
// "CREATE_NOTES_FOR_MEETING" - Create notes for a meeting specified in the
// request.
// "CREATE_NOTES_FOR_MEETING_REQUEST" - Create notes for meeting query.
// "CUSTOMER_NEWS" - News about your SFDC customers.
// "FIND_MEETING_TIME" - Find a time for two people to meet.
// "NEXT_MEETING" - The user's next non-declined meeting.
// "PERSONALIZED_DOCS" - Important documents for you since you have viewed
// them in the last month and there's some action going on.
// "TRENDING_DOCS" - Documents that are trending in your company. A
// TRENDING_DOCS card can be of two types: TRENDING_IN_COLLABORATORS (i.e.,
// Stay in the Loop) and TRENDING_IN_DOMAIN (i.e., Popular Content). Use
// DOMAIN_TRENDING_DOCS/TEAM_TRENDING_DOCS instead.
// "UPCOMING_TRIP" - An upcoming trip with all trip information along with
// calendar events in the destination timezone.
// "SUMMARY" - The Morning/Evening Summary Card for the next working day.
// "MEETINGS" - A meeting. When requesting meetings, the service will return
// a MEETING card for each meeting the user has in his agenda.
// "HOMEPAGE" - All cards related to the homepage (agenda,
// conflicting-meetings, summary, etc...). This type should no longer be used.
// Use HOMEPAGE_V3 instead.
// "SHARE_MEETING_DOCS" - A card to with specifics to share meeting documents
// with all attendees.
// "DISCOVER_PEOPLE" - Represents a set of users that the requesting user has
// low affinity with.
// "HOMEPAGE_V3" - All cards related to the homepage-v3 (agenda-group, WIP,
// etc...)
// "AGENDA_GROUP" - A group of agenda-events (meeting, conflicts)
// "WORK_IN_PROGRESS" - The documents that you were recently working on.
// "GET_AND_KEEP_AHEAD" - (v3) The "get and keep ahead" card for today and
// tomorrow
// "GENERIC_ANSWER_CARD" - Generic answer card.
// "THIRD_PARTY_ANSWER_CARD" - Third party answer card.
// "DOMAIN_TRENDING_DOCS" - Documents that are trending in your
// company/domain (i.e., Popular Content).
// "TEAM_TRENDING_DOCS" - Documents that are trending in your team (i.e.,
// Stay in the Loop).
// "DOCUMENT_LIST_ANSWER_CARD" - Documents that match the user's query (e.g.
// sheets shared with me).
// "SUGGESTED_QUERY_ANSWER_CARD" - A help card that provides examples of
// queries the user can ask.
// "PERSON_ANSWER_CARD" - Answer card for a single person (e.g. what is x's
// phone number).
// "RELATED_PEOPLE_ANSWER_CARD" - Answer card for a list of people related to
// the person that is the subject of the query (e.g. who reports to x).
// "PERSON_KNOWLEDGE_CARD" - Knowledge card for a single person and their
// related people.
// "PEOPLE_SEARCH_PROMOTION_CARD" - People Search promotion card.
CardType string `json:"cardType,omitempty"`
// ConflictingMeetingsCard: Conflicting events card.
ConflictingMeetingsCard *EnterpriseTopazSidekickConflictingEventsCardProto `json:"conflictingMeetingsCard,omitempty"`
// DocumentListCard: Answer card for documents that are applicable to the
// current query.
DocumentListCard *EnterpriseTopazSidekickDocumentPerCategoryList `json:"documentListCard,omitempty"`
// DocumentsWithMentions: Documents with mentions.
DocumentsWithMentions *EnterpriseTopazSidekickDocumentPerCategoryList `json:"documentsWithMentions,omitempty"`
// FindMeetingTimeCard: Find meeting time card.
FindMeetingTimeCard *EnterpriseTopazSidekickFindMeetingTimeCardProto `json:"findMeetingTimeCard,omitempty"`
// GenericAnswerCard: Generic answer card.
GenericAnswerCard *EnterpriseTopazSidekickGenericAnswerCard `json:"genericAnswerCard,omitempty"`
// GetAndKeepAheadCard: Get and keep ahead card.
GetAndKeepAheadCard *EnterpriseTopazSidekickGetAndKeepAheadCardProto `json:"getAndKeepAheadCard,omitempty"`
// Meeting: Meeting card.
Meeting *EnterpriseTopazSidekickAgendaEntry `json:"meeting,omitempty"`
// MeetingNotesCard: Meeting notes card.
MeetingNotesCard *EnterpriseTopazSidekickMeetingNotesCardProto `json:"meetingNotesCard,omitempty"`
// MeetingNotesCardRequest: Request for meeting notes card.
MeetingNotesCardRequest *EnterpriseTopazSidekickMeetingNotesCardRequest `json:"meetingNotesCardRequest,omitempty"`
// PeopleDisambiguationCard: The people disambiguation card.
PeopleDisambiguationCard *EnterpriseTopazSidekickPeopleDisambiguationCard `json:"peopleDisambiguationCard,omitempty"`
// PeoplePromotionCard: People Search promotion card.
PeoplePromotionCard *PeoplePromotionCard `json:"peoplePromotionCard,omitempty"`
// PersonAnswerCard: Answer card that represents a single person.
PersonAnswerCard *EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard `json:"personAnswerCard,omitempty"`
// PersonProfileCard: Full profile card.
PersonProfileCard *EnterpriseTopazSidekickPersonProfileCard `json:"personProfileCard,omitempty"`
// PersonalizedDocsCard: Card with recommended documents for the user.
PersonalizedDocsCard *EnterpriseTopazSidekickPersonalizedDocsCardProto `json:"personalizedDocsCard,omitempty"`
// RelatedPeopleAnswerCard: Answer card that represents a list of people
// related to a person.
RelatedPeopleAnswerCard *EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard `json:"relatedPeopleAnswerCard,omitempty"`
// ShareMeetingDocsCard: Sahre meeting docs card.
ShareMeetingDocsCard *EnterpriseTopazSidekickShareMeetingDocsCardProto `json:"shareMeetingDocsCard,omitempty"`
// SharedDocuments: Shared documents.
SharedDocuments *EnterpriseTopazSidekickDocumentPerCategoryList `json:"sharedDocuments,omitempty"`
// SuggestedQueryAnswerCard: Answer card for what natural language queries the
// user can ask.
SuggestedQueryAnswerCard *EnterpriseTopazSidekickAnswerSuggestedQueryAnswerCard `json:"suggestedQueryAnswerCard,omitempty"`
// ThirdPartyAnswerCard: Third party answer cards.
ThirdPartyAnswerCard *ThirdPartyGenericCard `json:"thirdPartyAnswerCard,omitempty"`
// WorkInProgressCardProto: Work In Progress card.
WorkInProgressCardProto *EnterpriseTopazSidekickRecentDocumentsCardProto `json:"workInProgressCardProto,omitempty"`
// ForceSendFields is a list of field names (e.g. "AgendaGroupCardProto") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AgendaGroupCardProto") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickAssistCardProto) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickCardMetadata: Card metadata.
type EnterpriseTopazSidekickCardMetadata struct {
// CardCategory: Declares a preference for how this card should be packed in
// MSCR. All cards in a response must correspond to a single category. As a
// result, cards may be dropped from the response if this field is set. Any
// card that does not match the category of the card with the highest priority
// in the response will be dropped.
//
// Possible values:
// "DEFAULT" - Let MSCR decide how this card should be packed. Most cards
// should choose this type. This type should largely be considered equivalent
// to ANSWER. However, this is not guaranteed to be the case as the request to
// MSCR may override the static configuration.
// "ANSWER" - This card should be rendered as an answer card.
// "KNOWLEDGE" - This card should be rendered as a knowledge card (a
// non-organic result).
// "HOMEPAGE" - This card should be rendered in the Homepage.
CardCategory string `json:"cardCategory,omitempty"`
// CardId: An ID to identify the card and match actions to it. Be thoughtful of
// new card IDs since actions will be associated to that ID. E.g., if two card
// IDs collide, the system will think that the actions have been applied to the
// same card. Similarly, if EAS can return multiple cards of the same type
// (e.g., Meetings), ensure that the card_id identifies a given instance of the
// card so that, e.g., dismissals only affect the dismissed card as opposed to
// affecting all meeting cards.
CardId string `json:"cardId,omitempty"`
// Chronology: Chronology.
//
// Possible values:
// "UNKNOWN" - Unknown chronology (default).
// "PAST" - Past.
// "RECENTLY_PAST" - Recently past.
// "PRESENT" - Present.
// "NEAR_FUTURE" - Near future.
// "FUTURE" - Future.
Chronology string `json:"chronology,omitempty"`
// DebugInfo: Debug info (only reported if request's debug_level > 0).
DebugInfo string `json:"debugInfo,omitempty"`
// NlpMetadata: Information about the NLP done to get the card.
NlpMetadata *EnterpriseTopazSidekickNlpMetadata `json:"nlpMetadata,omitempty"`
// RankingParams: Ranking params.
RankingParams *EnterpriseTopazSidekickRankingParams `json:"rankingParams,omitempty"`
// RenderMode: Render mode.
//
// Possible values:
// "UNKNOWN_RENDER" - Unknown mode (default).
// "COLLAPSED" - Collapsed.
// "EXPANDED" - Expanded.
RenderMode string `json:"renderMode,omitempty"`
// ForceSendFields is a list of field names (e.g. "CardCategory") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CardCategory") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickCardMetadata) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickCommonDebugInfo: Container of debugging information in all object levels. Extend as needed.
type EnterpriseTopazSidekickCommonDebugInfo struct {
// Message: Debug message.
Message string `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Message") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Message") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickCommonDebugInfo) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickCommonDocument: Representation of a document. NEXT_TAG: 15
type EnterpriseTopazSidekickCommonDocument struct {
// AccessType: Access type, i.e., whether the user has access to the document
// or not.
//
// Possible values:
// "UNKNOWN_ACCESS" - Unknown access type.
// "ALLOWED" - Access allowed.
// "NOT_ALLOWED" - Access not allowed.
AccessType string `json:"accessType,omitempty"`
// DebugInfo: Information for debugging.
DebugInfo *EnterpriseTopazSidekickCommonDebugInfo `json:"debugInfo,omitempty"`
// DocumentId: Document id.
DocumentId string `json:"documentId,omitempty"`
// DriveDocumentMetadata: Drive document metadata.
DriveDocumentMetadata *EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata `json:"driveDocumentMetadata,omitempty"`
// GenericUrl: Generic Drive-based url in the format of drive.google.com/open
// to be used for deeplink
GenericUrl string `json:"genericUrl,omitempty"`
// Justification: Justification on why the document is selected.
Justification *EnterpriseTopazSidekickCommonDocumentJustification `json:"justification,omitempty"`
// MimeType: MIME type
MimeType string `json:"mimeType,omitempty"`
// Provenance: Document provenance.
//
// Possible values:
// "UNKNOWN_PROVENANCE" - Unknown provenance.
// "CALENDAR_DESCRIPTION" - Calendar event description.
// "CALENDAR_ATTACHMENT" - Calendar event attachment.
// "MINED" - Mined (extracted by some offline/online analysis).
// "CALENDAR_ASSIST_ATTACHMENT" - Attachment created by enterprise assist.
Provenance string `json:"provenance,omitempty"`
// Reason: Justification of why this document is being returned.
//
// Possible values:
// "UNKNOWN" - Unknown justification.
// "TRENDING_IN_COLLABORATORS" - Popular documents within collaborators.
// "TRENDING_IN_DOMAIN" - Popular documents within the domain.
// "FREQUENTLY_VIEWED" - Documents being reviewed frequently by the current
// user .
// "FREQUENTLY_EDITED" - Documents being edited frequently by the current
// user .
// "NEW_UPDATES" - Documents updated since user's last visit.
// "NEW_COMMENTS" - Documents that receive comments since user's last visit.
// "EVENT_DESCRIPTION" - Documents in the calendar event description.
// "EVENT_ATTACHMENT" - Documents in the calendar event attachments section.
// "EVENT_METADATA_ATTACHMENT" - Documents attached in calendar event
// metadata instead of the attachment section. Event metadata is not visible to
// the final user. Enterprise assist uses this metadata to store auto-generated
// documents such as meeting notes.
// "MINED_DOCUMENT" - Documents mined, and so, probably related to the
// request context. For example, this category includes documents related to a
// meeting.
// "NEW_MENTIONS" - Documents that contains mentions of the user.
// "NEW_SHARES" - Documents that are shared with the user.
Reason string `json:"reason,omitempty"`
// Snippet: A sampling of the text from the document.
Snippet string `json:"snippet,omitempty"`
// ThumbnailUrl: Thumbnail URL.
ThumbnailUrl string `json:"thumbnailUrl,omitempty"`
// Title: Title of the document.
Title string `json:"title,omitempty"`
// Type: Type of the document.
//
// Possible values:
// "UNKNOWN" - If the type is unknown or not represented in this enum.
// "DOCUMENT" - Drive document types Writely, Word, etc.
// "PRESENTATION" - Presently, PowerPoint, etc.
// "SPREADSHEET" - Trix, Excel, etc.
// "PDF" - File types for Gdrive objects are below. PDF.
// "IMAGE" - Image.
// "BINARY_BLOB" - Fall-back for unknown Gdrive types.
// "FUSION_TABLE" - Fusion table.
// "FOLDER" - Folder.
// "DRAWING" - Drawing.
// "VIDEO" - Video.
// "FORM" - Form.
// "LINK_URL" - Link formats uncategorized URL links
// "LINK_GO" - meaningful links that should be renderred specifically
// "LINK_GOO_GL" - Link to goo.gl.
// "LINK_BIT_LY" - Link to bit_ly.
// "LINK_GMAIL" - Link to Gmail.
// "LINK_MAILTO" - Mailto link.
// "VIDEO_YOUTUBE" - Videos Youtube videos.
// "VIDEO_LIVE" - Live streams (e.g., liveplayer.googleplex.com)
// "GROUPS" - Other types. Google Groups.
// "NEWS" - Google News.
// "SITES" - Google Sites.
// "HANGOUT" - Google Hangout.
// "AUDIO" - Audio files.
// "MS_WORD" - Microsoft-specific file types.
// "MS_POWERPOINT"
// "MS_EXCEL"
// "MS_OUTLOOK"
Type string `json:"type,omitempty"`
// Url: Absolute URL of the document.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "AccessType") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AccessType") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickCommonDocument) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata: Meta data for drive documents.
type EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata struct {
// DocumentId: The drive document cosmo id. Client could use the id to build a
// URL to open a document. Please use Document.document_id.
DocumentId string `json:"documentId,omitempty"`
// IsPrivate: Additional field to identify whether a document is private since
// scope set to LIMITED can mean both that the doc is private or that it's
// shared with others. is_private indicates whether the doc is not shared with
// anyone except for the owner.
IsPrivate bool `json:"isPrivate,omitempty"`
// LastCommentTimeMs: Timestamp of the most recent comment added to the
// document in milliseconds since epoch.
LastCommentTimeMs uint64 `json:"lastCommentTimeMs,omitempty,string"`
// LastEditTimeMs: Timestamp of the most recent edit from the current user in
// milliseconds since epoch.
LastEditTimeMs uint64 `json:"lastEditTimeMs,omitempty,string"`
// LastModificationTimeMillis: Last modification time of the document
// (independent of the user that modified it).
LastModificationTimeMillis int64 `json:"lastModificationTimeMillis,omitempty,string"`
// LastUpdatedTimeMs: Timestamp of the last updated time of the document in
// milliseconds since epoch.
LastUpdatedTimeMs uint64 `json:"lastUpdatedTimeMs,omitempty,string"`
// LastViewTimeMs: Timestamp of the most recent view from the current user in
// milliseconds since epoch.
LastViewTimeMs uint64 `json:"lastViewTimeMs,omitempty,string"`
// Owner: The owner of the document.
Owner *EnterpriseTopazSidekickCommonPerson `json:"owner,omitempty"`
// Scope: ACL scope of the document which identifies the sharing status of the
// doc (e.g., limited, shared with link, team drive, ...).
//
// Possible values:
// "UNKNOWN_DOCUMENT_SCOPE"
// "LIMITED"
// "DASHER_DOMAIN_WITH_LINK"
// "DASHER_DOMAIN"
// "PUBLIC_WITH_LINK"
// "PUBLIC"
// "TEAM_DRIVE"
Scope string `json:"scope,omitempty"`
// ForceSendFields is a list of field names (e.g. "DocumentId") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DocumentId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickCommonDocumentDriveDocumentMetadata) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickCommonDocumentJustification: Justification of why we are reporting the document.
type EnterpriseTopazSidekickCommonDocumentJustification struct {
// Justification: A locale aware message that explains why this document was
// selected.
Justification string `json:"justification,omitempty"`
// Reason: Reason on why the document is selected. Populate for trending
// documents.
//
// Possible values:
// "UNKNOWN" - Unknown justification.
// "TRENDING_IN_COLLABORATORS" - Popular documents within collaborators.
// "TRENDING_IN_DOMAIN" - Popular documents within the domain.
// "FREQUENTLY_VIEWED" - Documents being reviewed frequently by the current
// user .
// "FREQUENTLY_EDITED" - Documents being edited frequently by the current
// user .
// "NEW_UPDATES" - Documents updated since user's last visit.
// "NEW_COMMENTS" - Documents that receive comments since user's last visit.
// "EVENT_DESCRIPTION" - Documents in the calendar event description.
// "EVENT_ATTACHMENT" - Documents in the calendar event attachments section.
// "EVENT_METADATA_ATTACHMENT" - Documents attached in calendar event
// metadata instead of the attachment section. Event metadata is not visible to
// the final user. Enterprise assist uses this metadata to store auto-generated
// documents such as meeting notes.
// "MINED_DOCUMENT" - Documents mined, and so, probably related to the
// request context. For example, this category includes documents related to a
// meeting.
// "NEW_MENTIONS" - Documents that contains mentions of the user.
// "NEW_SHARES" - Documents that are shared with the user.
Reason string `json:"reason,omitempty"`
// ForceSendFields is a list of field names (e.g. "Justification") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Justification") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickCommonDocumentJustification) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickCommonPerson: Common representation of a person.
type EnterpriseTopazSidekickCommonPerson struct {
// Birthday: The birthday.
Birthday *EnterpriseTopazSidekickCommonPersonBirthday `json:"birthday,omitempty"`
// CellPhone: Cell phone number.
CellPhone string `json:"cellPhone,omitempty"`
// Department: The department the person works in (e.g. Engineering).
Department string `json:"department,omitempty"`
// DeskLocation: Desk location (e.g. US-MTV-PR55-5-5B1I).
DeskLocation string `json:"deskLocation,omitempty"`
// DeskPhone: Work desk phone number.
DeskPhone string `json:"deskPhone,omitempty"`
// DisplayName: The full name.
DisplayName string `json:"displayName,omitempty"`
// Email: Email.
Email string `json:"email,omitempty"`
// FamilyName: The last name.
FamilyName string `json:"familyName,omitempty"`
// FullAddress: The fully formatted address (e.g. 1255 Pear Avenue, Mountain
// View 94043, United States).
FullAddress string `json:"fullAddress,omitempty"`
// GaiaId: This field is deprecated. The obfuscated_id should be used instead.
GaiaId int64 `json:"gaiaId,omitempty,string"`
// GivenName: The first name.
GivenName string `json:"givenName,omitempty"`
// JobTitle: The person's job title (e.g. Software Engineer).
JobTitle string `json:"jobTitle,omitempty"`
// Manager: The manager.
Manager *EnterpriseTopazSidekickCommonPerson `json:"manager,omitempty"`
// ObfuscatedId: The obfuscated GAIA ID.
ObfuscatedId string `json:"obfuscatedId,omitempty"`
// PhotoUrl: The URL for the Focus profile picture.
PhotoUrl string `json:"photoUrl,omitempty"`
// StreetAddress: The street address (e.g. 1255 Pear Avenue).
StreetAddress string `json:"streetAddress,omitempty"`
// ForceSendFields is a list of field names (e.g. "Birthday") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Birthday") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickCommonPerson) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickCommonPersonBirthday struct {
// Value: Unstructured birthday.
Value string `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Value") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Value") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickCommonPersonBirthday) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickConflictingEventsCardProto: Conflicting meetings card proto.
type EnterpriseTopazSidekickConflictingEventsCardProto struct {
// ConflictingEvent: All the events that conflict with main_event.
ConflictingEvent []*EnterpriseTopazSidekickAgendaEntry `json:"conflictingEvent,omitempty"`
// MainEvent: The event identified as being the most important.
MainEvent *EnterpriseTopazSidekickAgendaEntry `json:"mainEvent,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConflictingEvent") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConflictingEvent") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickConflictingEventsCardProto) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickDocumentGroup: Represents a mapping between a document type and its corresponding documents. Use for Work in Progress card in v1 homepage.
type EnterpriseTopazSidekickDocumentGroup struct {
// GroupType: Document group type
//
// Possible values:
// "UNKNOWN_TYPE" - Unknown type.
// "ALL" - A mix of all the document types.
GroupType string `json:"groupType,omitempty"`
// PersonalizedDocument: The list of corresponding documents.
PersonalizedDocument []*EnterpriseTopazSidekickCommonDocument `json:"personalizedDocument,omitempty"`
// ForceSendFields is a list of field names (e.g. "GroupType") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "GroupType") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickDocumentGroup) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickDocumentPerCategoryList struct {
Documents []*EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry `json:"documents,omitempty"`
// HelpMessage: Localized message explaining how the documents were derived
// (e.g. from the last 30 days activity). This field is optional.
HelpMessage string `json:"helpMessage,omitempty"`
// Possible values:
// "UNKNOWN_LIST_TYPE"
// "MENTIONS" - All documents in the list correspond to one of the mention
// categories.
// "SHARES" - All documents in the list correspond to one of the share
// categories.
// "NEEDS_ATTENTION" - A mixture of document categories that correspond to
// documents that need the users attention (e.g. documents that have been
// explicitly shared with the user but have not been viewed and documents where
// the user was mentioned but has not replied).
// "VIEWS" - All documents in the list correspond to one of the view
// categories.
// "EDITS" - All documents in the list correspond to one of the edit
// categories.
ListType string `json:"listType,omitempty"`
// ListTypeDescription: Description of the types of documents present in the
// list.
ListTypeDescription string `json:"listTypeDescription,omitempty"`
// ResponseMessage: Response message in case no documents are present in the
// card.
ResponseMessage string `json:"responseMessage,omitempty"`
// ForceSendFields is a list of field names (e.g. "Documents") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Documents") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickDocumentPerCategoryList) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry struct {
// Possible values:
// "UNKNOWN_DOCUMENT"
// "ACTIONABLE"
// "VIEWED"
// "REPLIED"
// "MENTION_VIEWED" - Mention categories. The mention has been viewed by the
// user, but the user has not replied.
// "MENTION_REPLIED" - The user has replied to the mention.
// "MENTION_NOT_VIEWED" - The mention has not been viewed by the user.
// "SHARED_AND_VIEWED" - Share categories. Consists of documents that have
// been explicitly shared with the user. Document has been viewed.
// "SHARED_NOT_VIEWED" - Document has not been viewed.
// "EDITED" - Document has been edited.
Category string `json:"category,omitempty"`
Document *EnterpriseTopazSidekickCommonDocument `json:"document,omitempty"`
// Rationale: Reason this document was selected.
Rationale string `json:"rationale,omitempty"`
// ForceSendFields is a list of field names (e.g. "Category") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Category") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickDocumentPerCategoryListDocumentPerCategoryListEntry) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickFindMeetingTimeCardProto: Response to find meeting time among a set of people.
type EnterpriseTopazSidekickFindMeetingTimeCardProto struct {
// CommonAvailableTimeSlots: Slots when all attendees have availability.
CommonAvailableTimeSlots []*EnterpriseTopazSidekickTimeSlot `json:"commonAvailableTimeSlots,omitempty"`
// Invitees: Invitees to the event.
Invitees []*EnterpriseTopazSidekickPerson `json:"invitees,omitempty"`
// Requester: Requester.
Requester *EnterpriseTopazSidekickPerson `json:"requester,omitempty"`
// ScheduledMeeting: Details about the scheduled meeting, if one exists.
ScheduledMeeting *EnterpriseTopazSidekickScheduledMeeting `json:"scheduledMeeting,omitempty"`
// SkippedInvitees: Invitees that have been skipped in the computation, most
// likely because they are groups.
SkippedInvitees []*EnterpriseTopazSidekickPerson `json:"skippedInvitees,omitempty"`
// TimeBoundaries: Min and max timestamp used to find a common available
// timeslot.
TimeBoundaries *EnterpriseTopazSidekickTimeSlot `json:"timeBoundaries,omitempty"`
// TimezoneId: Timezone ID.
TimezoneId string `json:"timezoneId,omitempty"`
// ForceSendFields is a list of field names (e.g. "CommonAvailableTimeSlots")
// to unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CommonAvailableTimeSlots") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickFindMeetingTimeCardProto) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickGap struct {
// DisplayRemainingTime: Localized time string in the format: 1 hour 15 minutes
DisplayRemainingTime string `json:"displayRemainingTime,omitempty"`
// EndTime: Localized time string in the format:(Locale CZ) 8:30 odp.
EndTime string `json:"endTime,omitempty"`
EndTimeMs uint64 `json:"endTimeMs,omitempty,string"`
RemainingTime string `json:"remainingTime,omitempty"`
// StartTime: Localized time string in the format:(Locale CZ) 8:30 odp.
StartTime string `json:"startTime,omitempty"`
StartTimeMs uint64 `json:"startTimeMs,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "DisplayRemainingTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayRemainingTime") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickGap) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickGenericAnswerCard struct {
// Answer: The answer.
Answer string `json:"answer,omitempty"`
// Title: Title or header of the card.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "Answer") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Answer") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickGenericAnswerCard) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickGetAndKeepAheadCardProto: Get and keep ahead card
type EnterpriseTopazSidekickGetAndKeepAheadCardProto struct {
DeclinedEvents *EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents `json:"declinedEvents,omitempty"`
MentionedDocuments *EnterpriseTopazSidekickDocumentPerCategoryList `json:"mentionedDocuments,omitempty"`
SharedDocuments *EnterpriseTopazSidekickDocumentPerCategoryList `json:"sharedDocuments,omitempty"`
// ForceSendFields is a list of field names (e.g. "DeclinedEvents") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DeclinedEvents") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickGetAndKeepAheadCardProto) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents: A list of events where all guests declined.
type EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents struct {
Events []*EnterpriseTopazSidekickAgendaEntry `json:"events,omitempty"`
// ForceSendFields is a list of field names (e.g. "Events") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Events") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickGetAndKeepAheadCardProtoDeclinedEvents) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickMeetingNotesCardError: Errors in the creation of meeting notes.
type EnterpriseTopazSidekickMeetingNotesCardError struct {
// Description: The description of the reason why create-meeting-notes failed.
Description string `json:"description,omitempty"`
// Event: The event to request meeting notes creation
Event *EnterpriseTopazSidekickAgendaEntry `json:"event,omitempty"`
// Reason: The reason why create-meeting-notes failed.
//
// Possible values:
// "NONE" - No reason (default value).
// "NOT_OWNER" - The user is not an owner.
// "UNKNOWN" - Unknown reason.
Reason string `json:"reason,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickMeetingNotesCardError) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickMeetingNotesCardProto: Information about the meeting notes created.
type EnterpriseTopazSidekickMeetingNotesCardProto struct {
// Event: The event to request meeting notes creation.
Event *EnterpriseTopazSidekickAgendaEntry `json:"event,omitempty"`
// FileId: Google Drive ID (a.k.a. resource ID) of the file.
FileId string `json:"fileId,omitempty"`
// Title: Title we want to show for meeting notes in the answer card
Title string `json:"title,omitempty"`
// Url: New URL.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "Event") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Event") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickMeetingNotesCardProto) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickMeetingNotesCardRequest: Meeting notes card request.
type EnterpriseTopazSidekickMeetingNotesCardRequest struct {
// CanCreateFor: Who are the meeting notes created for.
//
// Possible values:
// "UNKNOWN" - Unknown (default).
// "MYSELF" - For the requester.
// "ALL_ATTENDEES" - For all the meeting attendees.
CanCreateFor []string `json:"canCreateFor,omitempty"`
// Error: The error and reason if known error occured.
Error *EnterpriseTopazSidekickMeetingNotesCardError `json:"error,omitempty"`
// Event: The event to request meeting notes creation
Event *EnterpriseTopazSidekickAgendaEntry `json:"event,omitempty"`
// ForceSendFields is a list of field names (e.g. "CanCreateFor") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CanCreateFor") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickMeetingNotesCardRequest) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickNlpMetadata: Metadata about the NLP interpretation of the query.
type EnterpriseTopazSidekickNlpMetadata struct {
// Confidence: Confidence of the interpretation that generated this card.
Confidence float64 `json:"confidence,omitempty"`
// ForceSendFields is a list of field names (e.g. "Confidence") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Confidence") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickNlpMetadata) MarshalJSON() ([]byte, error)
func (s *EnterpriseTopazSidekickNlpMetadata) UnmarshalJSON(data []byte) error
EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo: Metadata for disambiguation.
type EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo struct {
// Disambiguation: A list of people that also matched the query. This list is
// not complete.
Disambiguation []*EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson `json:"disambiguation,omitempty"`
// Name: The name that was extracted from the query. This may be in the form of
// the given name, last name, full name, LDAP, or email address. This name can
// be considered suitable for displaying to the user and can largely be
// considered to be normalized (e.g. "Bob's" -> "Bob").
Name string `json:"name,omitempty"`
// ForceSendFields is a list of field names (e.g. "Disambiguation") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Disambiguation") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson: A person that also matches the query, but was not selected due to a lower affinity with the requesting user.
type EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson struct {
// Person: The profile of this person.
Person *EnterpriseTopazSidekickCommonPerson `json:"person,omitempty"`
// Query: The query that can be used to produce an answer card with the same
// attribute, but for this person.
Query string `json:"query,omitempty"`
// ForceSendFields is a list of field names (e.g. "Person") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Person") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPeopleAnswerDisambiguationInfoDisambiguationPerson) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader: Recommended header to display for the card.
type EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader struct {
// Title: The suggested title to display. This defaults to the user's query.
Title string `json:"title,omitempty"`
// ForceSendFields is a list of field names (e.g. "Title") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Title") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard: An answer card for a single person.
type EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard struct {
// Answer: List of answers.
Answer []*SafeHtmlProto `json:"answer,omitempty"`
// AnswerText: List of answers.
AnswerText *EnterpriseTopazSidekickAnswerAnswerList `json:"answerText,omitempty"`
// DisambiguationInfo: Disambiguation information.
DisambiguationInfo *EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo `json:"disambiguationInfo,omitempty"`
// Header: The header to display for the card.
Header *EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader `json:"header,omitempty"`
// ResponseStatus: The response status.
//
// Possible values:
// "UNKNOWN" - Unknown.
// "SUCCESS" - Success.
// "MISSING_PERSON" - No such person was found in the user's domain.
// "MISSING_DATA" - A person was found to match the query, but an answer
// could not be obtained.
ResponseStatus string `json:"responseStatus,omitempty"`
// StatusMessage: Localized user friendly message to display to the user in the
// case of missing data or an error.
StatusMessage string `json:"statusMessage,omitempty"`
// Subject: The profile of the person that was the subject of the query.
Subject *EnterpriseTopazSidekickCommonPerson `json:"subject,omitempty"`
// ForceSendFields is a list of field names (e.g. "Answer") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Answer") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPeopleAnswerPersonAnswerCard) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard: An answer card for a list of people that are related to the subject of the query.
type EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard struct {
// DisambiguationInfo: Disambiguation information.
DisambiguationInfo *EnterpriseTopazSidekickPeopleAnswerDisambiguationInfo `json:"disambiguationInfo,omitempty"`
// Header: The header to display for the card.
Header *EnterpriseTopazSidekickPeopleAnswerPeopleAnswerCardHeader `json:"header,omitempty"`
// RelatedPeople: A list of people that are related to the query subject.
RelatedPeople []*EnterpriseTopazSidekickCommonPerson `json:"relatedPeople,omitempty"`
// RelationType: Defines the type of relation the list of people have with the
// subject of the card.
//
// Possible values:
// "UNKNOWN" - Unknown.
// "DIRECT_REPORTS" - Direct reports.
// "MANAGER" - The manager.
// "PEERS" - The teammates/peers of the subject.
RelationType string `json:"relationType,omitempty"`
// ResponseStatus: The response status.
//
// Possible values:
// "UNKNOWN" - Unknown.
// "SUCCESS" - Success.
// "MISSING_PERSON" - No such person was found in the user's domain.
// "MISSING_DATA" - A person was found to match the query, but an answer
// could not be obtained.
ResponseStatus string `json:"responseStatus,omitempty"`
// StatusMessage: Localized user friendly message to display to the user in the
// case of missing data or an error.
StatusMessage string `json:"statusMessage,omitempty"`
// Subject: The profile of the person that was the subject of the query.
Subject *EnterpriseTopazSidekickCommonPerson `json:"subject,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisambiguationInfo") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisambiguationInfo") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPeopleAnswerRelatedPeopleAnswerCard) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickPeopleDisambiguationCard struct {
// Person: Candidate persons for the query.
Person []*EnterpriseTopazSidekickCommonPerson `json:"person,omitempty"`
// ForceSendFields is a list of field names (e.g. "Person") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Person") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPeopleDisambiguationCard) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickPerson: Person.
type EnterpriseTopazSidekickPerson struct {
// AffinityLevel: The level of affinity this person has with the requesting
// user.
//
// Possible values:
// "UNKNOWN"
// "LOW"
// "MEDIUM"
// "HIGH"
AffinityLevel string `json:"affinityLevel,omitempty"`
// AttendingStatus: Attendance status of the person when included in a meeting
// event.
//
// Possible values:
// "AWAITING" - Awaiting for the user to set the status.
// "YES" - Attending.
// "NO" - Not attending.
// "MAYBE" - Tentatively attending.
AttendingStatus string `json:"attendingStatus,omitempty"`
// Email: Email.
Email string `json:"email,omitempty"`
// GaiaId: Gaia id.
GaiaId int64 `json:"gaiaId,omitempty,string"`
// IsGroup: Whether the invitee is a group.
IsGroup bool `json:"isGroup,omitempty"`
// Name: Name.
Name string `json:"name,omitempty"`
// ObfuscatedGaiaId: Obfuscated Gaia id.
ObfuscatedGaiaId string `json:"obfuscatedGaiaId,omitempty"`
// PhotoUrl: Absolute URL to the profile photo of the person.
PhotoUrl string `json:"photoUrl,omitempty"`
// ForceSendFields is a list of field names (e.g. "AffinityLevel") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AffinityLevel") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPerson) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickPersonProfileCard struct {
RelatedPeople []*EnterpriseTopazSidekickPersonProfileCardRelatedPeople `json:"relatedPeople,omitempty"`
// Subject: The subject of the card.
Subject *EnterpriseTopazSidekickCommonPerson `json:"subject,omitempty"`
// ForceSendFields is a list of field names (e.g. "RelatedPeople") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RelatedPeople") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPersonProfileCard) MarshalJSON() ([]byte, error)
type EnterpriseTopazSidekickPersonProfileCardRelatedPeople struct {
// RelatedPerson: Related people.
RelatedPerson []*EnterpriseTopazSidekickCommonPerson `json:"relatedPerson,omitempty"`
// Relation: Relation type.
//
// Possible values:
// "UNKNOWN"
// "MANAGER"
// "DIRECT_REPORT"
Relation string `json:"relation,omitempty"`
// ForceSendFields is a list of field names (e.g. "RelatedPerson") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RelatedPerson") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPersonProfileCardRelatedPeople) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickPersonalizedDocsCardProto: Personalized docs card proto.
type EnterpriseTopazSidekickPersonalizedDocsCardProto struct {
// DocumentGroup: Document group.
DocumentGroup []*EnterpriseTopazSidekickDocumentGroup `json:"documentGroup,omitempty"`
// ForceSendFields is a list of field names (e.g. "DocumentGroup") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DocumentGroup") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickPersonalizedDocsCardProto) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickRankingParams: Ranking params.
type EnterpriseTopazSidekickRankingParams struct {
// EndTimeMs: The end-time that this object will expect to occur. If the type
// is marked as FIXED, then this end-time will persist after bidding. If the
// type is marked as FLEXIBLE, this field is NOT expected to be filled and will
// be filled in after it has won a bid. Expected to be set when type is set to
// FIXED.
EndTimeMs uint64 `json:"endTimeMs,omitempty,string"`
// Priority: The priority to determine between objects that have the same
// start_time_ms The lower-value of priority == ranked higher. Max-priority =
// 0. Expected to be set for all types.
//
// Possible values:
// "UNKNOWN" - Unknown (default).
// "CRITICAL" - Critical.
// "IMPORTANT" - Important.
// "HIGH" - High.
// "NORMAL" - Normal.
// "BEST_EFFORT" - Best effort.
Priority string `json:"priority,omitempty"`
// Score: The score of the card to be used to break priority-ties
Score float64 `json:"score,omitempty"`
// SpanMs: The span that this card will take in the stream Expected to be set
// when type is set to FLEXIBLE.
SpanMs uint64 `json:"spanMs,omitempty,string"`
// StartTimeMs: The start-time that this object will bid-for If the type is
// marked as FIXED, then this start-time will persist after bidding. If the
// type is marked as FLEXIBLE, then it will occur at the given time or sometime
// after the requested time. Expected to be set for all types.
StartTimeMs uint64 `json:"startTimeMs,omitempty,string"`
// Type: The packing type of this object.
//
// Possible values:
// "FIXED" - Fixed, i.e., the card is time sensitive.
// "FLEXIBLE" - Flexible, i.e., the card is not time sensitive.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "EndTimeMs") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EndTimeMs") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickRankingParams) MarshalJSON() ([]byte, error)
func (s *EnterpriseTopazSidekickRankingParams) UnmarshalJSON(data []byte) error
type EnterpriseTopazSidekickRecentDocumentsCardProto struct {
Document []*EnterpriseTopazSidekickCommonDocument `json:"document,omitempty"`
// ForceSendFields is a list of field names (e.g. "Document") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Document") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickRecentDocumentsCardProto) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickScheduledMeeting: Details about scheduled meetings.
type EnterpriseTopazSidekickScheduledMeeting struct {
// MeetingLocation: The meeting location.
MeetingLocation string `json:"meetingLocation,omitempty"`
// MeetingTime: The meeting time slot.
MeetingTime *EnterpriseTopazSidekickTimeSlot `json:"meetingTime,omitempty"`
// MeetingTitle: The meeting title.
MeetingTitle string `json:"meetingTitle,omitempty"`
// ForceSendFields is a list of field names (e.g. "MeetingLocation") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MeetingLocation") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickScheduledMeeting) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickShareMeetingDocsCardProto: Share meeting docs card proto.
type EnterpriseTopazSidekickShareMeetingDocsCardProto struct {
// Document: Documents to share for the given meeting.
Document []*EnterpriseTopazSidekickCommonDocument `json:"document,omitempty"`
// Event: Event.
Event *EnterpriseTopazSidekickAgendaEntry `json:"event,omitempty"`
// ForceSendFields is a list of field names (e.g. "Document") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Document") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickShareMeetingDocsCardProto) MarshalJSON() ([]byte, error)
EnterpriseTopazSidekickTimeSlot: Slot of time.
type EnterpriseTopazSidekickTimeSlot struct {
// EndTimeDay: Day end time at the user's timezone.
EndTimeDay string `json:"endTimeDay,omitempty"`
// EndTimeHourAndMinute: Hour and minute of the end time at the user's
// timezone.
EndTimeHourAndMinute string `json:"endTimeHourAndMinute,omitempty"`
// EndTimeInMillis: End time in milliseconds.
EndTimeInMillis int64 `json:"endTimeInMillis,omitempty,string"`
// StartTimeDay: Day start time at user's timezone.
StartTimeDay string `json:"startTimeDay,omitempty"`
// StartTimeHourAndMinute: Hour and minute of the start time at the user's
// timezone.
StartTimeHourAndMinute string `json:"startTimeHourAndMinute,omitempty"`
// StartTimeInMillis: Start time in milliseconds.
StartTimeInMillis int64 `json:"startTimeInMillis,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "EndTimeDay") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EndTimeDay") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnterpriseTopazSidekickTimeSlot) MarshalJSON() ([]byte, error)
EnumOperatorOptions: Used to provide a search operator for enum properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched. For example, if you provide no operator for a *priority* enum property with possible values *p0* and *p1*, a query that contains the term *p0* returns items that have *p0* as the value of the *priority* property, as well as any items that contain the string *p0* in other fields. If you provide an operator name for the enum, such as *priority*, then search users can use that operator to refine results to only items that have *p0* as this property's value, with the query *priority:p0*.
type EnumOperatorOptions struct {
// OperatorName: 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:<value>*
// show results only where the value of the property named *priorityVal*
// matches *<value>*. By contrast, a search that uses the same *<value>*
// without an operator returns all items where *<value>* 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 `json:"operatorName,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnumOperatorOptions) MarshalJSON() ([]byte, error)
EnumPropertyOptions: The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value. For example, for items in a request tracking system with priority information, you could define *p0* as an allowable enum value and tie this enum to the operator name *priority* so that search users could add *priority:p0* to their query to restrict the set of results to only those items indexed with the value *p0*.
type EnumPropertyOptions struct {
// OperatorOptions: If set, describes how the enum should be used as a search
// operator.
OperatorOptions *EnumOperatorOptions `json:"operatorOptions,omitempty"`
// OrderedRanking: 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.
//
// Possible values:
// "NO_ORDER" - There is no ranking order for the property. Results aren't
// adjusted by this property's value.
// "ASCENDING" - This property is ranked in ascending order. Lower values
// indicate lower ranking.
// "DESCENDING" - This property is ranked in descending order. Lower values
// indicate higher ranking.
OrderedRanking string `json:"orderedRanking,omitempty"`
// PossibleValues: 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 []*EnumValuePair `json:"possibleValues,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnumPropertyOptions) MarshalJSON() ([]byte, error)
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.
type EnumValuePair struct {
// IntegerValue: The integer value of the EnumValuePair which must be
// non-negative. Optional.
IntegerValue int64 `json:"integerValue,omitempty"`
// StringValue: The string value of the EnumValuePair. The maximum length is 32
// characters.
StringValue string `json:"stringValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "IntegerValue") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "IntegerValue") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnumValuePair) MarshalJSON() ([]byte, error)
EnumValues: List of enum values.
type EnumValues struct {
// Values: The maximum allowable length for string values is 32 characters.
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *EnumValues) MarshalJSON() ([]byte, error)
ErrorInfo: Error information about the response.
type ErrorInfo struct {
ErrorMessages []*ErrorMessage `json:"errorMessages,omitempty"`
// ForceSendFields is a list of field names (e.g. "ErrorMessages") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ErrorMessages") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ErrorInfo) MarshalJSON() ([]byte, error)
ErrorMessage: Error message per source response.
type ErrorMessage struct {
ErrorMessage string `json:"errorMessage,omitempty"`
Source *Source `json:"source,omitempty"`
// ForceSendFields is a list of field names (e.g. "ErrorMessage") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ErrorMessage") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ErrorMessage) MarshalJSON() ([]byte, error)
FacetBucket: A bucket in a facet is the basic unit of operation. A bucket can comprise either a single value OR a contiguous range of values, depending on the type of the field bucketed. FacetBucket is currently used only for returning the response object.
type FacetBucket struct {
// Count: Number of results that match the bucket value. Counts are only
// returned for searches when count accuracy is ensured. Cloud Search does not
// guarantee facet counts for any query and facet counts might be present only
// intermittently, even for identical queries. Do not build dependencies on
// facet count existence; instead use facet ount percentages which are always
// returned.
Count int64 `json:"count,omitempty"`
// Filter: Filter to be passed in the search request if the corresponding
// bucket is selected.
Filter *Filter `json:"filter,omitempty"`
// Percentage: Percent of results that match the bucket value. The returned
// value is between (0-100], and is rounded down to an integer if fractional.
// If the value is not explicitly returned, it represents a percentage value
// that rounds to 0. Percentages are returned for all searches, but are an
// estimate. Because percentages are always returned, you should render
// percentages instead of counts.
Percentage int64 `json:"percentage,omitempty"`
Value *Value `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "Count") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Count") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FacetBucket) MarshalJSON() ([]byte, error)
FacetOptions: Specifies operators to return facet results for. There will be one FacetResult for every source_name/object_type/operator_name combination.
type FacetOptions struct {
// IntegerFacetingOptions: If set, describes integer faceting options for the
// given integer property. The corresponding integer property in the schema
// should be marked isFacetable. The number of buckets returned would be
// minimum of this and num_facet_buckets.
IntegerFacetingOptions *IntegerFacetingOptions `json:"integerFacetingOptions,omitempty"`
// NumFacetBuckets: Maximum number of facet buckets that should be returned for
// this facet. Defaults to 10. Maximum value is 100.
NumFacetBuckets int64 `json:"numFacetBuckets,omitempty"`
// ObjectType: 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 `json:"objectType,omitempty"`
// OperatorName: The name of the operator chosen for faceting. @see
// cloudsearch.SchemaPropertyOptions
OperatorName string `json:"operatorName,omitempty"`
// SourceName: Source name to facet on. Format: datasources/{source_id} If
// empty, all data sources will be used.
SourceName string `json:"sourceName,omitempty"`
// ForceSendFields is a list of field names (e.g. "IntegerFacetingOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "IntegerFacetingOptions") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FacetOptions) MarshalJSON() ([]byte, error)
FacetResult: Source specific facet response
type FacetResult struct {
// Buckets: FacetBuckets for values in response containing at least a single
// result with the corresponding filter.
Buckets []*FacetBucket `json:"buckets,omitempty"`
// ObjectType: Object type for which facet results are returned. Can be empty.
ObjectType string `json:"objectType,omitempty"`
// OperatorName: The name of the operator chosen for faceting. @see
// cloudsearch.SchemaPropertyOptions
OperatorName string `json:"operatorName,omitempty"`
// SourceName: Source name for which facet results are returned. Will not be
// empty.
SourceName string `json:"sourceName,omitempty"`
// ForceSendFields is a list of field names (e.g. "Buckets") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Buckets") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FacetResult) MarshalJSON() ([]byte, error)
type FieldViolation struct {
// Description: The description of the error.
Description string `json:"description,omitempty"`
// Field: Path of field with violation.
Field string `json:"field,omitempty"`
// ForceSendFields is a list of field names (e.g. "Description") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Description") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FieldViolation) MarshalJSON() ([]byte, error)
Filter: A generic way of expressing filters in a query, which supports two approaches: **1. Setting a ValueFilter.** The name must match an operator_name defined in the schema for your data source. **2. Setting a CompositeFilter.** The filters are evaluated using the logical operator. The top-level operators can only be either an AND or a NOT. AND can appear only at the top-most level. OR can appear only under a top-level AND.
type Filter struct {
CompositeFilter *CompositeFilter `json:"compositeFilter,omitempty"`
ValueFilter *ValueFilter `json:"valueFilter,omitempty"`
// ForceSendFields is a list of field names (e.g. "CompositeFilter") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CompositeFilter") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Filter) MarshalJSON() ([]byte, error)
FilterOptions: Filter options to be applied on query.
type FilterOptions struct {
// Filter: Generic filter to restrict the search, such as `lang:en`,
// `site:xyz`.
Filter *Filter `json:"filter,omitempty"`
// ObjectType: 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 `json:"objectType,omitempty"`
// ForceSendFields is a list of field names (e.g. "Filter") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Filter") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FilterOptions) MarshalJSON() ([]byte, error)
FreshnessOptions: Indicates which freshness property to use when adjusting search ranking for an item. Fresher, more recent dates indicate higher quality. Use the freshness option property that best works with your data. For fileshare documents, last modified time is most relevant. For calendar event data, the time when the event occurs is a more relevant freshness indicator. In this way, calendar events that occur closer to the time of the search query are considered higher quality and ranked accordingly.
type FreshnessOptions struct {
// FreshnessDuration: The duration after which an object should be considered
// stale. The default value is 180 days (in seconds).
FreshnessDuration string `json:"freshnessDuration,omitempty"`
// FreshnessProperty: 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. When a property is used to calculate
// freshness, the value defaults to 2 years from the current time.
FreshnessProperty string `json:"freshnessProperty,omitempty"`
// ForceSendFields is a list of field names (e.g. "FreshnessDuration") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FreshnessDuration") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *FreshnessOptions) MarshalJSON() ([]byte, error)
type GSuitePrincipal struct {
// GsuiteDomain: This principal represents all users of the Google Workspace
// domain of the customer.
GsuiteDomain bool `json:"gsuiteDomain,omitempty"`
// GsuiteGroupEmail: This principal references a Google Workspace group name.
GsuiteGroupEmail string `json:"gsuiteGroupEmail,omitempty"`
// GsuiteUserEmail: This principal references a Google Workspace user account.
GsuiteUserEmail string `json:"gsuiteUserEmail,omitempty"`
// ForceSendFields is a list of field names (e.g. "GsuiteDomain") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "GsuiteDomain") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GSuitePrincipal) MarshalJSON() ([]byte, error)
type GetCustomerIndexStatsResponse struct {
// AverageIndexedItemCount: Average item count for the given date range for
// which billing is done.
AverageIndexedItemCount int64 `json:"averageIndexedItemCount,omitempty,string"`
// Stats: Summary of indexed item counts, one for each day in the requested
// range.
Stats []*CustomerIndexStats `json:"stats,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AverageIndexedItemCount") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AverageIndexedItemCount") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetCustomerIndexStatsResponse) MarshalJSON() ([]byte, error)
type GetCustomerQueryStatsResponse struct {
Stats []*CustomerQueryStats `json:"stats,omitempty"`
// TotalQueryCount: Total successful query count (status code 200) for the
// given date range.
TotalQueryCount int64 `json:"totalQueryCount,omitempty,string"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Stats") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Stats") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetCustomerQueryStatsResponse) MarshalJSON() ([]byte, error)
GetCustomerSearchApplicationStatsResponse: Response format for search application stats for a customer.
type GetCustomerSearchApplicationStatsResponse struct {
// AverageSearchApplicationCount: Average search application count for the
// given date range.
AverageSearchApplicationCount int64 `json:"averageSearchApplicationCount,omitempty,string"`
// Stats: Search application stats by date.
Stats []*CustomerSearchApplicationStats `json:"stats,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g.
// "AverageSearchApplicationCount") to unconditionally include in API requests.
// By default, fields with empty or default values are omitted from API
// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
// for more details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AverageSearchApplicationCount")
// to include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetCustomerSearchApplicationStatsResponse) MarshalJSON() ([]byte, error)
type GetCustomerSessionStatsResponse struct {
Stats []*CustomerSessionStats `json:"stats,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Stats") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Stats") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetCustomerSessionStatsResponse) MarshalJSON() ([]byte, error)
type GetCustomerUserStatsResponse struct {
Stats []*CustomerUserStats `json:"stats,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Stats") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Stats") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetCustomerUserStatsResponse) MarshalJSON() ([]byte, error)
type GetDataSourceIndexStatsResponse struct {
// AverageIndexedItemCount: Average item count for the given date range for
// which billing is done.
AverageIndexedItemCount int64 `json:"averageIndexedItemCount,omitempty,string"`
// Stats: Summary of indexed item counts, one for each day in the requested
// range.
Stats []*DataSourceIndexStats `json:"stats,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "AverageIndexedItemCount") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AverageIndexedItemCount") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetDataSourceIndexStatsResponse) MarshalJSON() ([]byte, error)
GetSearchApplicationQueryStatsResponse: Response format for getting query stats for a search application between given dates.
type GetSearchApplicationQueryStatsResponse struct {
// Stats: Query stats per date for a search application.
Stats []*SearchApplicationQueryStats `json:"stats,omitempty"`
// TotalQueryCount: Total successful query count (status code 200) for the
// given date range.
TotalQueryCount int64 `json:"totalQueryCount,omitempty,string"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Stats") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Stats") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetSearchApplicationQueryStatsResponse) MarshalJSON() ([]byte, error)
type GetSearchApplicationSessionStatsResponse struct {
Stats []*SearchApplicationSessionStats `json:"stats,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Stats") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Stats") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetSearchApplicationSessionStatsResponse) MarshalJSON() ([]byte, error)
type GetSearchApplicationUserStatsResponse struct {
Stats []*SearchApplicationUserStats `json:"stats,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Stats") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Stats") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *GetSearchApplicationUserStatsResponse) MarshalJSON() ([]byte, error)
HtmlOperatorOptions: Used to provide a search operator for html properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
type HtmlOperatorOptions struct {
// OperatorName: 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:<value>* show
// results only where the value of the property named *subjectLine* matches
// *<value>*. By contrast, a search that uses the same *<value>* without an
// operator return all items where *<value>* 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 `json:"operatorName,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *HtmlOperatorOptions) MarshalJSON() ([]byte, error)
HtmlPropertyOptions: The options for html properties.
type HtmlPropertyOptions struct {
// OperatorOptions: If set, describes how the property should be used as a
// search operator.
OperatorOptions *HtmlOperatorOptions `json:"operatorOptions,omitempty"`
// RetrievalImportance: Indicates the search quality importance of the tokens
// within the field when used for retrieval. Can only be set to DEFAULT or
// NONE.
RetrievalImportance *RetrievalImportance `json:"retrievalImportance,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *HtmlPropertyOptions) MarshalJSON() ([]byte, error)
HtmlValues: List of html values.
type HtmlValues struct {
// Values: The maximum allowable length for html values is 2048 characters.
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *HtmlValues) MarshalJSON() ([]byte, error)
type IndexItemOptions struct {
// AllowUnknownGsuitePrincipals: Specifies if the index request should allow
// Google Workspace principals that do not exist or are deleted.
AllowUnknownGsuitePrincipals bool `json:"allowUnknownGsuitePrincipals,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "AllowUnknownGsuitePrincipals") to unconditionally include in API requests.
// By default, fields with empty or default values are omitted from API
// requests. See https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields
// for more details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AllowUnknownGsuitePrincipals") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *IndexItemOptions) MarshalJSON() ([]byte, error)
type IndexItemRequest struct {
// ConnectorName: The name of connector making this call. Format:
// datasources/{source_id}/connectors/{ID}
ConnectorName string `json:"connectorName,omitempty"`
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
IndexItemOptions *IndexItemOptions `json:"indexItemOptions,omitempty"`
// Item: The name of the item. Format: datasources/{source_id}/items/{item_id}
Item *Item `json:"item,omitempty"`
// Mode: Required. The RequestMode for this request.
//
// Possible values:
// "UNSPECIFIED" - The priority is not specified in the update request.
// Leaving priority unspecified results in an update failure.
// "SYNCHRONOUS" - For real-time updates.
// "ASYNCHRONOUS" - For changes that are executed after the response is sent
// back to the caller.
Mode string `json:"mode,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConnectorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConnectorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *IndexItemRequest) MarshalJSON() ([]byte, error)
type IndexingDatasourcesDeleteSchemaCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesDeleteSchemaCall) Context(ctx context.Context) *IndexingDatasourcesDeleteSchemaCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesDeleteSchemaCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *IndexingDatasourcesDeleteSchemaCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *IndexingDatasourcesDeleteSchemaCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.indexing.datasources.deleteSchema" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesDeleteSchemaCall) Fields(s ...googleapi.Field) *IndexingDatasourcesDeleteSchemaCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesDeleteSchemaCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type IndexingDatasourcesGetSchemaCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesGetSchemaCall) Context(ctx context.Context) *IndexingDatasourcesGetSchemaCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesGetSchemaCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *IndexingDatasourcesGetSchemaCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *IndexingDatasourcesGetSchemaCall) Do(opts ...googleapi.CallOption) (*Schema, error)
Do executes the "cloudsearch.indexing.datasources.getSchema" call. Any non-2xx status code is an error. Response headers are in either *Schema.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesGetSchemaCall) Fields(s ...googleapi.Field) *IndexingDatasourcesGetSchemaCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesGetSchemaCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *IndexingDatasourcesGetSchemaCall) IfNoneMatch(entityTag string) *IndexingDatasourcesGetSchemaCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type IndexingDatasourcesItemsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsDeleteCall) ConnectorName(connectorName string) *IndexingDatasourcesItemsDeleteCall
ConnectorName sets the optional parameter "connectorName": The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
func (c *IndexingDatasourcesItemsDeleteCall) Context(ctx context.Context) *IndexingDatasourcesItemsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsDeleteCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *IndexingDatasourcesItemsDeleteCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *IndexingDatasourcesItemsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.indexing.datasources.items.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsDeleteCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *IndexingDatasourcesItemsDeleteCall) Mode(mode string) *IndexingDatasourcesItemsDeleteCall
Mode sets the optional parameter "mode": Required. The RequestMode for this request.
Possible values:
"UNSPECIFIED" - The priority is not specified in the update request.
Leaving priority unspecified results in an update failure.
"SYNCHRONOUS" - For real-time updates. "ASYNCHRONOUS" - For changes that are executed after the response is sent
back to the caller.
func (c *IndexingDatasourcesItemsDeleteCall) Version(version string) *IndexingDatasourcesItemsDeleteCall
Version sets the optional parameter "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. For information on how item version affects the deletion process, refer to Handle revisions after manual deletes (https://developers.google.com/cloud-search/docs/guides/operations).
type IndexingDatasourcesItemsDeleteQueueItemsCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsDeleteQueueItemsCall) Context(ctx context.Context) *IndexingDatasourcesItemsDeleteQueueItemsCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsDeleteQueueItemsCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.indexing.datasources.items.deleteQueueItems" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsDeleteQueueItemsCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsDeleteQueueItemsCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsDeleteQueueItemsCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type IndexingDatasourcesItemsGetCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsGetCall) ConnectorName(connectorName string) *IndexingDatasourcesItemsGetCall
ConnectorName sets the optional parameter "connectorName": The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
func (c *IndexingDatasourcesItemsGetCall) Context(ctx context.Context) *IndexingDatasourcesItemsGetCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsGetCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *IndexingDatasourcesItemsGetCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *IndexingDatasourcesItemsGetCall) Do(opts ...googleapi.CallOption) (*Item, error)
Do executes the "cloudsearch.indexing.datasources.items.get" call. Any non-2xx status code is an error. Response headers are in either *Item.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsGetCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *IndexingDatasourcesItemsGetCall) IfNoneMatch(entityTag string) *IndexingDatasourcesItemsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type IndexingDatasourcesItemsIndexCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsIndexCall) Context(ctx context.Context) *IndexingDatasourcesItemsIndexCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsIndexCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.indexing.datasources.items.index" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsIndexCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsIndexCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsIndexCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type IndexingDatasourcesItemsListCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsListCall) Brief(brief bool) *IndexingDatasourcesItemsListCall
Brief sets the optional parameter "brief": When set to true, the indexing system only populates the following fields: name, version, queue. metadata.hash, metadata.title, metadata.sourceRepositoryURL, metadata.objectType, metadata.createTime, metadata.updateTime, metadata.contentLanguage, metadata.mimeType, structured_data.hash, content.hash, itemType, itemStatus.code, itemStatus.processingError.code, itemStatus.repositoryError.type, If this value is false, then all the fields are populated in Item.
func (c *IndexingDatasourcesItemsListCall) ConnectorName(connectorName string) *IndexingDatasourcesItemsListCall
ConnectorName sets the optional parameter "connectorName": The name of connector making this call. Format: datasources/{source_id}/connectors/{ID}
func (c *IndexingDatasourcesItemsListCall) Context(ctx context.Context) *IndexingDatasourcesItemsListCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsListCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *IndexingDatasourcesItemsListCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *IndexingDatasourcesItemsListCall) Do(opts ...googleapi.CallOption) (*ListItemsResponse, error)
Do executes the "cloudsearch.indexing.datasources.items.list" call. Any non-2xx status code is an error. Response headers are in either *ListItemsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsListCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *IndexingDatasourcesItemsListCall) IfNoneMatch(entityTag string) *IndexingDatasourcesItemsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *IndexingDatasourcesItemsListCall) PageSize(pageSize int64) *IndexingDatasourcesItemsListCall
PageSize sets the optional parameter "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
func (c *IndexingDatasourcesItemsListCall) PageToken(pageToken string) *IndexingDatasourcesItemsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any.
func (c *IndexingDatasourcesItemsListCall) Pages(ctx context.Context, f func(*ListItemsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type IndexingDatasourcesItemsPollCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsPollCall) Context(ctx context.Context) *IndexingDatasourcesItemsPollCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsPollCall) Do(opts ...googleapi.CallOption) (*PollItemsResponse, error)
Do executes the "cloudsearch.indexing.datasources.items.poll" call. Any non-2xx status code is an error. Response headers are in either *PollItemsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsPollCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsPollCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsPollCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type IndexingDatasourcesItemsPushCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsPushCall) Context(ctx context.Context) *IndexingDatasourcesItemsPushCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsPushCall) Do(opts ...googleapi.CallOption) (*Item, error)
Do executes the "cloudsearch.indexing.datasources.items.push" call. Any non-2xx status code is an error. Response headers are in either *Item.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsPushCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsPushCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsPushCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type IndexingDatasourcesItemsService struct {
// contains filtered or unexported fields
}
func NewIndexingDatasourcesItemsService(s *Service) *IndexingDatasourcesItemsService
func (r *IndexingDatasourcesItemsService) Delete(name string) *IndexingDatasourcesItemsDeleteCall
Delete: Deletes Item resource for the specified resource name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
func (r *IndexingDatasourcesItemsService) DeleteQueueItems(name string, deletequeueitemsrequest *DeleteQueueItemsRequest) *IndexingDatasourcesItemsDeleteQueueItemsCall
DeleteQueueItems: Deletes all items in a queue. This method is useful for deleting stale items. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
func (r *IndexingDatasourcesItemsService) Get(name string) *IndexingDatasourcesItemsGetCall
Get: Gets Item resource by item name. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
func (r *IndexingDatasourcesItemsService) Index(name string, indexitemrequest *IndexItemRequest) *IndexingDatasourcesItemsIndexCall
Index: 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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
func (r *IndexingDatasourcesItemsService) List(name string) *IndexingDatasourcesItemsListCall
List: Lists all or a subset of Item resources. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
func (r *IndexingDatasourcesItemsService) Poll(name string, pollitemsrequest *PollItemsRequest) *IndexingDatasourcesItemsPollCall
Poll: 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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
func (r *IndexingDatasourcesItemsService) Push(name string, pushitemrequest *PushItemRequest) *IndexingDatasourcesItemsPushCall
Push: Pushes an item onto a queue for later polling and updating. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
func (r *IndexingDatasourcesItemsService) Unreserve(name string, unreserveitemsrequest *UnreserveItemsRequest) *IndexingDatasourcesItemsUnreserveCall
Unreserve: 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. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
func (r *IndexingDatasourcesItemsService) Upload(name string, startuploaditemrequest *StartUploadItemRequest) *IndexingDatasourcesItemsUploadCall
Upload: Creates an upload session for uploading item content. For items smaller than 100 KB, it's easier to embed the content inline within an index request. This API requires an admin or service account to execute. The service account used is the one whitelisted in the corresponding data source.
type IndexingDatasourcesItemsUnreserveCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsUnreserveCall) Context(ctx context.Context) *IndexingDatasourcesItemsUnreserveCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsUnreserveCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.indexing.datasources.items.unreserve" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsUnreserveCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsUnreserveCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsUnreserveCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type IndexingDatasourcesItemsUploadCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesItemsUploadCall) Context(ctx context.Context) *IndexingDatasourcesItemsUploadCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesItemsUploadCall) Do(opts ...googleapi.CallOption) (*UploadItemRef, error)
Do executes the "cloudsearch.indexing.datasources.items.upload" call. Any non-2xx status code is an error. Response headers are in either *UploadItemRef.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesItemsUploadCall) Fields(s ...googleapi.Field) *IndexingDatasourcesItemsUploadCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesItemsUploadCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type IndexingDatasourcesService struct {
Items *IndexingDatasourcesItemsService
// contains filtered or unexported fields
}
func NewIndexingDatasourcesService(s *Service) *IndexingDatasourcesService
func (r *IndexingDatasourcesService) DeleteSchema(name string) *IndexingDatasourcesDeleteSchemaCall
DeleteSchema: Deletes the schema of a data source. **Note:** This API requires an admin or service account to execute.
func (r *IndexingDatasourcesService) GetSchema(name string) *IndexingDatasourcesGetSchemaCall
GetSchema: Gets the schema of a data source. **Note:** This API requires an admin or service account to execute.
func (r *IndexingDatasourcesService) UpdateSchema(name string, updateschemarequest *UpdateSchemaRequest) *IndexingDatasourcesUpdateSchemaCall
UpdateSchema: Updates the schema of a data source. This method does not perform incremental updates to the schema. Instead, this method updates the schema by overwriting the entire schema. **Note:** This API requires an admin or service account to execute.
type IndexingDatasourcesUpdateSchemaCall struct {
// contains filtered or unexported fields
}
func (c *IndexingDatasourcesUpdateSchemaCall) Context(ctx context.Context) *IndexingDatasourcesUpdateSchemaCall
Context sets the context to be used in this call's Do method.
func (c *IndexingDatasourcesUpdateSchemaCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.indexing.datasources.updateSchema" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *IndexingDatasourcesUpdateSchemaCall) Fields(s ...googleapi.Field) *IndexingDatasourcesUpdateSchemaCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *IndexingDatasourcesUpdateSchemaCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type IndexingService struct {
Datasources *IndexingDatasourcesService
// contains filtered or unexported fields
}
func NewIndexingService(s *Service) *IndexingService
InitializeCustomerRequest: Request message for `InitializeCustomer` method.
type InitializeCustomerRequest struct {
}
IntegerFacetingOptions: Used to specify integer faceting options.
type IntegerFacetingOptions struct {
// IntegerBuckets: Buckets for given integer values should be in strictly
// ascending order. For example, if values supplied are (1,5,10,100), the
// following facet buckets will be formed {<1, [1,5), [5-10), [10-100), >=100}.
IntegerBuckets googleapi.Int64s `json:"integerBuckets,omitempty"`
// ForceSendFields is a list of field names (e.g. "IntegerBuckets") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "IntegerBuckets") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *IntegerFacetingOptions) MarshalJSON() ([]byte, error)
IntegerOperatorOptions: Used to provide a search operator for integer properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
type IntegerOperatorOptions struct {
// GreaterThanOperatorName: 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:<value>*
// show results only where the value of the property named *priorityVal* is
// greater than *<value>*. The operator name can only contain lowercase letters
// (a-z). The maximum length is 32 characters.
GreaterThanOperatorName string `json:"greaterThanOperatorName,omitempty"`
// LessThanOperatorName: 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:<value>* show results
// only where the value of the property named *priorityVal* is less than
// *<value>*. The operator name can only contain lowercase letters (a-z). The
// maximum length is 32 characters.
LessThanOperatorName string `json:"lessThanOperatorName,omitempty"`
// OperatorName: 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:<value>*
// show results only where the value of the property named *priorityVal*
// matches *<value>*. By contrast, a search that uses the same *<value>*
// without an operator returns all items where *<value>* 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 `json:"operatorName,omitempty"`
// ForceSendFields is a list of field names (e.g. "GreaterThanOperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "GreaterThanOperatorName") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *IntegerOperatorOptions) MarshalJSON() ([]byte, error)
IntegerPropertyOptions: The options for integer properties.
type IntegerPropertyOptions struct {
// IntegerFacetingOptions: If set, describes integer faceting options for the
// given integer property. The corresponding integer property should be marked
// isFacetable.
IntegerFacetingOptions *IntegerFacetingOptions `json:"integerFacetingOptions,omitempty"`
// MaximumValue: 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 int64 `json:"maximumValue,omitempty,string"`
// MinimumValue: 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 int64 `json:"minimumValue,omitempty,string"`
// OperatorOptions: If set, describes how the integer should be used as a
// search operator.
OperatorOptions *IntegerOperatorOptions `json:"operatorOptions,omitempty"`
// OrderedRanking: Used to specify the ordered ranking for the integer. Can
// only be used if isRepeatable is false.
//
// Possible values:
// "NO_ORDER" - There is no ranking order for the property. Results are not
// adjusted by this property's value.
// "ASCENDING" - This property is ranked in ascending order. Lower values
// indicate lower ranking.
// "DESCENDING" - This property is ranked in descending order. Lower values
// indicate higher ranking.
OrderedRanking string `json:"orderedRanking,omitempty"`
// ForceSendFields is a list of field names (e.g. "IntegerFacetingOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "IntegerFacetingOptions") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *IntegerPropertyOptions) MarshalJSON() ([]byte, error)
IntegerValues: List of integer values.
type IntegerValues struct {
Values googleapi.Int64s `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *IntegerValues) MarshalJSON() ([]byte, error)
Interaction: Represents an interaction between a user and an item.
type Interaction struct {
// InteractionTime: 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 `json:"interactionTime,omitempty"`
// Principal: The user that acted on the item.
Principal *Principal `json:"principal,omitempty"`
// Possible values:
// "UNSPECIFIED" - Invalid value.
// "VIEW" - This interaction indicates the user viewed the item.
// "EDIT" - This interaction indicates the user edited the item.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "InteractionTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "InteractionTime") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Interaction) MarshalJSON() ([]byte, error)
Item: Represents a single object that is an item in the search index, such as a file, folder, or a database record.
type Item struct {
// Acl: Access control list for this item.
Acl *ItemAcl `json:"acl,omitempty"`
// Content: Item content to be indexed and made text searchable.
Content *ItemContent `json:"content,omitempty"`
// ItemType: The type for this item.
//
// Possible values:
// "UNSPECIFIED"
// "CONTENT_ITEM" - An item that is indexed for the only purpose of serving
// information. These items cannot be referred in containerName or
// inheritAclFrom fields.
// "CONTAINER_ITEM" - An item that gets indexed and whose purpose is to
// supply other items with ACLs and/or contain other items.
// "VIRTUAL_CONTAINER_ITEM" - An item that does not get indexed, but
// otherwise has the same purpose as CONTAINER_ITEM.
ItemType string `json:"itemType,omitempty"`
// Metadata: The metadata information.
Metadata *ItemMetadata `json:"metadata,omitempty"`
// Name: The name of the Item. Format: datasources/{source_id}/items/{item_id}
// This is a required field. The maximum length is 1536 characters.
Name string `json:"name,omitempty"`
// Payload: Additional state connector can store for this item. The maximum
// length is 10000 bytes.
Payload string `json:"payload,omitempty"`
// Queue: Queue this item belongs to. The maximum length is 100 characters.
Queue string `json:"queue,omitempty"`
// Status: Status of the item. Output only field.
Status *ItemStatus `json:"status,omitempty"`
// StructuredData: The structured data for the item that should conform to a
// registered object definition in the schema for the data source.
StructuredData *ItemStructuredData `json:"structuredData,omitempty"`
// Version: 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. 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. For information on how item version affects
// the deletion process, refer to Handle revisions after manual deletes
// (https://developers.google.com/cloud-search/docs/guides/operations).
Version string `json:"version,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Acl") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Acl") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Item) MarshalJSON() ([]byte, error)
ItemAcl: Access control list information for the item. For more information see Map ACLs (https://developers.google.com/cloud-search/docs/guides/acls).
type ItemAcl struct {
// AclInheritanceType: 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.
//
// Possible values:
// "NOT_APPLICABLE" - The default value when this item does not inherit an
// ACL. Use NOT_APPLICABLE when inheritAclFrom is empty. An item without ACL
// inheritance can still have ACLs supplied by its own readers and
// deniedReaders fields.
// "CHILD_OVERRIDE" - During an authorization conflict, the ACL of the child
// item determines its read access.
// "PARENT_OVERRIDE" - During an authorization conflict, the ACL of the
// parent item specified in the inheritAclFrom field determines read access.
// "BOTH_PERMIT" - Access is granted only if this item and the parent item
// specified in the inheritAclFrom field both permit read access.
AclInheritanceType string `json:"aclInheritanceType,omitempty"`
// DeniedReaders: 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 []*Principal `json:"deniedReaders,omitempty"`
// InheritAclFrom: The 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 `json:"inheritAclFrom,omitempty"`
// Owners: 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 []*Principal `json:"owners,omitempty"`
// Readers: 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 []*Principal `json:"readers,omitempty"`
// ForceSendFields is a list of field names (e.g. "AclInheritanceType") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AclInheritanceType") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ItemAcl) MarshalJSON() ([]byte, error)
ItemContent: Content of an item to be indexed and surfaced by Cloud Search. Only UTF-8 encoded strings are allowed as inlineContent. If the content is uploaded and not binary, it must be UTF-8 encoded.
type ItemContent struct {
// ContentDataRef: Upload reference ID of a previously uploaded content via
// write method.
ContentDataRef *UploadItemRef `json:"contentDataRef,omitempty"`
// Possible values:
// "UNSPECIFIED" - Invalid value.
// "HTML" - contentFormat is HTML.
// "TEXT" - contentFormat is free text.
// "RAW" - contentFormat is raw bytes.
ContentFormat string `json:"contentFormat,omitempty"`
// Hash: 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 `json:"hash,omitempty"`
// InlineContent: Content that is supplied inlined within the update method.
// The maximum length is 102400 bytes (100 KiB).
InlineContent string `json:"inlineContent,omitempty"`
// ForceSendFields is a list of field names (e.g. "ContentDataRef") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ContentDataRef") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ItemContent) MarshalJSON() ([]byte, error)
type ItemCountByStatus struct {
// Count: Number of items matching the status code.
Count int64 `json:"count,omitempty,string"`
// IndexedItemsCount: Number of items matching the status code for which
// billing is done. This excludes virtual container items from the total count.
// This count would not be applicable for items with ERROR or NEW_ITEM status
// code.
IndexedItemsCount int64 `json:"indexedItemsCount,omitempty,string"`
// StatusCode: Status of the items.
//
// Possible values:
// "CODE_UNSPECIFIED" - Input-only value. Used with Items.list to list all
// items in the queue, regardless of status.
// "ERROR" - Error encountered by Cloud Search while processing this item.
// Details of the error are in repositoryError.
// "MODIFIED" - Item has been modified in the repository, and is out of date
// with the version previously accepted into Cloud Search.
// "NEW_ITEM" - Item is known to exist in the repository, but is not yet
// accepted by Cloud Search. An item can be in this state when Items.push has
// been called for an item of this name that did not exist previously.
// "ACCEPTED" - API has accepted the up-to-date data of this item.
StatusCode string `json:"statusCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "Count") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Count") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ItemCountByStatus) MarshalJSON() ([]byte, error)
ItemMetadata: Available metadata fields for the item.
type ItemMetadata struct {
// ContainerName: 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 `json:"containerName,omitempty"`
// ContentLanguage: 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 `json:"contentLanguage,omitempty"`
// ContextAttributes: A set of named attributes associated with the item. This
// can be used for influencing the ranking of the item based on the context in
// the request. The maximum number of elements is 10.
ContextAttributes []*ContextAttribute `json:"contextAttributes,omitempty"`
// CreateTime: The time when the item was created in the source repository.
CreateTime string `json:"createTime,omitempty"`
// Hash: 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 `json:"hash,omitempty"`
// Interactions: 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 []*Interaction `json:"interactions,omitempty"`
// Keywords: 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 `json:"keywords,omitempty"`
// MimeType: The original mime-type of ItemContent.content in the source
// repository. The maximum length is 256 characters.
MimeType string `json:"mimeType,omitempty"`
// ObjectType: 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 `json:"objectType,omitempty"`
// SearchQualityMetadata: Additional search quality metadata of the item
SearchQualityMetadata *SearchQualityMetadata `json:"searchQualityMetadata,omitempty"`
// SourceRepositoryUrl: Link to the source repository serving the data. Seach
// results apply this link to the title. Whitespace or special characters may
// cause Cloud Seach result links to trigger a redirect notice; to avoid this,
// encode the URL. The maximum length is 2048 characters.
SourceRepositoryUrl string `json:"sourceRepositoryUrl,omitempty"`
// Title: 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 `json:"title,omitempty"`
// UpdateTime: The time when the item was last modified in the source
// repository.
UpdateTime string `json:"updateTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "ContainerName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ContainerName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ItemMetadata) MarshalJSON() ([]byte, error)
ItemStatus: This contains item's status and any errors.
type ItemStatus struct {
// Code: Status code.
//
// Possible values:
// "CODE_UNSPECIFIED" - Input-only value. Used with Items.list to list all
// items in the queue, regardless of status.
// "ERROR" - Error encountered by Cloud Search while processing this item.
// Details of the error are in repositoryError.
// "MODIFIED" - Item has been modified in the repository, and is out of date
// with the version previously accepted into Cloud Search.
// "NEW_ITEM" - Item is known to exist in the repository, but is not yet
// accepted by Cloud Search. An item can be in this state when Items.push has
// been called for an item of this name that did not exist previously.
// "ACCEPTED" - API has accepted the up-to-date data of this item.
Code string `json:"code,omitempty"`
// ProcessingErrors: Error details in case the item is in ERROR state.
ProcessingErrors []*ProcessingError `json:"processingErrors,omitempty"`
// RepositoryErrors: Repository error reported by connector.
RepositoryErrors []*RepositoryError `json:"repositoryErrors,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ItemStatus) MarshalJSON() ([]byte, error)
ItemStructuredData: Available structured data fields for the item.
type ItemStructuredData struct {
// Hash: 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 `json:"hash,omitempty"`
// Object: The structured data object that should conform to a registered
// object definition in the schema for the data source.
Object *StructuredDataObject `json:"object,omitempty"`
// ForceSendFields is a list of field names (e.g. "Hash") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Hash") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ItemStructuredData) MarshalJSON() ([]byte, error)
type ListDataSourceResponse struct {
// NextPageToken: Token to retrieve the next page of results, or empty if there
// are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
Sources []*DataSource `json:"sources,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListDataSourceResponse) MarshalJSON() ([]byte, error)
type ListItemNamesForUnmappedIdentityResponse struct {
ItemNames []string `json:"itemNames,omitempty"`
// NextPageToken: Token to retrieve the next page of results, or empty if there
// are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ItemNames") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ItemNames") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListItemNamesForUnmappedIdentityResponse) MarshalJSON() ([]byte, error)
type ListItemsResponse struct {
Items []*Item `json:"items,omitempty"`
// NextPageToken: Token to retrieve the next page of results, or empty if there
// are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Items") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListItemsResponse) MarshalJSON() ([]byte, error)
ListOperationsResponse: The response message for Operations.ListOperations.
type ListOperationsResponse struct {
// NextPageToken: The standard List next-page token.
NextPageToken string `json:"nextPageToken,omitempty"`
// Operations: A list of operations that matches the specified filter in the
// request.
Operations []*Operation `json:"operations,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error)
ListQuerySourcesResponse: List sources response.
type ListQuerySourcesResponse struct {
NextPageToken string `json:"nextPageToken,omitempty"`
Sources []*QuerySource `json:"sources,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListQuerySourcesResponse) MarshalJSON() ([]byte, error)
type ListSearchApplicationsResponse struct {
// NextPageToken: Token to retrieve the next page of results, or empty if there
// are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
SearchApplications []*SearchApplication `json:"searchApplications,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListSearchApplicationsResponse) MarshalJSON() ([]byte, error)
type ListUnmappedIdentitiesResponse struct {
// NextPageToken: Token to retrieve the next page of results, or empty if there
// are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
UnmappedIdentities []*UnmappedIdentity `json:"unmappedIdentities,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "NextPageToken") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NextPageToken") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ListUnmappedIdentitiesResponse) MarshalJSON() ([]byte, error)
MapInfo: Geo information used for rendering a map that shows the user's work location.
type MapInfo struct {
// Lat: Latitude in degrees
Lat float64 `json:"lat,omitempty"`
// LocationUrl: URL to a view of a map centered on the user's work location in
// Campus Maps (for google.com) or Google Maps (external).
LocationUrl *SafeUrlProto `json:"locationUrl,omitempty"`
// Long: Longitude in degrees
Long float64 `json:"long,omitempty"`
// MapTile: MapTiles for the area around a user's work location
MapTile []*MapTile `json:"mapTile,omitempty"`
// Zoom: The zoom level of the map. A constant zoom value of 18 is used for now
// to match the zoom of the map shown on a Moma Teams Profile page
Zoom int64 `json:"zoom,omitempty"`
// ForceSendFields is a list of field names (e.g. "Lat") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Lat") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MapInfo) MarshalJSON() ([]byte, error)
func (s *MapInfo) UnmarshalJSON(data []byte) error
MapTile: Information used to render a map tile image in the proper location on a map.
type MapTile struct {
// ImageUrl: URL to an image file containing an office layout of the user's
// location for their organization, if one is available. For google.com, this
// image is from Corp Campus Maps.
ImageUrl *SafeUrlProto `json:"imageUrl,omitempty"`
// TileX: Map tile x coordinate
TileX float64 `json:"tileX,omitempty"`
// TileY: Map tile y coordinate
TileY float64 `json:"tileY,omitempty"`
// ForceSendFields is a list of field names (e.g. "ImageUrl") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ImageUrl") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MapTile) MarshalJSON() ([]byte, error)
func (s *MapTile) UnmarshalJSON(data []byte) error
MatchRange: Matched range of a snippet [start, end).
type MatchRange struct {
// End: End of the match in the snippet.
End int64 `json:"end,omitempty"`
// Start: Starting position of the match in the snippet.
Start int64 `json:"start,omitempty"`
// ForceSendFields is a list of field names (e.g. "End") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "End") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *MatchRange) MarshalJSON() ([]byte, error)
Media: Media resource.
type Media struct {
// ResourceName: Name of the media resource.
ResourceName string `json:"resourceName,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ResourceName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ResourceName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Media) MarshalJSON() ([]byte, error)
type MediaService struct {
// contains filtered or unexported fields
}
func NewMediaService(s *Service) *MediaService
func (r *MediaService) Upload(resourceName string, media *Media) *MediaUploadCall
Upload: 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 (https://developers.google.com/cloud-search/docs/reference/rest/v1/indexing.datasources.items#itemcontent). To index large content: 1. Call indexing.datasources.items.upload with the item name to begin an upload session and retrieve the UploadItemRef. 1. Call media.upload to upload the content, as a streaming request, using the same resource name from the UploadItemRef from step 1. 1. Call indexing.datasources.items.index to index the item. Populate the ItemContent (/cloud-search/docs/reference/rest/v1/indexing.datasources.items#ItemContent)
with the UploadItemRef from step 1. For additional information, see Create
a content connector using the REST API (https://developers.google.com/cloud-search/docs/guides/content-connector#rest). **Note:** This API requires a service account to execute.
type MediaUploadCall struct {
// contains filtered or unexported fields
}
func (c *MediaUploadCall) Context(ctx context.Context) *MediaUploadCall
Context sets the context to be used in this call's Do method. This context will supersede any context previously provided to the ResumableMedia method.
func (c *MediaUploadCall) Do(opts ...googleapi.CallOption) (*Media, error)
Do executes the "cloudsearch.media.upload" call. Any non-2xx status code is an error. Response headers are in either *Media.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *MediaUploadCall) Fields(s ...googleapi.Field) *MediaUploadCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *MediaUploadCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *MediaUploadCall) Media(r io.Reader, options ...googleapi.MediaOption) *MediaUploadCall
Media specifies the media to upload in one or more chunks. The chunk size may be controlled by supplying a MediaOption generated by googleapi.ChunkSize. The chunk size defaults to googleapi.DefaultUploadChunkSize.The Content-Type header used in the upload request will be determined by sniffing the contents of r, unless a MediaOption generated by googleapi.ContentType is supplied. At most one of Media and ResumableMedia may be set.
func (c *MediaUploadCall) ProgressUpdater(pu googleapi.ProgressUpdater) *MediaUploadCall
ProgressUpdater provides a callback function that will be called after every chunk. It should be a low-latency function in order to not slow down the upload operation. This should only be called when using ResumableMedia (as opposed to Media).
func (c *MediaUploadCall) ResumableMedia(ctx context.Context, r io.ReaderAt, size int64, mediaType string) *MediaUploadCall
ResumableMedia specifies the media to upload in chunks and can be canceled with ctx.
Deprecated: use Media instead.
At most one of Media and ResumableMedia may be set. mediaType identifies the MIME media type of the upload, such as "image/png". If mediaType is "", it will be auto-detected. The provided ctx will supersede any context previously provided to the Context method.
Metadata: Metadata of a matched search result.
type Metadata struct {
// CreateTime: The creation time for this document or object in the search
// result.
CreateTime string `json:"createTime,omitempty"`
// DisplayOptions: Options that specify how to display a structured data search
// result.
DisplayOptions *ResultDisplayMetadata `json:"displayOptions,omitempty"`
// Fields: Indexed fields in structured data, returned as a generic named
// property.
Fields []*NamedProperty `json:"fields,omitempty"`
// MimeType: Mime type of the search result.
MimeType string `json:"mimeType,omitempty"`
// ObjectType: Object type of the search result.
ObjectType string `json:"objectType,omitempty"`
// Owner: Owner (usually creator) of the document or object of the search
// result.
Owner *Person `json:"owner,omitempty"`
// Source: The named source for the result, such as Gmail.
Source *Source `json:"source,omitempty"`
// ThumbnailUrl: The thumbnail URL of the result.
ThumbnailUrl string `json:"thumbnailUrl,omitempty"`
// UpdateTime: The last modified date for the object in the search result. If
// not set in the item, the value returned here is empty. When `updateTime` is
// used for calculating freshness and is not set, this value defaults to 2
// years from the current time.
UpdateTime string `json:"updateTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "CreateTime") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CreateTime") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Metadata) MarshalJSON() ([]byte, error)
Metaline: A metaline is a list of properties that are displayed along with the search result to provide context.
type Metaline struct {
// Properties: The list of displayed properties for the metaline. The maximum
// number of properties is 5.
Properties []*DisplayedProperty `json:"properties,omitempty"`
// ForceSendFields is a list of field names (e.g. "Properties") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Properties") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Metaline) MarshalJSON() ([]byte, error)
Name: A person's name.
type Name struct {
// DisplayName: The read-only display name formatted according to the locale
// specified by the viewer's account or the `Accept-Language` HTTP header.
DisplayName string `json:"displayName,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Name) MarshalJSON() ([]byte, error)
NamedProperty: A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.
type NamedProperty struct {
BooleanValue bool `json:"booleanValue,omitempty"`
DateValues *DateValues `json:"dateValues,omitempty"`
DoubleValues *DoubleValues `json:"doubleValues,omitempty"`
EnumValues *EnumValues `json:"enumValues,omitempty"`
HtmlValues *HtmlValues `json:"htmlValues,omitempty"`
IntegerValues *IntegerValues `json:"integerValues,omitempty"`
// Name: 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 `json:"name,omitempty"`
ObjectValues *ObjectValues `json:"objectValues,omitempty"`
TextValues *TextValues `json:"textValues,omitempty"`
TimestampValues *TimestampValues `json:"timestampValues,omitempty"`
// ForceSendFields is a list of field names (e.g. "BooleanValue") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BooleanValue") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *NamedProperty) MarshalJSON() ([]byte, error)
ObjectDefinition: The definition for an object within a data source.
type ObjectDefinition struct {
// Name: The 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 `json:"name,omitempty"`
// Options: The optional object-specific options.
Options *ObjectOptions `json:"options,omitempty"`
// PropertyDefinitions: The property definitions for the object. The maximum
// number of elements is 1000.
PropertyDefinitions []*PropertyDefinition `json:"propertyDefinitions,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ObjectDefinition) MarshalJSON() ([]byte, error)
ObjectDisplayOptions: The display options for an object.
type ObjectDisplayOptions struct {
// Metalines: Defines the properties that are displayed in the metalines of the
// search results. The property values are displayed in the order given here.
// If a property holds multiple values, all of the values are displayed 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 metalines
// is 3.
Metalines []*Metaline `json:"metalines,omitempty"`
// ObjectDisplayLabel: The user friendly label to display in the search result
// to indicate the type of the item. This is OPTIONAL; if not provided, an
// object label isn't displayed on the context line of the search results. The
// maximum length is 64 characters.
ObjectDisplayLabel string `json:"objectDisplayLabel,omitempty"`
// ForceSendFields is a list of field names (e.g. "Metalines") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Metalines") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ObjectDisplayOptions) MarshalJSON() ([]byte, error)
ObjectOptions: The options for an object.
type ObjectOptions struct {
// DisplayOptions: The options that determine how the object is displayed in
// the Cloud Search results page.
DisplayOptions *ObjectDisplayOptions `json:"displayOptions,omitempty"`
// FreshnessOptions: The freshness options for an object.
FreshnessOptions *FreshnessOptions `json:"freshnessOptions,omitempty"`
// SuggestionFilteringOperators: Operators that can be used to filter
// suggestions. For Suggest API, only operators mentioned here will be honored
// in the FilterOptions. Only TEXT and ENUM operators are supported. NOTE:
// "objecttype", "type" and "mimetype" are already supported. This property is
// to configure schema specific operators. Even though this is an array, only
// one operator can be specified. This is an array for future extensibility.
// Operators mapping to multiple properties within the same object are not
// supported. If the operator spans across different object types, this option
// has to be set once for each object definition.
SuggestionFilteringOperators []string `json:"suggestionFilteringOperators,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ObjectOptions) MarshalJSON() ([]byte, error)
ObjectPropertyOptions: The options for object properties.
type ObjectPropertyOptions struct {
// SubobjectProperties: 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 []*PropertyDefinition `json:"subobjectProperties,omitempty"`
// ForceSendFields is a list of field names (e.g. "SubobjectProperties") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SubobjectProperties") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ObjectPropertyOptions) MarshalJSON() ([]byte, error)
ObjectValues: List of object values.
type ObjectValues struct {
Values []*StructuredDataObject `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ObjectValues) MarshalJSON() ([]byte, error)
Operation: This resource represents a long-running operation that is the result of a network API call.
type Operation struct {
// Done: 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 bool `json:"done,omitempty"`
// Error: The error result of the operation in case of failure or cancellation.
Error *Status `json:"error,omitempty"`
// Metadata: 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 googleapi.RawMessage `json:"metadata,omitempty"`
// Name: 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 be a resource name ending with `operations/{unique_id}`.
Name string `json:"name,omitempty"`
// Response: The normal, successful response of the operation. 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 googleapi.RawMessage `json:"response,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Done") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Done") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Operation) MarshalJSON() ([]byte, error)
type OperationsGetCall struct {
// contains filtered or unexported fields
}
func (c *OperationsGetCall) Context(ctx context.Context) *OperationsGetCall
Context sets the context to be used in this call's Do method.
func (c *OperationsGetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.operations.get" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OperationsGetCall) Fields(s ...googleapi.Field) *OperationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OperationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OperationsGetCall) IfNoneMatch(entityTag string) *OperationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type OperationsLroListCall struct {
// contains filtered or unexported fields
}
func (c *OperationsLroListCall) Context(ctx context.Context) *OperationsLroListCall
Context sets the context to be used in this call's Do method.
func (c *OperationsLroListCall) Do(opts ...googleapi.CallOption) (*ListOperationsResponse, error)
Do executes the "cloudsearch.operations.lro.list" call. Any non-2xx status code is an error. Response headers are in either *ListOperationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *OperationsLroListCall) Fields(s ...googleapi.Field) *OperationsLroListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *OperationsLroListCall) Filter(filter string) *OperationsLroListCall
Filter sets the optional parameter "filter": The standard list filter.
func (c *OperationsLroListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *OperationsLroListCall) IfNoneMatch(entityTag string) *OperationsLroListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *OperationsLroListCall) PageSize(pageSize int64) *OperationsLroListCall
PageSize sets the optional parameter "pageSize": The standard list page size.
func (c *OperationsLroListCall) PageToken(pageToken string) *OperationsLroListCall
PageToken sets the optional parameter "pageToken": The standard list page token.
func (c *OperationsLroListCall) Pages(ctx context.Context, f func(*ListOperationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type OperationsLroService struct {
// contains filtered or unexported fields
}
func NewOperationsLroService(s *Service) *OperationsLroService
func (r *OperationsLroService) List(name string) *OperationsLroListCall
List: Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.
- name: The name of the operation's parent resource.
type OperationsService struct {
Lro *OperationsLroService
// contains filtered or unexported fields
}
func NewOperationsService(s *Service) *OperationsService
func (r *OperationsService) Get(name string) *OperationsGetCall
Get: 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.
- name: The name of the operation resource.
type PeoplePromotionCard struct {
People []*PersonCore `json:"people,omitempty"`
// ForceSendFields is a list of field names (e.g. "People") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "People") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PeoplePromotionCard) MarshalJSON() ([]byte, error)
PeopleSuggestion: This field contains information about the person being suggested.
type PeopleSuggestion struct {
// Person: Suggested person. All fields of the person object might not be
// populated.
Person *Person `json:"person,omitempty"`
// ForceSendFields is a list of field names (e.g. "Person") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Person") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PeopleSuggestion) MarshalJSON() ([]byte, error)
Person: Object to represent a person.
type Person struct {
// EmailAddresses: The person's email addresses
EmailAddresses []*EmailAddress `json:"emailAddresses,omitempty"`
// Name: The resource name of the person to provide information about. See
// `People.get` (https://developers.google.com/people/api/rest/v1/people/get)
// from the Google People API.
Name string `json:"name,omitempty"`
// ObfuscatedId: Obfuscated ID of a person.
ObfuscatedId string `json:"obfuscatedId,omitempty"`
// PersonNames: The person's name
PersonNames []*Name `json:"personNames,omitempty"`
// PhoneNumbers: The person's phone numbers
PhoneNumbers []*PhoneNumber `json:"phoneNumbers,omitempty"`
// Photos: 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 []*Photo `json:"photos,omitempty"`
// ForceSendFields is a list of field names (e.g. "EmailAddresses") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EmailAddresses") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Person) MarshalJSON() ([]byte, error)
PersonCore: Information for rendering a person. NEXT ID: 37
type PersonCore struct {
// AddressMeAs: Instructions for how to address this person (e.g. custom
// pronouns). For google.com this is a set of pronouns from a defined list of
// options.
AddressMeAs string `json:"addressMeAs,omitempty"`
// AdminTo: People the profile owner is an admin to. Note that not all fields
// of these PersonCores will be set, in particular, relationships will be
// empty.
AdminTo []*PersonCore `json:"adminTo,omitempty"`
// Admins: The profile owner's admins in no particular order. Note that not all
// fields of these PersonCores will be set, in particular, relationships will
// be empty.
Admins []*PersonCore `json:"admins,omitempty"`
// Possible values:
// "UNKNOWN"
// "OUT_OF_OFFICE"
// "OUTSIDE_WORKING_HOURS"
// "AVAILABLE"
AvailabilityStatus string `json:"availabilityStatus,omitempty"`
// Birthday: Person birthday.
Birthday *Date `json:"birthday,omitempty"`
// CalendarUrl: The URL to open the profile owner's primary calendar.
CalendarUrl *SafeUrlProto `json:"calendarUrl,omitempty"`
// ChatUrl: The URL to start a chat conversation with the profile owner. For
// google.com this is a Hangouts URL.
ChatUrl *SafeUrlProto `json:"chatUrl,omitempty"`
// CostCenter: Person's cost center as a string, e.g. "926: Googler Apps".
CostCenter string `json:"costCenter,omitempty"`
// Department: The person's Organization department, e.g. "People Operations".
// For google.com this is usually called "area".
Department string `json:"department,omitempty"`
// DirectReports: A subset of the profile owner's direct reports. The number of
// entities here may be less than total_direct_reports_count, because typically
// ProfileResponse does not include all the person's reports, if there are too
// many to retrieve efficiently. Note that not all fields of these PersonCores
// will be set, in particular, relationships will be empty.
DirectReports []*PersonCore `json:"directReports,omitempty"`
// DottedLineManagers: The profile owner's direct dotted line managers in no
// particular order. Note that not all fields of these PersonCores will be set,
// in particular, relationships will be empty.
DottedLineManagers []*PersonCore `json:"dottedLineManagers,omitempty"`
// DottedLineReports: A subset of the profile owner's dotted-line reports. The
// number of entities here may be less than total_dlr_count. Note that not all
// fields of these PersonCores will be set, in particular, relationships will
// be empty.
DottedLineReports []*PersonCore `json:"dottedLineReports,omitempty"`
// Emails: E-mail addresses of the person. The primary or preferred email
// should be first.
Emails []string `json:"emails,omitempty"`
// EmployeeId: Person's employee number (external ID of type "organization")
// For google.com this is the badge number (e.g. 2 for Larry Page).
EmployeeId string `json:"employeeId,omitempty"`
// Fingerprint: A fingerprint used by PAPI to reliably determine if a resource
// has changed Externally it is used as part of the etag.
Fingerprint string `json:"fingerprint,omitempty"`
// FtePermille: Full-time equivalent (in ‰) (e.g. 800 for a person who's
// working 80%).
FtePermille int64 `json:"ftePermille,omitempty,string"`
GeoLocation *MapInfo `json:"geoLocation,omitempty"`
GmailUrl string `json:"gmailUrl,omitempty"`
// JobTitle: Profile owner's job title (e.g. "Software Engineer"). For
// google.com this is the Workday preferred job title.
JobTitle string `json:"jobTitle,omitempty"`
// KeywordTypes: List of keys to use from the map 'keywords'.
KeywordTypes []string `json:"keywordTypes,omitempty"`
// Keywords: Custom keywords the domain admin has added.
Keywords map[string]string `json:"keywords,omitempty"`
// Links: Custom links the profile owner has added.
Links []*EnterpriseTopazFrontendTeamsLink `json:"links,omitempty"`
// Location: Detailed desk location within the company. For google.com this is
// the desk location code (e.g. "DE-MUC-ARP-6T2-6T2C0C") if the person has a
// desk.
Location string `json:"location,omitempty"`
// Managers: The profile owner's management chain from top to bottom, where
// managers[0] is the CEO, manager[N-2] is the person's manager's manager and
// managers[N-1] is the person's direct manager. Note that not all fields of
// these PersonCores will be set, in particular, relationships will be empty.
Managers []*PersonCore `json:"managers,omitempty"`
// Mission: Custom mission statement the profile owner has added.
Mission string `json:"mission,omitempty"`
// Name: Human-readable Unicode display name.
Name string `json:"name,omitempty"`
// OfficeLocation: Office/building identifier within the company. For
// google.com this is the office code (e.g. "DE-MUC-ARP").
OfficeLocation string `json:"officeLocation,omitempty"`
// PersonId: The person's obfuscated Gaia ID.
PersonId string `json:"personId,omitempty"`
PhoneNumbers []*EnterpriseTopazFrontendTeamsPersonCorePhoneNumber `json:"phoneNumbers,omitempty"`
// PhotoUrl: Person photo.
PhotoUrl *SafeUrlProto `json:"photoUrl,omitempty"`
// PostalAddress: Postal address of office/building.
PostalAddress string `json:"postalAddress,omitempty"`
// TotalDirectReportsCount: Total count of the profile owner's direct reports.
TotalDirectReportsCount int64 `json:"totalDirectReportsCount,omitempty"`
// TotalDlrCount: Total count of the profile owner's dotted-line reports.
TotalDlrCount int64 `json:"totalDlrCount,omitempty"`
// TotalFteCount: The sum of all profile owner's reports and their own
// full-time-equivalents in ‰ (e.g. 1800 if one report is working 80% and
// profile owner 100%).
TotalFteCount int64 `json:"totalFteCount,omitempty,string"`
// Username: External ID of type "login_id" for the profile. For google.com
// this is the username/LDAP.
Username string `json:"username,omitempty"`
WaldoComeBackTime string `json:"waldoComeBackTime,omitempty"`
// ForceSendFields is a list of field names (e.g. "AddressMeAs") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "AddressMeAs") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PersonCore) MarshalJSON() ([]byte, error)
PhoneNumber: A person's Phone Number
type PhoneNumber struct {
// PhoneNumber: The phone number of the person.
PhoneNumber string `json:"phoneNumber,omitempty"`
// Possible values:
// "OTHER"
// "MOBILE"
// "OFFICE"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "PhoneNumber") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PhoneNumber") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PhoneNumber) MarshalJSON() ([]byte, error)
Photo: A person's photo.
type Photo struct {
// Url: The URL of the photo.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "Url") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Url") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Photo) MarshalJSON() ([]byte, error)
type PollItemsRequest struct {
// ConnectorName: The name of connector making this call. Format:
// datasources/{source_id}/connectors/{ID}
ConnectorName string `json:"connectorName,omitempty"`
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// Limit: Maximum number of items to return. The maximum value is 100 and the
// default value is 20.
Limit int64 `json:"limit,omitempty"`
// Queue: Queue name to fetch items from. If unspecified, PollItems will fetch
// from 'default' queue. The maximum length is 100 characters.
Queue string `json:"queue,omitempty"`
// StatusCodes: Limit the items polled to the ones with these statuses.
//
// Possible values:
// "CODE_UNSPECIFIED" - Input-only value. Used with Items.list to list all
// items in the queue, regardless of status.
// "ERROR" - Error encountered by Cloud Search while processing this item.
// Details of the error are in repositoryError.
// "MODIFIED" - Item has been modified in the repository, and is out of date
// with the version previously accepted into Cloud Search.
// "NEW_ITEM" - Item is known to exist in the repository, but is not yet
// accepted by Cloud Search. An item can be in this state when Items.push has
// been called for an item of this name that did not exist previously.
// "ACCEPTED" - API has accepted the up-to-date data of this item.
StatusCodes []string `json:"statusCodes,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConnectorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConnectorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PollItemsRequest) MarshalJSON() ([]byte, error)
type PollItemsResponse struct {
// Items: Set of items from the queue available for connector to process. These
// items have the following subset of fields populated: version metadata.hash
// structured_data.hash content.hash payload status queue
Items []*Item `json:"items,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Items") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PollItemsResponse) MarshalJSON() ([]byte, error)
Principal: Reference to a user, group, or domain.
type Principal struct {
// GroupResourceName: 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 `json:"groupResourceName,omitempty"`
// GsuitePrincipal: This principal is a Google Workspace user, group or domain.
GsuitePrincipal *GSuitePrincipal `json:"gsuitePrincipal,omitempty"`
// UserResourceName: 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 `json:"userResourceName,omitempty"`
// ForceSendFields is a list of field names (e.g. "GroupResourceName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "GroupResourceName") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Principal) MarshalJSON() ([]byte, error)
type ProcessingError struct {
// Code: Error code indicating the nature of the error.
//
// Possible values:
// "PROCESSING_ERROR_CODE_UNSPECIFIED" - Input only value. Use this value in
// Items.
// "MALFORMED_REQUEST" - Item's ACL, metadata, or content is malformed or in
// invalid state. FieldViolations contains more details on where the problem
// is.
// "UNSUPPORTED_CONTENT_FORMAT" - Countent format is unsupported.
// "INDIRECT_BROKEN_ACL" - Items with incomplete ACL information due to
// inheriting other items with broken ACL or having groups with unmapped
// descendants.
// "ACL_CYCLE" - ACL inheritance graph formed a cycle.
Code string `json:"code,omitempty"`
// ErrorMessage: The description of the error.
ErrorMessage string `json:"errorMessage,omitempty"`
// FieldViolations: In case the item fields are invalid, this field contains
// the details about the validation errors.
FieldViolations []*FieldViolation `json:"fieldViolations,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ProcessingError) MarshalJSON() ([]byte, error)
PropertyDefinition: The definition of a property within an object.
type PropertyDefinition struct {
BooleanPropertyOptions *BooleanPropertyOptions `json:"booleanPropertyOptions,omitempty"`
DatePropertyOptions *DatePropertyOptions `json:"datePropertyOptions,omitempty"`
// DisplayOptions: The options that determine how the property is displayed in
// the Cloud Search results page if it's specified to be displayed in the
// object's display options.
DisplayOptions *PropertyDisplayOptions `json:"displayOptions,omitempty"`
DoublePropertyOptions *DoublePropertyOptions `json:"doublePropertyOptions,omitempty"`
EnumPropertyOptions *EnumPropertyOptions `json:"enumPropertyOptions,omitempty"`
HtmlPropertyOptions *HtmlPropertyOptions `json:"htmlPropertyOptions,omitempty"`
IntegerPropertyOptions *IntegerPropertyOptions `json:"integerPropertyOptions,omitempty"`
// IsFacetable: 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, integer, and text
// properties.
IsFacetable bool `json:"isFacetable,omitempty"`
// IsRepeatable: 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 cause the indexing
// request for that item to be rejected.
IsRepeatable bool `json:"isRepeatable,omitempty"`
// IsReturnable: 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 bool `json:"isReturnable,omitempty"`
// IsSortable: 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. IsReturnable must be true to set this option. Only supported
// for boolean, date, double, integer, and timestamp properties.
IsSortable bool `json:"isSortable,omitempty"`
// IsSuggestable: Indicates that the property can be used for generating query
// suggestions.
IsSuggestable bool `json:"isSuggestable,omitempty"`
// IsWildcardSearchable: Indicates that users can perform wildcard search for
// this property. Only supported for Text properties. IsReturnable must be true
// to set this option. In a given datasource maximum of 5 properties can be
// marked as is_wildcard_searchable. For more details, see Define object
// properties
// (https://developers.google.com/cloud-search/docs/guides/schema-guide#properties)
IsWildcardSearchable bool `json:"isWildcardSearchable,omitempty"`
// Name: 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 `json:"name,omitempty"`
ObjectPropertyOptions *ObjectPropertyOptions `json:"objectPropertyOptions,omitempty"`
TextPropertyOptions *TextPropertyOptions `json:"textPropertyOptions,omitempty"`
TimestampPropertyOptions *TimestampPropertyOptions `json:"timestampPropertyOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "BooleanPropertyOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BooleanPropertyOptions") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PropertyDefinition) MarshalJSON() ([]byte, error)
PropertyDisplayOptions: The display options for a property.
type PropertyDisplayOptions struct {
// DisplayLabel: The user friendly label for the property that is used if the
// property is specified to be displayed in ObjectDisplayOptions. If provided,
// the display label is 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 sees 'priority : 1' in the
// search results which provides clear context to search users. This is
// OPTIONAL; if not given, only the property values are displayed. The maximum
// length is 64 characters.
DisplayLabel string `json:"displayLabel,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayLabel") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayLabel") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PropertyDisplayOptions) MarshalJSON() ([]byte, error)
PushItem: Represents an item to be pushed to the indexing queue.
type PushItem struct {
// ContentHash: 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 `json:"contentHash,omitempty"`
// MetadataHash: The 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 `json:"metadataHash,omitempty"`
// Payload: 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 `json:"payload,omitempty"`
// Queue: Queue to which this item belongs. The `default` queue is chosen if
// this field is not specified. The maximum length is 512 characters.
Queue string `json:"queue,omitempty"`
// RepositoryError: 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 *RepositoryError `json:"repositoryError,omitempty"`
// StructuredDataHash: 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 `json:"structuredDataHash,omitempty"`
// Type: The type of the push operation that defines the push behavior.
//
// Possible values:
// "UNSPECIFIED" - Default UNSPECIFIED. Specifies that the push operation
// should not modify ItemStatus
// "MODIFIED" - Indicates that the repository document has been modified or
// updated since the previous update call. This changes status to MODIFIED
// state for an existing item. If this is called on a non existing item, the
// status is changed to NEW_ITEM.
// "NOT_MODIFIED" - Item in the repository has not been modified since the
// last update call. This push operation will set status to ACCEPTED state.
// "REPOSITORY_ERROR" - Connector is facing a repository error regarding this
// item. Change status to REPOSITORY_ERROR state. Item is unreserved and
// rescheduled at a future time determined by exponential backoff.
// "REQUEUE" - Call push with REQUEUE only for items that have been reserved.
// This action unreserves the item and resets its available time to the wall
// clock time.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "ContentHash") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ContentHash") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PushItem) MarshalJSON() ([]byte, error)
type PushItemRequest struct {
// ConnectorName: The name of connector making this call. Format:
// datasources/{source_id}/connectors/{ID}
ConnectorName string `json:"connectorName,omitempty"`
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// Item: Item to push onto the queue.
Item *PushItem `json:"item,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConnectorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConnectorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *PushItemRequest) MarshalJSON() ([]byte, error)
QueryActivity: Details about a user's query activity.
type QueryActivity struct {
// Query: User input query to be logged/removed.
Query string `json:"query,omitempty"`
// ForceSendFields is a list of field names (e.g. "Query") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Query") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryActivity) MarshalJSON() ([]byte, error)
type QueryCountByStatus struct {
Count int64 `json:"count,omitempty,string"`
// StatusCode: This represents the http status code.
StatusCode int64 `json:"statusCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "Count") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Count") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryCountByStatus) MarshalJSON() ([]byte, error)
type QueryInterpretation struct {
// Possible values:
// "NONE" - Neither the natural language interpretation, nor a broader
// version of the query is used to fetch the search results.
// "BLEND" - The results from original query are blended with other results.
// The reason for blending these other results with the results from original
// query is populated in the 'Reason' field below.
// "REPLACE" - The results from original query are replaced. The reason for
// replacing the results from original query is populated in the 'Reason' field
// below.
InterpretationType string `json:"interpretationType,omitempty"`
// InterpretedQuery: The interpretation of the query used in search. For
// example, queries with natural language intent like "email from john" will be
// interpreted as "from:john source:mail". This field will not be filled when
// the reason is NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY.
InterpretedQuery string `json:"interpretedQuery,omitempty"`
// Reason: The reason for interpretation of the query. This field will not be
// UNSPECIFIED if the interpretation type is not NONE.
//
// Possible values:
// "UNSPECIFIED"
// "QUERY_HAS_NATURAL_LANGUAGE_INTENT" - Natural language interpretation of
// the query is used to fetch the search results.
// "NOT_ENOUGH_RESULTS_FOUND_FOR_USER_QUERY" - Query and document terms
// similarity is used to selectively broaden the query to retrieve additional
// search results since enough results were not found for the user query.
// Interpreted query will be empty for this case.
Reason string `json:"reason,omitempty"`
// ForceSendFields is a list of field names (e.g. "InterpretationType") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "InterpretationType") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryInterpretation) MarshalJSON() ([]byte, error)
QueryInterpretationConfig: Default options to interpret user query.
type QueryInterpretationConfig struct {
// ForceDisableSupplementalResults: Set this flag to disable supplemental
// results retrieval, setting a flag here will not retrieve supplemental
// results for queries associated with a given search application. If this flag
// is set to True, it will take precedence over the option set at Query level.
// For the default value of False, query level flag will set the correct
// interpretation for supplemental results.
ForceDisableSupplementalResults bool `json:"forceDisableSupplementalResults,omitempty"`
// ForceVerbatimMode: Enable this flag to turn off all internal optimizations
// like natural language (NL) interpretation of queries, supplemental results
// retrieval, and usage of synonyms including custom ones. If this flag is set
// to True, it will take precedence over the option set at Query level. For the
// default value of False, query level flag will set the correct interpretation
// for verbatim mode.
ForceVerbatimMode bool `json:"forceVerbatimMode,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "ForceDisableSupplementalResults") to unconditionally include in API
// requests. By default, fields with empty or default values are omitted from
// API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ForceDisableSupplementalResults")
// to include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryInterpretationConfig) MarshalJSON() ([]byte, error)
QueryInterpretationOptions: Options to interpret user query.
type QueryInterpretationOptions struct {
// DisableNlInterpretation: 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 bool `json:"disableNlInterpretation,omitempty"`
// DisableSupplementalResults: Use this flag to disable supplemental results
// for a query. Supplemental results setting chosen at SearchApplication level
// will take precedence if set to True.
DisableSupplementalResults bool `json:"disableSupplementalResults,omitempty"`
// EnableVerbatimMode: Enable this flag to turn off all internal optimizations
// like natural language (NL) interpretation of queries, supplemental result
// retrieval, and usage of synonyms including custom ones. Nl interpretation
// will be disabled if either one of the two flags is true.
EnableVerbatimMode bool `json:"enableVerbatimMode,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisableNlInterpretation") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisableNlInterpretation") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryInterpretationOptions) MarshalJSON() ([]byte, error)
QueryItem: Information relevant only to a query entry.
type QueryItem struct {
// IsSynthetic: True if the text was generated by means other than a previous
// user search.
IsSynthetic bool `json:"isSynthetic,omitempty"`
// ForceSendFields is a list of field names (e.g. "IsSynthetic") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "IsSynthetic") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryItem) MarshalJSON() ([]byte, error)
QueryOperator: The definition of a operator that can be used in a Search/Suggest request.
type QueryOperator struct {
// DisplayName: Display name of the operator
DisplayName string `json:"displayName,omitempty"`
// EnumValues: 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 `json:"enumValues,omitempty"`
// GreaterThanOperatorName: Indicates the operator name that can be used to
// isolate the property using the greater-than operator.
GreaterThanOperatorName string `json:"greaterThanOperatorName,omitempty"`
// IsFacetable: Can this operator be used to get facets.
IsFacetable bool `json:"isFacetable,omitempty"`
// IsRepeatable: Indicates if multiple values can be set for this property.
IsRepeatable bool `json:"isRepeatable,omitempty"`
// IsReturnable: Will the property associated with this facet be returned as
// part of search results.
IsReturnable bool `json:"isReturnable,omitempty"`
// IsSortable: Can this operator be used to sort results.
IsSortable bool `json:"isSortable,omitempty"`
// IsSuggestable: Can get suggestions for this field.
IsSuggestable bool `json:"isSuggestable,omitempty"`
// LessThanOperatorName: Indicates the operator name that can be used to
// isolate the property using the less-than operator.
LessThanOperatorName string `json:"lessThanOperatorName,omitempty"`
// ObjectType: The name of the object corresponding to the operator. This field
// is only filled for schema-specific operators, and is unset for common
// operators.
ObjectType string `json:"objectType,omitempty"`
// OperatorName: The name of the operator.
OperatorName string `json:"operatorName,omitempty"`
// Type: The type of the operator.
//
// Possible values:
// "UNKNOWN" - Invalid value.
// "INTEGER"
// "DOUBLE"
// "TIMESTAMP"
// "BOOLEAN"
// "ENUM"
// "DATE"
// "TEXT"
// "HTML"
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QueryOperator) MarshalJSON() ([]byte, error)
type QueryRemoveActivityCall struct {
// contains filtered or unexported fields
}
func (c *QueryRemoveActivityCall) Context(ctx context.Context) *QueryRemoveActivityCall
Context sets the context to be used in this call's Do method.
func (c *QueryRemoveActivityCall) Do(opts ...googleapi.CallOption) (*RemoveActivityResponse, error)
Do executes the "cloudsearch.query.removeActivity" call. Any non-2xx status code is an error. Response headers are in either *RemoveActivityResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *QueryRemoveActivityCall) Fields(s ...googleapi.Field) *QueryRemoveActivityCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *QueryRemoveActivityCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type QuerySearchCall struct {
// contains filtered or unexported fields
}
func (c *QuerySearchCall) Context(ctx context.Context) *QuerySearchCall
Context sets the context to be used in this call's Do method.
func (c *QuerySearchCall) Do(opts ...googleapi.CallOption) (*SearchResponse, error)
Do executes the "cloudsearch.query.search" call. Any non-2xx status code is an error. Response headers are in either *SearchResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *QuerySearchCall) Fields(s ...googleapi.Field) *QuerySearchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *QuerySearchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type QueryService struct {
Sources *QuerySourcesService
// contains filtered or unexported fields
}
func NewQueryService(s *Service) *QueryService
func (r *QueryService) RemoveActivity(removeactivityrequest *RemoveActivityRequest) *QueryRemoveActivityCall
RemoveActivity: Provides functionality to remove logged activity for a user. Currently to be used only for Chat 1p clients **Note:** This API requires a standard end user account to execute. A service account can't perform Remove Activity requests directly; to use a service account to perform queries, set up Google Workspace domain-wide delegation of authority (https://developers.google.com/cloud-search/docs/guides/delegation/).
func (r *QueryService) Search(searchrequest *SearchRequest) *QuerySearchCall
Search: The Cloud Search Query API provides the search method, which returns the most relevant results from a user query. The results can come from Google Workspace apps, such as Gmail or Google Drive, or they can come from data that you have indexed from a third party. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up Google Workspace domain-wide delegation of authority (https://developers.google.com/cloud-search/docs/guides/delegation/).
func (r *QueryService) Suggest(suggestrequest *SuggestRequest) *QuerySuggestCall
Suggest: Provides suggestions for autocompleting the query. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up Google Workspace domain-wide delegation of authority (https://developers.google.com/cloud-search/docs/guides/delegation/).
QuerySource: List of sources that the user can search using the query API.
type QuerySource struct {
// DisplayName: Display name of the data source.
DisplayName string `json:"displayName,omitempty"`
// Operators: List of all operators applicable for this source.
Operators []*QueryOperator `json:"operators,omitempty"`
// ShortName: A short name or alias for the source. This value can be used with
// the 'source' operator.
ShortName string `json:"shortName,omitempty"`
// Source: The name of the source
Source *Source `json:"source,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisplayName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisplayName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *QuerySource) MarshalJSON() ([]byte, error)
type QuerySourcesListCall struct {
// contains filtered or unexported fields
}
func (c *QuerySourcesListCall) Context(ctx context.Context) *QuerySourcesListCall
Context sets the context to be used in this call's Do method.
func (c *QuerySourcesListCall) Do(opts ...googleapi.CallOption) (*ListQuerySourcesResponse, error)
Do executes the "cloudsearch.query.sources.list" call. Any non-2xx status code is an error. Response headers are in either *ListQuerySourcesResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *QuerySourcesListCall) Fields(s ...googleapi.Field) *QuerySourcesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *QuerySourcesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *QuerySourcesListCall) IfNoneMatch(entityTag string) *QuerySourcesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *QuerySourcesListCall) PageToken(pageToken string) *QuerySourcesListCall
PageToken sets the optional parameter "pageToken": Number of sources to return in the response.
func (c *QuerySourcesListCall) Pages(ctx context.Context, f func(*ListQuerySourcesResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
func (c *QuerySourcesListCall) RequestOptionsDebugOptionsEnableDebugging(requestOptionsDebugOptionsEnableDebugging bool) *QuerySourcesListCall
RequestOptionsDebugOptionsEnableDebugging sets the optional parameter "requestOptions.debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *QuerySourcesListCall) RequestOptionsLanguageCode(requestOptionsLanguageCode string) *QuerySourcesListCall
RequestOptionsLanguageCode sets the optional parameter "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. Set this field using the language set in browser or for the page. In the event that the user's language preference is known, set this field to the known user language. When specified, the documents in search results are biased towards the specified language. The Suggest API uses this field as a hint to make better third-party autocomplete predictions.
func (c *QuerySourcesListCall) RequestOptionsSearchApplicationId(requestOptionsSearchApplicationId string) *QuerySourcesListCall
RequestOptionsSearchApplicationId sets the optional parameter "requestOptions.searchApplicationId": The ID generated when you create a search application using the admin console (https://support.google.com/a/answer/9043922).
func (c *QuerySourcesListCall) RequestOptionsTimeZone(requestOptionsTimeZone string) *QuerySourcesListCall
RequestOptionsTimeZone sets the optional parameter "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). This field is used to correctly interpret date and time queries. If this field is not specified, the default time zone (UTC) is used.
type QuerySourcesService struct {
// contains filtered or unexported fields
}
func NewQuerySourcesService(s *Service) *QuerySourcesService
func (r *QuerySourcesService) List() *QuerySourcesListCall
List: Returns list of sources that user can use for Search and Suggest APIs. **Note:** This API requires a standard end user account to execute. A service account can't perform Query API requests directly; to use a service account to perform queries, set up Google Workspace domain-wide delegation of authority (https://developers.google.com/cloud-search/docs/guides/delegation/).
type QuerySuggestCall struct {
// contains filtered or unexported fields
}
func (c *QuerySuggestCall) Context(ctx context.Context) *QuerySuggestCall
Context sets the context to be used in this call's Do method.
func (c *QuerySuggestCall) Do(opts ...googleapi.CallOption) (*SuggestResponse, error)
Do executes the "cloudsearch.query.suggest" call. Any non-2xx status code is an error. Response headers are in either *SuggestResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *QuerySuggestCall) Fields(s ...googleapi.Field) *QuerySuggestCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *QuerySuggestCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
QuerySuggestion: This field does not contain anything as of now and is just used as an indicator that the suggest result was a phrase completion.
type QuerySuggestion struct {
}
RemoveActivityRequest: Remove Logged Activity Request.
type RemoveActivityRequest struct {
// RequestOptions: Request options, such as the search application and
// clientId.
RequestOptions *RequestOptions `json:"requestOptions,omitempty"`
// UserActivity: User Activity containing the data to be deleted.
UserActivity *UserActivity `json:"userActivity,omitempty"`
// ForceSendFields is a list of field names (e.g. "RequestOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RequestOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RemoveActivityRequest) MarshalJSON() ([]byte, error)
RemoveActivityResponse: Remove Logged Activity Response. will return an empty response for now. Will be revisited in later phases.
type RemoveActivityResponse struct {
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
}
RepositoryError: Errors when the connector is communicating to the source repository.
type RepositoryError struct {
// ErrorMessage: Message that describes the error. The maximum allowable length
// of the message is 8192 characters.
ErrorMessage string `json:"errorMessage,omitempty"`
// HttpStatusCode: Error codes. Matches the definition of HTTP status codes.
HttpStatusCode int64 `json:"httpStatusCode,omitempty"`
// Type: The type of error.
//
// Possible values:
// "UNKNOWN" - Unknown error.
// "NETWORK_ERROR" - Unknown or unreachable host.
// "DNS_ERROR" - DNS problem, such as the DNS server is not responding.
// "CONNECTION_ERROR" - Cannot connect to the repository server.
// "AUTHENTICATION_ERROR" - Failed authentication due to incorrect
// credentials.
// "AUTHORIZATION_ERROR" - Service account is not authorized for the
// repository.
// "SERVER_ERROR" - Repository server error.
// "QUOTA_EXCEEDED" - Quota exceeded.
// "SERVICE_UNAVAILABLE" - Server temporarily unavailable.
// "CLIENT_ERROR" - Client-related error, such as an invalid request from the
// connector to the repository server.
Type string `json:"type,omitempty"`
// ForceSendFields is a list of field names (e.g. "ErrorMessage") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ErrorMessage") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RepositoryError) MarshalJSON() ([]byte, error)
RequestOptions: Shared request options for all RPC methods.
type RequestOptions struct {
// DebugOptions: Debug options of the request
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// 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. Set this field using the language set in browser or for the
// page. In the event that the user's language preference is known, set this
// field to the known user language. When specified, the documents in search
// results are biased towards the specified language. The Suggest API uses this
// field as a hint to make better third-party autocomplete predictions.
LanguageCode string `json:"languageCode,omitempty"`
// SearchApplicationId: The ID generated when you create a search application
// using the admin console (https://support.google.com/a/answer/9043922).
SearchApplicationId string `json:"searchApplicationId,omitempty"`
// 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). This field
// is used to correctly interpret date and time queries. If this field is not
// specified, the default time zone (UTC) is used.
TimeZone string `json:"timeZone,omitempty"`
// ForceSendFields is a list of field names (e.g. "DebugOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DebugOptions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RequestOptions) MarshalJSON() ([]byte, error)
type ResetSearchApplicationRequest struct {
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "DebugOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DebugOptions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResetSearchApplicationRequest) MarshalJSON() ([]byte, error)
ResponseDebugInfo: Debugging information about the response.
type ResponseDebugInfo struct {
// FormattedDebugInfo: General debug info formatted for display.
FormattedDebugInfo string `json:"formattedDebugInfo,omitempty"`
// ForceSendFields is a list of field names (e.g. "FormattedDebugInfo") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FormattedDebugInfo") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResponseDebugInfo) MarshalJSON() ([]byte, error)
RestrictItem: Information relevant only to a restrict entry. NextId: 12
type RestrictItem struct {
DriveFollowUpRestrict *DriveFollowUpRestrict `json:"driveFollowUpRestrict,omitempty"`
DriveLocationRestrict *DriveLocationRestrict `json:"driveLocationRestrict,omitempty"`
// DriveMimeTypeRestrict: Drive Types.
DriveMimeTypeRestrict *DriveMimeTypeRestrict `json:"driveMimeTypeRestrict,omitempty"`
DriveTimeSpanRestrict *DriveTimeSpanRestrict `json:"driveTimeSpanRestrict,omitempty"`
// SearchOperator: The search restrict (e.g. "after:2017-09-11
// before:2017-09-12").
SearchOperator string `json:"searchOperator,omitempty"`
// ForceSendFields is a list of field names (e.g. "DriveFollowUpRestrict") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DriveFollowUpRestrict") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RestrictItem) MarshalJSON() ([]byte, error)
ResultCounts: Result count information
type ResultCounts struct {
// SourceResultCounts: Result count information for each source with results.
SourceResultCounts []*SourceResultCount `json:"sourceResultCounts,omitempty"`
// ForceSendFields is a list of field names (e.g. "SourceResultCounts") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SourceResultCounts") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResultCounts) MarshalJSON() ([]byte, error)
ResultDebugInfo: Debugging information about the result.
type ResultDebugInfo struct {
// FormattedDebugInfo: General debug info formatted for display.
FormattedDebugInfo string `json:"formattedDebugInfo,omitempty"`
// ForceSendFields is a list of field names (e.g. "FormattedDebugInfo") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "FormattedDebugInfo") to include
// in API requests with the JSON null value. By default, fields with empty
// values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResultDebugInfo) MarshalJSON() ([]byte, error)
ResultDisplayField: Display Fields for Search Results
type ResultDisplayField struct {
// Label: The display label for the property.
Label string `json:"label,omitempty"`
// OperatorName: The operator name of the property.
OperatorName string `json:"operatorName,omitempty"`
// Property: The name value pair for the property.
Property *NamedProperty `json:"property,omitempty"`
// ForceSendFields is a list of field names (e.g. "Label") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Label") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResultDisplayField) MarshalJSON() ([]byte, error)
ResultDisplayLine: The collection of fields that make up a displayed line
type ResultDisplayLine struct {
Fields []*ResultDisplayField `json:"fields,omitempty"`
// ForceSendFields is a list of field names (e.g. "Fields") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Fields") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResultDisplayLine) MarshalJSON() ([]byte, error)
type ResultDisplayMetadata struct {
// Metalines: The metalines content to be displayed with the result.
Metalines []*ResultDisplayLine `json:"metalines,omitempty"`
// ObjectTypeLabel: The display label for the object.
ObjectTypeLabel string `json:"objectTypeLabel,omitempty"`
// ForceSendFields is a list of field names (e.g. "Metalines") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Metalines") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ResultDisplayMetadata) MarshalJSON() ([]byte, error)
type RetrievalImportance struct {
// Importance: Indicates the ranking importance given to property when it is
// matched during retrieval. Once set, the token importance of a property
// cannot be changed.
//
// Possible values:
// "DEFAULT" - Treat the match like a body text match.
// "HIGHEST" - Treat the match like a match against title of the item.
// "HIGH" - Treat the match with higher importance than body text.
// "LOW" - Treat the match with lower importance than body text.
// "NONE" - Do not match against this field during retrieval. The property
// can still be used for operator matching, faceting, and suggest if desired.
Importance string `json:"importance,omitempty"`
// ForceSendFields is a list of field names (e.g. "Importance") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Importance") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RetrievalImportance) MarshalJSON() ([]byte, error)
RewrittenQueries: The rewritten queries returned by Apps Search Query Understanding service.
type RewrittenQueries struct {
RewrittenQueries []*RewrittenQuery `json:"rewrittenQueries,omitempty"`
// SelectedQueryIndex: The index of the selected query in `rewritten_queries`
// that is used by QAPI to call CSSR to get search results. If none of the
// queries were used (i.e. they all give empty search results),
// `selected_query_index` would default to -1.
SelectedQueryIndex int64 `json:"selectedQueryIndex,omitempty"`
// ForceSendFields is a list of field names (e.g. "RewrittenQueries") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RewrittenQueries") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RewrittenQueries) MarshalJSON() ([]byte, error)
type RewrittenQuery struct {
RewrittenQuery string `json:"rewrittenQuery,omitempty"`
Score float64 `json:"score,omitempty"`
// Possible values:
// "SORTBY_UNSUPPORTED"
// "SORTBY_RELEVANCY"
// "SORTBY_LATEST"
// "SORTBY_OLDEST"
// "SORTBY_LARGEST"
// "SORTBY_SMALLEST"
// "SORTBY_MODIFY_LATEST"
// "SORTBY_MODIFY_OLDEST"
// "SORTBY_VIEW_LATEST"
// "SORTBY_VIEW_OLDEST"
// "SORTBY_CREATE_LATEST"
// "SORTBY_CREATE_OLDEST"
SortBy string `json:"sortBy,omitempty"`
// ForceSendFields is a list of field names (e.g. "RewrittenQuery") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "RewrittenQuery") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *RewrittenQuery) MarshalJSON() ([]byte, error)
func (s *RewrittenQuery) UnmarshalJSON(data []byte) error
SafeHtmlProto: IMPORTANT: It is unsafe to accept this message from an untrusted source, since it's trivial for an attacker to forge serialized messages that don't fulfill the type's safety contract -- for example, it could contain attacker controlled script. A system which receives a SafeHtmlProto implicitly trusts the producer of the SafeHtmlProto. So, it's generally safe to return this message in RPC responses, but generally unsafe to accept it in RPC requests.
type SafeHtmlProto struct {
// PrivateDoNotAccessOrElseSafeHtmlWrappedValue: IMPORTANT: Never set or read
// this field, even from tests, it is private. See documentation at the top of
// .proto file for programming language packages with which to create or read
// this message.
PrivateDoNotAccessOrElseSafeHtmlWrappedValue string `json:"privateDoNotAccessOrElseSafeHtmlWrappedValue,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "PrivateDoNotAccessOrElseSafeHtmlWrappedValue") to unconditionally include
// in API requests. By default, fields with empty or default values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g.
// "PrivateDoNotAccessOrElseSafeHtmlWrappedValue") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SafeHtmlProto) MarshalJSON() ([]byte, error)
SafeUrlProto: Message containing a string that is safe to use in URL contexts in DOM APIs and HTML documents, where the URL context does not refer to a resource that loads code.
type SafeUrlProto struct {
// PrivateDoNotAccessOrElseSafeUrlWrappedValue: IMPORTANT: Never set or read
// this field, even from tests, it is private. See documentation at the top of
// .proto file for programming language packages with which to create or read
// this message.
PrivateDoNotAccessOrElseSafeUrlWrappedValue string `json:"privateDoNotAccessOrElseSafeUrlWrappedValue,omitempty"`
// ForceSendFields is a list of field names (e.g.
// "PrivateDoNotAccessOrElseSafeUrlWrappedValue") to unconditionally include in
// API requests. By default, fields with empty or default values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g.
// "PrivateDoNotAccessOrElseSafeUrlWrappedValue") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SafeUrlProto) MarshalJSON() ([]byte, error)
Schema: The schema definition for a data source.
type Schema struct {
// ObjectDefinitions: The list of top-level objects for the data source. The
// maximum number of elements is 10.
ObjectDefinitions []*ObjectDefinition `json:"objectDefinitions,omitempty"`
// OperationIds: IDs of the Long Running Operations (LROs) currently running
// for this schema. After modifying the schema, wait for operations to complete
// before indexing additional content.
OperationIds []string `json:"operationIds,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "ObjectDefinitions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ObjectDefinitions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Schema) MarshalJSON() ([]byte, error)
ScoringConfig: Scoring configurations for a source while processing a Search or Suggest request.
type ScoringConfig struct {
// DisableFreshness: Whether to use freshness as a ranking signal. By default,
// freshness is used as a ranking signal. Note that this setting is not
// available in the Admin UI.
DisableFreshness bool `json:"disableFreshness,omitempty"`
// DisablePersonalization: Whether to personalize the results. By default,
// personal signals will be used to boost results.
DisablePersonalization bool `json:"disablePersonalization,omitempty"`
// ForceSendFields is a list of field names (e.g. "DisableFreshness") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DisableFreshness") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ScoringConfig) MarshalJSON() ([]byte, error)
SearchApplication: SearchApplication
type SearchApplication struct {
// DataSourceRestrictions: Retrictions applied to the configurations. The
// maximum number of elements is 10.
DataSourceRestrictions []*DataSourceRestriction `json:"dataSourceRestrictions,omitempty"`
// DefaultFacetOptions: The default fields for returning facet results. The
// sources specified here also have been included in data_source_restrictions
// above.
DefaultFacetOptions []*FacetOptions `json:"defaultFacetOptions,omitempty"`
// DefaultSortOptions: The default options for sorting the search results
DefaultSortOptions *SortOptions `json:"defaultSortOptions,omitempty"`
// DisplayName: Display name of the Search Application. The maximum length is
// 300 characters.
DisplayName string `json:"displayName,omitempty"`
// EnableAuditLog: Indicates whether audit logging is on/off for requests made
// for the search application in query APIs.
EnableAuditLog bool `json:"enableAuditLog,omitempty"`
// Name: The name of the Search Application. Format:
// searchapplications/{application_id}.
Name string `json:"name,omitempty"`
// OperationIds: Output only. IDs of the Long Running Operations (LROs)
// currently running for this schema. Output only field.
OperationIds []string `json:"operationIds,omitempty"`
// QueryInterpretationConfig: The default options for query interpretation
QueryInterpretationConfig *QueryInterpretationConfig `json:"queryInterpretationConfig,omitempty"`
// ReturnResultThumbnailUrls: With each result we should return the URI for its
// thumbnail (when applicable)
ReturnResultThumbnailUrls bool `json:"returnResultThumbnailUrls,omitempty"`
// ScoringConfig: Configuration for ranking results.
ScoringConfig *ScoringConfig `json:"scoringConfig,omitempty"`
// SourceConfig: Configuration for a sources specified in
// data_source_restrictions.
SourceConfig []*SourceConfig `json:"sourceConfig,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DataSourceRestrictions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataSourceRestrictions") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchApplication) MarshalJSON() ([]byte, error)
SearchApplicationQueryStats: Search application level query stats per date
type SearchApplicationQueryStats struct {
// Date: The date for which query stats were calculated. Stats calculated on
// the next day close to midnight are returned.
Date *Date `json:"date,omitempty"`
QueryCountByStatus []*QueryCountByStatus `json:"queryCountByStatus,omitempty"`
// ForceSendFields is a list of field names (e.g. "Date") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Date") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchApplicationQueryStats) MarshalJSON() ([]byte, error)
type SearchApplicationSessionStats struct {
// Date: The date for which session stats were calculated. Stats are calculated
// on the following day, close to midnight PST, and then returned.
Date *Date `json:"date,omitempty"`
// SearchSessionsCount: The count of search sessions on the day
SearchSessionsCount int64 `json:"searchSessionsCount,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Date") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Date") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchApplicationSessionStats) MarshalJSON() ([]byte, error)
type SearchApplicationUserStats struct {
// Date: The date for which session stats were calculated. Stats calculated on
// the next day close to midnight are returned.
Date *Date `json:"date,omitempty"`
// OneDayActiveUsersCount: The count of unique active users in the past one day
OneDayActiveUsersCount int64 `json:"oneDayActiveUsersCount,omitempty,string"`
// SevenDaysActiveUsersCount: The count of unique active users in the past
// seven days
SevenDaysActiveUsersCount int64 `json:"sevenDaysActiveUsersCount,omitempty,string"`
// ThirtyDaysActiveUsersCount: The count of unique active users in the past
// thirty days
ThirtyDaysActiveUsersCount int64 `json:"thirtyDaysActiveUsersCount,omitempty,string"`
// ForceSendFields is a list of field names (e.g. "Date") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Date") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchApplicationUserStats) MarshalJSON() ([]byte, error)
type SearchItemsByViewUrlRequest struct {
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// PageToken: The next_page_token value returned from a previous request, if
// any.
PageToken string `json:"pageToken,omitempty"`
// ViewUrl: Specify the full view URL to find the corresponding item. The
// maximum length is 2048 characters.
ViewUrl string `json:"viewUrl,omitempty"`
// ForceSendFields is a list of field names (e.g. "DebugOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DebugOptions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchItemsByViewUrlRequest) MarshalJSON() ([]byte, error)
type SearchItemsByViewUrlResponse struct {
Items []*Item `json:"items,omitempty"`
// NextPageToken: Token to retrieve the next page of results, or empty if there
// are no more results in the list.
NextPageToken string `json:"nextPageToken,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Items") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Items") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchItemsByViewUrlResponse) MarshalJSON() ([]byte, error)
SearchQualityMetadata: Additional search quality metadata of the item.
type SearchQualityMetadata struct {
// Quality: 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). The default value is 0.0.
Quality float64 `json:"quality,omitempty"`
// ForceSendFields is a list of field names (e.g. "Quality") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Quality") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchQualityMetadata) MarshalJSON() ([]byte, error)
func (s *SearchQualityMetadata) UnmarshalJSON(data []byte) error
SearchRequest: The search API request.
type SearchRequest struct {
// ContextAttributes: Context attributes for the request which will be used to
// adjust ranking of search results. The maximum number of elements is 10.
ContextAttributes []*ContextAttribute `json:"contextAttributes,omitempty"`
// DataSourceRestrictions: The sources to use for querying. If not specified,
// all data sources from the current search application are used.
DataSourceRestrictions []*DataSourceRestriction `json:"dataSourceRestrictions,omitempty"`
FacetOptions []*FacetOptions `json:"facetOptions,omitempty"`
// PageSize: Maximum number of search results to return in one page. Valid
// values are between 1 and 100, inclusive. Default value is 10. Minimum value
// is 50 when results beyond 2000 are requested.
PageSize int64 `json:"pageSize,omitempty"`
// Query: The raw query string. See supported search operators in the Narrow
// your search with operators
// (https://support.google.com/cloudsearch/answer/6172299)
Query string `json:"query,omitempty"`
// QueryInterpretationOptions: Options to interpret the user query.
QueryInterpretationOptions *QueryInterpretationOptions `json:"queryInterpretationOptions,omitempty"`
// RequestOptions: Request options, such as the search application and user
// timezone.
RequestOptions *RequestOptions `json:"requestOptions,omitempty"`
// SortOptions: The options for sorting the search results
SortOptions *SortOptions `json:"sortOptions,omitempty"`
// Start: Starting index of the results.
Start int64 `json:"start,omitempty"`
// ForceSendFields is a list of field names (e.g. "ContextAttributes") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ContextAttributes") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchRequest) MarshalJSON() ([]byte, error)
SearchResponse: The search API response.
type SearchResponse struct {
// DebugInfo: Debugging information about the response.
DebugInfo *ResponseDebugInfo `json:"debugInfo,omitempty"`
// ErrorInfo: Error information about the response.
ErrorInfo *ErrorInfo `json:"errorInfo,omitempty"`
// FacetResults: Repeated facet results.
FacetResults []*FacetResult `json:"facetResults,omitempty"`
// HasMoreResults: Whether there are more search results matching the query.
HasMoreResults bool `json:"hasMoreResults,omitempty"`
// QueryInterpretation: Query interpretation result for user query. Empty if
// query interpretation is disabled.
QueryInterpretation *QueryInterpretation `json:"queryInterpretation,omitempty"`
// ResultCountEstimate: The estimated result count for this query.
ResultCountEstimate int64 `json:"resultCountEstimate,omitempty,string"`
// ResultCountExact: The exact result count for this query.
ResultCountExact int64 `json:"resultCountExact,omitempty,string"`
// ResultCounts: Expanded result count information.
ResultCounts *ResultCounts `json:"resultCounts,omitempty"`
// Results: Results from a search query.
Results []*SearchResult `json:"results,omitempty"`
// SpellResults: Suggested spelling for the query.
SpellResults []*SpellResult `json:"spellResults,omitempty"`
// StructuredResults: Structured results for the user query. These results are
// not counted against the page_size.
StructuredResults []*StructuredResult `json:"structuredResults,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "DebugInfo") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DebugInfo") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchResponse) MarshalJSON() ([]byte, error)
SearchResult: Results containing indexed information for a document.
type SearchResult struct {
// ClusteredResults: 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 []*SearchResult `json:"clusteredResults,omitempty"`
// DebugInfo: Debugging information about this search result.
DebugInfo *ResultDebugInfo `json:"debugInfo,omitempty"`
// Metadata: Metadata of the search result.
Metadata *Metadata `json:"metadata,omitempty"`
// Snippet: The concatenation of all snippets (summaries) available for this
// result.
Snippet *Snippet `json:"snippet,omitempty"`
// Title: Title of the search result.
Title string `json:"title,omitempty"`
// Url: The URL of the search result. The URL contains a Google redirect to the
// actual item. This URL is signed and shouldn't be changed.
Url string `json:"url,omitempty"`
// ForceSendFields is a list of field names (e.g. "ClusteredResults") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ClusteredResults") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SearchResult) MarshalJSON() ([]byte, error)
type Service struct {
BasePath string // API endpoint base URL
UserAgent string // optional additional User-Agent fragment
Debug *DebugService
Indexing *IndexingService
Media *MediaService
Operations *OperationsService
Query *QueryService
Settings *SettingsService
Stats *StatsService
V1 *V1Service
// contains filtered or unexported fields
}
func New(client *http.Client) (*Service, error)
New creates a new Service. It uses the provided http.Client for requests.
Deprecated: please use NewService instead. To provide a custom HTTP client, use option.WithHTTPClient. If you are using google.golang.org/api/googleapis/transport.APIKey, use option.WithAPIKey with NewService instead.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error)
NewService creates a new Service.
type SettingsDatasourcesCreateCall struct {
// contains filtered or unexported fields
}
func (c *SettingsDatasourcesCreateCall) Context(ctx context.Context) *SettingsDatasourcesCreateCall
Context sets the context to be used in this call's Do method.
func (c *SettingsDatasourcesCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.datasources.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsDatasourcesCreateCall) Fields(s ...googleapi.Field) *SettingsDatasourcesCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsDatasourcesCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SettingsDatasourcesDeleteCall struct {
// contains filtered or unexported fields
}
func (c *SettingsDatasourcesDeleteCall) Context(ctx context.Context) *SettingsDatasourcesDeleteCall
Context sets the context to be used in this call's Do method.
func (c *SettingsDatasourcesDeleteCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *SettingsDatasourcesDeleteCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *SettingsDatasourcesDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.datasources.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsDatasourcesDeleteCall) Fields(s ...googleapi.Field) *SettingsDatasourcesDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsDatasourcesDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SettingsDatasourcesGetCall struct {
// contains filtered or unexported fields
}
func (c *SettingsDatasourcesGetCall) Context(ctx context.Context) *SettingsDatasourcesGetCall
Context sets the context to be used in this call's Do method.
func (c *SettingsDatasourcesGetCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *SettingsDatasourcesGetCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *SettingsDatasourcesGetCall) Do(opts ...googleapi.CallOption) (*DataSource, error)
Do executes the "cloudsearch.settings.datasources.get" call. Any non-2xx status code is an error. Response headers are in either *DataSource.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsDatasourcesGetCall) Fields(s ...googleapi.Field) *SettingsDatasourcesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsDatasourcesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsDatasourcesGetCall) IfNoneMatch(entityTag string) *SettingsDatasourcesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SettingsDatasourcesListCall struct {
// contains filtered or unexported fields
}
func (c *SettingsDatasourcesListCall) Context(ctx context.Context) *SettingsDatasourcesListCall
Context sets the context to be used in this call's Do method.
func (c *SettingsDatasourcesListCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *SettingsDatasourcesListCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *SettingsDatasourcesListCall) Do(opts ...googleapi.CallOption) (*ListDataSourceResponse, error)
Do executes the "cloudsearch.settings.datasources.list" call. Any non-2xx status code is an error. Response headers are in either *ListDataSourceResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsDatasourcesListCall) Fields(s ...googleapi.Field) *SettingsDatasourcesListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsDatasourcesListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsDatasourcesListCall) IfNoneMatch(entityTag string) *SettingsDatasourcesListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *SettingsDatasourcesListCall) PageSize(pageSize int64) *SettingsDatasourcesListCall
PageSize sets the optional parameter "pageSize": Maximum number of datasources to fetch in a request. The max value is 1000. The default value is 1000.
func (c *SettingsDatasourcesListCall) PageToken(pageToken string) *SettingsDatasourcesListCall
PageToken sets the optional parameter "pageToken": Starting index of the results.
func (c *SettingsDatasourcesListCall) Pages(ctx context.Context, f func(*ListDataSourceResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type SettingsDatasourcesPatchCall struct {
// contains filtered or unexported fields
}
func (c *SettingsDatasourcesPatchCall) Context(ctx context.Context) *SettingsDatasourcesPatchCall
Context sets the context to be used in this call's Do method.
func (c *SettingsDatasourcesPatchCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *SettingsDatasourcesPatchCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *SettingsDatasourcesPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.datasources.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsDatasourcesPatchCall) Fields(s ...googleapi.Field) *SettingsDatasourcesPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsDatasourcesPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsDatasourcesPatchCall) UpdateMask(updateMask string) *SettingsDatasourcesPatchCall
UpdateMask sets the optional parameter "updateMask": Only applies to `settings.datasources.patch` (https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch). Update mask to control which fields to update. Example field paths: `name`, `displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the source, that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.
type SettingsDatasourcesService struct {
// contains filtered or unexported fields
}
func NewSettingsDatasourcesService(s *Service) *SettingsDatasourcesService
func (r *SettingsDatasourcesService) Create(datasource *DataSource) *SettingsDatasourcesCreateCall
Create: Creates a datasource. **Note:** This API requires an admin account to execute.
func (r *SettingsDatasourcesService) Delete(name string) *SettingsDatasourcesDeleteCall
Delete: Deletes a datasource. **Note:** This API requires an admin account to execute.
- name: The name of the datasource. Format: datasources/{source_id}.
func (r *SettingsDatasourcesService) Get(name string) *SettingsDatasourcesGetCall
Get: Gets a datasource. **Note:** This API requires an admin account to execute.
func (r *SettingsDatasourcesService) List() *SettingsDatasourcesListCall
List: Lists datasources. **Note:** This API requires an admin account to execute.
func (r *SettingsDatasourcesService) Patch(name string, datasource *DataSource) *SettingsDatasourcesPatchCall
Patch: Updates a datasource. **Note:** This API requires an admin account to execute.
func (r *SettingsDatasourcesService) Update(name string, updatedatasourcerequest *UpdateDataSourceRequest) *SettingsDatasourcesUpdateCall
Update: Updates a datasource. **Note:** This API requires an admin account to execute.
type SettingsDatasourcesUpdateCall struct {
// contains filtered or unexported fields
}
func (c *SettingsDatasourcesUpdateCall) Context(ctx context.Context) *SettingsDatasourcesUpdateCall
Context sets the context to be used in this call's Do method.
func (c *SettingsDatasourcesUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.datasources.update" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsDatasourcesUpdateCall) Fields(s ...googleapi.Field) *SettingsDatasourcesUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsDatasourcesUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SettingsGetCustomerCall struct {
// contains filtered or unexported fields
}
func (c *SettingsGetCustomerCall) Context(ctx context.Context) *SettingsGetCustomerCall
Context sets the context to be used in this call's Do method.
func (c *SettingsGetCustomerCall) Do(opts ...googleapi.CallOption) (*CustomerSettings, error)
Do executes the "cloudsearch.settings.getCustomer" call. Any non-2xx status code is an error. Response headers are in either *CustomerSettings.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsGetCustomerCall) Fields(s ...googleapi.Field) *SettingsGetCustomerCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsGetCustomerCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsGetCustomerCall) IfNoneMatch(entityTag string) *SettingsGetCustomerCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SettingsSearchapplicationsCreateCall struct {
// contains filtered or unexported fields
}
func (c *SettingsSearchapplicationsCreateCall) Context(ctx context.Context) *SettingsSearchapplicationsCreateCall
Context sets the context to be used in this call's Do method.
func (c *SettingsSearchapplicationsCreateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.searchapplications.create" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsSearchapplicationsCreateCall) Fields(s ...googleapi.Field) *SettingsSearchapplicationsCreateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsSearchapplicationsCreateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SettingsSearchapplicationsDeleteCall struct {
// contains filtered or unexported fields
}
func (c *SettingsSearchapplicationsDeleteCall) Context(ctx context.Context) *SettingsSearchapplicationsDeleteCall
Context sets the context to be used in this call's Do method.
func (c *SettingsSearchapplicationsDeleteCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *SettingsSearchapplicationsDeleteCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *SettingsSearchapplicationsDeleteCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.searchapplications.delete" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsSearchapplicationsDeleteCall) Fields(s ...googleapi.Field) *SettingsSearchapplicationsDeleteCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsSearchapplicationsDeleteCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SettingsSearchapplicationsGetCall struct {
// contains filtered or unexported fields
}
func (c *SettingsSearchapplicationsGetCall) Context(ctx context.Context) *SettingsSearchapplicationsGetCall
Context sets the context to be used in this call's Do method.
func (c *SettingsSearchapplicationsGetCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *SettingsSearchapplicationsGetCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *SettingsSearchapplicationsGetCall) Do(opts ...googleapi.CallOption) (*SearchApplication, error)
Do executes the "cloudsearch.settings.searchapplications.get" call. Any non-2xx status code is an error. Response headers are in either *SearchApplication.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsSearchapplicationsGetCall) Fields(s ...googleapi.Field) *SettingsSearchapplicationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsSearchapplicationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsSearchapplicationsGetCall) IfNoneMatch(entityTag string) *SettingsSearchapplicationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
type SettingsSearchapplicationsListCall struct {
// contains filtered or unexported fields
}
func (c *SettingsSearchapplicationsListCall) Context(ctx context.Context) *SettingsSearchapplicationsListCall
Context sets the context to be used in this call's Do method.
func (c *SettingsSearchapplicationsListCall) DebugOptionsEnableDebugging(debugOptionsEnableDebugging bool) *SettingsSearchapplicationsListCall
DebugOptionsEnableDebugging sets the optional parameter "debugOptions.enableDebugging": If you are asked by Google to help with debugging, set this field. Otherwise, ignore this field.
func (c *SettingsSearchapplicationsListCall) Do(opts ...googleapi.CallOption) (*ListSearchApplicationsResponse, error)
Do executes the "cloudsearch.settings.searchapplications.list" call. Any non-2xx status code is an error. Response headers are in either *ListSearchApplicationsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsSearchapplicationsListCall) Fields(s ...googleapi.Field) *SettingsSearchapplicationsListCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsSearchapplicationsListCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsSearchapplicationsListCall) IfNoneMatch(entityTag string) *SettingsSearchapplicationsListCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *SettingsSearchapplicationsListCall) PageSize(pageSize int64) *SettingsSearchapplicationsListCall
PageSize sets the optional parameter "pageSize": The maximum number of items to return.
func (c *SettingsSearchapplicationsListCall) PageToken(pageToken string) *SettingsSearchapplicationsListCall
PageToken sets the optional parameter "pageToken": The next_page_token value returned from a previous List request, if any. The default value is 10
func (c *SettingsSearchapplicationsListCall) Pages(ctx context.Context, f func(*ListSearchApplicationsResponse) error) error
Pages invokes f for each page of results. A non-nil error returned from f will halt the iteration. The provided context supersedes any context provided to the Context method.
type SettingsSearchapplicationsPatchCall struct {
// contains filtered or unexported fields
}
func (c *SettingsSearchapplicationsPatchCall) Context(ctx context.Context) *SettingsSearchapplicationsPatchCall
Context sets the context to be used in this call's Do method.
func (c *SettingsSearchapplicationsPatchCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.searchapplications.patch" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsSearchapplicationsPatchCall) Fields(s ...googleapi.Field) *SettingsSearchapplicationsPatchCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsSearchapplicationsPatchCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsSearchapplicationsPatchCall) UpdateMask(updateMask string) *SettingsSearchapplicationsPatchCall
UpdateMask sets the optional parameter "updateMask": Only applies to `settings.searchapplications.patch` (https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.
type SettingsSearchapplicationsResetCall struct {
// contains filtered or unexported fields
}
func (c *SettingsSearchapplicationsResetCall) Context(ctx context.Context) *SettingsSearchapplicationsResetCall
Context sets the context to be used in this call's Do method.
func (c *SettingsSearchapplicationsResetCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.searchapplications.reset" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsSearchapplicationsResetCall) Fields(s ...googleapi.Field) *SettingsSearchapplicationsResetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsSearchapplicationsResetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type SettingsSearchapplicationsService struct {
// contains filtered or unexported fields
}
func NewSettingsSearchapplicationsService(s *Service) *SettingsSearchapplicationsService
func (r *SettingsSearchapplicationsService) Create(searchapplication *SearchApplication) *SettingsSearchapplicationsCreateCall
Create: Creates a search application. **Note:** This API requires an admin account to execute.
func (r *SettingsSearchapplicationsService) Delete(name string) *SettingsSearchapplicationsDeleteCall
Delete: Deletes a search application. **Note:** This API requires an admin account to execute.
func (r *SettingsSearchapplicationsService) Get(name string) *SettingsSearchapplicationsGetCall
Get: Gets the specified search application. **Note:** This API requires an admin account to execute.
func (r *SettingsSearchapplicationsService) List() *SettingsSearchapplicationsListCall
List: Lists all search applications. **Note:** This API requires an admin account to execute.
func (r *SettingsSearchapplicationsService) Patch(name string, searchapplication *SearchApplication) *SettingsSearchapplicationsPatchCall
Patch: Updates a search application. **Note:** This API requires an admin account to execute.
func (r *SettingsSearchapplicationsService) Reset(name string, resetsearchapplicationrequest *ResetSearchApplicationRequest) *SettingsSearchapplicationsResetCall
Reset: Resets a search application to default settings. This will return an empty response. **Note:** This API requires an admin account to execute.
func (r *SettingsSearchapplicationsService) Update(name string, searchapplication *SearchApplication) *SettingsSearchapplicationsUpdateCall
Update: Updates a search application. **Note:** This API requires an admin account to execute.
type SettingsSearchapplicationsUpdateCall struct {
// contains filtered or unexported fields
}
func (c *SettingsSearchapplicationsUpdateCall) Context(ctx context.Context) *SettingsSearchapplicationsUpdateCall
Context sets the context to be used in this call's Do method.
func (c *SettingsSearchapplicationsUpdateCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.searchapplications.update" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsSearchapplicationsUpdateCall) Fields(s ...googleapi.Field) *SettingsSearchapplicationsUpdateCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsSearchapplicationsUpdateCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsSearchapplicationsUpdateCall) UpdateMask(updateMask string) *SettingsSearchapplicationsUpdateCall
UpdateMask sets the optional parameter "updateMask": Only applies to `settings.searchapplications.patch` (https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.searchapplications/patch). Update mask to control which fields to update. Example field paths: `search_application.name`, `search_application.displayName`. * If `update_mask` is non-empty, then only the fields specified in the `update_mask` are updated. * If you specify a field in the `update_mask`, but don't specify its value in the `search_application`, then that field is cleared. * If the `update_mask` is not present or empty or has the value `*`, then all fields are updated.
type SettingsService struct {
Datasources *SettingsDatasourcesService
Searchapplications *SettingsSearchapplicationsService
// contains filtered or unexported fields
}
func NewSettingsService(s *Service) *SettingsService
func (r *SettingsService) GetCustomer() *SettingsGetCustomerCall
GetCustomer: Get customer settings. **Note:** This API requires an admin account to execute.
func (r *SettingsService) UpdateCustomer(customersettings *CustomerSettings) *SettingsUpdateCustomerCall
UpdateCustomer: Update customer settings. **Note:** This API requires an admin account to execute.
type SettingsUpdateCustomerCall struct {
// contains filtered or unexported fields
}
func (c *SettingsUpdateCustomerCall) Context(ctx context.Context) *SettingsUpdateCustomerCall
Context sets the context to be used in this call's Do method.
func (c *SettingsUpdateCustomerCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.settings.updateCustomer" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *SettingsUpdateCustomerCall) Fields(s ...googleapi.Field) *SettingsUpdateCustomerCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *SettingsUpdateCustomerCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *SettingsUpdateCustomerCall) UpdateMask(updateMask string) *SettingsUpdateCustomerCall
UpdateMask sets the optional parameter "updateMask": Update mask to control which fields get updated. If you specify a field in the update_mask but don't specify its value here, that field will be cleared. If the mask is not present or empty, all fields will be updated. Currently supported field paths: vpc_settings and audit_logging_settings
Snippet: Snippet of the search result, which summarizes the content of the resulting page.
type Snippet struct {
// MatchRanges: The matched ranges in the snippet.
MatchRanges []*MatchRange `json:"matchRanges,omitempty"`
// Snippet: The snippet of the document. May contain escaped HTML character
// that should be unescaped prior to rendering.
Snippet string `json:"snippet,omitempty"`
// ForceSendFields is a list of field names (e.g. "MatchRanges") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MatchRanges") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Snippet) MarshalJSON() ([]byte, error)
type SortOptions struct {
// OperatorName: The name of the operator corresponding to the field to sort
// on. The corresponding property must be marked as sortable.
OperatorName string `json:"operatorName,omitempty"`
// SortOrder: Ascending is the default sort order
//
// Possible values:
// "ASCENDING"
// "DESCENDING"
SortOrder string `json:"sortOrder,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SortOptions) MarshalJSON() ([]byte, error)
Source: Defines sources for the suggest/search APIs.
type Source struct {
// Name: Source name for content indexed by the Indexing API.
Name string `json:"name,omitempty"`
// PredefinedSource: Predefined content source for Google Apps.
//
// Possible values:
// "NONE"
// "QUERY_HISTORY" - Suggests queries issued by the user in the past. Only
// valid when used with the suggest API. Ignored when used in the query API.
// "PERSON" - Suggests people in the organization. Only valid when used with
// the suggest API. Results in an error when used in the query API.
// "GOOGLE_DRIVE"
// "GOOGLE_GMAIL"
// "GOOGLE_SITES"
// "GOOGLE_GROUPS"
// "GOOGLE_CALENDAR"
// "GOOGLE_KEEP"
PredefinedSource string `json:"predefinedSource,omitempty"`
// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Source) MarshalJSON() ([]byte, error)
SourceConfig: Configurations for a source while processing a Search or Suggest request.
type SourceConfig struct {
// CrowdingConfig: The crowding configuration for the source.
CrowdingConfig *SourceCrowdingConfig `json:"crowdingConfig,omitempty"`
// ScoringConfig: The scoring configuration for the source.
ScoringConfig *SourceScoringConfig `json:"scoringConfig,omitempty"`
// Source: The source for which this configuration is to be used.
Source *Source `json:"source,omitempty"`
// ForceSendFields is a list of field names (e.g. "CrowdingConfig") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CrowdingConfig") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SourceConfig) MarshalJSON() ([]byte, error)
SourceCrowdingConfig: Set search results crowding limits. Crowding is a situation in which multiple results from the same source or host "crowd out" other results, diminishing the quality of search for users. To foster better search quality and source diversity in search results, you can set a condition to reduce repetitive results by source.
type SourceCrowdingConfig struct {
// NumResults: Maximum number of results allowed from a datasource in a result
// page as long as results from other sources are not exhausted. Value
// specified must not be negative. A default value is used if this value is
// equal to 0. To disable crowding, set the value greater than 100.
NumResults int64 `json:"numResults,omitempty"`
// NumSuggestions: 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 int64 `json:"numSuggestions,omitempty"`
// ForceSendFields is a list of field names (e.g. "NumResults") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NumResults") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SourceCrowdingConfig) MarshalJSON() ([]byte, error)
SourceResultCount: Per source result count information.
type SourceResultCount struct {
// HasMoreResults: Whether there are more search results for this source.
HasMoreResults bool `json:"hasMoreResults,omitempty"`
// ResultCountEstimate: The estimated result count for this source.
ResultCountEstimate int64 `json:"resultCountEstimate,omitempty,string"`
// ResultCountExact: The exact result count for this source.
ResultCountExact int64 `json:"resultCountExact,omitempty,string"`
// Source: The source the result count information is associated with.
Source *Source `json:"source,omitempty"`
// ForceSendFields is a list of field names (e.g. "HasMoreResults") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "HasMoreResults") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SourceResultCount) MarshalJSON() ([]byte, error)
SourceScoringConfig: Set the scoring configuration. This allows modifying the ranking of results for a source.
type SourceScoringConfig struct {
// SourceImportance: Importance of the source.
//
// Possible values:
// "DEFAULT"
// "LOW"
// "HIGH"
SourceImportance string `json:"sourceImportance,omitempty"`
// ForceSendFields is a list of field names (e.g. "SourceImportance") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SourceImportance") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SourceScoringConfig) MarshalJSON() ([]byte, error)
type SpellResult struct {
// SuggestedQuery: The suggested spelling of the query.
SuggestedQuery string `json:"suggestedQuery,omitempty"`
// SuggestedQueryHtml: The sanitized HTML representing the spell corrected
// query that can be used in the UI. This usually has language-specific tags to
// mark up parts of the query that are spell checked.
SuggestedQueryHtml *SafeHtmlProto `json:"suggestedQueryHtml,omitempty"`
// SuggestionType: Suggestion triggered for the current query.
//
// Possible values:
// "SUGGESTION_TYPE_UNSPECIFIED" - Default spell check type
// "NON_EMPTY_RESULTS_SPELL_SUGGESTION" - Spell suggestion without any
// results changed. The results are still shown for the original query (which
// has non zero / results) with a suggestion for spelling that would have
// results.
// "ZERO_RESULTS_FULL_PAGE_REPLACEMENT" - Spell suggestion triggered when
// original query has no results. When the original query has no results, and
// spell suggestion has results we trigger results for the spell corrected
// query.
SuggestionType string `json:"suggestionType,omitempty"`
// ForceSendFields is a list of field names (e.g. "SuggestedQuery") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SuggestedQuery") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SpellResult) MarshalJSON() ([]byte, error)
StartUploadItemRequest: Start upload file request.
type StartUploadItemRequest struct {
// ConnectorName: The name of connector making this call. Format:
// datasources/{source_id}/connectors/{ID}
ConnectorName string `json:"connectorName,omitempty"`
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConnectorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConnectorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StartUploadItemRequest) MarshalJSON() ([]byte, error)
type StatsGetIndexCall struct {
// contains filtered or unexported fields
}
func (c *StatsGetIndexCall) Context(ctx context.Context) *StatsGetIndexCall
Context sets the context to be used in this call's Do method.
func (c *StatsGetIndexCall) Do(opts ...googleapi.CallOption) (*GetCustomerIndexStatsResponse, error)
Do executes the "cloudsearch.stats.getIndex" call. Any non-2xx status code is an error. Response headers are in either *GetCustomerIndexStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsGetIndexCall) Fields(s ...googleapi.Field) *StatsGetIndexCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsGetIndexCall) FromDateDay(fromDateDay int64) *StatsGetIndexCall
FromDateDay sets the optional parameter "fromDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetIndexCall) FromDateMonth(fromDateMonth int64) *StatsGetIndexCall
FromDateMonth sets the optional parameter "fromDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetIndexCall) FromDateYear(fromDateYear int64) *StatsGetIndexCall
FromDateYear sets the optional parameter "fromDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsGetIndexCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsGetIndexCall) IfNoneMatch(entityTag string) *StatsGetIndexCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsGetIndexCall) ToDateDay(toDateDay int64) *StatsGetIndexCall
ToDateDay sets the optional parameter "toDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetIndexCall) ToDateMonth(toDateMonth int64) *StatsGetIndexCall
ToDateMonth sets the optional parameter "toDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetIndexCall) ToDateYear(toDateYear int64) *StatsGetIndexCall
ToDateYear sets the optional parameter "toDate.year": Year of date. Must be from 1 to 9999.
type StatsGetQueryCall struct {
// contains filtered or unexported fields
}
func (c *StatsGetQueryCall) Context(ctx context.Context) *StatsGetQueryCall
Context sets the context to be used in this call's Do method.
func (c *StatsGetQueryCall) Do(opts ...googleapi.CallOption) (*GetCustomerQueryStatsResponse, error)
Do executes the "cloudsearch.stats.getQuery" call. Any non-2xx status code is an error. Response headers are in either *GetCustomerQueryStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsGetQueryCall) Fields(s ...googleapi.Field) *StatsGetQueryCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsGetQueryCall) FromDateDay(fromDateDay int64) *StatsGetQueryCall
FromDateDay sets the optional parameter "fromDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetQueryCall) FromDateMonth(fromDateMonth int64) *StatsGetQueryCall
FromDateMonth sets the optional parameter "fromDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetQueryCall) FromDateYear(fromDateYear int64) *StatsGetQueryCall
FromDateYear sets the optional parameter "fromDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsGetQueryCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsGetQueryCall) IfNoneMatch(entityTag string) *StatsGetQueryCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsGetQueryCall) ToDateDay(toDateDay int64) *StatsGetQueryCall
ToDateDay sets the optional parameter "toDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetQueryCall) ToDateMonth(toDateMonth int64) *StatsGetQueryCall
ToDateMonth sets the optional parameter "toDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetQueryCall) ToDateYear(toDateYear int64) *StatsGetQueryCall
ToDateYear sets the optional parameter "toDate.year": Year of date. Must be from 1 to 9999.
type StatsGetSearchapplicationCall struct {
// contains filtered or unexported fields
}
func (c *StatsGetSearchapplicationCall) Context(ctx context.Context) *StatsGetSearchapplicationCall
Context sets the context to be used in this call's Do method.
func (c *StatsGetSearchapplicationCall) Do(opts ...googleapi.CallOption) (*GetCustomerSearchApplicationStatsResponse, error)
Do executes the "cloudsearch.stats.getSearchapplication" call. Any non-2xx status code is an error. Response headers are in either *GetCustomerSearchApplicationStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsGetSearchapplicationCall) EndDateDay(endDateDay int64) *StatsGetSearchapplicationCall
EndDateDay sets the optional parameter "endDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetSearchapplicationCall) EndDateMonth(endDateMonth int64) *StatsGetSearchapplicationCall
EndDateMonth sets the optional parameter "endDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetSearchapplicationCall) EndDateYear(endDateYear int64) *StatsGetSearchapplicationCall
EndDateYear sets the optional parameter "endDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsGetSearchapplicationCall) Fields(s ...googleapi.Field) *StatsGetSearchapplicationCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsGetSearchapplicationCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsGetSearchapplicationCall) IfNoneMatch(entityTag string) *StatsGetSearchapplicationCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsGetSearchapplicationCall) StartDateDay(startDateDay int64) *StatsGetSearchapplicationCall
StartDateDay sets the optional parameter "startDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetSearchapplicationCall) StartDateMonth(startDateMonth int64) *StatsGetSearchapplicationCall
StartDateMonth sets the optional parameter "startDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetSearchapplicationCall) StartDateYear(startDateYear int64) *StatsGetSearchapplicationCall
StartDateYear sets the optional parameter "startDate.year": Year of date. Must be from 1 to 9999.
type StatsGetSessionCall struct {
// contains filtered or unexported fields
}
func (c *StatsGetSessionCall) Context(ctx context.Context) *StatsGetSessionCall
Context sets the context to be used in this call's Do method.
func (c *StatsGetSessionCall) Do(opts ...googleapi.CallOption) (*GetCustomerSessionStatsResponse, error)
Do executes the "cloudsearch.stats.getSession" call. Any non-2xx status code is an error. Response headers are in either *GetCustomerSessionStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsGetSessionCall) Fields(s ...googleapi.Field) *StatsGetSessionCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsGetSessionCall) FromDateDay(fromDateDay int64) *StatsGetSessionCall
FromDateDay sets the optional parameter "fromDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetSessionCall) FromDateMonth(fromDateMonth int64) *StatsGetSessionCall
FromDateMonth sets the optional parameter "fromDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetSessionCall) FromDateYear(fromDateYear int64) *StatsGetSessionCall
FromDateYear sets the optional parameter "fromDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsGetSessionCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsGetSessionCall) IfNoneMatch(entityTag string) *StatsGetSessionCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsGetSessionCall) ToDateDay(toDateDay int64) *StatsGetSessionCall
ToDateDay sets the optional parameter "toDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetSessionCall) ToDateMonth(toDateMonth int64) *StatsGetSessionCall
ToDateMonth sets the optional parameter "toDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetSessionCall) ToDateYear(toDateYear int64) *StatsGetSessionCall
ToDateYear sets the optional parameter "toDate.year": Year of date. Must be from 1 to 9999.
type StatsGetUserCall struct {
// contains filtered or unexported fields
}
func (c *StatsGetUserCall) Context(ctx context.Context) *StatsGetUserCall
Context sets the context to be used in this call's Do method.
func (c *StatsGetUserCall) Do(opts ...googleapi.CallOption) (*GetCustomerUserStatsResponse, error)
Do executes the "cloudsearch.stats.getUser" call. Any non-2xx status code is an error. Response headers are in either *GetCustomerUserStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsGetUserCall) Fields(s ...googleapi.Field) *StatsGetUserCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsGetUserCall) FromDateDay(fromDateDay int64) *StatsGetUserCall
FromDateDay sets the optional parameter "fromDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetUserCall) FromDateMonth(fromDateMonth int64) *StatsGetUserCall
FromDateMonth sets the optional parameter "fromDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetUserCall) FromDateYear(fromDateYear int64) *StatsGetUserCall
FromDateYear sets the optional parameter "fromDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsGetUserCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsGetUserCall) IfNoneMatch(entityTag string) *StatsGetUserCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsGetUserCall) ToDateDay(toDateDay int64) *StatsGetUserCall
ToDateDay sets the optional parameter "toDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsGetUserCall) ToDateMonth(toDateMonth int64) *StatsGetUserCall
ToDateMonth sets the optional parameter "toDate.month": Month of date. Must be from 1 to 12.
func (c *StatsGetUserCall) ToDateYear(toDateYear int64) *StatsGetUserCall
ToDateYear sets the optional parameter "toDate.year": Year of date. Must be from 1 to 9999.
type StatsIndexDatasourcesGetCall struct {
// contains filtered or unexported fields
}
func (c *StatsIndexDatasourcesGetCall) Context(ctx context.Context) *StatsIndexDatasourcesGetCall
Context sets the context to be used in this call's Do method.
func (c *StatsIndexDatasourcesGetCall) Do(opts ...googleapi.CallOption) (*GetDataSourceIndexStatsResponse, error)
Do executes the "cloudsearch.stats.index.datasources.get" call. Any non-2xx status code is an error. Response headers are in either *GetDataSourceIndexStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsIndexDatasourcesGetCall) Fields(s ...googleapi.Field) *StatsIndexDatasourcesGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsIndexDatasourcesGetCall) FromDateDay(fromDateDay int64) *StatsIndexDatasourcesGetCall
FromDateDay sets the optional parameter "fromDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsIndexDatasourcesGetCall) FromDateMonth(fromDateMonth int64) *StatsIndexDatasourcesGetCall
FromDateMonth sets the optional parameter "fromDate.month": Month of date. Must be from 1 to 12.
func (c *StatsIndexDatasourcesGetCall) FromDateYear(fromDateYear int64) *StatsIndexDatasourcesGetCall
FromDateYear sets the optional parameter "fromDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsIndexDatasourcesGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsIndexDatasourcesGetCall) IfNoneMatch(entityTag string) *StatsIndexDatasourcesGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsIndexDatasourcesGetCall) ToDateDay(toDateDay int64) *StatsIndexDatasourcesGetCall
ToDateDay sets the optional parameter "toDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsIndexDatasourcesGetCall) ToDateMonth(toDateMonth int64) *StatsIndexDatasourcesGetCall
ToDateMonth sets the optional parameter "toDate.month": Month of date. Must be from 1 to 12.
func (c *StatsIndexDatasourcesGetCall) ToDateYear(toDateYear int64) *StatsIndexDatasourcesGetCall
ToDateYear sets the optional parameter "toDate.year": Year of date. Must be from 1 to 9999.
type StatsIndexDatasourcesService struct {
// contains filtered or unexported fields
}
func NewStatsIndexDatasourcesService(s *Service) *StatsIndexDatasourcesService
func (r *StatsIndexDatasourcesService) Get(name string) *StatsIndexDatasourcesGetCall
Get: Gets indexed item statistics for a single data source. **Note:** This API requires a standard end user account to execute.
type StatsIndexService struct {
Datasources *StatsIndexDatasourcesService
// contains filtered or unexported fields
}
func NewStatsIndexService(s *Service) *StatsIndexService
type StatsQuerySearchapplicationsGetCall struct {
// contains filtered or unexported fields
}
func (c *StatsQuerySearchapplicationsGetCall) Context(ctx context.Context) *StatsQuerySearchapplicationsGetCall
Context sets the context to be used in this call's Do method.
func (c *StatsQuerySearchapplicationsGetCall) Do(opts ...googleapi.CallOption) (*GetSearchApplicationQueryStatsResponse, error)
Do executes the "cloudsearch.stats.query.searchapplications.get" call. Any non-2xx status code is an error. Response headers are in either *GetSearchApplicationQueryStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsQuerySearchapplicationsGetCall) Fields(s ...googleapi.Field) *StatsQuerySearchapplicationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsQuerySearchapplicationsGetCall) FromDateDay(fromDateDay int64) *StatsQuerySearchapplicationsGetCall
FromDateDay sets the optional parameter "fromDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsQuerySearchapplicationsGetCall) FromDateMonth(fromDateMonth int64) *StatsQuerySearchapplicationsGetCall
FromDateMonth sets the optional parameter "fromDate.month": Month of date. Must be from 1 to 12.
func (c *StatsQuerySearchapplicationsGetCall) FromDateYear(fromDateYear int64) *StatsQuerySearchapplicationsGetCall
FromDateYear sets the optional parameter "fromDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsQuerySearchapplicationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsQuerySearchapplicationsGetCall) IfNoneMatch(entityTag string) *StatsQuerySearchapplicationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsQuerySearchapplicationsGetCall) ToDateDay(toDateDay int64) *StatsQuerySearchapplicationsGetCall
ToDateDay sets the optional parameter "toDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsQuerySearchapplicationsGetCall) ToDateMonth(toDateMonth int64) *StatsQuerySearchapplicationsGetCall
ToDateMonth sets the optional parameter "toDate.month": Month of date. Must be from 1 to 12.
func (c *StatsQuerySearchapplicationsGetCall) ToDateYear(toDateYear int64) *StatsQuerySearchapplicationsGetCall
ToDateYear sets the optional parameter "toDate.year": Year of date. Must be from 1 to 9999.
type StatsQuerySearchapplicationsService struct {
// contains filtered or unexported fields
}
func NewStatsQuerySearchapplicationsService(s *Service) *StatsQuerySearchapplicationsService
func (r *StatsQuerySearchapplicationsService) Get(name string) *StatsQuerySearchapplicationsGetCall
Get: Get the query statistics for search application. **Note:** This API requires a standard end user account to execute.
type StatsQueryService struct {
Searchapplications *StatsQuerySearchapplicationsService
// contains filtered or unexported fields
}
func NewStatsQueryService(s *Service) *StatsQueryService
type StatsService struct {
Index *StatsIndexService
Query *StatsQueryService
Session *StatsSessionService
User *StatsUserService
// contains filtered or unexported fields
}
func NewStatsService(s *Service) *StatsService
func (r *StatsService) GetIndex() *StatsGetIndexCall
GetIndex: Gets indexed item statistics aggreggated across all data sources. This API only returns statistics for previous dates; it doesn't return statistics for the current day. **Note:** This API requires a standard end user account to execute.
func (r *StatsService) GetQuery() *StatsGetQueryCall
GetQuery: Get the query statistics for customer. **Note:** This API requires a standard end user account to execute.
func (r *StatsService) GetSearchapplication() *StatsGetSearchapplicationCall
GetSearchapplication: Get search application stats for customer. **Note:** This API requires a standard end user account to execute.
func (r *StatsService) GetSession() *StatsGetSessionCall
GetSession: Get the # of search sessions, % of successful sessions with a click query statistics for customer. **Note:** This API requires a standard end user account to execute.
func (r *StatsService) GetUser() *StatsGetUserCall
GetUser: Get the users statistics for customer. **Note:** This API requires a standard end user account to execute.
type StatsSessionSearchapplicationsGetCall struct {
// contains filtered or unexported fields
}
func (c *StatsSessionSearchapplicationsGetCall) Context(ctx context.Context) *StatsSessionSearchapplicationsGetCall
Context sets the context to be used in this call's Do method.
func (c *StatsSessionSearchapplicationsGetCall) Do(opts ...googleapi.CallOption) (*GetSearchApplicationSessionStatsResponse, error)
Do executes the "cloudsearch.stats.session.searchapplications.get" call. Any non-2xx status code is an error. Response headers are in either *GetSearchApplicationSessionStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsSessionSearchapplicationsGetCall) Fields(s ...googleapi.Field) *StatsSessionSearchapplicationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsSessionSearchapplicationsGetCall) FromDateDay(fromDateDay int64) *StatsSessionSearchapplicationsGetCall
FromDateDay sets the optional parameter "fromDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsSessionSearchapplicationsGetCall) FromDateMonth(fromDateMonth int64) *StatsSessionSearchapplicationsGetCall
FromDateMonth sets the optional parameter "fromDate.month": Month of date. Must be from 1 to 12.
func (c *StatsSessionSearchapplicationsGetCall) FromDateYear(fromDateYear int64) *StatsSessionSearchapplicationsGetCall
FromDateYear sets the optional parameter "fromDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsSessionSearchapplicationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsSessionSearchapplicationsGetCall) IfNoneMatch(entityTag string) *StatsSessionSearchapplicationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsSessionSearchapplicationsGetCall) ToDateDay(toDateDay int64) *StatsSessionSearchapplicationsGetCall
ToDateDay sets the optional parameter "toDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsSessionSearchapplicationsGetCall) ToDateMonth(toDateMonth int64) *StatsSessionSearchapplicationsGetCall
ToDateMonth sets the optional parameter "toDate.month": Month of date. Must be from 1 to 12.
func (c *StatsSessionSearchapplicationsGetCall) ToDateYear(toDateYear int64) *StatsSessionSearchapplicationsGetCall
ToDateYear sets the optional parameter "toDate.year": Year of date. Must be from 1 to 9999.
type StatsSessionSearchapplicationsService struct {
// contains filtered or unexported fields
}
func NewStatsSessionSearchapplicationsService(s *Service) *StatsSessionSearchapplicationsService
func (r *StatsSessionSearchapplicationsService) Get(name string) *StatsSessionSearchapplicationsGetCall
Get: Get the # of search sessions, % of successful sessions with a click query statistics for search application. **Note:** This API requires a standard end user account to execute.
type StatsSessionService struct {
Searchapplications *StatsSessionSearchapplicationsService
// contains filtered or unexported fields
}
func NewStatsSessionService(s *Service) *StatsSessionService
type StatsUserSearchapplicationsGetCall struct {
// contains filtered or unexported fields
}
func (c *StatsUserSearchapplicationsGetCall) Context(ctx context.Context) *StatsUserSearchapplicationsGetCall
Context sets the context to be used in this call's Do method.
func (c *StatsUserSearchapplicationsGetCall) Do(opts ...googleapi.CallOption) (*GetSearchApplicationUserStatsResponse, error)
Do executes the "cloudsearch.stats.user.searchapplications.get" call. Any non-2xx status code is an error. Response headers are in either *GetSearchApplicationUserStatsResponse.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *StatsUserSearchapplicationsGetCall) Fields(s ...googleapi.Field) *StatsUserSearchapplicationsGetCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *StatsUserSearchapplicationsGetCall) FromDateDay(fromDateDay int64) *StatsUserSearchapplicationsGetCall
FromDateDay sets the optional parameter "fromDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsUserSearchapplicationsGetCall) FromDateMonth(fromDateMonth int64) *StatsUserSearchapplicationsGetCall
FromDateMonth sets the optional parameter "fromDate.month": Month of date. Must be from 1 to 12.
func (c *StatsUserSearchapplicationsGetCall) FromDateYear(fromDateYear int64) *StatsUserSearchapplicationsGetCall
FromDateYear sets the optional parameter "fromDate.year": Year of date. Must be from 1 to 9999.
func (c *StatsUserSearchapplicationsGetCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
func (c *StatsUserSearchapplicationsGetCall) IfNoneMatch(entityTag string) *StatsUserSearchapplicationsGetCall
IfNoneMatch sets an optional parameter which makes the operation fail if the object's ETag matches the given value. This is useful for getting updates only after the object has changed since the last request.
func (c *StatsUserSearchapplicationsGetCall) ToDateDay(toDateDay int64) *StatsUserSearchapplicationsGetCall
ToDateDay sets the optional parameter "toDate.day": Day of month. Must be from 1 to 31 and valid for the year and month.
func (c *StatsUserSearchapplicationsGetCall) ToDateMonth(toDateMonth int64) *StatsUserSearchapplicationsGetCall
ToDateMonth sets the optional parameter "toDate.month": Month of date. Must be from 1 to 12.
func (c *StatsUserSearchapplicationsGetCall) ToDateYear(toDateYear int64) *StatsUserSearchapplicationsGetCall
ToDateYear sets the optional parameter "toDate.year": Year of date. Must be from 1 to 9999.
type StatsUserSearchapplicationsService struct {
// contains filtered or unexported fields
}
func NewStatsUserSearchapplicationsService(s *Service) *StatsUserSearchapplicationsService
func (r *StatsUserSearchapplicationsService) Get(name string) *StatsUserSearchapplicationsGetCall
Get: Get the users statistics for search application. **Note:** This API requires a standard end user account to execute.
type StatsUserService struct {
Searchapplications *StatsUserSearchapplicationsService
// contains filtered or unexported fields
}
func NewStatsUserService(s *Service) *StatsUserService
Status: The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC (https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide (https://cloud.google.com/apis/design/errors).
type Status struct {
// Code: The status code, which should be an enum value of google.rpc.Code.
Code int64 `json:"code,omitempty"`
// Details: A list of messages that carry the error details. There is a common
// set of message types for APIs to use.
Details []googleapi.RawMessage `json:"details,omitempty"`
// Message: 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 `json:"message,omitempty"`
// ForceSendFields is a list of field names (e.g. "Code") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Code") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Status) MarshalJSON() ([]byte, error)
StructuredDataObject: A structured data object consisting of named properties.
type StructuredDataObject struct {
// Properties: The properties for the object. The maximum number of elements is
// 1000.
Properties []*NamedProperty `json:"properties,omitempty"`
// ForceSendFields is a list of field names (e.g. "Properties") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Properties") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StructuredDataObject) MarshalJSON() ([]byte, error)
StructuredResult: Structured results that are returned as part of search request.
type StructuredResult struct {
// Person: Representation of a person
Person *Person `json:"person,omitempty"`
// ForceSendFields is a list of field names (e.g. "Person") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Person") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *StructuredResult) MarshalJSON() ([]byte, error)
SuggestRequest: Request of suggest API.
type SuggestRequest struct {
// DataSourceRestrictions: The sources to use for suggestions. If not
// specified, the data sources are taken from the current search application.
// NOTE: Suggestions are only supported for the following sources: *
// Third-party data sources * PredefinedSource.PERSON *
// PredefinedSource.GOOGLE_DRIVE
DataSourceRestrictions []*DataSourceRestriction `json:"dataSourceRestrictions,omitempty"`
// Query: Partial query for which autocomplete suggestions will be shown. For
// example, if the query is "sea", then the server might return "season",
// "search", "seagull" and so on.
Query string `json:"query,omitempty"`
// RequestOptions: Request options, such as the search application and user
// timezone.
RequestOptions *RequestOptions `json:"requestOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "DataSourceRestrictions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DataSourceRestrictions") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SuggestRequest) MarshalJSON() ([]byte, error)
SuggestResponse: Response of the suggest API.
type SuggestResponse struct {
// SuggestResults: List of suggestions.
SuggestResults []*SuggestResult `json:"suggestResults,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "SuggestResults") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "SuggestResults") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SuggestResponse) MarshalJSON() ([]byte, error)
SuggestResult: One suggestion result.
type SuggestResult struct {
// PeopleSuggestion: This is present when the suggestion indicates a person. It
// contains more information about the person - like their email ID, name etc.
PeopleSuggestion *PeopleSuggestion `json:"peopleSuggestion,omitempty"`
// QuerySuggestion: This field will be present if the suggested query is a
// word/phrase completion.
QuerySuggestion *QuerySuggestion `json:"querySuggestion,omitempty"`
// Source: The source of the suggestion.
Source *Source `json:"source,omitempty"`
// SuggestedQuery: The suggested query that will be used for search, when the
// user clicks on the suggestion
SuggestedQuery string `json:"suggestedQuery,omitempty"`
// ForceSendFields is a list of field names (e.g. "PeopleSuggestion") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "PeopleSuggestion") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *SuggestResult) MarshalJSON() ([]byte, error)
TextOperatorOptions: Used to provide a search operator for text properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
type TextOperatorOptions struct {
// ExactMatchWithOperator: If true, the text value is 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" doesn't match the item;
// "genre:science-fiction" does. Text value matching is case-sensitive and does
// not remove special characters. If false, the text is tokenized. For example,
// if the value is "science-fiction" the queries "genre:science" and
// "genre:fiction" matches the item.
ExactMatchWithOperator bool `json:"exactMatchWithOperator,omitempty"`
// OperatorName: 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:<value>* show
// results only where the value of the property named *subjectLine* matches
// *<value>*. By contrast, a search that uses the same *<value>* without an
// operator returns all items where *<value>* 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 `json:"operatorName,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExactMatchWithOperator") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExactMatchWithOperator") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TextOperatorOptions) MarshalJSON() ([]byte, error)
TextPropertyOptions: The options for text properties.
type TextPropertyOptions struct {
// OperatorOptions: If set, describes how the property should be used as a
// search operator.
OperatorOptions *TextOperatorOptions `json:"operatorOptions,omitempty"`
// RetrievalImportance: Indicates the search quality importance of the tokens
// within the field when used for retrieval.
RetrievalImportance *RetrievalImportance `json:"retrievalImportance,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TextPropertyOptions) MarshalJSON() ([]byte, error)
TextValues: List of text values.
type TextValues struct {
// Values: The maximum allowable length for text values is 2048 characters.
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TextValues) MarshalJSON() ([]byte, error)
type ThirdPartyGenericCard struct {
// CardId: Unique identifier for the card.
CardId string `json:"cardId,omitempty"`
// Category: Category that the card belongs to.
Category string `json:"category,omitempty"`
// Content: [Required] Card content.
Content *Content `json:"content,omitempty"`
// Context: [Required] Context where the card should be triggered.
Context *Context `json:"context,omitempty"`
// IsDismissible: Whether the card can be dismissed.
IsDismissible bool `json:"isDismissible,omitempty"`
// Priority: Priority of the card, where 0 is the highest priority.
Priority int64 `json:"priority,omitempty"`
// ForceSendFields is a list of field names (e.g. "CardId") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "CardId") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ThirdPartyGenericCard) MarshalJSON() ([]byte, error)
TimestampOperatorOptions: Used to provide a search operator for timestamp properties. This is optional. Search operators let users restrict the query to specific fields relevant to the type of item being searched.
type TimestampOperatorOptions struct {
// GreaterThanOperatorName: 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:<value>* show results
// only where the value of the property named *closeDate* is later than
// *<value>*. The operator name can only contain lowercase letters (a-z). The
// maximum length is 32 characters.
GreaterThanOperatorName string `json:"greaterThanOperatorName,omitempty"`
// LessThanOperatorName: 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:<value>* show results only
// where the value of the property named *closeDate* is earlier than *<value>*.
// The operator name can only contain lowercase letters (a-z). The maximum
// length is 32 characters.
LessThanOperatorName string `json:"lessThanOperatorName,omitempty"`
// OperatorName: 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:<value>*
// show results only where the value of the property named *closeDate* matches
// *<value>*. By contrast, a search that uses the same *<value>* without an
// operator returns all items where *<value>* 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 `json:"operatorName,omitempty"`
// ForceSendFields is a list of field names (e.g. "GreaterThanOperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "GreaterThanOperatorName") to
// include in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TimestampOperatorOptions) MarshalJSON() ([]byte, error)
TimestampPropertyOptions: The options for timestamp properties.
type TimestampPropertyOptions struct {
// OperatorOptions: If set, describes how the timestamp should be used as a
// search operator.
OperatorOptions *TimestampOperatorOptions `json:"operatorOptions,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorOptions") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TimestampPropertyOptions) MarshalJSON() ([]byte, error)
TimestampValues: List of timestamp values.
type TimestampValues struct {
Values []string `json:"values,omitempty"`
// ForceSendFields is a list of field names (e.g. "Values") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Values") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *TimestampValues) MarshalJSON() ([]byte, error)
type UnmappedIdentity struct {
// ExternalIdentity: The resource name for an external user.
ExternalIdentity *Principal `json:"externalIdentity,omitempty"`
// ResolutionStatusCode: The resolution status for the external identity.
//
// Possible values:
// "CODE_UNSPECIFIED" - Input-only value. Used to list all unmapped
// identities regardless of status.
// "NOT_FOUND" - The unmapped identity was not found in IDaaS, and needs to
// be provided by the user.
// "IDENTITY_SOURCE_NOT_FOUND" - The identity source associated with the
// identity was either not found or deleted.
// "IDENTITY_SOURCE_MISCONFIGURED" - IDaaS does not understand the identity
// source, probably because the schema was modified in a non compatible way.
// "TOO_MANY_MAPPINGS_FOUND" - The number of users associated with the
// external identity is too large.
// "INTERNAL_ERROR" - Internal error.
ResolutionStatusCode string `json:"resolutionStatusCode,omitempty"`
// ForceSendFields is a list of field names (e.g. "ExternalIdentity") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ExternalIdentity") to include in
// API requests with the JSON null value. By default, fields with empty values
// are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UnmappedIdentity) MarshalJSON() ([]byte, error)
type UnreserveItemsRequest struct {
// ConnectorName: The name of connector making this call. Format:
// datasources/{source_id}/connectors/{ID}
ConnectorName string `json:"connectorName,omitempty"`
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// Queue: The name of a queue to unreserve items from.
Queue string `json:"queue,omitempty"`
// ForceSendFields is a list of field names (e.g. "ConnectorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "ConnectorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UnreserveItemsRequest) MarshalJSON() ([]byte, error)
type UpdateDataSourceRequest struct {
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
Source *DataSource `json:"source,omitempty"`
// UpdateMask: Only applies to `settings.datasources.patch`
// (https://developers.google.com/cloud-search/docs/reference/rest/v1/settings.datasources/patch).
// Update mask to control which fields to update. Example field paths: `name`,
// `displayName`. * If `update_mask` is non-empty, then only the fields
// specified in the `update_mask` are updated. * If you specify a field in the
// `update_mask`, but don't specify its value in the source, that field is
// cleared. * If the `update_mask` is not present or empty or has the value
// `*`, then all fields are updated.
UpdateMask string `json:"updateMask,omitempty"`
// ForceSendFields is a list of field names (e.g. "DebugOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DebugOptions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UpdateDataSourceRequest) MarshalJSON() ([]byte, error)
type UpdateSchemaRequest struct {
// DebugOptions: Common debug options.
DebugOptions *DebugOptions `json:"debugOptions,omitempty"`
// Schema: The new schema for the source.
Schema *Schema `json:"schema,omitempty"`
// ValidateOnly: If true, the schema will be checked for validity, but will not
// be registered with the data source, even if valid.
ValidateOnly bool `json:"validateOnly,omitempty"`
// ForceSendFields is a list of field names (e.g. "DebugOptions") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "DebugOptions") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UpdateSchemaRequest) MarshalJSON() ([]byte, error)
UploadItemRef: Represents an upload session reference. This reference is created via upload method. This reference is valid for 30 days after its creation. Updating of item content may refer to this uploaded content via contentDataRef.
type UploadItemRef struct {
// Name: The name of the content reference. The maximum length is 2048
// characters.
Name string `json:"name,omitempty"`
// ServerResponse contains the HTTP response code and headers from the server.
googleapi.ServerResponse `json:"-"`
// ForceSendFields is a list of field names (e.g. "Name") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Name") to include in API requests
// with the JSON null value. By default, fields with empty values are omitted
// from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UploadItemRef) MarshalJSON() ([]byte, error)
UserActivity: User's single or bulk query activity. This can be a logging query or deletion query.
type UserActivity struct {
// QueryActivity: Contains data which needs to be logged/removed.
QueryActivity *QueryActivity `json:"queryActivity,omitempty"`
// ForceSendFields is a list of field names (e.g. "QueryActivity") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "QueryActivity") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *UserActivity) MarshalJSON() ([]byte, error)
type V1InitializeCustomerCall struct {
// contains filtered or unexported fields
}
func (c *V1InitializeCustomerCall) Context(ctx context.Context) *V1InitializeCustomerCall
Context sets the context to be used in this call's Do method.
func (c *V1InitializeCustomerCall) Do(opts ...googleapi.CallOption) (*Operation, error)
Do executes the "cloudsearch.initializeCustomer" call. Any non-2xx status code is an error. Response headers are in either *Operation.ServerResponse.Header or (if a response was returned at all) in error.(*googleapi.Error).Header. Use googleapi.IsNotModified to check whether the returned error was because http.StatusNotModified was returned.
func (c *V1InitializeCustomerCall) Fields(s ...googleapi.Field) *V1InitializeCustomerCall
Fields allows partial responses to be retrieved. See https://developers.google.com/gdata/docs/2.0/basics#PartialResponse for more details.
func (c *V1InitializeCustomerCall) Header() http.Header
Header returns a http.Header that can be modified by the caller to add headers to the request.
type V1Service struct {
// contains filtered or unexported fields
}
func NewV1Service(s *Service) *V1Service
func (r *V1Service) InitializeCustomer(initializecustomerrequest *InitializeCustomerRequest) *V1InitializeCustomerCall
InitializeCustomer: Enables `third party` support in Google Cloud Search. **Note:** This API requires an admin account to execute.
type VPCSettings struct {
// Project: The resource name of the GCP Project to be used for VPC SC policy
// check. VPC security settings on this project will be honored for Cloud
// Search APIs after project_name has been updated through CustomerService.
// Format: projects/{project_id}
Project string `json:"project,omitempty"`
// ForceSendFields is a list of field names (e.g. "Project") to unconditionally
// include in API requests. By default, fields with empty or default values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "Project") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *VPCSettings) MarshalJSON() ([]byte, error)
Value: Definition of a single value with generic type.
type Value struct {
BooleanValue bool `json:"booleanValue,omitempty"`
DateValue *Date `json:"dateValue,omitempty"`
DoubleValue float64 `json:"doubleValue,omitempty"`
IntegerValue int64 `json:"integerValue,omitempty,string"`
StringValue string `json:"stringValue,omitempty"`
TimestampValue string `json:"timestampValue,omitempty"`
// ForceSendFields is a list of field names (e.g. "BooleanValue") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "BooleanValue") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *Value) MarshalJSON() ([]byte, error)
func (s *Value) UnmarshalJSON(data []byte) error
type ValueFilter struct {
// OperatorName: The `operator_name` applied to the query, such as
// *price_greater_than*. The filter can work against both types of filters
// defined in the schema for your data source: 1. `operator_name`, where the
// query filters results by the property that matches the value. 2.
// `greater_than_operator_name` or `less_than_operator_name` in your schema.
// The query filters the results for the property values that are greater than
// or less than the supplied value in the query.
OperatorName string `json:"operatorName,omitempty"`
// Value: The value to be compared with.
Value *Value `json:"value,omitempty"`
// ForceSendFields is a list of field names (e.g. "OperatorName") to
// unconditionally include in API requests. By default, fields with empty or
// default values are omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-ForceSendFields for more
// details.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "OperatorName") to include in API
// requests with the JSON null value. By default, fields with empty values are
// omitted from API requests. See
// https://pkg.go.dev/google.golang.org/api#hdr-NullFields for more details.
NullFields []string `json:"-"`
}
func (s *ValueFilter) MarshalJSON() ([]byte, error)