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

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

[diff] [blame]

83

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

Bu Sun Kim

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

[diff] [blame]

84

<p class="firstline">Checks whether an item is accessible by specified principal.</p>

85

Dan O'Meara

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

[diff] [blame]

86

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

Bu Sun Kim

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

[diff] [blame]

87

<p class="firstline">Fetches the item whose viewUrl exactly matches that of the URL provided</p>

88

89

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

90

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

91

<h3>Method Details</h3>

92

Dan O'Meara

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<pre>Checks whether an item is accessible by specified principal.

95

Dan O'Meara

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

[diff] [blame]

96

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

97

Bu Sun Kim

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

[diff] [blame]

98

Args:

99

name: string, Item name, format:

100

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

Dan O'Meara

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

[diff] [blame]

101

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

102

The object takes the form of:

103

104

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

Bu Sun Kim

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

[diff] [blame]

105

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

106

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

Bu Sun Kim

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

[diff] [blame]

107

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

108

# customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

109

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

Bu Sun Kim

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

[diff] [blame]

110

},

111

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

Bu Sun Kim

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

[diff] [blame]

112

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

113

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

114

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

115

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

116

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

Bu Sun Kim

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

[diff] [blame]

117

}

118

119

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

120

Otherwise, ignore this field.

121

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

128

129

{

Bu Sun Kim

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

[diff] [blame]

130

"hasAccess": True or False, # Returns true if principal has access. Returns false otherwise.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

135

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

Bu Sun Kim

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

[diff] [blame]

136

<pre>Fetches the item whose viewUrl exactly matches that of the URL provided

137

in the request.

138

Dan O'Meara

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

[diff] [blame]

139

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

140

Bu Sun Kim

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

[diff] [blame]

141

Args:

142

name: string, Source name, format:

143

datasources/{source_id} (required)

Dan O'Meara

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

[diff] [blame]

144

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

145

The object takes the form of:

146

147

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

148

"viewUrl": "A String", # Specify the full view URL to find the corresponding item.

149

# The maximum length is 2048 characters.

150

"pageToken": "A String", # The next_page_token value returned from a previous request, if any.

Bu Sun Kim

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

[diff] [blame]

151

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

152

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

Bu Sun Kim

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

[diff] [blame]

153

# Otherwise, ignore this field.

154

},

Bu Sun Kim

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

[diff] [blame]

155

}

156

157

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

164

165

{

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

166

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

167

# more results in the list.

Bu Sun Kim

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

[diff] [blame]

168

"items": [

Bu Sun Kim

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

[diff] [blame]

169

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

170

# file, folder, or a database record.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

171

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

172

# The maximum length is 100 characters.

Bu Sun Kim

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

[diff] [blame]

173

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

174

# object definition in the schema for the data source.

175

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

176

# This can be used with the

177

# items.push

178

# method to calculate modified state.

Bu Sun Kim

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

[diff] [blame]

179

# The maximum length is 2048 characters.

Bu Sun Kim

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

[diff] [blame]

180

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

181

# definition in the schema for the data source.

182

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

183

# The maximum number of elements is 1000.

184

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

185

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

186

# definition of `objectType`.

Bu Sun Kim

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

[diff] [blame]

187

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

192

"doubleValues": { # List of double values.

Bu Sun Kim

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

[diff] [blame]

193

"values": [

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

3.14,

],

},

"integerValues": { # List of integer values.

198

"values": [

199

"A String",

Bu Sun Kim

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

[diff] [blame]

200

],

201

},

202

"dateValues": { # List of date values.

203

"values": [

204

{ # 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.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

205

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

Bu Sun Kim

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

[diff] [blame]

206

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

207

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

"enumValues": { # List of enum values.

212

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

213

"A String",

214

],

215

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

216

"textValues": { # List of text values.

217

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

"A String",

],

},

"booleanValue": True or False,

222

"htmlValues": { # List of html values.

223

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

"A String",

],

},

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

228

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

229

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

230

"objectValues": { # List of object values.

231

"values": [

232

# Object with schema name: StructuredDataObject

233

],

234

},

Bu Sun Kim

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

[diff] [blame]

235

},

236

],

Bu Sun Kim

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

[diff] [blame]

237

},

Bu Sun Kim

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

[diff] [blame]

238

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

239

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

240

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

241

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

242

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

243

# default value is 0.0.

244

},

245

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

246

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

247

# ItemContent.content

248

# in the source repository.

249

# The maximum length is 256 characters.

250

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

251

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

252

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

253

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

254

# objectType to 'document'.

255

# The maximum length is 256 characters.

256

"sourceRepositoryUrl": "A String", # Link to the source repository serving the data. &#83;earch results apply

257

# this link to the title.

258

# Whitespace or special characters may cause Cloud &#83;earch result links to

