Blame - docs/dyn/cloudsearch_v1.indexing.datasources.html - platform/external/python/google-api-python-client

2020-05-01 07:42:23 -0700

[diff] [blame]

89

<code><a href="#updateSchema">updateSchema(name, body=None, x__xgafv=None)</a></code></p>

90

<p class="firstline">Updates the schema of a data source. This method does not perform</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

91

<h3>Method Details</h3>

92

93

<code class="details" id="deleteSchema">deleteSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>

94

<pre>Deletes the schema of a data source.

95

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

96

**Note:** This API requires an admin or service account to execute.

97

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

98

Args:

99

100

datasources/{source_id} (required)

101

debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.

102

Otherwise, ignore this field.

103

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

110

111

{ # This resource represents a long-running operation that is the result of a

112

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

113

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

114

# If `true`, the operation is completed, and either `error` or `response` is

115

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

116

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

117

# method returns no data on success, such as `Delete`, the response is

118

# `google.protobuf.Empty`. If the original method is standard

119

# `Get`/`Create`/`Update`, the response should be the resource. For other

120

# methods, the response should have the type `XxxResponse`, where `Xxx`

121

# is the original method name. For example, if the original method name

122

# is `TakeSnapshot()`, the inferred response type is

123

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

124

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

125

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

126

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

127

# originally returns it. If you use the default HTTP mapping, the

128

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

129

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

130

# different programming environments, including REST APIs and RPC APIs. It is

131

# used by [gRPC](https://github.com/grpc). Each `Status` message contains

132

# three pieces of data: error code, error message, and error details.

133

#

134

# You can find out more about this error model and how to work with it in the

135

# [API Design Guide](https://cloud.google.com/apis/design/errors).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

136

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

137

# message types for APIs to use.

138

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

139

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

140

},

141

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

142

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

143

"message": "A String", # A developer-facing error message, which should be in English. Any

144

# user-facing error message should be localized and sent in the

145

# google.rpc.Status.details field, or localized by the client.

146

},

147

