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

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

Bu Sun Kim

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

[diff] [blame]

106

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

107

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

Bu Sun Kim

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

[diff] [blame]

108

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

109

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

110

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

111

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

112

# customer.

113

},

114

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

115

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

116

# identitysources/{source_id}/groups/{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-05-20 12:08:20 -0700

[diff] [blame]

148

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

149

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

150

# Otherwise, ignore this field.

151

},

Bu Sun Kim

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

[diff] [blame]

152

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

Bu Sun Kim

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

[diff] [blame^]

153

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

154

# The maximum length is 2048 characters.

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-05-20 12:08:20 -0700

[diff] [blame]

166

"items": [

Bu Sun Kim

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

[diff] [blame]

167

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

168

# file, folder, or a database record.

Bu Sun Kim

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

[diff] [blame^]

169

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

170

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

171

# object definition in the schema for the data source.

172

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

173

# This can be used with the

174

# items.push

175

# method to calculate modified state.

Bu Sun Kim

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

[diff] [blame]

176

# The maximum length is 2048 characters.

Bu Sun Kim

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

[diff] [blame^]

177

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

178

# definition in the schema for the data source.

179

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

180

# The maximum number of elements is 1000.

181

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

182

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

183

# definition of `objectType`.

184

"integerValues": { # List of integer values.

"values": [

"A String",

],

},

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

190

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

191

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

192

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"booleanValue": True or False,

198

"htmlValues": { # List of html values.

199

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

"A String",

],

},

"textValues": { # List of text values.

204

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

"A String",

],

},

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

"objectValues": { # List of object values.

214

"values": [

215

# Object with schema name: StructuredDataObject

216

],

217

},

218

"dateValues": { # List of date values.

219

"values": [

220

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

221

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

222

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

223

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

},

],

},

"enumValues": { # List of enum values.

228

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

"A String",

],

},

},

],

Bu Sun Kim

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

[diff] [blame]

234

},

Bu Sun Kim

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

[diff] [blame^]

235

},

236

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

237

# Output only field.

238

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

239

{

240

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

241

# about the validation errors.

242

{

243

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

244

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

245

},

246

],

247

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

248

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

249

},

250

],

251

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

252

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

253

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

254

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

255

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

256

# of the message is 8192 characters.

257

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

},

],

},

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

262

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

263

# <br />This is a required field.

264

# The maximum length is 1536 characters.

265

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

266

# The maximum length is 10000 bytes.

267

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

268

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

269

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

270

# document access permissions. It does, however, offer

271

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

272

# The maximum number of elements is 5.

273

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

274

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

275

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

276

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

277

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

278

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

279

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

280

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

281

# customer.

282

},

283

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

284

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

285

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

286

},

287

],

288

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

289

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

290

# inheritAclFrom

291

# field. Also, when the

292

# inheritAclFrom field

293

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

294

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

295

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

296

# to handle exceptions and override the list allowed readers.

297

# The maximum number of elements is 100.

298

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

299

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

300

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

301

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

302

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

303

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

304

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

305

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

306

# customer.

307

},

308

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

309

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

310

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

311

},

312

],

313

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

314

# Note: ACL inheritance *only* provides access permissions

315

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

316

# provide convenient ways to delete large groups of items.

317

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

318

# child items that reference the parent in the

319

# inheritAclFrom

320

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

321

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

322

# also deletes all items that reference the container via the

323

# containerName

324

# field.

325

# The maximum length for this field is 1536 characters.

326

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

327

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

328

# is not intended to be visible, such as

329

# virtual

330

# containers.

331

# The maximum number of elements is 1000.

332

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

333

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

334

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

335

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

336

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

337

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

338

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

339

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

340

# customer.

341

},

342

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

343

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

344

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

345

},

346

],

Bu Sun Kim

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

[diff] [blame]

347

},

348

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

Bu Sun Kim

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

[diff] [blame]

349

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

350

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

351

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

352

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

353

# objectType to 'document'.

354

# The maximum length is 256 characters.

355

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

356

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

357

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

358

# default value is 0.0.

359

},

360

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

361

# This can be used with the

362

# items.push

363

# method to calculate modified state.

364

# The maximum length is 2048 characters.

365

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

366

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

367

# The maximum number of elements is 1000.

368

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

369

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

370

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

371

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

372

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

373

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

374

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

375

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

376

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

377

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

378

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

379

# customer.

380

},

381

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

382

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

383

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

},

"type": "A String",

},

],

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

389

# Used internally for user generated content.

390

# The maximum number of elements is 100.

391

# The maximum length is 8192 characters.

392

"A String",

393

],

394

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

395

# ItemContent.content

396

# in the source repository.

397

# The maximum length is 256 characters.

398

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

399

# Search result.

400

# The maximum length is 2048 characters.

401

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

402

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

403

# more information, see

404

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

405

# The maximum length is 32 characters.

Bu Sun Kim

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

[diff] [blame^]

406

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

407

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

408

# this link to the title.

409

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

410

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

411

# The maximum length is 2048 characters.

412

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

413

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

414

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

415

# To provide ACL inheritance for an item, use the

416

# inheritAclFrom

417

# field. The maximum length is 1536 characters.

Bu Sun Kim

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

[diff] [blame]

418

},

Bu Sun Kim

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

[diff] [blame^]

419

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

420

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

421

# This reference is created via upload

422

# method.

423

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

424

# contentDataRef.

425

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

426

# The maximum length is 2048 characters.

427

},

428

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

429

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

430

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

431

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

432

# The maximum length is 2048 characters.

433

"contentFormat": "A String",

434

},

Bu Sun Kim

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

[diff] [blame]

435

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

436

# byte string and compares the Item version in the index

437

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

438

# <br /><br />

439

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

440

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

441

# currently indexed item.

442

# The maximum length for this field is 1024 bytes.

Bu Sun Kim

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

[diff] [blame^]

443

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

444

# The maximum length is 100 characters.

Bu Sun Kim

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

[diff] [blame]

445

},

446

],

Bu Sun Kim

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

[diff] [blame^]

447

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

448

# more results in the list.

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