Skip to content

GoogledriveClient

Classes

BlobMetadata dataclass 

BlobMetadata(id: Optional[str] = None, name: Optional[str] = None, display_name: Optional[str] = None, path: Optional[str] = None, folder_id: Optional[str] = None, folder_path: Optional[str] = None, last_modified: Optional[str] = None, size: Optional[int] = None, media_type: Optional[str] = None, is_folder: Optional[bool] = None, e_tag: Optional[str] = None, file_locator: Optional[str] = None, last_modified_by: Optional[str] = None)

Response for Get file metadata using id

Attributes

id class-attribute instance-attribute 
id: Optional[str] = field(default=None, metadata={'wire_name': 'Id'})

The unique id of the file or folder.

name class-attribute instance-attribute 
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name of the file or folder.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the file or folder.

path class-attribute instance-attribute 
path: Optional[str] = field(default=None, metadata={'wire_name': 'Path'})

The path of the file or folder.

folder_id class-attribute instance-attribute 
folder_id: Optional[str] = field(default=None, metadata={'wire_name': 'FolderId'})

The unique id of the parent folder of the file or folder.

folder_path class-attribute instance-attribute 
folder_path: Optional[str] = field(default=None, metadata={'wire_name': 'FolderPath'})

The current path of the parent folder of the file or folder.

last_modified class-attribute instance-attribute 
last_modified: Optional[str] = field(default=None, metadata={'wire_name': 'LastModified'})

The date and time the file or folder was last modified.

size class-attribute instance-attribute 
size: Optional[int] = field(default=None, metadata={'wire_name': 'Size'})

The size of the file or folder.

media_type class-attribute instance-attribute 
media_type: Optional[str] = field(default=None, metadata={'wire_name': 'MediaType'})

The media type of the file or folder.

is_folder class-attribute instance-attribute 
is_folder: Optional[bool] = field(default=None, metadata={'wire_name': 'IsFolder'})

A boolean value (true, false) to indicate whether or not the blob is a folder.

e_tag class-attribute instance-attribute 
e_tag: Optional[str] = field(default=None, metadata={'wire_name': 'ETag'})

The etag of the file or folder.

file_locator class-attribute instance-attribute 
file_locator: Optional[str] = field(default=None, metadata={'wire_name': 'FileLocator'})

The filelocator of the file or folder.

last_modified_by class-attribute instance-attribute 
last_modified_by: Optional[str] = field(default=None, metadata={'wire_name': 'LastModifiedBy'})

The user who last modified the file or folder.

DataSetsMetadata dataclass 

DataSetsMetadata(tabular: Optional[TabularDataSetsMetadata] = None, blob: Optional[BlobDataSetsMetadata] = None)

Definition: DataSetsMetadata

TabularDataSetsMetadata dataclass 

TabularDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None, table_display_name: Optional[str] = None, table_plural_name: Optional[str] = None)

Definition: TabularDataSetsMetadata

Attributes

source class-attribute instance-attribute 
source: Optional[str] = None

Dataset source

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Dataset display name

url_encoding class-attribute instance-attribute 
url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Dataset url encoding

table_display_name class-attribute instance-attribute 
table_display_name: Optional[str] = field(default=None, metadata={'wire_name': 'tableDisplayName'})

Table display name

table_plural_name class-attribute instance-attribute 
table_plural_name: Optional[str] = field(default=None, metadata={'wire_name': 'tablePluralName'})

Table plural display name

BlobDataSetsMetadata dataclass 

BlobDataSetsMetadata(source: Optional[str] = None, display_name: Optional[str] = None, url_encoding: Optional[str] = None)

Definition: BlobDataSetsMetadata

Attributes

source class-attribute instance-attribute 
source: Optional[str] = None

Blob dataset source

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'displayName'})

Blob dataset display name

url_encoding class-attribute instance-attribute 
url_encoding: Optional[str] = field(default=None, metadata={'wire_name': 'urlEncoding'})

Blob dataset url encoding

ObjectEntity dataclass 

ObjectEntity(additional_properties: Dict[str, Any] = dict())

Definition: Object

Attributes

additional_properties class-attribute instance-attribute 
additional_properties: Dict[str, Any] = field(default_factory=dict)

