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

"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]

114

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

115

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

116

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

117

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

118

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

119

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

120

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

121

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

Dan O'Meara

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

[diff] [blame]

122

},

Bu Sun Kim

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

[diff] [blame]

123

"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]

124

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

125

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

Bu Sun Kim

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

[diff] [blame]

126

"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]

127

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

128

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

129

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

130

#

131

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

132

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

Bu Sun Kim

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

[diff] [blame]

133

"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]

134

# message types for APIs to use.

135

{

Bu Sun Kim

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

[diff] [blame]

136

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

Bu Sun Kim

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

[diff] [blame]

137

},

138

],

Bu Sun Kim

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

[diff] [blame]

139

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

140

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

141

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

142

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

143

},

144

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

145

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

146

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

147

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

148

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

Bu Sun Kim

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

[diff] [blame]

149

},

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

150

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

151

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

152

# available.

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-27 12:20:54 -0700

[diff] [blame^]

184

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

185

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

186

# results page.

187

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

188

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

189

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

190

# is 64 characters.

191

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

192

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

193

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

194

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

195

# practice to specify singular properties before repeated properties in this

196

# list. All of the properties must set

197

# is_returnable

198

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

199

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

200

# result to provide context.

201

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

202

# properties is 5.

203

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

204

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

205

# displayed in the search results along with the

206

# display label

207

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

208

# only the values is shown.

209

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

210

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

211

# error is given when attempting to update the schema.

},

],

},

],

},

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

218

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

219

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

220

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

221

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

222

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

223

# are considered higher quality and ranked accordingly.

224

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

225

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

226

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

227

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

228

# property definitions

# and it must be a

# timestamp type

# or

# date type.

# Otherwise, the Indexing API uses

234

# updateTime

235

# as the freshness indicator.

236

# The maximum length is 256 characters.

237

#

238

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

239

# to 2 years from the current time.

240

},

241

},

Bu Sun Kim

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

[diff] [blame]

242

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

Bu Sun Kim

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

[diff] [blame]

243

# The maximum number of elements is 1000.

244

{ # The definition of a property within an object.

Bu Sun Kim

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

[diff] [blame]

245

"textPropertyOptions": { # Options for text properties.

246

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

247

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

248

# to the type of item being searched.

249

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

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

# The maximum length is 32 characters.

259

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

260

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

261

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

262

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

263

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

264

# and does not remove special characters.

265

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

266

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

267

# matches the item.

268

},

269

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

270

# field when used for retrieval.

271

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

272

# 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

277

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

278

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

279

# marked as is_wildcard_searchable.

280

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

281

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

282

# true for properties whose type is a boolean.

283

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

284

# indexing request for that item to be rejected.

285

"objectPropertyOptions": { # Options for object properties.

286

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

Dan O'Meara

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

[diff] [blame]

287

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

288

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

289

# The maximum number of elements is 1000.

290

# Object with schema name: PropertyDefinition

291

],

Bu Sun Kim

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

[diff] [blame]

292

},

Bu Sun Kim

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

[diff] [blame]

293

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

294

"htmlPropertyOptions": { # Options for html properties.

295

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

296

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

297

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

298

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

299

# changed.

300

},

301

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

302

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

303

# to the type of item being searched.

304

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

305

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

306

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

307

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

308

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

309

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

310

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

311

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

Bu Sun Kim

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

[diff] [blame]

312

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

313

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

314

},

315

},

316

"integerPropertyOptions": { # Options for integer properties.

Bu Sun Kim

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

[diff] [blame]

317

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

318

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

319

# relevant to the type of item being searched.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

320

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

321

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

322

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

323

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

324

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

325

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

326

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

327

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

328

"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]

329

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

Bu Sun Kim

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

[diff] [blame]

330

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

Dan O'Meara

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

[diff] [blame]

331

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

332

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

333

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

334

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

Bu Sun Kim

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

[diff] [blame]

335

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

336

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

337

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

338

"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]

339

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

Bu Sun Kim

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

[diff] [blame]

340

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

Dan O'Meara

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

[diff] [blame]

341

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

342

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

343

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

344

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

345

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

346

},

