googleapis/build/src/apis/drivelabels/v2.d.ts

Google APIs Client Library for Node.js

/// <reference types="node" />
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosPromise, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace drivelabels_v2 {
    export interface Options extends GlobalOptions {
        version: 'v2';
    }
    interface StandardParameters {
        /**
         * Auth client or API Key for the request
         */
        auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
        /**
         * V1 error format.
         */
        '$.xgafv'?: string;
        /**
         * OAuth access token.
         */
        access_token?: string;
        /**
         * Data format for response.
         */
        alt?: string;
        /**
         * JSONP
         */
        callback?: string;
        /**
         * Selector specifying which fields to include in a partial response.
         */
        fields?: string;
        /**
         * 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.
         */
        key?: string;
        /**
         * OAuth 2.0 token for the current user.
         */
        oauth_token?: string;
        /**
         * Returns response with indentations and line breaks.
         */
        prettyPrint?: boolean;
        /**
         * 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.
         */
        quotaUser?: string;
        /**
         * Legacy upload protocol for media (e.g. "media", "multipart").
         */
        uploadType?: string;
        /**
         * Upload protocol for media (e.g. "raw", "multipart").
         */
        upload_protocol?: string;
    }
    /**
     * Drive Labels API
     *
     * An API for managing Drive Labels
     *
     * @example
     * ```js
     * const {google} = require('googleapis');
     * const drivelabels = google.drivelabels('v2');
     * ```
     */
    export class Drivelabels {
        context: APIRequestContext;
        labels: Resource$Labels;
        limits: Resource$Limits;
        users: Resource$Users;
        constructor(options: GlobalOptions, google?: GoogleConfigurable);
    }
    /**
     * The color derived from BadgeConfig and changed to the closest recommended supported color.
     */
    export interface Schema$GoogleAppsDriveLabelsV2BadgeColors {
        /**
         * Output only. Badge background that pairs with the foreground.
         */
        backgroundColor?: Schema$GoogleTypeColor;
        /**
         * Output only. Badge foreground that pairs with the background.
         */
        foregroundColor?: Schema$GoogleTypeColor;
        /**
         * Output only. Color that can be used for text without a background.
         */
        soloColor?: Schema$GoogleTypeColor;
    }
    /**
     * Badge status of the label.
     */
    export interface Schema$GoogleAppsDriveLabelsV2BadgeConfig {
        /**
         * The color of the badge. When not specified, no badge is rendered. The background, foreground, and solo (light and dark mode) colors set here are changed in the Drive UI into the closest recommended supported color.
         */
        color?: Schema$GoogleTypeColor;
        /**
         * Override the default global priority of this badge. When set to 0, the default priority heuristic is used.
         */
        priorityOverride?: string | null;
    }
    /**
     * Deletes one of more Label Permissions.
     */
    export interface Schema$GoogleAppsDriveLabelsV2BatchDeleteLabelPermissionsRequest {
        /**
         * Required. The request message specifying the resources to update.
         */
        requests?: Schema$GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest[];
        /**
         * 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. If this is set, the use_admin_access field in the DeleteLabelPermissionRequest messages must either be empty or match this field.
         */
        useAdminAccess?: boolean | null;
    }
    /**
     * Updates one or more Label Permissions.
     */
    export interface Schema$GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsRequest {
        /**
         * Required. The request message specifying the resources to update.
         */
        requests?: Schema$GoogleAppsDriveLabelsV2UpdateLabelPermissionRequest[];
        /**
         * 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. If this is set, the use_admin_access field in the UpdateLabelPermissionRequest messages must either be empty or match this field.
         */
        useAdminAccess?: boolean | null;
    }
    /**
     * Response for updating one or more Label Permissions.
     */
    export interface Schema$GoogleAppsDriveLabelsV2BatchUpdateLabelPermissionsResponse {
        /**
         * Required. Permissions updated.
         */
        permissions?: Schema$GoogleAppsDriveLabelsV2LabelPermission[];
    }
    /**
     * Limits for date Field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DateLimits {
        /**
         * Maximum value for the date Field type.
         */
        maxValue?: Schema$GoogleTypeDate;
        /**
         * Minimum value for the date Field type.
         */
        minValue?: Schema$GoogleTypeDate;
    }
    /**
     * Deletes a Label Permission. Permissions affect the Label resource as a whole, are not revisioned, and do not require publishing.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeleteLabelPermissionRequest {
        /**
         * Required. Label Permission resource name.
         */
        name?: string | null;
        /**
         * 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.
         */
        useAdminAccess?: boolean | null;
    }
    /**
     * The set of requests for updating aspects of a Label. If any request is not valid, no requests will be applied.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequest {
        /**
         * The BCP-47 language code to use for evaluating localized Field labels when `include_label_in_response` is `true`.
         */
        languageCode?: string | null;
        /**
         * A list of updates to apply to the Label. Requests will be applied in the order they are specified.
         */
        requests?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest[];
        /**
         * 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.
         */
        useAdminAccess?: boolean | null;
        /**
         * When specified, only certain fields belonging to the indicated view will be returned.
         */
        view?: string | null;
        /**
         * Provides control over how write requests are executed.
         */
        writeControl?: Schema$GoogleAppsDriveLabelsV2WriteControl;
    }
    /**
     * Request to create a Field within a Label.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest {
        /**
         * Required. Field to create.
         */
        field?: Schema$GoogleAppsDriveLabelsV2Field;
    }
    /**
     * Request to create a Selection Choice.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest {
        /**
         * Required. The Choice to create.
         */
        choice?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice;
        /**
         * Required. The Selection Field in which a Choice will be created.
         */
        fieldId?: string | null;
    }
    /**
     * Request to delete the Field.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest {
        /**
         * Required. ID of the Field to delete.
         */
        id?: string | null;
    }
    /**
     * Request to delete a Choice.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest {
        /**
         * Required. The Selection Field from which a Choice will be deleted.
         */
        fieldId?: string | null;
        /**
         * Required. Choice to delete.
         */
        id?: string | null;
    }
    /**
     * Request to disable the Field.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest {
        /**
         * Required. Field Disabled Policy.
         */
        disabledPolicy?: Schema$GoogleAppsDriveLabelsV2LifecycleDisabledPolicy;
        /**
         * Required. Key of the Field to disable.
         */
        id?: string | null;
        /**
         * The fields that should be updated. At least one field must be specified. The root `disabled_policy` is implied and should not be specified. A single `*` can be used as short-hand for updating every field.
         */
        updateMask?: string | null;
    }
    /**
     * Request to disable a Choice.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest {
        /**
         * Required. The disabled policy to update.
         */
        disabledPolicy?: Schema$GoogleAppsDriveLabelsV2LifecycleDisabledPolicy;
        /**
         * Required. The Selection Field in which a Choice will be disabled.
         */
        fieldId?: string | null;
        /**
         * Required. Choice to disable.
         */
        id?: string | null;
        /**
         * The fields that should be updated. At least one field must be specified. The root `disabled_policy` is implied and should not be specified. A single `*` can be used as short-hand for updating every field.
         */
        updateMask?: string | null;
    }
    /**
     * Request to enable the Field.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest {
        /**
         * Required. ID of the Field to enable.
         */
        id?: string | null;
    }
    /**
     * Request to enable a Choice.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest {
        /**
         * Required. The Selection Field in which a Choice will be enabled.
         */
        fieldId?: string | null;
        /**
         * Required. Choice to enable.
         */
        id?: string | null;
    }
    /**
     * A single kind of update to apply to a Label.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestRequest {
        /**
         * Creates a new Field.
         */
        createField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateFieldRequest;
        /**
         * Creates Choice within a Selection field.
         */
        createSelectionChoice?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestCreateSelectionChoiceRequest;
        /**
         * Deletes a Field from the label.
         */
        deleteField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteFieldRequest;
        /**
         * Delete a Choice within a Selection Field.
         */
        deleteSelectionChoice?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDeleteSelectionChoiceRequest;
        /**
         * Disables the Field.
         */
        disableField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableFieldRequest;
        /**
         * Disable a Choice within a Selection Field.
         */
        disableSelectionChoice?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestDisableSelectionChoiceRequest;
        /**
         * Enables the Field.
         */
        enableField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableFieldRequest;
        /**
         * Enable a Choice within a Selection Field.
         */
        enableSelectionChoice?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestEnableSelectionChoiceRequest;
        /**
         * Updates basic properties of a Field.
         */
        updateField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest;
        /**
         * Update Field type and/or type options.
         */
        updateFieldType?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest;
        /**
         * Updates the Label properties.
         */
        updateLabel?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest;
        /**
         * Update a Choice properties within a Selection Field.
         */
        updateSelectionChoiceProperties?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest;
    }
    /**
     * Request to update Field properties.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldPropertiesRequest {
        /**
         * Required. The Field to update.
         */
        id?: string | null;
        /**
         * Required. Basic Field properties.
         */
        properties?: Schema$GoogleAppsDriveLabelsV2FieldProperties;
        /**
         * The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `*` can be used as short-hand for updating every field.
         */
        updateMask?: string | null;
    }
    /**
     * Request to change the type of a Field.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateFieldTypeRequest {
        /**
         * Update field to Date.
         */
        dateOptions?: Schema$GoogleAppsDriveLabelsV2FieldDateOptions;
        /**
         * Required. The Field to update.
         */
        id?: string | null;
        /**
         * Update field to Integer.
         */
        integerOptions?: Schema$GoogleAppsDriveLabelsV2FieldIntegerOptions;
        /**
         * Update field to Long Text.
         */
        longTextOptions?: Schema$GoogleAppsDriveLabelsV2FieldLongTextOptions;
        /**
         * Update field to Selection.
         */
        selectionOptions?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptions;
        /**
         * Update field to Text.
         */
        textOptions?: Schema$GoogleAppsDriveLabelsV2FieldTextOptions;
        /**
         * The fields that should be updated. At least one field must be specified. The root of `type_options` is implied and should not be specified. A single `*` can be used as short-hand for updating every field.
         */
        updateMask?: string | null;
        /**
         * Update field to User.
         */
        userOptions?: Schema$GoogleAppsDriveLabelsV2FieldUserOptions;
    }
    /**
     * Updates basic properties of a Label.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateLabelPropertiesRequest {
        /**
         * Required. Label properties to update.
         */
        properties?: Schema$GoogleAppsDriveLabelsV2LabelProperties;
        /**
         * The fields that should be updated. At least one field must be specified. The root `label_properties` is implied and should not be specified. A single `*` can be used as short-hand for updating every field.
         */
        updateMask?: string | null;
    }
    /**
     * Request to update a Choice properties.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelRequestUpdateSelectionChoicePropertiesRequest {
        /**
         * Required. The Selection Field to update.
         */
        fieldId?: string | null;
        /**
         * Required. The Choice to update.
         */
        id?: string | null;
        /**
         * Required. The Choice properties to update.
         */
        properties?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties;
        /**
         * The fields that should be updated. At least one field must be specified. The root `properties` is implied and should not be specified. A single `*` can be used as short-hand for updating every field.
         */
        updateMask?: string | null;
    }
    /**
     * Response for Label update.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponse {
        /**
         * The reply of the updates. This maps 1:1 with the updates, although responses to some requests may be empty.
         */
        responses?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse[];
        /**
         * The label after updates were applied. This is only set if [BatchUpdateLabelResponse2.include_label_in_response] is `true` and there were no errors.
         */
        updatedLabel?: Schema$GoogleAppsDriveLabelsV2Label;
    }
    /**
     * Response following Field create.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse {
        /**
         * The field of the created field. When left blank in a create request, a key will be autogenerated and can be identified here.
         */
        id?: string | null;
        /**
         * The priority of the created field. The priority may change from what was specified to assure contiguous priorities between fields (1-n).
         */
        priority?: number | null;
    }
    /**
     * Response following Selection Choice create.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse {
        /**
         * The server-generated id of the field.
         */
        fieldId?: string | null;
        /**
         * The server-generated ID of the created choice within the Field
         */
        id?: string | null;
    }
    /**
     * Response following Field delete.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse {
    }
    /**
     * Response following Choice delete.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse {
    }
    /**
     * Response following Field disable.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse {
    }
    /**
     * Response following Choice disable.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse {
    }
    /**
     * Response following Field enable.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse {
    }
    /**
     * Response following Choice enable.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse {
    }
    /**
     * A single response from an update.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseResponse {
        /**
         * Creates a new Field.
         */
        createField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateFieldResponse;
        /**
         * Creates a new selection list option to add to a Selection Field.
         */
        createSelectionChoice?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseCreateSelectionChoiceResponse;
        /**
         * Deletes a Field from the label.
         */
        deleteField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteFieldResponse;
        /**
         * Deletes a Choice from a Selection Field.
         */
        deleteSelectionChoice?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDeleteSelectionChoiceResponse;
        /**
         * Disables Field.
         */
        disableField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableFieldResponse;
        /**
         * Disables a Choice within a Selection Field.
         */
        disableSelectionChoice?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseDisableSelectionChoiceResponse;
        /**
         * Enables Field.
         */
        enableField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableFieldResponse;
        /**
         * Enables a Choice within a Selection Field.
         */
        enableSelectionChoice?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseEnableSelectionChoiceResponse;
        /**
         * Updates basic properties of a Field.
         */
        updateField?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse;
        /**
         * Update Field type and/or type options.
         */
        updateFieldType?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse;
        /**
         * Updated basic properties of a Label.
         */
        updateLabel?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse;
        /**
         * Updates a Choice within a Selection Field.
         */
        updateSelectionChoiceProperties?: Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse;
    }
    /**
     * Response following update to Field properties.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldPropertiesResponse {
        /**
         * The priority of the updated field. The priority may change from what was specified to assure contiguous priorities between fields (1-n).
         */
        priority?: number | null;
    }
    /**
     * Response following update to Field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateFieldTypeResponse {
    }
    /**
     * Response following update to Label properties.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateLabelPropertiesResponse {
    }
    /**
     * Response following update to Selection Choice properties.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DeltaUpdateLabelResponseUpdateSelectionChoicePropertiesResponse {
        /**
         * The priority of the updated choice. The priority may change from what was specified to assure contiguous priorities between choices (1-n).
         */
        priority?: number | null;
    }
    /**
     * Request to deprecate a published Label.
     */
    export interface Schema$GoogleAppsDriveLabelsV2DisableLabelRequest {
        /**
         * Disabled policy to use.
         */
        disabledPolicy?: Schema$GoogleAppsDriveLabelsV2LifecycleDisabledPolicy;
        /**
         * The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used.
         */
        languageCode?: string | null;
        /**
         * The fields that should be updated. At least one field must be specified. The root `disabled_policy` is implied and should not be specified. A single `*` can be used as short-hand for updating every field.
         */
        updateMask?: string | null;
        /**
         * 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.
         */
        useAdminAccess?: boolean | null;
        /**
         * Provides control over how write requests are executed. Defaults to unset, which means last write wins.
         */
        writeControl?: Schema$GoogleAppsDriveLabelsV2WriteControl;
    }
    /**
     * Request to enable a label.
     */
    export interface Schema$GoogleAppsDriveLabelsV2EnableLabelRequest {
        /**
         * The BCP-47 language code to use for evaluating localized field labels. When not specified, values in the default configured language will be used.
         */
        languageCode?: string | null;
        /**
         * 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.
         */
        useAdminAccess?: boolean | null;
        /**
         * Provides control over how write requests are executed. Defaults to unset, which means last write wins.
         */
        writeControl?: Schema$GoogleAppsDriveLabelsV2WriteControl;
    }
    /**
     * Defines a field that has a display name, data type, and other configuration options. This field defines the kind of metadata that may be set on a Drive item.
     */
    export interface Schema$GoogleAppsDriveLabelsV2Field {
        /**
         * Output only. The capabilities this user has on this field and its value when the label is applied on Drive items.
         */
        appliedCapabilities?: Schema$GoogleAppsDriveLabelsV2FieldAppliedCapabilities;
        /**
         * Output only. The time this field was created.
         */
        createTime?: string | null;
        /**
         * Output only. The user who created this field.
         */
        creator?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Date field options.
         */
        dateOptions?: Schema$GoogleAppsDriveLabelsV2FieldDateOptions;
        /**
         * Output only. The user who disabled this field. This value has no meaning when the field is not disabled.
         */
        disabler?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The time this field was disabled. This value has no meaning when the field is not disabled.
         */
        disableTime?: string | null;
        /**
         * Output only. UI display hints for rendering a field.
         */
        displayHints?: Schema$GoogleAppsDriveLabelsV2FieldDisplayHints;
        /**
         * Output only. The key of a field, unique within a label or library. This value is autogenerated. Matches the regex: `([a-zA-Z0-9])+`
         */
        id?: string | null;
        /**
         * Integer field options.
         */
        integerOptions?: Schema$GoogleAppsDriveLabelsV2FieldIntegerOptions;
        /**
         * Output only. The lifecycle of this field.
         */
        lifecycle?: Schema$GoogleAppsDriveLabelsV2Lifecycle;
        /**
         * Output only. The LockStatus of this field.
         */
        lockStatus?: Schema$GoogleAppsDriveLabelsV2LockStatus;
        /**
         * The basic properties of the field.
         */
        properties?: Schema$GoogleAppsDriveLabelsV2FieldProperties;
        /**
         * Output only. The user who published this field. This value has no meaning when the field is not published.
         */
        publisher?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The key to use when constructing Drive search queries to find files based on values defined for this field on files. For example, "`{query_key\}` \> 2001-01-01".
         */
        queryKey?: string | null;
        /**
         * Output only. The capabilities this user has when editing this field.
         */
        schemaCapabilities?: Schema$GoogleAppsDriveLabelsV2FieldSchemaCapabilities;
        /**
         * Selection field options.
         */
        selectionOptions?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptions;
        /**
         * Text field options.
         */
        textOptions?: Schema$GoogleAppsDriveLabelsV2FieldTextOptions;
        /**
         * Output only. The user who modified this field.
         */
        updater?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The time this field was updated.
         */
        updateTime?: string | null;
        /**
         * User field options.
         */
        userOptions?: Schema$GoogleAppsDriveLabelsV2FieldUserOptions;
    }
    /**
     * The capabilities related to this field on applied metadata.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldAppliedCapabilities {
        /**
         * Whether the user can read related applied metadata on items.
         */
        canRead?: boolean | null;
        /**
         * Whether the user can search for Drive items referencing this field.
         */
        canSearch?: boolean | null;
        /**
         * Whether the user can set this field on Drive items.
         */
        canWrite?: boolean | null;
    }
    /**
     * Options for the date field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldDateOptions {
        /**
         * Output only. ICU date format.
         */
        dateFormat?: string | null;
        /**
         * Localized date formatting option. Field values are rendered in this format according to their locale.
         */
        dateFormatType?: string | null;
        /**
         * Output only. Maximum valid value (year, month, day).
         */
        maxValue?: Schema$GoogleTypeDate;
        /**
         * Output only. Minimum valid value (year, month, day).
         */
        minValue?: Schema$GoogleTypeDate;
    }
    /**
     * UI display hints for rendering a field.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldDisplayHints {
        /**
         * Whether the field should be shown in the UI as disabled.
         */
        disabled?: boolean | null;
        /**
         * This field should be hidden in the search menu when searching for Drive items.
         */
        hiddenInSearch?: boolean | null;
        /**
         * Whether the field should be shown as required in the UI.
         */
        required?: boolean | null;
        /**
         * This field should be shown in the apply menu when applying values to a Drive item.
         */
        shownInApply?: boolean | null;
    }
    /**
     * Options for the Integer field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldIntegerOptions {
        /**
         * Output only. The maximum valid value for the integer field.
         */
        maxValue?: string | null;
        /**
         * Output only. The minimum valid value for the integer field.
         */
        minValue?: string | null;
    }
    /**
     * Field constants governing the structure of a Field; such as, the maximum title length, minimum and maximum field values or length, etc.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldLimits {
        /**
         * Date Field limits.
         */
        dateLimits?: Schema$GoogleAppsDriveLabelsV2DateLimits;
        /**
         * Integer Field limits.
         */
        integerLimits?: Schema$GoogleAppsDriveLabelsV2IntegerLimits;
        /**
         * Long text Field limits.
         */
        longTextLimits?: Schema$GoogleAppsDriveLabelsV2LongTextLimits;
        /**
         * Limits for Field description, also called help text.
         */
        maxDescriptionLength?: number | null;
        /**
         * Limits for Field title.
         */
        maxDisplayNameLength?: number | null;
        /**
         * Max length for the id.
         */
        maxIdLength?: number | null;
        /**
         * Selection Field limits.
         */
        selectionLimits?: Schema$GoogleAppsDriveLabelsV2SelectionLimits;
        /**
         * The relevant limits for the specified Field.Type. Text Field limits.
         */
        textLimits?: Schema$GoogleAppsDriveLabelsV2TextLimits;
        /**
         * User Field limits.
         */
        userLimits?: Schema$GoogleAppsDriveLabelsV2UserLimits;
    }
    /**
     * Options for a multi-valued variant of an associated field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldListOptions {
        /**
         * Maximum number of entries permitted.
         */
        maxEntries?: number | null;
    }
    /**
     * Options the Long Text field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldLongTextOptions {
        /**
         * Output only. The maximum valid length of values for the text field.
         */
        maxLength?: number | null;
        /**
         * Output only. The minimum valid length of values for the text field.
         */
        minLength?: number | null;
    }
    /**
     * The basic properties of the field.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldProperties {
        /**
         * Required. The display text to show in the UI identifying this field.
         */
        displayName?: string | null;
        /**
         * Input only. Insert or move this field before the indicated field. If empty, the field is placed at the end of the list.
         */
        insertBeforeField?: string | null;
        /**
         * Whether the field should be marked as required.
         */
        required?: boolean | null;
    }
    /**
     * The capabilities related to this field when editing the field.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldSchemaCapabilities {
        /**
         * Whether the user can delete this field. The user must have permission and the field must be deprecated.
         */
        canDelete?: boolean | null;
        /**
         * Whether the user can disable this field. The user must have permission and this field must not already be disabled.
         */
        canDisable?: boolean | null;
        /**
         * Whether the user can enable this field. The user must have permission and this field must be disabled.
         */
        canEnable?: boolean | null;
        /**
         * Whether the user can change this field.
         */
        canUpdate?: boolean | null;
    }
    /**
     * Options for the selection field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldSelectionOptions {
        /**
         * The options available for this selection field. The list order is consistent, and modified with `insert_before_choice`.
         */
        choices?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice[];
        /**
         * When specified, indicates this field supports a list of values. Once the field is published, this cannot be changed.
         */
        listOptions?: Schema$GoogleAppsDriveLabelsV2FieldListOptions;
    }
    /**
     * Selection field choice.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoice {
        /**
         * Output only. The capabilities related to this choice on applied metadata.
         */
        appliedCapabilities?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities;
        /**
         * Output only. The time this choice was created.
         */
        createTime?: string | null;
        /**
         * Output only. The user who created this choice.
         */
        creator?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The user who disabled this choice. This value has no meaning when the option is not disabled.
         */
        disabler?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The time this choice was disabled. This value has no meaning when the choice is not disabled.
         */
        disableTime?: string | null;
        /**
         * Output only. UI display hints for rendering a choice.
         */
        displayHints?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints;
        /**
         * The unique value of the choice. This ID is autogenerated. Matches the regex: `([a-zA-Z0-9_])+`.
         */
        id?: string | null;
        /**
         * Output only. Lifecycle of the choice.
         */
        lifecycle?: Schema$GoogleAppsDriveLabelsV2Lifecycle;
        /**
         * Output only. The LockStatus of this choice.
         */
        lockStatus?: Schema$GoogleAppsDriveLabelsV2LockStatus;
        /**
         * Basic properties of the choice.
         */
        properties?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties;
        /**
         * Output only. The user who published this choice. This value has no meaning when the choice is not published.
         */
        publisher?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The time this choice was published. This value has no meaning when the choice is not published.
         */
        publishTime?: string | null;
        /**
         * Output only. The capabilities related to this option when editing the option.
         */
        schemaCapabilities?: Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities;
        /**
         * Output only. The user who updated this choice last.
         */
        updater?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The time this choice was updated last.
         */
        updateTime?: string | null;
    }
    /**
     * The capabilities related to this choice on applied metadata.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceAppliedCapabilities {
        /**
         * Whether the user can read related applied metadata on items.
         */
        canRead?: boolean | null;
        /**
         * Whether the user can use this choice in search queries.
         */
        canSearch?: boolean | null;
        /**
         * Whether the user can select this choice on an item.
         */
        canSelect?: boolean | null;
    }
    /**
     * UI display hints for rendering an option.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceDisplayHints {
        /**
         * The colors to use for the badge. Changed to Google Material colors based on the chosen `properties.badge_config.color`.
         */
        badgeColors?: Schema$GoogleAppsDriveLabelsV2BadgeColors;
        /**
         * The priority of this badge. Used to compare and sort between multiple badges. A lower number means the badge should be shown first. When a badging configuration is not present, this will be 0. Otherwise, this will be set to `BadgeConfig.priority_override` or the default heuristic which prefers creation date of the label, and field and option priority.
         */
        badgePriority?: string | null;
        /**
         * The dark-mode color to use for the badge. Changed to Google Material colors based on the chosen `properties.badge_config.color`.
         */
        darkBadgeColors?: Schema$GoogleAppsDriveLabelsV2BadgeColors;
        /**
         * Whether the option should be shown in the UI as disabled.
         */
        disabled?: boolean | null;
        /**
         * This option should be hidden in the search menu when searching for Drive items.
         */
        hiddenInSearch?: boolean | null;
        /**
         * This option should be shown in the apply menu when applying values to a Drive item.
         */
        shownInApply?: boolean | null;
    }
    /**
     * Basic properties of the choice.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceProperties {
        /**
         * The badge configuration for this choice. When set, the label that owns this choice is considered a "badged label".
         */
        badgeConfig?: Schema$GoogleAppsDriveLabelsV2BadgeConfig;
        /**
         * The description of this label.
         */
        description?: string | null;
        /**
         * Required. The display text to show in the UI identifying this field.
         */
        displayName?: string | null;
        /**
         * Input only. Insert or move this choice before the indicated choice. If empty, the choice is placed at the end of the list.
         */
        insertBeforeChoice?: string | null;
    }
    /**
     * The capabilities related to this choice when editing the choice.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldSelectionOptionsChoiceSchemaCapabilities {
        /**
         * Whether the user can delete this choice.
         */
        canDelete?: boolean | null;
        /**
         * Whether the user can disable this choice.
         */
        canDisable?: boolean | null;
        /**
         * Whether the user can enable this choice.
         */
        canEnable?: boolean | null;
        /**
         * Whether the user can update this choice.
         */
        canUpdate?: boolean | null;
    }
    /**
     * Options for the Text field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldTextOptions {
        /**
         * Output only. The maximum valid length of values for the text field.
         */
        maxLength?: number | null;
        /**
         * Output only. The minimum valid length of values for the text field.
         */
        minLength?: number | null;
    }
    /**
     * Options for the user field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2FieldUserOptions {
        /**
         * When specified, indicates that this field supports a list of values. Once the field is published, this cannot be changed.
         */
        listOptions?: Schema$GoogleAppsDriveLabelsV2FieldListOptions;
    }
    /**
     * Limits for integer Field type.
     */
    export interface Schema$GoogleAppsDriveLabelsV2IntegerLimits {
        /**
         * Maximum value for an integer Field type.
         */
        maxValue?: string | null;
        /**
         * Minimum value for an integer Field type.
         */
        minValue?: string | null;
    }
    /**
     * A label defines a taxonomy that can be applied to Drive items in order to organize and search across items. Labels can be simple strings, or can contain fields that describe additional metadata that can be further used to organize and search Drive items.
     */
    export interface Schema$GoogleAppsDriveLabelsV2Label {
        /**
         * Output only. The capabilities related to this label on applied metadata.
         */
        appliedCapabilities?: Schema$GoogleAppsDriveLabelsV2LabelAppliedCapabilities;
        /**
         * Output only. Behavior of this label when it's applied to Drive items.
         */
        appliedLabelPolicy?: Schema$GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy;
        /**
         * Output only. The time this label was created.
         */
        createTime?: string | null;
        /**
         * Output only. The user who created this label.
         */
        creator?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The customer this label belongs to. For example: "customers/123abc789."
         */
        customer?: string | null;
        /**
         * Output only. The user who disabled this label. This value has no meaning when the label is not disabled.
         */
        disabler?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The time this label was disabled. This value has no meaning when the label is not disabled.
         */
        disableTime?: string | null;
        /**
         * Output only. UI display hints for rendering the label.
         */
        displayHints?: Schema$GoogleAppsDriveLabelsV2LabelDisplayHints;
        /**
         * List of fields in descending priority order.
         */
        fields?: Schema$GoogleAppsDriveLabelsV2Field[];
        /**
         * Output only. Globally unique identifier of this label. ID makes up part of the label `name`, but unlike `name`, ID is consistent between revisions. Matches the regex: `([a-zA-Z0-9])+`
         */
        id?: string | null;
        /**
         * Required. The type of label.
         */
        labelType?: string | null;
        /**
         * Custom URL to present to users to allow them to learn more about this label and how it should be used.
         */
        learnMoreUri?: string | null;
        /**
         * Output only. The lifecycle state of the label including whether it's published, deprecated, and has draft changes.
         */
        lifecycle?: Schema$GoogleAppsDriveLabelsV2Lifecycle;
        /**
         * Output only. The LockStatus of this label.
         */
        lockStatus?: Schema$GoogleAppsDriveLabelsV2LockStatus;
        /**
         * Output only. Resource name of the label. Will be in the form of either: `labels/{id\}` or `labels/{id\}@{revision_id\}` depending on the request. See `id` and `revision_id` below.
         */
        name?: string | null;
        /**
         * Required. The basic properties of the label.
         */
        properties?: Schema$GoogleAppsDriveLabelsV2LabelProperties;
        /**
         * Output only. The user who published this label. This value has no meaning when the label is not published.
         */
        publisher?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. The time this label was published. This value has no meaning when the label is not published.
         */
        publishTime?: string | null;
        /**
         * Output only. The time this label revision was created.
         */
        revisionCreateTime?: string | null;
        /**
         * Output only. The user who created this label revision.
         */
        revisionCreator?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. Revision ID of the label. Revision ID might be part of the label `name` depending on the request issued. A new revision is created whenever revisioned properties of a label are changed. Matches the regex: `([a-zA-Z0-9])+`
         */
        revisionId?: string | null;
        /**
         * Output only. The capabilities the user has on this label.
         */
        schemaCapabilities?: Schema$GoogleAppsDriveLabelsV2LabelSchemaCapabilities;
    }
    /**
     * The capabilities a user has on this label's applied metadata.
     */
    export interface Schema$GoogleAppsDriveLabelsV2LabelAppliedCapabilities {
        /**
         * Whether the user can apply this label to items.
         */
        canApply?: boolean | null;
        /**
         * Whether the user can read applied metadata related to this label.
         */
        canRead?: boolean | null;
        /**
         * Whether the user can remove this label from items.
         */
        canRemove?: boolean | null;
    }
    /**
     * Behavior of this label when it's applied to Drive items.
     */
    export interface Schema$GoogleAppsDriveLabelsV2LabelAppliedLabelPolicy {
        /**
         * Indicates how the applied label and field values should be copied when a Drive item is copied.
         */
        copyMode?: string | null;
    }
    /**
     * UI display hints for rendering the label.
     */
    export interface Schema$GoogleAppsDriveLabelsV2LabelDisplayHints {
        /**
         * Whether the label should be shown in the UI as disabled.
         */
        disabled?: boolean | null;
        /**
         * This label should be hidden in the search menu when searching for Drive items.
         */
        hiddenInSearch?: boolean | null;
        /**
         * Order to display label in a list.
         */
        priority?: string | null;
        /**
         * This label should be shown in the apply menu when applying values to a Drive item.
         */
        shownInApply?: boolean | null;
    }
    /**
     * Label constraints governing the structure of a Label; such as, the maximum number of Fields allowed and maximum length of the label title.
     */
    export interface Schema$GoogleAppsDriveLabelsV2LabelLimits {
        /**
         * The limits for Fields.
         */
        fieldLimits?: Schema$GoogleAppsDriveLabelsV2FieldLimits;
        /**
         * The maximum number of published Fields that can be deleted.
         */
        maxDeletedFields?: number | null;
        /**
         * The maximum number of characters allowed for the description.
         */
        maxDescriptionLength?: number | null;
        /**
         * The maximum number of draft revisions that will be kept before deleting old drafts.
         */
        maxDraftRevisions?: number | null;
        /**
         * The maximum number of Fields allowed within the label.
         */
        maxFields?: number | null;
        /**
         * The maximum number of characters allowed for the title.
         */
        maxTitleLength?: number | null;
        /**
         * Resource name.
         */
        name?: string | null;
    }
    /**
     * A Lock that can be applied to a Label, Field, or Choice.
     */
    export interface Schema$GoogleAppsDriveLabelsV2LabelLock {
        /**
         * Output only. The user's capabilities on this LabelLock.
         */
        capabilities?: Schema$GoogleAppsDriveLabelsV2LabelLockCapabilities;
        /**
         * The ID of the Selection Field Choice that should be locked. If present, `field_id` must also be present.
         */
        choiceId?: string | null;
        /**
         * Output only. The time this LabelLock was created.
         */
        createTime?: string | null;
        /**
         * Output only. The user whose credentials were used to create the LabelLock. This will not be present if no user was responsible for creating the LabelLock.
         */
        creator?: Schema$GoogleAppsDriveLabelsV2UserInfo;
        /**
         * Output only. A timestamp indicating when this LabelLock was scheduled for deletion. This will be present only if this LabelLock is in the DELETING state.
         */
        deleteTime?: string | null;
        /**
         * The ID of the Field that should be locked. Empty if the whole Label should be locked.
         */
        fieldId?: string | null;
        /**
         * Output only. Resource name of this LabelLock.
         */
        name?: string | null;