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

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

76

<h2>Instance Methods</h2>

77

78

<code><a href="cloudsearch_v1.debug.datasources.items.unmappedids.html">unmappedids()</a></code>

79

</p>

80

<p class="firstline">Returns the unmappedids Resource.</p>

81

82

83

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

84

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

85

86

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

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

93

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

94

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

95

96

Args:

97

name: string, Item name, format:

98

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

99

body: object, The request body. (required)

100

The object takes the form of:

101

102

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

103

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

104

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

105

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

106

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

107

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

108

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

109

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

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

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

},

}

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

118

Otherwise, ignore this field.

119

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

126

127

{

128

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

}</pre>

</div>

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

134

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

in the request.

Args:

name: string, Source name, format:

139

datasources/{source_id} (required)

140

body: object, The request body. (required)

141

The object takes the form of:

142

143

{

144

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

145

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

146

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

147

# Otherwise, ignore this field.

148

},

149

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

150

# The maximum length is 2048 characters.

151

}

152

153

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

160

161

{

162

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

163

# more results in the list.

164

"items": [

165

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

166

# file, folder, or a database record.

167

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

168

# Output only field.

169

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

170

{

171

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

172

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

173

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

174

# about the validation errors.

175

{

176

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

177

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

},

],

},

],

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

183

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

184

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

185

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

186

# of the message is 8192 characters.

187

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

188

},

189

],

190

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

191

},

192

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

193

# The maximum length is 100 characters.

194

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

195

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

196

# <br />This is a required field.

197

# The maximum length is 1536 characters.

198

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

199

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

200

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

201

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

202

# inheritAclFrom

203

# field. Also, when the

204

# inheritAclFrom field

205

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

206

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

207

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

208

# is not intended to be visible, such as

209

# virtual

210

# containers.

211

# The maximum number of elements is 1000.

212

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

213

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

214

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

215

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

216

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

217

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

218

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

219

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

220

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

221

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

222

# customer.

223

"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

228

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

229

# to handle exceptions and override the list allowed readers.

230

# The maximum number of elements is 100.

231

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

232

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

233

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

234

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

235

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

236

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

237

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

238

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

239

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

240

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

241

# customer.

242

"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

247

# document access permissions. It does, however, offer

248

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

249

# The maximum number of elements is 5.

250

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

251

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

252

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

253

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

254

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

255

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

256

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

257

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

258

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

259

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

260

# customer.

261

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

266

# Note: ACL inheritance *only* provides access permissions

267

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

268

# provide convenient ways to delete large groups of items.

269

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

270

# child items that reference the parent in the

271

# inheritAclFrom

272

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

273

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

274

# also deletes all items that reference the container via the

275

# containerName

276

# field.

277

# The maximum length for this field is 1536 characters.

278

},

279

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

280

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

281

# This reference is created via upload

282

# method.

283

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

284

# contentDataRef.

285

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

286

# The maximum length is 2048 characters.

287

},

288

"contentFormat": "A String",

289

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

290

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

291

# The maximum length is 2048 characters.

292

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

293

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

294

},

295

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

296

# byte string and compares the Item version in the index

297

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

298

# <br /><br />

299

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

300

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

301

# currently indexed item.

302

# The maximum length for this field is 1024 bytes.

303

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

304

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

305

# object definition in the schema for the data source.

306

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

307

# definition in the schema for the data source.

308

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

309

# The maximum number of elements is 1000.

310

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

311

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

312

# definition of `objectType`.

313

"objectValues": { # List of object values.

314

"values": [

315

# Object with schema name: StructuredDataObject

316

],

317

},

318

"dateValues": { # List of date values.

319

"values": [

320

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

321

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

322

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

323

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

},

],

},

"textValues": { # List of text values.

328

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

"A String",

],

},

"enumValues": { # List of enum values.

333

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

348

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

"A String",

],

},

"booleanValue": True or False,

353

"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

359

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

360

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

},

],

},

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

365

# This can be used with the

366

# items.push

367

# method to calculate modified state.

368

# The maximum length is 2048 characters.

369

},

370

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

371

# The maximum length is 10000 bytes.

372

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

373

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

374

# ItemContent.content

375

# in the source repository.

376

# The maximum length is 256 characters.

377

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

378

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

379

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

380

# To provide ACL inheritance for an item, use the

381

# inheritAclFrom

382

# field. The maximum length is 1536 characters.

383

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

384

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

385

# This can be used with the

386

# items.push

387

# method to calculate modified state.

388

# The maximum length is 2048 characters.

389

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

390

# more information, see

391

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

392

# The maximum length is 32 characters.

393

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

394

# Search result.

395

# The maximum length is 2048 characters.

396

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

397

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

398

# The maximum number of elements is 1000.

399

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

400

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

401

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

402

"type": "A String",

403

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

404

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

405

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

406

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

407

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

408

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

409

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

410

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

411

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

412

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

413

# customer.

414

"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

420

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

421

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

422

# default value is 0.0.

423

},

424

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

425

# Used internally for user generated content.

426

# The maximum number of elements is 100.

427

# The maximum length is 8192 characters.

428

"A String",

429

],

430

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

431

# this link to the title.

432

# The maximum length is 2048 characters.

433

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

434

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

435

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

436

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

437

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

438

# objectType to 'document'.

439

# The maximum length is 256 characters.

},

},

],

}</pre>

</div>

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

448

<pre>Retrieves the next page of results.

449

450

Args:

451

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

452

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

453

454

Returns:

455

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

456

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

</pre>

</div>

</body></html>