Skip to main content

@swamp/gcp/drivelabels

v2026.04.23.1

Google Cloud drivelabels infrastructure models

Repository

https://github.com/systeminit/swamp-extensions

Labels

gcpgoogle-clouddrivelabelscloudinfrastructure

Contents

Quality score

Verified by Swamp

How well-documented and verifiable this extension is.

100%

Grade A

  • Has README or module doc2/2earned
  • README has a code example1/1earned
  • README is substantive1/1earned
  • Most symbols documented1/1earned
  • No slow types1/1earned
  • Has description1/1earned
  • At least one platform tag (or universal)1/1earned
  • Two or more platform tags (or universal)1/1earned
  • License declared1/1earned
  • Verified public repository2/2earned

Install

$ swamp extension pull @swamp/gcp/drivelabels

@swamp/gcp/drivelabels/labelsv2026.04.23.1labels.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
appliedCapabilities?objectThe capabilities a user has on this label's applied metadata.
appliedLabelPolicy?objectBehavior of this label when it's applied to Drive items.
creator?objectInformation about a user.
disabler?objectInformation about a user.
displayHints?objectThe UI display hints for rendering the label.
enabledAppSettings?objectDescribes the Google Workspace apps in which the label can be used.
fields?arrayList of fields in descending priority order.
labelType?enumRequired. The type of label.
learnMoreUri?stringCustom URL to present to users to allow them to learn more about this label and how it should be used.
lifecycle?objectThe lifecycle state of an object, such as label, field, or choice. For more information, see [Label lifecycle](https://developers.google.com/workspace/drive/labels/guides/label-lifecycle). The lifecycle enforces the following transitions: * `UNPUBLISHED_DRAFT` (starting state) * `UNPUBLISHED_DRAFT` -> `PUBLISHED` * `UNPUBLISHED_DRAFT` -> (Deleted) * `PUBLISHED` -> `DISABLED` * `DISABLED` -> `PUBLISHED` * `DISABLED` -> (Deleted) The published and disabled states have some distinct characteristics
lockStatus?objectContains information about whether a label component should be considered locked.
properties?objectBasic properties of the label.
publisher?objectInformation about a user.
revisionCreator?objectInformation about a user.
schemaCapabilities?objectThe capabilities related to this label when editing the label.
languageCode?stringThe BCP-47 language code to use for evaluating localized field labels in response. When not specified, values in the default configured language will be used.
useAdminAccess?stringSet to `true` in order to use the user's admin privileges. The server will verify the user is an admin before allowing access.
createCreate a labels
getGet a labels
ArgumentTypeDescription
identifierstringThe name of the labels
deleteDelete the labels
ArgumentTypeDescription
identifierstringThe name of the labels
syncSync labels state from GCP
deltadelta
ArgumentTypeDescription
languageCode?any
requests?any
useAdminAccess?any
view?any
writeControl?any
disabledisable
ArgumentTypeDescription
disabledPolicy?any
languageCode?any
updateMask?any
useAdminAccess?any
writeControl?any
enableenable
ArgumentTypeDescription
languageCode?any
useAdminAccess?any
writeControl?any
publishpublish
ArgumentTypeDescription
languageCode?any
useAdminAccess?any
writeControl?any
update_label_copy_modeupdate label copy mode
ArgumentTypeDescription
copyMode?any
languageCode?any
useAdminAccess?any
view?any
update_label_enabled_app_settingsupdate label enabled app settings
ArgumentTypeDescription
enabledAppSettings?any
languageCode?any
useAdminAccess?any
view?any
update_permissionsupdate permissions
ArgumentTypeDescription
audience?any
email?any
group?any
name?any
person?any
role?any

Resources

state(infinite)— A label defines a taxonomy that can be applied to Drive items in order to org...
@swamp/gcp/drivelabels/labels-locksv2026.04.23.1labels_locks.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
getGet a locks
ArgumentTypeDescription
identifierstringThe name of the locks
syncSync locks state from GCP

Resources

state(infinite)— A lock that can be applied to a label, field, or choice.
@swamp/gcp/drivelabels/labels-permissionsv2026.04.23.1labels_permissions.ts

Global Arguments

ArgumentTypeDescription
audience?stringAudience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the label.
email?stringSpecifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
group?stringGroup resource name.
name?stringResource name of this permission.
person?stringPerson resource name.
role?enumThe role the principal should have.
useAdminAccess?stringSet to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a permissions
getGet a permissions
ArgumentTypeDescription
identifierstringThe name of the permissions
deleteDelete the permissions
ArgumentTypeDescription
identifierstringThe name of the permissions
syncSync permissions state from GCP
batch_deletebatch delete
ArgumentTypeDescription
requests?any
useAdminAccess?any
batch_updatebatch update
ArgumentTypeDescription
requests?any
useAdminAccess?any

Resources

state(infinite)— The permission that applies to a principal (user, group, audience) on a label.
@swamp/gcp/drivelabels/labels-revisions-locksv2026.04.23.1labels_revisions_locks.ts

Global Arguments

ArgumentTypeDescription
namestringInstance name for this resource (used as the unique identifier in the factory pattern)
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
getGet a locks
ArgumentTypeDescription
identifierstringThe name of the locks
syncSync locks state from GCP

Resources

state(infinite)— A lock that can be applied to a label, field, or choice.
@swamp/gcp/drivelabels/labels-revisions-permissionsv2026.04.23.1labels_revisions_permissions.ts

Global Arguments

ArgumentTypeDescription
audience?stringAudience to grant a role to. The magic value of `audiences/default` may be used to apply the role to the default audience in the context of the organization that owns the label.
email?stringSpecifies the email address for a user or group principal. Not populated for audience principals. User and group permissions may only be inserted using an email address. On update requests, if email address is specified, no principal should be specified.
group?stringGroup resource name.
name?stringResource name of this permission.
person?stringPerson resource name.
role?enumThe role the principal should have.
useAdminAccess?stringSet to `true` in order to use the user's admin credentials. The server will verify the user is an admin for the label before allowing access.
parent?stringThe parent resource name (e.g., projects/my-project/locations/us-central1, organizations/123, folders/456)
createCreate a permissions
getGet a permissions
ArgumentTypeDescription
identifierstringThe name of the permissions
deleteDelete the permissions
ArgumentTypeDescription
identifierstringThe name of the permissions
syncSync permissions state from GCP
batch_deletebatch delete
ArgumentTypeDescription
requests?any
useAdminAccess?any
batch_updatebatch update
ArgumentTypeDescription
requests?any
useAdminAccess?any

Resources

state(infinite)— The permission that applies to a principal (user, group, audience) on a label.