GoogleStorage Class

Properties   Methods   Events   Config Settings   Errors  

The GoogleStorage class implements the Google Storage for Developers API.

Class Name

CloudStorage_GoogleStorage

Procedural Interface

 cloudstorage_googlestorage_open();
 cloudstorage_googlestorage_close($res);
 cloudstorage_googlestorage_register_callback($res, $id, $function);
 cloudstorage_googlestorage_get_last_error($res);
 cloudstorage_googlestorage_get_last_error_code($res);
 cloudstorage_googlestorage_set($res, $id, $index, $value);
 cloudstorage_googlestorage_get($res, $id, $index);
 cloudstorage_googlestorage_do_addmetadata($res, $name, $value);
 cloudstorage_googlestorage_do_addqueryparam($res, $name, $value);
 cloudstorage_googlestorage_do_authorize($res);
 cloudstorage_googlestorage_do_bucketexists($res);
 cloudstorage_googlestorage_do_calcauthorization($res);
 cloudstorage_googlestorage_do_checkversioningenabled($res);
 cloudstorage_googlestorage_do_composeobjects($res, $composedobjectname);
 cloudstorage_googlestorage_do_config($res, $configurationstring);
 cloudstorage_googlestorage_do_copyobject($res, $srcobjectname, $destbucket, $destobjectname);
 cloudstorage_googlestorage_do_createbucket($res);
 cloudstorage_googlestorage_do_createobject($res, $objectname);
 cloudstorage_googlestorage_do_deletebucket($res);
 cloudstorage_googlestorage_do_deleteobject($res, $objectname);
 cloudstorage_googlestorage_do_disableversioning($res);
 cloudstorage_googlestorage_do_doevents($res);
 cloudstorage_googlestorage_do_enableversioning($res);
 cloudstorage_googlestorage_do_getbucketlocation($res);
 cloudstorage_googlestorage_do_getobject($res, $objectname);
 cloudstorage_googlestorage_do_getobjectinfo($res, $objectname);
 cloudstorage_googlestorage_do_interrupt($res);
 cloudstorage_googlestorage_do_listbuckets($res);
 cloudstorage_googlestorage_do_listobjects($res);
 cloudstorage_googlestorage_do_listversions($res);
 cloudstorage_googlestorage_do_reset($res);
 cloudstorage_googlestorage_do_resetheaders($res);
 cloudstorage_googlestorage_do_sendcustomrequest($res, $httpmethod, $objectname, $requestbody);
 cloudstorage_googlestorage_do_updatebucketacl($res);
 cloudstorage_googlestorage_do_updateobjectacl($res, $objectname);

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 OAuthClientProfile and OAuthGrantType.

The class has the following defaults:

Below is a brief description of the different OAuthClientProfile and OAuthGrantType 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 OAuthAccessToken property will be populated. Additionally, if a refresh token was provided the OAuthRefreshToken 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 OAuthAccessToken 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 OAuthAccessToken. 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 OAuthGrantType 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 OAuthGrantType 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, OAuthServerAuthURL, and OAuthServerTokenURL 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 OAuthAuthorizationCode 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 OAuthRefreshToken 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 OAuthGrantType the class expects a OAuthClientId, OAuthClientSecret, and OAuthServerAuthURL 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 OAuth 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 CreateBucket. 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 CreateObject.

There are other methods such as ListBuckets, ListObjects, GetObject, DeleteObject etc. that further enable you to manage your Google Storage data store.

When authenticating via OAuth the ProjectId 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.

AccessPolicy Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getAccessPolicy();


public function setAccessPolicy($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 1 );


cloudstorage_googlestorage_set($res, 1, $value );

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:

• CopyObject (for the destination object)
• CreateBucket
• CreateObject
• StartMultipartUpload
• UpdateBucketACL
• UpdateObjectACL

Valid values are:

Data Type

Integer

Authorization Property (CloudStorage_GoogleStorage Class)

OAuth 2.0 Authorization Token.

Object Oriented Interface

public function getAuthorization();


public function setAuthorization($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 2 );


cloudstorage_googlestorage_set($res, 2, $value );

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

Data Type

String

Bucket Property (CloudStorage_GoogleStorage Class)

Selects a bucket.

Object Oriented Interface

public function getBucket();


public function setBucket($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 3 );


cloudstorage_googlestorage_set($res, 3, $value );

Default Value

''

Remarks

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

Data Type

String

BucketsCount Property (CloudStorage_GoogleStorage Class)

The number of records in the Buckets arrays.

Object Oriented Interface

public function getBucketsCount();

Procedural Interface

