GoogleDrive Class

Properties   Methods   Events   Config Settings   Errors  

The GoogleDrive class makes it easy to upload, download, and manage files and folders within Google Drive.

Syntax

class cloudstorage.GoogleDrive

Remarks

The GoogleDrive class provides an easy-to-use interface for Google Drive. Capabilities include uploading and downloading files, file and folder manipulation and organization, Google Shared Drive support, strong client-side file encryption functionality, and more.

Authentication

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property to set the appropriate fields for the chosen o_auth_client_profile and o_auth_grant_type.

The class has the following defaults:

Below is a brief description of the different o_auth_client_profile and o_auth_grant_type values that are supported by this class. For a more in-depth description of what needs to be set, refer to the service documentation.

Application Profile

This profile encompasses the most basic grant types that OAuth supports. When this profile is set, all the requests and response handling is done by the class. Depending on the grant type, this may involve launching a browser so a user can login to authenticate with a authorization server. It may also involve starting an embedded web server to receive a response from a redirect.

To start the authentication and authorization process, the authorize method should be called. If the authorization and authentication was successful, then the o_auth_access_token property will be populated. Additionally, if a refresh token was provided the o_auth_refresh_token property will be populated as well. These values of the fields are for informational purposes. The class will also cache these tokens along with when the o_auth_access_token will be expired. When a method that makes requests to the service provider is called or the authorize method is called the class will automatically check to see if the access token is expired. If it is, it will then automatically try to get a new o_auth_access_token. If the authorize method was not used and user interaction would be required, the class will throw an error which can be caught. When user interaction is needed depends on what grant type is set in the o_auth_grant_type property. To force the component to only check the access token when the authorize method is called, the OAuthAutomaticRefresh configuration setting can be set to false.

A brief description of the supported values for the o_auth_grant_type property are below. For more information, see the service documentation.

Authorization Code

When using the Authorization Code grant type, the class will use an authorization code to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, and o_auth_server_token_url to be set. When the authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the authorization code, setting the o_auth_authorization_code property, from the redirect. Immediately, the class will make a request to the token server to exchange the authorization code for an access token. The token server will return an access token and possibly a refresh token. If the o_auth_refresh_token property is set, or a refresh token is cached, then the class will not launch the browser and use the refresh token in its request to the token server instead of an authorization code.

Example: GoogleDrive googledrive = new GoogleDrive(); googledrive.OAuth.ClientProfile = CloudOAuthClientProfiles.cocpApplication; googledrive.OAuth.GrantType = OAuthSettingsGrantTypes.cogtAuthorizationCode; googledrive.OAuth.ClientId = CLIENT_ID; googledrive.OAuth.ClientSecret = CLIENT_SECRET; googledrive.Authorize();

Implicit

Note: This grant type is considered insecure and should only be used when necessary.

When using the Implicit grant type, the class will request the authorization server to get an access token. For this o_auth_grant_type the class expects a o_auth_client_id, o_auth_client_secret, and o_auth_server_auth_url to be set. When the authorize method is called, the component will start the embedded web server and launch the browser so the user can authorize the application. Once the user authorizes, the service provider will redirect them to the embedded web server and the class will parse the access token from the redirect.

A disadvantage of the grant type is that can not use a refresh token to silently get a new access token. Most service providers offer a way to silently get a new access token. See the service documentation for specifics. This means the class will not be able to automatically get a fresh token once it expires.

Web Profile

This profile is similar to setting the class to the Application profile and Authorization Code grant type except the class will not launch the browser. It is typically used in situations where there is a back-end that is supporting some front end. This profile expects that o_auth_client_id, o_auth_client_secret, o_auth_server_auth_url, o_auth_server_token_url, and the o_auth_return_url properties to be set. Before calling the authorize method, the o_auth_web_auth_url property should be queried to get a URL. This URL should be used to redirect the user to the authorization page for the service provider. The redirect_uri parameter of this URL is mapped to the o_auth_return_url property. The o_auth_return_url property should be set to some web server that will parse the authorization code out of the query parameter from the redirect. Once the authorization code is parsed, it should be passed back to the server where it is then set to the o_auth_authorization_code property. Once that is set, the authorize method can be called to exchange the authorization code for an access token and refresh token if provided. The class will then cache these values like normal and use them to make requests. If the o_auth_refresh_token field is set, or a refresh token is cached, then the authorize method can immediately be called to make a request to the token server to get a new access token.

External OAuth Support

For complex profiles or grant types, or for more control of the flow, it is possible to perform OAuth authentication using the OAuth class or a separate process. Once complete you should have an authorization string which looks like:

Bearer ACCESS_TOKEN_VALUE

Assign this value to the authorization property before attempting any operations. Setting the authorization property will cause the class to ignore the values set in the o_auth property.

For Example: Oauth oauth = new Oauth(); oauth.ClientId = "CLIENT_ID"; oauth.ClientSecret = "CLIENT_SECRET"; oauth.AuthorizationScope = "https://www.googleapis.com/auth/gmail.readonly"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://www.googleapis.com/auth/drive"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; googledrive.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Listing Resources

The list_resources method is used to list resources within the scope specified by the list_resources_scope property.

The list_children, list_parents, and get_resource_info methods are also available for finer-grained control. // ResourceList event handler. googledrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // List all of the current user's resources. googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker)); // List all of the resources in the specified shared drive. googledrive.SharedDrive = "wfsr789vusijfv"; googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker));

Downloading Files

The download_file method is used to download files.

Download Notes

Downloading an Encrypted File

