ListLabelLocksResponse

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.