View Source GoogleApi.DriveLabels.V2.Api.Labels (google_api_drive_labels v0.2.0)

API calls for all endpoints tagged Labels.

Summary

Functions

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.

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.

Disable 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. Once disabled, a label may be deleted with DeleteLabel.

Enable 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.

Get 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}@{revision_id} - Gets the label at the specified revision ID.

Deletes Label permissions. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.

Updates 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.

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.

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

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. For example, the following changes to a Label will be rejected after the Label is published: The label cannot be directly deleted. It must be disabled first, then deleted. Field.FieldType cannot be changed. Changes to Field validation options cannot reject something that was previously accepted. Reducing the max entries.

Deletes Label permissions. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.

Updates 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.

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.

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

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.

Updates a Label's CopyMode. Changes to this policy are not revisioned, do not require publishing, and take effect immediately.

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.

Functions

Link to this function

drivelabels_labels_create(connection, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_create(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Creates a new Label.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - The 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 (type: boolean()) - Set to true in order to use the user's admin privileges. The server will verify the user is an admin before allowing access.
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_delete(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Label resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :useAdminAccess (type: boolean()) - Set 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.
    • :"writeControl.requiredRevisionId" (type: String.t) - The revision_id of the label that the write request will be applied to. If this is not the latest revision of the label, the request will not be processed and will return a 400 Bad Request error.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_delta(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_delta(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Label to update.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_disable(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_disable(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Disable 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. Once disabled, a label may be deleted with DeleteLabel.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Label resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2DisableLabelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_enable(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_enable(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Enable 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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Label resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2EnableLabelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_get(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_get(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Get 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}@{revision_id} - Gets the label at the specified revision ID.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Label resource name. May be any of: labels/{id} (equivalent to labels/{id}@latest) labels/{id}@latest labels/{id}@published labels/{id}@{revision_id}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :languageCode (type: String.t) - The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language are used.
    • :useAdminAccess (type: boolean()) - Set to true in order to use the user's admin credentials. The server verifies that the user is an admin for the label before allowing access.
    • :view (type: String.t) - When specified, only certain fields belonging to the indicated view are returned.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_list(connection, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_list(Tesla.Env.client(), keyword(), keyword()) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

List labels.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :customer (type: String.t) - The customer to scope this list request to. For example: "customers/abcd1234". If unset, will return all labels within the current customer.
    • :languageCode (type: String.t) - The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language are used.
    • :minimumRole (type: String.t) - Specifies the level of access the user must have on the returned Labels. The minimum role a user must have on a label. Defaults to READER.
    • :pageSize (type: integer()) - Maximum number of labels to return per page. Default: 50. Max: 200.
    • :pageToken (type: String.t) - The token of the page to return.
    • :publishedOnly (type: boolean()) - Whether to include only published labels in the results. When true, only the current published label revisions are returned. Disabled labels are included. Returned label resource names reference the published revision (labels/{id}/{revision_id}). When false, the current label revisions are returned, which might not be published. Returned label resource names don't reference a specific revision (labels/{id}).
    • :useAdminAccess (type: boolean()) - Set to true in order to use the user's admin credentials. This will return all Labels within the customer.
    • :view (type: String.t) - When specified, only certain fields belonging to the indicated view are returned.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelsResponse{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_locks_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_locks_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelLocksResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the LabelLocks on a Label.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Label on which Locks are applied. Format: labels/{label}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of Locks to return per page. Default: 100. Max: 200.
    • :pageToken (type: String.t) - The token of the page to return.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelLocksResponse{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_permissions_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_permissions_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes Label permissions. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name shared by all permissions being deleted. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_permissions_batch_update(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_permissions_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates 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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name shared by all permissions being updated. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_permissions_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_permissions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name on the Label Permission is created. Format: labels/{label}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :useAdminAccess (type: boolean()) - Set 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.
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_permissions_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_permissions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Label Permission resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :useAdminAccess (type: boolean()) - Set 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_permissions_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_permissions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists a Label's permissions.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name on which Label Permission are listed. Format: labels/{label}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of permissions to return per page. Default: 50. Max: 200.
    • :pageToken (type: String.t) - The token of the page to return.
    • :useAdminAccess (type: boolean()) - Set 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_publish(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_publish(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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. For example, the following changes to a Label will be rejected after the Label is published: The label cannot be directly deleted. It must be disabled first, then deleted. Field.FieldType cannot be changed. Changes to Field validation options cannot reject something that was previously accepted. Reducing the max entries.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Label resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2PublishLabelRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_revisions_locks_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_revisions_locks_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelLocksResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the LabelLocks on a Label.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. Label on which Locks are applied. Format: labels/{label}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of Locks to return per page. Default: 100. Max: 200.
    • :pageToken (type: String.t) - The token of the page to return.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelLocksResponse{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_revisions_permissions_batch_delete(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_revisions_permissions_batch_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Deletes Label permissions. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name shared by all permissions being deleted. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_revisions_permissions_batch_update(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_revisions_permissions_batch_update(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates 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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name shared by all permissions being updated. Format: labels/{label} If this is set, the parent field in the UpdateLabelPermissionRequest messages must either be empty or match this field.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_revisions_permissions_create(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_revisions_permissions_create(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name on the Label Permission is created. Format: labels/{label}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :useAdminAccess (type: boolean()) - Set 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.
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_revisions_permissions_delete(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_revisions_permissions_delete(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. Label Permission resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :useAdminAccess (type: boolean()) - Set 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleProtobufEmpty{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_revisions_permissions_list(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_revisions_permissions_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelPermissionsResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists a Label's permissions.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name on which Label Permission are listed. Format: labels/{label}
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :pageSize (type: integer()) - Maximum number of permissions to return per page. Default: 50. Max: 200.
    • :pageToken (type: String.t) - The token of the page to return.
    • :useAdminAccess (type: boolean()) - Set 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.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2ListLabelPermissionsResponse{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_revisions_update_permissions(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_revisions_update_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :useAdminAccess (type: boolean()) - Set 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.
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_update_label_copy_mode(connection, name, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_update_label_copy_mode(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok, GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a Label's CopyMode. Changes to this policy are not revisioned, do not require publishing, and take effect immediately.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • name (type: String.t) - Required. The resource name of the Label to update.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2UpdateLabelCopyModeRequest.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2Label{}} on success
  • {:error, info} on failure
Link to this function

drivelabels_labels_update_permissions(connection, parent, optional_params \\ [], opts \\ [])

View Source
@spec drivelabels_labels_update_permissions(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

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.

Parameters

  • connection (type: GoogleApi.DriveLabels.V2.Connection.t) - Connection to server
  • parent (type: String.t) - Required. The parent Label resource name.
  • optional_params (type: keyword()) - Optional parameters
    • :"$.xgafv" (type: String.t) - V1 error format.
    • :access_token (type: String.t) - OAuth access token.
    • :alt (type: String.t) - Data format for response.
    • :callback (type: String.t) - JSONP
    • :fields (type: String.t) - Selector specifying which fields to include in a partial response.
    • :key (type: String.t) - API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    • :oauth_token (type: String.t) - OAuth 2.0 token for the current user.
    • :prettyPrint (type: boolean()) - Returns response with indentations and line breaks.
    • :quotaUser (type: String.t) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    • :uploadType (type: String.t) - Legacy upload protocol for media (e.g. "media", "multipart").
    • :upload_protocol (type: String.t) - Upload protocol for media (e.g. "raw", "multipart").
    • :useAdminAccess (type: boolean()) - Set 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.
    • :body (type: GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.DriveLabels.V2.Model.GoogleAppsDriveLabelsV2LabelPermission{}} on success
  • {:error, info} on failure