GoogleStorage Class

Properties   Methods   Events   Config Settings   Errors  

The GoogleStorage class implements the Google Storage for Developers API.

Syntax

class cloudstorage.GoogleStorage

Remarks

GoogleStorage allows you to easily manage storing and retrieving files using the Google Storage for Developers service.

Before using the class you must have a valid Google Storage account.

Authentication

This class requires authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth* properties 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: GoogleStorage googlestorage = new GoogleStorage(); googlestorage.OAuth.ClientProfile = OAuthClientProfiles.cocpApplication; googlestorage.OAuth.GrantType = OAuthGrantTypes.cogtAuthorizationCode; googlestorage.OAuth.ClientId = CLIENT_ID; googlestorage.OAuth.ClientSecret = CLIENT_SECRET; googlestorage.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

External OAuth Support

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/cloud-platform"; oauth.ServerAuthURL = "https://accounts.google.com/o/oauth2/auth"; oauth.ServerTokenURL = "https://accounts.google.com/o/oauth2/token"; oauth.GrantType = OauthGrantTypes.ogtAuthorizationCode; googlestorage.Authorization = oauth.GetAuthorization(); Consult the documentation for the service for more information about supported scope values and more details on OAuth authentication.

Once you have a valid Google Storage account you can start creating buckets in your account using create_bucket. The buckets are place holders for your objects allowing you to access them by http URLs. You can then add objects to any of your buckets using create_object.

There are other methods such as list_buckets, list_objects, get_object, delete_object etc. that further enable you to manage your Google Storage data store.

When authenticating via OAuth the project_id property is also required.

Alternatively, this service also supports authenticating by setting the AccessKey and SecretKey configuration settings.

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.

access_policy Property

The canned access policy to apply to a bucket or object.

Syntax

def get_access_policy() -> int: ...
def set_access_policy(value: int) -> None: ...

access_policy = property(get_access_policy, set_access_policy)

Default Value

0

Remarks

This property specifies the canned access policy that should be applied to a bucket or object when one of the following methods is called:

• copy_object (for the destination object)
• create_bucket
• create_object
• start_multipart_upload
• update_bucket_acl
• update_object_acl

Valid values are:

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 OAuth* properties, using the OAuth class or a separate process. If using the OAuth* properties, then the authorization property will not be used.

Bearer ACCESS_TOKEN

bucket Property

Selects a bucket.

Syntax

def get_bucket() -> str: ...
def set_bucket(value: str) -> None: ...

bucket = property(get_bucket, set_bucket)

Default Value

""

Remarks

This property selects a bucket, by name, for the class to operate against. It must be set before attempting most operations.

buckets_count Property

The number of records in the Buckets arrays.

Syntax

def get_buckets_count() -> int: ...

buckets_count = property(get_buckets_count, None)

Default Value

0

Remarks

This property controls the size of the following arrays:

• buckets_creation_date
• buckets_name
• buckets_owner_display_name
• buckets_owner_id

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

This property is read-only.

buckets_creation_date Property

The property includes the creation date of the bucket.

Syntax

def get_buckets_creation_date(buckets_index: int) -> str: ...

Default Value

""

Remarks

The property includes the creation date of the bucket.

This property reflects the creation date of the bucket.

The buckets_index parameter specifies the index of the item in the array. The size of the array is controlled by the buckets_count property.

This property is read-only.

buckets_name Property

The property contains the name of the bucket.

Syntax

def get_buckets_name(buckets_index: int) -> str: ...

Default Value

""

Remarks

The property contains the name of the bucket.

This property reflects the name of the bucket.

The buckets_index parameter specifies the index of the item in the array. The size of the array is controlled by the buckets_count property.

This property is read-only.

buckets_owner_display_name Property

The property contains the display name of the bucket's owner.

Syntax

def get_buckets_owner_display_name(buckets_index: int) -> str: ...

Default Value

""

Remarks

The property contains the display name of the bucket's owner.

This property reflects the display name of the bucket's owner.

The buckets_index parameter specifies the index of the item in the array. The size of the array is controlled by the buckets_count property.

This property is read-only.

buckets_owner_id Property

The property contains the Id of the bucket's owner.

Syntax

def get_buckets_owner_id(buckets_index: int) -> str: ...

Default Value

""

Remarks

The property contains the Id of the bucket's owner.

This property reflects the Id of the bucket's owner.

The buckets_index parameter specifies the index of the item in the array. The size of the array is controlled by the buckets_count property.

This property is read-only.

content_disposition Property

Content disposition to send for an object.

Syntax

def get_content_disposition() -> str: ...
def set_content_disposition(value: str) -> None: ...

