Module

googleapis.drive

Module googleapis.drive

Client

About
BearerTokenConfig
CacheConfig
Capabilities
CertKey
CircuitBreakerConfig
ClientHttp1Settings
ClientHttp2Settings
ClientSecureSocket
ConnectionConfig
ContentHints
ContentRestrictions
CookieConfig
File
FileContent
FileMetadata
FilesResponse
GeneratedFileMetadata
ImageMediaMetadata
KeyStore
Location
OAuth2RefreshTokenGrantConfig
PermissionDetails
Permissions
PoolConfiguration
ProxyConfig
ResponseLimitConfigs
RetryConfig
RollingWindow
ShortcutDetails
StorageQuota
StringArrayValuePairs
StringKeyValuePairs
Thumbnail
TrustStore
User
VideoMediaMetadata

CertValidationType
CredentialBearer
HttpVersion
MimeTypes
Protocol

CACHE_CONTROL_AND_VALIDATORS
CHUNKING_ALWAYS
CHUNKING_AUTO
CHUNKING_NEVER
COMPRESSION_ALWAYS
COMPRESSION_AUTO
COMPRESSION_NEVER
KEEPALIVE_ALWAYS
KEEPALIVE_AUTO
KEEPALIVE_NEVER
REFRESH_URL
RFC_7234

CachingPolicy
Chunking
Compression
KeepAlive

ballerinax/googleapis.drive

3.1.0

Overview

The connector provides the capability to programmatically manage files and folders in the Google Drive.

This module supports Google Drive API v3.

Prerequisites

Before using this connector in your Ballerina application, complete the following:

Quickstart

To use the Google Drive connector in your Ballerina application, update the .bal file as follows:

Step 1: Import the connector

Import the ballerinax/googleapis.drive module into the Ballerina projects shown below.

Copy

All the actions return a valid response or error. If the action is a success, then the requested resource is returned. If not, an error is returned.

Step 2: Create a new connector instance

Create a drive:ConnectionConfig with the OAuth2 tokens obtained, and initialize the connector with it.

Copy

Step 3: Invoke the connector operation

  1. Now you can use the operations available within the connector. Note that they are in the form of remote operations.

    Following is an example on how to retrieve a file using the connector.

    Get file with given file ID

    Copy

  2. Use bal run command to compile and run the Ballerina program.

You can find a list of samples here

Clients

googleapis.drive: Client

Isolated

Ballerina Google Drive connector provides capability to programmatically manage files and folders. Google Drive API provides operations related to files, channels and changes in Google Drive.

Constructor

Initialize the connector.

init (ConnectionConfig driveConfig)

getFile

Isolated FunctionRemote Function
function getFile(string fileId, string? fields) returns File|error

Retrieves file using the file ID.

Parameters
  • fileId string - ID of the file to retrieve
  • fields string? (default ()) - The paths of the fields you want included in the response
Return Type
  • File|error - If successful, File. Else an error

getFileContent

Isolated FunctionRemote Function
function getFileContent(string fileId) returns FileContent|error

Retrieves file content using the fileId.

Parameters
  • fileId string - Id of the file to retrieve file content
Return Type

downloadFile

Isolated FunctionRemote Function
function downloadFile(string fileId) returns string|error

Downloads file using the fileId.

Parameters
  • fileId string - ID of the file to retrieve
Return Type
  • string|error - If successful, downloadable link value. Else an error

getAllFiles

Isolated FunctionRemote Function
function getAllFiles(string? filterString, string? orderBy) returns stream<File>|error

Retrieves all the files in the drive.

Parameters
  • filterString string? (default ()) - Query used to find what you need. Read documentation for query string patterns. https://github.com/ballerina-platform/module-ballerinax-googleapis.drive/blob/main/drive/README.md#filter-files
  • orderBy string? (default ()) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'
Return Type
  • stream<File>|error - If successful, stream of files stream<File>. Else an error

getFilesByName

Isolated FunctionRemote Function
function getFilesByName(string fileName, string? orderBy) returns stream<File>|error

Retrieves files by name.

Parameters
  • fileName string - Name of the file to search (Partial search)
  • orderBy string? (default ()) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'
Return Type
  • stream<File>|error - If successful, stream of files stream<File>. Else an error

getAllSpreadsheets

Isolated FunctionRemote Function
function getAllSpreadsheets() returns stream<File>|error

Retrieves all Google spreadsheets.

Return Type
  • stream<File>|error - If successful, stream of files stream<File>. Else an error

getSpreadsheetsByName

Isolated FunctionRemote Function
function getSpreadsheetsByName(string fileName, string? orderBy) returns stream<File>|error

