Google Integrator 2016 Delphi Edition
Google Integrator 2016 Delphi Edition
Questions / Feedback?

GStorage Component

Properties   Methods   Events   Configuration Settings   Errors  

The GStorage component implements the Google Storage for Developers API.

Syntax

TibgGStorage

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.

AccessPolicyThe AccessPolicy are used to set permissions when a Bucket or an object is updated.
AuthorizationOAuth 2.0 Authorization Token.
BucketThe name of the current bucket.
BucketsCountThe number of records in the Buckets arrays.
BucketsCreationDateThe creation date of the current bucket.
BucketsNameThe name of the current bucket.
BucketsOwnerDisplayNameThe display name of the current bucket's owner.
BucketsOwnerIdThe owner of the current bucket.
ConnectedShows whether the component is connected.
ContentDispositionContent disposition for the object.
ContentTypeContent type for the object.
EncryptionPasswordThe password to use when encrypting the object.
FirewallAutoDetectThis property tells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallTypeThis property determines the type of firewall to connect through.
FirewallHostThis property contains the name or IP address of firewall (optional).
FirewallPasswordThis property contains a password if authentication is to be used when connecting through the firewall.
FirewallPortThis property contains the TCP port for the firewall Host .
FirewallUserThis property contains a user name if authentication is to be used connecting through a firewall.
FollowRedirectsDetermines what happens when the server issues a redirect.
IdleThe current status of the component.
LocalFileThe path to a local file for uploading or downloading. When downloading, if the file exists it is overwritten (optional).
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
ObjectDataThe contents of the object returned after calling GetObject , or the data to upload.
ObjectDelimiterA delimiter can be used to organize multiple objects.
ObjectMarkerA marker for the object(s).
ObjectPrefixA prefix for the object(s).
ObjectsCountThe number of records in the Objects arrays.
ObjectsETagAn Etag for the current object.
ObjectsNameThe name (key) of the current object.
ObjectsLastModifiedThe date and time at which the object was last modified.
ObjectsOwnerDisplayNameThe display name of the Object owner.
ObjectsOwnerIdThe owner ID of the Object.
ObjectsSizeThe size of the current object.
ObjectsStorageClassThe storage type of the current object.
OtherHeadersOther headers as determined by the user (optional).
OverwriteWhether or not the component should overwrite files during transfer.
ParsedHeaderCountThe number of records in the ParsedHeader arrays.
ParsedHeaderFieldThis property contains the name of the HTTP header (same case as it is delivered).
ParsedHeaderValueThis property contains the header contents.
ProjectIdThe Id of the project.
ProxyAuthSchemeThis property is used to tell the component which type of authorization to perform when connecting to the proxy.
ProxyAutoDetectThis property tells the component whether or not to automatically detect and use proxy system settings, if available.
ProxyPasswordThis property contains a password if authentication is to be used for the proxy.
ProxyPortThis property contains the TCP port for the proxy Server (default 80).
ProxyServerIf a proxy Server is given, then the HTTP request is sent to the proxy instead of the server otherwise specified.
ProxySSLThis property determines when to use SSL for the connection to the proxy.
ProxyUserThis property contains a user name, if authentication is to be used for the proxy.
RangeThe byte-range to be sent to the server.
RefererReferer URL/document (optional).
SSLAcceptServerCertEncodedThe certificate (PEM/base64 encoded).
SSLCertEncodedThe certificate (PEM/base64 encoded).
SSLCertStoreThe name of the certificate store for the client certificate.
SSLCertStorePasswordIf the certificate store is of a type that requires a password, this property is used to specify that password in order to open the certificate store.
SSLCertStoreTypeThe type of certificate store for this certificate.
SSLCertSubjectThe subject of the certificate used for client authentication.
SSLServerCertEncodedThe certificate (PEM/base64 encoded).
StatusLineThe first line of the last server response.
TimeoutA timeout for the component.
UseSSLUse SSL to access Google Storage.
UseVirtualHostingDetermines 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.

AddUserMetaDataAdds meta data to an object.
ConfigSets or retrieves a configuration setting .
CopyObjectMake a copy of the specified object.
CreateBucketCreates a new bucket.
CreateObjectPuts an object into a bucket.
DeleteBucketDeletes a bucket.
DeleteObjectDeletes the specified object.
DoEventsProcesses events from the internal message queue.
GetBucketLocationReturns the location of the specified bucket.
GetObjectGets an object from a bucket.
GetObjectInfoReturns the meta-data for the indicated object.
GetXValueRetrieves a valid XPath expression from the HTTP response after calling SendCustomRequest .
InterruptInterrupt the current method.
ListBucketsLists all buckets in the account.
ListObjectsLists all objects in a bucket.
ResetResets request-related properties.
ResetHeadersResets all HTTP headers, cookies, and localfile.
SendCustomRequestAllows the sending of a custom request to Google Storage.
UpdateBucketACLUpdates the access policy of the specified bucket.
UpdateObjectACLUpdates 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.

BucketListFired for every bucket when ListBuckets is called.
ConnectedFired immediately after a connection completes (or fails).
DisconnectedFired when a connection is closed.
EndTransferFired when a document finishes transferring.
ErrorInformation about errors during data delivery.
HeaderFired every time a header line comes in.
ObjectListFired for every object when ListObjects , or upload when ListMultipartUploads is called.
PrefixListFired for every prefix returned as a common prefix.
SSLServerAuthenticationFired after the server presents its certificate to the client.
SSLStatusShows the progress of the secure connection.
StartTransferFired when a document starts transferring (after the headers).
StatusFired when the HTTP status line is received from the server.
TransferFired 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.