Dynamic properties determined at runtime (similar to .NET [JsonExtensionData])

TableMetadata dataclass 

TableMetadata(name: Optional[str] = None, title: Optional[str] = None, x_ms_permission: Optional[str] = None, x_ms_capabilities: Optional[TableCapabilitiesMetadata] = None, schema: Optional[ObjectEntity] = None, referenced_entities: Optional[ObjectEntity] = None, web_url: Optional[str] = None)

Definition: TableMetadata

Attributes

name class-attribute instance-attribute 
name: Optional[str] = None

Table name

title class-attribute instance-attribute 
title: Optional[str] = None

Table title

x_ms_permission class-attribute instance-attribute 
x_ms_permission: Optional[str] = field(default=None, metadata={'wire_name': 'x-ms-permission'})

Table permission

web_url class-attribute instance-attribute 
web_url: Optional[str] = field(default=None, metadata={'wire_name': 'webUrl'})

Url link

TableCapabilitiesMetadata dataclass 

TableCapabilitiesMetadata(sort_restrictions: Optional[TableSortRestrictionsMetadata] = None, filter_restrictions: Optional[TableFilterRestrictionsMetadata] = None, select_restrictions: Optional[TableSelectRestrictionsMetadata] = None, is_only_server_pagable: Optional[bool] = None, filter_function_support: Optional[List[str]] = None, server_paging_options: Optional[List[str]] = None)

Definition: TableCapabilitiesMetadata

Attributes

is_only_server_pagable class-attribute instance-attribute 
is_only_server_pagable: Optional[bool] = field(default=None, metadata={'wire_name': 'isOnlyServerPagable'})

Server paging restrictions

filter_function_support class-attribute instance-attribute 
filter_function_support: Optional[List[str]] = field(default=None, metadata={'wire_name': 'filterFunctionSupport'})

List of supported filter capabilities

server_paging_options class-attribute instance-attribute 
server_paging_options: Optional[List[str]] = field(default=None, metadata={'wire_name': 'serverPagingOptions'})

List of supported server-driven paging capabilities

TableSortRestrictionsMetadata dataclass 

TableSortRestrictionsMetadata(sortable: Optional[bool] = None, unsortable_properties: Optional[List[str]] = None, ascending_only_properties: Optional[List[str]] = None)

Definition: TableSortRestrictionsMetadata

Attributes

sortable class-attribute instance-attribute 
sortable: Optional[bool] = None

Indicates whether this table has sortable columns

unsortable_properties class-attribute instance-attribute 
unsortable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'unsortableProperties'})

List of unsortable properties

ascending_only_properties class-attribute instance-attribute 
ascending_only_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'ascendingOnlyProperties'})

List of properties which support ascending order only

TableFilterRestrictionsMetadata dataclass 

TableFilterRestrictionsMetadata(filterable: Optional[bool] = None, non_filterable_properties: Optional[List[str]] = None, required_properties: Optional[List[str]] = None)

Definition: TableFilterRestrictionsMetadata

Attributes

filterable class-attribute instance-attribute 
filterable: Optional[bool] = None

Indicates whether this table has filterable columns

non_filterable_properties class-attribute instance-attribute 
non_filterable_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'nonFilterableProperties'})

List of non filterable properties

required_properties class-attribute instance-attribute 
required_properties: Optional[List[str]] = field(default=None, metadata={'wire_name': 'requiredProperties'})

List of required properties

TableSelectRestrictionsMetadata dataclass 

TableSelectRestrictionsMetadata(selectable: Optional[bool] = None)

Definition: TableSelectRestrictionsMetadata

Attributes

selectable class-attribute instance-attribute 
selectable: Optional[bool] = None

Indicates whether this table has selectable columns

TablesList dataclass 

TablesList(value: Optional[List[Table]] = None)

Definition: TablesList

Attributes

value class-attribute instance-attribute 
value: Optional[List[Table]] = None

List of Tables

Table dataclass 

