Blame - docs/dyn/drive_v2.properties.html - platform/external/python/google-api-python-client

2014-04-24 15:46:26 -0400

[diff] [blame]

<style>

body, h1, h2, h3, div, span, p, pre, a {

margin: 0;

padding: 0;

border: 0;

font-weight: inherit;

9

font-style: inherit;

10

font-size: 100%;

11

font-family: inherit;

12

vertical-align: baseline;

}

body {

font-size: 13px;

padding: 1em;

}

h1 {

font-size: 26px;

margin-bottom: 1em;

}

h2 {

font-size: 24px;

margin-bottom: 1em;

}

h3 {

font-size: 20px;

margin-bottom: 1em;

margin-top: 1em;

}

pre, code {

line-height: 1.5;

font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;

}

pre {

margin-top: 0.5em;

}

h1, h2, h3, p {

font-family: Arial, sans serif;

}

h1, h2, h3 {

border-bottom: solid #CCC 1px;

}

.toc_element {

margin-top: 0.5em;

}

.firstline {

margin-left: 2 em;

}

.method {

margin-top: 1em;

border: solid 1px #CCC;

padding: 1em;

background: #EEE;

}

.details {

font-weight: bold;

font-size: 14px;

}

</style>

<h1><a href="drive_v2.html">Drive API</a> . <a href="drive_v2.properties.html">properties</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#delete">delete(fileId, propertyKey, visibility=None)</a></code></p>

79

<p class="firstline">Deletes a property.</p>

80

81

<code><a href="#get">get(fileId, propertyKey, visibility=None)</a></code></p>

82

<p class="firstline">Gets a property by its key.</p>

83

Dan O'Meara

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

[diff] [blame]

84

<code><a href="#insert">insert(fileId, body=None)</a></code></p>

Sai Cheemalapati

df61397

2016-10-21 13:59:49 -0700

[diff] [blame]

85

<p class="firstline">Adds a property to a file, or updates it if it already exists.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

86

87

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

88

<p class="firstline">Lists a file's properties.</p>

89

Dan O'Meara

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

[diff] [blame]

90