"metadata": { # Service-specific metadata associated with the operation. It typically

148

# contains progress information and common metadata such as create time.

149

# Some services might not provide such metadata. Any method that returns a

150

# long-running operation should document the metadata type, if any.

151

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

152

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="getSchema">getSchema(name, debugOptions_enableDebugging=None, x__xgafv=None)</code>

158

<pre>Gets the schema of a data source.

159

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

160

**Note:** This API requires an admin or service account to execute.

161

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

162

Args:

163

164

datasources/{source_id} (required)

165

debugOptions_enableDebugging: boolean, If you are asked by Google to help with debugging, set this field.

166

Otherwise, ignore this field.

167

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

174

175

{ # The schema definition for a data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

176

"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this

177

# schema. After modifying the schema, wait for operations to complete

178

# before indexing additional content.

179

"A String",

180

],

181

"objectDefinitions": [ # The list of top-level objects for the data source.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

182

# The maximum number of elements is 10.

183

{ # The definition for an object within a data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

184

"propertyDefinitions": [ # The property definitions for the object.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

185

# The maximum number of elements is 1000.

186

{ # The definition of a property within an object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

187

"enumPropertyOptions": { # Options for enum properties, which allow you to define a restricted set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

188

# strings to match user queries, set rankings for those string values, and

189

# define an operator name to be paired with those strings so that users can

190

# narrow results to only items with a specific value. For example, for items in

191

# a request tracking system with priority information, you could define *p0* as

192

# an allowable enum value and tie this enum to the operator name *priority* so

193

# that search users could add *priority:p0* to their query to restrict the set

194

# of results to only those items indexed with the value *p0*.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

195

"orderedRanking": "A String", # Used to specify the ordered ranking for the enumeration that determines how

196

# the integer values provided in the possible EnumValuePairs are used to rank

197

# results. If specified, integer values must be provided for all possible

198

# EnumValuePair values given for this property. Can only be used if

199

# isRepeatable

200

# is false.

201

"operatorOptions": { # Used to provide a search operator for enum properties. This is # If set, describes how the enum should be used as a search operator.

202

# optional. Search operators let users restrict the query to specific fields

203

# relevant to the type of item being searched. For example, if you provide no

204

# operator for a *priority* enum property with possible values *p0* and *p1*,

205

# a query that contains the term *p0* returns items that have *p0* as the

206

# value of the *priority* property, as well as any items that contain the

207

# string *p0* in other fields. If you provide an operator name for the enum,

208

# such as *priority*, then search users can use that operator to refine

209

# results to only items that have *p0* as this property's value, with the

210

# query *priority:p0*.

211

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

212

# enum property. For example, if operatorName is *priority* and the

213

# property's name is *priorityVal*, then queries like

214

# *priority:&lt;value&gt;* show results only where the value of the

215

# property named *priorityVal* matches *&lt;value&gt;*. By contrast, a

216

# search that uses the same *&lt;value&gt;* without an operator returns

217

# all items where *&lt;value&gt;* matches the value of any String

218

# properties or text within the content field for the item.

219

# The operator name can only contain lowercase letters (a-z).

220

# The maximum length is 32 characters.

221

},

222

"possibleValues": [ # The list of possible values for the enumeration property. All

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

223

# EnumValuePairs must provide a string value. If you specify an integer value

224

# for one EnumValuePair, then all possible EnumValuePairs must provide an

225

# integer value. Both the string value and integer value must be unique over

226

# all possible values. Once set, possible values cannot be removed or

227

# modified. If you supply an ordered ranking and think you might insert

228

# additional enum values in the future, leave gaps in the initial integer

229

# values to allow adding a value in between previously registered values.

230

# The maximum number of elements is 100.

231

{ # The enumeration value pair defines two things: a required string value and

232

# an optional integer value. The string value defines the necessary query

233

# term required to retrieve that item, such as *p0* for a priority item.

234

# The integer value determines the ranking of that string value relative

235

# to other enumerated values for the same property. For example, you might

236

# associate *p0* with *0* and define another enum pair such as *p1* and *1*.

237

# You must use the integer value in combination with

238

# ordered

239

# ranking to

240

# set the ranking of a given value relative to other enumerated values for

241

# the same property name. Here, a ranking order of DESCENDING for *priority*

242

# properties results in a ranking boost for items indexed with a value of

243

# *p0* compared to items indexed with a value of *p1*. Without a specified

244

# ranking order, the integer value has no effect on item ranking.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

245

"integerValue": 42, # The integer value of the EnumValuePair which must be non-negative.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

246

# Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

247

"stringValue": "A String", # The string value of the EnumValuePair.

248

# The maximum length is 32 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

249

},

250

],

251

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

252

"displayOptions": { # The display options for a property. # Options that determine how the property is displayed in the Cloud Search

253

# results page if it is specified to be displayed in the object's

254

# display options

255

# .

256

"displayLabel": "A String", # The user friendly label for the property that is used if the property

257

# is specified to be displayed in ObjectDisplayOptions. If provided, the

258

# display label is shown in front of the property values when the property is

259

# part of the object display options. For example, if the property value is

260

# '1', the value by itself may not be useful context for the user. If the

261

# display name given was 'priority', then the user sees 'priority : 1' in

262

# the search results which provides clear context to search users. This is

263

# OPTIONAL; if not given, only the property values are displayed.

264

# The maximum length is 64 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

265

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

266

"datePropertyOptions": { # Options for date properties.

267

"operatorOptions": { # Optional. Provides a search operator for date properties. # If set, describes how the date should be used as a search operator.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

268

# Search operators let users restrict the query to specific fields relevant

269

# to the type of item being searched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

270

"operatorName": "A String", # Indicates the actual string required in the query in order to isolate the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

271

# date property. For example, suppose an issue tracking schema object

272

# has a property named *closeDate* that specifies an operator with an

273

# operatorName of *closedon*. For searches on that data, queries like

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

274

# *closedon:&lt;value&gt;* show results only where the value of the

275

# *closeDate* property matches *&lt;value&gt;*. By contrast, a

276

# search that uses the same *&lt;value&gt;* without an operator returns

277

# all items where *&lt;value&gt;* matches the value of any String

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

278

# properties or text within the content field for the indexed datasource.

279

# The operator name can only contain lowercase letters (a-z).

280

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

281

"greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

282

# date property using the greater-than operator. For example, if

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

283

# greaterThanOperatorName is *closedafter* and the property's name is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

284

# *closeDate*, then queries like *closedafter:&lt;value&gt;*

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

285

# show results only where the value of the property named *closeDate* is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

286

# later than *&lt;value&gt;*.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

287

# The operator name can only contain lowercase letters (a-z).

288

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

289

"lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

290

# date property using the less-than operator. For example, if

291

# lessThanOperatorName is *closedbefore* and the property's name is

292

# *closeDate*, then queries like *closedbefore:&lt;value&gt;*

293

# show results only where the value of the property named *closeDate* is

294

# earlier than *&lt;value&gt;*.

295

# The operator name can only contain lowercase letters (a-z).

296

# The maximum length is 32 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

297

},

298

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

299

"isFacetable": True or False, # Indicates that the property can be used for generating facets. Cannot be

300

# true for properties whose type is object. IsReturnable must be true to set

301

# this option.

302

# Only supported for Boolean, Enum, and Text properties.

303

"isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

304

# properties that are repeatable. Cannot be true for properties whose type

305

# is object or user identifier. IsReturnable must be true to set this option.

306

# Only supported for Boolean, Date, Double, Integer, and Timestamp

307

# properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

308

"isReturnable": True or False, # Indicates that the property identifies data that should be returned in

309

# search results via the Query API. If set to *true*, indicates that Query

310

# API users can use matching property fields in results. However, storing

311

# fields requires more space allocation and uses more bandwidth for search

312

# queries, which impacts performance over large datasets. Set to *true* here

313

# only if the field is needed for search results. Cannot be true for

314

# properties whose type is an object.

315

"name": "A String", # The name of the property. Item indexing requests sent to the Indexing API

316

# should set the property name

317

# equal to this value. For example, if name is *subject_line*, then indexing

318

# requests for document items with subject fields should set the

319

# name for that field equal to

320

# *subject_line*. Use the name as the identifier for the object property.

321

# Once registered as a property for an object, you cannot re-use this name

322

# for another property within that object.

323

# The name must start with a letter and can only contain letters (A-Z, a-z)

324

# or numbers (0-9).

325

# The maximum length is 256 characters.

326

"booleanPropertyOptions": { # Options for boolean properties.

327

"operatorOptions": { # Used to provide a search operator for boolean properties. This is # If set, describes how the boolean should be used as a search operator.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

328

# optional. Search operators let users restrict the query to specific fields

329

# relevant to the type of item being searched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

330

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

331

# boolean property. For example, if operatorName is *closed* and the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

332

# property's name is *isClosed*, then queries like

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

333

# *closed:&lt;value&gt;* show results only where the value of the

334

# property named *isClosed* matches *&lt;value&gt;*. By contrast, a

335

# search that uses the same *&lt;value&gt;* without an operator returns

336

# all items where *&lt;value&gt;* matches the value of any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

337

# String properties or text within the content field for the item.

338

# The operator name can only contain lowercase letters (a-z).

339

# The maximum length is 32 characters.

340

},

341

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

342

"timestampPropertyOptions": { # Options for timestamp properties.

343

"operatorOptions": { # Used to provide a search operator for timestamp properties. This is # If set, describes how the timestamp should be used as a search operator.

344

# optional. Search operators let users restrict the query to specific fields

345

# relevant to the type of item being searched.

346

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

347

# timestamp property. For example, if operatorName is *closedon* and the

348

# property's name is *closeDate*, then queries like

349

# *closedon:&lt;value&gt;* show results only where the value of the

350

# property named *closeDate* matches *&lt;value&gt;*. By contrast, a

351

# search that uses the same *&lt;value&gt;* without an operator returns

352

# all items where *&lt;value&gt;* matches the value of any String

353

# properties or text within the content field for the item. The operator

354

# name can only contain lowercase letters (a-z). The maximum length is 32

355

# characters.

356

"greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

357

# timestamp property using the greater-than operator. For example, if

358

# greaterThanOperatorName is *closedafter* and the property's name is

359

# *closeDate*, then queries like *closedafter:&lt;value&gt;*

360

# show results only where the value of the property named *closeDate* is

361

# later than *&lt;value&gt;*.

362

# The operator name can only contain lowercase letters (a-z).

363

# The maximum length is 32 characters.

364

"lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

365

# timestamp property using the less-than operator. For example, if

366

# lessThanOperatorName is *closedbefore* and the property's name is

367

# *closeDate*, then queries like *closedbefore:&lt;value&gt;*

368

# show results only where the value of the property named *closeDate* is

369

# earlier than *&lt;value&gt;*.

370

# The operator name can only contain lowercase letters (a-z).

371

# The maximum length is 32 characters.

372

},

373

},

374

"doublePropertyOptions": { # Options for double properties.

375

"operatorOptions": { # Used to provide a search operator for double properties. This is # If set, describes how the double should be used as a search operator.

376

# optional. Search operators let users restrict the query to specific fields

377

# relevant to the type of item being searched.

378

"operatorName": "A String", # Indicates the operator name required in the query in order to use the

379

# double property in sorting or as a facet.

380

# The operator name can only contain lowercase letters (a-z).

381

# The maximum length is 32 characters.

382

},

383

},

384

"textPropertyOptions": { # Options for text properties.

385

"operatorOptions": { # Used to provide a search operator for text properties. This is optional. # If set, describes how the property should be used as a search operator.

386

# Search operators let users restrict the query to specific fields relevant

387

# to the type of item being searched.

388

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

389

# text property. For example, if operatorName is *subject* and the

390

# property's name is *subjectLine*, then queries like

391

# *subject:&lt;value&gt;* show results only where the value of the

392

# property named *subjectLine* matches *&lt;value&gt;*. By contrast, a

393

# search that uses the same *&lt;value&gt;* without an operator returns

394

# all items where *&lt;value&gt;* matches the value of any

395

# text properties or text within the content field for the item.

396

# The operator name can only contain lowercase letters (a-z).

397

# The maximum length is 32 characters.

398

"exactMatchWithOperator": True or False, # If true, the text value is tokenized as one atomic value in

399

# operator searches and facet matches. For example, if the operator name is

400

# "genre" and the value is "science-fiction" the query restrictions

401

# "genre:science" and "genre:fiction" doesn't match the item;

402

# "genre:science-fiction" does. Value matching is case-sensitive

403

# and does not remove special characters.

404

# If false, the text is tokenized. For example, if the value is

405

# "science-fiction" the queries "genre:science" and "genre:fiction"

406

# matches the item.

407

},

408

"retrievalImportance": { # Indicates the search quality importance of the tokens within the

409

# field when used for retrieval.

410

"importance": "A String", # Indicates the ranking importance given to property when it is matched

411

# during retrieval. Once set, the token importance of a property cannot be

# changed.

},

},

"isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this

416

# property. Only supported for Text properties. IsReturnable must be true to

417

# set this option. In a given datasource maximum of 5 properties can be

418

# marked as is_wildcard_searchable.

419

"isRepeatable": True or False, # Indicates that multiple values are allowed for the property. For example, a

420

# document only has one description but can have multiple comments. Cannot be

421

# true for properties whose type is a boolean.

422

# If set to false, properties that contain more than one value cause the

423

# indexing request for that item to be rejected.

424

"objectPropertyOptions": { # Options for object properties.

425

"subobjectProperties": [ # The properties of the sub-object. These properties represent a nested

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

426

# object. For example, if this property represents a postal address, the

427

# subobjectProperties might be named *street*, *city*, and *state*.

428

# The maximum number of elements is 1000.

429

# Object with schema name: PropertyDefinition

430

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

431

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

432

"isSuggestable": True or False, # Indicates that the property can be used for generating query suggestions.

433

"htmlPropertyOptions": { # Options for html properties.

434

"retrievalImportance": { # Indicates the search quality importance of the tokens within the

435

# field when used for retrieval. Can only be set to DEFAULT or NONE.

436

"importance": "A String", # Indicates the ranking importance given to property when it is matched

437

# during retrieval. Once set, the token importance of a property cannot be

438

# changed.

439

},

440

"operatorOptions": { # Used to provide a search operator for html properties. This is optional. # If set, describes how the property should be used as a search operator.

441

# Search operators let users restrict the query to specific fields relevant

442

# to the type of item being searched.

443

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

444

# html property. For example, if operatorName is *subject* and the

445

# property's name is *subjectLine*, then queries like

446

# *subject:&lt;value&gt;* show results only where the value of the

447

# property named *subjectLine* matches *&lt;value&gt;*. By contrast, a

448

# search that uses the same *&lt;value&gt;* without an operator return

449

# all items where *&lt;value&gt;* matches the value of any

450

# html properties or text within the content field for the item.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

451

# The operator name can only contain lowercase letters (a-z).

452

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

453

},

454

},

455

"integerPropertyOptions": { # Options for integer properties.

456

"orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if

457

# isRepeatable

458

# is false.

459

"maximumValue": "A String", # The maximum value of the property. The minimum and maximum values for the

460

# property are used to rank results according to the

461

# ordered ranking.

462

# Indexing requests with values greater than the maximum are accepted and

463

# ranked with the same weight as items indexed with the maximum value.

464

"operatorOptions": { # Used to provide a search operator for integer properties. This is # If set, describes how the integer should be used as a search operator.

465

# optional. Search operators let users restrict the query to specific fields

466

# relevant to the type of item being searched.

467

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

468

# integer property. For example, if operatorName is *priority* and the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

469

# property's name is *priorityVal*, then queries like

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

470

# *priority:&lt;value&gt;* show results only where the value of the

471

# property named *priorityVal* matches *&lt;value&gt;*. By contrast, a

472

# search that uses the same *&lt;value&gt;* without an operator returns

473

# all items where *&lt;value&gt;* matches the value of any String

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

474

# properties or text within the content field for the item.

475

# The operator name can only contain lowercase letters (a-z).

476

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

477

"greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

478

# integer property using the greater-than operator. For example, if

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

479

# greaterThanOperatorName is *priorityabove* and the property's name is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

480

# *priorityVal*, then queries like *priorityabove:&lt;value&gt;*

481

# show results only where the value of the property named *priorityVal* is

482

# greater than *&lt;value&gt;*.

483

# The operator name can only contain lowercase letters (a-z).

484

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

485

"lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

486

# integer property using the less-than operator. For example, if

487

# lessThanOperatorName is *prioritybelow* and the property's name is

488

# *priorityVal*, then queries like *prioritybelow:&lt;value&gt;*

489

# show results only where the value of the property named *priorityVal* is

490

# less than *&lt;value&gt;*.

491

# The operator name can only contain lowercase letters (a-z).

492

# The maximum length is 32 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

493

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

494

"minimumValue": "A String", # The minimum value of the property. The minimum and maximum values for the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

495

# property are used to rank results according to the

496

# ordered ranking.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

497

# Indexing requests with values less than the minimum are accepted and

498

# ranked with the same weight as items indexed with the minimum value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

499

},

500

},

501

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

502

"name": "A String", # Name for the object, which then defines its type. Item indexing requests

503

# should set the

504

# objectType field

505

# equal to this value. For example, if *name* is *Document*, then indexing

506

# requests for items of type Document should set

507

# objectType equal to

508

# *Document*. Each object definition must be uniquely named within a schema.

509

# The name must start with a letter and can only contain letters (A-Z, a-z)

510

# or numbers (0-9).

511

# The maximum length is 256 characters.

512

"options": { # The options for an object. # The optional object-specific options.

513

"freshnessOptions": { # Indicates which freshness property to use when adjusting search ranking for # The freshness options for an object.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

514

# an item. Fresher, more recent dates indicate higher quality. Use the

515

# freshness option property that best works with your data. For fileshare

516

# documents, last modified time is most relevant. For calendar event data,

517

# the time when the event occurs is a more relevant freshness indicator. In

518

# this way, calendar events that occur closer to the time of the search query

519

# are considered higher quality and ranked accordingly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

520

"freshnessDuration": "A String", # The duration after which an object should be considered

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

521

# stale. The default value is 180 days (in seconds).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

522

"freshnessProperty": "A String", # This property indicates the freshness level of the object in the index.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

523

# If set, this property must be a top-level property within the

524

# property definitions

# and it must be a

# timestamp type

# or

# date type.

# Otherwise, the Indexing API uses

530

# updateTime

531

# as the freshness indicator.

532

# The maximum length is 256 characters.

533

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

534

# When a property is used to calculate freshness, the value defaults

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

535

# to 2 years from the current time.

536

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

537

"displayOptions": { # The display options for an object. # Options that determine how the object is displayed in the Cloud Search

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

538

# results page.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

539

"objectDisplayLabel": "A String", # The user friendly label to display in the search result to indicate the

540

# type of the item. This is OPTIONAL; if not provided, an object label isn't

541

# displayed on the context line of the search results. The maximum length

542

# is 64 characters.

543

"metalines": [ # Defines the properties that are displayed in the metalines of the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

544

# search results. The property values are displayed in the order given

545

# here. If a property holds multiple values, all of the values are

546

# displayed before the next properties. For this reason, it is a good

547

# practice to specify singular properties before repeated properties in this

548

# list. All of the properties must set

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

549

# is_returnable

550

# to true. The maximum number of metalines is 3.

551

{ # A metaline is a list of properties that are displayed along with the search

552

# result to provide context.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

553

"properties": [ # The list of displayed properties for the metaline. The maximum number of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

554

# properties is 5.

555

{ # A reference to a top-level property within the object that should be

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

556

# displayed in search results. The values of the chosen properties is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

557

# displayed in the search results along with the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

558

# display label

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

559

# for that property if one is specified. If a display label is not specified,

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

560

# only the values is shown.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

561

"propertyName": "A String", # The name of the top-level property as defined in a property definition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

562

# for the object. If the name is not a defined property in the schema, an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

563

# error is given when attempting to update the schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

},

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

576

<code class="details" id="updateSchema">updateSchema(name, body=None, x__xgafv=None)</code>

577

<pre>Updates the schema of a data source. This method does not perform

578

incremental updates to the schema. Instead, this method updates the schema

579

by overwriting the entire schema.

580

581

**Note:** This API requires an admin or service account to execute.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

Args:

datasources/{source_id} (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

586

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

587

The object takes the form of:

588

589

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

590

"schema": { # The schema definition for a data source. # The new schema for the source.

591

"operationIds": [ # IDs of the Long Running Operations (LROs) currently running for this

592

# schema. After modifying the schema, wait for operations to complete

593

# before indexing additional content.

594

"A String",

595

],

596

"objectDefinitions": [ # The list of top-level objects for the data source.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

597

# The maximum number of elements is 10.

598

{ # The definition for an object within a data source.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

599

"propertyDefinitions": [ # The property definitions for the object.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

600

# The maximum number of elements is 1000.

601

{ # The definition of a property within an object.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

602

"enumPropertyOptions": { # Options for enum properties, which allow you to define a restricted set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

603

# strings to match user queries, set rankings for those string values, and

604

# define an operator name to be paired with those strings so that users can

605

# narrow results to only items with a specific value. For example, for items in

606

# a request tracking system with priority information, you could define *p0* as

607

# an allowable enum value and tie this enum to the operator name *priority* so

608

# that search users could add *priority:p0* to their query to restrict the set

609

# of results to only those items indexed with the value *p0*.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

610

"orderedRanking": "A String", # Used to specify the ordered ranking for the enumeration that determines how

611

# the integer values provided in the possible EnumValuePairs are used to rank

612

# results. If specified, integer values must be provided for all possible

613

# EnumValuePair values given for this property. Can only be used if

614

# isRepeatable

615

# is false.

616

"operatorOptions": { # Used to provide a search operator for enum properties. This is # If set, describes how the enum should be used as a search operator.

617

# optional. Search operators let users restrict the query to specific fields

618

# relevant to the type of item being searched. For example, if you provide no

619

# operator for a *priority* enum property with possible values *p0* and *p1*,

620

# a query that contains the term *p0* returns items that have *p0* as the

621

# value of the *priority* property, as well as any items that contain the

622

# string *p0* in other fields. If you provide an operator name for the enum,

623

# such as *priority*, then search users can use that operator to refine

624

# results to only items that have *p0* as this property's value, with the

625

# query *priority:p0*.

626

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

627

# enum property. For example, if operatorName is *priority* and the

628

# property's name is *priorityVal*, then queries like

629

# *priority:&lt;value&gt;* show results only where the value of the

630

# property named *priorityVal* matches *&lt;value&gt;*. By contrast, a

631

# search that uses the same *&lt;value&gt;* without an operator returns

632

# all items where *&lt;value&gt;* matches the value of any String

633

# properties or text within the content field for the item.

634

# The operator name can only contain lowercase letters (a-z).

635

# The maximum length is 32 characters.

636

},

637

"possibleValues": [ # The list of possible values for the enumeration property. All

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

638

# EnumValuePairs must provide a string value. If you specify an integer value

639

# for one EnumValuePair, then all possible EnumValuePairs must provide an

640

# integer value. Both the string value and integer value must be unique over

641

# all possible values. Once set, possible values cannot be removed or

642

# modified. If you supply an ordered ranking and think you might insert

643

# additional enum values in the future, leave gaps in the initial integer

644

# values to allow adding a value in between previously registered values.

645

# The maximum number of elements is 100.

646

{ # The enumeration value pair defines two things: a required string value and

647

# an optional integer value. The string value defines the necessary query

648

# term required to retrieve that item, such as *p0* for a priority item.

649

# The integer value determines the ranking of that string value relative

650

# to other enumerated values for the same property. For example, you might

651

# associate *p0* with *0* and define another enum pair such as *p1* and *1*.

652

# You must use the integer value in combination with

653

# ordered

654

# ranking to

655

# set the ranking of a given value relative to other enumerated values for

656

# the same property name. Here, a ranking order of DESCENDING for *priority*

657

# properties results in a ranking boost for items indexed with a value of

658

# *p0* compared to items indexed with a value of *p1*. Without a specified

659

# ranking order, the integer value has no effect on item ranking.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

660

"integerValue": 42, # The integer value of the EnumValuePair which must be non-negative.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

661

# Optional.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

662

"stringValue": "A String", # The string value of the EnumValuePair.

663

# The maximum length is 32 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

664

},

665

],

666

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

667

"displayOptions": { # The display options for a property. # Options that determine how the property is displayed in the Cloud Search

668

# results page if it is specified to be displayed in the object's

669

# display options

670

# .

671

"displayLabel": "A String", # The user friendly label for the property that is used if the property

672

# is specified to be displayed in ObjectDisplayOptions. If provided, the

673

# display label is shown in front of the property values when the property is

674

# part of the object display options. For example, if the property value is

675

# '1', the value by itself may not be useful context for the user. If the

676

# display name given was 'priority', then the user sees 'priority : 1' in

677

# the search results which provides clear context to search users. This is

678

# OPTIONAL; if not given, only the property values are displayed.

679

# The maximum length is 64 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

680

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

681

"datePropertyOptions": { # Options for date properties.

682

"operatorOptions": { # Optional. Provides a search operator for date properties. # If set, describes how the date should be used as a search operator.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

683

# Search operators let users restrict the query to specific fields relevant

684

# to the type of item being searched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

685

"operatorName": "A String", # Indicates the actual string required in the query in order to isolate the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

686

# date property. For example, suppose an issue tracking schema object

687

# has a property named *closeDate* that specifies an operator with an

688

# operatorName of *closedon*. For searches on that data, queries like

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

689

# *closedon:&lt;value&gt;* show results only where the value of the

690

# *closeDate* property matches *&lt;value&gt;*. By contrast, a

691

# search that uses the same *&lt;value&gt;* without an operator returns

692

# all items where *&lt;value&gt;* matches the value of any String

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

693

# properties or text within the content field for the indexed datasource.

694

# The operator name can only contain lowercase letters (a-z).

695

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

696

"greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

697

# date property using the greater-than operator. For example, if

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

698

# greaterThanOperatorName is *closedafter* and the property's name is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

699

# *closeDate*, then queries like *closedafter:&lt;value&gt;*

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

700

# show results only where the value of the property named *closeDate* is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

701

# later than *&lt;value&gt;*.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

702

# The operator name can only contain lowercase letters (a-z).

703

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

704

"lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

705

# date property using the less-than operator. For example, if

706

# lessThanOperatorName is *closedbefore* and the property's name is

707

# *closeDate*, then queries like *closedbefore:&lt;value&gt;*

708

# show results only where the value of the property named *closeDate* is

709

# earlier than *&lt;value&gt;*.

710

# The operator name can only contain lowercase letters (a-z).

711

# The maximum length is 32 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

712

},

713

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

714

"isFacetable": True or False, # Indicates that the property can be used for generating facets. Cannot be

715

# true for properties whose type is object. IsReturnable must be true to set

716

# this option.

717

# Only supported for Boolean, Enum, and Text properties.

718

"isSortable": True or False, # Indicates that the property can be used for sorting. Cannot be true for

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

719

# properties that are repeatable. Cannot be true for properties whose type

720

# is object or user identifier. IsReturnable must be true to set this option.

721

# Only supported for Boolean, Date, Double, Integer, and Timestamp

722

# properties.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

723

"isReturnable": True or False, # Indicates that the property identifies data that should be returned in

724

# search results via the Query API. If set to *true*, indicates that Query

725

# API users can use matching property fields in results. However, storing

726

# fields requires more space allocation and uses more bandwidth for search

727

# queries, which impacts performance over large datasets. Set to *true* here

728

# only if the field is needed for search results. Cannot be true for

729

# properties whose type is an object.

730

"name": "A String", # The name of the property. Item indexing requests sent to the Indexing API

731

# should set the property name

732

# equal to this value. For example, if name is *subject_line*, then indexing

733

# requests for document items with subject fields should set the

734

# name for that field equal to

735

# *subject_line*. Use the name as the identifier for the object property.

736

# Once registered as a property for an object, you cannot re-use this name

737

# for another property within that object.

738

# The name must start with a letter and can only contain letters (A-Z, a-z)

739

# or numbers (0-9).

740

# The maximum length is 256 characters.

741

"booleanPropertyOptions": { # Options for boolean properties.

742

"operatorOptions": { # Used to provide a search operator for boolean properties. This is # If set, describes how the boolean should be used as a search operator.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

743

# optional. Search operators let users restrict the query to specific fields

744

# relevant to the type of item being searched.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

745

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

746

# boolean property. For example, if operatorName is *closed* and the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

747

# property's name is *isClosed*, then queries like

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

748

# *closed:&lt;value&gt;* show results only where the value of the

749

# property named *isClosed* matches *&lt;value&gt;*. By contrast, a

750

# search that uses the same *&lt;value&gt;* without an operator returns

751

# all items where *&lt;value&gt;* matches the value of any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

752

# String properties or text within the content field for the item.

753

# The operator name can only contain lowercase letters (a-z).

754

# The maximum length is 32 characters.

755

},

756

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

757

"timestampPropertyOptions": { # Options for timestamp properties.

758

"operatorOptions": { # Used to provide a search operator for timestamp properties. This is # If set, describes how the timestamp should be used as a search operator.

759

# optional. Search operators let users restrict the query to specific fields

760

# relevant to the type of item being searched.

761

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

762

# timestamp property. For example, if operatorName is *closedon* and the

763

# property's name is *closeDate*, then queries like

764

# *closedon:&lt;value&gt;* show results only where the value of the

765

# property named *closeDate* matches *&lt;value&gt;*. By contrast, a

766

# search that uses the same *&lt;value&gt;* without an operator returns

767

# all items where *&lt;value&gt;* matches the value of any String

768

# properties or text within the content field for the item. The operator

769

# name can only contain lowercase letters (a-z). The maximum length is 32

770

# characters.

771

"greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

772

# timestamp property using the greater-than operator. For example, if

773

# greaterThanOperatorName is *closedafter* and the property's name is

774

# *closeDate*, then queries like *closedafter:&lt;value&gt;*

775

# show results only where the value of the property named *closeDate* is

776

# later than *&lt;value&gt;*.

777

# The operator name can only contain lowercase letters (a-z).

778

# The maximum length is 32 characters.

779

"lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

780

# timestamp property using the less-than operator. For example, if

781

# lessThanOperatorName is *closedbefore* and the property's name is

782

# *closeDate*, then queries like *closedbefore:&lt;value&gt;*

783

# show results only where the value of the property named *closeDate* is

784

# earlier than *&lt;value&gt;*.

785

# The operator name can only contain lowercase letters (a-z).

786

# The maximum length is 32 characters.

787

},

788

},

789

"doublePropertyOptions": { # Options for double properties.

790

"operatorOptions": { # Used to provide a search operator for double properties. This is # If set, describes how the double should be used as a search operator.

791

# optional. Search operators let users restrict the query to specific fields

792

# relevant to the type of item being searched.

793

"operatorName": "A String", # Indicates the operator name required in the query in order to use the

794

# double property in sorting or as a facet.

795

# The operator name can only contain lowercase letters (a-z).

796

# The maximum length is 32 characters.

797

},

798

},

799

"textPropertyOptions": { # Options for text properties.

800

"operatorOptions": { # Used to provide a search operator for text properties. This is optional. # If set, describes how the property should be used as a search operator.

801

# Search operators let users restrict the query to specific fields relevant

802

# to the type of item being searched.

803

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

804

# text property. For example, if operatorName is *subject* and the

805

# property's name is *subjectLine*, then queries like

806

# *subject:&lt;value&gt;* show results only where the value of the

807

# property named *subjectLine* matches *&lt;value&gt;*. By contrast, a

808

# search that uses the same *&lt;value&gt;* without an operator returns

809

# all items where *&lt;value&gt;* matches the value of any

810

# text properties or text within the content field for the item.

811

# The operator name can only contain lowercase letters (a-z).

812

# The maximum length is 32 characters.

813

"exactMatchWithOperator": True or False, # If true, the text value is tokenized as one atomic value in

814

# operator searches and facet matches. For example, if the operator name is

815

# "genre" and the value is "science-fiction" the query restrictions

816

# "genre:science" and "genre:fiction" doesn't match the item;

817

# "genre:science-fiction" does. Value matching is case-sensitive

818

# and does not remove special characters.

819

# If false, the text is tokenized. For example, if the value is

820

# "science-fiction" the queries "genre:science" and "genre:fiction"

821

# matches the item.

822

},

823

"retrievalImportance": { # Indicates the search quality importance of the tokens within the

824

# field when used for retrieval.

825

"importance": "A String", # Indicates the ranking importance given to property when it is matched

826

# during retrieval. Once set, the token importance of a property cannot be

# changed.

},

},

"isWildcardSearchable": True or False, # Indicates that users can perform wildcard search for this

831

# property. Only supported for Text properties. IsReturnable must be true to

832

# set this option. In a given datasource maximum of 5 properties can be

833

# marked as is_wildcard_searchable.

834

"isRepeatable": True or False, # Indicates that multiple values are allowed for the property. For example, a

835

# document only has one description but can have multiple comments. Cannot be

836

# true for properties whose type is a boolean.

837

# If set to false, properties that contain more than one value cause the

838

# indexing request for that item to be rejected.

839

"objectPropertyOptions": { # Options for object properties.

840

"subobjectProperties": [ # The properties of the sub-object. These properties represent a nested

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

841

# object. For example, if this property represents a postal address, the

842

# subobjectProperties might be named *street*, *city*, and *state*.

843

# The maximum number of elements is 1000.

844

# Object with schema name: PropertyDefinition

845

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

846

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

847

"isSuggestable": True or False, # Indicates that the property can be used for generating query suggestions.

848

"htmlPropertyOptions": { # Options for html properties.

849

"retrievalImportance": { # Indicates the search quality importance of the tokens within the

850

# field when used for retrieval. Can only be set to DEFAULT or NONE.

851

"importance": "A String", # Indicates the ranking importance given to property when it is matched

852

# during retrieval. Once set, the token importance of a property cannot be

853

# changed.

854

},

855

"operatorOptions": { # Used to provide a search operator for html properties. This is optional. # If set, describes how the property should be used as a search operator.

856

# Search operators let users restrict the query to specific fields relevant

857

# to the type of item being searched.

858

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

859

# html property. For example, if operatorName is *subject* and the

860

# property's name is *subjectLine*, then queries like

861

# *subject:&lt;value&gt;* show results only where the value of the

862

# property named *subjectLine* matches *&lt;value&gt;*. By contrast, a

863

# search that uses the same *&lt;value&gt;* without an operator return

864

# all items where *&lt;value&gt;* matches the value of any

865

# html properties or text within the content field for the item.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

866

# The operator name can only contain lowercase letters (a-z).

867

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

868

},

869

},

870

"integerPropertyOptions": { # Options for integer properties.

871

"orderedRanking": "A String", # Used to specify the ordered ranking for the integer. Can only be used if

872

# isRepeatable

873

# is false.

874

"maximumValue": "A String", # The maximum value of the property. The minimum and maximum values for the

875

# property are used to rank results according to the

876

# ordered ranking.

877

# Indexing requests with values greater than the maximum are accepted and

878

# ranked with the same weight as items indexed with the maximum value.

879

"operatorOptions": { # Used to provide a search operator for integer properties. This is # If set, describes how the integer should be used as a search operator.

880

# optional. Search operators let users restrict the query to specific fields

881

# relevant to the type of item being searched.

882

"operatorName": "A String", # Indicates the operator name required in the query in order to isolate the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

883

# integer property. For example, if operatorName is *priority* and the

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

884

# property's name is *priorityVal*, then queries like

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

885

# *priority:&lt;value&gt;* show results only where the value of the

886

# property named *priorityVal* matches *&lt;value&gt;*. By contrast, a

887

# search that uses the same *&lt;value&gt;* without an operator returns

888

# all items where *&lt;value&gt;* matches the value of any String

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

889

# properties or text within the content field for the item.

890

# The operator name can only contain lowercase letters (a-z).

891

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

892

"greaterThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

893

# integer property using the greater-than operator. For example, if

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

894

# greaterThanOperatorName is *priorityabove* and the property's name is

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

895

# *priorityVal*, then queries like *priorityabove:&lt;value&gt;*

896

# show results only where the value of the property named *priorityVal* is

897

# greater than *&lt;value&gt;*.

898

# The operator name can only contain lowercase letters (a-z).

899

# The maximum length is 32 characters.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

900

"lessThanOperatorName": "A String", # Indicates the operator name required in the query in order to isolate the

901

# integer property using the less-than operator. For example, if

902

# lessThanOperatorName is *prioritybelow* and the property's name is

903

# *priorityVal*, then queries like *prioritybelow:&lt;value&gt;*

904

# show results only where the value of the property named *priorityVal* is

905

# less than *&lt;value&gt;*.

906

# The operator name can only contain lowercase letters (a-z).

907

# The maximum length is 32 characters.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

908

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

909

"minimumValue": "A String", # The minimum value of the property. The minimum and maximum values for the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

910

# property are used to rank results according to the

911

# ordered ranking.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

912

# Indexing requests with values less than the minimum are accepted and

913

# ranked with the same weight as items indexed with the minimum value.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

914

},

915

},

916

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

917

"name": "A String", # Name for the object, which then defines its type. Item indexing requests

918

# should set the

919

# objectType field

920

# equal to this value. For example, if *name* is *Document*, then indexing

921

# requests for items of type Document should set

922

# objectType equal to

923

# *Document*. Each object definition must be uniquely named within a schema.

924

# The name must start with a letter and can only contain letters (A-Z, a-z)

925

# or numbers (0-9).

926

# The maximum length is 256 characters.

927

"options": { # The options for an object. # The optional object-specific options.

928

"freshnessOptions": { # Indicates which freshness property to use when adjusting search ranking for # The freshness options for an object.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

929

# an item. Fresher, more recent dates indicate higher quality. Use the

930

# freshness option property that best works with your data. For fileshare

931

# documents, last modified time is most relevant. For calendar event data,

932

# the time when the event occurs is a more relevant freshness indicator. In

933

# this way, calendar events that occur closer to the time of the search query

934

# are considered higher quality and ranked accordingly.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

935

"freshnessDuration": "A String", # The duration after which an object should be considered

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

936

# stale. The default value is 180 days (in seconds).

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

937

"freshnessProperty": "A String", # This property indicates the freshness level of the object in the index.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

938

# If set, this property must be a top-level property within the

939

# property definitions

# and it must be a

# timestamp type

# or

# date type.

# Otherwise, the Indexing API uses

945

# updateTime

946

# as the freshness indicator.

947

# The maximum length is 256 characters.

948

#

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

949

# When a property is used to calculate freshness, the value defaults

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

950

# to 2 years from the current time.

951

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

952

"displayOptions": { # The display options for an object. # Options that determine how the object is displayed in the Cloud Search

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

953

# results page.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

954

"objectDisplayLabel": "A String", # The user friendly label to display in the search result to indicate the

955

# type of the item. This is OPTIONAL; if not provided, an object label isn't

956

# displayed on the context line of the search results. The maximum length

957

# is 64 characters.

958

"metalines": [ # Defines the properties that are displayed in the metalines of the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

959

# search results. The property values are displayed in the order given

960

# here. If a property holds multiple values, all of the values are

961

# displayed before the next properties. For this reason, it is a good

962

# practice to specify singular properties before repeated properties in this

963

# list. All of the properties must set

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

964

# is_returnable

965

# to true. The maximum number of metalines is 3.

966

{ # A metaline is a list of properties that are displayed along with the search

967

# result to provide context.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

968

"properties": [ # The list of displayed properties for the metaline. The maximum number of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

969

# properties is 5.

970

{ # A reference to a top-level property within the object that should be

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

971

# displayed in search results. The values of the chosen properties is

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

972

# displayed in the search results along with the

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

973

# display label

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

974

# for that property if one is specified. If a display label is not specified,

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

975

# only the values is shown.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

976

"propertyName": "A String", # The name of the top-level property as defined in a property definition

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

977

# for the object. If the name is not a defined property in the schema, an

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

978

# error is given when attempting to update the schema.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

},

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

},

},

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

987

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

988

"debugOptions": { # Shared request debug options for all cloudsearch RPC methods. # Common debug options.

989

"enableDebugging": True or False, # If you are asked by Google to help with debugging, set this field.

990

# Otherwise, ignore this field.

991

},

992

"validateOnly": True or False, # If true, the schema will be checked for validity,

993

# but will not be registered with the data source, even if valid.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

994

}

995

996

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1003

1004

{ # This resource represents a long-running operation that is the result of a

1005

# network API call.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1006

"done": True or False, # If the value is `false`, it means the operation is still in progress.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1007

# If `true`, the operation is completed, and either `error` or `response` is

1008

# available.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1009

"response": { # The normal response of the operation in case of success. If the original

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1010

# method returns no data on success, such as `Delete`, the response is

1011

# `google.protobuf.Empty`. If the original method is standard

1012

# `Get`/`Create`/`Update`, the response should be the resource. For other

1013

# methods, the response should have the type `XxxResponse`, where `Xxx`

1014

# is the original method name. For example, if the original method name

1015

# is `TakeSnapshot()`, the inferred response type is

1016

# `TakeSnapshotResponse`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1017

"a_key": "", # Properties of the object. Contains field @type with type URL.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1018

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1019

"name": "A String", # The server-assigned name, which is only unique within the same service that

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

1020

# originally returns it. If you use the default HTTP mapping, the

1021

# `name` should be a resource name ending with `operations/{unique_id}`.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

1022

"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.

Bu Sun Kim