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

<h1><a href="cloudsearch_v1.html">Cloud Search API</a> . <a href="cloudsearch_v1.indexing.html">indexing</a> . <a href="cloudsearch_v1.indexing.datasources.html">datasources</a> . <a href="cloudsearch_v1.indexing.datasources.items.html">items</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#delete">delete(name, connectorName=None, version=None, mode=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>

79

<p class="firstline">Deletes Item resource for the</p>

80

81

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

82

<p class="firstline">Deletes all items in a queue. This method is useful for deleting stale</p>

83

84

<code><a href="#get">get(name, connectorName=None, debugOptions_enableDebugging=None, x__xgafv=None)</a></code></p>

85

<p class="firstline">Gets Item resource by item name.</p>

86

87

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

88

<p class="firstline">Updates Item ACL, metadata, and</p>

89

90

<code><a href="#list">list(name, pageSize=None, brief=None, connectorName=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">Lists all or a subset of Item resources.</p>

92

93

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

94

<p class="firstline">Retrieves the next page of results.</p>

95

96

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

97

<p class="firstline">Polls for unreserved items from the indexing queue and marks a</p>

98

99

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

100

<p class="firstline">Pushes an item onto a queue for later polling and updating.</p>

101

102

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

103

<p class="firstline">Unreserves all items from a queue, making them all eligible to be</p>

104

105

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

106

<p class="firstline">Creates an upload session for uploading item content. For items smaller</p>

107

<h3>Method Details</h3>

108

109

<code class="details" id="delete">delete(name, connectorName=None, version=None, mode=None, debugOptions_enableDebugging=None, x__xgafv=None)</code>

110

<pre>Deletes Item resource for the

111

specified resource name.

Args:

Format: datasources/{source_id}/items/{item_id} (required)

116

connectorName: string, Name of connector making this call.

117

<br />Format: datasources/{source_id}/connectors/{ID}

118

version: string, Required. The incremented version of the item to delete from the index.

119

The indexing system stores the version from the datasource as a

120

byte string and compares the Item version in the index

121

to the version of the queued Item using lexical ordering.

122

123

Cloud Search Indexing won't delete any queued item with

124

a version value that is less than or equal to

125

the version of the currently indexed item.

126

The maximum length for this field is 1024 bytes.

127

mode: string, Required. The RequestMode for this request.

128

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

129

Otherwise, ignore this field.

130

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

137

138

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

139

# network API call.

140

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

141

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

142

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

143

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

144

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

145

},

146

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

147

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

148

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

149

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

150

#

151

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

152

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

153

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

154

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

155

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

156

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

157

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

158

# message types for APIs to use.

159

{

160

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

},

],

},

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

165

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

166

# available.

167

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

168

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

169

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

170

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

171

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

172

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

173

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

174

# `TakeSnapshotResponse`.

175

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

176

},

177

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

178

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

179

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

}</pre>

</div>

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

185

<pre>Deletes all items in a queue. This method is useful for deleting stale

items.

Args:

Format: datasources/{source_id} (required)

191

body: object, The request body. (required)

192

The object takes the form of:

193

194

{

195

"queue": "A String", # Name of a queue to delete items from.

196

"connectorName": "A String", # Name of connector making this call.

197

# <br />Format: datasources/{source_id}/connectors/{ID}

198

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

199

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

200

# Otherwise, ignore this field.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

211

212

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

213

# network API call.

214

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

215

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

216

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

217

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

218

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

219

},

220

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

221

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

222

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

223

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

224

#

225

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

226

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

227

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

228

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

229

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

230

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

231

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

232

# message types for APIs to use.

233

{

234

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

},

],

},

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

239

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

240

# available.

241

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

242

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

243

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

244

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

245

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

246

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

247

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

248

# `TakeSnapshotResponse`.

249

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

250

},

251

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

252

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

253

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

}</pre>

</div>

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

259

<pre>Gets Item resource by item name.

Args:

Format: datasources/{source_id}/items/{item_id} (required)

264

connectorName: string, Name of connector making this call.

265

<br />Format: datasources/{source_id}/connectors/{ID}

266

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

267

Otherwise, ignore this field.

268

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

275

276