content_disposition = property(get_content_disposition, set_content_disposition)

Default Value

""

Remarks

This property can be set before calling create_object to have its value submitted as the object's Content-Disposition header value. This same value will then be returned in the Content-Disposition header by the server anytime the object is downloaded.

content_type Property

Content type to send for an object.

Syntax

def get_content_type() -> str: ...
def set_content_type(value: str) -> None: ...

content_type = property(get_content_type, set_content_type)

Default Value

""

Remarks

This property can be set before calling create_object to have its value submitted as the object's Content-Type header value. This same value will then be returned in the Content-Type header by the server anytime the object is downloaded.

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

This property tells the class whether or not 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

This property tells the class whether or not to automatically detect and use firewall system settings, if available.

firewall_type Property

This property determines 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

This property determines the type of firewall to connect through. The applicable values are as follows:

firewall_host Property

This property contains the name or IP address of 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

This property contains the name or IP address of 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

This property contains 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

This property contains 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

This property contains 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

This property contains 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

This property contains a user name if authentication is to be used 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

This property contains a user name if authentication is to be used connecting through a firewall. If the firewall_host is specified, this property and firewall_password properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

follow_redirects Property

Determines what happens when the server issues a redirect.

Syntax

def get_follow_redirects() -> int: ...
def set_follow_redirects(value: int) -> None: ...

follow_redirects = property(get_follow_redirects, set_follow_redirects)

Default Value

0

Remarks

This property specifies how the class should behave when the server returns a redirect response (e.g. "Object Moved"). Valid values are:

idle Property

The current status of the class.

Syntax

def get_idle() -> bool: ...

idle = property(get_idle, None)

Default Value

TRUE

Remarks

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

This property is read-only.

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 create_object or upload_part; and as the destination file when calling get_object.

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

The local_host 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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.

metadata_count Property

The number of records in the Metadata arrays.

Syntax

def get_metadata_count() -> int: ...
def set_metadata_count(value: int) -> None: ...