Bu Sun Kim

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

[diff] [blame]

347

"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]

348

# property are used to rank results according to the

349

# ordered ranking.

Bu Sun Kim

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

[diff] [blame]

350

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

351

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

352

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

353

# isRepeatable

354

# is false.

355

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

356

# property are used to rank results according to the

357

# ordered ranking.

358

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

359

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

360

},

361

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

362

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

363

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

364

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

365

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

366

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

367

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

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

# The maximum number of elements is 100.

378

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

379

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

380

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

381

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

382

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

383

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

384

# You must use the integer value in combination with

385

# ordered

386

# ranking to

387

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

388

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

389

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

390

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

391

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

392

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

393

# Optional.

394

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

395

# The maximum length is 32 characters.

396

},

397

],

398

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

399

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

400

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

401

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

402

# isRepeatable

403

# is false.

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

# query *priority:p0*.

414

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

415

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

416

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

417

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

418

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

419

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

420

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

421

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

422

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

423

# The maximum length is 32 characters.

424

},

425

},

426

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

427

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

428

# display options

429

# .

430

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

431

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

432

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

433

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

434

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

435

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

436

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

437

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

438

# The maximum length is 64 characters.

439

},

440

"datePropertyOptions": { # Options for date properties.

441

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

442

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

443

# to the type of item being searched.

444

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

445

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

446

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

447

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

448

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

449

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

450

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

451

# The maximum length is 32 characters.

452

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

453

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

454

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

455

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

456

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

457

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

458

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

459

# The maximum length is 32 characters.

460

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

461

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

462

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

463

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

464

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

465

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

466

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

467

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

468

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

469

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

470

# The maximum length is 32 characters.

471

},

472

},

473

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

474

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

475

# this option.

476

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

477

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

478

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

479

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

480

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

481

# properties.

482

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

483

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

484

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

485

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

486

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

487

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

488

# properties whose type is an object.

489

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

490

# should set the property name

491

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

492

# requests for document items with subject fields should set the

493

# name for that field equal to

494

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

495

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

496

# for another property within that object.

497

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

498

# or numbers (0-9).

499

# The maximum length is 256 characters.

500

"booleanPropertyOptions": { # Options for boolean properties.

501

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

502

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

503

# relevant to the type of item being searched.

504

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

505

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

506

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

507

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

508

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

509

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

510

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

511

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

512

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

513

# The maximum length is 32 characters.

514

},

515

},

516

"timestampPropertyOptions": { # Options for timestamp properties.

517

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

518

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

519

# relevant to the type of item being searched.

520

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

521

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

522

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

523

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

524

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

525

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

526

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

527

# The maximum length is 32 characters.

528

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

529

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

530

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

531

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

532

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

533

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

534

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

535

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

536

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

537

# characters.

538

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

539

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

540

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

541

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

542

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

543

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

544

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

545

# The maximum length is 32 characters.

546

},

547

},

548

"doublePropertyOptions": { # Options for double properties.

549

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

550

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

551

# relevant to the type of item being searched.

552

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

553

# double property in sorting or as a facet.

554

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

555

# The maximum length is 32 characters.

556

},

Bu Sun Kim

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

[diff] [blame]

557

},

558

},

559

],

Bu Sun Kim

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

[diff] [blame]

560

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

561

# should set the

562

# objectType field

563

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

564

# requests for items of type Document should set

565

# objectType equal to

566

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

567

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

568

# or numbers (0-9).

569

# The maximum length is 256 characters.

Bu Sun Kim

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

[diff] [blame]

570

},

571

],

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-27 12:20:54 -0700

[diff] [blame^]

590

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