Retrieves Google spreadsheets by name

Parameters
  • fileName string - Name of the file to search (Partial search)
  • orderBy string? (default ()) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'
Return Type
  • stream<File>|error - If successful, stream of files stream<File>. Else an error

getDocumentsByName

Isolated FunctionRemote Function
function getDocumentsByName(string fileName, string? orderBy) returns stream<File>|error

Retrieves Google documents by name

Parameters
  • fileName string - Name of the file to be searched (Partial search)
  • orderBy string? (default ()) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'
Return Type
  • stream<File>|error - If successful, stream of files stream<File>. Else an error

getFormsByName

Isolated FunctionRemote Function
function getFormsByName(string fileName, string? orderBy) returns stream<File>|error

Retrieves Google forms by name.

Parameters
  • fileName string - Name of the file to be searched (Partial search)
  • orderBy string? (default ()) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'
Return Type
  • stream<File>|error - If successful, stream of files stream<File>. Else an error

getSlidesByName

Isolated FunctionRemote Function
function getSlidesByName(string fileName, string? orderBy) returns stream<File>|error

Retrieves Google slides by name.

Parameters
  • fileName string - Name of the file to be searched (Partial search)
  • orderBy string? (default ()) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'
Return Type
  • stream<File>|error - If successful, stream of files stream<File>. Else an error

getFoldersByName

Isolated FunctionRemote Function
function getFoldersByName(string folderName, string? orderBy) returns stream<File>|error

Retrieves folders by name.

Parameters
  • folderName string - Name of the folder to be searched (Partial search)
  • orderBy string? (default ()) - A comma-separated list of sort keys. Valid keys are 'createdTime', 'folder', 'modifiedByMeTime', 'modifiedTime', 'name', 'name_natural', 'quotaBytesUsed', 'recency', 'sharedWithMeTime', 'starred', and 'viewedByMeTime'.
Return Type
  • stream<File>|error - If successful, stream of files stream<File>. Else an error

deleteFile

Isolated FunctionRemote Function
function deleteFile(string fileId) returns boolean|error

Deletes file using the file ID.

Parameters
  • fileId string - ID of the file to delete
Return Type
  • boolean|error - If successful, boolean as true. Else an error

copyFile

Isolated FunctionRemote Function
function copyFile(string fileId, string? destinationFolderId, string? newFileName) returns File|error

Copies file using the file ID.

Parameters
  • fileId string - ID of the file to be copied
  • destinationFolderId string? (default ()) - Folder ID of the destination
  • newFileName string? (default ()) - Name of the New file
Return Type
  • File|error - If successful, File. Else an error

moveFile

Isolated FunctionRemote Function
function moveFile(string fileId, string destinationFolderId) returns File|error

Moves file using the file ID.

Parameters
  • fileId string - ID of the file to be moved
  • destinationFolderId string - Folder ID of the destination
Return Type
  • File|error - If successful, File. Else an error

renameFile

Isolated FunctionRemote Function
function renameFile(string fileId, string newFileName) returns File|error

Renames a file.

Parameters
  • fileId string - File ID that need to be renamed
  • newFileName string - New file name that should be renamed to
Return Type
  • File|error - If successful, File. Else an error

updateFileMetadataById

Isolated FunctionRemote Function
function updateFileMetadataById(string fileId, FileMetadata? fileMetadata, record { addParents string, includePermissionsForView string, keepRevisionForever boolean, ocrLanguage string, removeParents string, supportsAllDrives boolean, useContentAsIndexableText boolean,  anydata... }? optional) returns File|error

Updates file metadata using the file ID.

Parameters
  • fileId string - ID of the file to be updated
  • fileMetadata FileMetadata? (default ()) - 'FileMetadata' can added as a payload to change metadata
  • optional record { addParents string, includePermissionsForView string, keepRevisionForever boolean, ocrLanguage string, removeParents string, supportsAllDrives boolean, useContentAsIndexableText boolean, anydata... }? (default ()) - 'UpdateFileMetadataOptional' used to add query parameters to the request
Return Type
  • File|error - If successful, File. Else an error

createFile

Isolated FunctionRemote Function
function createFile(string fileName, MimeTypes? mime, string? folderId) returns File|error

Creates new file.

Parameters
  • fileName string - Name of the new file to be created
  • mime MimeTypes? (default ()) - Type of file that is going to create. refer https://developers.google.com/drive/api/v3/mime-types You need to only specify the last word in the MIME type. For an example, If you want to create a Google document.. The value for this parameter should be "document" .. Google sheets -> "spreadsheet" etc
  • folderId string? (default ()) - ID of the parent folder that the new file wants to get created
