GStorage Component

Properties Methods Events Configuration Settings Errors

The GStorage component implements the Google Storage for Developers API.

Syntax

nsoftware.InGoogle.Gstorage

Remarks

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

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

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.

This service supports authentication via OAuth 2.0. First, perform OAuth authentication using the OAuth component or a separate process. Once complete you should have an authorization string which looks like:

Bearer ya29.AHES6ZSZEJzATdZYjeihDn5W-VrXSsxEZu5p0pclxGdKKQ

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

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 component with short descriptions. Click on the links for further details.


AccessPolicy	The AccessPolicy are used to set permissions when a Bucket or an object is updated.
Authorization	OAuth 2.0 Authorization Token.
Bucket	The name of the current bucket.
Buckets	The list of buckets returned by a call to ListBuckets .
Connected	Shows whether the component is connected.
ContentDisposition	Content disposition for the object.
ContentType	Content type for the object.
EncryptionPassword	The password to use when encrypting the object.
Firewall	A set of properties related to firewall access.
FollowRedirects	Determines what happens when the server issues a redirect.
Idle	The current status of the component.
LocalFile	The path to a local file for uploading or downloading. When downloading, if the file exists it is overwritten (optional).
LocalHost	The name of the local host or user-assigned IP interface through which connections are initiated or accepted.
ObjectData	The contents of the object returned after calling GetObject , or the data to upload.
ObjectDelimiter	A delimiter can be used to organize multiple objects.
ObjectMarker	A marker for the object(s).
ObjectPrefix	A prefix for the object(s).
Objects	The objects returned by a call to ListObjects .
OtherHeaders	Other headers as determined by the user (optional).
Overwrite	Whether or not the component should overwrite files during transfer.
ParsedHeaders	Collection of headers returned from the last request.
ProjectId	The Id of the project.
Proxy	A set of properties related to proxy access.
Range	The byte-range to be sent to the server.
Referer	Referer URL/document (optional).
SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate.
SSLCert	The certificate to be used during SSL negotiation.
SSLServerCert	The server certificate for the last established connection.
StatusLine	The first line of the last server response.
Timeout	A timeout for the component.
UseSSL	Use SSL to access Google Storage.
UseVirtualHosting	Determines which style request to use.

Method List

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


AddUserMetaData	Adds meta data to an object.
Config	Sets or retrieves a configuration setting .
CopyObject	Make a copy of the specified object.
CreateBucket	Creates a new bucket.
CreateObject	Puts an object into a bucket.
DeleteBucket	Deletes a bucket.
DeleteObject	Deletes the specified object.
DoEvents	Processes events from the internal message queue.
GetBucketLocation	Returns the location of the specified bucket.
GetObject	Gets an object from a bucket.
GetObjectInfo	Returns the meta-data for the indicated object.
GetXValue	Retrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
Interrupt	Interrupt the current method.
ListBuckets	Lists all buckets in the account.
ListObjects	Lists all objects in a bucket.
Reset	Resets request-related properties.
ResetHeaders	Resets all HTTP headers, cookies, and localfile.
SendCustomRequest	Allows the sending of a custom request to Google Storage.
SetDownloadStream	Sets the stream to which the downloaded data from the server will be written.
SetUploadStream	Sets the stream to be uploaded to the server.
UpdateBucketACL	Updates the access policy of the specified bucket.
UpdateObjectACL	Updates the access policy of the specified object.

Event List

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


BucketList	Fired for every bucket when ListBuckets is called.
Connected	Fired immediately after a connection completes (or fails).
Disconnected	Fired when a connection is closed.
EndTransfer	Fired when a document finishes transferring.
Error	Information about errors during data delivery.
Header	Fired every time a header line comes in.
ObjectList	Fired for every object when ListObjects , or upload when ListMultipartUploads is called.
PrefixList	Fired for every prefix returned as a common prefix.
SSLServerAuthentication	Fired after the server presents its certificate to the client.
SSLStatus	Shows the progress of the secure connection.
StartTransfer	Fired when a document starts transferring (after the headers).
Status	Fired when the HTTP status line is received from the server.
Transfer	Fired while a document transfers (delivers document).

Configuration Settings

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