591

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

592

# Otherwise, ignore this field.

593

},

594

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

595

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

Bu Sun Kim

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

[diff] [blame]

596

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

597

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

598

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

599

# before indexing additional content.

600

"A String",

601

],

602

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

Bu Sun Kim

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

[diff] [blame]

603

# The maximum number of elements is 10.

604

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

605

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

606

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

607

# results page.

608

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

609

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

610

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

611

# is 64 characters.

612

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

613

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

614

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

615

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

616

# practice to specify singular properties before repeated properties in this

617

# list. All of the properties must set

618

# is_returnable

619

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

620

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

621

# result to provide context.

622

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

623

# properties is 5.

624

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

625

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

626

# displayed in the search results along with the

627

# display label

628

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

629

# only the values is shown.

630

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

631

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

632

# error is given when attempting to update the schema.

},

],

},

],

},

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

639

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

640

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

641

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

642

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

643

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

644

# are considered higher quality and ranked accordingly.

645

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

646

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

647

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

648

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

649

# property definitions

# and it must be a

# timestamp type

# or

# date type.

# Otherwise, the Indexing API uses

655

# updateTime

656

# as the freshness indicator.

657

# The maximum length is 256 characters.

658

#

659

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

660

# to 2 years from the current time.

661

},

662

},

Bu Sun Kim

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

[diff] [blame]

663

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

Bu Sun Kim

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

[diff] [blame]

664

# The maximum number of elements is 1000.

665

{ # The definition of a property within an object.

Bu Sun Kim

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

[diff] [blame]

666

"textPropertyOptions": { # Options for text properties.

667

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

668

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

669

# to the type of item being searched.

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

# The maximum length is 32 characters.

680

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

681

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

682

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

683

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

684

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

685

# and does not remove special characters.

686

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

687

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

688

# matches the item.

689

},

690

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

691

# field when used for retrieval.

692

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

693

# 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

698

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

699

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

700

# marked as is_wildcard_searchable.

701

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

702

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

703

# true for properties whose type is a boolean.

704

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

705

# indexing request for that item to be rejected.

706

"objectPropertyOptions": { # Options for object properties.

707

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

Dan O'Meara

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

[diff] [blame]

708

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

709

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

710

# The maximum number of elements is 1000.

711

# Object with schema name: PropertyDefinition

712

],

Bu Sun Kim

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

[diff] [blame]

713

},

Bu Sun Kim

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

[diff] [blame]

714

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

715

"htmlPropertyOptions": { # Options for html properties.

716

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

717

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

718

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

719

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

720

# changed.

721

},

722

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

723

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

724

# to the type of item being searched.

725

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

726

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

727

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

728

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

729

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

730

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

731

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

732

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

Bu Sun Kim

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

[diff] [blame]

733

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

734

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

735

},

736

},

737

"integerPropertyOptions": { # Options for integer properties.

Bu Sun Kim

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

[diff] [blame]

738

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

739

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

740

# relevant to the type of item being searched.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

741

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

742

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

743

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

744

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

745

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

746

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

747

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

748

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

749

"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]

750

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

Bu Sun Kim

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

[diff] [blame]

751

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

Dan O'Meara

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

[diff] [blame]

752

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

753

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

754

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

755

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

Bu Sun Kim

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

[diff] [blame]

756

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

757

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

758

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

759

"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]

760

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

Bu Sun Kim

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

[diff] [blame]

761

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

Dan O'Meara

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

[diff] [blame]

762

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

763

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

764

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

765

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

766

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

767

},

Bu Sun Kim

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

[diff] [blame]

768

"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]

769

# property are used to rank results according to the

770

# ordered ranking.

Bu Sun Kim

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

[diff] [blame]

771

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

772

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

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame^]

773

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

774

# isRepeatable

775

# is false.

776

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

777

# property are used to rank results according to the

778

# ordered ranking.

779

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

780

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

