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>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

84

<p class="firstline">Checks whether an item is accessible by specified principal. **Note:** This API requires an admin account to execute.</p>

85

86

<code><a href="#close">close()</a></code></p>

87

<p class="firstline">Close httplib2 connections.</p>

Bu Sun Kim

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

[diff] [blame]

88

Dan O'Meara

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

[diff] [blame]

89

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

90

<p class="firstline">Fetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute.</p>

Bu Sun Kim

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

[diff] [blame]

91

92

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

93

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

94

<h3>Method Details</h3>

95

Dan O'Meara

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

[diff] [blame]

96

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

97

<pre>Checks whether an item is accessible by specified principal. **Note:** This API requires an admin account to execute.

Dan O'Meara

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

[diff] [blame]

98

Bu Sun Kim

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

[diff] [blame]

99

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

100

name: string, Item name, format: 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.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

105

"userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}

Bu Sun Kim

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

[diff] [blame]

106

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

107

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

Bu Sun Kim

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

[diff] [blame]

108

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

109

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

Bu Sun Kim

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

[diff] [blame]

110

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

111

"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}

Bu Sun Kim

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

[diff] [blame]

112

}

113

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

114

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

Bu Sun Kim

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

[diff] [blame]

115

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

122

123

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

124

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

129

<code class="details" id="close">close()</code>

130

<pre>Close httplib2 connections.</pre>

131

</div>

Bu Sun Kim

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

[diff] [blame]

132

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

133

134

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

135

<pre>Fetches the item whose viewUrl exactly matches that of the URL provided in the request. **Note:** This API requires an admin account to execute.

Dan O'Meara

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

[diff] [blame]

136

Bu Sun Kim

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

[diff] [blame]

137

Args:

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

138

name: string, Source name, format: datasources/{source_id} (required)

Dan O'Meara

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

[diff] [blame]

139

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

140

The object takes the form of:

141

142

{

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

143

"viewUrl": "A String", # Specify the full view URL to find the corresponding item. The maximum length is 2048 characters.

Bu Sun Kim

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

[diff] [blame]

144

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

145

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

Bu Sun Kim

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

[diff] [blame]

146

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

147

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

148

}

149

150

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

157

158

{

Bu Sun Kim

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

[diff] [blame]

159

"items": [

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

160

{ # Represents a single object that is an item in the search index, such as a file, folder, or a database record.

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

161

"name": "A String", # Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.

162

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

163

"hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.

164

"object": { # A structured data object consisting of named properties. # The structured data object that should conform to a registered object definition in the schema for the data source.

165

"properties": [ # The properties for the object. The maximum number of elements is 1000.

166

{ # A typed name-value pair for structured data. The type of the value should be the same as the registered type for the `name` property in the object definition of `objectType`.

167

"htmlValues": { # List of html values.

168

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

"A String",

],

},

"doubleValues": { # List of double values.

"values": [

3.14,

],

},

"booleanValue": True or False,

178

"timestampValues": { # List of timestamp values.

"values": [

"A String",

],

},

"objectValues": { # List of object values.

184

"values": [

185

# Object with schema name: StructuredDataObject

186

],

187

},

188

"enumValues": { # List of enum values.

189

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

"A String",

],

},

"textValues": { # List of text values.

194

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

"A String",

],

},

"dateValues": { # List of date values.

199

"values": [

200

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

201

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

202

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

203

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

},

],

},

"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 property that was registered for object definition in the schema. The maximum allowable length for this property is 256 characters.

},

],

},

},

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

218

"contentFormat": "A String",

219

"hash": "A String", # Hashing info calculated and provided by the API client for content. Can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.

220

"contentDataRef": { # Represents an upload session reference. This reference is created via upload method. Updating of item content may refer to this uploaded content via contentDataRef. # Upload reference ID of a previously uploaded content via write method.

221

"name": "A String", # Name of the content reference. The maximum length is 2048 characters.

222

},

223

"inlineContent": "A String", # Content that is supplied inlined within the update method. The maximum length is 102400 bytes (100 KiB).

224

},

225

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

226

