gsmdrivelabels

Documentation

Overview

Package gsmdrivelabels implements the Drive Labels API

Index

• func BatchDeleteLabelPermissions(parent string, ...) (bool, error)
• func BatchUpdateLabelPermissions(parent, fields string, ...) (*drivelabels.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse, error)
• func CreateLabel(label *drivelabels.GoogleAppsDriveLabelsV2Label, languageCode, fields string, ...) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)
• func CreateLabelPermission(parent, fields string, useAdminAccess bool, ...) (*drivelabels.GoogleAppsDriveLabelsV2LabelPermission, error)
• func DeleteLabel(name, requiredRevisionId string, useAdminAccess bool) (bool, error)
• func DeleteLabelPermission(name string, useAdminAccess bool) (bool, error)
• func Delta(name, fields string, ...) (*drivelabels.GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse, error)
• func Disable(name, fields string, ...) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)
• func Enable(name, fields string, ...) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)
• func GetCapabilities(name, customer, fields string) (*drivelabels.GoogleAppsDriveLabelsV2UserCapabilities, error)
• func GetLabel(name, languageCode, view, fields string, useAdminAccess bool) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)
• func GetLabelLimits(name, fields string) (*drivelabels.GoogleAppsDriveLabelsV2LabelLimits, error)
• func ListLabelLocks(parent, fields string, cap int) (<-chan *drivelabels.GoogleAppsDriveLabelsV2LabelLock, <-chan error)
• func ListLabelPermissions(parent, fields string, useAdminAccess bool, cap int) (<-chan *drivelabels.GoogleAppsDriveLabelsV2LabelPermission, <-chan error)
• func ListLabels(languageCode, view, minimumRole, fields string, ...) (<-chan *drivelabels.GoogleAppsDriveLabelsV2Label, <-chan error)
• func Publish(name, fields string, ...) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)
• func SetClient(c *http.Client)
• func UpdateLabelCopyMode(name, fields string, ...) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)
• func UpdatePermissions(name, fields string, useAdminAccess bool, ...) (*drivelabels.GoogleAppsDriveLabelsV2LabelPermission, error)

Functions

func BatchDeleteLabelPermissions

func BatchDeleteLabelPermissions(parent string, request *drivelabels.GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest) (bool, error)

DeleteLabelPermission deletes a principal's permission on a Label. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.

func BatchUpdateLabelPermissions

func BatchUpdateLabelPermissions(parent, fields string, request *drivelabels.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest) (*drivelabels.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse, error)

BatchDeleteLabelPermissions updatess Label permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.

func CreateLabel

func CreateLabel(label *drivelabels.GoogleAppsDriveLabelsV2Label, languageCode, fields string, useAdminAccess bool) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)

CreateLabel creates a new Label.

func CreateLabelPermission

func CreateLabelPermission(parent, fields string, useAdminAccess bool, permission *drivelabels.GoogleAppsDriveLabelsV2LabelPermission) (*drivelabels.GoogleAppsDriveLabelsV2LabelPermission, error)

CreateLabelPermission updates a Label's permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.

func DeleteLabel

func DeleteLabel(name, requiredRevisionId string, useAdminAccess bool) (bool, error)

DeleteLabel permanently deletes a Label and related metadata on Drive Items. Once deleted, the Label and related Drive item metadata will be deleted. Only draft Labels, and disabled Labels may be deleted.

func DeleteLabelPermission

func DeleteLabelPermission(name string, useAdminAccess bool) (bool, error)

DeleteLabelPermission deletes a principal's permission on a Label. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.

func Delta

func Delta(name, fields string, request *drivelabels.GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest) (*drivelabels.GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse, error)

Delta updates a single Label by applying a set of update requests resulting in a new draft revision. The batch update is all-or-nothing: If any of the update requests are invalid, no changes are applied. The resulting draft revision must be published before the changes may be used with Drive Items.

func Disable

func Disable(name, fields string, request *drivelabels.GoogleAppsDriveLabelsV2DisableLabelRequest) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)

Disable disables a published Label. Disabling a Label will result in a new disabled published revision based on the current published revision. If there is a draft revision, a new disabled draft revision will be created based on the latest draft revision. Older draft revisions will be deleted.

func Enable

func Enable(name, fields string, request *drivelabels.GoogleAppsDriveLabelsV2EnableLabelRequest) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)

Enable enables a disabled Label and restore it to its published state. This will result in a new published revision based on the current disabled published revision. If there is an existing disabled draft revision, a new revision will be created based on that draft and will be enabled.

func GetCapabilities

func GetCapabilities(name, customer, fields string) (*drivelabels.GoogleAppsDriveLabelsV2UserCapabilities, error)

Gets the user capabilities.

func GetLabel

func GetLabel(name, languageCode, view, fields string, useAdminAccess bool) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)

GetLabel gets a label by its resource name. Resource name may be any of: labels/{id} - See labels/{id}@latest labels/{id}@latest - Gets the latest revision of the label. labels/{id}@published - Gets the current published revision of the label. labels/{id}@{revisionId} - Gets the label at the specified revision ID.

func GetLabelLimits

func GetLabelLimits(name, fields string) (*drivelabels.GoogleAppsDriveLabelsV2LabelLimits, error)

Get the constraints on the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title.

func ListLabelLocks

func ListLabelLocks(parent, fields string, cap int) (<-chan *drivelabels.GoogleAppsDriveLabelsV2LabelLock, <-chan error)

Lists the LabelLocks on a Label.

func ListLabelPermissions

func ListLabelPermissions(parent, fields string, useAdminAccess bool, cap int) (<-chan *drivelabels.GoogleAppsDriveLabelsV2LabelPermission, <-chan error)

Lists the LabelPermissions on a Label.

func ListLabels

func ListLabels(languageCode, view, minimumRole, fields string, useAdminAccess, publishedOnly bool, cap int) (<-chan *drivelabels.GoogleAppsDriveLabelsV2Label, <-chan error)

ListLabels list labels.

func Publish

func Publish(name, fields string, request *drivelabels.GoogleAppsDriveLabelsV2PublishLabelRequest) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)

Publish all draft changes to the Label. Once published, the Label may not return to its draft state. See google.apps.drive.labels.v2.Lifecycle for more information. Publishing a Label will result in a new published revision. All previous draft revisions will be deleted. Previous published revisions will be kept but are subject to automated deletion as needed. Once published, some changes are no longer permitted. Generally, any change that would invalidate or cause new restrictions on existing metadata related to the Label will be rejected.

func SetClient

func SetClient(c *http.Client)

SetClient is used to inject a *http.Client into the package

func UpdateLabelCopyMode

func UpdateLabelCopyMode(name, fields string, request *drivelabels.GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest) (*drivelabels.GoogleAppsDriveLabelsV2Label, error)

Publish all draft changes to the Label. Once published, the Label may not return to its draft state. See google.apps.drive.labels.v2.Lifecycle for more information. Publishing a Label will result in a new published revision. All previous draft revisions will be deleted. Previous published revisions will be kept but are subject to automated deletion as needed. Once published, some changes are no longer permitted. Generally, any change that would invalidate or cause new restrictions on existing metadata related to the Label will be rejected.

func UpdatePermissions

func UpdatePermissions(name, fields string, useAdminAccess bool, request *drivelabels.GoogleAppsDriveLabelsV2LabelPermission) (*drivelabels.GoogleAppsDriveLabelsV2LabelPermission, error)

UpdatePermissions updates a Label's permissions. If a permission for the indicated principal doesn't exist, a new Label Permission is created, otherwise the existing permission is updated. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.