Module googleapis.drive
ballerinax/googleapis.drive Ballerina library
3.5.0
Overview
Google Drive is a cloud-based storage service that allows users to store, share, and collaborate on files and folders across various devices. It provides a secure and accessible platform for managing digital content.
The Google Drive connector offers APIs to connect and interact with Google Drive API v3, enabling developers to manage files and folders programmatically within their applications.
Key Features
- Create, upload, and manage files and folders programmatically
- Support for Google Drive API v3
- Search and filter files within Google Drive
- Secure integration with Google workspace environment
Report issues
To report bugs, request new features, start new discussions, view project boards, etc., go to the Ballerina Extended Library repository
Useful links
- Discuss code changes of the Ballerina project in ballerina-dev@googlegroups.com.
- Chat live with us via our Discord server.
- Post all technical questions on Stack Overflow with the #ballerina tag
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)- driveConfig ConnectionConfig -
getFile
Isolated FunctionRemote Function
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
getFileContent
Isolated FunctionRemote Function
function getFileContent(string fileId) returns FileContent|errorRetrieves file content using the fileId.
Parameters
- fileId string - Id of the file to retrieve file content
Return Type
- FileContent|error - If successful,
FileContent. Else anerror
downloadFile
Isolated FunctionRemote Function
Downloads file using the fileId.
Parameters
- fileId string - ID of the file to retrieve
exportFile
Isolated FunctionRemote Function
function exportFile(string fileId, string mimeType) returns FileContent|errorExports file using the fileId.
Parameters
- fileId string - ID of the file to retrieve
- mimeType string - MIME type of the file to be exported
Return Type
- FileContent|error - If successful,
FileContent. Else anerror
getAllFiles
Isolated FunctionRemote Function
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'
getFilesByName
Isolated FunctionRemote Function
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'
getAllSpreadsheets
Isolated FunctionRemote Function
Retrieves all Google spreadsheets.
getSpreadsheetsByName
Isolated FunctionRemote Function
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'
getDocumentsByName
Isolated FunctionRemote Function
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'
getFormsByName
Isolated FunctionRemote Function
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'
getSlidesByName
Isolated FunctionRemote Function
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'
getFoldersByName
Isolated FunctionRemote Function
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'.
deleteFile
Isolated FunctionRemote Function
Deletes file using the file ID.
Parameters
- fileId string - ID of the file to delete
copyFile
Isolated FunctionRemote Function
function copyFile(string fileId, string? destinationFolderId, string? newFileName) returns File|errorCopies 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
moveFile
Isolated FunctionRemote Function
Moves file using the file ID.
Parameters
- fileId string - ID of the file to be moved
- destinationFolderId string - Folder ID of the destination
renameFile
Isolated FunctionRemote Function
Renames a file.
Parameters
- fileId string - File ID that need to be renamed
- newFileName string - New file name that should be renamed to
updateFileMetadataById
Isolated FunctionRemote Function
function updateFileMetadataById(string fileId, FileMetadata? fileMetadata, UpdateFileMetadataOptional? optional) returns File|errorUpdates 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 UpdateFileMetadataOptional? (default ()) - 'UpdateFileMetadataOptional' used to add query parameters to the request
createFile
Isolated FunctionRemote Function
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
createFolder
Isolated FunctionRemote Function
Creates new folder.
Parameters
- folderName string - Name of the new folder to be created
- parentFolderId string? (default ()) - ID of the parent folder
uploadFile
Isolated FunctionRemote Function
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
uploadFileUsingByteArray
Isolated FunctionRemote Function
function uploadFileUsingByteArray(byte[] byteArray, string fileName, string? parentFolderId) returns File|errorUploads 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
getStartPageToken
Isolated FunctionRemote Function
Gets the starting pageToken for listing future changes.
listChanges
Isolated FunctionRemote Function
function listChanges(string pageToken, ListChangesOptional? optional) returns stream<Change>|errorLists the changes for a user or a shared drive.
Parameters
- pageToken string - The token returned from the previous request
- optional ListChangesOptional? (default ()) - A
ListChangesOptionalrecord used to add query parameters to the request
Constants
googleapis.drive: 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
Always set chunking header in the response.
googleapis.drive: CHUNKING_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
Never set the chunking header even if the payload is larger than 8KB in the outbound request/response.
googleapis.drive: COMPRESSION_ALWAYS
Always set accept-encoding/content-encoding in outbound request/response.
googleapis.drive: COMPRESSION_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
Never set accept-encoding/content-encoding header in outbound request/response.
googleapis.drive: KEEPALIVE_ALWAYS
Keeps the connection alive irrespective of the connection header value }
googleapis.drive: KEEPALIVE_AUTO
Decides to keep the connection alive or not based on the connection header of the client request }
googleapis.drive: KEEPALIVE_NEVER
Closes the connection irrespective of the connection header value }
googleapis.drive: REFRESH_URL
googleapis.drive: RFC_7234
Caching behaviour is as specified by the RFC 7234 specification.
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
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
- maxImportSizes? StringKeyValuePairs - A map of maximum import sizes by MIME type, in bytes
- 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
- driveThemes? StringKeyValuePairs - A list of themes that are supported for shared drives
- 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.
- 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 thecache-controlheader and either theetagorlast-modifiedheader 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
- 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: Change
A change to a file or shared drive.
Fields
- changeType? string - The type of the change. Possible values are file and drive.
- drive? Drive - Drive the file or shared drive belongs to.
- driveId? string - The ID of the shared drive associated with this change.
- file? File - The file which has changed. This will only be populated if the file is still accessible to the user.
- fileId? string - The ID of the file which has changed.
- kind string(default "drive#change") - Identifies what kind of resource this is. Value: the fixed string "drive#change".
- removed? boolean - Whether the file or shared drive has been removed from this list of changes, for example by deletion or loss of access.
- time? string - The time of this change (RFC 3339 date-time).
googleapis.drive: ChangeList
A list of changes for a user.
Fields
- changes Change[] - The list of changes. If nextPageToken is populated, then this list may be incomplete and an additional page of results should be fetched.
- kind string(default "drive#changeList") - Identifies what kind of resource this is. Value: the fixed string "drive#changeList".
- newStartPageToken? string - The starting page token for future changes. This will be present only if the end of the current changes list has been reached.
- nextPageToken? string - The page token for the next page of changes. This will be absent if the end of the changes 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.
googleapis.drive: CircuitBreakerConfig
Closed record
Provides a set of configurations for controlling the behaviour of the Circuit Breaker.
Fields
- rollingWindow RollingWindow(default {}) - The
http:RollingWindowoptions of theCircuitBreaker
- 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
- proxy? ProxyConfig - Proxy server related options
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:TrustStoreor single certificate file that the client trusts
- 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
- handshakeTimeout? decimal - SSL handshake time out
- sessionTimeout? decimal - SSL session time out
googleapis.drive: ConnectionConfig
Closed record
Client configuration details.
Fields
- Fields Included from *ConnectionConfig
- auth AuthConfig
- httpVersion HttpVersion
- http1Settings ClientHttp1Settings
- http2Settings ClientHttp2Settings
- timeout decimal
- forwarded string
- poolConfig PoolConfiguration
- cache CacheConfig
- compression Compression
- circuitBreaker CircuitBreakerConfig
- retryConfig RetryConfig
- responseLimits ResponseLimitConfigs
- secureSocket ClientSecureSocket
- proxy ProxyConfig
- validation boolean
- anydata...
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- 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
- 'type string -
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: Drive
Representation of a shared drive.
Fields
- backgroundImageFile? DriveBackgroundImageFile - Drive background image file details.
- backgroundImageLink? string - A short-lived link to this shared drive's background image.
- capabilities? DriveCapabilities - Capabilities the current user has on this shared drive.
- colorRgb? string - The color of this shared drive as an RGB hex string. It can only be set on drive.drives.update requests that don't set themeId.
- createdTime? string - The time at which the shared drive was created (RFC 3339 date-time).
- id? string - The ID of this shared drive which is also the ID of the top level folder of this shared drive.
- kind string(default "drive#drive") - Identifies what kind of resource this is. Value: the fixed string "drive#drive".
- name? string - The name of this shared drive.
- orgUnitId? string - The organizational unit of this shared drive. This field is only populated on drives.list responses when the useDomainAdminAccess parameter is set to true.
- restrictions? DriveRestrictions - Restrictions for accessing the content of the shared drive. This field is only populated on drives.get responses.
- themeId? string - The ID of the theme from which the background image and color are set. The set of possible driveThemes can be retrieved from a drive.about.get response. When not specified on a drive.drives.create request, a random theme is chosen from which the background image and color are set. This is a write-only field; it can only be set on requests that don't set colorRgb or backgroundImageFile.
googleapis.drive: DriveBackgroundImageFile
An image file and cropping parameters from which a background image for this shared drive is set. This is a write-only field; it can only be set on drive.drives.update requests that don't set themeId. When specified, all fields of the backgroundImageFile must be set.
Fields
- id? string - The ID of an image file in Google Drive to use for the background image.
- width? float - The width of the cropped image in the closed range of 0 to 1. This value represents the width of the cropped image divided by the width of the entire image. The height is computed by applying a width to height aspect ratio of 80 to 9. The resulting image must be at least 1280 pixels wide and 144 pixels high.
- xCoordinate? float - The X coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the horizontal distance from the left side of the entire image to the left side of the cropping area divided by the width of the entire image.
- yCoordinate? float - The Y coordinate of the upper left corner of the cropping area in the background image. This is a value in the closed range of 0 to 1. This value represents the vertical distance from the top side of the entire image to the top side of the cropping area divided by the height of the entire image.
googleapis.drive: DriveCapabilities
Capabilities the current user has on this shared drive.
Fields
- canAddChildren? boolean - Whether the current user can add children to folders in this shared drive.
- canChangeCopyRequiresWriterPermissionRestriction? boolean - Whether the current user can change the copyRequiresWriterPermission restriction of this shared drive.
- canChangeDomainUsersOnlyRestriction? boolean - Whether the current user can change the domainUsersOnly restriction of this shared drive.
- canChangeDriveBackground? boolean - Whether the current user can change the background of this shared drive.
- canChangeDriveMembersOnlyRestriction? boolean - Whether the current user can change the driveMembersOnly restriction of this shared drive.
- canChangeSharingFoldersRequiresOrganizerPermissionRestriction? boolean - Whether the current user can change the sharingFoldersRequiresOrganizerPermission restriction of this shared drive.
- canComment? boolean - Whether the current user can comment on files in this shared drive.
- canCopy? boolean - Whether the current user can copy files in this shared drive.
- canDeleteChildren? boolean - Whether the current user can delete children from folders in this shared drive.
- canDeleteDrive? boolean - Whether the current user can delete this shared drive. Attempting to delete the shared drive may still fail if there are untrashed items inside the shared drive.
- canDownload? boolean - Whether the current user can download files in this shared drive.
- canEdit? boolean - Whether the current user can edit files in this shared drive
- canListChildren? boolean - Whether the current user can list the children of folders in this shared drive.
- canManageMembers? boolean - Whether the current user can add members to this shared drive or remove them or change their role.
- canReadRevisions? boolean - Whether the current user can read the revisions resource of files in this shared drive.
- canRename? boolean - Whether the current user can rename files or folders in this shared drive.
- canRenameDrive? boolean - Whether the current user can rename this shared drive.
- canResetDriveRestrictions? boolean - Whether the current user can reset the shared drive restrictions to defaults.
- canTrashChildren? boolean - Whether the current user can trash children from folders in this shared drive.
googleapis.drive: DriveRestrictions
A set of restrictions that apply to this shared drive or items inside this shared drive.
Fields
- adminManagedRestrictions? boolean - Whether administrative privileges on this shared drive are required to modify restrictions.
- copyRequiresWriterPermission? boolean - Whether the options to copy, print, or download files inside this shared drive, should be disabled for readers and commenters. When this restriction is set to true, it will override the similarly named field to true for any file inside this shared drive.
- domainUsersOnly? boolean - Whether access to this shared drive and items inside this shared drive is restricted to users of the domain to which this shared drive belongs. This restriction may be overridden by other sharing policies controlled outside of this shared drive.
- driveMembersOnly? boolean - Whether access to items inside this shared drive is restricted to its members.
googleapis.drive: File
Represents File.
Fields
- Fields Included from *FileMetadata
- name string
- mimeType string
- description string
- starred boolean
- trashed boolean
- folderColorRgb string
- appProperties StringKeyValuePairs
- contentHints ContentHints
- copyRequiresWriterPermission boolean
- modifiedTime string
- originalFilename string
- properties StringKeyValuePairs
- viewedByMeTime string
- writersCanShare boolean
- anydata...
- Fields Included from *GeneratedFileMetadata
- id string
- kind string
- explicitlyTrashed boolean
- trashingUser User
- trashedTime string
- parents string[]
- spaces string[]
- version int
- webContentLink string
- webViewLink string
- iconLink string
- hasThumbnail boolean
- thumbnailLink string
- thumbnailVersion int
- viewedByMe boolean
- modifiedByMe boolean
- createdTime string
- modifiedByMeTime string
- sharedWithMeTime string
- sharingUser User
- owners User[]
- driveId string
- lastModifyingUser User
- shared boolean
- ownedByMe boolean
- capabilities Capabilities
- permissions Permissions[]
- permissionIds string[]
- hasAugmentedPermissions boolean
- fullFileExtension string
- fileExtension string
- md5Checksum string
- size int
- quotaBytesUsed int
- headRevisionId string
- imageMediaMetadata ImageMediaMetadata
- videoMediaMetadata VideoMediaMetadata
- isAppAuthorized boolean
- exportLinks StringKeyValuePairs
- shortcutDetails ShortcutDetails
- contentRestrictions ContentRestrictions
- anydata...
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 Driveroot folder, and theApplication Datafolder
- 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
Aboutresource
- 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)
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 -
- webContentLink? string - A link for downloading the content of the file in a browser. This is only available for files with binary content in Google Drive
- webViewLink? string - A link for opening the file in a relevant Google editor or viewer in a browser
- iconLink? string - A static, unauthenticated link to the file's icon
- 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
- thumbnailLink? string - A short-lived link to the file's thumbnail, if available. Typically lasts on the order of hours. Only populated when the requesting app can access the file's content. If the file isn't shared publicly, the URL returned in Files.thumbnailLink must be fetched using a credentialed request
- 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)
- 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
- 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
- exportLinks? StringKeyValuePairs - Links for exporting Docs Editors files to specific formats
- 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: GetFileOptional
Optional query parameters in get files.
Fields
- acknowledgeAbuse? boolean - Whether the user is acknowledging the risk of downloading known malware or other abusive files. This is only applicable when alt=media. (Default: false)
- fields? string - The paths of the fields you want included in the response. If not specified, the response includes a default set of fields specific to this method. For development you can use the special value * to return all fields, but you'll achieve greater performance by only selecting the fields you need
- alt? string - If you provide the URL parameter alt=media, then the response includes the file contents in the response body
- includePermissionsForView? string - Specifies which additional view's permissions to include in the response. Only 'published' is supported
- supportsAllDrives boolean?(default true) - Whether the requesting application supports both My Drives and shared drives. (Default: false)
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: ListChangesOptional
Description.
Fields
- pageSize? int - field description
- includeItemsFromAllDrives? boolean - field description
- includeRemoved? boolean - field description
- includeCorpusRemovals? boolean - field description
- restrictToMyDrive? boolean - field description
- driveId? string - field description
- fields? string - field description
- supportsAllDrives? boolean - field description
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_infield
- clockSkew decimal(default 0) - Clock skew (in seconds) that can be used to avoid token validation failures due to clock synchronization problems
- 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
- 'type string -
- 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
- photoLink string - A link to the user's profile photo, if available
- 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 aClientError
- 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 aClientError
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
RollingWindowthat 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
- float... - Rest field
googleapis.drive: StringArrayValuePairs
Record Type to accept string[] values.
Fields
- string[]... - Rest field
googleapis.drive: StringKeyValuePairs
Record Type to accpet string values.
Fields
- string... - Rest field
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: UpdateFileMetadataOptional
Update file optional parameters.
Fields
- addParents? string - A comma-separated list of parent IDs to add
- includePermissionsForView? string - Specifies which additional view's permissions to include in the response. Only 'published' is supported
- keepRevisionForever? boolean - Whether to set the 'keepForever' field in the new head revision. This is only applicable to files with binary content in Google Drive. Only 200 revisions for the file can be kept forever. If the limit is reached, try deleting pinned revisions. (Default: false)
- ocrLanguage? string - A language hint for OCR processing during image import (ISO 639-1 code)
- removeParents? string - A comma-separated list of parent IDs to remove
- supportsAllDrives? boolean - Whether the requesting application supports both My Drives and shared drives. (Default: false)
- useContentAsIndexableText? boolean - Whether to use the uploaded content as indexable text. (Default: false)
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
- photoLink? string - A link to the user's profile photo, if available
- 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
Union types
googleapis.drive: KeepAlive
KeepAlive
Defines the possible values for the keep-alive configuration in service and client endpoints.
googleapis.drive: Chunking
Chunking
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: CachingPolicy
CachingPolicy
Used for configuring the caching behaviour. Setting the policy field in the CacheConfig record allows
the user to control the caching behaviour.
googleapis.drive: Compression
Compression
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