Table(name: Optional[str] = None, display_name: Optional[str] = None, dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: Table

Attributes

name class-attribute instance-attribute 
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

The name of the table. The name is used at runtime.

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

The display name of the table.

dynamic_properties class-attribute instance-attribute 
dynamic_properties: Optional[Dict[str, Any]] = field(default=None, metadata={'wire_name': 'DynamicProperties'})

Additional table properties provided by the connector to the clients.

Item dataclass 

Item(dynamic_properties: Optional[Dict[str, Any]] = None)

Definition: Item

ItemsList dataclass 

ItemsList(value: Optional[List[Item]] = None)

Definition: ItemsList

Attributes

value class-attribute instance-attribute 
value: Optional[List[Item]] = None

List of Items

DataSetsList dataclass 

DataSetsList(value: Optional[List[DataSet]] = None)

Definition: DataSetsList

Attributes

value class-attribute instance-attribute 
value: Optional[List[DataSet]] = None

List of datasets

DataSet dataclass 

DataSet(name: Optional[str] = None, display_name: Optional[str] = None, query: Optional[List[PassThroughNativeQuery]] = None)

Definition: DataSet

Attributes

name class-attribute instance-attribute 
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Dataset name

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Dataset display name

query class-attribute instance-attribute 
query: Optional[List[PassThroughNativeQuery]] = None

Pass-through Native Queries

Procedure dataclass 

Procedure(name: Optional[str] = None, display_name: Optional[str] = None)

Definition: Procedure

Attributes

name class-attribute instance-attribute 
name: Optional[str] = field(default=None, metadata={'wire_name': 'Name'})

Procedure name

display_name class-attribute instance-attribute 
display_name: Optional[str] = field(default=None, metadata={'wire_name': 'DisplayName'})

Procedure display name

PassThroughNativeQuery dataclass 

PassThroughNativeQuery(language: Optional[str] = None)

Definition: PassThroughNativeQuery

Attributes

language class-attribute instance-attribute 
language: Optional[str] = field(default=None, metadata={'wire_name': 'Language'})

Query language

GoogledriveClient 

GoogledriveClient(connection_runtime_url: str, token_provider: Optional[TokenProvider] = None, options: Optional[ConnectorClientOptions] = None)

Bases: ConnectorClientBase

Typed client for googledrive connector.

Initialize a GoogledriveClient.

Parameters:

Name Type Description Default
connection_runtime_url str

The connection runtime URL from Azure Portal.

 required
token_provider Optional[TokenProvider]

Optional token provider. Defaults to ManagedIdentityTokenProvider.

 None
options Optional[ConnectorClientOptions]

Optional connector client options.

 None

Methods:

get_file_metadata_async async 
get_file_metadata_async(id: str) -> dict[str, Any] | None

Get file metadata using id

Retrieves file metadata from Google Drive using id

update_file_async async 
update_file_async(input: bytes, id: str) -> dict[str, Any] | None

Update file

Updates a file in Google Drive

delete_file_async async 
delete_file_async(id: str) -> None

Delete file

Deletes a file from Google Drive

get_file_metadata_by_path_async async 
get_file_metadata_by_path_async(path: str) -> dict[str, Any] | None

Get file metadata using path

Retrieves file metadata from Google Drive using path

get_file_content_by_path_async async 
get_file_content_by_path_async(path: str, infer_content_type: Optional[bool] = None) -> bytes

Get file content using path

Retrieves file content from Google Drive using path

get_file_content_async async 
get_file_content_async(id: str, infer_content_type: Optional[bool] = None) -> bytes

Get file content using id

Retrieves file content from Google Drive using id

copy_file_async async 
copy_file_async(source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Copy file

Copies a file on Google Drive

list_folder_async async 
list_folder_async(id: str) -> dict[str, Any] | None

List files in folder

List files in a Google Drive folder

list_root_folder_async async 
list_root_folder_async() -> dict[str, Any] | None

List files in root folder

Lists files in the Google Drive root folder

create_file_async async 
create_file_async(input: bytes, folder_id: str, name: str) -> dict[str, Any] | None

Create file

Uploads a file to a Google Drive folder selected by its identifier

extract_folder_async async 
extract_folder_async(source: str, destination: str, overwrite: Optional[bool] = None) -> dict[str, Any] | None

Extract archive to folder

Extracts an archive file into a folder in Google Drive (example: .zip)