Skip to main content

locks

Creates, updates, deletes, gets or lists a locks resource.

Overview

Namelocks
TypeResource
Idgoogleworkspace.drivelabelsv2.locks

Fields

The following fields are returned by SELECT queries:

NameDatatypeDescription
namestringOutput only. Resource name of this label lock.
capabilitiesobjectOutput only. The user's capabilities on this label lock. (id: GoogleAppsDriveLabelsV2LabelLockCapabilities)
choiceIdstringThe ID of the selection field choice that should be locked. If present, field_id must also be present.
createTimestring (google-datetime)Output only. The time this label lock was created.
creatorobjectOutput only. The user whose credentials were used to create the label lock. Not present if no user was responsible for creating the label lock. (id: GoogleAppsDriveLabelsV2UserInfo)
deleteTimestring (google-datetime)Output only. A timestamp indicating when this label lock was scheduled for deletion. Present only if this label lock is in the DELETING state.
fieldIdstringThe ID of the field that should be locked. Empty if the whole label should be locked.
statestringOutput only. This label lock's state.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectlabelsIdpageSize, pageTokenLists the label locks on a label.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
labelsIdstring
pageSizeinteger (int32)
pageTokenstring

SELECT examples

Lists the label locks on a label.

SELECT
name,
capabilities,
choiceId,
createTime,
creator,
deleteTime,
fieldId,
state
FROM googleworkspace.drivelabelsv2.locks
WHERE labelsId = '{{ labelsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
;