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

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

149

# The maximum length is 2048 characters.

150

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

151

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

152

# Otherwise, ignore this field.

153

},

Bu Sun Kim

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

[diff] [blame^]

154

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

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

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

Bu Sun Kim

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

[diff] [blame]

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

[diff] [blame^]

171

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

172

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

173

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

174

# The maximum length is 2048 characters.

175

"contentFormat": "A String",

176

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

177

# This reference is created via upload

178

# method.

179

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

180

# contentDataRef.

181

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

182

# The maximum length is 2048 characters.

183

},

184

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

185

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

186

},

187

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

188

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

189

# this link to the title.

190

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

191

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

192

# The maximum length is 2048 characters.

193

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

194

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

195

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

196

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

197

# To provide ACL inheritance for an item, use the

198

# inheritAclFrom

199

# field. The maximum length is 1536 characters.

200

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

201

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

202

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

203

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

204

# objectType to 'document'.

205

# The maximum length is 256 characters.

206

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

207

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

208

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

209

# default value is 0.0.

210

},

211

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

212

# This can be used with the

213

# items.push

214

# method to calculate modified state.

215

# The maximum length is 2048 characters.

216

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

217

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

218

# The maximum number of elements is 1000.

219

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

220

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

221

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

222

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

223

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

224

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

225

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

226

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

227

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

228

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

229

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

230

# customer.

231

},

232

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

233

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

234

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

},

"type": "A String",

},

],

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

240

# Used internally for user generated content.

241

# The maximum number of elements is 100.

242

# The maximum length is 8192 characters.

243

"A String",

244

],

245

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

246

# ItemContent.content

247

# in the source repository.

248

# The maximum length is 256 characters.

249

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

250

# Search result.

251

# The maximum length is 2048 characters.

252

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

253

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

254

# more information, see

255

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

256

# The maximum length is 32 characters.

257

},

258

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

259

# The maximum length is 100 characters.

260

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

261

# byte string and compares the Item version in the index

262

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

263

# <br /><br />

264

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

265

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

266

# currently indexed item.

267

# The maximum length for this field is 1024 bytes.

268

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

269

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

270

# object definition in the schema for the data source.

271

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

272

# This can be used with the

273

# items.push

274

# method to calculate modified state.

275

# The maximum length is 2048 characters.

276

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

277

# definition in the schema for the data source.

278

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

279

# The maximum number of elements is 1000.

280

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

281

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

282

# definition of `objectType`.

283

"objectValues": { # List of object values.

284

"values": [

285

# Object with schema name: StructuredDataObject

286

],

287

},

288

"enumValues": { # List of enum values.

289

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

"A String",

],

},

"dateValues": { # List of date values.

294

"values": [

295

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

296

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

297

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

298

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

},

],

},

"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

308

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

309

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

310

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"booleanValue": True or False,

316

"textValues": { # List of text values.

317

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

"A String",

],

},

"htmlValues": { # List of html values.

322

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

"A String",

],

},

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

},

],

},

},

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

Bu Sun Kim

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

[diff] [blame]

336

# Output only field.

Bu Sun Kim

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

[diff] [blame^]

337

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

338

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

339

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

340

# of the message is 8192 characters.

341

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

342

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

343

},

344

],

345

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

Bu Sun Kim

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

[diff] [blame]

346

{

Bu Sun Kim

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

[diff] [blame^]

347

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

348

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

349

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

Bu Sun Kim

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

[diff] [blame]

350

# about the validation errors.

351

{

Bu Sun Kim

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

[diff] [blame^]

352

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

353

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

Bu Sun Kim

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

[diff] [blame]

},

],

},

],

Bu Sun Kim

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

[diff] [blame^]

358

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

Bu Sun Kim

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

[diff] [blame]

359

},

Bu Sun Kim

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

[diff] [blame^]

360

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

361

# The maximum length is 10000 bytes.

362

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

Bu Sun Kim

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

[diff] [blame]

363

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

Dan O'Meara

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

[diff] [blame]

364

# <br />This is a required field.

Bu Sun Kim

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

[diff] [blame]

365

# The maximum length is 1536 characters.

Bu Sun Kim

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

[diff] [blame^]

366

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

Dan O'Meara

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

[diff] [blame]

367

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

Bu Sun Kim

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

[diff] [blame^]

368

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

Bu Sun Kim

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

[diff] [blame]

369

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

370

# to handle exceptions and override the list allowed readers.

371

# The maximum number of elements is 100.

372

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

Bu Sun Kim

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

[diff] [blame^]

373

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

374

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

375

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

Bu Sun Kim

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

[diff] [blame^]

376

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

377

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

378

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

379

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

380

# customer.

381

},

382

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

383

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

384

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

Bu Sun Kim

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

[diff] [blame]

385

},

386

],

Bu Sun Kim

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

[diff] [blame^]

387

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

Bu Sun Kim

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

[diff] [blame]

388

# Note: ACL inheritance *only* provides access permissions

389

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

390

# provide convenient ways to delete large groups of items.

391

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

392

# child items that reference the parent in the

393

# inheritAclFrom

394

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

395

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

396

# also deletes all items that reference the container via the

397

# containerName

398

# field.

399

# The maximum length for this field is 1536 characters.

Bu Sun Kim

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

[diff] [blame^]

400

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

401

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

402

# is not intended to be visible, such as

403

# virtual

404

# containers.

Bu Sun Kim

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

[diff] [blame]

405

# The maximum number of elements is 1000.

Bu Sun Kim

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

[diff] [blame^]

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

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

414

# customer.

Bu Sun Kim

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

[diff] [blame]

415

},

Bu Sun Kim

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

[diff] [blame^]

416

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

417

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

418

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

Bu Sun Kim

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

[diff] [blame]

419

},

420

],

Bu Sun Kim

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

[diff] [blame^]

421

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

422

# document access permissions. It does, however, offer

423

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

424

# The maximum number of elements is 5.

425

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

426

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

427

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

428

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

429

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

430

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

431

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

432

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

433

# customer.

434

},

435

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

436

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

437

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

438

},

Bu Sun Kim

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

[diff] [blame]

439

],

Bu Sun Kim

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

[diff] [blame^]

440

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

441

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

442

# inheritAclFrom

443

# field. Also, when the

444

# inheritAclFrom field

445

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

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