cloudstorage_googlestorage_get($res, 4 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• BucketsCreationDate
• BucketsName
• BucketsOwnerDisplayName
• BucketsOwnerId

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

This property is read-only and not available at design time.

Data Type

Integer

BucketsCreationDate Property (CloudStorage_GoogleStorage Class)

The property includes the creation date of the bucket.

Object Oriented Interface

public function getBucketsCreationDate($bucketsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 5 , $bucketsindex);

Default Value

''

Remarks

The property includes the creation date of the bucket.

This property reflects the creation date of the bucket.

The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

This property is read-only and not available at design time.

Data Type

String

BucketsName Property (CloudStorage_GoogleStorage Class)

The property contains the name of the bucket.

Object Oriented Interface

public function getBucketsName($bucketsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 6 , $bucketsindex);

Default Value

''

Remarks

The property contains the name of the bucket.

This property reflects the name of the bucket.

The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

This property is read-only and not available at design time.

Data Type

String

BucketsOwnerDisplayName Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getBucketsOwnerDisplayName($bucketsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 7 , $bucketsindex);

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 $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

This property is read-only and not available at design time.

Data Type

String

BucketsOwnerId Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getBucketsOwnerId($bucketsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 8 , $bucketsindex);

Default Value

''

Remarks

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

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

The $bucketsindex parameter specifies the index of the item in the array. The size of the array is controlled by the BucketsCount property.

This property is read-only and not available at design time.

Data Type

String

ContentDisposition Property (CloudStorage_GoogleStorage Class)

Content disposition to send for an object.

Object Oriented Interface

public function getContentDisposition();


public function setContentDisposition($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 9 );


cloudstorage_googlestorage_set($res, 9, $value );

Default Value

''

Remarks

This property can be set before calling CreateObject 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.

This property is not available at design time.

Data Type

String

ContentType Property (CloudStorage_GoogleStorage Class)

Content type to send for an object.

Object Oriented Interface

public function getContentType();


public function setContentType($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 10 );


cloudstorage_googlestorage_set($res, 10, $value );

Default Value

''

Remarks

This property can be set before calling CreateObject 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.

This property is not available at design time.

Data Type

String

EncryptionAlgorithm Property (CloudStorage_GoogleStorage Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();


public function setEncryptionAlgorithm($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 11 );


cloudstorage_googlestorage_set($res, 11, $value );

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:

Data Type

Integer

EncryptionPassword Property (CloudStorage_GoogleStorage Class)

The encryption password.

Object Oriented Interface

public function getEncryptionPassword();


public function setEncryptionPassword($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 12 );


cloudstorage_googlestorage_set($res, 12, $value );

Default Value

''

Remarks

If this property is populated when UploadFile or DownloadFile 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.

This property is not available at design time.

Data Type

String

FirewallAutoDetect Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getFirewallAutoDetect();


public function setFirewallAutoDetect($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 13 );


cloudstorage_googlestorage_set($res, 13, $value );

Default Value

false

Remarks

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

Data Type

Boolean

FirewallType Property (CloudStorage_GoogleStorage Class)

This property determines the type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();


public function setFirewallType($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 14 );


cloudstorage_googlestorage_set($res, 14, $value );

Default Value

0

Remarks

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

Data Type

Integer

FirewallHost Property (CloudStorage_GoogleStorage Class)

This property contains the name or IP address of firewall (optional).

Object Oriented Interface

public function getFirewallHost();


public function setFirewallHost($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 15 );


cloudstorage_googlestorage_set($res, 15, $value );

Default Value

''

Remarks

This property contains the name or IP address of firewall (optional). If a FirewallHost 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.

Data Type

String

FirewallPassword Property (CloudStorage_GoogleStorage Class)

This property contains a password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();


public function setFirewallPassword($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 16 );


cloudstorage_googlestorage_set($res, 16, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (CloudStorage_GoogleStorage Class)

This property contains the transmission control protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();


public function setFirewallPort($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 17 );


cloudstorage_googlestorage_set($res, 17, $value );

Default Value

0

Remarks

This property contains the transmission control protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

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

Data Type

Integer

FirewallUser Property (CloudStorage_GoogleStorage Class)

This property contains a user name if authentication is to be used connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();


public function setFirewallUser($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 18 );


cloudstorage_googlestorage_set($res, 18, $value );

Default Value

''

Remarks

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

Data Type

String

FollowRedirects Property (CloudStorage_GoogleStorage Class)

Determines what happens when the server issues a redirect.

Object Oriented Interface

public function getFollowRedirects();


public function setFollowRedirects($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 19 );


cloudstorage_googlestorage_set($res, 19, $value );

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:

Data Type

Integer

Idle Property (CloudStorage_GoogleStorage Class)

The current status of the class.

Object Oriented Interface

public function getIdle();

Procedural Interface

cloudstorage_googlestorage_get($res, 20 );

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.

Data Type

Boolean

LocalFile Property (CloudStorage_GoogleStorage Class)

The location of the local file.

Object Oriented Interface

public function getLocalFile();


public function setLocalFile($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 21 );


cloudstorage_googlestorage_set($res, 21, $value );

Default Value

''

Remarks

This property specifies the location of a file on disk. This is used as the source file when calling CreateObject or UploadPart; and as the destination file when calling GetObject.

Data Type

String

LocalHost Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getLocalHost();


public function setLocalHost($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 22 );


cloudstorage_googlestorage_set($res, 22, $value );

Default Value

''

Remarks

The LocalHost 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 LocalHost 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: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MetadataCount Property (CloudStorage_GoogleStorage Class)

The number of records in the Metadata arrays.

Object Oriented Interface

public function getMetadataCount();


public function setMetadataCount($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 23 );


cloudstorage_googlestorage_set($res, 23, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• MetadataName
• MetadataValue

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

This property is not available at design time.

Data Type

Integer

MetadataName Property (CloudStorage_GoogleStorage Class)

The property contains the name of the metadata item.

Object Oriented Interface

public function getMetadataName($metadataindex);


public function setMetadataName($metadataindex, $value);

Procedural Interface

cloudstorage_googlestorage_get($res, 24 , $metadataindex);


cloudstorage_googlestorage_set($res, 24, $value , $metadataindex);

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 $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

MetadataValue Property (CloudStorage_GoogleStorage Class)

This property contains the value of the metadata item.

Object Oriented Interface

public function getMetadataValue($metadataindex);


public function setMetadataValue($metadataindex, $value);

Procedural Interface

cloudstorage_googlestorage_get($res, 25 , $metadataindex);


cloudstorage_googlestorage_set($res, 25, $value , $metadataindex);

Default Value

''

Remarks

This property contains the value of the metadata item.

This property specifies the value of the metadata item.

The $metadataindex parameter specifies the index of the item in the array. The size of the array is controlled by the MetadataCount property.

This property is not available at design time.

Data Type

String

OAuthAccessToken Property (CloudStorage_GoogleStorage Class)

The access token returned by the authorization server.

Object Oriented Interface

public function getOAuthAccessToken();


public function setOAuthAccessToken($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 26 );


cloudstorage_googlestorage_set($res, 26, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationCode Property (CloudStorage_GoogleStorage Class)

The authorization code that is exchanged for an access token.

Object Oriented Interface

public function getOAuthAuthorizationCode();


public function setOAuthAuthorizationCode($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 27 );


cloudstorage_googlestorage_set($res, 27, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthAuthorizationScope Property (CloudStorage_GoogleStorage Class)

The scope request or response parameter used during authorization.

Object Oriented Interface

public function getOAuthAuthorizationScope();


public function setOAuthAuthorizationScope($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 28 );


cloudstorage_googlestorage_set($res, 28, $value );

Default Value

''

Remarks

The scope request or response parameter used during authorization.

This property is not available at design time.

Data Type

String

OAuthClientId Property (CloudStorage_GoogleStorage Class)

The id of the client assigned when registering the application.

Object Oriented Interface

public function getOAuthClientId();


public function setOAuthClientId($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 29 );


cloudstorage_googlestorage_set($res, 29, $value );

Default Value

''

Remarks

The id of the client assigned when registering the application.

This property is not available at design time.

Data Type

String

OAuthClientProfile Property (CloudStorage_GoogleStorage Class)

The type of client that is requesting authorization.

Object Oriented Interface

public function getOAuthClientProfile();


public function setOAuthClientProfile($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 30 );


cloudstorage_googlestorage_set($res, 30, $value );

Default Value

0

Remarks

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

This property is not available at design time.

Data Type

Integer

OAuthClientSecret Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getOAuthClientSecret();


public function setOAuthClientSecret($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 31 );


cloudstorage_googlestorage_set($res, 31, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthGrantType Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getOAuthGrantType();


public function setOAuthGrantType($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 32 );


cloudstorage_googlestorage_set($res, 32, $value );

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:

This property is not available at design time.

Data Type

Integer

OAuthRefreshToken Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getOAuthRefreshToken();


public function setOAuthRefreshToken($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 33 );


cloudstorage_googlestorage_set($res, 33, $value );

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 OAuthGrantType property is set to a grant that can use refresh tokens.

This property is not available at design time.

Data Type

String

OAuthReturnURL Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getOAuthReturnURL();


public function setOAuthReturnURL($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 34 );


cloudstorage_googlestorage_set($res, 34, $value );

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.

This property is not available at design time.

Data Type

String

OAuthServerAuthURL Property (CloudStorage_GoogleStorage Class)

The URL of the authorization server.

Object Oriented Interface

public function getOAuthServerAuthURL();


public function setOAuthServerAuthURL($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 35 );


cloudstorage_googlestorage_set($res, 35, $value );

Default Value

''

Remarks

The URL of the authorization server.

This property is not available at design time.

Data Type

String

OAuthServerTokenURL Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getOAuthServerTokenURL();


public function setOAuthServerTokenURL($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 36 );


cloudstorage_googlestorage_set($res, 36, $value );

Default Value

''

Remarks

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

This property is not available at design time.

Data Type

String

OAuthWebAuthURL Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getOAuthWebAuthURL();

Procedural Interface

cloudstorage_googlestorage_get($res, 37 );

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 and not available at design time.

Data Type

String

ObjectData Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getObjectData();


public function setObjectData($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 38 );


cloudstorage_googlestorage_set($res, 38, $value );

Default Value

''

Remarks

This property is populated with object data after calling GetObject if LocalFile is not set.

This property can also be set before calling CreateObject or UploadPart; its data will be uploaded if LocalFile is not set.

This property is not available at design time.

Data Type

Binary String

ObjectDelimiter Property (CloudStorage_GoogleStorage Class)

The delimiter string to use when listing objects.

Object Oriented Interface

public function getObjectDelimiter();


public function setObjectDelimiter($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 39 );


cloudstorage_googlestorage_set($res, 39, $value );

Default Value

''

Remarks

If this property is non-empty when ListObjects or ListVersions is called, any objects (or object versions) whose names contain the same string between the specified ObjectPrefix 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 PrefixList 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 ObjectDelimiter and ObjectPrefix 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 ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Data Type

String

ObjectMarker Property (CloudStorage_GoogleStorage Class)

A marker indicating what page of objects to return next.

Object Oriented Interface

public function getObjectMarker();


public function setObjectMarker($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 40 );


cloudstorage_googlestorage_set($res, 40, $value );

Default Value

''

Remarks

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

Refer to ListObjects for more information.

This property is not available at design time.

Data Type

String

ObjectPrefix Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getObjectPrefix();


public function setObjectPrefix($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 41 );


cloudstorage_googlestorage_set($res, 41, $value );

Default Value

''

Remarks

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

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix 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 ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

This property is not available at design time.

Data Type

String

ObjectsCount Property (CloudStorage_GoogleStorage Class)

The number of records in the Objects arrays.

Object Oriented Interface

public function getObjectsCount();


public function setObjectsCount($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 42 );


cloudstorage_googlestorage_set($res, 42, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ObjectsDeleted
• ObjectsETag
• ObjectsLastModified
• ObjectsLatestVersion
• ObjectsName
• ObjectsOwnerDisplayName
• ObjectsOwnerId
• ObjectsSize
• ObjectsStorageClass
• ObjectsUploadId
• ObjectsVersionId

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

This property is not available at design time.

Data Type

Integer

ObjectsDeleted Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getObjectsDeleted($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 43 , $objectsindex);

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 DeleteObject for more information.

This is applicable only when ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; false in all other cases.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectsETag Property (CloudStorage_GoogleStorage Class)

This property contains the ETag of the object.

Object Oriented Interface

public function getObjectsETag($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 44 , $objectsindex);

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 ListMultipartUploads is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsLastModified Property (CloudStorage_GoogleStorage Class)

This property contains the last modified time of the object.

Object Oriented Interface

public function getObjectsLastModified($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 45 , $objectsindex);

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 ListMultipartUploads is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsLatestVersion Property (CloudStorage_GoogleStorage Class)

This property specifies whether this is the latest object version.

Object Oriented Interface

public function getObjectsLatestVersion($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 46 , $objectsindex);

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 ListVersions is called.; true in all other cases.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

Boolean

ObjectsName Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getObjectsName($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 47 , $objectsindex);

Default Value

''

Remarks

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

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

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsOwnerDisplayName Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getObjectsOwnerDisplayName($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 48 , $objectsindex);

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 GetObjectInfo is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsOwnerId Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getObjectsOwnerId($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 49 , $objectsindex);

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 GetObjectInfo is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsSize Property (CloudStorage_GoogleStorage Class)

This property contains the size of the object.

Object Oriented Interface

public function getObjectsSize($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 50 , $objectsindex);

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 ListMultipartUploads is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

Long64

ObjectsStorageClass Property (CloudStorage_GoogleStorage Class)

This property contains the storage class of the object.

Object Oriented Interface

public function getObjectsStorageClass($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 51 , $objectsindex);

Default Value

''

Remarks

This property contains the storage class of the object.

This property reflects the storage class of the object.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsUploadId Property (CloudStorage_GoogleStorage Class)

This property contains the upload Id of the multipart upload.

Object Oriented Interface

public function getObjectsUploadId($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 52 , $objectsindex);

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 ListMultipartUploads is called.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

ObjectsVersionId Property (CloudStorage_GoogleStorage Class)

This property contains the Id of the object version.

Object Oriented Interface

public function getObjectsVersionId($objectsindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 53 , $objectsindex);

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 ListVersions is called, or when GetObjectInfo is called while VersionId is nonempty.; empty in all other cases.

The $objectsindex parameter specifies the index of the item in the array. The size of the array is controlled by the ObjectsCount property.

This property is read-only and not available at design time.

Data Type

String

OtherHeaders Property (CloudStorage_GoogleStorage Class)

This property includes other headers as determined by the user (optional).

Object Oriented Interface

public function getOtherHeaders();


public function setOtherHeaders($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 54 );


cloudstorage_googlestorage_set($res, 54, $value );

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

This property is not available at design time.

Data Type

String

Overwrite Property (CloudStorage_GoogleStorage Class)

Determines if local files are overwritten.

Object Oriented Interface

public function getOverwrite();


public function setOverwrite($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 55 );


cloudstorage_googlestorage_set($res, 55, $value );

Default Value

false

Remarks

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

Data Type

Boolean

ParsedHeaderCount Property (CloudStorage_GoogleStorage Class)

The number of records in the ParsedHeader arrays.

Object Oriented Interface

public function getParsedHeaderCount();

Procedural Interface

cloudstorage_googlestorage_get($res, 56 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• ParsedHeaderField
• ParsedHeaderValue

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

This property is read-only and not available at design time.

Data Type

Integer

ParsedHeaderField Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getParsedHeaderField($parsedheaderindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 57 , $parsedheaderindex);

Default Value

''

Remarks

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

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ParsedHeaderValue Property (CloudStorage_GoogleStorage Class)

This property contains the header contents.

Object Oriented Interface

public function getParsedHeaderValue($parsedheaderindex);

Procedural Interface

cloudstorage_googlestorage_get($res, 58 , $parsedheaderindex);

Default Value

''

Remarks

This property contains the Header contents.

The $parsedheaderindex parameter specifies the index of the item in the array. The size of the array is controlled by the ParsedHeaderCount property.

This property is read-only and not available at design time.

Data Type

String

ProjectId Property (CloudStorage_GoogleStorage Class)

The Id of the project.

Object Oriented Interface

public function getProjectId();


public function setProjectId($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 59 );


cloudstorage_googlestorage_set($res, 59, $value );

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.

Data Type

String

ProxyAuthScheme Property (CloudStorage_GoogleStorage Class)

This property is used to tell the class which type of authorization to perform when connecting to the proxy.

Object Oriented Interface

public function getProxyAuthScheme();


public function setProxyAuthScheme($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 60 );


cloudstorage_googlestorage_set($res, 60, $value );

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 ProxyUser and ProxyPassword properties are set.

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

By default, ProxyAuthScheme is authBasic (0), and if the ProxyUser and ProxyPassword properties are set, the component will attempt basic authentication.

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

If ProxyAuthScheme 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 ProxyAuthScheme is set to authNtlm (4), NTLM authentication will be used.

For security reasons, setting this property will clear the values of ProxyUser and ProxyPassword.

Data Type

Integer

ProxyAutoDetect Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getProxyAutoDetect();


public function setProxyAutoDetect($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 61 );


cloudstorage_googlestorage_set($res, 61, $value );

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.

Data Type

Boolean

ProxyPassword Property (CloudStorage_GoogleStorage Class)

This property contains a password if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyPassword();


public function setProxyPassword($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 62 );


cloudstorage_googlestorage_set($res, 62, $value );

Default Value

''

Remarks

This property contains a password if authentication is to be used for the proxy.

If ProxyAuthScheme is set to Basic Authentication, the ProxyUser and ProxyPassword are Base64 encoded and the proxy authentication token will be generated in the form Basic [encoded-user-password].

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

ProxyPort Property (CloudStorage_GoogleStorage Class)

This property contains the Transmission Control Protocol (TCP) port for the proxy Server (default 80).

Object Oriented Interface

public function getProxyPort();


public function setProxyPort($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 63 );


cloudstorage_googlestorage_set($res, 63, $value );

Default Value

80

Remarks

This property contains the Transmission Control Protocol (TCP) port for the proxy ProxyServer (default 80). See the description of the ProxyServer property for details.

Data Type

Integer

ProxyServer Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getProxyServer();


public function setProxyServer($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 64 );


cloudstorage_googlestorage_set($res, 64, $value );

Default Value

''

Remarks

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

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

Data Type

String

ProxySSL Property (CloudStorage_GoogleStorage Class)

This property determines when to use a Secure Sockets Layer (SSL) for the connection to the proxy.

Object Oriented Interface

public function getProxySSL();


public function setProxySSL($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 65 );


cloudstorage_googlestorage_set($res, 65, $value );

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:

Data Type

Integer

ProxyUser Property (CloudStorage_GoogleStorage Class)

This property contains a username if authentication is to be used for the proxy.

Object Oriented Interface

public function getProxyUser();


public function setProxyUser($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 66 );


cloudstorage_googlestorage_set($res, 66, $value );

Default Value

''

Remarks

This property contains a username if authentication is to be used for the proxy.

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

If ProxyAuthScheme is set to Digest Authentication, the ProxyUser and ProxyPassword properties are used to respond to the Digest Authentication challenge from the server.

If ProxyAuthScheme is set to NTLM Authentication, the ProxyUser and ProxyPassword properties are used to authenticate through NTLM negotiation.

Data Type

String

QueryParamCount Property (CloudStorage_GoogleStorage Class)

The number of records in the QueryParam arrays.

Object Oriented Interface

public function getQueryParamCount();


public function setQueryParamCount($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 67 );


cloudstorage_googlestorage_set($res, 67, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• QueryParamName
• QueryParamValue

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

This property is not available at design time.

Data Type

Integer

QueryParamName Property (CloudStorage_GoogleStorage Class)

The name of the query parameter.

Object Oriented Interface

public function getQueryParamName($queryparamindex);


public function setQueryParamName($queryparamindex, $value);

Procedural Interface

cloudstorage_googlestorage_get($res, 68 , $queryparamindex);


cloudstorage_googlestorage_set($res, 68, $value , $queryparamindex);

Default Value

''

Remarks

The name of the query parameter.

This property specifies the name of the query parameter.

The $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

QueryParamValue Property (CloudStorage_GoogleStorage Class)

The value of the query parameter.

Object Oriented Interface

public function getQueryParamValue($queryparamindex);


public function setQueryParamValue($queryparamindex, $value);

Procedural Interface

cloudstorage_googlestorage_get($res, 69 , $queryparamindex);


cloudstorage_googlestorage_set($res, 69, $value , $queryparamindex);

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 $queryparamindex parameter specifies the index of the item in the array. The size of the array is controlled by the QueryParamCount property.

This property is not available at design time.

Data Type

String

Range Property (CloudStorage_GoogleStorage Class)

The range of bytes to request.

Object Oriented Interface

public function getRange();


public function setRange($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 70 );


cloudstorage_googlestorage_set($res, 70, $value );

Default Value

''

Remarks

This property specifies the range of bytes to request from the server. If this property is non-empty when a GetObject 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 StartByte property is greater than zero when GetObject 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 StartByte 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.

This property is not available at design time.

Data Type

String

Region Property (CloudStorage_GoogleStorage Class)

The location the class will create buckets in.

Object Oriented Interface

public function getRegion();


public function setRegion($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 71 );


cloudstorage_googlestorage_set($res, 71, $value );

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.

Data Type

String

SSLAcceptServerCertEncoded Property (CloudStorage_GoogleStorage Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();


public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 73 );


cloudstorage_googlestorage_set($res, 73, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertEncoded Property (CloudStorage_GoogleStorage Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();


public function setSSLCertEncoded($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 101 );


cloudstorage_googlestorage_set($res, 101, $value );

Default Value

''

Remarks

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

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

This property is not available at design time.

Data Type

Binary String

SSLCertStore Property (CloudStorage_GoogleStorage Class)

This is the name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();


public function setSSLCertStore($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 117 );


cloudstorage_googlestorage_set($res, 117, $value );

Default Value

'MY'

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject 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).

Data Type

Binary String

SSLCertStorePassword Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getSSLCertStorePassword();


public function setSSLCertStorePassword($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 118 );


cloudstorage_googlestorage_set($res, 118, $value );

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.

Data Type

String

SSLCertStoreType Property (CloudStorage_GoogleStorage Class)

This is the type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();


public function setSSLCertStoreType($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 119 );


cloudstorage_googlestorage_set($res, 119, $value );

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:

Data Type

Integer

SSLCertSubject Property (CloudStorage_GoogleStorage Class)

This is the subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();


public function setSSLCertSubject($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 120 );


cloudstorage_googlestorage_set($res, 120, $value );

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.

Data Type

String

SSLProvider Property (CloudStorage_GoogleStorage Class)

This specifies the SSL/TLS implementation to use.

Object Oriented Interface

public function getSSLProvider();


public function setSSLProvider($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 128 );


cloudstorage_googlestorage_set($res, 128, $value );

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.

Data Type

Integer

SSLServerCertEncoded Property (CloudStorage_GoogleStorage Class)

This is the certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLServerCertEncoded();

Procedural Interface

cloudstorage_googlestorage_get($res, 130 );

Default Value

''

Remarks

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

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

This property is read-only and not available at design time.

Data Type

Binary String

StartByte Property (CloudStorage_GoogleStorage Class)

The byte offset from which to resume the download.

Object Oriented Interface

public function getStartByte();


public function setStartByte($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 157 );


cloudstorage_googlestorage_set($res, 157, $value );

Default Value

0

Remarks

This property specifies the byte offset from which to resume a download initiated by GetObject; refer to its documentation for more information.

This property is not available at design time.

Data Type

Long64

Timeout Property (CloudStorage_GoogleStorage Class)

A timeout for the class.

Object Oriented Interface

public function getTimeout();


public function setTimeout($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 158 );


cloudstorage_googlestorage_set($res, 158, $value );

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

Data Type

Integer

UseSSL Property (CloudStorage_GoogleStorage Class)

Whether to use SSL/TLS when connecting.

Object Oriented Interface

public function getUseSSL();


public function setUseSSL($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 159 );


cloudstorage_googlestorage_set($res, 159, $value );

Default Value

true

Remarks

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

This property is not available at design time.

Data Type

Boolean

UseVirtualHosting Property (CloudStorage_GoogleStorage Class)

Determines which style request to use.

Object Oriented Interface

public function getUseVirtualHosting();


public function setUseVirtualHosting($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 160 );


cloudstorage_googlestorage_set($res, 160, $value );

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.

This property is not available at design time.

Data Type

Boolean

VersionId Property (CloudStorage_GoogleStorage Class)

The object version to make requests against.

Object Oriented Interface

public function getVersionId();


public function setVersionId($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 161 );


cloudstorage_googlestorage_set($res, 161, $value );

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:

• CopyObject (to copy from a specific object version)
• DeleteObject
• GetLink (to build a link for a specific object version)
• GetObject
• GetObjectInfo
• SendCustomRequest
• UpdateObjectACL

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

This property is not available at design time.

Data Type

String

VersioningEnabled Property (CloudStorage_GoogleStorage Class)

Controls whether versioning is enabled for the currently selected bucket.

Object Oriented Interface

public function getVersioningEnabled();


public function setVersioningEnabled($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 162 );


cloudstorage_googlestorage_set($res, 162, $value );

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.

This property is not available at design time.

Data Type

Boolean

VersionMarker Property (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function getVersionMarker();


public function setVersionMarker($value);

Procedural Interface

cloudstorage_googlestorage_get($res, 163 );


cloudstorage_googlestorage_set($res, 163, $value );

Default Value

''

Remarks

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

Refer to ListVersions for more information.

This property is not available at design time.

Data Type

String

AddMetadata Method (CloudStorage_GoogleStorage Class)

Adds a metadata item to the Metadata properties.

Object Oriented Interface

public function doAddMetadata($name, $value);

Procedural Interface

cloudstorage_googlestorage_do_addmetadata($res, $name, $value);

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.

AddQueryParam Method (CloudStorage_GoogleStorage Class)

Adds a query parameter to the QueryParams properties.

Object Oriented Interface

public function doAddQueryParam($name, $value);

Procedural Interface

cloudstorage_googlestorage_do_addqueryparam($res, $name, $value);

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 (CloudStorage_GoogleStorage Class)

Get the authorization string required to access the protected resource.

Object Oriented Interface

public function doAuthorize();

Procedural Interface

cloudstorage_googlestorage_do_authorize($res);

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 OAuthClientProfile property and the OAuthGrantType 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.

BucketExists Method (CloudStorage_GoogleStorage Class)

Checks whether the bucket exists.

Object Oriented Interface

public function doBucketExists();

Procedural Interface

cloudstorage_googlestorage_do_bucketexists($res);

Remarks

This method checks whether the bucket specified by Bucket exists, returning true if so or false if not.

CalcAuthorization Method (CloudStorage_GoogleStorage Class)

Calculates the Authorization header based on provided credentials.

Object Oriented Interface

public function doCalcAuthorization();

Procedural Interface

cloudstorage_googlestorage_do_calcauthorization($res);

Remarks

This method calculates the Authorization value using the values provided in AuthScheme, 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.

CheckVersioningEnabled Method (CloudStorage_GoogleStorage Class)

Checks whether versioning is enabled for the currently selected bucket.

Object Oriented Interface

public function doCheckVersioningEnabled();

Procedural Interface

cloudstorage_googlestorage_do_checkversioningenabled($res);

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.

ComposeObjects Method (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function doComposeObjects($composedobjectname);

Procedural Interface

cloudstorage_googlestorage_do_composeobjects($res, $composedobjectname);

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 (CloudStorage_GoogleStorage Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

cloudstorage_googlestorage_do_config($res, $configurationstring);

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.

CopyObject Method (CloudStorage_GoogleStorage Class)

Copies an object.

Object Oriented Interface

public function doCopyObject($srcobjectname, $destbucket, $destobjectname);

Procedural Interface

cloudstorage_googlestorage_do_copyobject($res, $srcobjectname, $destbucket, $destobjectname);

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 VersionId 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 StartMultipartUpload, and then use the CopyPart method to create parts for said multipart upload using the source object's data.

CreateBucket Method (CloudStorage_GoogleStorage Class)

Creates a new bucket.

Object Oriented Interface

public function doCreateBucket();

Procedural Interface

cloudstorage_googlestorage_do_createbucket($res);

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.

CreateObject Method (CloudStorage_GoogleStorage Class)

Creates a new object in the currently selected bucket.

Object Oriented Interface

public function doCreateObject($objectname);

Procedural Interface

cloudstorage_googlestorage_do_createobject($res, $objectname);

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 LocalFile is set the file will be uploaded from the specified path. If LocalFile is not set the data in ObjectData will be used.

To encrypt the file before uploading it, set EncryptionAlgorithm and EncryptionPassword.

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

DeleteBucket Method (CloudStorage_GoogleStorage Class)

Deletes a bucket.

Object Oriented Interface

public function doDeleteBucket();

Procedural Interface

cloudstorage_googlestorage_do_deletebucket($res);

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.

DeleteObject Method (CloudStorage_GoogleStorage Class)

Deletes an object.

Object Oriented Interface

public function doDeleteObject($objectname);

Procedural Interface

cloudstorage_googlestorage_do_deleteobject($res, $objectname);

Remarks

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

If the VersionId 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.

DisableVersioning Method (CloudStorage_GoogleStorage Class)

Disables versioning for the currently selected bucket.

Object Oriented Interface

public function doDisableVersioning();

Procedural Interface

cloudstorage_googlestorage_do_disableversioning($res);

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.

DoEvents Method (CloudStorage_GoogleStorage Class)

Processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

cloudstorage_googlestorage_do_doevents($res);

Remarks

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

EnableVersioning Method (CloudStorage_GoogleStorage Class)

Enables versioning for the currently selected bucket.

Object Oriented Interface

public function doEnableVersioning();

Procedural Interface

cloudstorage_googlestorage_do_enableversioning($res);

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.

GetBucketLocation Method (CloudStorage_GoogleStorage Class)

Gets a bucket's location.

Object Oriented Interface

public function doGetBucketLocation();

Procedural Interface

cloudstorage_googlestorage_do_getbucketlocation($res);

Remarks

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

GetObject Method (CloudStorage_GoogleStorage Class)

Downloads an object.

Object Oriented Interface

public function doGetObject($objectname);

Procedural Interface

cloudstorage_googlestorage_do_getobject($res, $objectname);

Remarks

This methods downloads the object specified by ObjectName in the bucket currently selected by Bucket. If the VersionId 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 LocalFile is set, the object data will be saved to the specified location; otherwise, the object data will be held by ObjectData.

To download and decrypt an encrypted object, set EncryptionAlgorithm and EncryptionPassword 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 StartByte property. If a download is interrupted, set StartByte 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 LocalFile was set in the initial download attempt.

If LocalFile 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 StartByte, to allow the remainder of the encrypted data to be downloaded. Once the encrypted data is downloaded it will be decrypted and written to LocalFile. 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);

GetObjectInfo Method (CloudStorage_GoogleStorage Class)

Gets an object's information and metadata.

Object Oriented Interface

public function doGetObjectInfo($objectname);

Procedural Interface

cloudstorage_googlestorage_do_getobjectinfo($res, $objectname);

Remarks

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

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

Interrupt Method (CloudStorage_GoogleStorage Class)

Interrupt the current method.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

cloudstorage_googlestorage_do_interrupt($res);

Remarks

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

ListBuckets Method (CloudStorage_GoogleStorage Class)

Lists all buckets in the account.

Object Oriented Interface

public function doListBuckets();

Procedural Interface

cloudstorage_googlestorage_do_listbuckets($res);

Remarks

This method lists all buckets in the account.

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

ListObjects Method (CloudStorage_GoogleStorage Class)

Lists the objects in a bucket.

Object Oriented Interface

public function doListObjects();

Procedural Interface

cloudstorage_googlestorage_do_listobjects($res);

Remarks

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

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the objects whose names begin with a given string. The ObjectDelimiter 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 ObjectList event once for each object, and will also populate the Objects* properties. It may also fire the PrefixList 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 ObjectMarker property will be populated. Continue to call this method until ObjectMarker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix 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 ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

ListVersions Method (CloudStorage_GoogleStorage Class)

Lists the object versions in a bucket.

Object Oriented Interface

public function doListVersions();

Procedural Interface

cloudstorage_googlestorage_do_listversions($res);

Remarks

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

Before calling this method, the ObjectPrefix property may be set in order to restrict the results to only the object versions whose names begin with a given string. The ObjectDelimiter 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 ObjectList event once for each object version, and will also populate the Objects* properties. It may also fire the PrefixList 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 VersionMarker property will be populated. Continue to call this method until VersionMarker is empty to accumulate all pages of results in the Objects* properties.

Object Hierarchy Traversal

By using the ObjectDelimiter and ObjectPrefix 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 ObjectDelimiter set to /, we can set ObjectPrefix to successively "deeper" values before calling ListObjects or ListVersions for the following effect:

Reset Method (CloudStorage_GoogleStorage Class)

Resets the class to its initial state.

Object Oriented Interface

public function doReset();

Procedural Interface

cloudstorage_googlestorage_do_reset($res);

Remarks

This method resets the class to its initial state.

ResetHeaders Method (CloudStorage_GoogleStorage Class)

Resets all HTTP headers, cookies, and LocalFile.

Object Oriented Interface

public function doResetHeaders();

Procedural Interface

cloudstorage_googlestorage_do_resetheaders($res);

Remarks

Resets all the HTTP headers as well as LocalFile 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.

SendCustomRequest Method (CloudStorage_GoogleStorage Class)

Sends a custom request to the server.

Object Oriented Interface

public function doSendCustomRequest($httpmethod, $objectname, $requestbody);

Procedural Interface

cloudstorage_googlestorage_do_sendcustomrequest($res, $httpmethod, $objectname, $requestbody);

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:
   • UseSSL, Region, and UseVirtualHosting 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)
   • VersionId (if both it and ObjectName are non-empty)
   • QueryParam*
2. Adds request headers from:
   • ContentDisposition
   • ContentType
   • OtherHeaders
   • 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 LocalFile, or ObjectData (using the same logic as GetObject).

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.

UpdateBucketACL Method (CloudStorage_GoogleStorage Class)

Updates a bucket's canned access policy.

Object Oriented Interface

public function doUpdateBucketACL();

Procedural Interface

cloudstorage_googlestorage_do_updatebucketacl($res);

Remarks

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

UpdateObjectACL Method (CloudStorage_GoogleStorage Class)

Updates an object's canned access policy.

Object Oriented Interface

public function doUpdateObjectACL($objectname);

Procedural Interface

cloudstorage_googlestorage_do_updateobjectacl($res, $objectname);

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

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

BucketList Event (CloudStorage_GoogleStorage Class)

Fires once for each bucket returned when listing buckets.

Object Oriented Interface

public function fireBucketList($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 1, array($this, 'fireBucketList'));

Parameter List

 'bucketname'
 'creationdate'
 'ownerid'
 'ownername'

Remarks

This event fires once for each bucket returned when ListBuckets 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.

EndTransfer Event (CloudStorage_GoogleStorage Class)

This event fires when a document finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 2, array($this, 'fireEndTransfer'));

Parameter List

 'direction'

Remarks

The EndTransfer 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.

Error Event (CloudStorage_GoogleStorage Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 3, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

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

Header Event (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function fireHeader($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 4, array($this, 'fireHeader'));

Parameter List

 'field'
 'value'

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

Log Event (CloudStorage_GoogleStorage Class)

This event fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 5, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

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"

MetadataList Event (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function fireMetadataList($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 6, array($this, 'fireMetadataList'));

Parameter List

 'name'
 'value'

Remarks

This event fires once for each metadata item returned when GetObjectInfo 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.

ObjectList Event (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function fireObjectList($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 7, array($this, 'fireObjectList'));

Parameter List

 'bucketname'
 'objectname'
 'lastmodified'
 'size'
 'etag'
 'ownerid'
 'ownername'
 'uploadid'
 'versionid'
 'latestversion'
 'deleted'

Remarks

This event fires once for each object, or object version, returned when GetObjectInfo, ListObjects, or ListVersions 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 GetObjectInfo is called.

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

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

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

PrefixList Event (CloudStorage_GoogleStorage Class)

Fires once for each common prefix returned when listing objects.

Object Oriented Interface

public function firePrefixList($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 8, array($this, 'firePrefixList'));

Parameter List

 'bucketname'
 'prefix'

Remarks

This event fires once for each common prefix returned when ListObjects or ListVersions is called when ObjectDelimiter is non-empty. Refer to ObjectDelimiter for more information.

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

Prefix is the common prefix.

Progress Event (CloudStorage_GoogleStorage Class)

Fires during an upload or download to indicate transfer progress.

Object Oriented Interface

public function fireProgress($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 9, array($this, 'fireProgress'));

Parameter List

 'direction'
 'bytestransferred'
 'totalbytes'
 'percentdone'

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.

SSLServerAuthentication Event (CloudStorage_GoogleStorage Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 10, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

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.

SSLStatus Event (CloudStorage_GoogleStorage Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 11, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (CloudStorage_GoogleStorage Class)

This event fires when a document starts transferring (after the headers).

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 12, array($this, 'fireStartTransfer'));

Parameter List

 'direction'

Remarks

The StartTransfer 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.

Transfer Event (CloudStorage_GoogleStorage Class)

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

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

cloudstorage_googlestorage_register_callback($res, 13, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'bytestransferred'
 'percentdone'
 'text'

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.

Config Settings (GoogleStorage Class)

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

Trappable Errors (GoogleStorage Class)

Common Errors