{ # Represents a single object that is an item in the search index, such as a

277

# file, folder, or a database record.

278

"status": { # This contains item's status and any errors. # Status of the item.

279

# Output only field.

280

"processingErrors": [ # Error details in case the item is in ERROR state.

281

{

282

"code": "A String", # Error code indicating the nature of the error.

283

"errorMessage": "A String", # Description of the error.

284

"fieldViolations": [ # In case the item fields are invalid, this field contains the details

285

# about the validation errors.

286

{

287

"field": "A String", # Path of field with violation.

288

"description": "A String", # Description of the error.

},

],

},

],

"repositoryErrors": [ # Repository error reported by connector.

294

{ # Errors when the connector is communicating to the source repository.

295

"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.

296

"errorMessage": "A String", # Message that describes the error. The maximum allowable length

297

# of the message is 8192 characters.

298

"type": "A String", # Type of error.

299

},

300

],

301

"code": "A String", # Status code.

302

},

303

"queue": "A String", # Queue this item belongs to.

304

# The maximum length is 100 characters.

305

"name": "A String", # Name of the Item. Format:

306

# datasources/{source_id}/items/{item_id}

307

# <br />This is a required field.

308

# The maximum length is 1536 characters.

309

"acl": { # Access control list information for the item. For more information see # Access control list for this item.

310

# https://developers.google.com/cloud-search/docs/guides/index-your-data#acls

311

"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a

312

# parent. This should always be set in tandem with the

313

# inheritAclFrom

314

# field. Also, when the

315

# inheritAclFrom field

316

# is set, this field should be set to a valid AclInheritanceType.

317

"readers": [ # List of principals who are allowed to see the item in search results.

318

# Optional if inheriting permissions from another item or if the item

319

# is not intended to be visible, such as

320

# virtual

321

# containers.

322

# The maximum number of elements is 1000.

323

{ # Reference to a user, group, or domain.

324

"userResourceName": "A String", # This principal is a user identified using an external identity.

325

# The name field must specify the user resource name with this format:

326

# identitysources/{source_id}/users/{ID}

327

"groupResourceName": "A String", # This principal is a group identified using an external identity.

328

# The name field must specify the group resource name with this format:

329

# identitysources/{source_id}/groups/{ID}

330

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

331

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

332

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

333

# customer.

334

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"deniedReaders": [ # List of principals who are explicitly denied access to the item in search

339

# results. While principals are denied access by default, use denied readers

340

# to handle exceptions and override the list allowed readers.

341

# The maximum number of elements is 100.

342

{ # Reference to a user, group, or domain.

343

"userResourceName": "A String", # This principal is a user identified using an external identity.

344

# The name field must specify the user resource name with this format:

345

# identitysources/{source_id}/users/{ID}

346

"groupResourceName": "A String", # This principal is a group identified using an external identity.

347

# The name field must specify the group resource name with this format:

348

# identitysources/{source_id}/groups/{ID}

349

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

350

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

351

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

352

# customer.

353

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"owners": [ # Optional. List of owners for the item. This field has no bearing on

358

# document access permissions. It does, however, offer

359

# a slight ranking boosts items where the querying user is an owner.

360

# The maximum number of elements is 5.

361

{ # Reference to a user, group, or domain.

362

"userResourceName": "A String", # This principal is a user identified using an external identity.

363

# The name field must specify the user resource name with this format:

364

# identitysources/{source_id}/users/{ID}

365

"groupResourceName": "A String", # This principal is a group identified using an external identity.

366

# The name field must specify the group resource name with this format:

367

# identitysources/{source_id}/groups/{ID}

368

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

369

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

370

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

371

# customer.

372

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.

377

# Note: ACL inheritance *only* provides access permissions

378

# to child items and does not define structural relationships, nor does it

379

# provide convenient ways to delete large groups of items.

380

# Deleting an ACL parent from the index only alters the access permissions of

381

# child items that reference the parent in the

382

# inheritAclFrom

383

# field. The item is still in the index, but may not

384

# visible in search results. By contrast, deletion of a container item

385

# also deletes all items that reference the container via the

386

# containerName

387

# field.

388

# The maximum length for this field is 1536 characters.

389

},

390

"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.

391

"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.

392

# This reference is created via upload

393

# method.

394

# Updating of item content may refer to this uploaded content via

395

# contentDataRef.

396

"name": "A String", # Name of the content reference.

397

# The maximum length is 2048 characters.

398

},

399

"contentFormat": "A String",

400

"hash": "A String", # Hashing info calculated and provided by the API client for content.

401

# Can be used with the items.push method to calculate modified state.

402

# The maximum length is 2048 characters.

403

"inlineContent": "A String", # Content that is supplied inlined within the update method.

404

# The maximum length is 102400 bytes (100 KiB).

405

},

406

"version": "A String", # Required. The indexing system stores the version from the datasource as a

407

# byte string and compares the Item version in the index

408

# to the version of the queued Item using lexical ordering.

409

# <br /><br />

410

# Cloud Search Indexing won't index or delete any queued item with

411

# a version value that is less than or equal to the version of the

412

# currently indexed item.

413

# The maximum length for this field is 1024 bytes.

414

"itemType": "A String", # Type for this item.

415

"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered

416

# object definition in the schema for the data source.

417

"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object

418

# definition in the schema for the data source.

419

"properties": [ # The properties for the object.

420

# The maximum number of elements is 1000.

421

{ # A typed name-value pair for structured data. The type of the value should

422

# be the same as the registered type for the `name` property in the object

423

# definition of `objectType`.

424

"objectValues": { # List of object values.

425

"values": [

426

# Object with schema name: StructuredDataObject

427

],

428

},

429

"dateValues": { # List of date values.

430

"values": [

431

{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

432

"month": 42, # Month of date. Must be from 1 to 12.

433

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

434

"year": 42, # Year of date. Must be from 1 to 9999.

},

],

},

"textValues": { # List of text values.

439

"values": [ # The maximum allowable length for text values is 2048 characters.

"A String",

],

},

"enumValues": { # List of enum values.

444

"values": [ # The maximum allowable length for string values is 32 characters.

"A String",

],

},

"integerValues": { # List of integer values.

"values": [

"A String",

],

},

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"htmlValues": { # List of html values.

459

"values": [ # The maximum allowable length for html values is 2048 characters.

"A String",

],

},

"booleanValue": True or False,

464

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

"name": "A String", # The name of the property. This name should correspond to the name of the

470

# property that was registered for object definition in the schema.

471

# The maximum allowable length for this property is 256 characters.

},

],

},

"hash": "A String", # Hashing value provided by the API caller.

476

# This can be used with the

477

# items.push

478

# method to calculate modified state.

479

# The maximum length is 2048 characters.

480

},

481

"payload": "A String", # Additional state connector can store for this item.

482

# The maximum length is 10000 bytes.

483

"metadata": { # Available metadata fields for the item. # Metadata information.

484

"mimeType": "A String", # The original mime-type of

485

# ItemContent.content

486

# in the source repository.

487

# The maximum length is 256 characters.

488

"containerName": "A String", # The name of the container for this item.

489

# Deletion of the container item leads to automatic deletion of this

490

# item. Note: ACLs are not inherited from a container item.

491

# To provide ACL inheritance for an item, use the

492

# inheritAclFrom

493

# field. The maximum length is 1536 characters.

494

"updateTime": "A String", # The time when the item was last modified in the source repository.

495

"hash": "A String", # Hashing value provided by the API caller.

496

# This can be used with the

497

# items.push

498

# method to calculate modified state.

499

# The maximum length is 2048 characters.

500

"contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For

501

# more information, see

502

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

503

# The maximum length is 32 characters.

504

"title": "A String", # The title of the item. If given, this will be the displayed title of the

505

# Search result.

506

# The maximum length is 2048 characters.

507

"interactions": [ # A list of interactions for the item. Interactions are used to improve

508

# Search quality, but are not exposed to end users.

509

# The maximum number of elements is 1000.

510

{ # Represents an interaction between a user and an item.

511

"interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same

512

# type exist for a single user, only the most recent action is recorded.

513

"type": "A String",

514

"principal": { # Reference to a user, group, or domain. # The user that acted on the item.

515

"userResourceName": "A String", # This principal is a user identified using an external identity.

516

# The name field must specify the user resource name with this format:

517

# identitysources/{source_id}/users/{ID}

518

"groupResourceName": "A String", # This principal is a group identified using an external identity.

519

# The name field must specify the group resource name with this format:

520

# identitysources/{source_id}/groups/{ID}

521

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

522

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

523

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

524

# customer.

525

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

},

],

"searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item

531

"quality": 3.14, # An indication of the quality of the item, used to influence search quality.

532

# Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The

533

# default value is 0.0.

534

},

535

"keywords": [ # Additional keywords or phrases that should match the item.

536

# Used internally for user generated content.

537

# The maximum number of elements is 100.

538

# The maximum length is 8192 characters.

539

"A String",

540

],

541

"sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply

542

# this link to the title.

543

# The maximum length is 2048 characters.

544

"createTime": "A String", # The time when the item was created in the source repository.

545

"objectType": "A String", # The type of the item. This should correspond to the name of an object

546

# definition in the schema registered for the data source. For example, if

547

# the schema for the data source contains an object definition with name

548

# 'document', then item indexing requests for objects of that type should set

549

# objectType to 'document'.

550

# The maximum length is 256 characters.

},

}</pre>

</div>

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

557

<pre>Updates Item ACL, metadata, and

558

content. It will insert the Item if it

559

does not exist.

560

This method does not support partial updates. Fields with no provided

561

values are cleared out in the Cloud Search index.

Args:

datasources/{source_id}/items/{item_id}

566

<br />This is a required field.

567

The maximum length is 1536 characters. (required)

568

body: object, The request body. (required)

569

The object takes the form of:

570

571

{

572

"item": { # Represents a single object that is an item in the search index, such as a # Name of the item. Format:

573

# datasources/{source_id}/items/{item_id}

574

# file, folder, or a database record.

575

"status": { # This contains item's status and any errors. # Status of the item.

576

# Output only field.

577

"processingErrors": [ # Error details in case the item is in ERROR state.

578

{

579

"code": "A String", # Error code indicating the nature of the error.

580

"errorMessage": "A String", # Description of the error.

581

"fieldViolations": [ # In case the item fields are invalid, this field contains the details

582

# about the validation errors.

583

{

584

"field": "A String", # Path of field with violation.

585

"description": "A String", # Description of the error.

},

],

},

],

"repositoryErrors": [ # Repository error reported by connector.

591

{ # Errors when the connector is communicating to the source repository.

592

"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.

593

"errorMessage": "A String", # Message that describes the error. The maximum allowable length

594

# of the message is 8192 characters.

595

"type": "A String", # Type of error.

596

},

597

],

598

"code": "A String", # Status code.

599

},

600

"queue": "A String", # Queue this item belongs to.

601

# The maximum length is 100 characters.

602

"name": "A String", # Name of the Item. Format:

603

# datasources/{source_id}/items/{item_id}

604

# <br />This is a required field.

605

# The maximum length is 1536 characters.

606

"acl": { # Access control list information for the item. For more information see # Access control list for this item.

607

# https://developers.google.com/cloud-search/docs/guides/index-your-data#acls

608

"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a

609

# parent. This should always be set in tandem with the

610

# inheritAclFrom

611

# field. Also, when the

612

# inheritAclFrom field

613

# is set, this field should be set to a valid AclInheritanceType.

614

"readers": [ # List of principals who are allowed to see the item in search results.

615

# Optional if inheriting permissions from another item or if the item

616

# is not intended to be visible, such as

617

# virtual

618

# containers.

619

# The maximum number of elements is 1000.

620

{ # Reference to a user, group, or domain.

621

"userResourceName": "A String", # This principal is a user identified using an external identity.

622

# The name field must specify the user resource name with this format:

623

# identitysources/{source_id}/users/{ID}

624

"groupResourceName": "A String", # This principal is a group identified using an external identity.

625

# The name field must specify the group resource name with this format:

626

# identitysources/{source_id}/groups/{ID}

627

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

628

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

629

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

630

# customer.

631

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"deniedReaders": [ # List of principals who are explicitly denied access to the item in search

636

# results. While principals are denied access by default, use denied readers

637

# to handle exceptions and override the list allowed readers.

638

# The maximum number of elements is 100.

639

{ # Reference to a user, group, or domain.

640

"userResourceName": "A String", # This principal is a user identified using an external identity.

641

# The name field must specify the user resource name with this format:

642

# identitysources/{source_id}/users/{ID}

643

"groupResourceName": "A String", # This principal is a group identified using an external identity.

644

# The name field must specify the group resource name with this format:

645

# identitysources/{source_id}/groups/{ID}

646

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

647

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

648

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

649

# customer.

650

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"owners": [ # Optional. List of owners for the item. This field has no bearing on

655

# document access permissions. It does, however, offer

656

# a slight ranking boosts items where the querying user is an owner.

657

# The maximum number of elements is 5.

658

{ # Reference to a user, group, or domain.

659

"userResourceName": "A String", # This principal is a user identified using an external identity.

660

# The name field must specify the user resource name with this format:

661

# identitysources/{source_id}/users/{ID}

662

"groupResourceName": "A String", # This principal is a group identified using an external identity.

663

# The name field must specify the group resource name with this format:

664

# identitysources/{source_id}/groups/{ID}

665

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

666

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

667

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

668

# customer.

669

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.

674

# Note: ACL inheritance *only* provides access permissions

675

# to child items and does not define structural relationships, nor does it

676

# provide convenient ways to delete large groups of items.

677

# Deleting an ACL parent from the index only alters the access permissions of

678

# child items that reference the parent in the

679

# inheritAclFrom

680

# field. The item is still in the index, but may not

681

# visible in search results. By contrast, deletion of a container item

682

# also deletes all items that reference the container via the

683

# containerName

684

# field.

685

# The maximum length for this field is 1536 characters.

686

},

687

"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.

688

"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.

689

# This reference is created via upload

690

# method.

691

# Updating of item content may refer to this uploaded content via

692

# contentDataRef.

693

"name": "A String", # Name of the content reference.

694

# The maximum length is 2048 characters.

695

},

696

"contentFormat": "A String",

697

"hash": "A String", # Hashing info calculated and provided by the API client for content.

698

# Can be used with the items.push method to calculate modified state.

699

# The maximum length is 2048 characters.

700

"inlineContent": "A String", # Content that is supplied inlined within the update method.

701

# The maximum length is 102400 bytes (100 KiB).

702

},

703

"version": "A String", # Required. The indexing system stores the version from the datasource as a

704

# byte string and compares the Item version in the index

705

# to the version of the queued Item using lexical ordering.

706

# <br /><br />

707

# Cloud Search Indexing won't index or delete any queued item with

708

# a version value that is less than or equal to the version of the

709

# currently indexed item.

710

# The maximum length for this field is 1024 bytes.

711

"itemType": "A String", # Type for this item.

712

"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered

713

# object definition in the schema for the data source.

714

"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object

715

# definition in the schema for the data source.

716

"properties": [ # The properties for the object.

717

# The maximum number of elements is 1000.

718

{ # A typed name-value pair for structured data. The type of the value should

719

# be the same as the registered type for the `name` property in the object

720

# definition of `objectType`.

721

"objectValues": { # List of object values.

722

"values": [

723

# Object with schema name: StructuredDataObject

724

],

725

},

726

"dateValues": { # List of date values.

727

"values": [

728

{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

729

"month": 42, # Month of date. Must be from 1 to 12.

730

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

731

"year": 42, # Year of date. Must be from 1 to 9999.

},

],

},

"textValues": { # List of text values.

736

"values": [ # The maximum allowable length for text values is 2048 characters.

"A String",

],

},

"enumValues": { # List of enum values.

741

"values": [ # The maximum allowable length for string values is 32 characters.

"A String",

],

},

"integerValues": { # List of integer values.

"values": [

"A String",

],

},

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"htmlValues": { # List of html values.

756

"values": [ # The maximum allowable length for html values is 2048 characters.

"A String",

],

},

"booleanValue": True or False,

761

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

"name": "A String", # The name of the property. This name should correspond to the name of the

767

# property that was registered for object definition in the schema.

768

# The maximum allowable length for this property is 256 characters.

},

],

},

"hash": "A String", # Hashing value provided by the API caller.

773

# This can be used with the

774

# items.push

775

# method to calculate modified state.

776

# The maximum length is 2048 characters.

777

},

778

"payload": "A String", # Additional state connector can store for this item.

779

# The maximum length is 10000 bytes.

780

"metadata": { # Available metadata fields for the item. # Metadata information.

781

"mimeType": "A String", # The original mime-type of

782

# ItemContent.content

783

# in the source repository.

784

# The maximum length is 256 characters.

785

"containerName": "A String", # The name of the container for this item.

786

# Deletion of the container item leads to automatic deletion of this

787

# item. Note: ACLs are not inherited from a container item.

788

# To provide ACL inheritance for an item, use the

789

# inheritAclFrom

790

# field. The maximum length is 1536 characters.

791

"updateTime": "A String", # The time when the item was last modified in the source repository.

792

"hash": "A String", # Hashing value provided by the API caller.

793

# This can be used with the

794

# items.push

795

# method to calculate modified state.

796

# The maximum length is 2048 characters.

797

"contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For

798

# more information, see

799

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

800

# The maximum length is 32 characters.

801

"title": "A String", # The title of the item. If given, this will be the displayed title of the

802

# Search result.

803

# The maximum length is 2048 characters.

804

"interactions": [ # A list of interactions for the item. Interactions are used to improve

805

# Search quality, but are not exposed to end users.

806

# The maximum number of elements is 1000.

807

{ # Represents an interaction between a user and an item.

808

"interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same

809

# type exist for a single user, only the most recent action is recorded.

810

"type": "A String",

811

"principal": { # Reference to a user, group, or domain. # The user that acted on the item.

812

"userResourceName": "A String", # This principal is a user identified using an external identity.

813

# The name field must specify the user resource name with this format:

814

# identitysources/{source_id}/users/{ID}

815

"groupResourceName": "A String", # This principal is a group identified using an external identity.

816

# The name field must specify the group resource name with this format:

817

# identitysources/{source_id}/groups/{ID}

818

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

819

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

820

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

821

# customer.

822

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

},

],

"searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item

828

"quality": 3.14, # An indication of the quality of the item, used to influence search quality.

829

# Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The

830

# default value is 0.0.

831

},

832

"keywords": [ # Additional keywords or phrases that should match the item.

833

# Used internally for user generated content.

834

# The maximum number of elements is 100.

835

# The maximum length is 8192 characters.

836

"A String",

837

],

838

"sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply

839

# this link to the title.

840

# The maximum length is 2048 characters.

841

"createTime": "A String", # The time when the item was created in the source repository.

842

"objectType": "A String", # The type of the item. This should correspond to the name of an object

843

# definition in the schema registered for the data source. For example, if

844

# the schema for the data source contains an object definition with name

845

# 'document', then item indexing requests for objects of that type should set

846

# objectType to 'document'.

847

# The maximum length is 256 characters.

848

},

849

},

850

"mode": "A String", # Required. The RequestMode for this request.

851

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

852

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

853

# Otherwise, ignore this field.

854

},

855

"indexItemOptions": {

856

"allowUnknownGsuitePrincipals": True or False, # Specifies if the index request should allow gsuite principals that do not

857

# exist or are deleted in the index request.

858

},

859

"connectorName": "A String", # Name of connector making this call.

860

# <br />Format: datasources/{source_id}/connectors/{ID}

861

}

862

863

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

870

871

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

872

# network API call.

873

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

874

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

875

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

876

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

877

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

878

},

879

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

880

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

881

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

882

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

883

#

884

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

885

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

886

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

887

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

888

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

889

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

890

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

891

# message types for APIs to use.

892

{

893

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

},

],

},

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