EventObjectSizeUsed to retrieve the full object size from inside the ObjectList event.
ObjectSizeUsed to set and retrieve object sizes information beyond the range of an integer.
ContentRangeThis contains the range of bytes of the current object that are being returned.
EncryptionIVThe initialization vector to be used for encryption/decryption.
EncryptionKeyThe key to use during AES encryption/decryption.
ETagThe ETag for the object returned by the server.
IfMatchCheck to make sure the object has not been modified since the last request.
EnforceBucketNameRestrictionsAllows the user to enforce Google-defined bucket name restrictions.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
AccessKeyThe Access Key Id for the Google account.
SecretKeyThe Secret Access Key Id for the Google account.
IncludeObjectMD5Includes the MD5 digest of the object data if set.
IncludePartMD5Includes the MD5 digest of the part data if set.
IsPagedWhether or not all objects were returned by the last listing.
LocationConstraintThe location where buckets will be created.
MaxObjectsThe maximum number of objects for the server to return.
HTTPMethodSpecifies the HTTP method to use when sending a custom request.
TransferredDataReturns the entire XML response received from Google.
URLIf set, the default URL will be overridden by this value.
AcceptEncodingUsed to tell the server which types of content encodings the client supports.
AllowHTTPCompressionThis property enables HTTP compression for receiving data.
AllowHTTPFallbackWhether HTTP/2 connections are permitted to fallback to HTTP/1.1.
AppendWhether to append data to LocalFile.
AuthorizationThe Authorization string to be sent to the server.
BytesTransferredContains the number of bytes transferred in the response data.
EncodeURLIf set to true the URL will be encoded by the component.
FollowRedirectsDetermines what happens when the server issues a redirect.
GetOn302RedirectIf set to true the component will perform a GET on the new location.
HTTPVersionThe version of HTTP used by the component.
IfModifiedSinceA date determining the maximum age of the desired document.
KeepAliveDetermines whether the HTTP connection is closed after completion of the request.
LogLevelThe level of detail that is logged.
MaxRedirectAttemptsLimits the number of redirects that are followed in a request.
NegotiatedHTTPVersionThe negotiated HTTP version.
OtherHeadersOther headers as determined by the user (optional).
ProxyAuthorizationThe authorization string to be sent to the proxy server.
ProxyAuthSchemeThe authorization scheme to be used for the proxy.
ProxyPasswordA password if authentication is to be used for the proxy.
ProxyPortPort for the proxy server (default 80).
ProxyServerName or IP address of a proxy server (optional).
ProxyUserA user name if authentication is to be used for the proxy.
TransferredDataThe contents of the last response from the server.
TransferredDataLimitThe maximum number of incoming bytes to be stored by the component.
TransferredHeadersThe full set of headers as received from the server.
UseChunkedEncodingEnables or Disables HTTP chunked encoding for transfers.
ChunkSizeSpecifies the chunk size in bytes when using chunked encoding.
UserAgentInformation about the user agent (browser).
KerberosSPNThe Service Principal Name for the Kerberos Domain Controller.
ConnectionTimeoutSets a separate timeout value for establishing a connection.
FirewallAutoDetectTells the component whether or not to automatically detect and use firewall system settings, if available.
FirewallHostName or IP address of firewall (optional).
FirewallPasswordPassword to be used if authentication is to be used when connecting through the firewall.
FirewallPortThe TCP port for the FirewallHost;.
FirewallTypeDetermines the type of firewall to connect through.
FirewallUserA user name if authentication is to be used connecting through a firewall.
KeepAliveTimeThe inactivity time in milliseconds before a TCP keep-alive packet is sent.
KeepAliveIntervalThe retry interval, in milliseconds, to be used when a TCP keep-alive packet is sent and no response is received.
LingerWhen set to True, connections are terminated gracefully.
LingerTimeTime in seconds to have the connection linger.
LocalHostThe name of the local host through which connections are initiated or accepted.
LocalPortThe port in the local host where the component binds.
MaxLineLengthThe maximum amount of data to accumulate when no EOL is found.
MaxTransferRateThe transfer rate limit in bytes per second.
ProxyExceptionsListA semicolon separated list of hosts and IPs to bypass when using a proxy.
TCPKeepAliveDetermines whether or not the keep alive socket option is enabled.
UseIPv6Whether to use IPv6.
TcpNoDelayWhether or not to delay when sending packets.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLProviderThe name of the security provider to use.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
OpenSSLCADirThe path to a directory containing CA certificates.
OpenSSLCAFileName of the file containing the list of CA's trusted by your application.
OpenSSLCipherListA string that controls the ciphers to be used by SSL.
OpenSSLPrngSeedDataThe data to seed the pseudo random number generator (PRNG).
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
FirewallDataUsed to send extra data to the firewall.
InBufferSizeThe size in bytes of the incoming queue of the socket.
OutBufferSizeThe size in bytes of the outgoing queue of the socket.
CodePageThe system code page used for Unicode to Multibyte translations.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Google Integrator 2016 Delphi Edition - Version 16.0 [Build 6454]