To decrypt an encrypted file set encryption_algorithm and encryption_password before calling this method. googledrive.LocalFile = "../MyFile.zip"; googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Downloads

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; googledrive.LocalFile = downloadFile; googledrive.DownloadFile(googledrive.Resources[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file googledrive.StartByte = new FileInfo(downloadFile).Length; googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. googledrive.LocalFile = "../MyFile.zip"; googledrive.EncryptionPassword = "password"; googledrive.DownloadFile(googledrive.Resource[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length; googledrive.DownloadFile(googledrive.Resource[0].Id, "");

Uploading Files

The upload_file method is used to upload files.

Upload Notes

Google Drive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set use_resumable_upload to True. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. resume_url is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the on_fragment_complete event fires after each fragment is uploaded to indicate overall progress. The class also updates start_byte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that resume_url and start_byte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call upload_file again to resume the upload at the specified start_byte offset.

Note that if the upload is not resumed after some time the upload session will expire. get_upload_status may be used to check the status of a resumable upload. googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. googledrive.UploadFile("MyFile.zip", "");

Shared Drive Support

The GoogleDrive class has full support for Google Shared Drives. For the most common use-cases (such as those described above), there is very little difference when using a shared drive versus a personal Google Drive ("My Drive").

For more information about how to use the class with Google Shared Drives, refer to both the shared-drive-specific documentation sections for commonly-used methods like list_resources, move_resource, update_permissions, etc.; and browse through the documentation for shared-drive-specific methods and properties such as the add_shared_drive_member and list_shared_drives methods, the shared_drive property, etc.

Additional Functionality

The GoogleDrive class offers advanced functionality beyond simple uploads and downloads. For instance:

• Encrypt and decrypt files using the encryption_algorithm and encryption_password properties.
• Basic file and folder manipulation and organization using methods such as copy_resource, create_folder, delete_resource, move_resource, and update_resource.
• Enumeration and manipulation of parent-child relationships using the add_parents, list_children, list_parents, and remove_parents methods.
• Resourcing trashing and deletion: delete_resource, trash_resource, restore_resource.
• Control over permissions using list_permissions and update_permissions.
• Change tracking with list_changes.
• And more!

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

account_can_create_shared_drives Property

Whether the account has permission to create shared drives.

Syntax

def get_account_can_create_shared_drives() -> bool: ...

account_can_create_shared_drives = property(get_account_can_create_shared_drives, None)

Default Value

FALSE

Remarks

Whether the account has permission to create shared drives.

This property reflects whether the account has the permissions necessary to create shared drives.

This property is read-only.

account_drive_usage Property

Amount of storage used in Google Drive.

Syntax

def get_account_drive_usage() -> int: ...

account_drive_usage = property(get_account_drive_usage, None)

Default Value

-1

Remarks

Amount of storage used in Google Drive.

This property reflects the storage usage, in bytes, for all items in the account's Google Drive (including trashed items).

This property is read-only.

account_email Property

The email address of the account.

Syntax

def get_account_email() -> str: ...

account_email = property(get_account_email, None)

Default Value

""

Remarks

The email address of the account.

This property reflects the email address associated with the account.

This property is read-only.

account_name Property

The name of the account's user.

Syntax

def get_account_name() -> str: ...

account_name = property(get_account_name, None)

Default Value

""

Remarks

The name of the account's user.

This property reflects the name of the account's user.

This property is read-only.

account_permission_id Property

The permission Id associated with the account.

Syntax

def get_account_permission_id() -> str: ...

account_permission_id = property(get_account_permission_id, None)

Default Value

""

Remarks

The permission Id associated with the account.

This property reflects the permission Id associated with the account. Any permissions (including shared drive memberships) created for this account will include this Id.

This property is read-only.

account_storage_quota Property

The account's storage quota.

Syntax

def get_account_storage_quota() -> int: ...

account_storage_quota = property(get_account_storage_quota, None)

Default Value

-1

Remarks

The account's storage quota.

This property reflects the account's storage quota, in bytes, across all Google services (Google Drive, Gmail, etc.).

A value of -1 indicates that the account does not have a storage quota (i.e., it has unlimited storage).

This property is read-only.

account_storage_usage Property

Amount of storage used across all Google services.

Syntax

def get_account_storage_usage() -> int: ...

account_storage_usage = property(get_account_storage_usage, None)

Default Value

-1

Remarks

Amount of storage used across all Google services.

This property reflects the account's total storage usage, in bytes, across all Google services (Google Drive, Gmail, etc.).

This property is read-only.

account_trash_usage Property

Amount of storage used by trashed items in Google Drive.

Syntax

def get_account_trash_usage() -> int: ...

account_trash_usage = property(get_account_trash_usage, None)

Default Value

-1

Remarks

Amount of storage used by trashed items in Google Drive.

This property reflects the storage usage, in bytes, for all trashed items in the account's Google Drive.

This property is read-only.

authorization Property

OAuth 2.0 Authorization Token.

Syntax

def get_authorization() -> str: ...
def set_authorization(value: str) -> None: ...

authorization = property(get_authorization, set_authorization)

Default Value

""

Remarks

This class supports authentication via OAuth 2.0. First, perform OAuth authentication using the o_auth property, using the OAuth class or a separate process. If using the o_auth property, then the authorization property will not be used.

Bearer ACCESS_TOKEN

Assign this value to the authorization property before attempting any operations. Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

change_marker Property

A marker indicating what page of changes to return next.

Syntax

def get_change_marker() -> str: ...
def set_change_marker(value: str) -> None: ...

change_marker = property(get_change_marker, set_change_marker)

Default Value

""

Remarks

This property will be populated when list_changes is called if the results are paged and there are more pages. To list all changes, continue to call list_changes until this property returns empty string.

Setting change_marker will cause next_change_marker to be set to empty string.

Refer to list_changes for more information.

change_count Property

The number of records in the Change arrays.

Syntax

def get_change_count() -> int: ...

change_count = property(get_change_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• change_removed
• change_resource_id
• change_shared_drive_id
• change_time
• change_type

The array indices start at 0 and end at change_count - 1.

This property is read-only.

change_removed Property

Whether the file or shared drive has been removed.

Syntax

def get_change_removed(change_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the file or shared drive has been removed.

This property indicates whether the file or shared drive to which the change applies has been removed.

The change_index parameter specifies the index of the item in the array. The size of the array is controlled by the change_count property.

This property is read-only.

change_resource_id Property

The Id of the file to which the change applies.

Syntax

def get_change_resource_id(change_index: int) -> str: ...

Default Value

""

Remarks

The Id of the file to which the change applies.

This property holds the Id of the file to which the change applies.

The change_index parameter specifies the index of the item in the array. The size of the array is controlled by the change_count property.

This property is read-only.

change_shared_drive_id Property

The Id of the shared drive.

Syntax

def get_change_shared_drive_id(change_index: int) -> str: ...

Default Value

""

Remarks

The Id of the shared drive.

This property holds the Id of the shared drive to which the change applies (if change_type is ctSharedDrive (1)), or which owns the file to which the change applies (if change_type is ctFile (0)).

The change_index parameter specifies the index of the item in the array. The size of the array is controlled by the change_count property.

This property is read-only.

change_time Property

The time of the change.

Syntax

def get_change_time(change_index: int) -> str: ...

Default Value

""

Remarks

The time of the change.

This property holds the time of the change. This is a combined date-time value (formatted according to RFC 3339).

The change_index parameter specifies the index of the item in the array. The size of the array is controlled by the change_count property.

This property is read-only.

change_type Property

Whether the change is for a file or a shared drive.

Syntax

def get_change_type(change_index: int) -> int: ...

Default Value

0

Remarks

Whether the change is for a file or a shared drive.

This property indicates whether the change applies to a file or a shared drive. Possible values are:

• ctFile (0)
• ctSharedDrive (1)

The change_index parameter specifies the index of the item in the array. The size of the array is controlled by the change_count property.

This property is read-only.

child_marker Property

A marker when child resources are paged.

Syntax

def get_child_marker() -> str: ...
def set_child_marker(value: str) -> None: ...

child_marker = property(get_child_marker, set_child_marker)

Default Value

""

Remarks

This property returns a marker used to iterate over pages of child resources; it's populated when list_children is called if the results are paged.

Continue to call list_children until this property returns empty string in order to list all resources.

child_count Property

The number of records in the Child arrays.

Syntax

def get_child_count() -> int: ...

child_count = property(get_child_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• child_content_accessible
• child_created_time
• child_description
• child_extension
• child_id
• child_md5_checksum
• child_mime_type
• child_modified_time
• child_name
• child_original_name
• child_owner
• child_owner_email
• child_parent_ids
• child_shared_drive_id
• child_size
• child_starred
• child_trashed
• child_type
• child_viewed
• child_view_link

The array indices start at 0 and end at child_count - 1.

This property is read-only.

child_content_accessible Property

Whether the resource's content is accessible to less-privileged users.

Syntax

def get_child_content_accessible(child_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the resource's content is accessible to less-privileged users.

This property indicates whether the resource's content is accessible. If the resource is not accessible, it cannot be copied, downloaded, or printed by a users unless they have at least "writer" permissions.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_created_time Property

The creation date of the resource.

Syntax

def get_child_created_time(child_index: int) -> str: ...

Default Value

""

Remarks

The creation date of the resource.

This property holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Note that while this property is writable, the class only uses it as input when upload_file is called; it is ignored when calling update_resource.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_description Property

A short description of the resource.

Syntax

def get_child_description(child_index: int) -> str: ...

Default Value

""

Remarks

A short description of the resource.

This property specifies a short description of the resource.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_extension Property

The file extension of the resource.

Syntax

def get_child_extension(child_index: int) -> str: ...

Default Value

""

Remarks

The file extension of the resource.

This property indicates the file extension of the resource. It cannot be set, and is empty for folder resources. To specify the extension when creating a new file resource include it when calling upload_file.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_id Property

The Id of the resource.

Syntax

def get_child_id(child_index: int) -> str: ...

Default Value

""

Remarks

The Id of the resource.

This property holds the Id of the resource.

This property must be set before calling update_resource.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_md5_checksum Property

The MD5 checksum of the file resource.

Syntax

def get_child_md5_checksum(child_index: int) -> str: ...

Default Value

""

Remarks

The MD5 checksum of the file resource.

This property holds the MD5 checksum of the resource, if it is a file resource.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_mime_type Property

The MIME type of the resource.

Syntax

def get_child_mime_type(child_index: int) -> str: ...

Default Value

""

Remarks

The MIME type of the resource.

This property specifies the MIME type of the resource.

When calling upload_file, this property is ignored in favor of the MimeType parameter of upload_file.

When calling update_resource, this property is only submitted if new file data is being uploaded.

Some Google Drive MIME types:

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_modified_time Property

The last modified date of the resource.

Syntax

def get_child_modified_time(child_index: int) -> str: ...

Default Value

""

Remarks

The last modified date of the resource.

This property holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_name Property

The name of the resource.

Syntax

def get_child_name(child_index: int) -> str: ...

Default Value

""

Remarks

The name of the resource.

This property specifies the name of the resource.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_original_name Property

The original name of the file resource.

Syntax

def get_child_original_name(child_index: int) -> str: ...

Default Value

""

Remarks

The original name of the file resource.

This property specifies the original name of a file resource if the file was uploaded manually, or if the name was set programmatically through the API.

Updating child_name will not change this value.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_owner Property

The name of the resource's owner.

Syntax

def get_child_owner(child_index: int) -> str: ...

Default Value

""

Remarks

The name of the resource's owner.

This property holds the name of resource's owner.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_owner_email Property

The email address of the resource's owner.

Syntax

def get_child_owner_email(child_index: int) -> str: ...

Default Value

""

Remarks

The email address of the resource's owner.

This property holds the email address of the resource's owner.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_parent_ids Property

The Ids of the resource's parent folders.

Syntax

def get_child_parent_ids(child_index: int) -> str: ...

Default Value

""

Remarks

The Ids of the resource's parent folders.

This property holds a comma-separated list of Ids for the resource's parent folders.

Note that while this property is writable, the class only uses it as input when upload_file is called. To modify a resource's parents in any other case, use the add_parents, remove_parents, and move_resource methods.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_shared_drive_id Property

The Id of the shared drive the resource is in.

Syntax

def get_child_shared_drive_id(child_index: int) -> str: ...

Default Value

""

Remarks

The Id of the shared drive the resource is in.

This property holds the Id of the shared drive that the resource is in, if applicable.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_size Property

The size of the file resource in bytes.

Syntax

def get_child_size(child_index: int) -> int: ...

Default Value

0

Remarks

The size of the file resource in bytes.

This property holds the size of a file resource in bytes. This is only applicable to files.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_starred Property

Whether the resource is starred.

Syntax

def get_child_starred(child_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the resource is starred.

This property indicates whether the resource is starred by the current user.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_trashed Property

Whether the resource is in the trash.

Syntax

def get_child_trashed(child_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the resource is in the trash.

This property indicates whether the resource has been moved to trash.

Note that while this property is writable, the class only uses it as input when update_resource is called; it is ignored when calling upload_file.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_type Property

The resource's type.

Syntax

def get_child_type(child_index: int) -> int: ...

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

Google treats files and folders in the same way, and folders are included when listing resources. The resource_type property can be used to determine if a resource is a folder, a file, or a revision of a file.

To list, delete, and update folders use the list_resources, delete_resource, and update_resource methods.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_viewed Property

Whether the resource has been viewed.

Syntax

def get_child_viewed(child_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the resource has been viewed.

This property indicates whether the resource has been viewed by the current user.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

child_view_link Property

A link for opening the resource in a relevant Google editor or viewer in a browser.

Syntax

def get_child_view_link(child_index: int) -> str: ...

Default Value

""

Remarks

A link for opening the resource in a relevant Google editor or viewer in a browser.

This property holds the link to the resource. The link may be used to view the resource in a browser or relevant editor.

The child_index parameter specifies the index of the item in the array. The size of the array is controlled by the child_count property.

This property is read-only.

encryption_algorithm Property

The encryption algorithm.

Syntax

def get_encryption_algorithm() -> int: ...
def set_encryption_algorithm(value: int) -> None: ...

encryption_algorithm = property(get_encryption_algorithm, set_encryption_algorithm)

Default Value

0

Remarks

This property specifies the encryption algorithm to be used. The maximum allowable key size is automatically used for the selected algorithm. Possible values are:

encryption_password Property

The encryption password.

Syntax

def get_encryption_password() -> str: ...
def set_encryption_password(value: str) -> None: ...

encryption_password = property(get_encryption_password, set_encryption_password)

Default Value

""

Remarks

If this property is populated when upload_file or download_file is called, the class will attempt to encrypt or decrypt the data before uploading or after downloading it.

The class uses the value specified here to generate the necessary encryption Key and IV values using the PKCS5 password digest algorithm. This provides a simpler alternative to creating and managing Key and IV values directly.

However, it is also possible to explicitly specify the Key and IV values to use by setting the EncryptionKey and EncryptionIV configuration settings. This may be necessary if, e.g., the data needs to be encrypted/decrypted by another utility which generates Key and IV values differently.

firewall_auto_detect Property

Whether to automatically detect and use firewall system settings, if available.

Syntax

def get_firewall_auto_detect() -> bool: ...
def set_firewall_auto_detect(value: bool) -> None: ...

firewall_auto_detect = property(get_firewall_auto_detect, set_firewall_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use firewall system settings, if available.

firewall_type Property

The type of firewall to connect through.

Syntax

def get_firewall_type() -> int: ...
def set_firewall_type(value: int) -> None: ...

firewall_type = property(get_firewall_type, set_firewall_type)

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

firewall_host Property

The name or IP address of the firewall (optional).

Syntax

def get_firewall_host() -> str: ...
def set_firewall_host(value: str) -> None: ...

firewall_host = property(get_firewall_host, set_firewall_host)

Default Value

""

Remarks

The name or IP address of the firewall (optional). If a firewall_host is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

firewall_password Property

A password if authentication is to be used when connecting through the firewall.

Syntax

def get_firewall_password() -> str: ...
def set_firewall_password(value: str) -> None: ...

firewall_password = property(get_firewall_password, set_firewall_password)

Default Value

""

Remarks

A password if authentication is to be used when connecting through the firewall. If firewall_host is specified, the firewall_user and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

firewall_port Property

The Transmission Control Protocol (TCP) port for the firewall Host .

Syntax

def get_firewall_port() -> int: ...
def set_firewall_port(value: int) -> None: ...

firewall_port = property(get_firewall_port, set_firewall_port)

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall firewall_host. See the description of the firewall_host property for details.

Note: This property is set automatically when firewall_type is set to a valid value. See the description of the firewall_type property for details.

firewall_user Property

A username if authentication is to be used when connecting through a firewall.

Syntax

def get_firewall_user() -> str: ...
def set_firewall_user(value: str) -> None: ...

firewall_user = property(get_firewall_user, set_firewall_user)

Default Value

""

Remarks

A username if authentication is to be used when connecting through a firewall. If firewall_host is specified, this property and the firewall_password property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

This property will be False if the component is currently busy (communicating or waiting for an answer), and True at all other times.

This property is read-only.

list_resources_scope Property

Controls the scope of the results when listing resources.

Syntax

def get_list_resources_scope() -> int: ...
def set_list_resources_scope(value: int) -> None: ...

list_resources_scope = property(get_list_resources_scope, set_list_resources_scope)

Default Value

0

Remarks

This property controls the scope of the results when listing resources with list_resources or list_children. Valid values are:

Refer to list_resources for more information.

local_file Property

The location of the local file.

Syntax

def get_local_file() -> str: ...
def set_local_file(value: str) -> None: ...

local_file = property(get_local_file, set_local_file)

Default Value

""

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling upload_file or update_resource, and as the destination file when calling download_file.

local_host Property

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

def get_local_host() -> str: ...
def set_local_host(value: str) -> None: ...

local_host = property(get_local_host, set_local_host)

Default Value

""

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the local_host property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: local_host is not persistent. You must always set it in code, and never in the property window.

next_change_marker Property

A marker indicating what page of changes to return in the future.

Syntax

def get_next_change_marker() -> str: ...
def set_next_change_marker(value: str) -> None: ...

next_change_marker = property(get_next_change_marker, set_next_change_marker)

Default Value

""

Remarks

This property will be populated when list_changes is called if there are no more changes to list.

This property will be populated with the most current change marker if get_current_change_marker is called.

Setting next_change_marker will cause change_marker to be set to empty string.

Refer to list_changes for more information.

o_auth_access_token Property

The access token returned by the authorization server.

Syntax

def get_o_auth_access_token() -> str: ...
def set_o_auth_access_token(value: str) -> None: ...

o_auth_access_token = property(get_o_auth_access_token, set_o_auth_access_token)

Default Value

""

Remarks

The access token returned by the authorization server. This is set when the class makes a request to the token server.

o_auth_authorization_code Property

The authorization code that is exchanged for an access token.

Syntax

def get_o_auth_authorization_code() -> str: ...
def set_o_auth_authorization_code(value: str) -> None: ...

o_auth_authorization_code = property(get_o_auth_authorization_code, set_o_auth_authorization_code)

Default Value

""

Remarks

The authorization code that is exchanged for an access token. This is required to be set when the o_auth_client_profile property is set to the Web profile. Otherwise, this field is for information purposes only.

o_auth_authorization_scope Property

The scope request or response parameter used during authorization.

Syntax

def get_o_auth_authorization_scope() -> str: ...
def set_o_auth_authorization_scope(value: str) -> None: ...

o_auth_authorization_scope = property(get_o_auth_authorization_scope, set_o_auth_authorization_scope)

Default Value

""

Remarks

The scope request or response parameter used during authorization.

o_auth_client_id Property

The id of the client assigned when registering the application.

Syntax

def get_o_auth_client_id() -> str: ...
def set_o_auth_client_id(value: str) -> None: ...

o_auth_client_id = property(get_o_auth_client_id, set_o_auth_client_id)

Default Value

""

Remarks

The id of the client assigned when registering the application.

o_auth_client_profile Property

The type of client that is requesting authorization.

Syntax

def get_o_auth_client_profile() -> int: ...
def set_o_auth_client_profile(value: int) -> None: ...

o_auth_client_profile = property(get_o_auth_client_profile, set_o_auth_client_profile)

Default Value

0

Remarks

The type of client that is requesting authorization. See the introduction section for more information. Possible values are:

o_auth_client_secret Property

The secret value for the client assigned when registering the application.

Syntax

def get_o_auth_client_secret() -> str: ...
def set_o_auth_client_secret(value: str) -> None: ...

o_auth_client_secret = property(get_o_auth_client_secret, set_o_auth_client_secret)

Default Value

""

Remarks

The secret value for the client assigned when registering the application.

o_auth_grant_type Property

The OAuth grant type used to acquire an OAuth access token.

Syntax

def get_o_auth_grant_type() -> int: ...
def set_o_auth_grant_type(value: int) -> None: ...

o_auth_grant_type = property(get_o_auth_grant_type, set_o_auth_grant_type)

Default Value

0

Remarks

The OAuth grant type used to acquire an OAuth access token. See the introduction section for more information. Possible values are:

o_auth_refresh_token Property

Specifies the refresh token received from or sent to the authorization server.

Syntax

def get_o_auth_refresh_token() -> str: ...
def set_o_auth_refresh_token(value: str) -> None: ...

o_auth_refresh_token = property(get_o_auth_refresh_token, set_o_auth_refresh_token)

Default Value

""

Remarks

Specifies the refresh token received from or sent to the authorization server. This property is set automatically if a refresh token is retrieved from the token server. If the OAuthAutomaticRefresh configuration setting is set to true, and the o_auth_grant_type property is set to a grant that can use refresh tokens.

o_auth_request_refresh_token Property

Specifies whether the class will request a refresh token during authorization.

Syntax

def get_o_auth_request_refresh_token() -> bool: ...
def set_o_auth_request_refresh_token(value: bool) -> None: ...

o_auth_request_refresh_token = property(get_o_auth_request_refresh_token, set_o_auth_request_refresh_token)

Default Value

TRUE

Remarks

Specifies whether the class will request a refresh token during authorization. By default, this value is True.

When True, the class will automatically add the necessary scopes or parameters to obtain a refresh token. When False, this property will have no effect. If the necessary scopes or parameters are specified manually, a refresh token can still be obtained.

Note: This property is only applicable when the o_auth_grant_type property is set to cogtAuthorizationCode.

o_auth_return_url Property

The URL where the user (browser) returns after authenticating.

Syntax

def get_o_auth_return_url() -> str: ...
def set_o_auth_return_url(value: str) -> None: ...

o_auth_return_url = property(get_o_auth_return_url, set_o_auth_return_url)

Default Value

""

Remarks

The URL where the user (browser) returns after authenticating. This property is mapped to the redirect_uri parameter when making a request to the authorization server. Typically, this is automatically set by the class when using the embedded web server. If the OAuthWebServerPort or OAuthWebServerHost configuration settings is set, then this property should be set to match. If using the Web client profile, this should be set to the place where the authorization code will be parsed out of the response after the user finishes authorizing.

o_auth_server_auth_url Property

The URL of the authorization server.

Syntax

def get_o_auth_server_auth_url() -> str: ...
def set_o_auth_server_auth_url(value: str) -> None: ...

o_auth_server_auth_url = property(get_o_auth_server_auth_url, set_o_auth_server_auth_url)

Default Value

""

Remarks

The URL of the authorization server.

o_auth_server_token_url Property

The URL of the token server used to obtain the access token.

Syntax

def get_o_auth_server_token_url() -> str: ...
def set_o_auth_server_token_url(value: str) -> None: ...

o_auth_server_token_url = property(get_o_auth_server_token_url, set_o_auth_server_token_url)

Default Value

""

Remarks

The URL of the token server used to obtain the access token.

o_auth_web_auth_url Property

The URL to which the user should be re-directed for authorization.

Syntax

def get_o_auth_web_auth_url() -> str: ...

o_auth_web_auth_url = property(get_o_auth_web_auth_url, None)

Default Value

""

Remarks

The URL to which the user should be re-directed for authorization. This field is used to get the URL that the user should be redirected to when using the Web client profile. See introduction section for more information.

This property is read-only.

other_headers Property

Other headers as determined by the user (optional).

Syntax

def get_other_headers() -> str: ...
def set_other_headers(value: str) -> None: ...

other_headers = property(get_other_headers, set_other_headers)

Default Value

""

Remarks

This property can be set to a string of headers to be appended to the HTTP request headers created from other properties like content_type and from_.

The headers must follow the format Header: Value as described in the HTTP specifications. Header lines should be separated by CRLF ("\r\n") .

Use this property with caution. If this property contains invalid headers, HTTP requests may fail.

This property is useful for extending the functionality of the class beyond what is provided.

overwrite Property

Determines if local files are overwritten.

Syntax

def get_overwrite() -> bool: ...
def set_overwrite(value: bool) -> None: ...

overwrite = property(get_overwrite, set_overwrite)

Default Value

FALSE

Remarks

This property controls whether local files are overwritten when calling download_file. It is only applicable to local files. The default value is False.

parsed_header_count Property

The number of records in the ParsedHeader arrays.

Syntax

def get_parsed_header_count() -> int: ...

parsed_header_count = property(get_parsed_header_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• parsed_header_field
• parsed_header_value

The array indices start at 0 and end at parsed_header_count - 1.

This property is read-only.

parsed_header_field Property

This property contains the name of the HTTP header (this is the same case as it is delivered).

Syntax

def get_parsed_header_field(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name of the HTTP Header (this is the same case as it is delivered).

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

parsed_header_value Property

This property contains the header contents.

Syntax

def get_parsed_header_value(parsed_header_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Header contents.

The parsed_header_index parameter specifies the index of the item in the array. The size of the array is controlled by the parsed_header_count property.

This property is read-only.

permission_marker Property

A marker when permissions are paged.

Syntax

def get_permission_marker() -> str: ...
def set_permission_marker(value: str) -> None: ...

permission_marker = property(get_permission_marker, set_permission_marker)

Default Value

""

Remarks

This property returns a marker used to iterate over pages of permissions; it's populated when list_permissions is called if the results are paged.

Continue to call list_permissions until this property returns empty string in order to list all permissions.

permission_count Property

The number of records in the Permission arrays.

Syntax

def get_permission_count() -> int: ...
def set_permission_count(value: int) -> None: ...

permission_count = property(get_permission_count, set_permission_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• permission_allow_file_discovery
• permission_domain
• permission_email
• permission_id
• permission_mod_op
• permission_role
• permission_type

The array indices start at 0 and end at permission_count - 1.

permission_allow_file_discovery Property

Whether the permission allows the file or folder to be discovered through search.

Syntax

def get_permission_allow_file_discovery(permission_index: int) -> bool: ...
def set_permission_allow_file_discovery(permission_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the permission allows the file or folder to be discovered through search.

This property indicates whether the permission allows the file or folder to which it applies to be discovered through search.

This property is only applicable if the permission's permission_type is set to 2 (ptDomain) or 3 (ptAnyone).

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_domain Property

The domain to which the permission applies.

Syntax

def get_permission_domain(permission_index: int) -> str: ...
def set_permission_domain(permission_index: int, value: str) -> None: ...

Default Value

""

Remarks

The domain to which the permission applies.

This property is used to define the domain to which the permission applies when permission_type is set to 2 (ptDomain).

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_email Property

The user or group to which the permission applies.

Syntax

def get_permission_email(permission_index: int) -> str: ...
def set_permission_email(permission_index: int, value: str) -> None: ...

Default Value

""

Remarks

The user or group to which the permission applies.

This property is used to define the user or group to which the permission applies when permission_type is set to 0 (ptUser) or 1 (ptGroup).

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_id Property

The Id of the permission.

Syntax

def get_permission_id(permission_index: int) -> str: ...
def set_permission_id(permission_index: int, value: str) -> None: ...

Default Value

""

Remarks

The Id of the permission.

This property holds the Id of the permission.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_mod_op Property

The operation to perform on the permission.

Syntax

def get_permission_mod_op(permission_index: int) -> int: ...
def set_permission_mod_op(permission_index: int, value: int) -> None: ...

Default Value

0

Remarks

The operation to perform on the permission.

This property is used to specify the operation that the class should perform on the permission when update_permissions is called. Valid values are:

Refer to update_permissions for more information.

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_role Property

The role specified by the permission.

Syntax

def get_permission_role(permission_index: int) -> int: ...
def set_permission_role(permission_index: int, value: int) -> None: ...

Default Value

0

Remarks

The role specified by the permission.

This property defines the role specified by the permission. Possible values are:

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

permission_type Property

The set of users to which the permission applies.

Syntax

def get_permission_type(permission_index: int) -> int: ...
def set_permission_type(permission_index: int, value: int) -> None: ...

Default Value

0

Remarks

The set of users to which the permission applies.

This property defines the set of users to which the permission role defined in permission_role applies.

The permission_email and permission_domain properties are used to define the user, group, or domain to which the permission applies. The following table shows which property is associated with which permission type:

The permission_index parameter specifies the index of the item in the array. The size of the array is controlled by the permission_count property.

proxy_auth_scheme Property

The type of authorization to perform when connecting to the proxy.

Syntax

def get_proxy_auth_scheme() -> int: ...
def set_proxy_auth_scheme(value: int) -> None: ...

proxy_auth_scheme = property(get_proxy_auth_scheme, set_proxy_auth_scheme)

Default Value

0

Remarks

The type of authorization to perform when connecting to the proxy. This is used only when the proxy_user and proxy_password properties are set.

proxy_auth_scheme should be set to authNone (3) when no authentication is expected.

By default, proxy_auth_scheme is authBasic (0), and if the proxy_user and proxy_password properties are set, the class will attempt basic authentication.

If proxy_auth_scheme is set to authDigest (1), digest authentication will be attempted instead.

If proxy_auth_scheme is set to authProprietary (2), then the authorization token will not be generated by the class. Look at the configuration file for the class being used to find more information about manually setting this token.

If proxy_auth_scheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of proxy_user and proxy_password.

proxy_auto_detect Property

Whether to automatically detect and use proxy system settings, if available.

Syntax

def get_proxy_auto_detect() -> bool: ...
def set_proxy_auto_detect(value: bool) -> None: ...

proxy_auto_detect = property(get_proxy_auto_detect, set_proxy_auto_detect)

Default Value

FALSE

Remarks

Whether to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

A password if authentication is to be used for the proxy.

Syntax

def get_proxy_password() -> str: ...
def set_proxy_password(value: str) -> None: ...

proxy_password = property(get_proxy_password, set_proxy_password)

Default Value

""

Remarks

A password if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

proxy_port Property

The Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Syntax

def get_proxy_port() -> int: ...
def set_proxy_port(value: int) -> None: ...

proxy_port = property(get_proxy_port, set_proxy_port)

Default Value

80

Remarks

The Transmission Control Protocol (TCP) port for the proxy proxy_server (default 80). See the description of the proxy_server property for details.

proxy_server Property

If a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

Syntax

def get_proxy_server() -> str: ...
def set_proxy_server(value: str) -> None: ...

proxy_server = property(get_proxy_server, set_proxy_server)

Default Value

""

Remarks

If a proxy proxy_server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.

If the proxy_server property is set to a domain name, a DNS request is initiated. Upon successful termination of the request, the proxy_server property is set to the corresponding address. If the search is not successful, an error is returned.

proxy_ssl Property

When to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Syntax

def get_proxy_ssl() -> int: ...
def set_proxy_ssl(value: int) -> None: ...

proxy_ssl = property(get_proxy_ssl, set_proxy_ssl)

Default Value

0

Remarks

When to use a Secure Sockets Layer (SSL) for the connection to the proxy. The applicable values are as follows:

proxy_user Property

A username if authentication is to be used for the proxy.

Syntax

def get_proxy_user() -> str: ...
def set_proxy_user(value: str) -> None: ...

proxy_user = property(get_proxy_user, set_proxy_user)

Default Value

""

Remarks

A username if authentication is to be used for the proxy.

If proxy_auth_scheme is set to Basic Authentication, the proxy_user and proxy_password properties are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If proxy_auth_scheme is set to Digest Authentication, the proxy_user and proxy_password properties are used to respond to the Digest Authentication challenge from the server.

If proxy_auth_scheme is set to NTLM Authentication, the proxy_user and proxy_password properties are used to authenticate through NTLM negotiation.

query_param_count Property

The number of records in the QueryParam arrays.

Syntax

def get_query_param_count() -> int: ...
def set_query_param_count(value: int) -> None: ...

query_param_count = property(get_query_param_count, set_query_param_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• query_param_name
• query_param_value

The array indices start at 0 and end at query_param_count - 1.

query_param_name Property

The name of the query parameter.

Syntax

def get_query_param_name(query_param_index: int) -> str: ...
def set_query_param_name(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

query_param_value Property

The value of the query parameter.

Syntax

def get_query_param_value(query_param_index: int) -> str: ...
def set_query_param_value(query_param_index: int, value: str) -> None: ...

Default Value

""

Remarks

The value of the query parameter.

This property specifies the value of the query parameter. The class will automatically URL-encode this value when sending the request.

The query_param_index parameter specifies the index of the item in the array. The size of the array is controlled by the query_param_count property.

resource_data Property

The data that was downloaded, or that should be uploaded.

Syntax

def get_resource_data() -> bytes: ...
def set_resource_data(value: bytes) -> None: ...

resource_data = property(get_resource_data, set_resource_data)

Default Value

""

Remarks

This property is populated with file data after calling download_file if local_file is not set.

This property can also be set before calling upload_file; its data will be uploaded if local_file is not set.

resource_marker Property

A marker indicating what page of resources to return next.

Syntax

def get_resource_marker() -> str: ...
def set_resource_marker(value: str) -> None: ...

resource_marker = property(get_resource_marker, set_resource_marker)

Default Value

""

Remarks

This property will be populated when list_resources is called if the results are paged and there are more pages. To list all resources, continue to call list_resources until this property returns empty string.

Refer to list_resources for more information.

Note that resources are never paged when calling list_parents or get_resource_info.

resource_count Property

The number of records in the Resource arrays.

Syntax

def get_resource_count() -> int: ...
def set_resource_count(value: int) -> None: ...

resource_count = property(get_resource_count, set_resource_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• resource_content_accessible
• resource_created_time
• resource_description
• resource_extension
• resource_id
• resource_md5_checksum
• resource_mime_type
• resource_modified_time
• resource_name
• resource_original_name
• resource_owner
• resource_owner_email
• resource_parent_ids
• resource_shared_drive_id
• resource_size
• resource_starred
• resource_trashed
• resource_type
• resource_viewed
• resource_view_link

The array indices start at 0 and end at resource_count - 1.

resource_content_accessible Property

Whether the resource's content is accessible to less-privileged users.

Syntax

def get_resource_content_accessible(resource_index: int) -> bool: ...
def set_resource_content_accessible(resource_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the resource's content is accessible to less-privileged users.

This property indicates whether the resource's content is accessible. If the resource is not accessible, it cannot be copied, downloaded, or printed by a users unless they have at least "writer" permissions.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_created_time Property

The creation date of the resource.

Syntax

def get_resource_created_time(resource_index: int) -> str: ...
def set_resource_created_time(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The creation date of the resource.

This property holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Note that while this property is writable, the class only uses it as input when upload_file is called; it is ignored when calling update_resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_description Property

A short description of the resource.

Syntax

def get_resource_description(resource_index: int) -> str: ...
def set_resource_description(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

A short description of the resource.

This property specifies a short description of the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_extension Property

The file extension of the resource.

Syntax

def get_resource_extension(resource_index: int) -> str: ...

Default Value

""

Remarks

The file extension of the resource.

This property indicates the file extension of the resource. It cannot be set, and is empty for folder resources. To specify the extension when creating a new file resource include it when calling upload_file.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_id Property

The Id of the resource.

Syntax

def get_resource_id(resource_index: int) -> str: ...
def set_resource_id(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The Id of the resource.

This property holds the Id of the resource.

This property must be set before calling update_resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_md5_checksum Property

The MD5 checksum of the file resource.

Syntax

def get_resource_md5_checksum(resource_index: int) -> str: ...

Default Value

""

Remarks

The MD5 checksum of the file resource.

This property holds the MD5 checksum of the resource, if it is a file resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_mime_type Property

The MIME type of the resource.

Syntax

def get_resource_mime_type(resource_index: int) -> str: ...
def set_resource_mime_type(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The MIME type of the resource.

This property specifies the MIME type of the resource.

When calling upload_file, this property is ignored in favor of the MimeType parameter of upload_file.

When calling update_resource, this property is only submitted if new file data is being uploaded.

Some Google Drive MIME types:

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_modified_time Property

The last modified date of the resource.

Syntax

def get_resource_modified_time(resource_index: int) -> str: ...
def set_resource_modified_time(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The last modified date of the resource.

This property holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_name Property

The name of the resource.

Syntax

def get_resource_name(resource_index: int) -> str: ...
def set_resource_name(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The name of the resource.

This property specifies the name of the resource.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_original_name Property

The original name of the file resource.

Syntax

def get_resource_original_name(resource_index: int) -> str: ...

Default Value

""

Remarks

The original name of the file resource.

This property specifies the original name of a file resource if the file was uploaded manually, or if the name was set programmatically through the API.

Updating resource_name will not change this value.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_owner Property

The name of the resource's owner.

Syntax

def get_resource_owner(resource_index: int) -> str: ...

Default Value

""

Remarks

The name of the resource's owner.

This property holds the name of resource's owner.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_owner_email Property

The email address of the resource's owner.

Syntax

def get_resource_owner_email(resource_index: int) -> str: ...

Default Value

""

Remarks

The email address of the resource's owner.

This property holds the email address of the resource's owner.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_parent_ids Property

The Ids of the resource's parent folders.

Syntax

def get_resource_parent_ids(resource_index: int) -> str: ...
def set_resource_parent_ids(resource_index: int, value: str) -> None: ...

Default Value

""

Remarks

The Ids of the resource's parent folders.

This property holds a comma-separated list of Ids for the resource's parent folders.

Note that while this property is writable, the class only uses it as input when upload_file is called. To modify a resource's parents in any other case, use the add_parents, remove_parents, and move_resource methods.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_shared_drive_id Property

The Id of the shared drive the resource is in.

Syntax

def get_resource_shared_drive_id(resource_index: int) -> str: ...

Default Value

""

Remarks

The Id of the shared drive the resource is in.

This property holds the Id of the shared drive that the resource is in, if applicable.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_size Property

The size of the file resource in bytes.

Syntax

def get_resource_size(resource_index: int) -> int: ...

Default Value

0

Remarks

The size of the file resource in bytes.

This property holds the size of a file resource in bytes. This is only applicable to files.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_starred Property

Whether the resource is starred.

Syntax

def get_resource_starred(resource_index: int) -> bool: ...
def set_resource_starred(resource_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the resource is starred.

This property indicates whether the resource is starred by the current user.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_trashed Property

Whether the resource is in the trash.

Syntax

def get_resource_trashed(resource_index: int) -> bool: ...
def set_resource_trashed(resource_index: int, value: bool) -> None: ...

Default Value

FALSE

Remarks

Whether the resource is in the trash.

This property indicates whether the resource has been moved to trash.

Note that while this property is writable, the class only uses it as input when update_resource is called; it is ignored when calling upload_file.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

resource_type Property

The resource's type.

Syntax

def get_resource_type(resource_index: int) -> int: ...

Default Value

0

Remarks

The resource's type.

This property indicates whether the resource is a folder or a file. Possible values are:

Google treats files and folders in the same way, and folders are included when listing resources. The resource_type property can be used to determine if a resource is a folder, a file, or a revision of a file.

To list, delete, and update folders use the list_resources, delete_resource, and update_resource methods.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_viewed Property

Whether the resource has been viewed.

Syntax

def get_resource_viewed(resource_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the resource has been viewed.

This property indicates whether the resource has been viewed by the current user.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resource_view_link Property

A link for opening the resource in a relevant Google editor or viewer in a browser.

Syntax

def get_resource_view_link(resource_index: int) -> str: ...

Default Value

""

Remarks

A link for opening the resource in a relevant Google editor or viewer in a browser.

This property holds the link to the resource. The link may be used to view the resource in a browser or relevant editor.

The resource_index parameter specifies the index of the item in the array. The size of the array is controlled by the resource_count property.

This property is read-only.

resume_url Property

The resumable upload URL.

Syntax

def get_resume_url() -> str: ...
def set_resume_url(value: str) -> None: ...

resume_url = property(get_resume_url, set_resume_url)

Default Value

""

Remarks

This property holds the URL of the resumable upload session. This is populated by the class automatically when use_resumable_upload is set to True and upload_file is called to initiate a new upload.

This must be set in order to resume an interrupted upload. See upload_file for details.

shared_drive Property

The shared drive to list file and folder resources for.

Syntax

def get_shared_drive() -> str: ...
def set_shared_drive(value: str) -> None: ...

shared_drive = property(get_shared_drive, set_shared_drive)

Default Value

""

Remarks

When list_resources_scope is set to lrsSharedDrive (2), this property must be set to a shared drive resource Id before calling list_resources or list_children.

This property may also be set to a shared drive resource Id before calling get_current_change_marker or list_changes in order to list changes to the specified shared drive and its contents.

Refer to list_resources or list_changes for more information.

shared_drive_marker Property

A marker when shared drives are paged.

Syntax

def get_shared_drive_marker() -> str: ...
def set_shared_drive_marker(value: str) -> None: ...

shared_drive_marker = property(get_shared_drive_marker, set_shared_drive_marker)

Default Value

""

Remarks

This property returns a marker used to iterate over pages of shared drives; it's populated when list_shared_drives is called if the results are paged.

Continue to call list_shared_drives until this property returns empty string in order to list all shared drives.

shared_drive_count Property

The number of records in the SharedDrive arrays.

Syntax

def get_shared_drive_count() -> int: ...

shared_drive_count = property(get_shared_drive_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• shared_drive_capabilities
• shared_drive_created_time
• shared_drive_hidden
• shared_drive_id
• shared_drive_name
• shared_drive_restrictions

The array indices start at 0 and end at shared_drive_count - 1.

This property is read-only.

shared_drive_capabilities Property

The capabilities that the current user has for the shared drive.

Syntax

def get_shared_drive_capabilities(shared_drive_index: int) -> int: ...

Default Value

0

Remarks

The capabilities that the current user has for the shared drive.

This property describes the effective capabilities that the current user has for the shared drive. The value is a bit field comprised of one or more of the following, OR'ed together:

The shared_drive_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_drive_count property.

This property is read-only.

shared_drive_created_time Property

The creation date of the shared drive.

Syntax

def get_shared_drive_created_time(shared_drive_index: int) -> str: ...

Default Value

""

Remarks

The creation date of the shared drive.

This property holds a DateTime string representing the creation date of the shared drive. This is a combined date-time value (formatted according to RFC 3339).

The shared_drive_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_drive_count property.

This property is read-only.

shared_drive_hidden Property

Whether the shared drive is hidden from default view.

Syntax

def get_shared_drive_hidden(shared_drive_index: int) -> bool: ...

Default Value

FALSE

Remarks

Whether the shared drive is hidden from default view.

This property specifies whether the shared drive is hidden from default view. To hide or unhide a shared drive, call the toggle_shared_drive_hidden method.

If a shared drive is hidden, it will not show up in the Google Drive UI by default (but is still otherwise accessible). Google Drive tracks this setting separately for each user; i.e., each member of a shared drive can choose whether the shared drive should be hidden or not.

The shared_drive_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_drive_count property.

This property is read-only.

shared_drive_id Property

The Id of the shared drive.

Syntax

def get_shared_drive_id(shared_drive_index: int) -> str: ...

Default Value

""

Remarks

The Id of the shared drive.

This property holds the Id of the shared drive.

The shared_drive_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_drive_count property.

This property is read-only.

shared_drive_name Property

The name of the shared drive.

Syntax

def get_shared_drive_name(shared_drive_index: int) -> str: ...

Default Value

""

Remarks

The name of the shared drive.

This property reflects the name of the shared drive.

The update_shared_drive method can be used to rename the shared drive if the current user is allowed to do so (i.e., if the shared_drive_capabilities property has the 0x08000 flag set).

The shared_drive_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_drive_count property.

This property is read-only.

shared_drive_restrictions Property

The restrictions that apply to the shared drive.

Syntax

def get_shared_drive_restrictions(shared_drive_index: int) -> int: ...

Default Value

0

Remarks

The restrictions that apply to the shared drive.

This property specifies the restrictions that apply to the shared drive. The value is a bitmask comprised of one or more of the following, OR'ed together:

The update_shared_drive method can be used to change any of the shared drive's restrictions that the current user is allowed to alter (indicated by the presence of the 0x00002, 0x00004, and/or 0x00010 flags in the shared_drive_capabilities property).

The shared_drive_index parameter specifies the index of the item in the array. The size of the array is controlled by the shared_drive_count property.

This property is read-only.

ssl_accept_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_accept_server_cert_effective_date() -> str: ...

ssl_accept_server_cert_effective_date = property(get_ssl_accept_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_accept_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_accept_server_cert_expiration_date() -> str: ...

ssl_accept_server_cert_expiration_date = property(get_ssl_accept_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_accept_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_accept_server_cert_extended_key_usage() -> str: ...

ssl_accept_server_cert_extended_key_usage = property(get_ssl_accept_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_accept_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint() -> str: ...

ssl_accept_server_cert_fingerprint = property(get_ssl_accept_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_accept_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha1() -> str: ...

ssl_accept_server_cert_fingerprint_sha1 = property(get_ssl_accept_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_accept_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_accept_server_cert_fingerprint_sha256() -> str: ...

ssl_accept_server_cert_fingerprint_sha256 = property(get_ssl_accept_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_accept_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_accept_server_cert_issuer() -> str: ...

ssl_accept_server_cert_issuer = property(get_ssl_accept_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_accept_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key() -> str: ...

ssl_accept_server_cert_private_key = property(get_ssl_accept_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_accept_server_cert_private_key may be available but not exportable. In this case, ssl_accept_server_cert_private_key returns an empty string.

This property is read-only.

ssl_accept_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_accept_server_cert_private_key_available() -> bool: ...

ssl_accept_server_cert_private_key_available = property(get_ssl_accept_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_accept_server_cert_private_key is available for the selected certificate. If ssl_accept_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_accept_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_accept_server_cert_private_key_container() -> str: ...

ssl_accept_server_cert_private_key_container = property(get_ssl_accept_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_accept_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_accept_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_accept_server_cert_public_key() -> str: ...

ssl_accept_server_cert_public_key = property(get_ssl_accept_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_accept_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_accept_server_cert_public_key_algorithm() -> str: ...

ssl_accept_server_cert_public_key_algorithm = property(get_ssl_accept_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_accept_server_cert_public_key_length() -> int: ...

ssl_accept_server_cert_public_key_length = property(get_ssl_accept_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_accept_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_accept_server_cert_serial_number() -> str: ...

ssl_accept_server_cert_serial_number = property(get_ssl_accept_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_accept_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_accept_server_cert_signature_algorithm() -> str: ...

ssl_accept_server_cert_signature_algorithm = property(get_ssl_accept_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_accept_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_accept_server_cert_store() -> bytes: ...
def set_ssl_accept_server_cert_store(value: bytes) -> None: ...

ssl_accept_server_cert_store = property(get_ssl_accept_server_cert_store, set_ssl_accept_server_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_accept_server_cert_store_type property denotes the type of the certificate store specified by ssl_accept_server_cert_store. If the store is password-protected, specify the password in ssl_accept_server_cert_store_password.

ssl_accept_server_cert_store is used in conjunction with the ssl_accept_server_cert_subject property to specify client certificates. If ssl_accept_server_cert_store has a value, and ssl_accept_server_cert_subject or ssl_accept_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_accept_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_accept_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_accept_server_cert_store_password() -> str: ...
def set_ssl_accept_server_cert_store_password(value: str) -> None: ...

ssl_accept_server_cert_store_password = property(get_ssl_accept_server_cert_store_password, set_ssl_accept_server_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_accept_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_accept_server_cert_store_type() -> int: ...
def set_ssl_accept_server_cert_store_type(value: int) -> None: ...

ssl_accept_server_cert_store_type = property(get_ssl_accept_server_cert_store_type, set_ssl_accept_server_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_accept_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_accept_server_cert_subject_alt_names() -> str: ...

ssl_accept_server_cert_subject_alt_names = property(get_ssl_accept_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_accept_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_md5() -> str: ...

ssl_accept_server_cert_thumbprint_md5 = property(get_ssl_accept_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha1() -> str: ...

ssl_accept_server_cert_thumbprint_sha1 = property(get_ssl_accept_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_accept_server_cert_thumbprint_sha256() -> str: ...

ssl_accept_server_cert_thumbprint_sha256 = property(get_ssl_accept_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_accept_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_accept_server_cert_usage() -> str: ...

ssl_accept_server_cert_usage = property(get_ssl_accept_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_accept_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_accept_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_accept_server_cert_usage_flags() -> int: ...

ssl_accept_server_cert_usage_flags = property(get_ssl_accept_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_accept_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_accept_server_cert_usage property for a text representation of ssl_accept_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_accept_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_accept_server_cert_version() -> str: ...

ssl_accept_server_cert_version = property(get_ssl_accept_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_accept_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_accept_server_cert_subject() -> str: ...
def set_ssl_accept_server_cert_subject(value: str) -> None: ...

ssl_accept_server_cert_subject = property(get_ssl_accept_server_cert_subject, set_ssl_accept_server_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_accept_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_accept_server_cert_encoded() -> bytes: ...
def set_ssl_accept_server_cert_encoded(value: bytes) -> None: ...

ssl_accept_server_cert_encoded = property(get_ssl_accept_server_cert_encoded, set_ssl_accept_server_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_accept_server_cert_store and ssl_accept_server_cert_subject properties also may be used to specify a certificate.

When ssl_accept_server_cert_encoded is set, a search is initiated in the current ssl_accept_server_cert_store for the private key of the certificate. If the key is found, ssl_accept_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_accept_server_cert_subject is set to an empty string.

ssl_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_cert_effective_date() -> str: ...

ssl_cert_effective_date = property(get_ssl_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_cert_expiration_date() -> str: ...

ssl_cert_expiration_date = property(get_ssl_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_cert_extended_key_usage() -> str: ...

ssl_cert_extended_key_usage = property(get_ssl_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint() -> str: ...

ssl_cert_fingerprint = property(get_ssl_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha1() -> str: ...

ssl_cert_fingerprint_sha1 = property(get_ssl_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_cert_fingerprint_sha256() -> str: ...

ssl_cert_fingerprint_sha256 = property(get_ssl_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_cert_issuer() -> str: ...

ssl_cert_issuer = property(get_ssl_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_cert_private_key() -> str: ...

ssl_cert_private_key = property(get_ssl_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_cert_private_key may be available but not exportable. In this case, ssl_cert_private_key returns an empty string.

This property is read-only.

ssl_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_cert_private_key_available() -> bool: ...

ssl_cert_private_key_available = property(get_ssl_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_cert_private_key is available for the selected certificate. If ssl_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_cert_private_key_container() -> str: ...

ssl_cert_private_key_container = property(get_ssl_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_cert_public_key() -> str: ...

ssl_cert_public_key = property(get_ssl_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_cert_public_key_algorithm() -> str: ...

ssl_cert_public_key_algorithm = property(get_ssl_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_cert_public_key_length() -> int: ...

ssl_cert_public_key_length = property(get_ssl_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_cert_serial_number() -> str: ...

ssl_cert_serial_number = property(get_ssl_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_cert_signature_algorithm() -> str: ...

ssl_cert_signature_algorithm = property(get_ssl_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

ssl_cert_store is used in conjunction with the ssl_cert_subject property to specify client certificates. If ssl_cert_store has a value, and ssl_cert_subject or ssl_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

ssl_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

ssl_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_cert_subject_alt_names() -> str: ...

ssl_cert_subject_alt_names = property(get_ssl_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_md5() -> str: ...

ssl_cert_thumbprint_md5 = property(get_ssl_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha1() -> str: ...

ssl_cert_thumbprint_sha1 = property(get_ssl_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_cert_thumbprint_sha256() -> str: ...

ssl_cert_thumbprint_sha256 = property(get_ssl_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_cert_usage() -> str: ...

ssl_cert_usage = property(get_ssl_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_cert_usage_flags() -> int: ...

ssl_cert_usage_flags = property(get_ssl_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_cert_usage_flags is a combination of the following flags:

Please see the ssl_cert_usage property for a text representation of ssl_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_cert_version Property

The certificate's version number.

Syntax

def get_ssl_cert_version() -> str: ...

ssl_cert_version = property(get_ssl_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_cert_store and ssl_cert_subject properties also may be used to specify a certificate.

When ssl_cert_encoded is set, a search is initiated in the current ssl_cert_store for the private key of the certificate. If the key is found, ssl_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_cert_subject is set to an empty string.

ssl_provider Property

The Secure Sockets Layer/Transport Layer Security (SSL/TLS) implementation to use.

Syntax

def get_ssl_provider() -> int: ...
def set_ssl_provider(value: int) -> None: ...

ssl_provider = property(get_ssl_provider, set_ssl_provider)

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic), the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are as follows:

Additional Notes

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected, on Windows, the class will use the platform implementation. On Linux/macOS, the class will use the internal implementation. When TLS 1.3 is enabled via SSLEnabledProtocols, the internal implementation is used on all platforms.

ssl_server_cert_effective_date Property

The date on which this certificate becomes valid.

Syntax

def get_ssl_server_cert_effective_date() -> str: ...

ssl_server_cert_effective_date = property(get_ssl_server_cert_effective_date, None)

Default Value

""

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

ssl_server_cert_expiration_date Property

The date on which the certificate expires.

Syntax

def get_ssl_server_cert_expiration_date() -> str: ...

ssl_server_cert_expiration_date = property(get_ssl_server_cert_expiration_date, None)

Default Value

""

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

ssl_server_cert_extended_key_usage Property

A comma-delimited list of extended key usage identifiers.

Syntax

def get_ssl_server_cert_extended_key_usage() -> str: ...

ssl_server_cert_extended_key_usage = property(get_ssl_server_cert_extended_key_usage, None)

Default Value

""

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

ssl_server_cert_fingerprint Property

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint() -> str: ...

ssl_server_cert_fingerprint = property(get_ssl_server_cert_fingerprint, None)

Default Value

""

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

ssl_server_cert_fingerprint_sha1 Property

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha1() -> str: ...

ssl_server_cert_fingerprint_sha1 = property(get_ssl_server_cert_fingerprint_sha1, None)

Default Value

""

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

ssl_server_cert_fingerprint_sha256 Property

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Syntax

def get_ssl_server_cert_fingerprint_sha256() -> str: ...

ssl_server_cert_fingerprint_sha256 = property(get_ssl_server_cert_fingerprint_sha256, None)

Default Value

""

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

ssl_server_cert_issuer Property

The issuer of the certificate.

Syntax

def get_ssl_server_cert_issuer() -> str: ...

ssl_server_cert_issuer = property(get_ssl_server_cert_issuer, None)

Default Value

""

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

ssl_server_cert_private_key Property

The private key of the certificate (if available).

Syntax

def get_ssl_server_cert_private_key() -> str: ...

ssl_server_cert_private_key = property(get_ssl_server_cert_private_key, None)

Default Value

""

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The ssl_server_cert_private_key may be available but not exportable. In this case, ssl_server_cert_private_key returns an empty string.

This property is read-only.

ssl_server_cert_private_key_available Property

Whether a PrivateKey is available for the selected certificate.

Syntax

def get_ssl_server_cert_private_key_available() -> bool: ...

ssl_server_cert_private_key_available = property(get_ssl_server_cert_private_key_available, None)

Default Value

FALSE

Remarks

Whether a ssl_server_cert_private_key is available for the selected certificate. If ssl_server_cert_private_key_available is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

ssl_server_cert_private_key_container Property

The name of the PrivateKey container for the certificate (if available).

Syntax

def get_ssl_server_cert_private_key_container() -> str: ...

ssl_server_cert_private_key_container = property(get_ssl_server_cert_private_key_container, None)

Default Value

""

Remarks

The name of the ssl_server_cert_private_key container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

ssl_server_cert_public_key Property

The public key of the certificate.

Syntax

def get_ssl_server_cert_public_key() -> str: ...

ssl_server_cert_public_key = property(get_ssl_server_cert_public_key, None)

Default Value

""

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

ssl_server_cert_public_key_algorithm Property

The textual description of the certificate's public key algorithm.

Syntax

def get_ssl_server_cert_public_key_algorithm() -> str: ...

ssl_server_cert_public_key_algorithm = property(get_ssl_server_cert_public_key_algorithm, None)

Default Value

""

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_public_key_length Property

The length of the certificate's public key (in bits).

Syntax

def get_ssl_server_cert_public_key_length() -> int: ...

ssl_server_cert_public_key_length = property(get_ssl_server_cert_public_key_length, None)

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

ssl_server_cert_serial_number Property

The serial number of the certificate encoded as a string.

Syntax

def get_ssl_server_cert_serial_number() -> str: ...

ssl_server_cert_serial_number = property(get_ssl_server_cert_serial_number, None)

Default Value

""

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

ssl_server_cert_signature_algorithm Property

The text description of the certificate's signature algorithm.

Syntax

def get_ssl_server_cert_signature_algorithm() -> str: ...

ssl_server_cert_signature_algorithm = property(get_ssl_server_cert_signature_algorithm, None)

Default Value

""

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

ssl_server_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_server_cert_store() -> bytes: ...

ssl_server_cert_store = property(get_ssl_server_cert_store, None)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_server_cert_store_type property denotes the type of the certificate store specified by ssl_server_cert_store. If the store is password-protected, specify the password in ssl_server_cert_store_password.

ssl_server_cert_store is used in conjunction with the ssl_server_cert_subject property to specify client certificates. If ssl_server_cert_store has a value, and ssl_server_cert_subject or ssl_server_cert_encoded is set, a search for a certificate is initiated. Please see the ssl_server_cert_subject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is read-only.

ssl_server_cert_store_password Property

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

def get_ssl_server_cert_store_password() -> str: ...

ssl_server_cert_store_password = property(get_ssl_server_cert_store_password, None)

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is read-only.

ssl_server_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_server_cert_store_type() -> int: ...

ssl_server_cert_store_type = property(get_ssl_server_cert_store_type, None)

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is read-only.

ssl_server_cert_subject_alt_names Property

Comma-separated lists of alternative subject names for the certificate.

Syntax

def get_ssl_server_cert_subject_alt_names() -> str: ...

ssl_server_cert_subject_alt_names = property(get_ssl_server_cert_subject_alt_names, None)

Default Value

""

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

ssl_server_cert_thumbprint_md5 Property

The MD5 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_md5() -> str: ...

ssl_server_cert_thumbprint_md5 = property(get_ssl_server_cert_thumbprint_md5, None)

Default Value

""

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha1 Property

The SHA-1 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha1() -> str: ...

ssl_server_cert_thumbprint_sha1 = property(get_ssl_server_cert_thumbprint_sha1, None)

Default Value

""

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_thumbprint_sha256 Property

The SHA-256 hash of the certificate.

Syntax

def get_ssl_server_cert_thumbprint_sha256() -> str: ...

ssl_server_cert_thumbprint_sha256 = property(get_ssl_server_cert_thumbprint_sha256, None)

Default Value

""

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

ssl_server_cert_usage Property

The text description of UsageFlags .

Syntax

def get_ssl_server_cert_usage() -> str: ...

ssl_server_cert_usage = property(get_ssl_server_cert_usage, None)

Default Value

""

Remarks

The text description of ssl_server_cert_usage_flags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

ssl_server_cert_usage_flags Property

The flags that show intended use for the certificate.

Syntax

def get_ssl_server_cert_usage_flags() -> int: ...

ssl_server_cert_usage_flags = property(get_ssl_server_cert_usage_flags, None)

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of ssl_server_cert_usage_flags is a combination of the following flags:

Please see the ssl_server_cert_usage property for a text representation of ssl_server_cert_usage_flags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

ssl_server_cert_version Property

The certificate's version number.

Syntax

def get_ssl_server_cert_version() -> str: ...

ssl_server_cert_version = property(get_ssl_server_cert_version, None)

Default Value

""

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

ssl_server_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_server_cert_subject() -> str: ...

ssl_server_cert_subject = property(get_ssl_server_cert_subject, None)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is read-only.

ssl_server_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_server_cert_encoded() -> bytes: ...

ssl_server_cert_encoded = property(get_ssl_server_cert_encoded, None)

Default Value

""

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The ssl_server_cert_store and ssl_server_cert_subject properties also may be used to specify a certificate.

When ssl_server_cert_encoded is set, a search is initiated in the current ssl_server_cert_store for the private key of the certificate. If the key is found, ssl_server_cert_subject is updated to reflect the full subject of the selected certificate; otherwise, ssl_server_cert_subject is set to an empty string.

This property is read-only.

start_byte Property

The byte offset from which to start the upload or download.

Syntax

def get_start_byte() -> int: ...
def set_start_byte(value: int) -> None: ...

start_byte = property(get_start_byte, set_start_byte)

Default Value

0

Remarks

This property may be set to resume an upload or download; it specifies the offset in the file from which to resume. See upload_file and download_file for details about resuming uploads and downloads.

timeout Property

The timeout for the class.

Syntax

def get_timeout() -> int: ...
def set_timeout(value: int) -> None: ...

timeout = property(get_timeout, set_timeout)

Default Value

60

Remarks

If the timeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If timeout is set to a positive value, the class will wait for the operation to complete before returning control.

The class will use do_events to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by timeout seconds when any amount of data is successfully sent or received.

The default value for the timeout property is 60 seconds.

use_resumable_upload Property

Whether to use resumable uploads.

Syntax

def get_use_resumable_upload() -> bool: ...
def set_use_resumable_upload(value: bool) -> None: ...

use_resumable_upload = property(get_use_resumable_upload, set_use_resumable_upload)

Default Value

FALSE

Remarks

This property controls whether simple or resumable uploads are used when upload_file is called. The default value is False (simple uploads are used).

Refer to upload_file for more information.

add_parents Method

Adds folders to the list of parents for a file or folder.

Syntax

def add_parents(resource_id: str, parent_ids: str) -> None: ...

Remarks

This method adds one or more folders, specified by ParentIds, to the list of parents for the file or folder specified by ResourceId.

ParentIds should be specified as a comma-separated list of one or more resource Ids.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

add_query_param Method

Adds a query parameter to the QueryParams properties.

Syntax

def add_query_param(name: str, value: str) -> None: ...

Remarks

This method is used to add a query parameter to the query_params properties. Name specifies the name of the parameter, and Value specifies the value of the parameter.

All specified Values will be URL encoded by the class automatically. Consult the service documentation for details on the available parameters.

add_shared_drive_member Method

Creates a new shared drive member.

Syntax

def add_shared_drive_member(shared_drive_id: str, role: int, permission_type: int, email: str) -> str: ...

Remarks

This is a convenience method that adds a new member to the shared drive specified by SharedDriveId by creating a permission on that shared drive. The Id of the newly-created permission is returned.

Role specifies the member's role. Valid values are:

PermissionType must be one of:

• 0 (ptUser) - A single user.
• 1 (ptGroup) - A group.

Email specifies the email address of the user or the group.

Refer to update_permissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

authorize Method

Get the authorization string required to access the protected resource.

Syntax

def authorize() -> None: ...

Remarks

This method is used to get an access token that is required to access the protected resource. The method will act differently based on what is set in the o_auth_client_profile property and the o_auth_grant_type property. This method is not to be used in conjunction with the authorization property. It should instead be used when setting the o_auth property.

For more information, see the introduction section.

calc_authorization Method

Calculates the Authorization header based on provided credentials.

Syntax

def calc_authorization() -> None: ...

Remarks

This method calculates the authorization value using the values provided in auth_scheme, user and password.

In most cases this method does not need to be called. The class will automatically calculate any required authorization values when a method is called such as get or post.

This method may be useful in cases where the authorization value needs to be calculated prior to sending a request.

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

Remarks

config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

copy_resource Method

Copies a file.

Syntax

def copy_resource(resource_id: str, new_name: str, parent_ids: str) -> str: ...

Remarks

This method copies the file identified by ResourceId and returns the Id of the newly created copy.

The NewName parameter defines the name of the copied file.

The ParentIds parameter should be a comma-separated list of existing folder Ids to use as parents for the copied file. If left blank, the copied file will inherit the same parents of the original.

create_folder Method

Creates a new folder.

Syntax

def create_folder(name: str, parent_ids: str) -> str: ...

Remarks

This method creates a new folder with the specified Name and returns its Id. ParentIds can be a list of existing folder Ids to use as parents for the new folder, or empty string to create the folder at the root of the drive.

If the IncludeFolderProperties configuration setting is True when this method is called, the class will include the metadata held by the first item in the resources properties when creating the folder. (Note that the Name and ParentIds passed to this method will take precedence.)

Google treats files and folders in the same way, and folders are included when listing resources. The resource_type property can be used to determine if a resource is a folder, a file, or a revision of a file.

To list, delete, and update folders use the list_resources, delete_resource, and update_resource methods.

create_shared_drive Method

Creates a new shared drive.

Syntax

def create_shared_drive(name: str, request_id: str) -> str: ...

Remarks

This method creates a new shared drive and returns the newly-created shared drive's Id.

Name is the name of the new shared drive.

RequestId is a unique value used by the server to identify an idempotent request by the current user to create a shared drive. (That is, the server ensures that duplicate shared drives are not created if any given user makes repeated shared drive creation requests with the same Name and RequestId.)

delete_resource Method

Deletes the specified file or folder permanently.

Syntax

def delete_resource(resource_id: str) -> None: ...

Remarks

This method deletes the file or folder specified by ResourceId permanently.

Files and folders are not moved to the trash, they are deleted permanently. You can use trash_resource to move files or folders to the trash.

delete_shared_drive Method

Deletes a shared drive.

Syntax

def delete_shared_drive(shared_drive_id: str) -> None: ...

Remarks

This method deletes the shared drive specified by SharedDriveId.

Note that only members of a shared drive with the prOrganizer (5) role can delete it, and that the shared drive must be empty (or all of its items must be in the trash).

download_file Method

Downloads, and optionally converts, a file.

Syntax

def download_file(resource_id: str, mime_type: str) -> None: ...

Remarks

This method downloads the file specified by ResourceId.

If local_file is set, the file will be saved to the specified location; otherwise, the file data will be held by resource_data.

If the empty string is passed for MimeType, the file will be downloaded as-is. If the file is in one of the Google formats shown in the table below, one of the MIME types shown in the third column can be passed for MimeType instead to convert the file before downloading it.

Download Notes

Downloading an Encrypted File

To decrypt an encrypted file set encryption_algorithm and encryption_password before calling this method. googledrive.LocalFile = "../MyFile.zip"; googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Downloads

The class also supports resuming failed downloads by using the start_byte property. If a download is interrupted, set start_byte to the appropriate offset before calling this method to resume the download. string downloadFile = "../MyFile.zip"; googledrive.LocalFile = downloadFile; googledrive.DownloadFile(googledrive.Resources[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially downloaded file googledrive.StartByte = new FileInfo(downloadFile).Length; googledrive.DownloadFile(googledrive.Resources[0].Id, "");

Resuming Encrypted File Downloads

Resuming encrypted file downloads is only supported when local_file was set in the initial download attempt.

If local_file is set when beginning an encrypted download, the class creates a temporary file in TempPath to hold the encrypted data until the download is complete. If the download is interrupted, DownloadTempFile will be populated with the path of the temporary file that holds the partial data.

To resume, DownloadTempFile must be populated, along with start_byte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to local_file. googledrive.LocalFile = "../MyFile.zip"; googledrive.EncryptionPassword = "password"; googledrive.DownloadFile(googledrive.Resource[0].Id, ""); //The transfer is interrupted and DownloadFile() above fails. Later, resume the download: //Get the size of the partially download temp file googledrive.StartByte = new FileInfo(googledrive.Config("DownloadTempFile")).Length; googledrive.DownloadFile(googledrive.Resource[0].Id, "");

empty_trash Method

Permanently deletes all of the current user's trashed files.

Syntax

def empty_trash() -> None: ...

Remarks

This method permanently deletes all of the current user's trashed files by emptying the trash for their "My Drive".

It is not possible to recover trashed files after this method is called!

get_account_info Method

Gets information about the current user's account and space usage.

Syntax

def get_account_info() -> None: ...

Remarks

This method gets information about the current user's account and space usage, populating the account object property's properties.

get_current_change_marker Method

Gets the most current change marker.

Syntax

def get_current_change_marker() -> None: ...

Remarks

This method populates next_change_marker with the most current change marker available.

Refer to list_changes for more information.

If shared_drive is set, this method will get the most current change marker available for that shared drive's changes.

get_permission_info Method

Gets information about a specific permission.

Syntax

def get_permission_info(resource_id: str, permission_id: str) -> None: ...

Remarks

This method retrieves information about the permission specified by PermissionId on the file, folder, or shared drive specified by ResourceId.

Calling this method will fire the on_permission_list event, and will populate the permissions properties (clearing any previously-held items in the process).

Shared Drive Members

Refer to update_permissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.

get_resource_info Method

Gets information about specific files and folders.

Syntax

def get_resource_info(resource_ids: str) -> None: ...

Remarks

This method retrieves information about the file and folder resources specified by ResourceIds (which should be specified as a comma-separated list of resource Ids).

Calling this method will fire the on_resource_list event once for each resource, and will populate the resources properties (clearing any previously-held items in the process).

Note that, unlike the list_resources and list_children methods, this method uses the resource Ids to retrieve information directly. This means that it does not support paged results or complex search queries (the "q" query parameter), does not need to know whether the resources are in shared drives, etc.

get_shared_drive_info Method

Gets information about a specific shared drive.

Syntax

def get_shared_drive_info(shared_drive_id: str) -> None: ...

Remarks

This method retrieves information about the shared drive specified by SharedDriveId.

Calling this method will fire the on_shared_drive_list event, and will populate the shared_drives properties (clearing any previously-held items in the process).

get_upload_status Method

Gets the status of a resumable upload session.

Syntax

def get_upload_status() -> None: ...

Remarks

This method gets the status of a resumable upload session. Set resume_url before calling this method. After calling this method start_byte will be populated.

interrupt Method

This method interrupts the current method.

Syntax

def interrupt() -> None: ...

Remarks

If there is no method in progress, interrupt simply returns, doing nothing.

list_changes Method

Lists changes to resources and shared drives.

Syntax

def list_changes() -> None: ...

Remarks

This method lists changes to resources and shared drives.

General Usage

When this method is called, it will use the change marker stored in either change_marker or next_change_marker (only one can be populated at a time) to request the next page of changes. This method causes the on_change_list event to fire once for each change, and will also populate the changes properties.

If there are still more changes available to list when this method returns, the change_marker property will be populated. Continue to call this method until change_marker is empty to accumulate all pages of results in the changes properties. (Once there aren't any more changes available to list, the next_change_marker property will be populated instead.) Alternatively, the AccumulatePages configuration setting can be disabled to clear the changes properties every time a page of results is returned.

Calling get_current_change_marker will immediately populate next_change_marker. Regardless of whether it is populated because of a call to get_current_change_marker or to list_changes, next_change_marker is always populated with a value that (at the time of population) points to the most current state. (Since "the most current state" implies that there are no further changes to list, calling list_changes immediately after next_change_marker is populated will not return any further changes.)

Setting change_marker to "1" will cause list_changes to list changes beginning with the very first change available.

Example of Listing Changes // Start listing changes from the beginning, and list a maximum of 10 changes at a time. googledrive.ChangeMarker = "1"; googledrive.Config("MaxResults=10"); // List changes once. googledrive.ListChanges(); do { for (int i = 0; i < googledrive.Changes.Count; i++) { Console.WriteLine(googledrive.Changes[i].ResourceId); Console.WriteLine(googledrive.Changes[i].Time); Console.WriteLine(googledrive.Changes[i].Removed); } // Continue to call ListChanges() until ChangeMarker is the empty string (indicating there // are no more changes to list). googledrive.ListChanges(); } while (googledrive.ChangeMarker.Length > 0); // Now NextChangeMarker will be populated. If we were to call ListChanges() again right now, // nothing would be listed and NextChangeMarker would still be populated. // Wait 2 minutes and then try to list changes again. Thread.Sleep(120000); googledrive.ListChanges(); do { for (int i = 0; i < googledrive.Changes.Count; i++) { Console.WriteLine(googledrive.Changes[i].ResourceId); Console.WriteLine(googledrive.Changes[i].Time); Console.WriteLine(googledrive.Changes[i].Removed); } googledrive.ListChanges(); } while (googledrive.ChangeMarker.Length > 0);

Shared Drive Functionality

When working in the context of shared drives, there are additional properties that can be configured to specify what kinds of changes should returned.

If shared_drive is empty string, then changes for items in shared drives that the user has accessed will be included (in addition to the usual changes for the user's items). Changes to the shared drives themselves which the user is a member of will also be included.

If shared_drive is populated with a shared drive resource Id, then only changes to items within that shared drive, as well as changes to that shared drive itself, will be returned.

A change's change_type will reflect whether it is associated with a file or folder (0), or a shared drive itself (1).

list_children Method

Lists the child resources of one or more folders.

Syntax

def list_children(folder_ids: str) -> None: ...

Remarks

This is a convenience method that works the same way as list_resources, but limits the results to children of one or more folders specified by FolderIds (which should be specified as a comma-separated list of folder resource Ids).

Calling this method will fire the on_resource_list event once for each resource, and will also populate the children properties.

If there are still more child resources available to list when this method returns, the child_marker property will be populated. Continue to call this method until child_marker is empty to accumulate all pages of results in the children properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the children properties every time a page of results is returned.

Note that the string "root" may be used as a folder Id to represent the root folder of a drive.

Refer to list_resources for more information about how listing resources works in general, everything there applies to this method too. // ResourceList event handler. googledrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // List all of the children of the given folder resource. do { googledrive.ListChildren("12978eyuihusd"); for (int i = 0; i < googledrive.Children.Count; i++) { // Process child resources here. } } while (!string.IsNullOrEmpty(googledrive.ChildMarker));

list_parents Method

Lists the parent folders of a file or folder.

Syntax

def list_parents(resource_id: str) -> None: ...

Remarks

This is a convenience method that simply retrieves the parent Ids of the file or folder specified by ResourceId and passes them to get_resource_info.

Refer to get_resource_info for more information.

list_permissions Method

Lists the permissions for a file, folder, or shared drive.

Syntax

def list_permissions(resource_id: str) -> None: ...

Remarks

This method is used to list permissions for the file, folder, or shared drive specified by ResourceId.

Calling this method will fire the on_permission_list event once for each permission, and will also populate the permissions properties.

If there are still more permissions available to list when this method returns, the permission_marker property will be populated. Continue to call this method until permission_marker is empty to accumulate all pages of results in the permissions properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the permissions properties every time a page of results is returned. // PermissionList event handler. googledrive.OnPermissionList += (s, e) => { Console.WriteLine("Permission Id: " + e.Id); }; // List all of the permissions on the given resource. do { googledrive.ListPermissions("fdjhskdf89o3wi"); for (int i = 0; i < googledrive.Permissions.Count; i++) { // Process permissions here. } } while (!string.IsNullOrEmpty(googledrive.PermissionMarker));

Shared Drive Members

Refer to update_permissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once.

Shared Drive Capabilities

To determine the effective capabilities the current user has for shared drives that they're a member of, call list_shared_drives instead and inspect the shared_drive_capabilities property of the returned items.

list_resources Method

Lists files and folders.

Syntax

def list_resources() -> None: ...

Remarks

This method is used to list file and folders. Calling this method will fire the on_resource_list event once for each resource, and will also populate the resources properties.

If there are still more resources available to list when this method returns, the resource_marker property will be populated. Continue to call this method until resource_marker is empty to accumulate all pages of results in the resources properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the resources properties every time a page of results is returned.

Listing Resources

By default, all files and folders in the scope specified by the list_resources_scope property will be returned. The ListResourcesMode configuration setting can be used to specify that only files or only folders should be returned. Refer to the "Result Scopes" section, below, for more information about what the results for each scope are comprised of.

To simply list the children or parents of specific resources, use list_children or list_parents. To retrieve information about specific resources, use get_resource_info.

For more complex queries, refer to the Google Drive API documentation for information on how to construct a search query, then use the add_query_param method to add a query parameter named "q" to the query_params properties before calling this method.

Result Scopes

There are a number of different search scopes which the results of this method can be drawn from, some of which are exclusive to shared drives.

When list_resources is called with list_resources_scope set to the default of lrsUser (0), the results will consist of items that are in the current user's "My Drive" and "Shared with me" spaces.

If list_resources_scope is set to lrsDomain (1), the results will instead consist of items which have been shared to the current user's domain, whether or not the user has actually accessed them.

(To clarify, items shared to a user's domain are only added to their "Shared with me" space once the user accesses them for the first time. So, items shared to a user's domain that they have not actually accessed before would not show up when list_resources_scope is set to lrsUser (0), but would show up when it is set to lrsDomain (1).)

When list_resources_scope is set to lrsSharedDrive (2), the shared_drive property must be set to the resource Id of a shared drive, and the results of this method will consist only of items within that shared drive.

When list_resources_scope is set to lrsAllDrives (3), the results will consist of anything in the user's "My Drive" and "Shared with me" spaces, and all items in all shared drives which the user is a member of.

Note: Under some circumstances, if a user is a member of many shared drives, using the lrsAllDrives (3) will not yield a complete set of results (even with paged results). This is a direct limitation of the Google Drive API, and the only solution is to use a narrower scope. When using the lrsAllDrives (3) scope, you should check the SearchIncomplete configuration setting after calling list_resources; it will return "True" if the result set is incomplete.

How Shared Drives Work

Shared drives are, more than anything else, very similar to a normal user account. Once this is understood, it becomes much easier to understand how shared drives fit into the overall Google Drive architecture.

Just like a real user, a shared drive itself owns the files in its storage space (this is why the permissions for members of a shared drive use the "file organizer" and "organizer" roles instead of the "owner" role). Also like a real user, a shared drive's files can be explicitly shared with other users (even if they aren't members of the shared drive), and with the overall domain.

The difference, of course, is that a shared drive has a defined set of members, all of which have access to everything in the shared drive (though with varying capabilities). Refer to update_permissions, add_shared_drive_member, update_shared_drive_member, and remove_shared_drive_member for more information. // ResourceList event handler. googledrive.OnResourceList += (s, e) => { Console.WriteLine(e.Name); }; // List all of the current user's resources. googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsUser; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker)); // List all of the resources in the specified shared drive. googledrive.SharedDrive = "wfsr789vusijfv"; googledrive.ListResourcesScope = GoogledriveListResourcesScopes.lrsSharedDrive; do { googledrive.ListResources(); for (int i = 0; i < googledrive.Resources.Count; i++) { // Process resources here. } } while (!string.IsNullOrEmpty(googledrive.ResourceMarker));

list_revisions Method

List the revisions of a file.

Syntax

def list_revisions(file_id: str) -> None: ...

Remarks

This method will list the revisions of the specified file. Calling this method will fire the on_resource_list event once for each revision, and will also populate the resources properties. The Revision ID will be help in the ResourceId property.

If the Revision ID is set to the RevisionId configuration setting, the following methods can be used to interact with the specific revision:

• delete_resource
• download_file
• get_resource_info
• update_resource

After these methods are no longer needed, it is recommended to clear to the RevisionId configuration setting to avoid unattended changes to functionality.

list_shared_drives Method

Lists shared drives that the current user is a member of.

Syntax

def list_shared_drives() -> None: ...

Remarks

This method lists the shared drives which the current user is a member of.

Calling this method will fire the on_shared_drive_list event once for each shared drive, and will also populate the shared_drives properties.

If there are still more shared drives available to list when this method returns, the shared_drive_marker property will be populated. Continue to call this method until shared_drive_marker is empty to accumulate all pages of results in the shared_drives properties. Alternatively, the AccumulatePages configuration setting can be disabled to clear the shared_drives properties every time a page of results is returned. // SharedDriveList event handler. googledrive.OnSharedDriveList += (s, e) => { Console.WriteLine(e.Name); }; // List all shared drives the current user is a member of. do { googledrive.ListSharedDrives(); for (int i = 0; i < googledrive.SharedDrives.Count; i++) { // Process shared drives here. } } while (!string.IsNullOrEmpty(googledrive.SharedDriveMarker));

move_resource Method

Moves a file or folder.

Syntax

def move_resource(resource_id: str, new_parent_ids: str) -> None: ...

Remarks

This method "moves" an existing file or folder specified by ResourceId to the folders specified by NewParentIds (which should be specified as a comma-separated list of folder resource Ids).

After this method returns, the folders specified by NewParentIds will be the only parents of in the resource's parent list. If you wish to add additional parents for the resource without removing its existing parents, use add_parents instead.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

remove_parents Method

Removes folders from the list of parents for a file or folder.

Syntax

def remove_parents(resource_id: str, parent_ids: str) -> None: ...

Remarks

This method removes one or more folders, specified by ParentIds, from the list of parents for the file or folder specified by ResourceId.

ParentIds should be specified as a comma-separated list of one or more resource Ids.

Note that resources within a shared drive must always have exactly one parent, and that only shared drive members with the "file organizer" or "organizer" roles can move files and folders within a shared drive.

remove_shared_drive_member Method

Removes an existing shared drive member.

Syntax

def remove_shared_drive_member(shared_drive_id: str, permission_id: str) -> None: ...

Remarks

This is a convenience method that removes an existing member of a shared drive (specified by SharedDriveId) by deleting their associated permission (specified by PermissionId).

Refer to update_permissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

reset Method

Resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

restore_resource Method

Restores a file or folder from the trash.

Syntax

def restore_resource(resource_id: str) -> None: ...

Remarks

This method restores the file or folder specified by ResourceId from the trash.

send_custom_request Method

Sends a custom request to the Google Drive API.

Syntax

def send_custom_request(http_method: str, request_path: str, request_body: str) -> None: ...

Remarks

This method can be used to send arbitrary requests to the Google Drive API.

Valid values for HttpMethod are:

• GET (default if empty)
• HEAD
• POST
• PUT
• PATCH
• DELETE

The value passed for RequestPath must already be URL-encoded in a manner acceptable to the Google Drive API. The RequestBody parameter may be empty if not needed.

Usage

When this method is called, the class does the following:

1. Builds a request URL, including query parameters, as follows:
   • The specified RequestPath is appended to the Google Drive API endpoint, https://www.googleapis.com/drive/v3.
   • All query parameters in the query_params properties are added to the request URL.
2. Sends the request using the specified HttpMethod, the request URL build in step 1, the header information held by authorization and other_headers, and the given RequestBody (if non-empty).
3. Stores the response headers in the parsed_headers properties, and the response body in the specified local_file, or resource_data (using the same logic as download_file).

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

toggle_shared_drive_hidden Method

Hides or unhides a shared drive.

Syntax

def toggle_shared_drive_hidden(shared_drive_id: str, hidden: bool) -> None: ...

Remarks

This method hides or unhides the shared drive specified by SharedDriveId.

If a shared drive is hidden, it will not show up in the Google Drive UI by default (but is still otherwise accessible). Google Drive tracks this setting separately for each user; i.e., each member of a shared drive can choose whether the shared drive should be hidden or not.

trash_resource Method

Moves the specified file or folder to the trash.

Syntax

def trash_resource(resource_id: str) -> None: ...

Remarks

This method moves the file or folder specified by ResourceId to the trash. The resource may be restored from the trash by calling restore_resource.

To permanently delete a resource, call delete_resource. To empty the trash (thus permanently deleting all trashed items), call empty_trash.

update_permissions Method

Create, update, and delete permissions on a file, folder, or shared drive.

Syntax

def update_permissions(resource_id: str) -> None: ...

Remarks

This method is used to create, update, and delete permissions for the file, folder, or shared drive specified by ResourceId.

Each item in the permissions properties has a permission_mod_op property which can be set to one of the following values:

When this method is called, the class will iterate through the permissions properties and execute the requested operation for each permission.

For each permission operation which completes successfully, the class will change its permission_mod_op property back to moNone (0).

Important: The class executes permission operations one-by-one due to how the Google Drive API works. If the class encounters an issue during one of the operations, it will fail with an error, and won't attempt to execute any remaining permission items' operations. The error message will indicate the index of the permission item which caused the error.

Usage

list_permissions must be called before using this method in order to populate the permissions properties with a resource's existing permissions. (When creating new permissions, calling list_permissions first is optional, but still recommended to ensure that the class reflects the latest information.)

To create new permissions, add new items to the permissions properties by incrementing the PermissionCount property as necessary.

For each permission being created or updated, set its properties to the desired values. The permission_mod_op property should be set to a value other than moNone (0) for any permission that should be created, updated, or deleted.

Once the permission items have been set up as desired, call this method. // For simplicity's sake, assume that this file currently has no permissions on it. string fileId = "awd0s79uocijl23wf"; // Add permissions for a couple of users to the file. googledrive.Permissions.Add(new GDrivePermission() { Email = "fakeuser1@example.com", Role = GDrivePermissionRoles.prReader, ModOp = GDrivePermissionModOps.moCreate }); googledrive.Permissions.Add(new GDrivePermission() { Email = "fakeuser2@example.com", Role = GDrivePermissionRoles.prWriter, ModOp = GDrivePermissionModOps.moCreate }); googledrive.UpdatePermissions(fileId); // Now we'll update the permissions on the file, removing one of the users and // changing the other's role to "Commenter". Always list the permissions first // to ensure that the latest data is loaded into the class. googledrive.ListPermissions(fileId); googledrive.Permissions[0].ModOp = GDrivePermissionModOps.moDelete; googledrive.Permissions[1].Role = GDrivePermissionRoles.prCommenter; googledrive.Permissions[1].ModOp = GDrivePermissionModOps.moUpdate; // Now commit the changes. googledrive.UpdatePermissions(fileId);

Transferring Ownership

When creating or updating a permission with the prOwner (3) role on a file or folder, the old owner will have their role downgraded to prWriter (2). The TransferOwnership configuration setting must be set to "True" before calling update_permissions to acknowledge this side effect.

Note that this does not apply to shared drives themselves, or resources in shared drives. It also does not apply when moving resources into or out of shared drives.

Shared Drive Permissions

The permissions on a shared drive itself determine what users are members of the shared drive, and what capabilities they have within the shared drive. Said another way, creating, updating, and deleting the permissions on a shared drive will create, update the capabilities of, and delete shared drive memberships.

Since members are determined by the permissions on a shared drive, this method can of course be used to manipulate one or more shared drive members at once. For simpler use cases which only need to modify one member at a time, the add_shared_drive_member, update_shared_drive_member, and remove_shared_drive_member convenience methods can be used.

Note: Only the ptUser (0) and ptGroup (1) permission types are valid for permissions on a shared drive itself.

Just like in a regular user's drive, permissions can also be applied to files within a shared drive to explicitly share them with specific users (whether they're members of the shared drive or not).

update_resource Method

Updates a file or folder.

Syntax

def update_resource(resource_id: str) -> None: ...

Remarks

This method updates the metadata for the file or folder resource identified by ResourceId. For file resources, the file data can optionally be updated as well.

Usage

There must be a GDriveResource properties whose resource_id property matches the specified ResourceId value before this method is called.

1. If necessary, call get_resource_info or list_resources to ensure an item with the resource's latest information is present in the resources properties.
2. Modify the item's Resource* properties as desired; the following properties are supported:
   • resource_content_accessible
   • resource_description
   • resource_mime_type (only updated for files, if not empty and new file data is uploaded)
   • resource_modified_time (only updated if not empty)
   • resource_name
   • resource_starred
   • resource_trashed
3. For file resources, you may set local_file or resource_data if you wish to update the file data on the server. (Refer to upload_file for more information about simple vs. resumable uploads and encrypting the file data before uploading.)
4. Finally, call this method to update the resource.

// Load the latest information about the resource into the Resources collection. string resId = "2309urjdojwefs0d09u"; googledrive.GetResourceInfo(resId); // We'll update the file resource's name, description, and content. googledrive.ResourceData = "new file content"; googledrive.Resources[0].Name = "CoolStuff2.txt"; googledrive.Resources[0].Description = "This is a text file with cool stuff in it"; googledrive.UpdateResource(resId);

update_shared_drive Method

Updates a shared drive.

Syntax

def update_shared_drive(shared_drive_id: str, new_name: str, set_restrictions: int, unset_restrictions: int) -> None: ...

Remarks

This method updates the name of and/or restrictions applied to the shared drive specified by SharedDriveId.

If the current user is allowed to rename the shared drive (i.e., if the shared_drive_capabilities property has the 0x08000 flag set), then a new name can be provided using the NewName parameter. If the user is not allowed to rename the shared drive, or wishes to preserve its current name, pass empty string for NewName.

Similarly, if the current user is allowed to alter one or more of the shared drive's shared_drive_restrictions (i.e., if the shared_drive_capabilities property has the 0x00002, 0x00004, and/or 0x00010 flags set), then the desired restrictions can be set or unset by including their associated flags, listed below, in the values passed for the SetRestrictions and UnsetRestrictions parameters.

Note that calls to this method will fail if:

• A non-empty string is passed for NewName, but the current user isn't allowed to rename the shared drive.
• The values passed for SetRestrictions and/or UnsetRestrictions contains any flag that corresponds to a restriction the current user isn't allowed to alter.
• Any restriction flag appears in both SetRestrictions and UnsetRestrictions.

Changes requested using this method are "all-or-nothing"; e.g., if both a new name and a new set of restrictions are requested, but the current user isn't allowed to rename the shared drive, the entire request fails.

update_shared_drive_member Method

Updates an existing shared drive member's role.

Syntax

def update_shared_drive_member(shared_drive_id: str, permission_id: str, role: int) -> None: ...

Remarks

This is a convenience method that updates the role of an existing member of a shared drive (specified by SharedDriveId) by modifying their associated permission (specified by PermissionId).

Role specifies the member's role. Valid values are:

Refer to update_permissions for more information about how permissions work in general, how permissions relate to shared drive members, and how to manipulate multiple members at once. string sharedDriveId = "20983euijdsds"; // First, we'll add a new member to the shared drive. The two integer parameters signify: // * The role type. 2 is the "Writer" role, which provides read and write (but not organize) permissions. // * The permission type. 0 means this is a single user (versus a group). // The Id of the new permission we've created on the shared drive--which is what actually causes the user to // be a member of the shared drive--is returned. string permId = googledrive.AddSharedDriveMember(sharedDriveId, 2, 0, "fakeuser@example.com"); // At some point later, perhaps this user has abused their privileges and we wish to revoke their writer // permissions. We change their role to "Commenter", which provides reader and commenting permissions. googledrive.UpdateSharedDriveMember(sharedDriveId, permId, 1); // 1 is the "Commenter" role. // Or perhaps we wish to simply remove the user's shared drive membership completely. googledrive.RemoveSharedDriveMember(sharedDriveId, permId);

upload_file Method

Uploads, and optionally converts, a new file.

Syntax

def upload_file(file_name: str, mime_type: str) -> str: ...

Remarks

This method uploads a new file and returns the Id of the newly-created file resource.

If local_file is set the file will be uploaded from the specified path. If local_file is not set the data in resource_data will be used.

Usage

The name specified by the FileName parameter should include a file extension.

If MimeType is "", the file will be uploaded as-is and its MIME type will be automatically determined. The file can be converted to one of the Google formats by explicitly setting MimeType to one of the MIME types in the table below.

Before calling this method, always set ResourceCount to 0 to clear the stored resource data. Then, if you wish to set file metadata and/or assign parent Ids when the file is uploaded, set ResourceCount to 1 and set the desired properties. (Note that the name and MIME type passed to this method will take precedence.)

To encrypt the file before uploading it, set encryption_algorithm and encryption_password.

Finally, call this method to upload the file, along with any metadata that may be set.

Upload Notes

Google Drive offers two ways to upload a file. For smaller files a simple upload option is provided to upload data in one request. This is the default option. For larger files, uploads can be fragmented into multiple pieces, allowing resuming of uploads that may be interrupted.

Simple

By default the class uses the simple upload mechanism. googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", "");

Resumable

To enable resumable uploads set use_resumable_upload to True. This is recommended for large files. The class will automatically fragment the specified file into smaller pieces and upload each individually. FragmentSize may be set to specify the size of the fragment if desired. The default fragment size is 10 MB.

When use_resumable_upload is set to True and upload_file is called, a resumable upload session is started by the class. resume_url is populated with a URL identifying the session (this value may be needed for additional operations if the upload does not complete normally).

During a resumable upload, the on_fragment_complete event fires after each fragment is uploaded to indicate overall progress. The class also updates start_byte as necessary to indicate the current offset in the file.

If the upload is interrupted for any reason, resuming it is easy. First, verify that resume_url and start_byte are populated (if the same instance of the class is used, they should already be populated, and no special action should be needed). Then call upload_file again to resume the upload at the specified start_byte offset.

Note that if the upload is not resumed after some time the upload session will expire. get_upload_status may be used to check the status of a resumable upload. googledrive.LocalFile = "../MyFile.zip"; googledrive.UploadFile("MyFile.zip", ""); //The transfer is interrupted and UploadFile() above fails. Later, resume the download. //Using the same instance StartByte and ResumeURL are already populated from the previous //upload attempt. googledrive.UploadFile("MyFile.zip", "");

on_change_list Event

Fires once for each change when ListChanges is called.

Syntax

class GoogleDriveChangeListEventParams(object):
  @property
  def resource_id() -> str: ...

  @property
  def shared_drive_id() -> str: ...

  @property
  def removed() -> bool: ...

  @property
  def time() -> str: ...

  @property
  def change_type() -> int: ...

# In class GoogleDrive:
@property
def on_change_list() -> Callable[[GoogleDriveChangeListEventParams], None]: ...
@on_change_list.setter
def on_change_list(event_hook: Callable[[GoogleDriveChangeListEventParams], None]) -> None: ...

Remarks

This event fires once for each change returned when list_changes is called.

ResourceId is the Id of the file or folder to which the change applies.

SharedDriveId is the Id of the shared drive associated with the change.

Removed indicates whether the file or shared drive has been removed from the view of the change list. For example, if a file was permanently deleted or access to it was revoked, this would return True (it would still return False if the file was simply in the trash).

Time is a DateTime string representing the time of the change. This is a combined date-time value (formatted according to RFC 3339).

ChangeType indicates whether this is a file (0) or a shared drive (1) change.

Refer to list_changes for more information.

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

class GoogleDriveEndTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class GoogleDrive:
@property
def on_end_transfer() -> Callable[[GoogleDriveEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[GoogleDriveEndTransferEventParams], None]) -> None: ...

Remarks

The on_end_transfer event is fired when the document text finishes transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class GoogleDriveErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class GoogleDrive:
@property
def on_error() -> Callable[[GoogleDriveErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[GoogleDriveErrorEventParams], None]) -> None: ...

Remarks

The on_error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

on_fragment_complete Event

Fires after each fragment of a resumable upload is completed.

Syntax

class GoogleDriveFragmentCompleteEventParams(object):
  @property
  def fragment_number() -> int: ...

  @property
  def fragment_count() -> int: ...

  @property
  def interrupt() -> bool: ...
  @interrupt.setter
  def interrupt(value) -> None: ...

# In class GoogleDrive:
@property
def on_fragment_complete() -> Callable[[GoogleDriveFragmentCompleteEventParams], None]: ...
@on_fragment_complete.setter
def on_fragment_complete(event_hook: Callable[[GoogleDriveFragmentCompleteEventParams], None]) -> None: ...

Remarks

When use_resumable_upload is True and upload_file is called, this event will fire after each fragment is uploaded, providing an indication of overall upload progress.

FragmentNumber is the number of the current fragment that has completed. This value starts at 1.

FragmentCount is the total number of fragments that will be uploaded.

Interrupt can be set to True to interrupt the upload. The upload may be resumed later.

on_header Event

Fired every time a header line comes in.

Syntax

class GoogleDriveHeaderEventParams(object):
  @property
  def field() -> str: ...

  @property
  def value() -> str: ...

# In class GoogleDrive:
@property
def on_header() -> Callable[[GoogleDriveHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[GoogleDriveHeaderEventParams], None]) -> None: ...

Remarks

The Field parameter contains the name of the HTTP header (which is the same as it is delivered). The Value parameter contains the header contents.

If the header line being retrieved is a continuation header line, then the Field parameter contains "" (empty string).

on_log Event

Fired once for each log message.

Syntax

class GoogleDriveLogEventParams(object):
  @property
  def log_level() -> int: ...

  @property
  def message() -> str: ...

  @property
  def log_type() -> str: ...

# In class GoogleDrive:
@property
def on_log() -> Callable[[GoogleDriveLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[GoogleDriveLogEventParams], None]) -> None: ...

Remarks

This event is fired once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are as follows:

The value 1 (Info) logs basic information, including the URL, HTTP version, and status details.

The value 2 (Verbose) logs additional information about the request and response.

The value 3 (Debug) logs the headers and body for both the request and response, as well as additional debug information (if any).

Message is the log entry.

LogType identifies the type of log entry. Possible values are as follows:

• "Info"
• "RequestHeaders"
• "ResponseHeaders"
• "RequestBody"
• "ResponseBody"
• "ProxyRequest"
• "ProxyResponse"
• "FirewallRequest"
• "FirewallResponse"

on_permission_list Event

This event fires once for each permission returned when listing permissions.

Syntax

class GoogleDrivePermissionListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def role() -> int: ...

  @property
  def permission_type() -> int: ...

  @property
  def email() -> str: ...

  @property
  def domain() -> str: ...

  @property
  def allow_file_discovery() -> bool: ...

# In class GoogleDrive:
@property
def on_permission_list() -> Callable[[GoogleDrivePermissionListEventParams], None]: ...
@on_permission_list.setter
def on_permission_list(event_hook: Callable[[GoogleDrivePermissionListEventParams], None]) -> None: ...

Remarks

When calling list_permissions this event will fire once for each permission that is returned.

Id is the Id of the permission.

Role is the role of the permission. Possible values are:

PermissionType indicates the type of the permission. Possible values are:

Email holds the email address of the user or group that the permission applies to when Type is 0 or 1.

Domain holds the domain that the permission applies to when Type is 2.

AllowFileDiscovery signifies whether the permission allows the file to be discovered through search. It is only applicable when Type is 2 or 3.

on_progress Event

Fires during an upload or download to indicate transfer progress.

Syntax

class GoogleDriveProgressEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def total_bytes() -> int: ...

  @property
  def percent_done() -> int: ...

# In class GoogleDrive:
@property
def on_progress() -> Callable[[GoogleDriveProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[GoogleDriveProgressEventParams], None]) -> None: ...

Remarks

This event fires during an upload or download to indicate the progress of the transfer of the entire request. By default, this event will fire each time PercentDone increases by one percent; the ProgressStep configuration setting can be used to alter this behavior.

Direction indicates whether the transfer is an upload (0) or a download (1).

BytesTransferred reflects the number of bytes that have been transferred so far, or 0 if the transfer is starting (however, see note below).

TotalBytes reflects the total number of bytes that are to be transferred, or -1 if the total is unknown. This amount includes the size of everything in the request like HTTP headers.

PercentDone reflects the overall progress of the transfer, or -1 if the progress cannot be calculated.

Note: By default, the class tracks transfer progress absolutely. If a transfer is interrupted and later resumed, the values reported by this event upon and after resumption will account for the data that was transferred before the interruption.

For example, if 10MB of data was successfully transferred before the interruption, then this event will fire with a BytesTransferred value of 10485760 (10MB) when the transfer is first resumed, and then continue to fire with successively greater values as usual.

This behavior can be changed by disabling the ProgressAbsolute configuration setting, in which case the class will treat resumed transfers as "new" transfers. In this case, the BytesTransferred parameter will always be 0 the first time this event fires, regardless of whether the transfer is new or being resumed.

on_resource_list Event

Fires once for each resource returned when listing resources.

Syntax

class GoogleDriveResourceListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def extension() -> str: ...

  @property
  def description() -> str: ...

  @property
  def resource_type() -> int: ...

  @property
  def shared_drive_id() -> str: ...

  @property
  def created_time() -> str: ...

  @property
  def modified_time() -> str: ...

  @property
  def size() -> int: ...

  @property
  def trashed() -> bool: ...

# In class GoogleDrive:
@property
def on_resource_list() -> Callable[[GoogleDriveResourceListEventParams], None]: ...
@on_resource_list.setter
def on_resource_list(event_hook: Callable[[GoogleDriveResourceListEventParams], None]) -> None: ...

Remarks

This event fires once for each resource returned when list_resources, list_children, list_parents, or get_resource_info is called.

Id is the Id of the resource.

Name holds the resource's name.

Extension is the file extension.

Description holds a short description of the resource (if any).

ResourceType indicates whether the resource is a file or folder. Possible values are:

SharedDriveId is the Id of the shared drive which the resource is in, or empty string if it is not in a shared drive.

CreatedTime holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

ModifiedTime holds a DateTime string representing the last modified date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Size holds the size of the file in bytes. This is only applicable to files.

Trashed indicates whether the resource is in the trash.

on_shared_drive_list Event

Fires once for each shared drive returned when listing shared drives.

Syntax

class GoogleDriveSharedDriveListEventParams(object):
  @property
  def id() -> str: ...

  @property
  def name() -> str: ...

  @property
  def created_time() -> str: ...

  @property
  def hidden() -> bool: ...

  @property
  def capabilities() -> int: ...

  @property
  def restrictions() -> int: ...

# In class GoogleDrive:
@property
def on_shared_drive_list() -> Callable[[GoogleDriveSharedDriveListEventParams], None]: ...
@on_shared_drive_list.setter
def on_shared_drive_list(event_hook: Callable[[GoogleDriveSharedDriveListEventParams], None]) -> None: ...

Remarks

This event fires once for each shared drive returned when list_shared_drives is called.

Id is the Id of the shared drive.

Name holds the shared drive's name.

CreatedTime holds a DateTime string representing the creation date of the resource. This is a combined date-time value (formatted according to RFC 3339).

Hidden indicates whether the shared drive is hidden from default view (i.e., whether it is shown by default in the Google Drive UI).

Capabilities describes the effective capabilities that the current user has for the shared drive. The value is a bit field comprised of one or more of the following, OR'ed together:

Restrictions describes any restrictions that apply to the shared drive and/or its contents. The value is a bit field comprised of one or more of the following, OR'ed together:

on_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class GoogleDriveSSLServerAuthenticationEventParams(object):
  @property
  def cert_encoded() -> bytes: ...

  @property
  def cert_subject() -> str: ...

  @property
  def cert_issuer() -> str: ...

  @property
  def status() -> str: ...

  @property
  def accept() -> bool: ...
  @accept.setter
  def accept(value) -> None: ...

# In class GoogleDrive:
@property
def on_ssl_server_authentication() -> Callable[[GoogleDriveSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[GoogleDriveSSLServerAuthenticationEventParams], None]) -> None: ...

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

on_ssl_status Event

Fired when secure connection progress messages are available.

Syntax

class GoogleDriveSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class GoogleDrive:
@property
def on_ssl_status() -> Callable[[GoogleDriveSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[GoogleDriveSSLStatusEventParams], None]) -> None: ...

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

on_start_transfer Event

This event fires when a document starts transferring (after the headers).

Syntax

class GoogleDriveStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class GoogleDrive:
@property
def on_start_transfer() -> Callable[[GoogleDriveStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[GoogleDriveStartTransferEventParams], None]) -> None: ...

Remarks

The on_start_transfer event is fired when the document text starts transferring from the server to the local host.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

on_transfer Event

Fired while a document transfers (delivers document).

Syntax

class GoogleDriveTransferEventParams(object):
  @property
  def direction() -> int: ...

  @property
  def bytes_transferred() -> int: ...

  @property
  def percent_done() -> int: ...

  @property
  def text() -> bytes: ...

# In class GoogleDrive:
@property
def on_transfer() -> Callable[[GoogleDriveTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[GoogleDriveTransferEventParams], None]) -> None: ...

Remarks

The Text parameter contains the portion of the document text being received. It is empty if data are being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text (excluding HTTP response headers).

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

The PercentDone parameter shows the progress of the transfer in the corresponding direction. If PercentDone can not be calculated the value will be -1.

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

GoogleDrive Config Settings

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the config method.

GoogleDrive Config Settings

OAuth Config Settings

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

Socket Config Settings

Base Config Settings

GoogleDrive Errors

Common Errors

The class may also return one of the following error codes, which are inherited from other classes.

HTTP Errors

The class may also return one of the following error codes, which are inherited from other classes.

TCPClient Errors

SSL Errors

TCP/IP Errors