898

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

899

# available.

900

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

901

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

902

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

903

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

904

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

905

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

906

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

907

# `TakeSnapshotResponse`.

908

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

909

},

910

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

911

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

912

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

}</pre>

</div>

<code class="details" id="list">list(name, pageSize=None, brief=None, connectorName=None, debugOptions_enableDebugging=None, pageToken=None, x__xgafv=None)</code>

918

<pre>Lists all or a subset of Item resources.

Args:

datasources/{source_id} (required)

923

pageSize: integer, Maximum number of items to fetch in a request.

924

The max value is 1000 when brief is true. The max value is 10 if brief

925

is false.

926

<br />The default value is 10

927

brief: boolean, When set to true, the indexing system only populates the following fields:

name,

version,

metadata.hash,

structured_data.hash,

932

content.hash.

933

<br />If this value is false, then all the fields are populated in Item.

934

connectorName: string, Name of connector making this call.

935

<br />Format: datasources/{source_id}/connectors/{ID}

936

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

937

Otherwise, ignore this field.

938

pageToken: string, The next_page_token value returned from a previous List request, if any.

939

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

946

947

{

948

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no

949

# more results in the list.

950

"items": [

951

{ # Represents a single object that is an item in the search index, such as a

952

# file, folder, or a database record.

953

"status": { # This contains item's status and any errors. # Status of the item.

954

# Output only field.

955

"processingErrors": [ # Error details in case the item is in ERROR state.

956

{

957

"code": "A String", # Error code indicating the nature of the error.

958

"errorMessage": "A String", # Description of the error.

959

"fieldViolations": [ # In case the item fields are invalid, this field contains the details

960

# about the validation errors.

961

{

962

"field": "A String", # Path of field with violation.

963

"description": "A String", # Description of the error.

},

],

},

],

"repositoryErrors": [ # Repository error reported by connector.

969

{ # Errors when the connector is communicating to the source repository.

970

"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.

971

"errorMessage": "A String", # Message that describes the error. The maximum allowable length

972

# of the message is 8192 characters.

973

"type": "A String", # Type of error.

974

},

975

],

976

"code": "A String", # Status code.

977

},

978

"queue": "A String", # Queue this item belongs to.

979

# The maximum length is 100 characters.

980

"name": "A String", # Name of the Item. Format:

981

# datasources/{source_id}/items/{item_id}

982

# <br />This is a required field.

983

# The maximum length is 1536 characters.

984

"acl": { # Access control list information for the item. For more information see # Access control list for this item.

985

# https://developers.google.com/cloud-search/docs/guides/index-your-data#acls

986

"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a

987

# parent. This should always be set in tandem with the

988

# inheritAclFrom

989

# field. Also, when the

990

# inheritAclFrom field

991

# is set, this field should be set to a valid AclInheritanceType.

992

"readers": [ # List of principals who are allowed to see the item in search results.

993

# Optional if inheriting permissions from another item or if the item

994

# is not intended to be visible, such as

995

# virtual

996

# containers.

997

# The maximum number of elements is 1000.

998

{ # Reference to a user, group, or domain.

999

"userResourceName": "A String", # This principal is a user identified using an external identity.

1000

# The name field must specify the user resource name with this format:

1001

# identitysources/{source_id}/users/{ID}

1002

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1003

# The name field must specify the group resource name with this format:

1004

# identitysources/{source_id}/groups/{ID}

1005

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1006

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1007

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1008

# customer.

1009

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"deniedReaders": [ # List of principals who are explicitly denied access to the item in search

1014

# results. While principals are denied access by default, use denied readers

1015

# to handle exceptions and override the list allowed readers.

1016

# The maximum number of elements is 100.

1017

{ # Reference to a user, group, or domain.

1018

"userResourceName": "A String", # This principal is a user identified using an external identity.

1019

# The name field must specify the user resource name with this format:

1020

# identitysources/{source_id}/users/{ID}

1021

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1022

# The name field must specify the group resource name with this format:

1023

# identitysources/{source_id}/groups/{ID}

1024

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1025

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1026

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1027

# customer.

1028

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"owners": [ # Optional. List of owners for the item. This field has no bearing on

1033

# document access permissions. It does, however, offer

1034

# a slight ranking boosts items where the querying user is an owner.

1035

# The maximum number of elements is 5.

1036

{ # Reference to a user, group, or domain.

1037

"userResourceName": "A String", # This principal is a user identified using an external identity.

1038

# The name field must specify the user resource name with this format:

1039

# identitysources/{source_id}/users/{ID}

1040

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1041

# The name field must specify the group resource name with this format:

1042

# identitysources/{source_id}/groups/{ID}

1043

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1044

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1045

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1046

# customer.

1047

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.

1052

# Note: ACL inheritance *only* provides access permissions

1053

# to child items and does not define structural relationships, nor does it

1054

# provide convenient ways to delete large groups of items.

1055

# Deleting an ACL parent from the index only alters the access permissions of

1056

# child items that reference the parent in the

1057

# inheritAclFrom

1058

# field. The item is still in the index, but may not

1059

# visible in search results. By contrast, deletion of a container item

1060

# also deletes all items that reference the container via the

1061

# containerName

1062

# field.

1063

# The maximum length for this field is 1536 characters.

1064

},

1065

"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.

1066

"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.

1067

# This reference is created via upload

1068

# method.

1069

# Updating of item content may refer to this uploaded content via

1070

# contentDataRef.

1071

"name": "A String", # Name of the content reference.

1072

# The maximum length is 2048 characters.

1073

},

1074

"contentFormat": "A String",

1075

"hash": "A String", # Hashing info calculated and provided by the API client for content.

1076

# Can be used with the items.push method to calculate modified state.

1077

# The maximum length is 2048 characters.

1078

"inlineContent": "A String", # Content that is supplied inlined within the update method.

1079

# The maximum length is 102400 bytes (100 KiB).

1080

},

1081

"version": "A String", # Required. The indexing system stores the version from the datasource as a

1082

# byte string and compares the Item version in the index

1083

# to the version of the queued Item using lexical ordering.

1084

# <br /><br />

1085

# Cloud Search Indexing won't index or delete any queued item with

1086

# a version value that is less than or equal to the version of the

1087

# currently indexed item.

1088

# The maximum length for this field is 1024 bytes.

1089

"itemType": "A String", # Type for this item.

1090

"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered

1091

# object definition in the schema for the data source.

1092

"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object

1093

# definition in the schema for the data source.

1094

"properties": [ # The properties for the object.

1095

# The maximum number of elements is 1000.

1096

{ # A typed name-value pair for structured data. The type of the value should

1097

# be the same as the registered type for the `name` property in the object

1098

# definition of `objectType`.

1099

"objectValues": { # List of object values.

1100

"values": [

1101

# Object with schema name: StructuredDataObject

1102

],

1103

},

1104

"dateValues": { # List of date values.

1105

"values": [

1106

{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

1107

"month": 42, # Month of date. Must be from 1 to 12.

1108

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

1109

"year": 42, # Year of date. Must be from 1 to 9999.

},

],

},

"textValues": { # List of text values.

1114

"values": [ # The maximum allowable length for text values is 2048 characters.

"A String",

],

},

"enumValues": { # List of enum values.

1119

"values": [ # The maximum allowable length for string values is 32 characters.

"A String",

],

},

"integerValues": { # List of integer values.

"values": [

"A String",

],

},

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"htmlValues": { # List of html values.

1134

"values": [ # The maximum allowable length for html values is 2048 characters.

"A String",

],

},

"booleanValue": True or False,

1139

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

"name": "A String", # The name of the property. This name should correspond to the name of the

1145

# property that was registered for object definition in the schema.

1146

# The maximum allowable length for this property is 256 characters.

},

],

},

"hash": "A String", # Hashing value provided by the API caller.

1151

# This can be used with the

1152

# items.push

1153

# method to calculate modified state.

1154

# The maximum length is 2048 characters.

1155

},

1156

"payload": "A String", # Additional state connector can store for this item.

1157

# The maximum length is 10000 bytes.

1158

"metadata": { # Available metadata fields for the item. # Metadata information.

1159

"mimeType": "A String", # The original mime-type of

1160

# ItemContent.content

1161

# in the source repository.

1162

# The maximum length is 256 characters.

1163

"containerName": "A String", # The name of the container for this item.

1164

# Deletion of the container item leads to automatic deletion of this

1165

# item. Note: ACLs are not inherited from a container item.

1166

# To provide ACL inheritance for an item, use the

1167

# inheritAclFrom

1168

# field. The maximum length is 1536 characters.

1169

"updateTime": "A String", # The time when the item was last modified in the source repository.

1170

"hash": "A String", # Hashing value provided by the API caller.

1171

# This can be used with the

1172

# items.push

1173

# method to calculate modified state.

1174

# The maximum length is 2048 characters.

1175

"contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For

1176

# more information, see

1177

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

1178

# The maximum length is 32 characters.

1179

"title": "A String", # The title of the item. If given, this will be the displayed title of the

1180

# Search result.

1181

# The maximum length is 2048 characters.

1182

"interactions": [ # A list of interactions for the item. Interactions are used to improve

1183

# Search quality, but are not exposed to end users.

1184

# The maximum number of elements is 1000.

1185

{ # Represents an interaction between a user and an item.

1186

"interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same

1187

# type exist for a single user, only the most recent action is recorded.

1188

"type": "A String",

1189

"principal": { # Reference to a user, group, or domain. # The user that acted on the item.

1190

"userResourceName": "A String", # This principal is a user identified using an external identity.

1191

# The name field must specify the user resource name with this format:

1192

# identitysources/{source_id}/users/{ID}

1193

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1194

# The name field must specify the group resource name with this format:

1195

# identitysources/{source_id}/groups/{ID}

1196

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1197

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1198

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1199

# customer.

1200

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

},

],

"searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item

1206

"quality": 3.14, # An indication of the quality of the item, used to influence search quality.

1207

# Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The

1208

# default value is 0.0.

1209

},

1210

"keywords": [ # Additional keywords or phrases that should match the item.

1211

# Used internally for user generated content.

1212

# The maximum number of elements is 100.

1213

# The maximum length is 8192 characters.

1214

"A String",

1215

],

1216

"sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply

1217

# this link to the title.

1218

# The maximum length is 2048 characters.

1219

"createTime": "A String", # The time when the item was created in the source repository.

1220

"objectType": "A String", # The type of the item. This should correspond to the name of an object

1221

# definition in the schema registered for the data source. For example, if

1222

# the schema for the data source contains an object definition with name

1223

# 'document', then item indexing requests for objects of that type should set

1224

# objectType to 'document'.

1225

# The maximum length is 256 characters.

},

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

1234

<pre>Retrieves the next page of results.

1235

1236

Args:

1237

previous_request: The request for the previous page. (required)

1238

previous_response: The response from the request for the previous page. (required)

1239

1240

Returns:

1241

A request object that you can call 'execute()' on to request the next

1242

page. Returns None if there are no more items in the collection.

</pre>

</div>

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

1248

<pre>Polls for unreserved items from the indexing queue and marks a

1249

set as reserved, starting with items that have

1250

the oldest timestamp from the highest priority

1251

ItemStatus.

1252

The priority order is as follows: <br />

ERROR

<br />

MODIFIED

<br />

NEW_ITEM

<br />

ACCEPTED

<br />

Reserving items ensures that polling from other threads

1262

cannot create overlapping sets.

1263

1264

After handling the reserved items, the client should put items back

1265

into the unreserved state, either by calling

index,

or by calling

push with

the type REQUEUE.

Items automatically become available (unreserved) after 4 hours even if no

1272

update or push method is called.

Args:

Format: datasources/{source_id} (required)

1277

body: object, The request body. (required)

1278

The object takes the form of:

1279

1280

{

1281

"queue": "A String", # Queue name to fetch items from. If unspecified, PollItems will

1282

# fetch from 'default' queue.

1283

# The maximum length is 100 characters.

1284

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

1285

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

1286

# Otherwise, ignore this field.

1287

},

1288

"limit": 42, # Maximum number of items to return.

1289

# <br />The maximum and the default value is 1000

1290

"connectorName": "A String", # Name of connector making this call.

1291

# <br />Format: datasources/{source_id}/connectors/{ID}

1292

"statusCodes": [ # Limit the items polled to the ones with these statuses.

"A String",

],

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1304

1305

{

1306

"items": [ # Set of items from the queue available for connector to process.

1307

# <br />These items have the following subset of fields populated: <br />

1308

# <br />version

1309

# <br />metadata.hash

1310

# <br />structured_data.hash

# <br />content.hash

# <br />payload

# <br />status

# <br />queue

{ # Represents a single object that is an item in the search index, such as a

1316

# file, folder, or a database record.

1317

"status": { # This contains item's status and any errors. # Status of the item.

1318

# Output only field.

1319

"processingErrors": [ # Error details in case the item is in ERROR state.

1320

{

1321

"code": "A String", # Error code indicating the nature of the error.

1322

"errorMessage": "A String", # Description of the error.

1323

"fieldViolations": [ # In case the item fields are invalid, this field contains the details

1324

# about the validation errors.

1325

{

1326

"field": "A String", # Path of field with violation.

1327

"description": "A String", # Description of the error.

},

],

},

],

"repositoryErrors": [ # Repository error reported by connector.

1333

{ # Errors when the connector is communicating to the source repository.

1334

"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.

1335

"errorMessage": "A String", # Message that describes the error. The maximum allowable length

1336

# of the message is 8192 characters.

1337

"type": "A String", # Type of error.

1338

},

1339

],

1340

"code": "A String", # Status code.

1341

},

1342

"queue": "A String", # Queue this item belongs to.

1343

# The maximum length is 100 characters.

1344

"name": "A String", # Name of the Item. Format:

1345

# datasources/{source_id}/items/{item_id}

1346

# <br />This is a required field.

1347

# The maximum length is 1536 characters.

1348

"acl": { # Access control list information for the item. For more information see # Access control list for this item.

1349

# https://developers.google.com/cloud-search/docs/guides/index-your-data#acls

1350

"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a

1351

# parent. This should always be set in tandem with the

1352

# inheritAclFrom

1353

# field. Also, when the

1354

# inheritAclFrom field

1355

# is set, this field should be set to a valid AclInheritanceType.

1356

"readers": [ # List of principals who are allowed to see the item in search results.

1357

# Optional if inheriting permissions from another item or if the item

1358

# is not intended to be visible, such as

1359

# virtual

1360

# containers.

1361

# The maximum number of elements is 1000.

1362

{ # Reference to a user, group, or domain.

1363

"userResourceName": "A String", # This principal is a user identified using an external identity.

1364

# The name field must specify the user resource name with this format:

1365

# identitysources/{source_id}/users/{ID}

1366

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1367

# The name field must specify the group resource name with this format:

1368

# identitysources/{source_id}/groups/{ID}

1369

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1370

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1371

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1372

# customer.

1373

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"deniedReaders": [ # List of principals who are explicitly denied access to the item in search

1378

# results. While principals are denied access by default, use denied readers

1379

# to handle exceptions and override the list allowed readers.

1380

# The maximum number of elements is 100.

1381

{ # Reference to a user, group, or domain.

1382

"userResourceName": "A String", # This principal is a user identified using an external identity.

1383

# The name field must specify the user resource name with this format:

1384

# identitysources/{source_id}/users/{ID}

1385

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1386

# The name field must specify the group resource name with this format:

1387

# identitysources/{source_id}/groups/{ID}

1388

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1389

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1390

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1391

# customer.

1392

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"owners": [ # Optional. List of owners for the item. This field has no bearing on

1397

# document access permissions. It does, however, offer

1398

# a slight ranking boosts items where the querying user is an owner.

1399

# The maximum number of elements is 5.

1400

{ # Reference to a user, group, or domain.

1401

"userResourceName": "A String", # This principal is a user identified using an external identity.

1402

# The name field must specify the user resource name with this format:

1403

# identitysources/{source_id}/users/{ID}

1404

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1405

# The name field must specify the group resource name with this format:

1406

# identitysources/{source_id}/groups/{ID}

1407

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1408

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1409

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1410

# customer.

1411

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.

1416

# Note: ACL inheritance *only* provides access permissions

1417

# to child items and does not define structural relationships, nor does it

1418

# provide convenient ways to delete large groups of items.

1419

# Deleting an ACL parent from the index only alters the access permissions of

1420

# child items that reference the parent in the

1421

# inheritAclFrom

1422

# field. The item is still in the index, but may not

1423

# visible in search results. By contrast, deletion of a container item

1424

# also deletes all items that reference the container via the

1425

# containerName

1426

# field.

1427

# The maximum length for this field is 1536 characters.

1428

},

1429

"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.

1430

"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.

1431

# This reference is created via upload

1432

# method.

1433

# Updating of item content may refer to this uploaded content via

1434

# contentDataRef.

1435

"name": "A String", # Name of the content reference.

1436

# The maximum length is 2048 characters.

1437

},

1438

"contentFormat": "A String",

1439

"hash": "A String", # Hashing info calculated and provided by the API client for content.

1440

# Can be used with the items.push method to calculate modified state.

1441

# The maximum length is 2048 characters.

1442

"inlineContent": "A String", # Content that is supplied inlined within the update method.

1443

# The maximum length is 102400 bytes (100 KiB).

1444

},

1445

"version": "A String", # Required. The indexing system stores the version from the datasource as a

1446

# byte string and compares the Item version in the index

1447

# to the version of the queued Item using lexical ordering.

1448

# <br /><br />

1449

# Cloud Search Indexing won't index or delete any queued item with

1450

# a version value that is less than or equal to the version of the

1451

# currently indexed item.

1452

# The maximum length for this field is 1024 bytes.

1453

"itemType": "A String", # Type for this item.

1454

"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered

1455

# object definition in the schema for the data source.

1456

"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object

1457

# definition in the schema for the data source.

1458

"properties": [ # The properties for the object.

1459

# The maximum number of elements is 1000.

1460

{ # A typed name-value pair for structured data. The type of the value should

1461

# be the same as the registered type for the `name` property in the object

1462

# definition of `objectType`.

1463

"objectValues": { # List of object values.

1464

"values": [

1465

# Object with schema name: StructuredDataObject

1466

],

1467

},

1468

"dateValues": { # List of date values.

1469

"values": [

1470

{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

1471

"month": 42, # Month of date. Must be from 1 to 12.

1472

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

1473

"year": 42, # Year of date. Must be from 1 to 9999.

},

],

},

"textValues": { # List of text values.

1478

"values": [ # The maximum allowable length for text values is 2048 characters.

"A String",

],

},

"enumValues": { # List of enum values.

1483

"values": [ # The maximum allowable length for string values is 32 characters.

"A String",

],

},

"integerValues": { # List of integer values.

"values": [

"A String",

],

},

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"htmlValues": { # List of html values.

1498

"values": [ # The maximum allowable length for html values is 2048 characters.

"A String",

],

},

"booleanValue": True or False,

1503

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

"name": "A String", # The name of the property. This name should correspond to the name of the

1509

# property that was registered for object definition in the schema.

1510

# The maximum allowable length for this property is 256 characters.

},

],

},

"hash": "A String", # Hashing value provided by the API caller.

1515

# This can be used with the

1516

# items.push

1517

# method to calculate modified state.

1518

# The maximum length is 2048 characters.

1519

},

1520

"payload": "A String", # Additional state connector can store for this item.

1521

# The maximum length is 10000 bytes.

1522

"metadata": { # Available metadata fields for the item. # Metadata information.

1523

"mimeType": "A String", # The original mime-type of

1524

# ItemContent.content

1525

# in the source repository.

1526

# The maximum length is 256 characters.

1527

"containerName": "A String", # The name of the container for this item.

1528

# Deletion of the container item leads to automatic deletion of this

1529

# item. Note: ACLs are not inherited from a container item.

1530

# To provide ACL inheritance for an item, use the

1531

# inheritAclFrom

1532

# field. The maximum length is 1536 characters.

1533

"updateTime": "A String", # The time when the item was last modified in the source repository.

1534

"hash": "A String", # Hashing value provided by the API caller.

1535

# This can be used with the

1536

# items.push

1537

# method to calculate modified state.

1538

# The maximum length is 2048 characters.

1539

"contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For

1540

# more information, see

1541

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

1542

# The maximum length is 32 characters.

1543

"title": "A String", # The title of the item. If given, this will be the displayed title of the

1544

# Search result.

1545

# The maximum length is 2048 characters.

1546

"interactions": [ # A list of interactions for the item. Interactions are used to improve

1547

# Search quality, but are not exposed to end users.

1548

# The maximum number of elements is 1000.

1549

{ # Represents an interaction between a user and an item.

1550

"interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same

1551

# type exist for a single user, only the most recent action is recorded.

1552

"type": "A String",

1553

"principal": { # Reference to a user, group, or domain. # The user that acted on the item.

1554

"userResourceName": "A String", # This principal is a user identified using an external identity.

1555

# The name field must specify the user resource name with this format:

1556

# identitysources/{source_id}/users/{ID}

1557

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1558

# The name field must specify the group resource name with this format:

1559

# identitysources/{source_id}/groups/{ID}

1560

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1561

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1562

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1563

# customer.

1564

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

},

],

"searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item

1570

"quality": 3.14, # An indication of the quality of the item, used to influence search quality.

1571

# Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The

1572

# default value is 0.0.

1573

},

1574

"keywords": [ # Additional keywords or phrases that should match the item.

1575

# Used internally for user generated content.

1576

# The maximum number of elements is 100.

1577

# The maximum length is 8192 characters.

1578

"A String",

1579

],

1580

"sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply

1581

# this link to the title.

1582

# The maximum length is 2048 characters.

1583

"createTime": "A String", # The time when the item was created in the source repository.

1584

"objectType": "A String", # The type of the item. This should correspond to the name of an object

1585

# definition in the schema registered for the data source. For example, if

1586

# the schema for the data source contains an object definition with name

1587

# 'document', then item indexing requests for objects of that type should set

1588

# objectType to 'document'.

1589

# The maximum length is 256 characters.

},

},

],

}</pre>

</div>

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

1598

<pre>Pushes an item onto a queue for later polling and updating.

Args:

push into the indexing queue.<br />

1603

Format: datasources/{source_id}/items/{ID}

1604

<br />This is a required field.

1605

The maximum length is 1536 characters. (required)

1606

body: object, The request body. (required)

1607

The object takes the form of:

1608

1609

{

1610

"item": { # Represents an item to be pushed to the indexing queue. # Item to push onto the queue.

1611

"contentHash": "A String", # Content hash of the item according to the repository. If specified, this is

1612

# used to determine how to modify this

1613

# item's status. Setting this field and the

1614

# type field results in argument

1615

# error.

1616

# The maximum length is 2048 characters.

1617

"metadataHash": "A String", # Metadata hash of the item according to the repository. If specified, this

1618

# is used to determine how to modify this

1619

# item's status. Setting this field and the

1620

# type field results in argument

1621

# error.

1622

# The maximum length is 2048 characters.

1623

"queue": "A String", # Queue to which this item belongs to. The <code>default</code> queue is

1624

# chosen if this field is not specified. The maximum length is

1625

# 512 characters.

1626

"repositoryError": { # Errors when the connector is communicating to the source repository. # Populate this field to store Connector or repository error details.

1627

# This information is displayed in the Admin Console.

1628

# This field may only be populated when the

1629

# Type is

1630

# REPOSITORY_ERROR.

1631

"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.

1632

"errorMessage": "A String", # Message that describes the error. The maximum allowable length

1633

# of the message is 8192 characters.

1634

"type": "A String", # Type of error.

1635

},

1636

"structuredDataHash": "A String", # Structured data hash of the item according to the repository. If specified,

1637

# this is used to determine how to modify this item's status. Setting this

1638

# field and the type field

1639

# results in argument error.

1640

# The maximum length is 2048 characters.

1641

"type": "A String", # The type of the push operation that defines the push behavior.

1642

"payload": "A String", # Provides additional document state information for the connector,

1643

# such as an alternate repository ID and other metadata.

1644

# The maximum length is 8192 bytes.

1645

},

1646

"connectorName": "A String", # Name of connector making this call.

1647

# <br />Format: datasources/{source_id}/connectors/{ID}

1648

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

1649

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

1650

# Otherwise, ignore this field.

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1661

1662

{ # Represents a single object that is an item in the search index, such as a

1663

# file, folder, or a database record.

1664

"status": { # This contains item's status and any errors. # Status of the item.

1665

# Output only field.

1666

"processingErrors": [ # Error details in case the item is in ERROR state.

1667

{

1668

"code": "A String", # Error code indicating the nature of the error.

1669

"errorMessage": "A String", # Description of the error.

1670

"fieldViolations": [ # In case the item fields are invalid, this field contains the details

1671

# about the validation errors.

1672

{

1673

"field": "A String", # Path of field with violation.

1674

"description": "A String", # Description of the error.

},

],

},

],

"repositoryErrors": [ # Repository error reported by connector.

1680

{ # Errors when the connector is communicating to the source repository.

1681

"httpStatusCode": 42, # Error codes. Matches the definition of HTTP status codes.

1682

"errorMessage": "A String", # Message that describes the error. The maximum allowable length

1683

# of the message is 8192 characters.

1684

"type": "A String", # Type of error.

1685

},

1686

],

1687

"code": "A String", # Status code.

1688

},

1689

"queue": "A String", # Queue this item belongs to.

1690

# The maximum length is 100 characters.

1691

"name": "A String", # Name of the Item. Format:

1692

# datasources/{source_id}/items/{item_id}

1693

# <br />This is a required field.

1694

# The maximum length is 1536 characters.

1695

"acl": { # Access control list information for the item. For more information see # Access control list for this item.

1696

# https://developers.google.com/cloud-search/docs/guides/index-your-data#acls

1697

"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a

1698

# parent. This should always be set in tandem with the

1699

# inheritAclFrom

1700

# field. Also, when the

1701

# inheritAclFrom field

1702

# is set, this field should be set to a valid AclInheritanceType.

1703

"readers": [ # List of principals who are allowed to see the item in search results.

1704

# Optional if inheriting permissions from another item or if the item

1705

# is not intended to be visible, such as

1706

# virtual

1707

# containers.

1708

# The maximum number of elements is 1000.

1709

{ # Reference to a user, group, or domain.

1710

"userResourceName": "A String", # This principal is a user identified using an external identity.

1711

# The name field must specify the user resource name with this format:

1712

# identitysources/{source_id}/users/{ID}

1713

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1714

# The name field must specify the group resource name with this format:

1715

# identitysources/{source_id}/groups/{ID}

1716

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1717

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1718

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1719

# customer.

1720

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"deniedReaders": [ # List of principals who are explicitly denied access to the item in search

1725

# results. While principals are denied access by default, use denied readers

1726

# to handle exceptions and override the list allowed readers.

1727

# The maximum number of elements is 100.

1728

{ # Reference to a user, group, or domain.

1729

"userResourceName": "A String", # This principal is a user identified using an external identity.

1730

# The name field must specify the user resource name with this format:

1731

# identitysources/{source_id}/users/{ID}

1732

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1733

# The name field must specify the group resource name with this format:

1734

# identitysources/{source_id}/groups/{ID}

1735

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1736

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1737

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1738

# customer.

1739

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"owners": [ # Optional. List of owners for the item. This field has no bearing on

1744

# document access permissions. It does, however, offer

1745

# a slight ranking boosts items where the querying user is an owner.

1746

# The maximum number of elements is 5.

1747

{ # Reference to a user, group, or domain.

1748

"userResourceName": "A String", # This principal is a user identified using an external identity.

1749

# The name field must specify the user resource name with this format:

1750

# identitysources/{source_id}/users/{ID}

1751

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1752

# The name field must specify the group resource name with this format:

1753

# identitysources/{source_id}/groups/{ID}

1754

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1755

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1756

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1757

# customer.

1758

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

],

"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from.

1763

# Note: ACL inheritance *only* provides access permissions

1764

# to child items and does not define structural relationships, nor does it

1765

# provide convenient ways to delete large groups of items.

1766

# Deleting an ACL parent from the index only alters the access permissions of

1767

# child items that reference the parent in the

1768

# inheritAclFrom

1769

# field. The item is still in the index, but may not

1770

# visible in search results. By contrast, deletion of a container item

1771

# also deletes all items that reference the container via the

1772

# containerName

1773

# field.

1774

# The maximum length for this field is 1536 characters.

1775

},

1776

"content": { # Content of an item to be indexed and surfaced by Cloud Search. # Item content to be indexed and made text searchable.

1777

"contentDataRef": { # Represents an upload session reference. # Upload reference ID of a previously uploaded content via write method.

1778

# This reference is created via upload

1779

# method.

1780

# Updating of item content may refer to this uploaded content via

1781

# contentDataRef.

1782

"name": "A String", # Name of the content reference.

1783

# The maximum length is 2048 characters.

1784

},

1785

"contentFormat": "A String",

1786

"hash": "A String", # Hashing info calculated and provided by the API client for content.

1787

# Can be used with the items.push method to calculate modified state.

1788

# The maximum length is 2048 characters.

1789

"inlineContent": "A String", # Content that is supplied inlined within the update method.

1790

# The maximum length is 102400 bytes (100 KiB).

1791

},

1792

"version": "A String", # Required. The indexing system stores the version from the datasource as a

1793

# byte string and compares the Item version in the index

1794

# to the version of the queued Item using lexical ordering.

1795

# <br /><br />

1796

# Cloud Search Indexing won't index or delete any queued item with

1797

# a version value that is less than or equal to the version of the

1798

# currently indexed item.

1799

# The maximum length for this field is 1024 bytes.

1800

"itemType": "A String", # Type for this item.

1801

"structuredData": { # Available structured data fields for the item. # The structured data for the item that should conform to a registered

1802

# object definition in the schema for the data source.

1803

"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object

1804

# definition in the schema for the data source.

1805

"properties": [ # The properties for the object.

1806

# The maximum number of elements is 1000.

1807

{ # A typed name-value pair for structured data. The type of the value should

1808

# be the same as the registered type for the `name` property in the object

1809

# definition of `objectType`.

1810

"objectValues": { # List of object values.

1811

"values": [

1812

# Object with schema name: StructuredDataObject

1813

],

1814

},

1815

"dateValues": { # List of date values.

1816

"values": [

1817

{ # Represents a whole calendar date, for example a date of birth. The time of day and time zone are either specified elsewhere or are not significant. The date is relative to the [Proleptic Gregorian Calendar](https://en.wikipedia.org/wiki/Proleptic_Gregorian_calendar). The date must be a valid calendar date between the year 1 and 9999.

1818

"month": 42, # Month of date. Must be from 1 to 12.

1819

"day": 42, # Day of month. Must be from 1 to 31 and valid for the year and month.

1820

"year": 42, # Year of date. Must be from 1 to 9999.

},

],

},

"textValues": { # List of text values.

1825

"values": [ # The maximum allowable length for text values is 2048 characters.

"A String",

],

},

"enumValues": { # List of enum values.

1830

"values": [ # The maximum allowable length for string values is 32 characters.

"A String",

],

},

"integerValues": { # List of integer values.

"values": [

"A String",

],

},

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"htmlValues": { # List of html values.

1845

"values": [ # The maximum allowable length for html values is 2048 characters.

"A String",

],

},

"booleanValue": True or False,

1850

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

"name": "A String", # The name of the property. This name should correspond to the name of the

1856

# property that was registered for object definition in the schema.

1857

# The maximum allowable length for this property is 256 characters.

},

],

},

"hash": "A String", # Hashing value provided by the API caller.

1862

# This can be used with the

1863

# items.push

1864

# method to calculate modified state.

1865

# The maximum length is 2048 characters.

1866

},

1867

"payload": "A String", # Additional state connector can store for this item.

1868

# The maximum length is 10000 bytes.

1869

"metadata": { # Available metadata fields for the item. # Metadata information.

1870

"mimeType": "A String", # The original mime-type of

1871

# ItemContent.content

1872

# in the source repository.

1873

# The maximum length is 256 characters.

1874

"containerName": "A String", # The name of the container for this item.

1875

# Deletion of the container item leads to automatic deletion of this

1876

# item. Note: ACLs are not inherited from a container item.

1877

# To provide ACL inheritance for an item, use the

1878

# inheritAclFrom

1879

# field. The maximum length is 1536 characters.

1880

"updateTime": "A String", # The time when the item was last modified in the source repository.

1881

"hash": "A String", # Hashing value provided by the API caller.

1882

# This can be used with the

1883

# items.push

1884

# method to calculate modified state.

1885

# The maximum length is 2048 characters.

1886

"contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For

1887

# more information, see

1888

# http://www.unicode.org/reports/tr35/#Unicode_locale_identifier.

1889

# The maximum length is 32 characters.

1890

"title": "A String", # The title of the item. If given, this will be the displayed title of the

1891

# Search result.

1892

# The maximum length is 2048 characters.

1893

"interactions": [ # A list of interactions for the item. Interactions are used to improve

1894

# Search quality, but are not exposed to end users.

1895

# The maximum number of elements is 1000.

1896

{ # Represents an interaction between a user and an item.

1897

"interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same

1898

# type exist for a single user, only the most recent action is recorded.

1899

"type": "A String",

1900

"principal": { # Reference to a user, group, or domain. # The user that acted on the item.

1901

"userResourceName": "A String", # This principal is a user identified using an external identity.

1902

# The name field must specify the user resource name with this format:

1903

# identitysources/{source_id}/users/{ID}

1904

"groupResourceName": "A String", # This principal is a group identified using an external identity.

1905

# The name field must specify the group resource name with this format:

1906

# identitysources/{source_id}/groups/{ID}

1907

"gsuitePrincipal": { # This principal is a GSuite user, group or domain.

1908

"gsuiteUserEmail": "A String", # This principal references a G Suite user account

1909

"gsuiteDomain": True or False, # This principal represents all users of the G Suite domain of the

1910

# customer.

1911

"gsuiteGroupEmail": "A String", # This principal references a G Suite group account

},

},

},

],

"searchQualityMetadata": { # Additional search quality metadata of the item. # Additional search quality metadata of the item

1917

"quality": 3.14, # An indication of the quality of the item, used to influence search quality.

1918

# Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The

1919

# default value is 0.0.

1920

},

1921

"keywords": [ # Additional keywords or phrases that should match the item.

1922

# Used internally for user generated content.

1923

# The maximum number of elements is 100.

1924

# The maximum length is 8192 characters.

1925

"A String",

1926

],

1927

"sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply

1928

# this link to the title.

1929

# The maximum length is 2048 characters.

1930

"createTime": "A String", # The time when the item was created in the source repository.

1931

"objectType": "A String", # The type of the item. This should correspond to the name of an object

1932

# definition in the schema registered for the data source. For example, if

1933

# the schema for the data source contains an object definition with name

1934

# 'document', then item indexing requests for objects of that type should set

1935

# objectType to 'document'.

1936

# The maximum length is 256 characters.

},

}</pre>

</div>

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

1943

<pre>Unreserves all items from a queue, making them all eligible to be

1944

polled. This method is useful for resetting the indexing queue

1945

after a connector has been restarted.

Args:

Format: datasources/{source_id} (required)

1950

body: object, The request body. (required)

1951

The object takes the form of:

1952

1953

{

1954

"queue": "A String", # Name of a queue to unreserve items from.

1955

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

1956

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

1957

# Otherwise, ignore this field.

1958

},

1959

"connectorName": "A String", # Name of connector making this call.

1960

# <br />Format: datasources/{source_id}/connectors/{ID}

1961

}

1962

1963

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1970

1971

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

1972

# network API call.

1973

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

1974

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

1975

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

1976

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

1977

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

1978

},

1979

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

1980

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

1981

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

1982

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

1983

#

1984

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

1985

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

1986

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

1987

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

1988

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

1989

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

1990

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

1991

# message types for APIs to use.

1992

{

1993

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

},

],

},

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

1998

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

1999

# available.

2000

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

2001

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

2002

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

2003

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

2004

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

2005

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

2006

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

2007

# `TakeSnapshotResponse`.

2008

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

2009

},

2010

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

2011

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

2012

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

}</pre>

</div>

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

2018

<pre>Creates an upload session for uploading item content. For items smaller

2019

than 100 KiB, it's easier to embed the content

inline within

update.

Args:

Format: datasources/{source_id}/items/{item_id}. (required)

2026

body: object, The request body. (required)

2027

The object takes the form of:

2028

2029

{ # Start upload file request.

2030

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

2031

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

2032

# Otherwise, ignore this field.

2033

},

2034

"connectorName": "A String", # Name of connector making this call.

2035

# <br />Format: datasources/{source_id}/connectors/{ID}

2036

}

2037

2038

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

2045

2046

{ # Represents an upload session reference.

2047

# This reference is created via upload

2048

# method.

2049

# Updating of item content may refer to this uploaded content via

2050

# contentDataRef.

2051

"name": "A String", # Name of the content reference.

2052

# The maximum length is 2048 characters.

}</pre>

</div>

</body></html>