781

},

782

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

783

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

784

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

785

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

786

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

787

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

788

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

789

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

790

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

791

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

792

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

793

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

794

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

795

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

796

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

797

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

798

# The maximum number of elements is 100.

799

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

800

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

801

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

802

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

803

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

804

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

805

# You must use the integer value in combination with

806

# ordered

807

# ranking to

808

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

809

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

810

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

811

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

812

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

813

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

814

# Optional.

815

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

816

# The maximum length is 32 characters.

817

},

818

],

819

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

820

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

821

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

822

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

823

# isRepeatable

824

# is false.

825

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

826

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

827

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

828

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

829

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

830

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

831

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

832

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

833

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

834

# query *priority:p0*.

835

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

836

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

837

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

838

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

839

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

840

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

841

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

842

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

843

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

844

# The maximum length is 32 characters.

845

},

846

},

847

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

848

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

849

# display options

850

# .

851

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

852

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

853

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

854

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

855

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

856

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

857

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

858

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

859

# The maximum length is 64 characters.

860

},

861

"datePropertyOptions": { # Options for date properties.

862

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

863

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

864

# to the type of item being searched.

865

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

866

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

867

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

868

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

869

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

870

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

871

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

872

# The maximum length is 32 characters.

873

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

874

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

875

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

876

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

877

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

878

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

879

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

880

# The maximum length is 32 characters.

881

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

882

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

883

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

884

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

885

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

886

# *closeDate* property 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

889

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

890

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

891

# The maximum length is 32 characters.

892

},

893

},

894

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

895

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

896

# this option.

897

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

898

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

899

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

900

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

901

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

902

# properties.

903

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

904

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

905

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

906

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

907

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

908

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

909

# properties whose type is an object.

910

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

911

# should set the property name

912

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

913

# requests for document items with subject fields should set the

914

# name for that field equal to

915

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

916

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

917

# for another property within that object.

918

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

919

# or numbers (0-9).

920

# The maximum length is 256 characters.

921

"booleanPropertyOptions": { # Options for boolean properties.

922

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

923

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

924

# relevant to the type of item being searched.

925

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

926

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

927

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

928

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

929

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

930

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

931

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

932

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

933

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

934

# The maximum length is 32 characters.

935

},

936

},

937

"timestampPropertyOptions": { # Options for timestamp properties.

938

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

939

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

940

# relevant to the type of item being searched.

941

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

942

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

943

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

944

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

945

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

946

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

947

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

948

# The maximum length is 32 characters.

949

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

950

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

951

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

952

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

953

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

954

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

955

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

956

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

957

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

958

# characters.

959

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

960

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

961

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

962

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

963

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

964

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

965

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

966

# The maximum length is 32 characters.

967

},

968

},

969

"doublePropertyOptions": { # Options for double properties.

970

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

971

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

972

# relevant to the type of item being searched.

973

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

974

# double property in sorting or as a facet.

975

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

976

# The maximum length is 32 characters.

977

},

Bu Sun Kim

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

[diff] [blame]

978

},

979

},

980

],

Bu Sun Kim

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

[diff] [blame]

981

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

982

# should set the

983

# objectType field

984

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

985

# requests for items of type Document should set

986

# objectType equal to

987

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

988

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

989

# or numbers (0-9).

990

# The maximum length is 256 characters.

Bu Sun Kim

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

[diff] [blame]

991

},

992

],

Bu Sun Kim

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

[diff] [blame]

},

}

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

"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]

1007

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

1008

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

1009

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

1010

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

1011

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

1012

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

1013

# `TakeSnapshotResponse`.

Bu Sun Kim

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

[diff] [blame]

1014

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

Dan O'Meara

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

[diff] [blame]

1015

},

Bu Sun Kim

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

[diff] [blame]

1016

"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]

1017

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

1018

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

Bu Sun Kim

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

[diff] [blame]

1019

"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