blob: 309baae75dfa23b128de80524417a4f5595a18f5 [file] [log] [blame] [edit]
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
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="drivelabels_v2.html">Drive Labels API</a> . <a href="drivelabels_v2.labels.html">labels</a> . <a href="drivelabels_v2.labels.revisions.html">revisions</a> . <a href="drivelabels_v2.labels.revisions.locks.html">locks</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists the LabelLocks on a Label.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists the LabelLocks on a Label.
Args:
parent: string, Required. Label on which Locks are applied. Format: labels/{label} (required)
pageSize: integer, Maximum number of Locks to return per page. Default: 100. Max: 200.
pageToken: string, The token of the page to return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response to a ListLabelLocksRequest.
&quot;labelLocks&quot;: [ # LabelLocks.
{ # A Lock that can be applied to a Label, Field, or Choice.
&quot;capabilities&quot;: { # A description of a user&#x27;s capabilities on a LabelLock. # Output only. The user&#x27;s capabilities on this LabelLock.
&quot;canViewPolicy&quot;: True or False, # True if the user is authorized to view the policy.
},
&quot;choiceId&quot;: &quot;A String&quot;, # The ID of the Selection Field Choice that should be locked. If present, `field_id` must also be present.
&quot;createTime&quot;: &quot;A String&quot;, # Output only. The time this LabelLock was created.
&quot;creator&quot;: { # Information about a user. # Output only. The user whose credentials were used to create the LabelLock. This will not be present if no user was responsible for creating the LabelLock.
&quot;person&quot;: &quot;A String&quot;, # The identifier for this user that can be used with the People API to get more information. For example, people/12345678.
},
&quot;deleteTime&quot;: &quot;A String&quot;, # Output only. A timestamp indicating when this LabelLock was scheduled for deletion. This will be present only if this LabelLock is in the DELETING state.
&quot;fieldId&quot;: &quot;A String&quot;, # The ID of the Field that should be locked. Empty if the whole Label should be locked.
&quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of this LabelLock.
&quot;state&quot;: &quot;A String&quot;, # Output only. This LabelLock&#x27;s state.
},
],
&quot;nextPageToken&quot;: &quot;A String&quot;, # The token of the next page in the response.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call &#x27;execute()&#x27; on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
</body></html>