blob: 17449d59fc88e86c66aa85d4441734946384f8f6 [file] [log] [blame]
// Copyright 2020 Google LLC.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// Code generated file. DO NOT EDIT.
// Package cloudsearch provides access to the Cloud Search API.
//
// For product documentation, see: https://developers.google.com/cloud-search/docs/guides/
//
// Creating a client
//
// Usage example:
//
// import "google.golang.org/api/cloudsearch/v1"
// ...
// ctx := context.Background()
// cloudsearchService, err := cloudsearch.NewService(ctx)
//
// In this example, Google Application Default Credentials are used for authentication.
//
// For information on how to create and obtain Application Default Credentials, see https://developers.google.com/identity/protocols/application-default-credentials.
//
// Other authentication options
//
// By default, all available scopes (see "Constants") are used to authenticate. To restrict scopes, use option.WithScopes:
//
// cloudsearchService, err := cloudsearch.NewService(ctx, option.WithScopes(cloudsearch.CloudSearchStatsIndexingScope))
//
// To use an API key for authentication (note: some APIs do not support API keys), use option.WithAPIKey:
//
// cloudsearchService, err := cloudsearch.NewService(ctx, option.WithAPIKey("AIza..."))
//
// To use an OAuth token (e.g., a user token obtained via a three-legged OAuth flow), use option.WithTokenSource:
//
// config := &oauth2.Config{...}
// // ...
// token, err := config.Exchange(ctx, ...)
// cloudsearchService, err := cloudsearch.NewService(ctx, option.WithTokenSource(config.TokenSource(ctx, token)))
//
// See https://godoc.org/google.golang.org/api/option/ for details on options.
package cloudsearch // import "google.golang.org/api/cloudsearch/v1"
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"io"
"net/http"
"net/url"
"strconv"
"strings"
googleapi "google.golang.org/api/googleapi"
gensupport "google.golang.org/api/internal/gensupport"
option "google.golang.org/api/option"
internaloption "google.golang.org/api/option/internaloption"
htransport "google.golang.org/api/transport/http"
)
// Always reference these packages, just in case the auto-generated code
// below doesn't.
var _ = bytes.NewBuffer
var _ = strconv.Itoa
var _ = fmt.Sprintf
var _ = json.NewDecoder
var _ = io.Copy
var _ = url.Parse
var _ = gensupport.MarshalJSON
var _ = googleapi.Version
var _ = errors.New
var _ = strings.Replace
var _ = context.Canceled
var _ = internaloption.WithDefaultEndpoint
const apiId = "cloudsearch:v1"
const apiName = "cloudsearch"
const apiVersion = "v1"
const basePath = "https://cloudsearch.googleapis.com/"
const mtlsBasePath = "https://cloudsearch.mtls.googleapis.com/"
// 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"
)
// NewService creates a new Service.
func NewService(ctx context.Context, opts ...option.ClientOption) (*Service, error) {
scopesOption := option.WithScopes(
"https://www.googleapis.com/auth/cloud_search",
"https://www.googleapis.com/auth/cloud_search.debug",
"https://www.googleapis.com/auth/cloud_search.indexing",
"https://www.googleapis.com/auth/cloud_search.query",
"https://www.googleapis.com/auth/cloud_search.settings",
"https://www.googleapis.com/auth/cloud_search.settings.indexing",
"https://www.googleapis.com/auth/cloud_search.settings.query",
"https://www.googleapis.com/auth/cloud_search.stats",
"https://www.googleapis.com/auth/cloud_search.stats.indexing",
)
// NOTE: prepend, so we don't override user-specified scopes.
opts = append([]option.ClientOption{scopesOption}, opts...)
opts = append(opts, internaloption.WithDefaultEndpoint(basePath))
opts = append(opts, internaloption.WithDefaultMTLSEndpoint(mtlsBasePath))
client, endpoint, err := htransport.NewClient(ctx, opts...)
if err != nil {
return nil, err
}
s, err := New(client)
if err != nil {
return nil, err
}
if endpoint != "" {
s.BasePath = endpoint
}
return s, nil
}
// 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 New(client *http.Client) (*Service, error) {
if client == nil {
return nil, errors.New("client is nil")
}
s := &Service{client: client, BasePath: basePath}
s.Debug = NewDebugService(s)
s.Indexing = NewIndexingService(s)
s.Media = NewMediaService(s)
s.Operations = NewOperationsService(s)
s.Query = NewQueryService(s)
s.Settings = NewSettingsService(s)
s.Stats = NewStatsService(s)
return s, nil
}
type Service struct {
client *http.Client
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
}
func (s *Service) userAgent() string {
if s.UserAgent == "" {
return googleapi.UserAgent
}
return googleapi.UserAgent + " " + s.UserAgent
}
func NewDebugService(s *Service) *DebugService {
rs := &DebugService{s: s}
rs.Datasources = NewDebugDatasourcesService(s)
rs.Identitysources = NewDebugIdentitysourcesService(s)
return rs
}
type DebugService struct {
s *Service
Datasources *DebugDatasourcesService
Identitysources *DebugIdentitysourcesService
}
func NewDebugDatasourcesService(s *Service) *DebugDatasourcesService {
rs := &DebugDatasourcesService{s: s}
rs.Items = NewDebugDatasourcesItemsService(s)
return rs
}
type DebugDatasourcesService struct {
s *Service
Items *DebugDatasourcesItemsService
}
func NewDebugDatasourcesItemsService(s *Service) *DebugDatasourcesItemsService {
rs := &DebugDatasourcesItemsService{s: s}
rs.Unmappedids = NewDebugDatasourcesItemsUnmappedidsService(s)
return rs
}
type DebugDatasourcesItemsService struct {
s *Service
Unmappedids *DebugDatasourcesItemsUnmappedidsService
}
func NewDebugDatasourcesItemsUnmappedidsService(s *Service) *DebugDatasourcesItemsUnmappedidsService {
rs := &DebugDatasourcesItemsUnmappedidsService{s: s}
return rs
}
type DebugDatasourcesItemsUnmappedidsService struct {
s *Service
}
func NewDebugIdentitysourcesService(s *Service) *DebugIdentitysourcesService {
rs := &DebugIdentitysourcesService{s: s}
rs.Items = NewDebugIdentitysourcesItemsService(s)
rs.Unmappedids = NewDebugIdentitysourcesUnmappedidsService(s)
return rs
}
type DebugIdentitysourcesService struct {
s *Service
Items *DebugIdentitysourcesItemsService
Unmappedids *DebugIdentitysourcesUnmappedidsService
}
func NewDebugIdentitysourcesItemsService(s *Service) *DebugIdentitysourcesItemsService {
rs := &DebugIdentitysourcesItemsService{s: s}
return rs
}
type DebugIdentitysourcesItemsService struct {
s *Service
}
func NewDebugIdentitysourcesUnmappedidsService(s *Service) *DebugIdentitysourcesUnmappedidsService {
rs := &DebugIdentitysourcesUnmappedidsService{s: s}
return rs
}
type DebugIdentitysourcesUnmappedidsService struct {
s *Service
}
func NewIndexingService(s *Service) *IndexingService {
rs := &IndexingService{s: s}
rs.Datasources = NewIndexingDatasourcesService(s)
return rs
}
type IndexingService struct {
s *Service
Datasources *IndexingDatasourcesService
}
func NewIndexingDatasourcesService(s *Service) *IndexingDatasourcesService {
rs := &IndexingDatasourcesService{s: s}
rs.Items = NewIndexingDatasourcesItemsService(s)
return rs
}
type IndexingDatasourcesService struct {
s *Service
Items *IndexingDatasourcesItemsService
}
func NewIndexingDatasourcesItemsService(s *Service) *IndexingDatasourcesItemsService {
rs := &IndexingDatasourcesItemsService{s: s}
return rs
}
type IndexingDatasourcesItemsService struct {
s *Service
}
func NewMediaService(s *Service) *MediaService {
rs := &MediaService{s: s}
return rs
}
type MediaService struct {
s *Service
}
func NewOperationsService(s *Service) *OperationsService {
rs := &OperationsService{s: s}
rs.Lro = NewOperationsLroService(s)
return rs
}
type OperationsService struct {
s *Service
Lro *OperationsLroService
}
func NewOperationsLroService(s *Service) *OperationsLroService {
rs := &OperationsLroService{s: s}
return rs
}
type OperationsLroService struct {
s *Service
}
func NewQueryService(s *Service) *QueryService {
rs := &QueryService{s: s}
rs.Sources = NewQuerySourcesService(s)
return rs
}
type QueryService struct {
s *Service
Sources *QuerySourcesService
}
func NewQuerySourcesService(s *Service) *QuerySourcesService {
rs := &QuerySourcesService{s: s}
return rs
}
type QuerySourcesService struct {
s *Service
}
func NewSettingsService(s *Service) *SettingsService {
rs := &SettingsService{s: s}
rs.Datasources = NewSettingsDatasourcesService(s)
rs.Searchapplications = NewSettingsSearchapplicationsService(s)
return rs
}
type SettingsService struct {
s *Service
Datasources *SettingsDatasourcesService
Searchapplications *SettingsSearchapplicationsService
}
func NewSettingsDatasourcesService(s *Service) *SettingsDatasourcesService {
rs := &SettingsDatasourcesService{s: s}
return rs
}
type SettingsDatasourcesService struct {
s *Service
}
func NewSettingsSearchapplicationsService(s *Service) *SettingsSearchapplicationsService {
rs := &SettingsSearchapplicationsService{s: s}
return rs
}
type SettingsSearchapplicationsService struct {
s *Service
}
func NewStatsService(s *Service) *StatsService {
rs := &StatsService{s: s}
rs.Index = NewStatsIndexService(s)
rs.Query = NewStatsQueryService(s)
rs.Session = NewStatsSessionService(s)
rs.User = NewStatsUserService(s)
return rs
}
type StatsService struct {
s *Service
Index *StatsIndexService
Query *StatsQueryService
Session *StatsSessionService
User *StatsUserService
}
func NewStatsIndexService(s *Service) *StatsIndexService {
rs := &StatsIndexService{s: s}
rs.Datasources = NewStatsIndexDatasourcesService(s)
return rs
}
type StatsIndexService struct {
s *Service
Datasources *StatsIndexDatasourcesService
}
func NewStatsIndexDatasourcesService(s *Service) *StatsIndexDatasourcesService {
rs := &StatsIndexDatasourcesService{s: s}
return rs
}
type StatsIndexDatasourcesService struct {
s *Service
}
func NewStatsQueryService(s *Service) *StatsQueryService {
rs := &StatsQueryService{s: s}
rs.Searchapplications = NewStatsQuerySearchapplicationsService(s)
return rs
}
type StatsQueryService struct {
s *Service
Searchapplications *StatsQuerySearchapplicationsService
}
func NewStatsQuerySearchapplicationsService(s *Service) *StatsQuerySearchapplicationsService {
rs := &StatsQuerySearchapplicationsService{s: s}
return rs
}
type StatsQuerySearchapplicationsService struct {
s *Service
}
func NewStatsSessionService(s *Service) *StatsSessionService {
rs := &StatsSessionService{s: s}
rs.Searchapplications = NewStatsSessionSearchapplicationsService(s)
return rs
}
type StatsSessionService struct {
s *Service
Searchapplications *StatsSessionSearchapplicationsService
}
func NewStatsSessionSearchapplicationsService(s *Service) *StatsSessionSearchapplicationsService {
rs := &StatsSessionSearchapplicationsService{s: s}
return rs
}
type StatsSessionSearchapplicationsService struct {
s *Service
}
func NewStatsUserService(s *Service) *StatsUserService {
rs := &StatsUserService{s: s}
rs.Searchapplications = NewStatsUserSearchapplicationsService(s)
return rs
}
type StatsUserService struct {
s *Service
Searchapplications *StatsUserSearchapplicationsService
}
func NewStatsUserSearchapplicationsService(s *Service) *StatsUserSearchapplicationsService {
rs := &StatsUserSearchapplicationsService{s: s}
return rs
}
type StatsUserSearchapplicationsService struct {
s *Service
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *BooleanOperatorOptions) MarshalJSON() ([]byte, error) {
type NoMethod BooleanOperatorOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// BooleanPropertyOptions: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *BooleanPropertyOptions) MarshalJSON() ([]byte, error) {
type NoMethod BooleanPropertyOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CheckAccessResponse) MarshalJSON() ([]byte, error) {
type NoMethod CheckAccessResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CompositeFilter) MarshalJSON() ([]byte, error) {
type NoMethod CompositeFilter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// CustomerIndexStats: Aggregation of items by status code as of the
// specified date.
type CustomerIndexStats struct {
// Date: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CustomerIndexStats) MarshalJSON() ([]byte, error) {
type NoMethod CustomerIndexStats
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type CustomerQueryStats struct {
// Date: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CustomerQueryStats) MarshalJSON() ([]byte, error) {
type NoMethod CustomerQueryStats
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type CustomerSessionStats struct {
// Date: Date for which session stats were calculated. Stats calculated
// on the next day close to midnight are 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CustomerSessionStats) MarshalJSON() ([]byte, error) {
type NoMethod CustomerSessionStats
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type CustomerUserStats struct {
// Date: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *CustomerUserStats) MarshalJSON() ([]byte, error) {
type NoMethod CustomerUserStats
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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, Indexing API rejects any modification
// calls to this datasource such as create, update, and delete.
// Disabling this does not imply halting process 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: 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"`
// 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 values are omitted from API requests.
// However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *DataSource) MarshalJSON() ([]byte, error) {
type NoMethod DataSource
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DataSourceIndexStats: Aggregation of items by status code as of the
// specified date.
type DataSourceIndexStats struct {
// Date: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DataSourceIndexStats) MarshalJSON() ([]byte, error) {
type NoMethod DataSourceIndexStats
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DataSourceRestriction) MarshalJSON() ([]byte, error) {
type NoMethod DataSourceRestriction
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Date) MarshalJSON() ([]byte, error) {
type NoMethod Date
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API
// requests. However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
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. However, any
// field with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *DateOperatorOptions) MarshalJSON() ([]byte, error) {
type NoMethod DateOperatorOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DatePropertyOptions: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *DatePropertyOptions) MarshalJSON() ([]byte, error) {
type NoMethod DatePropertyOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DateValues) MarshalJSON() ([]byte, error) {
type NoMethod DateValues
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *DebugOptions) MarshalJSON() ([]byte, error) {
type NoMethod DebugOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type DeleteQueueItemsRequest struct {
// ConnectorName: 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: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DeleteQueueItemsRequest) MarshalJSON() ([]byte, error) {
type NoMethod DeleteQueueItemsRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DisplayedProperty) MarshalJSON() ([]byte, error) {
type NoMethod DisplayedProperty
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DoubleOperatorOptions) MarshalJSON() ([]byte, error) {
type NoMethod DoubleOperatorOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// DoublePropertyOptions: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *DoublePropertyOptions) MarshalJSON() ([]byte, error) {
type NoMethod DoublePropertyOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DoubleValues) MarshalJSON() ([]byte, error) {
type NoMethod DoubleValues
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DriveFollowUpRestrict) MarshalJSON() ([]byte, error) {
type NoMethod DriveFollowUpRestrict
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DriveLocationRestrict) MarshalJSON() ([]byte, error) {
type NoMethod DriveLocationRestrict
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DriveMimeTypeRestrict) MarshalJSON() ([]byte, error) {
type NoMethod DriveMimeTypeRestrict
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *DriveTimeSpanRestrict) MarshalJSON() ([]byte, error) {
type NoMethod DriveTimeSpanRestrict
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// EmailAddress: A person's email address.
type EmailAddress struct {
// EmailAddress: The email address.
EmailAddress string `json:"emailAddress,omitempty"`
// ForceSendFields is a list of field names (e.g. "EmailAddress") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "EmailAddress") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *EmailAddress) MarshalJSON() ([]byte, error) {
type NoMethod EmailAddress
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *EnumOperatorOptions) MarshalJSON() ([]byte, error) {
type NoMethod EnumOperatorOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// EnumPropertyOptions: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *EnumPropertyOptions) MarshalJSON() ([]byte, error) {
type NoMethod EnumPropertyOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *EnumValuePair) MarshalJSON() ([]byte, error) {
type NoMethod EnumValuePair
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *EnumValues) MarshalJSON() ([]byte, error) {
type NoMethod EnumValues
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ErrorInfo) MarshalJSON() ([]byte, error) {
type NoMethod ErrorInfo
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ErrorMessage) MarshalJSON() ([]byte, error) {
type NoMethod ErrorMessage
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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. Can be empty.
Count int64 `json:"count,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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FacetBucket) MarshalJSON() ([]byte, error) {
type NoMethod FacetBucket
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 {
// 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: 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. "NumFacetBuckets") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "NumFacetBuckets") to
// include in API requests with the JSON null value. By default, fields
// with empty values are omitted from API requests. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *FacetOptions) MarshalJSON() ([]byte, error) {
type NoMethod FacetOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// FacetResult: Source specific facet response
type FacetResult struct {
// Buckets: FacetBuckets for values in response containing at least a
// single result.
Buckets []*FacetBucket `json:"buckets,omitempty"`
// ObjectType: Object type for which facet results are returned. Can be
// empty.
ObjectType string `json:"objectType,omitempty"`
// OperatorName: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FacetResult) MarshalJSON() ([]byte, error) {
type NoMethod FacetResult
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type FieldViolation struct {
// Description: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FieldViolation) MarshalJSON() ([]byte, error) {
type NoMethod FieldViolation
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *Filter) MarshalJSON() ([]byte, error) {
type NoMethod Filter
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *FilterOptions) MarshalJSON() ([]byte, error) {
type NoMethod FilterOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *FreshnessOptions) MarshalJSON() ([]byte, error) {
type NoMethod FreshnessOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type GSuitePrincipal struct {
// GsuiteDomain: This principal represents all users of the G Suite
// domain of the customer.
GsuiteDomain bool `json:"gsuiteDomain,omitempty"`
// GsuiteGroupEmail: This principal references a G Suite group account
GsuiteGroupEmail string `json:"gsuiteGroupEmail,omitempty"`
// GsuiteUserEmail: This principal references a G Suite 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GSuitePrincipal) MarshalJSON() ([]byte, error) {
type NoMethod GSuitePrincipal
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type GetCustomerIndexStatsResponse struct {
// 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. "Stats") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetCustomerIndexStatsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetCustomerIndexStatsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type GetCustomerQueryStatsResponse struct {
Stats []*CustomerQueryStats `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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetCustomerQueryStatsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetCustomerQueryStatsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetCustomerSessionStatsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetCustomerSessionStatsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetCustomerUserStatsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetCustomerUserStatsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type GetDataSourceIndexStatsResponse struct {
// 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. "Stats") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetDataSourceIndexStatsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetDataSourceIndexStatsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type GetSearchApplicationQueryStatsResponse struct {
Stats []*SearchApplicationQueryStats `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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetSearchApplicationQueryStatsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetSearchApplicationQueryStatsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetSearchApplicationSessionStatsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetSearchApplicationSessionStatsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *GetSearchApplicationUserStatsResponse) MarshalJSON() ([]byte, error) {
type NoMethod GetSearchApplicationUserStatsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *HtmlOperatorOptions) MarshalJSON() ([]byte, error) {
type NoMethod HtmlOperatorOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// HtmlPropertyOptions: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *HtmlPropertyOptions) MarshalJSON() ([]byte, error) {
type NoMethod HtmlPropertyOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *HtmlValues) MarshalJSON() ([]byte, error) {
type NoMethod HtmlValues
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type IndexItemOptions struct {
// AllowUnknownGsuitePrincipals: Specifies if the index request should
// allow gsuite principals that do not exist or are deleted in the index
// request.
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 values are omitted from API
// requests. However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
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. However, any field with an empty value appearing
// in NullFields will be sent to the server as null. It is an error if a
// field in this list has a non-empty value. This may be used to include
// null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *IndexItemOptions) MarshalJSON() ([]byte, error) {
type NoMethod IndexItemOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type IndexItemRequest struct {
// ConnectorName: 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: 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" - 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *IndexItemRequest) MarshalJSON() ([]byte, error) {
type NoMethod IndexItemRequest
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API
// requests. However, any non-pointer, non-interface field appearing in
// ForceSendFields will be sent to the server regardless of whether the
// field is empty or not. This may be used to include empty fields in
// Patch requests.
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. However, any
// field with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *IntegerOperatorOptions) MarshalJSON() ([]byte, error) {
type NoMethod IntegerOperatorOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// IntegerPropertyOptions: Options for integer properties.
type IntegerPropertyOptions struct {
// 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. "MaximumValue") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
ForceSendFields []string `json:"-"`
// NullFields is a list of field names (e.g. "MaximumValue") to include
// in API requests with the JSON null value. By default, fields with
// empty values are omitted from API requests. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *IntegerPropertyOptions) MarshalJSON() ([]byte, error) {
type NoMethod IntegerPropertyOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *IntegerValues) MarshalJSON() ([]byte, error) {
type NoMethod IntegerValues
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *Interaction) MarshalJSON() ([]byte, error) {
type NoMethod Interaction
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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: 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: Metadata information.
Metadata *ItemMetadata `json:"metadata,omitempty"`
// Name: 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.
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Item) MarshalJSON() ([]byte, error) {
type NoMethod Item
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ItemAcl: Access control list information for the item. For more
// information see [Map ACLs](/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: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *ItemAcl) MarshalJSON() ([]byte, error) {
type NoMethod ItemAcl
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ItemContent: Content of an item to be indexed and surfaced by Cloud
// Search.
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field
// with an empty value appearing in NullFields will be sent to the
// server as null. It is an error if a field in this list has a
// non-empty value. This may be used to include null fields in Patch
// requests.
NullFields []string `json:"-"`
}
func (s *ItemContent) MarshalJSON() ([]byte, error) {
type NoMethod ItemContent
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
type ItemCountByStatus struct {
// Count: Number of items matching the status code.
Count int64 `json:"count,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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ItemCountByStatus) MarshalJSON() ([]byte, error) {
type NoMethod ItemCountByStatus
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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"`
// 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.
// Search results apply this link to the title. Whitespace or special
// characters may cause Cloud Search 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ItemMetadata) MarshalJSON() ([]byte, error) {
type NoMethod ItemMetadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ItemStatus) MarshalJSON() ([]byte, error) {
type NoMethod ItemStatus
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ItemStructuredData) MarshalJSON() ([]byte, error) {
type NoMethod ItemStructuredData
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListDataSourceResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListDataSourceResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListItemNamesForUnmappedIdentityResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListItemNamesForUnmappedIdentityResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListItemsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListItemsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListOperationsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListQuerySourcesResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListQuerySourcesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListSearchApplicationsResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListSearchApplicationsResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ListUnmappedIdentitiesResponse) MarshalJSON() ([]byte, error) {
type NoMethod ListUnmappedIdentitiesResponse
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *MatchRange) MarshalJSON() ([]byte, error) {
type NoMethod MatchRange
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Media) MarshalJSON() ([]byte, error) {
type NoMethod Media
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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"`
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Metadata) MarshalJSON() ([]byte, error) {
type NoMethod Metadata
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Metaline) MarshalJSON() ([]byte, error) {
type NoMethod Metaline
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *Name) MarshalJSON() ([]byte, error) {
type NoMethod Name
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with
// an empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *NamedProperty) MarshalJSON() ([]byte, error) {
type NoMethod NamedProperty
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ObjectDefinition: The definition for an object within a data source.
type ObjectDefinition struct {
// Name: 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ObjectDefinition) MarshalJSON() ([]byte, error) {
type NoMethod ObjectDefinition
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// 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 values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field with an
// empty value appearing in NullFields will be sent to the server as
// null. It is an error if a field in this list has a non-empty value.
// This may be used to include null fields in Patch requests.
NullFields []string `json:"-"`
}
func (s *ObjectDisplayOptions) MarshalJSON() ([]byte, error) {
type NoMethod ObjectDisplayOptions
raw := NoMethod(*s)
return gensupport.MarshalJSON(raw, s.ForceSendFields, s.NullFields)
}
// ObjectOptions: The options for an object.
type ObjectOptions struct {
// DisplayOptions: 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"`
// ForceSendFields is a list of field names (e.g. "DisplayOptions") to
// unconditionally include in API requests. By default, fields with
// empty values are omitted from API requests. However, any non-pointer,
// non-interface field appearing in ForceSendFields will be sent to the
// server regardless of whether the field is empty or not. This may be
// used to include empty fields in Patch requests.
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. However, any field