Return Type
  • File|error - If successful, File. Else an error

createFolder

Isolated FunctionRemote Function
function createFolder(string folderName, string? parentFolderId) returns File|error

Creates new folder.

Parameters
  • folderName string - Name of the new folder to be created
  • parentFolderId string? (default ()) - ID of the parent folder
Return Type
  • File|error - If successful, File. Else an error

uploadFile

Isolated FunctionRemote Function
function uploadFile(string localPath, string? fileName, string? parentFolderId) returns File|error

Uploads new file.

Parameters
  • localPath string - Path to the file object to be uploaded
  • fileName string? (default ()) - File name for the uploading file (optional). It will take the base name, if not provided
  • parentFolderId string? (default ()) - Parent folder ID (optional). It will be uploaded to the root, if not provided
Return Type
  • File|error - If successful, File. Else an error

uploadFileUsingByteArray

Isolated FunctionRemote Function
function uploadFileUsingByteArray(byte[] byteArray, string fileName, string? parentFolderId) returns File|error

Uploads new file using a Byte array.

Parameters
  • byteArray byte[] - Byte array that represents the file object
  • fileName string - File name for the uploading file (optional). It will take the base name, if not provided
  • parentFolderId string? (default ()) - Parent folder ID (optional). It will be uploaded to the root, if not provided
Return Type
  • File|error - If successful, File. Else an error

Records

googleapis.drive: About

Represents drive information.

Fields
  • kind string? - Identifies what kind of resource this is. Value: the fixed string "drive#about"
  • user User? - The authenticated user
  • storageQuota StorageQuota? - The user's storage quota limits and usage. All fields are measured in bytes
  • importFormats StringArrayValuePairs? - A map of source MIME type to possible targets for all supported imports
  • exportFormats StringArrayValuePairs? - A map of source MIME type to possible targets for all supported exports
  • maxUploadSize float? - The maximum upload size in bytes
  • appInstalled boolean? - Whether the user has installed the requesting app
  • folderColorPalette string[]? - The currently supported folder colors as RGB hex strings
  • canCreateDrives boolean? - Indicates whether the user can create shared drives

googleapis.drive: BearerTokenConfig

Closed record

Represents token for Bearer token authentication.

Fields
  • token string - Bearer token for authentication

googleapis.drive: CacheConfig

Closed record

Provides a set of configurations for controlling the caching behaviour of the endpoint.

Fields
  • enabled boolean(default true) - Specifies whether HTTP caching is enabled. Caching is enabled by default.
  • isShared boolean(default false) - Specifies whether the HTTP caching layer should behave as a public cache or a private cache
  • capacity int(default 16) - The capacity of the cache
  • evictionFactor float(default 0.2) - The fraction of entries to be removed when the cache is full. The value should be between 0 (exclusive) and 1 (inclusive).
  • policy CachingPolicy(default CACHE_CONTROL_AND_VALIDATORS) - Gives the user some control over the caching behaviour. By default, this is set to CACHE_CONTROL_AND_VALIDATORS. The default behaviour is to allow caching only when the cache-control header and either the etag or last-modified header are present.

googleapis.drive: Capabilities

Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