EventObjectSize	Used to retrieve the full object size from inside the ObjectList event.
ObjectSize	Used to set and retrieve object sizes information beyond the range of an integer.
ContentRange	This contains the range of bytes of the current object that are being returned.
EncryptionIV	The initialization vector to be used for encryption/decryption.
EncryptionKey	The key to use during AES encryption/decryption.
ETag	The ETag for the object returned by the server.
IfMatch	Check to make sure the object has not been modified since the last request.
EnforceBucketNameRestrictions	Allows the user to enforce Google-defined bucket name restrictions.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
AccessKey	The Access Key Id for the Google account.
SecretKey	The Secret Access Key Id for the Google account.
IncludeObjectMD5	Includes the MD5 digest of the object data if set.
IncludePartMD5	Includes the MD5 digest of the part data if set.
IsPaged	Whether or not all objects were returned by the last listing.
LocationConstraint	The location where buckets will be created.
MaxObjects	The maximum number of objects for the server to return.
HTTPMethod	Specifies the HTTP method to use when sending a custom request.
TransferredData	Returns the entire XML response received from Google.
URL	If set, the default URL will be overridden by this value.
AcceptEncoding	Used to tell the server which types of content encodings the client supports.
AllowHTTPCompression	This property enables HTTP compression for receiving data.
AllowIdenticalRedirectURL	Allow redirects to the same URL.
Append	Whether to append data to LocalFile.
Authorization	The Authorization string to be sent to the server.
BytesTransferred	Contains the number of bytes transferred in the response data.
EncodeURL	If set to true the URL will be encoded by the component.
FollowRedirects	Determines what happens when the server issues a redirect.
GetOn302Redirect	If set to true the component will perform a GET on the new location.
HTTPVersion	The version of HTTP used by the component.
IfModifiedSince	A date determining the maximum age of the desired document.
KeepAlive	Determines whether the HTTP connection is closed after completion of the request.
MaxRedirectAttempts	Limits the number of redirects that are followed in a request.
OtherHeaders	Other headers as determined by the user (optional).
ProxyAuthorization	The authorization string to be sent to the proxy server.
ProxyAuthScheme	The authorization scheme to be used for the proxy.
ProxyPassword	A password if authentication is to be used for the proxy.
ProxyPort	Port for the proxy server (default 80).
ProxyServer	Name or IP address of a proxy server (optional).
ProxyUser	A user name if authentication is to be used for the proxy.
TransferredDataLimit	The maximum number of incoming bytes to be stored by the component.
TransferredHeaders	The full set of headers as received from the server.
UseChunkedEncoding	Enables or Disables HTTP chunked encoding for transfers.
ChunkSize	Specifies the chunk size in bytes when using chunked encoding.
UserAgent	Information about the user agent (browser).
KerberosSPN	The Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeout	Sets a separate timeout value for establishing a connection.
FirewallAutoDetect	Tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHost	Name or IP address of firewall (optional).
FirewallPassword	Password to be used if authentication is to be used when connecting through the firewall.
FirewallPort	The TCP port for the FirewallHost;.
FirewallType	Determines the type of firewall to connect through.
FirewallUser	A user name if authentication is to be used connecting through a firewall.
KeepAliveTime	The inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveInterval	The retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
Linger	When set to True, connections are terminated gracefully.
LingerTime	Time in seconds to have the connection linger.
LocalHost	The name of the local host through which connections are initiated or accepted.
LocalPort	The TCP port in the local host where the component binds.
MaxLineLength	The maximum amount of data to accumulate when no EOL is found.
MaxTransferRate	The transfer rate limit in bytes per second.
RecordLength	The length of received data records.
TCPKeepAlive	Determines whether or not the keep alive socket option is enabled.
UseIPv6	Whether to use IPv6.
TcpNoDelay	Whether or not to delay when sending packets.
ReuseSSLSession	Determines if the SSL session is reused.
SSLCipherStrength	The minimum cipher strength used for bulk encryption.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
SSLProvider	The name of the security provider to use.
SSLSecurityFlags	Flags that control certificate verification.
OpenSSLCADir	The path to a directory containing CA certificates.
OpenSSLCAFile	Name of the file containing the list of CA's trusted by your application.
OpenSSLCipherList	A string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedData	The data to seed the pseudo random number generator (PRNG).
AbsoluteTimeout	Determines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallData	Used to send extra data to the firewall.
InBufferSize	The size in bytes of the incoming queue of the socket.
OutBufferSize	The size in bytes of the outgoing queue of the socket.
CodePage	The system code page used for Unicode to Multibyte translations.