metadata_count = property(get_metadata_count, set_metadata_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• metadata_name
• metadata_value

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

metadata_name Property

The property contains the name of the metadata item.

Syntax

def get_metadata_name(metadata_index: int) -> str: ...
def set_metadata_name(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

The property contains the name of the metadata item.

This property specifies the name of the metadata item. The server stores metadata names in lowercase.

Note: The class will automatically prepend the service-appropriate prefix (e.g., x-amz-meta-, x-goog-meta-) to this value when submitting metadata items to the server and will automatically strip that prefix from this value when this property is populated.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

metadata_value Property

This property contains the value of the metadata item.

Syntax

def get_metadata_value(metadata_index: int) -> str: ...
def set_metadata_value(metadata_index: int, value: str) -> None: ...

Default Value

""

Remarks

This property contains the value of the metadata item.

This property specifies the value of the metadata item.

The metadata_index parameter specifies the index of the item in the array. The size of the array is controlled by the metadata_count property.

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_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.

object_data Property

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

Syntax

def get_object_data() -> bytes: ...
def set_object_data(value: bytes) -> None: ...

object_data = property(get_object_data, set_object_data)

Default Value

""

Remarks

This property is populated with object data after calling get_object if local_file is not set.

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

object_delimiter Property

The delimiter string to use when listing objects.

Syntax

def get_object_delimiter() -> str: ...
def set_object_delimiter(value: str) -> None: ...

object_delimiter = property(get_object_delimiter, set_object_delimiter)

Default Value

""

Remarks

If this property is non-empty when list_objects or list_versions is called, any objects (or object versions) whose names contain the same string between the specified object_prefix and the first occurrence of the specified delimiter that follow will be rolled up into a "common prefix" element, which is returned in place of the individual objects themselves.

The on_prefix_list event will fire once for each common prefix returned. If the StorePrefixList configuration setting is enabled, the class will also populate the PrefixCount and Prefix[i] configuration settings

Object Hierarchy Traversal

By using the object_delimiter and object_prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With object_delimiter set to /, we can set object_prefix to successively "deeper" values before calling list_objects or list_versions for the following effect:

object_marker Property

A marker indicating what page of objects to return next.

Syntax

def get_object_marker() -> str: ...
def set_object_marker(value: str) -> None: ...

object_marker = property(get_object_marker, set_object_marker)

Default Value

""

Remarks

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

Refer to list_objects for more information.

object_prefix Property

A prefix used to restrict the results returned when listing objects.

Syntax

def get_object_prefix() -> str: ...
def set_object_prefix(value: str) -> None: ...

object_prefix = property(get_object_prefix, set_object_prefix)

Default Value

""

Remarks

This property, if non-empty, is used to restrict the results returned by list_objects (or list_versions) to only the objects (or object versions) whose names begin with the given value.

Object Hierarchy Traversal

By using the object_delimiter and object_prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With object_delimiter set to /, we can set object_prefix to successively "deeper" values before calling list_objects or list_versions for the following effect:

objects_count Property

The number of records in the Objects arrays.

Syntax

def get_objects_count() -> int: ...
def set_objects_count(value: int) -> None: ...

objects_count = property(get_objects_count, set_objects_count)

Default Value

0

Remarks

This property controls the size of the following arrays:

• objects_deleted
• objects_e_tag
• objects_last_modified
• objects_latest_version
• objects_name
• objects_owner_display_name
• objects_owner_id
• objects_size
• objects_storage_class
• objects_upload_id
• objects_version_id

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

objects_deleted Property

This property specifies whether this object version is a delete marker.

Syntax

def get_objects_deleted(objects_index: int) -> bool: ...

Default Value

FALSE

Remarks

This property specifies whether this object version is a delete marker.

This property indicates whether this object version is a delete marker. Delete markers are created when an object in a versioning-enabled bucket is "deleted" (i.e., instead of actually deleting any data); refer to delete_object for more information.

This is applicable only when list_versions is called, or when get_object_info is called while version_id is nonempty.; False in all other cases.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_e_tag Property

This property contains the ETag of the object.

Syntax

def get_objects_e_tag(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the ETag of the object.

This property reflects the ETag of the object.

An object's ETag is an MD5 hash of its contents, and as such, it can be used to determine whether its contents have been modified.

This is not applicable when list_multipart_uploads is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_last_modified Property

This property contains the last modified time of the object.

Syntax

def get_objects_last_modified(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the last modified time of the object.

This property reflects the last modified time of the object.

This is not applicable when list_multipart_uploads is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_latest_version Property

This property specifies whether this is the latest object version.

Syntax

def get_objects_latest_version(objects_index: int) -> bool: ...

Default Value

TRUE

Remarks

This property specifies whether this is the latest object version.

This property indicates whether this object version is the latest version available.

This is applicable only when list_versions is called.; True in all other cases.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_name Property

This property contains the name (key) of the object.

Syntax

def get_objects_name(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the name (key) of the object.

This property reflects the name (key) of the object.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_owner_display_name Property

This property contains the display name of the object's owner.

Syntax

def get_objects_owner_display_name(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the display name of the object's owner.

This property reflects the display name of the object's owner.

This is not applicable when get_object_info is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_owner_id Property

This property contains the Id of the object's owner.

Syntax

def get_objects_owner_id(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Id of the object's owner.

This property reflects the Id of the object's owner.

This is not applicable when get_object_info is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_size Property

This property contains the size of the object.

Syntax

def get_objects_size(objects_index: int) -> int: ...

Default Value

0

Remarks

This property contains the size of the object.

This property reflects the size of the object in bytes.

This is not applicable when list_multipart_uploads is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_storage_class Property

This property contains the storage class of the object.

Syntax

def get_objects_storage_class(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the storage class of the object.

This property reflects the storage class of the object.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_upload_id Property

This property contains the upload Id of the multipart upload.

Syntax

def get_objects_upload_id(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the upload Id of the multipart upload.

This property reflects the upload Id of the multipart upload.

It is applicable only when list_multipart_uploads is called.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

objects_version_id Property

This property contains the Id of the object version.

Syntax

def get_objects_version_id(objects_index: int) -> str: ...

Default Value

""

Remarks

This property contains the Id of the object version.

This property reflects the Id of the object version.

Note: The string null is a valid version Id.

This is applicable only when list_versions is called, or when get_object_info is called while version_id is nonempty.; empty in all other cases.

The objects_index parameter specifies the index of the item in the array. The size of the array is controlled by the objects_count property.

This property is read-only.

other_headers Property

This property includes 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 get_object. 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.

project_id Property

The Id of the project.

Syntax

def get_project_id() -> str: ...
def set_project_id(value: str) -> None: ...

project_id = property(get_project_id, set_project_id)

Default Value

""

Remarks

This property specifies the user's project Id obtained from the Google API Console. It is required when authentication using OAuth 2.0.

proxy_auth_scheme Property

This property is used to tell the class which 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

This property is used to tell the class which 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 component 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

This property tells the class whether or not 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

This property tells the class whether or not to automatically detect and use proxy system settings, if available. The default value is False.

proxy_password Property

This property contains 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

This property contains 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 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

This property contains 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

This property contains 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

This property determines 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

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

proxy_user Property

This property contains 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

This property contains 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.

range Property

The range of bytes to request.

Syntax

def get_range() -> str: ...
def set_range(value: str) -> None: ...

range = property(get_range, set_range)

Default Value

""

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a get_object request is being constructed, a header like Range: bytes=Range will be added to the request, with Range substituted with the specified value.

There are two valid formats for this property's value:

• StartByte-
• StartByte-EndByte

Note: If the start_byte property is greater than zero when get_object is called (i.e., when a download is being resumed), and this property is non-empty, the class will automatically advance the StartByte value in the specified range by start_byte bytes when sending the Range header to the server. This ensures that the previously-downloaded data at the start of the specified range is not downloaded again when the download is resumed.

region Property

The location the class will create buckets in.

Syntax

def get_region() -> str: ...
def set_region(value: str) -> None: ...

region = property(get_region, set_region)

Default Value

"us"

Remarks

This property control which location the class will create buckets in. By default the class uses us, the US-regional location. This property should be changed to create buckets in other locations.

Regions:

The class will always convert this property's value to lowercase. If this property is cleared, the class will reset it to the default value.

ssl_accept_server_cert_encoded Property

This is 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

This is 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_encoded Property

This is 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

This is 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_cert_store Property

This is 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

This is 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 PFXFile, this property must be set to the name of the file. When the type is PFXBlob, 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

This is 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

This is 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 Property

This is 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

This is 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_provider Property

This specifies the 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:

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_encoded Property

This is 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

This is 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 resume the 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 specifies the byte offset from which to resume a download initiated by get_object; refer to its documentation for more information.

timeout Property

A 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.

Please note that by default, all timeouts are inactivity timeouts, i.e. 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_ssl Property

Whether to use SSL/TLS when connecting.

Syntax

def get_use_ssl() -> bool: ...
def set_use_ssl(value: bool) -> None: ...

use_ssl = property(get_use_ssl, set_use_ssl)

Default Value

TRUE

Remarks

This property specifies whether the class should use SSL/TLS when connecting.

use_virtual_hosting Property

Determines which style request to use.

Syntax

def get_use_virtual_hosting() -> bool: ...
def set_use_virtual_hosting(value: bool) -> None: ...

use_virtual_hosting = property(get_use_virtual_hosting, set_use_virtual_hosting)

Default Value

TRUE

Remarks

If set to True (default), buckets will be referenced in the request using the hosted-style request: http://yourbucket.storage.googleapis.com/yourobject. If False, the class will use the path-style request: http://storage.googleapis.com/yourbucket/yourobject.

NOTE: When set to True, there are more limitations when choosing a bucket name due to DNS server naming restrictions. See Google's documentation for more detailed naming information.

version_id Property

The object version to make requests against.

Syntax

def get_version_id() -> str: ...
def set_version_id(value: str) -> None: ...

version_id = property(get_version_id, set_version_id)

Default Value

""

Remarks

This property can be set to the Id of a specific object version before calling the following methods in order to make requests against the specified object version instead of the base object; refer to each one's documentation for more information:

• copy_object (to copy from a specific object version)
• delete_object
• get_link (to build a link for a specific object version)
• get_object
• get_object_info
• send_custom_request
• update_object_acl

Refer to Amazon's Versioning documentation for more information about versioning.

versioning_enabled Property

Controls whether versioning is enabled for the currently selected bucket.

Syntax

def get_versioning_enabled() -> bool: ...
def set_versioning_enabled(value: bool) -> None: ...

versioning_enabled = property(get_versioning_enabled, set_versioning_enabled)

Default Value

FALSE

Remarks

This property can be used to query and control whether the bucket currently selected by bucket has versioning enabled.

Note that if bucket is empty, or refers to a bucket that does not exist, this property will always return False when queried, and any attempts to set it will fail.

Refer to Amazon's Versioning documentation for more information about versioning.

version_marker Property

A marker indicating what page of object versions to return next.

Syntax

def get_version_marker() -> str: ...
def set_version_marker(value: str) -> None: ...

version_marker = property(get_version_marker, set_version_marker)

Default Value

""

Remarks

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

Refer to list_versions for more information.

add_metadata Method

Adds a metadata item to the Metadata properties.

Syntax

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

Remarks

This method adds a metadata item to the Metadata* properties. Name specifies the name of the item, and Value specifies the value of the item. Keep in mind that the server stores metadata names in lowercase.

If Name begins with a service-specific metadata (e.g., x-amz-meta-, x-goog-meta-, etc.), it will be stripped off. The class will take care of prepending it when sending metadata to the server.

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 QueryaParam* 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.

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 OAuth* properties.

For more information, see the introduction section.

bucket_exists Method

Checks whether the bucket exists.

Syntax

def bucket_exists() -> bool: ...

Remarks

This method checks whether the bucket specified by bucket exists, returning True if so or False if not.

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.

check_versioning_enabled Method

Checks whether versioning is enabled for the currently selected bucket.

Syntax

def check_versioning_enabled() -> bool: ...

Remarks

This method can be used to check whether the bucket currently selected by bucket has versioning enabled.

Note that if bucket is empty, or refers to a bucket that does not exist, this method will always return False when queried.

Refer to Amazon's Versioning documentation for more information about versioning.

compose_objects Method

Creates a composed object using multiple objects already on the server.

Syntax

def compose_objects(composed_object_name: str) -> None: ...

Remarks

This method is used to compose objects on the server. Object composition is a server-side method of building an object by concatenating multiple existing objects together. This feature is a simpler alternative to the typical multipart-upload method of building objects.

A composed object looks and acts just like a regular object. However, its data is determined by its component objects (that is, the objects that make it up) and the order in which they are composed together.

To use this method, specify the names of the objects that should be composed together using the objects property. When this method is called, the ComposedObjectName parameter determines what name is given to the resulting composed object. See the following code snippet for examples: // Upload some objects to start with. Let's assume we have some text files to upload. for (int i = 1; i <= 3; i++) { gstorage.LocalFile = "file" + i + ".txt"; gstorage.CreateObject("file" + i + ".txt"); } // Compose a new object. SetObjectNames("file1.txt", "file2.txt", "file3.txt"); gstorage.ComposeObjects("composed1.txt"); // Compose a new object using a composed object. SetObjectNames("file1.txt", "composed1.txt"); gstorage.ComposeObjects("composed2.txt"); // Compose onto an existing composed object. // (Similar to appending, but all server-side, no uploading needed.) SetObjectNames("file1.txt", "file2.txt"); gstorage.ComposeObjects("composed3.txt"); SetObjectNames("composed3.txt", "file3.txt"); gstorage.ComposeObjects("composed3.txt"); // Compose a new object using the same object twice. SetObjectNames("file1.txt", "file1.txt"); gstorage.ComposeObjects("composed4.txt"); // Compose a composed object onto itself. SetObjectNames("composed4.txt", "composed4.txt"); gstorage.ComposeObjects("composed4.txt"); Assume we have this helper method for the above code: void SetObjectNames(params string[] names) { gstorage.Objects.Clear(); foreach (string name in names) gstorage.Objects.Add(new S3Object(name, "", 0, "", "", "", "", "")); }

Object composition is a powerful and flexible feature. However, there are some things to keep in mind when doing object composition:

• The order of the object names in the objects property is the order that they will be concatenated in when they are composed.
• Objects from multiple buckets cannot be composed together.
• No more than 32 object names may be specified in a single compose 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_object Method

Copies an object.

Syntax

def copy_object(src_object_name: str, dest_bucket: str, dest_object_name: str) -> None: ...

Remarks

This method copies the object specified by SrcObjectName (in the bucket currently selected by bucket) to the object specified by DestObjectName in DestBucket. If DestBucket is empty, the bucket specified by bucket is used as the destination bucket.

If the version_id property is non-empty, the specified version of the source object will be used as the copy source. In this case, DestObjectName may be the same as SrcObjectName to "promote" the version, copying its contents back to the base object.

If there are any metadata items present in the Metadata* properties, they will set on the destination object; otherwise, the server will copy any metadata items present on the source object to the destination object.

Notes:

• Objects may only be copied to buckets that exist within the same region.
• Objects larger than 5GB cannot be copied using this method. To copy such objects, start a new multipart upload for the destination object using start_multipart_upload, and then use the copy_part method to create parts for said multipart upload using the source object's data.

create_bucket Method

Creates a new bucket.

Syntax

def create_bucket() -> None: ...

Remarks

This method creates a new bucket using the name specified by the bucket property. The bucket is created in the region specified by the region property.

create_object Method

Creates a new object in the currently selected bucket.

Syntax

def create_object(object_name: str) -> None: ...

Remarks

This method creates a new object named Object in the bucket currently selected by bucket. If there are any metadata items present in the Metadata* properties, they will included in the creation request.

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

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

This method can automatically handle the multipart upload of objects (See Below). If it is desired to manually take control of the multipart upload process see start_multipart_upload.

delete_bucket Method

Deletes a bucket.

Syntax

def delete_bucket() -> None: ...

Remarks

This method deletes the bucket currently selected by bucket. Note that bucket names share a global namespace, and it may not be possible to recreate a deleted bucket if its name has been taken by another user in the meantime.

delete_object Method

Deletes an object.

Syntax

def delete_object(object_name: str) -> None: ...

Remarks

This method deletes the object specified by ObjectName in the bucket currently selected by bucket.

If the version_id property is non-empty, this method deletes the specified version of the object instead. Note that deleting the latest version of an object will not automatically "restore" the previous version.

disable_versioning Method

Disables versioning for the currently selected bucket.

Syntax

def disable_versioning() -> None: ...

Remarks

This method can be used to disable versioning for the bucket currently selected by bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

do_events Method

Processes events from the internal message queue.

Syntax

def do_events() -> None: ...

Remarks

When do_events is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

enable_versioning Method

Enables versioning for the currently selected bucket.

Syntax

def enable_versioning() -> None: ...

Remarks

This method can be used to enable versioning for the bucket currently selected by bucket.

Refer to Amazon's Versioning documentation for more information about versioning.

get_bucket_location Method

Gets a bucket's location.

Syntax

def get_bucket_location() -> str: ...

Remarks

This method retrieves and returns the location (i.e., region) of the bucket currently selected by bucket.

get_object Method

Downloads an object.

Syntax

def get_object(object_name: str) -> None: ...

Remarks

This methods downloads the object specified by ObjectName in the bucket currently selected by bucket. If the version_id property is non-empty, the specified version of the object is downloaded instead. The range property can be used to download a specific range of bytes from the object.

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

To download and decrypt an encrypted object, set encryption_algorithm and encryption_password before calling this method.

Download Notes

In the simplest use-case, downloading an object looks like this: s3.LocalFile = "../MyData.zip"; s3.GetObject(s3.Objects[0].Name);

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 = "../MyData.zip"; s3.LocalFile = downloadFile; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded file s3.StartByte = new FileInfo(downloadFile).Length; s3.GetObject(s3.Objects[0].Name);

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. s3.LocalFile = "../MyData.zip"; s3.EncryptionPassword = "password"; s3.GetObject(s3.Objects[0].Name); //The transfer is interrupted and GetObject() above fails. Later, resume the download: //Get the size of the partially downloaded temp file s3.StartByte = new FileInfo(s3.Config("DownloadTempFile")).Length; s3.GetObject(s3.Objects[0].Name);

get_object_info Method

Gets an object's information and metadata.

Syntax

def get_object_info(object_name: str) -> None: ...

Remarks

This method gets information and metadata for the object specified by Object in the bucket currently selected by bucket. If the version_id property is non-empty, information and metadata for the specified version of the object is retrieved instead.

Calling this method will fire the on_object_list and on_metadata_list events, and will re-populate the Objects* and Metadata* properties.

interrupt Method

Interrupt the current method.

Syntax

def interrupt() -> None: ...

Remarks

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

list_buckets Method

Lists all buckets in the account.

Syntax

def list_buckets() -> None: ...

Remarks

This method lists all buckets in the account.

Calling this method will fire the on_bucket_list event once for each bucket, and will also populate the Buckets* properties.

list_objects Method

Lists the objects in a bucket.

Syntax

def list_objects() -> None: ...

Remarks

This method lists the objects in the bucket currently selected by bucket.

Before calling this method, the object_prefix property may be set in order to restrict the results to only the objects whose names begin with a given string. The object_delimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the on_object_list event once for each object, and will also populate the Objects* properties. It may also fire the on_prefix_list event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more objects available to list when this method returns, the object_marker property will be populated. Continue to call this method until object_marker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

By using the object_delimiter and object_prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With object_delimiter set to /, we can set object_prefix to successively "deeper" values before calling list_objects or list_versions for the following effect:

list_versions Method

Lists the object versions in a bucket.

Syntax

def list_versions() -> None: ...

Remarks

This method lists the object versions in the bucket currently selected by bucket.

Before calling this method, the object_prefix property may be set in order to restrict the results to only the object versions whose names begin with a given string. The object_delimiter property can also be used to further tune the results returned. The MaxObjects configuration setting may be used to limit the number of results returned.

Calling this method will fire the on_object_list event once for each object version, and will also populate the Objects* properties. It may also fire the on_prefix_list event, and populate the PrefixCount and Prefix[i] configuration settings, depending on how the properties discussed above are set.

If there are still more object versions available to list when this method returns, the version_marker property will be populated. Continue to call this method until version_marker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

By using the object_delimiter and object_prefix properties in tandem, applications can effectively "traverse" a virtual hierarchy of objects (or object versions) as if it were a filesystem. For example, assume that objects with the following names exist within a bucket:

• MyCompany/
• MyCompany/Department1/
• MyCompany/Department2/
• MyCompany/Department2/EmployeeA
• MyCompany/Department2/EmployeeB

With object_delimiter set to /, we can set object_prefix to successively "deeper" values before calling list_objects or list_versions for the following effect:

reset Method

Resets the class to its initial state.

Syntax

def reset() -> None: ...

Remarks

This method resets the class to its initial state.

reset_headers Method

Resets all HTTP headers, cookies, and LocalFile.

Syntax

def reset_headers() -> None: ...

Remarks

Resets all the HTTP headers as well as local_file to "" (empty string), and clears the Metadata* and QueryParam* properties.

Call this method before creating a new request, so that headers and query parameters from the previous request are not carried over to the next one.

send_custom_request Method

Sends a custom request to the server.

Syntax

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

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

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

The ObjectName and RequestBody parameters 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, based on the following:
   • use_ssl, region, and use_virtual_hosting for the base URL.
     • Alternatively, if a custom URL has been specified using the URL configuration setting, it is used directly, and these properties are ignored.
   • bucket (if non-empty)
   • ObjectName (if non-empty)
   • version_id (if both it and ObjectName are non-empty)
   • QueryParam*
2. Adds request headers from:
   • content_disposition
   • content_type
   • other_headers
   • ProductToken
   • SessionToken
   • UserToken
3. Signs the request (unless the SignCustomRequest configuration setting is disabled).
4. Sends the request, including RequestBody if non-empty.
5. Stores the response headers in the ParsedHeader* properties; and the response body in the specified local_file, or object_data (using the same logic as get_object).

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

update_bucket_acl Method

Updates a bucket's canned access policy.

Syntax

def update_bucket_acl() -> None: ...

Remarks

This method updates the canned access policy of the bucket selected by bucket to the value specified by access_policy

update_object_acl Method

Updates an object's canned access policy.

Syntax

def update_object_acl(object_name: str) -> None: ...

Remarks

This method updates the caned access policy of the objects specified by ObjectName, in the bucket currently selected by bucket, to the value specified by access_policy.

If the version_id property is non-empty, the canned access policy of the specified version of the object is updated instead.

on_bucket_list Event

Fires once for each bucket returned when listing buckets.

Syntax

class GoogleStorageBucketListEventParams(object):
  @property
  def bucket_name() -> str: ...

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

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

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

# In class GoogleStorage:
@property
def on_bucket_list() -> Callable[[GoogleStorageBucketListEventParams], None]: ...
@on_bucket_list.setter
def on_bucket_list(event_hook: Callable[[GoogleStorageBucketListEventParams], None]) -> None: ...

Remarks

This event fires once for each bucket returned when list_buckets is called.

BucketName reflects the name of the bucket.

CreationDate reflects the bucket's creation date.

OwnerId and OwnerName reflect the Id and display name of the bucket's owner, respectively.

on_end_transfer Event

This event fires when a document finishes transferring.

Syntax

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

# In class GoogleStorage:
@property
def on_end_transfer() -> Callable[[GoogleStorageEndTransferEventParams], None]: ...
@on_end_transfer.setter
def on_end_transfer(event_hook: Callable[[GoogleStorageEndTransferEventParams], 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 GoogleStorageErrorEventParams(object):
  @property
  def error_code() -> int: ...

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

# In class GoogleStorage:
@property
def on_error() -> Callable[[GoogleStorageErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[GoogleStorageErrorEventParams], 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_header Event

This event is fired every time a header line comes in.

Syntax

class GoogleStorageHeaderEventParams(object):
  @property
  def field() -> str: ...

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

# In class GoogleStorage:
@property
def on_header() -> Callable[[GoogleStorageHeaderEventParams], None]: ...
@on_header.setter
def on_header(event_hook: Callable[[GoogleStorageHeaderEventParams], 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

This event fires once for each log message.

Syntax

class GoogleStorageLogEventParams(object):
  @property
  def log_level() -> int: ...

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

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

# In class GoogleStorage:
@property
def on_log() -> Callable[[GoogleStorageLogEventParams], None]: ...
@on_log.setter
def on_log(event_hook: Callable[[GoogleStorageLogEventParams], None]) -> None: ...

Remarks

This event fires 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_metadata_list Event

Fires once for each metadata item returned when object information and metadata is retrieved.

Syntax

class GoogleStorageMetadataListEventParams(object):
  @property
  def name() -> str: ...

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

# In class GoogleStorage:
@property
def on_metadata_list() -> Callable[[GoogleStorageMetadataListEventParams], None]: ...
@on_metadata_list.setter
def on_metadata_list(event_hook: Callable[[GoogleStorageMetadataListEventParams], None]) -> None: ...

Remarks

This event fires once for each metadata item returned when get_object_info is called.

Name is the name of the metadata item, without the service-specific prefix (e.g., x-amz-meta-, x-goog-meta-, etc.). Keep in mind that the server stores metadata names in lowercase.

Value is the metadata item's value.

on_object_list Event

Fires once for each object, object version, or multipart upload returned when listing such items.

Syntax

class GoogleStorageObjectListEventParams(object):
  @property
  def bucket_name() -> str: ...

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

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

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

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

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

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

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

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

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

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

# In class GoogleStorage:
@property
def on_object_list() -> Callable[[GoogleStorageObjectListEventParams], None]: ...
@on_object_list.setter
def on_object_list(event_hook: Callable[[GoogleStorageObjectListEventParams], None]) -> None: ...

Remarks

This event fires once for each object, or object version, returned when get_object_info, list_objects, or list_versions is called.

BucketName reflects the name of the bucket that the object is in.

ObjectName reflects the name of the object.

LastModified reflects the last modified time of the object.

Size reflects the size, in bytes, of the object.

ETag reflects the object's ETag.

OwnerId and OwnerName reflect the Id and display name of the object's owner, respectively. Not applicable when get_object_info is called.

VersionId reflects the Id of the object version (note that the string null is a valid version Id). Only applicable when list_versions is called, or when get_object_info is called while version_id is non-empty; empty in all other cases.

LatestVersion indicates whether this is the latest object version. Only applicable when list_versions is called; True in all other cases.

Deleted indicates whether this object version was deleted or overwritten. Only applicable when list_versions is called; False in all other cases.

on_prefix_list Event

Fires once for each common prefix returned when listing objects.

Syntax

class GoogleStoragePrefixListEventParams(object):
  @property
  def bucket_name() -> str: ...

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

# In class GoogleStorage:
@property
def on_prefix_list() -> Callable[[GoogleStoragePrefixListEventParams], None]: ...
@on_prefix_list.setter
def on_prefix_list(event_hook: Callable[[GoogleStoragePrefixListEventParams], None]) -> None: ...

Remarks

This event fires once for each common prefix returned when list_objects or list_versions is called when object_delimiter is non-empty. Refer to object_delimiter for more information.

BucketName reflects the name of the bucket that the prefix is in.

Prefix is the common prefix.

on_progress Event

Fires during an upload or download to indicate transfer progress.

Syntax

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

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

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

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

# In class GoogleStorage:
@property
def on_progress() -> Callable[[GoogleStorageProgressEventParams], None]: ...
@on_progress.setter
def on_progress(event_hook: Callable[[GoogleStorageProgressEventParams], 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_ssl_server_authentication Event

Fired after the server presents its certificate to the client.

Syntax

class GoogleStorageSSLServerAuthenticationEventParams(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 GoogleStorage:
@property
def on_ssl_server_authentication() -> Callable[[GoogleStorageSSLServerAuthenticationEventParams], None]: ...
@on_ssl_server_authentication.setter
def on_ssl_server_authentication(event_hook: Callable[[GoogleStorageSSLServerAuthenticationEventParams], 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 GoogleStorageSSLStatusEventParams(object):
  @property
  def message() -> str: ...

# In class GoogleStorage:
@property
def on_ssl_status() -> Callable[[GoogleStorageSSLStatusEventParams], None]: ...
@on_ssl_status.setter
def on_ssl_status(event_hook: Callable[[GoogleStorageSSLStatusEventParams], 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 GoogleStorageStartTransferEventParams(object):
  @property
  def direction() -> int: ...

# In class GoogleStorage:
@property
def on_start_transfer() -> Callable[[GoogleStorageStartTransferEventParams], None]: ...
@on_start_transfer.setter
def on_start_transfer(event_hook: Callable[[GoogleStorageStartTransferEventParams], 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

This event is fired while a document transfers (delivers document).

Syntax

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

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

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

  @property
  def text() -> bytes: ...

# In class GoogleStorage:
@property
def on_transfer() -> Callable[[GoogleStorageTransferEventParams], None]: ...
@on_transfer.setter
def on_transfer(event_hook: Callable[[GoogleStorageTransferEventParams], 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.

GoogleStorage Config Settings

GoogleStorage Config Settings

<firstlevel>
  <one>value</one>
  <two>
    <item>first</item>
    <item>second</item>
  </two>
  <three>value three</three>
</firstlevel>

{
  "firstlevel": {
    "one": "value",
    "two": ["first", "second"],
    "three": "value three"
  }
}

HTTP Config Settings

TCPClient Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Socket Config Settings

Base Config Settings

GoogleStorage Errors

Common Errors

GoogleStorage 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