ListLabelLocksResponse
Stay organized with collections
Save and categorize content based on your preferences.
The response to a ListLabelLocksRequest
.
JSON representation |
{
"labelLocks": [
{
object (LabelLock )
}
],
"nextPageToken": string
} |
Fields |
labelLocks[] |
object (LabelLock )
Label locks.
|
nextPageToken |
string
The token of the next page in the response.
|
LabelLock
A lock that can be applied to a label, field, or choice.
JSON representation |
{
"name": string,
"fieldId": string,
"choiceId": string,
"createTime": string,
"creator": {
object (UserInfo )
},
"deleteTime": string,
"capabilities": {
object (Capabilities )
},
"state": enum (State )
} |
Fields |
name |
string
Output only. Resource name of this label lock.
|
fieldId |
string
The ID of the field that should be locked. Empty if the whole label should be locked.
|
choiceId |
string
The ID of the selection field choice that should be locked. If present, fieldId must also be present.
|
createTime |
string (Timestamp format)
Output only. The time this label lock was created.
|
creator |
object (UserInfo )
Output only. The user whose credentials were used to create the label lock. Not present if no user was responsible for creating the label lock.
|
deleteTime |
string (Timestamp format)
Output only. A timestamp indicating when this label lock was scheduled for deletion. Present only if this label lock is in the DELETING state.
|
capabilities |
object (Capabilities )
Output only. The user's capabilities on this label lock.
|
state |
enum (State )
Output only. This label lock's state.
|
Capabilities
A description of a user's capabilities on a label lock.
JSON representation |
{
"canViewPolicy": boolean
} |
Fields |
canViewPolicy |
boolean
True if the user is authorized to view the policy.
|
State
A description of a label lock's state.
Enums |
STATE_UNSPECIFIED |
Unknown state. |
ACTIVE |
The label lock is active and is being enforced by the server. |
DELETING |
The label lock is being deleted. The label lock will continue to be enforced by the server until it has been fully removed. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-08-04 UTC.
[null,null,["Last updated 2025-08-04 UTC."],[],[],null,["# ListLabelLocksResponse\n\n- [JSON representation](#SCHEMA_REPRESENTATION)\n- [LabelLock](#LabelLock)\n - [JSON representation](#LabelLock.SCHEMA_REPRESENTATION)\n- [Capabilities](#Capabilities)\n - [JSON representation](#Capabilities.SCHEMA_REPRESENTATION)\n- [State](#State)\n\nThe response to a `ListLabelLocksRequest`.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"labelLocks\": [ { object (/workspace/drive/labels/reference/rest/v2/ListLabelLocksResponse#LabelLock) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------|\n| `labelLocks[]` | `object (`[LabelLock](/workspace/drive/labels/reference/rest/v2/ListLabelLocksResponse#LabelLock)`)` Label locks. |\n| `nextPageToken` | `string` The token of the next page in the response. |\n\nLabelLock\n---------\n\nA lock that can be applied to a label, field, or choice.\n\n| JSON representation |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"fieldId\": string, \"choiceId\": string, \"createTime\": string, \"creator\": { object (/workspace/drive/labels/reference/rest/v2/labels#UserInfo) }, \"deleteTime\": string, \"capabilities\": { object (/workspace/drive/labels/reference/rest/v2/ListLabelLocksResponse#Capabilities) }, \"state\": enum (/workspace/drive/labels/reference/rest/v2/ListLabelLocksResponse#State) } ``` |\n\n| Fields ||\n|----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name of this label lock. |\n| `fieldId` | `string` The ID of the field that should be locked. Empty if the whole label should be locked. |\n| `choiceId` | `string` The ID of the selection field choice that should be locked. If present, `fieldId` must also be present. |\n| `createTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. The time this label lock was created. |\n| `creator` | `object (`[UserInfo](/workspace/drive/labels/reference/rest/v2/labels#UserInfo)`)` Output only. The user whose credentials were used to create the label lock. Not present if no user was responsible for creating the label lock. |\n| `deleteTime` | `string (`[Timestamp](https://protobuf.dev/reference/protobuf/google.protobuf/#timestamp)` format)` Output only. A timestamp indicating when this label lock was scheduled for deletion. Present only if this label lock is in the `DELETING` state. |\n| `capabilities` | `object (`[Capabilities](/workspace/drive/labels/reference/rest/v2/ListLabelLocksResponse#Capabilities)`)` Output only. The user's capabilities on this label lock. |\n| `state` | `enum (`[State](/workspace/drive/labels/reference/rest/v2/ListLabelLocksResponse#State)`)` Output only. This label lock's state. |\n\nCapabilities\n------------\n\nA description of a user's capabilities on a label lock.\n\n| JSON representation |\n|--------------------------------------|\n| ``` { \"canViewPolicy\": boolean } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------|\n| `canViewPolicy` | `boolean` True if the user is authorized to view the policy. |\n\nState\n-----\n\nA description of a label lock's state.\n\n| Enums ||\n|---------------------|-----------------------------------------------------------------------------------------------------------------------------|\n| `STATE_UNSPECIFIED` | Unknown state. |\n| `ACTIVE` | The label lock is active and is being enforced by the server. |\n| `DELETING` | The label lock is being deleted. The label lock will continue to be enforced by the server until it has been fully removed. |"]]