"queue": "A String", # Queue this item belongs to. The maximum length is 100 characters.

227

"acl": { # Access control list information for the item. For more information see [Map ACLs](/cloud-search/docs/guides/acls). # Access control list for this item.

228

"owners": [ # Optional. List of owners for the item. This field has no bearing on document access permissions. It does, however, offer a slight ranking boosts items where the querying user is an owner. The maximum number of elements is 5.

229

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

230

"userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}

231

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

232

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

233

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

234

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

235

},

236

"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}

237

},

238

],

239

"readers": [ # List of principals who are allowed to see the item in search results. Optional if inheriting permissions from another item or if the item is not intended to be visible, such as virtual containers. The maximum number of elements is 1000.

240

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

241

"userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}

242

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

243

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

244

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

245

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

246

},

247

"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}

248

},

249

],

250

"inheritAclFrom": "A String", # Name of the item to inherit the Access Permission List (ACL) from. Note: ACL inheritance *only* provides access permissions to child items and does not define structural relationships, nor does it provide convenient ways to delete large groups of items. Deleting an ACL parent from the index only alters the access permissions of child items that reference the parent in the inheritAclFrom field. The item is still in the index, but may not visible in search results. By contrast, deletion of a container item also deletes all items that reference the container via the containerName field. The maximum length for this field is 1536 characters.

251

"deniedReaders": [ # List of principals who are explicitly denied access to the item in search results. While principals are denied access by default, use denied readers to handle exceptions and override the list allowed readers. The maximum number of elements is 100.

252

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

253

"userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}

254

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

255

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

256

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

257

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

258

},

259

"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}

260

},

261

],

262

"aclInheritanceType": "A String", # Sets the type of access rules to apply when an item inherits its ACL from a parent. This should always be set in tandem with the inheritAclFrom field. Also, when the inheritAclFrom field is set, this field should be set to a valid AclInheritanceType.

263

},

264

"version": "A String", # Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes.

265

"payload": "A String", # Additional state connector can store for this item. The maximum length is 10000 bytes.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

266

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

267

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

268

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

269

"errorMessage": "A String", # Message that describes the error. The maximum allowable length of the message is 8192 characters.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

270

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

271

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

272

},

273

],

274

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

275

{

276

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

277

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

278

{

279

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

280

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

281

},

282

],

283

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

284

},

285

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

286

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

287

},

Bu Sun Kim

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

[diff] [blame]

288

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

289

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

290

"quality": 3.14, # An indication of the quality of the item, used to influence search quality. Value should be between 0.0 (lowest quality) and 1.0 (highest quality). The default value is 0.0.

291

},

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

292

"containerName": "A String", # The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.

293

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

294

"interactions": [ # A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.

295

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

296

"interactionTime": "A String", # The time when the user acted on the item. If multiple actions of the same type exist for a single user, only the most recent action is recorded.

297

"type": "A String",

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

298

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

299

"userResourceName": "A String", # This principal is a user identified using an external identity. The name field must specify the user resource name with this format: identitysources/{source_id}/users/{ID}

300

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

301

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

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

302

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

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

303

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

Bu Sun Kim

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

[diff] [blame]

304

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame]

305

"groupResourceName": "A String", # This principal is a group identified using an external identity. The name field must specify the group resource name with this format: identitysources/{source_id}/groups/{ID}

306

},

Bu Sun Kim

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

[diff] [blame]

307

},

308

],

Bu Sun Kim

2020-11-16 11:05:03 -0700

[diff] [blame^]

309

"title": "A String", # The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.

310

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

311

"mimeType": "A String", # The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.

312

"sourceRepositoryUrl": "A String", # Link to the source repository serving the data. Search results apply this link to the title. Whitespace or special characters may cause Cloud Search result links to trigger a redirect notice; to avoid this, encode the URL. The maximum length is 2048 characters.

313

"objectType": "A String", # The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.

314

"contentLanguage": "A String", # The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.

315

"keywords": [ # Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.

316

"A String",

317

],

318

"hash": "A String", # Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.

Bu Sun Kim

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

[diff] [blame]

319

},

Bu Sun Kim