Fields
  • canAddChildren boolean - Whether the current user can add children to this folder. This is always false when the item is not a folder
  • canAddFolderFromAnotherDrive boolean - Whether the current user can add a folder from another drive (different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives
  • canAddMyDriveParent boolean - Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files
  • canChangeCopyRequiresWriterPermission boolean - Whether the current user can change the copyRequiresWriterPermission restriction of this file
  • canComment boolean - Whether the current user can comment on this file
  • canCopy boolean - Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder
  • canDelete boolean - Whether the current user can delete this file
  • canDeleteChildren boolean - Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives
  • canDownload boolean - Whether the current user can download this file
  • canEdit boolean - Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent
  • canListChildren boolean - Whether the current user can list the children of this folder. This is always false when the item is not a folder
  • canModifyContent boolean - Whether the current user can modify the content of this file
  • canModifyContentRestriction boolean - Whether the current user can modify restrictions on content of this file
  • canMoveChildrenOutOfDrive boolean - Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder.Only populated for items in shared drives.
  • canMoveChildrenWithinDrive boolean - Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder
  • canMoveItemOutOfDrive boolean - Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added
  • canMoveItemWithinDrive boolean - Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed
  • canReadRevisions boolean - Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read
  • canReadDrive boolean - Whether the current user can read the shared drive to which this file belongs Only populated for items in shared drives
  • canRemoveChildren boolean - Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead
  • canRemoveMyDriveParent boolean - Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files
  • canRename boolean - Whether the current user can rename this file
  • canShare boolean - Whether the current user can modify the sharing settings for this file
  • canTrash boolean - Whether the current user can move this file to trash
  • canTrashChildren boolean - Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives
  • canUntrash boolean - Whether the current user can restore this file from trash

googleapis.drive: CertKey

Closed record

Represents the combination of the certificate file path, private key file path, and private key password if encrypted.

Fields
  • certFile string - A file containing the certificate
  • keyFile string - A file containing the private key
  • keyPassword string? - Password of the private key (if encrypted)

googleapis.drive: CircuitBreakerConfig

Closed record

Provides a set of configurations for controlling the behaviour of the Circuit Breaker.

Fields
  • rollingWindow RollingWindow(default {}) - The http:RollingWindow options of the CircuitBreaker
  • failureThreshold float(default 0.0) - The threshold for request failures. When this threshold exceeds, the circuit trips. The threshold should be a value between 0 and 1
  • resetTime decimal(default 0) - The time period (in seconds) to wait before attempting to make another request to the upstream service
  • statusCodes int[](default []) - Array of HTTP response status codes which are considered as failures

googleapis.drive: ClientHttp1Settings

Closed record

Provides settings related to HTTP/1.x protocol.

Fields
  • keepAlive KeepAlive(default KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
  • chunking Chunking(default CHUNKING_NEVER) - The chunking behaviour of the request

googleapis.drive: ClientHttp2Settings

Closed record

Provides settings related to HTTP/2 protocol.

Fields
  • http2PriorKnowledge boolean(default false) - Configuration to enable HTTP/2 prior knowledge

googleapis.drive: ClientSecureSocket

Closed record

Provides configurations for facilitating secure communication with a remote HTTP endpoint.

Fields
  • enable boolean(default true) - Enable SSL validation
  • cert TrustStore|string? - Configurations associated with crypto:TrustStore or single certificate file that the client trusts
  • key KeyStore|CertKey? - Configurations associated with crypto:KeyStore or combination of certificate and private key of the client
  • protocol record {| name Protocol, versions string[] |}? - SSL/TLS protocol related options
  • certValidation record {| 'type CertValidationType, cacheSize int, cacheValidityPeriod int |}? - Certificate validation against OCSP_CRL, OCSP_STAPLING related options
  • ciphers string[]? - List of ciphers to be used eg: TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA
  • verifyHostName boolean(default true) - Enable/disable host name verification
  • shareSession boolean(default true) - Enable/disable new SSL session creation
  • handshakeTimeout decimal? - SSL handshake time out
  • sessionTimeout decimal? - SSL session time out

googleapis.drive: ConnectionConfig

Closed record

Client configuration details.

Fields
  • httpVersion HttpVersion(default http:HTTP_1_1) - The HTTP version understood by the client

googleapis.drive: ContentHints

Additional information about the content of the file. These fields are never populated in responses.

Fields
  • thumbnail Thumbnail - A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail
  • indexableText string - Text to be indexed for the file to improve fullText queries. This is limited to 128KB in length and may contain HTML elements

googleapis.drive: ContentRestrictions

Restrictions for accessing the content of the file. Only populated if such a restriction exists.

Fields
  • readOnly boolean - Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added,comments may not be added or modified, and the title of the file may not be modified
  • reason string - Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true
  • restrictingUser User - The user who set the content restriction. Only populated if readOnly is true
  • restrictionTime string - The time at which the content restriction was set (formatted RFC 3339 timestamp) Only populated if readOnly is true

googleapis.drive: CookieConfig

Closed record

Client configuration for cookies.

Fields
  • enabled boolean(default false) - User agents provide users with a mechanism for disabling or enabling cookies
  • maxCookiesPerDomain int(default 50) - Maximum number of cookies per domain, which is 50
  • maxTotalCookieCount int(default 3000) - Maximum number of total cookies allowed to be stored in cookie store, which is 3000
  • blockThirdPartyCookies boolean(default true) - User can block cookies from third party responses and refuse to send cookies for third party requests, if needed

googleapis.drive: File

Represents File.

Fields

googleapis.drive: FileContent

Represents file content.

Fields
  • content byte[] - A byte[] which represents the content of a file
  • mimeType string - The MIME type for the file

googleapis.drive: FileMetadata

Represents file metadata.

Fields
  • name string? - The name of the file. This is not necessarily unique within a folder. Note that the name is constant for immutable items such as the top level folders of shared drives, My Drive root folder, and the Application Data folder
  • mimeType string? - The MIME (Multipurpose Internet Mail Extensions) type of file. If no value is provided, Google Drive attempts to automatically detect an appropriate value from uploaded content. The value cannot be changed unless a new revision is uploaded. If a file is created with a Google Doc MIME type, the uploaded content will be imported if possible. The supported import formats are published in the About resource
  • description string? - A short description of the file
  • starred boolean? - Whether the user has starred the file
  • trashed boolean? - Whether the file has been trashed, either explicitly or from a trashed parent folder. Only the owner may trash a file. The trashed item is excluded from all files. list responses returned for any user who does not own the file. However, all users with access to the file can see the trashed item metadata in an API response. All users with access can copy, download, export, and share the file
  • folderColorRgb string? - The color for a folder as an RGB hex string
  • appProperties StringKeyValuePairs? - A collection of arbitrary key-value pairs which are private to the requesting app
  • contentHints ContentHints? - Additional information about the content of the file. These fields are never populated in responses.
  • copyRequiresWriterPermission boolean? - Whether the options to copy, print, or download this file, should be disabled for readers and commenters
  • modifiedTime string? - The last time the file was modified by anyone (RFC 3339 date-time)
  • originalFilename string? - The original filename of the uploaded content if available, or else the original value of the name field. This is only available for files with binary content in Google Drive
  • properties StringKeyValuePairs? - A collection of arbitrary key-value pairs which are visible to all apps
  • viewedByMeTime string? - The last time the file was viewed by the user (RFC 3339 date-time)
  • writersCanShare boolean? - Whether users with only writer permission can modify the file's permissions

googleapis.drive: FilesResponse

Response from file search

Fields
  • kind string - Identifies what kind of resource this is. Value: the fixed string "drive#fileList"
  • nextPageToken string? - The page token for the next page of files. This will be absent if the end of the files list has been reached. If the token is rejected for any reason, it should be discarded, and pagination should be restarted from the first page of results
  • incompleteSearch boolean? - Whether the search process was incomplete. If true, then some search results may be missing, Since all documents were not searched. This may occur when searching multiple drives with the "allDrives" corpora, but all corpora could not be searched. When this happens, it is suggested that clients narrow their query by choosing a different corpus such as "user" or "drive".
  • files File[] - The list of files. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.

googleapis.drive: GeneratedFileMetadata

Represents generated file metadata

Fields
  • id string? - The ID of the file/folder
  • kind string? - Identifies what kind of resource this is. Value: the fixed string "drive#file"
  • explicitlyTrashed boolean? - Whether the file has been explicitly trashed, as opposed to recursively trashed from a parent folder
  • trashingUser User? - If the file has been explicitly trashed, the user who trashed it. Only populated for items in shared drives
  • trashedTime string? - The time that the item was trashed (RFC 3339 date-time). Only populated for items in shared drives
  • parents string[]? - The IDs of the parent folders which contain the file. If not specified as part of a create request, the file will be placed directly in the user's My Drive folder. If not specified as part of a copy request, the file will inherit any discoverable parents of the source file Update requests must use the addParents and removeParents parameters to modify the parents list.
  • spaces string[]? - The list of spaces which contain the file. The currently supported values are 'drive', 'appDataFolder' and 'photos'
  • 'version int? -
  • hasThumbnail boolean? - Whether this file has a thumbnail. This does not indicate whether the requesting app has access to the thumbnail.To check access,look for the presence of the thumbnailLink field
  • thumbnailVersion int? - The thumbnail version for use in thumbnail cache invalidation
  • viewedByMe boolean? - Whether the file has been viewed by this user
  • modifiedByMe boolean? - Whether the file has been modified by this user
  • createdTime string? - The time at which the file was created (RFC 3339 date-time)
  • modifiedByMeTime string? - The last time the file was modified by the user (RFC 3339 date-time)
  • sharedWithMeTime string? - The time at which the file was shared with the user, if applicable (RFC 3339 date-time). Not populated for items in shared drives
  • sharingUser User? - The user who shared the file with the requesting user, if applicable
  • owners User[]? - The owners of the file. Currently, only certain legacy files may have more than one owner. Not populated for items in shared drives
  • driveId string? - ID of the shared drive the file resides in. Only populated for items in shared drives
  • lastModifyingUser User? - The last user to modify the file
  • shared boolean? - Whether the file has been shared. Not populated for items in shared drives
  • ownedByMe boolean? - Whether the user owns the file. Not populated for items in shared drives
  • capabilities Capabilities? - Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take
  • permissions Permissions[]? - The full list of permissions for the file. This is only available if the requesting user can share the file. Not populated for items in shared drives
  • permissionIds string[]? - List of permission IDs for users with access to this file
  • hasAugmentedPermissions boolean? - Whether there are permissions directly on this file. This field is only populated for items in shared drives
  • fullFileExtension string? - The full file extension extracted from the name field. May contain multiple concatenated extensions, such as "tar.gz".This is only available for files with binary content in Google Drive
  • fileExtension string? - The final component of fullFileExtension. This is only available for files with binary content in Google Drive
  • md5Checksum string? - The MD5 checksum for the content of the file. This is only applicable to files with binary content in Google Drive
  • size int? - The size of the file's content in bytes. This is applicable to binary files in Google Drive and Google Docs files
  • quotaBytesUsed int? - The number of storage quota bytes used by the file. This includes the head revision as well as previous revisions with keepForever enabled
  • headRevisionId string? - The ID of the file's head revision. This is currently only available for files with binary content in Google Drive
  • imageMediaMetadata ImageMediaMetadata? - Additional metadata about image media, if available
  • videoMediaMetadata VideoMediaMetadata? - Additional metadata about video media. This may not be available immediately upon upload
  • isAppAuthorized boolean? - Whether the file was created or opened by the requesting app
  • shortcutDetails ShortcutDetails? - Shortcut file details.Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut
  • contentRestrictions ContentRestrictions? - Restrictions for accessing the content of the file. Only populated if such a restriction exists

googleapis.drive: ImageMediaMetadata

Additional metadata about image media, if available

Fields
  • width int - The width of the video in pixels
  • height int - The height of the image in pixels
  • rotation int - The number of clockwise 90 degree rotations applied from the image's original orientation
  • location Location - Geographic location information stored in the image
  • time string - The date and time the photo was taken (EXIF DateTime)
  • cameraMake string - The make of the camera used to create the photo
  • cameraModel string - The model of the camera used to create the photo
  • exposureTime int - The length of the exposure in seconds
  • aperture int - The aperture used to create the photo (f-number)
  • flashUsed boolean - Whether a flash was used to create the photo
  • focalLength int - The focal length used to create the photo, in millimeters
  • isoSpeed int - The ISO speed used to create the photo
  • meteringMode string - The metering mode used to create the photo
  • sensor string - The type of sensor used to create the photo
  • exposureMode string - The length of the exposure, in seconds
  • colorSpace string - The color space of the photo
  • whiteBalance string - The white balance mode used to create the photo
  • exposureBias int - The exposure bias of the photo (APEX value)
  • maxApertureValue int - The smallest f-number of the lens at the focal length used to create the photo (APEX value)
  • subjectDistance int - The distance to the subject of the photo, in meters
  • lens string - The lens used to create the photo

googleapis.drive: KeyStore

Closed record

Represents the KeyStore-related configurations.

Fields
  • path string - Path to the KeyStore file
  • password string - KeyStore password

googleapis.drive: Location

Geographic location information stored in the image.

Fields
  • latitude float - The latitude stored in the image
  • longitude float - The longitude stored in the image
  • altitude float - The altitude stored in the image

googleapis.drive: OAuth2RefreshTokenGrantConfig

Closed record

Represents OAuth2 refresh token grant configurations for OAuth2 authentication.

Fields
  • refreshUrl string - Refresh token URL of the token endpoint
  • refreshToken string - Refresh token for the token endpoint
  • clientId string - Client ID of the client authentication
  • clientSecret string - Client secret of the client authentication
  • scopes string[]? - Scope(s) of the access request
  • defaultTokenExpTime decimal(default 3600) - Expiration time (in seconds) of the tokens if the token endpoint response does not contain an expires_in field
  • clockSkew decimal(default 0) - Clock skew (in seconds) that can be used to avoid token validation failures due to clock synchronization problems
  • optionalParams map<string>? - Map of the optional parameters used for the token endpoint
  • credentialBearer CredentialBearer(default AUTH_HEADER_BEARER) - Bearer of the authentication credentials, which is sent to the token endpoint

googleapis.drive: PermissionDetails

Details of whether the permissions on this shared drive item are inherited or directly on this item. This is an output-only field which is present only for shared drive items.

Fields
  • permissionType string - The permission type for this user
  • role string - The primary role for this user
  • inheritedFrom string - The ID of the item from which this permission is inherited. This is an output-only field
  • inherited boolean - Whether this permission is inherited. This field is always populated. This is an output-only field

googleapis.drive: Permissions

A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Fields
  • kind string - Identifies what kind of resource this is. Value: the fixed string "drive#permission"
  • id string - The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values
  • emailAddress string - The email address of the user or group to which this permission refers
  • domain string - The domain to which this permission refers
  • role string - The role granted by this permission
  • view string - Indicates the view for this permission. Only populated for permissions that belong to a view. published is the only supported value
  • allowFileDiscovery boolean - Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone
  • displayName string - The "pretty" name of the value of the permission
  • expirationTime string - The time at which this permission will expire (RFC 3339 date-time)
  • permissionDetails PermissionDetails[]? - Details of whether the permissions on this shared drive item are inherited or directly on this item This is an output-only field which is present only for shared drive items.
  • deleted boolean - Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions

googleapis.drive: PoolConfiguration

Closed record

Configurations for managing HTTP client connection pool.

Fields
  • maxActiveConnections int(default -1) - Max active connections per route(host:port). Default value is -1 which indicates unlimited.
  • maxIdleConnections int(default 100) - Maximum number of idle connections allowed per pool.
  • waitTime decimal(default 30) - Maximum amount of time (in seconds), the client should wait for an idle connection before it sends an error when the pool is exhausted
  • maxActiveStreamsPerConnection int(default 50) - Maximum active streams per connection. This only applies to HTTP/2.

googleapis.drive: ProxyConfig

Closed record

Proxy server configurations to be used with the HTTP client endpoint.

Fields
  • host string(default "") - Host name of the proxy server
  • port int(default 0) - Proxy server port
  • userName string(default "") - Proxy server username
  • password string(default "") - proxy server password

googleapis.drive: ResponseLimitConfigs

Closed record

Provides inbound response status line, total header and entity body size threshold configurations.

Fields
  • maxStatusLineLength int(default 4096) - Maximum allowed length for response status line(HTTP/1.1 200 OK). Exceeding this limit will result in a ClientError
  • maxHeaderSize int(default 8192) - Maximum allowed size for headers. Exceeding this limit will result in a ClientError
  • maxEntityBodySize int(default -1) - Maximum allowed size for the entity body. By default it is set to -1 which means there is no restriction maxEntityBodySize, On the Exceeding this limit will result in a ClientError

googleapis.drive: RetryConfig

Closed record

Provides configurations for controlling the retrying behavior in failure scenarios.

Fields
  • count int(default 0) - Number of retry attempts before giving up
  • interval decimal(default 0) - Retry interval in seconds
  • backOffFactor float(default 0.0) - Multiplier, which increases the retry interval exponentially.
  • maxWaitInterval decimal(default 0) - Maximum time of the retry interval in seconds
  • statusCodes int[](default []) - HTTP response status codes which are considered as failures

googleapis.drive: RollingWindow

Closed record

Represents a rolling window in the Circuit Breaker.

Fields
  • requestVolumeThreshold int(default 10) - Minimum number of requests in a RollingWindow that will trip the circuit.
  • timeWindow decimal(default 60) - Time period in seconds for which the failure threshold is calculated
  • bucketSize decimal(default 10) - The granularity at which the time window slides. This is measured in seconds.

googleapis.drive: ShortcutDetails

Shortcut file details. Only populated for shortcut files, which have the mimeType field set to application/vnd.google-apps.shortcut.

Fields
  • targetId string - The ID of the file that this shortcut points to
  • targetMimeType string - The MIME type of the file that this shortcut points to. The value of this field is a snapshot of the target's MIME type, captured when the shortcut is created

googleapis.drive: StorageQuota

Record Type to accept float values.

Fields

googleapis.drive: StringArrayValuePairs

Record Type to accept string[] values.

Fields

googleapis.drive: StringKeyValuePairs

Record Type to accpet string values.

Fields

googleapis.drive: Thumbnail

A thumbnail for the file. This will only be used if Google Drive cannot generate a standard thumbnail.

Fields
  • image byte - The thumbnail data encoded with URL-safe Base64 (RFC 4648 section 5)
  • mimeType string - The MIME type of the thumbnail

googleapis.drive: TrustStore

Closed record

Represents the truststore-related configurations.

Fields
  • path string - Path to the TrustStore file
  • password string - TrustStore password

googleapis.drive: User

Represents User.

Fields
  • kind string? - Identifies what kind of resource this is. Value: the fixed string "drive#user".
  • displayName string? - A plain text displayable name for this user
  • me boolean? - Whether this user is the requesting user
  • permissionId string? - The user's ID as visible in Permission resources
  • emailAddress string? - The email address of the user. This may not be present in certain contexts if the user has not made. their email address visible to the requester

googleapis.drive: VideoMediaMetadata

Additional metadata about video media. This may not be available immediately upon upload.

Fields
  • width int - The width of the video in pixelsn
  • height int - The height of the video in pixels
  • durationMillis float - The duration of the video in milliseconds

Enums

googleapis.drive: CertValidationType

Represents certification validation type options.

Members

OCSP_CRL
OCSP_STAPLING

googleapis.drive: CredentialBearer

Represents the credential-bearing methods.

Members

AUTH_HEADER_BEARER
POST_BODY_BEARER

googleapis.drive: HttpVersion

Represents the HTTP versions.

Members

HTTP_V1_0 - Represents HTTP/1.0 protocol
HTTP_V1_1 - Represents HTTP/1.1 protocol
HTTP_V2_0 - Represents HTTP/2.0 protocol

googleapis.drive: MimeTypes

Mime types for file operations.

Members

DOCUMENT
SPREADSHEET
PRESENTATION
FORM
AUDIO - Audio MIME type
DRIVE_SDK - Drive SDK MIME type
DRAWING - Drawing MIME type
FILE - File MIME type
FUSIONTABLE - Fusiontable MIME type
MAP - Map MIME type
PHOTO - Photo MIME type
SCRIPT - Script MIME type
SHORTCUT - Shortcut MIME type
SITE - Site MIME type
UNKNOWN - Unknown MIME type
VIDEO - Video MIME type

googleapis.drive: Protocol

Represents protocol options.

Members

SSL
TLS
DTLS

Constants

googleapis.drive: CACHE_CONTROL_AND_VALIDATORS

string "CACHE_CONTROL_AND_VALIDATORS"

This is a more restricted mode of RFC 7234. Setting this as the caching policy restricts caching to instances where the cache-control header and either the etag or last-modified header are present.

googleapis.drive: CHUNKING_ALWAYS

string "ALWAYS"

Always set chunking header in the response.

googleapis.drive: CHUNKING_AUTO

string "AUTO"

If the payload is less than 8KB, content-length header is set in the outbound request/response, otherwise chunking header is set in the outbound request/response.}

googleapis.drive: CHUNKING_NEVER

string "NEVER"

Never set the chunking header even if the payload is larger than 8KB in the outbound request/response.

googleapis.drive: COMPRESSION_ALWAYS

string "ALWAYS"

Always set accept-encoding/content-encoding in outbound request/response.

googleapis.drive: COMPRESSION_AUTO

string "AUTO"

When service behaves as a HTTP gateway inbound request/response accept-encoding option is set as the outbound request/response accept-encoding/content-encoding option.

googleapis.drive: COMPRESSION_NEVER

string "NEVER"

Never set accept-encoding/content-encoding header in outbound request/response.

googleapis.drive: KEEPALIVE_ALWAYS

string "ALWAYS"

Keeps the connection alive irrespective of the connection header value }

googleapis.drive: KEEPALIVE_AUTO

string "AUTO"

Decides to keep the connection alive or not based on the connection header of the client request }