259

# trigger a redirect notice; to avoid this, encode the URL.

260

# The maximum length is 2048 characters.

261

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

262

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

263

# The maximum number of elements is 1000.

264

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

265

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

266

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

267

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

268

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

269

# customer.

270

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

Bu Sun Kim

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

[diff] [blame]

271

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

272

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

273

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

274

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

275

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

276

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

277

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

278

},

279

"type": "A String",

280

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

281

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

Bu Sun Kim

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

[diff] [blame]

282

},

283

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

284

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

285

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

286

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

287

# To provide ACL inheritance for an item, use the

288

# inheritAclFrom

289

# field. The maximum length is 1536 characters.

290

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

291

# Used internally for user generated content.

292

# The maximum number of elements is 100.

293

# The maximum length is 8192 characters.

294

"A String",

Bu Sun Kim

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

[diff] [blame]

295

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

296

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

297

# Search result.

298

# The maximum length is 2048 characters.

299

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

300

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

301

# This can be used with the

302

# items.push

303

# method to calculate modified state.

304

# The maximum length is 2048 characters.

305

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

306

# more information, see

307

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

308

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame]

309

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

310

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

311

# byte string and compares the Item version in the index

312

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

313

# <br /><br />

314

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

315

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

316

# currently indexed item.

317

# The maximum length for this field is 1024 bytes.

Bu Sun Kim

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

[diff] [blame]

318

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

319

# [Map ACLs](/cloud-search/docs/guides/acls).

320

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

321

# document access permissions. It does, however, offer

322

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

323

# The maximum number of elements is 5.

324

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

Bu Sun Kim

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

[diff] [blame]

325

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

326

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

Bu Sun Kim

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

[diff] [blame]

327

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

328

# customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

329

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

Bu Sun Kim

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

[diff] [blame]

330

},

331

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

332

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

333

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

334

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

335

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

336

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

Bu Sun Kim

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

[diff] [blame]

337

},

338

],

Bu Sun Kim

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

[diff] [blame]

339

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

340

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

341

# to handle exceptions and override the list allowed readers.

342

# The maximum number of elements is 100.

343

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

Bu Sun Kim

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

[diff] [blame]

344

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

345

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

Bu Sun Kim

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

[diff] [blame]

346

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

347

# customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

348

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

Bu Sun Kim

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

[diff] [blame]

349

},

350

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

351

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

352

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

353

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

354

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

355

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

Bu Sun Kim

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

[diff] [blame]

356

},

357

],

358

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

359

# Note: ACL inheritance *only* provides access permissions

360

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

361

# provide convenient ways to delete large groups of items.

362

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

363

# child items that reference the parent in the

364

# inheritAclFrom

365

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

366

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

367

# also deletes all items that reference the container via the

368

# containerName

369

# field.

370

# The maximum length for this field is 1536 characters.

371

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

372

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

373

# is not intended to be visible, such as

374

# virtual

375

# containers.

376

# The maximum number of elements is 1000.

377

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

Bu Sun Kim

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

[diff] [blame]

378

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

379

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

Bu Sun Kim

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

[diff] [blame]

380

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

381

# customer.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

382

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

Bu Sun Kim

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

[diff] [blame]

383

},

384

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

385

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

386

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

387

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

388

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

389

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

Bu Sun Kim

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

[diff] [blame]

390

},

391

],

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

392

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

393

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

Bu Sun Kim

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

[diff] [blame]

394

# inheritAclFrom

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

395

# field. Also, when the

396

# inheritAclFrom field

397

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

Bu Sun Kim

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

[diff] [blame]

398

},

Bu Sun Kim

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

[diff] [blame]

399

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

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

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.

Bu Sun Kim

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

[diff] [blame]

403

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

404

# This reference is created via upload

405

# method.

406

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

407

# contentDataRef.

408

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

409

# The maximum length is 2048 characters.

410

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

411

"contentFormat": "A String",

Bu Sun Kim

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

[diff] [blame]

412

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

413

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

Bu Sun Kim

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

[diff] [blame]

414

},

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

415

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

416

# The maximum length is 10000 bytes.

417

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

418

# Output only field.

419

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

420

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

421

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

422

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

423

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

424

# of the message is 8192 characters.

425

},

426

],

427

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

428

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

429

{

430

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

431

# about the validation errors.

432

{

433

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

434

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

435

},

436

],

437

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

438

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

},

],

},

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

443

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

444

# <br />This is a required field.

445

# The maximum length is 1536 characters.

446

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

Bu Sun Kim

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

[diff] [blame]

},

],

}</pre>

</div>

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

454

<pre>Retrieves the next page of results.

455

456

Args:

457

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

458

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

459

460

Returns:

Bu Sun Kim

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

[diff] [blame]

461

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

Bu Sun Kim