<code><a href="#patch">patch(fileId, propertyKey, body=None, visibility=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

91

<p class="firstline">Updates a property.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

92

Dan O'Meara

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

[diff] [blame]

93

<code><a href="#update">update(fileId, propertyKey, body=None, visibility=None)</a></code></p>

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Updates a property.</p>

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

95

<h3>Method Details</h3>

96

97

<code class="details" id="delete">delete(fileId, propertyKey, visibility=None)</code>

98

<pre>Deletes a property.

99

100

Args:

101

fileId: string, The ID of the file. (required)

102

propertyKey: string, The key of the property. (required)

103

visibility: string, The visibility of the property.

</pre>

</div>

<code class="details" id="get">get(fileId, propertyKey, visibility=None)</code>

109

<pre>Gets a property by its key.

110

111

Args:

112

fileId: string, The ID of the file. (required)

113

propertyKey: string, The key of the property. (required)

114

visibility: string, The visibility of the property.

115

116

Returns:

117

An object of the form:

118

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

119

{ # A key-value pair attached to a file that is either public or private to an application.

120

# The following limits apply to file properties:

121

# - Maximum of 100 properties total per file

122

# - Maximum of 30 private properties per app

123

# - Maximum of 30 public properties

124

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

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

[diff] [blame]

125

"etag": "A String", # ETag of the property.

126

"key": "A String", # The key of this property.

127

"kind": "drive#property", # This is always drive#property.

128

"selfLink": "A String", # The link back to this property.

129

"value": "A String", # The value of this property.

130

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

135

<code class="details" id="insert">insert(fileId, body=None)</code>

Sai Cheemalapati

df61397

2016-10-21 13:59:49 -0700

[diff] [blame]

136

<pre>Adds a property to a file, or updates it if it already exists.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

137

138

Args:

139

fileId: string, The ID of the file. (required)

Dan O'Meara

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

[diff] [blame]

140

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

141

The object takes the form of:

142

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

143

{ # A key-value pair attached to a file that is either public or private to an application.

144

# The following limits apply to file properties:

145

# - Maximum of 100 properties total per file

146

# - Maximum of 30 private properties per app

147

# - Maximum of 30 public properties

148

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

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

[diff] [blame]

149

"etag": "A String", # ETag of the property.

150

"key": "A String", # The key of this property.

151

"kind": "drive#property", # This is always drive#property.

152

"selfLink": "A String", # The link back to this property.

153

"value": "A String", # The value of this property.

154

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}

Returns:

An object of the form:

160

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

161

{ # A key-value pair attached to a file that is either public or private to an application.

162

# The following limits apply to file properties:

163

# - Maximum of 100 properties total per file

164

# - Maximum of 30 private properties per app

165

# - Maximum of 30 public properties

166

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

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

[diff] [blame]

167

"etag": "A String", # ETag of the property.

168

"key": "A String", # The key of this property.

169

"kind": "drive#property", # This is always drive#property.

170

"selfLink": "A String", # The link back to this property.

171

"value": "A String", # The value of this property.

172

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

<code class="details" id="list">list(fileId)</code>

Bu Sun Kim

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

[diff] [blame]

178

<pre>Lists a file's properties.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

179

180

Args:

181

fileId: string, The ID of the file. (required)

182

183

Returns:

184

An object of the form:

185

186

{ # A collection of properties, key-value pairs that are either public or private to an application.

Bu Sun Kim

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

[diff] [blame]

187

"etag": "A String", # The ETag of the list.

188

"items": [ # The list of properties.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

189

{ # A key-value pair attached to a file that is either public or private to an application.

190

# The following limits apply to file properties:

191

# - Maximum of 100 properties total per file

192

# - Maximum of 30 private properties per app

193

# - Maximum of 30 public properties

194

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

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

[diff] [blame]

195

"etag": "A String", # ETag of the property.

196

"key": "A String", # The key of this property.

197

"kind": "drive#property", # This is always drive#property.

198

"selfLink": "A String", # The link back to this property.

199

"value": "A String", # The value of this property.

200

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

201

},

202

],

Bu Sun Kim

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

[diff] [blame]

203

"kind": "drive#propertyList", # This is always drive#propertyList.

204

"selfLink": "A String", # The link back to this list.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

209

<code class="details" id="patch">patch(fileId, propertyKey, body=None, visibility=None)</code>

Bu Sun Kim

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

[diff] [blame]

210

<pre>Updates a property.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

211

212

Args:

213

fileId: string, The ID of the file. (required)

214

propertyKey: string, The key of the property. (required)

Dan O'Meara

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

[diff] [blame]

215

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

216

The object takes the form of:

217

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

218

{ # A key-value pair attached to a file that is either public or private to an application.

219

# The following limits apply to file properties:

220

# - Maximum of 100 properties total per file

221

# - Maximum of 30 private properties per app

222

# - Maximum of 30 public properties

223

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

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

[diff] [blame]

224

"etag": "A String", # ETag of the property.

225

"key": "A String", # The key of this property.

226

"kind": "drive#property", # This is always drive#property.

227

"selfLink": "A String", # The link back to this property.

228

"value": "A String", # The value of this property.

229

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

230

}

231

Bu Sun Kim

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

[diff] [blame]

232

visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

233

234

Returns:

235

An object of the form:

236

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

237

{ # A key-value pair attached to a file that is either public or private to an application.

238

# The following limits apply to file properties:

239

# - Maximum of 100 properties total per file

240

# - Maximum of 30 private properties per app

241

# - Maximum of 30 public properties

242

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

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

[diff] [blame]

243

"etag": "A String", # ETag of the property.

244

"key": "A String", # The key of this property.

245

"kind": "drive#property", # This is always drive#property.

246

"selfLink": "A String", # The link back to this property.

247

"value": "A String", # The value of this property.

248

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

253

<code class="details" id="update">update(fileId, propertyKey, body=None, visibility=None)</code>

Bu Sun Kim

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

[diff] [blame]

254

<pre>Updates a property.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

255

256

Args:

257

fileId: string, The ID of the file. (required)

258

propertyKey: string, The key of the property. (required)

Dan O'Meara

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

[diff] [blame]

259

body: object, The request body.

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

260

The object takes the form of:

261

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

262

{ # A key-value pair attached to a file that is either public or private to an application.

263

# The following limits apply to file properties:

264

# - Maximum of 100 properties total per file

265

# - Maximum of 30 private properties per app

266

# - Maximum of 30 public properties

267

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

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

[diff] [blame]

268

"etag": "A String", # ETag of the property.

269

"key": "A String", # The key of this property.

270

"kind": "drive#property", # This is always drive#property.

271

"selfLink": "A String", # The link back to this property.

272

"value": "A String", # The value of this property.

273

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

274

}

275

Bu Sun Kim

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

[diff] [blame]

276

visibility: string, The visibility of the property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth

2014-04-24 15:46:26 -0400

[diff] [blame]

277

278

Returns:

279

An object of the form:

280

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

281

{ # A key-value pair attached to a file that is either public or private to an application.

282

# The following limits apply to file properties:

283

# - Maximum of 100 properties total per file

284

# - Maximum of 30 private properties per app

285

# - Maximum of 30 public properties

286

# - Maximum of 124 bytes size limit on (key + value) string in UTF-8 encoding for a single property.

Bu Sun Kim

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

[diff] [blame]

287

"etag": "A String", # ETag of the property.

288

"key": "A String", # The key of this property.

289

"kind": "drive#property", # This is always drive#property.

290

"selfLink": "A String", # The link back to this property.

291

"value": "A String", # The value of this property.

292

"visibility": "A String", # The visibility of this property. Allowed values are PRIVATE and PUBLIC. (Default: PRIVATE)

John Asmuth