googleapis.drive: KEEPALIVE_NEVER

string "NEVER"

Closes the connection irrespective of the connection header value }

googleapis.drive: REFRESH_URL

string "https://www.googleapis.com/oauth2/v3/token"

googleapis.drive: RFC_7234

string "RFC_7234"

Caching behaviour is as specified by the RFC 7234 specification.

Types

googleapis.drive: CachingPolicy

CACHE_CONTROL_AND_VALIDATORS|RFC_7234

Used for configuring the caching behaviour. Setting the policy field in the CacheConfig record allows the user to control the caching behaviour.

googleapis.drive: Chunking

CHUNKING_AUTO|CHUNKING_ALWAYS|CHUNKING_NEVER

Defines the possible values for the chunking configuration in HTTP services and clients.

AUTO: If the payload is less than 8KB, content-length header is set in the outbound request/response, otherwise chunking header is set in the outbound request/response ALWAYS: Always set chunking header in the response NEVER: Never set the chunking header even if the payload is larger than 8KB in the outbound request/response

googleapis.drive: Compression

COMPRESSION_AUTO|COMPRESSION_ALWAYS|COMPRESSION_NEVER

Options to compress using gzip or deflate.

AUTO: When service behaves as a HTTP gateway inbound request/response accept-encoding option is set as the outbound request/response accept-encoding/content-encoding option ALWAYS: Always set accept-encoding/content-encoding in outbound request/response NEVER: Never set accept-encoding/content-encoding header in outbound request/response

googleapis.drive: KeepAlive

KEEPALIVE_AUTO|KEEPALIVE_ALWAYS|KEEPALIVE_NEVER

Defines the possible values for the keep-alive configuration in service and client endpoints.

Other versions

3.1.0

3.0.02.2.02.1.02.0.0
See more...

Terms of service

Privacy policy

Cookie policy

2023 WSO2