package
3.0.2+incompatible
Repository: https://github.com/aliyun/aliyun-oss-go-sdk.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
AcceptEncoding is an option to set Accept-Encoding header.
ACL is an option to set X-Oss-Acl header.
ACReqHeaders is an option to set Access-Control-Request-Headers header.
ACReqMethod is an option to set Access-Control-Request-Method header.
No description provided by the author
AdditionalHeaders sets special http headers needed to be signed.
AddParam Allow users to set personalized http params.
AdjustRange returns adjusted range, adjust the range according to the length of the file.
ForbidOverWrite is an option to set X-Oss-Forbid-Overwrite.
AuthProxy sets the proxy information with user name and password.
AuthVersion sets auth version: v1 or v2 signature which oss_server needed.
BuildLifecycleRuleByDate builds a lifecycle rule objects will expiration in specified date.
BuildLifecycleRuleByDays builds a lifecycle rule objects will expiration in days after the last modified time.
CacheControl is an option to set Cache-Control header.
Callback is an option to set callback values.
CallbackResult for get response of call back.
CallbackVar is an option to set callback user defined values.
No description provided by the author
CheckCallbackResp return error if the given response code is not 200.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Checkpoint sets the isEnable flag and checkpoint file path for DownloadFile/UploadFile.
CheckpointDir sets the isEnable flag and checkpoint dir path for DownloadFile/UploadFile.
CheckRespCode returns UnexpectedStatusError if the given response code is not one of the allowed status codes; otherwise nil.
ChoiceAbortPartOption choices valid option supported by AbortMultipartUpload.
ChoiceCompletePartOption choices valid option supported by CompleteMulitiPart.
ChoiceHeadObjectOption choices valid option supported by HeadObject.
choiceTransferPartOption choices valid option supported by Uploadpart or DownloadPart.
CloudBoxId set cloudBox id.
ContentDisposition is an option to set Content-Disposition header.
ContentEncoding is an option to set Content-Encoding header.
ContentLanguage is an option to set Content-Language header.
ContentLength is an option to set Content-Length header.
ContentMD5 is an option to set Content-MD5 header.
ContentType is an option to set Content-Type header.
ContinuationToken is an option to set Continuation-token parameter for ListObjectsV2.
No description provided by the author
CopySource is an option to set X-Oss-Copy-Source header.
CopySourceIfMatch is an option to set X-Oss-Copy-Source-If-Match header.
CopySourceIfModifiedSince is an option to set X-Oss-CopySource-If-Modified-Since header.
CopySourceIfNoneMatch is an option to set X-Oss-Copy-Source-If-None-Match header.
CopySourceIfUnmodifiedSince is an option to set X-Oss-Copy-Source-If-Unmodified-Since header.
CopySourceRange is an option to set X-Oss-Copy-Source header.
CopySourceVersion is an option to set X-Oss-Copy-Source header,include versionId.
CRC64Combine combines CRC64.
DeleteObjectsQuiet false:DeleteObjects in verbose mode; true:DeleteObjects in quite mode.
No description provided by the author
Delimiter is an option to set delimiler parameter.
EnableCRC enables the CRC checksum.
EnableMd5 is an option to set x-oss-enable-md5 parameter for InitiateMultipartUpload.
EnableMD5 enables MD5 validation.
EnableSha1 is an option to set x-oss-enable-sha1 parameter for InitiateMultipartUpload.
EnableSha256 is an option to set x-oss-enable-sha256 parameter for InitiateMultipartUpload.
EncodingType is an option to set encoding-type parameter.
No description provided by the author
EscapeString writes to p the properly escaped XML equivalent of the plain text data s.
Expires is an option to set Expires header.
FetchOwner is an option to set Fetch-owner parameter for ListObjectsV2.
No description provided by the author
ForbidOverWrite is an option to set X-Oss-Forbid-Overwrite.
ForcePathStyle sets the flag of using Path Style.
No description provided by the author
No description provided by the author
No description provided by the author
GetNowGMT gets the current time in GMT format.
GetNowNanoSec returns t as a Unix time, the number of nanoseconds elapsed since January 1, 1970 UTC.
GetNowSec returns Unix time, the number of seconds elapsed since January 1, 1970 UTC.
GetOssLimiter create OssLimiter uploadSpeed KB/s.
GetPartEnd calculates the end position.
GetProgressListener gets the progress callback.
No description provided by the author
GetRangeConfig gets the download range from the options.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
GetResponseHeader for get response http header.
No description provided by the author
HTTPClient sets the http.Client in use to the one passed in
.
IfMatch is an option to set If-Match header.
IfModifiedSince is an option to set If-Modified-Since header.
IfNoneMatch is an option to set IfNoneMatch header.
IfUnmodifiedSince is an option to set If-Unmodified-Since header.
InitCRC Init AppendObject CRC.
InsecureSkipVerify skip verifying tls certificate file.
InvalidRangeError returns invalid range error.
No description provided by the author
KeyMarker is an option to set key-marker parameter.
No description provided by the author
ListType is an option to set List-type parameter for ListObjectsV2.
Marker is an option to set marker parameter.
MaxConns sets the HTTP max connections for a client.
MaxKeys is an option to set maxkeys parameter.
MaxParts is an option to set max-parts parameter.
MaxUploads is an option to set max-uploads parameter.
MD5ThresholdCalcInMemory sets the memory usage threshold for computing the MD5, default is 16MB.
Meta is an option to set Meta header.
MetadataDirective is an option to set X-Oss-Metadata-Directive header.
New creates a new client.
NewCRC creates a new hash.Hash64 computing the CRC64 checksum using the polynomial represented by the Table.
No description provided by the author
NormalizedRange is an option to set Range header, such as 1024-2048 or 1024- or -2048.
ObjectACL is an option to set X-Oss-Object-Acl header.
RedundancyType bucket data redundancy type.
ObjectStorageClass is an option to set the storage class of object.
Origin is an option to set Origin header.
ParseRange parse various styles of range such as bytes=M-N.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PartNumberMarker is an option to set part-number-marker parameter.
Prefix is an option to set prefix parameter.
Process is an option to set x-oss-process param.
Product set product type.
Progress set progress listener.
Proxy sets the proxy (optional).
Range is an option to set Range header, [start, end].
RangeBehavior is an option to set Range value, such as "standard".
RedirectEnabled only effective from go1.7 onward,RedirectEnabled set http redirect enabled or not.
RedundancyType bucket data redundancy type.
Region set region.
RequestPayer is an option to set payer who pay for the request.
RequestPayerParam is an option to set payer who pay for the request.
ResponseCacheControl is an option to set response-cache-control param.
ResponseContentDisposition is an option to set response-content-disposition param.
ResponseContentEncoding is an option to set response-content-encoding param.
ResponseContentLanguage is an option to set response-content-language param.
ResponseContentType is an option to set response-content-type param.
ResponseExpires is an option to set response-expires param.
Routines DownloadFile/UploadFile routine count.
SecurityToken sets the temporary user's SecurityToken.
Sequential is an option to set sequential parameter for InitiateMultipartUpload.
ServerSideDataEncryption is an option to set X-Oss-Server-Side-Data-Encryption header.
ServerSideEncryption is an option to set X-Oss-Server-Side-Encryption header.
ServerSideEncryptionKeyID is an option to set X-Oss-Server-Side-Encryption-Key-Id header.
SetCredentialsProvider sets function for get the user's ak.
SetHeader Allow users to set personalized http headers.
SetLocalAddr sets function for local addr.
SetLogger sets the oss sdk logger
.
SetLogLevel sets the oss sdk log level
.
SetTagging is an option to set object tagging.
SplitFileByPartNum splits big file into parts by the num of parts.
SplitFileByPartSize splits big file into parts by the size of parts.
SSECAlgorithm is an option to set X-Oss-Server-Side-Encryption-Customer-Algorithm header.
SSECKey is an option to set X-Oss-Server-Side-Encryption-Customer-Key header.
SSECKeyMd5 is an option to set X-Oss-Server-Side-Encryption-Customer-Key-Md5 header.
StartAfter is an option to set start-after parameter for ListObjectsV2.
StorageClass bucket storage class.
TaggingDirective is an option to set X-Oss-Metadata-Directive header.
TagKey is an option to set tag key parameter.
TagValue is an option to set tag value parameter.
TeeReader returns a Reader that writes to w what it reads from r.
Timeout sets the HTTP timeout in seconds.
TrafficLimitHeader is an option to set X-Oss-Traffic-Limit.
TrafficLimitParam is a option to set x-oss-traffic-limit.
TypeByExtension returns the MIME type associated with the file extension ext.
UploadIDMarker is an option to set upload-id-marker parameter.
UseCname sets the flag of using CName.
UserAgent specifies UserAgent.
UserAgentHeader is an option to set HTTPHeaderUserAgent.
VerifyObjectStrict sets the flag of verifying object name strictly.
VersionId is an option to set versionId parameter.
VersionIdMarker is an option to set version-id-marker parameter.
WithContext returns an option that sets the context for requests.
WithHashContext is an option to set withHashContext parameter for InitiateMultipartUpload.
# Constants
ACLDefault Object.
ACLPrivate definition : private read and write.
ACLPublicRead definition : public read and private write.
ACLPublicReadWrite definition : public read and public write.
No description provided by the author
AuthV1 v1.
AuthV2 v2.
AuthV4 v4.
BucketOwner the requester who send the request.
Checkpoint file suffix.
FrameType.
FrameType.
Define the level of the output log.
for v4 signature.
FrameType.
Define the level of the output log.
Default file permission.
No description provided by the author
No description provided by the author
HTTPDelete HTTP DELETE.
HTTPGet HTTP GET.
HTTPHead HTTP HEAD.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP headers.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTP Param.
HTTPPost HTTP POST.
HTTPPut HTTP PUT.
Define the level of the output log.
No description provided by the author
Define the level of the output log.
Max part size, 5GB.
MetaCopy the target object's metadata is copied from the source one.
FrameType.
FrameType.
MetaReplace the target object's metadata is created as part of the copy request (not same as the source one).
Min part size, 100KB.
Other constants.
RedundancyLRS Local redundancy, default value.
RedundancyZRS Same city redundancy.
Requester the requester who send the request.
RestoreBulk object will be restored in 5-10 hours.
RestoreExpedited object will be restored in 1 hour.
RestoreStandard object will be restored in 2-5 hours.
No description provided by the author
StorageArchive archive.
StorageColdArchive cold archive.
StorageDeepColdArchive deep cold archive.
StorageIA infrequent access.
StorageStandard standard.
TaggingCopy the target object's tagging is copied from the source one.
TaggingReplace the target object's tagging is created as part of the copy request (not same as the source one).
Temp file prefix.
Temp file suffix.
TransferCompletedEvent transfer completed.
TransferDataEvent transfer data, set ConsumedBytes and TotalBytes.
TransferFailedEvent transfer encounters an error.
TransferStartedEvent transfer started, set TotalBytes.
Go SDK version.
Versioning Status definition: Enabled.
Versioning Status definition: Suspended.
Define the level of the output log.
# Structs
AppendObjectRequest is the requtest of DoAppendObject.
AppendObjectResult is the result of DoAppendObject.
AsyncFetchTaskConfiguration for SetBucketAsyncFetchTask.
AsyncFetchTaskResult for SetBucketAsyncFetchTask result.
AsyncProcessObjectResult defines result object of AsyncProcessObject.
AsyncTaskInfo for async task information.
AsynFetchTaskInfo for GetBucketAsyncFetchTask result.
Bucket implements the operations of object.
BucketAccessMonitorXml define get bucket access monitor information.
BucketCnameXml define get the bucket cname information.
BucketInfo defines Bucket information.
BucketListStyleXml define the list style of the bucket.
BucketProperties defines bucket properties.
BucketQoSConfiguration define QoS configuration.
BucketReplicationLocationXml define the xml of bucket replication location info.
BucketReplicationProgressXml define the xml of bucket replication config.
BucketReplicationXml define the xml of bucket replication config.
BucketResourceGroupXml define the information of the bucket's resource group.
BucketRTCXml define the xml of bucket rtc config.
No description provided by the author
BucketStyleXml define the information of the bucket's style.
Certificate define Details of domain name certificate.
No description provided by the author
Client SDK's entry point.
CloudBoxProperties defines cloudbox properties.
Cname define the cname information.
CnameConfigurationXML define cname configuration.
CnameTokenXML define cname token information.
CompleteMultipartUploadResult defines result object of CompleteMultipartUploadRequest.
Condition defines codition in the RoutingRule.
Config defines oss configuration.
Conn defines OSS Conn.
CopyObjectResult defines result object of CopyObject.
CORSRule defines CORS rules.
CORSXML defines CORS configuration.
CRCCheckError is returned when crc check is inconsistent between client and server.
CreateLiveChannelResult the result of crete live-channel.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
DeletedKeyInfo defines object delete info.
DeleteObject defines the struct for deleting object.
DeleteObjectsResult defines result of DeleteObjects request.
DeleteObjectVersionsResult defines result of DeleteObjects request.
No description provided by the author
DoMetaQueryResultXml defines do meta query information.
EndFrame is EndFrameType of SelectObject api.
No description provided by the author
ErrorDocument defines the 404 error page info.
ExtendWormConfiguration define ExtendWormConfiguration configuration.
FileChunk is the file chunk definition.
GetBucketACLResult defines GetBucketACL request's result.
GetBucketInfoResult defines the result from GetBucketInfo request.
GetMetaQueryStatusResultXml define get meta query status information.
GetObjectRequest is the request of DoGetObject.
GetObjectResult is the result of DoGetObject.
HTTPMaxConns defines max idle connections and max idle connections per host.
HTTPTimeout defines HTTP timeout.
IncludeHeader defines includeHeader in the RoutingRule's Condition.
IndexDocument defines the index page info.
InitiateMultipartUploadResult defines result of InitiateMultipartUpload request.
InitiateWormConfiguration define InitiateBucketWorm configuration.
No description provided by the author
No description provided by the author
No description provided by the author
InventoryConfiguration is Inventory config.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
LifecycleAbortMultipartUpload defines the rule's abort multipart upload propery.
LifecycleConfiguration is the Bucket Lifecycle configuration.
LifecycleExpiration defines the rule's expiration property.
LifecycleFilter defines the rule's Filter propery.
LifecycleFilterNot defines the rule's Filter Not propery.
LifecycleRule defines Lifecycle rules.
LifecycleTransition defines the rule's transition propery.
LifecycleVersionExpiration defines the rule's NoncurrentVersionExpiration propery.
LifecycleVersionTransition defines the rule's NoncurrentVersionTransition propery.
LimitedRC support Close().
LimitSpeedReader for limit bandwidth upload.
ListBucketsResult defines the result object from ListBuckets request.
ListCloudBoxResult defines the result object from ListBuckets request.
No description provided by the author
ListLiveChannelResult the result of ListLiveChannel.
ListMultipartUploadResult defines result object of ListMultipartUpload.
ListObjectsResult defines the result from ListObjects request.
ListObjectsResultV2 defines the result from ListObjectsV2 request.
ListObjectVersionsResult defines the result from ListObjectVersions request.
ListUploadedPartsResult defines result object of ListUploadedParts.
LiveChannelAudio audio stream information.
LiveChannelConfiguration defines the configuration for live-channel.
LiveChannelHistory the result of GetLiveChannelHistory, at most return up to lastest 10 push records.
LiveChannelInfo the infomation of live-channel.
LiveChannelSnapshot snapshot configuration of live-channel.
LiveChannelStat the result of get live-channel state.
LiveChannelTarget target configuration of live-channel.
LiveChannelVideo video stream information.
LiveRecord push recode.
LoggingEnabled defines the logging configuration information.
LoggingXML defines logging configuration.
MetaEndFrameCSV is MetaEndFrameCSVType of CreateSelectObjectMeta.
MetaEndFrameJSON is MetaEndFrameJSON of CreateSelectObjectMeta.
MetaQuery defines meta query struct.
MetaQueryAggregationRequest defines meta query aggregation request.
MetaQueryAggregationResponse defines meta query aggregation response.
MetaQueryFile defines do meta query result file information.
MetaQueryGroup defines do meta query result group information.
MetaQueryTagging defines do meta query result tagging information.
MetaQueryUserMeta defines do meta query result user meta information.
MirrorHeaders defines MirrorHeaders in the Redirect.
MirrorHeaderSet defines Set for Redirect's MirrorHeaders.
No description provided by the author
ObjectProperties defines Objecct properties.
No description provided by the author
No description provided by the author
No description provided by the author
OssLimiter wrapper rate.Limiter.
No description provided by the author
Owner defines Bucket/Object's owner.
PostSelectResult is the request of SelectObject.
ProcessObjectResult defines result object of ProcessObject.
ProgressEvent defines progress event.
PutBucketCnameXml define cname configuration.
PutObjectRequest is the request of DoPutObject.
ReadFlagInfo if reading the frame data, recode the reading status.
Redirect defines redirect in the RoutingRule.
No description provided by the author
RefererXML defines Referer configuration.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ReplicationRule define the xml of bucket replication config rule.
No description provided by the author
No description provided by the author
No description provided by the author
ReplicationXML defines simple replication xml, and ReplicationXML is used for "DeleteBucketReplication" in client.go.
RequestPaymentConfiguration define the request payment configuration.
Response defines HTTP response from OSS.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RestoreConfiguration for RestoreObject.
RoutingRule defines the routing rules.
SelectObjectResponse defines HTTP response from OSS SelectObject.
SelectObjectResult is the SelectObject api's return.
SelectOptions is a element in the SelectObject api request's params.
SelectRequest is for the SelectObject request params of json file.
ServerEncryptionRule Server Encryption rule for the bucket.
ServiceError contains fields of the error response from Oss Service REST API.
SSEDefaultRule Server Encryption deafult rule for the bucket.
No description provided by the author
Tag a tag for the object.
Tagging tag set for the object.
TransferAccConfiguration define transfer acceleration configuration.
UncompletedUpload structure wraps an uncompleted upload task.
UnexpectedStatusCodeError is returned when a storage service responds with neither an error nor with an HTTP status code indicating success.
UnpackedRange.
UploadedPart defines uploaded part.
UploadPart defines the upload/copy part.
UploadPartCopyResult defines result object of multipart copy request.
UploadPartRequest is the request of DoUploadPart.
UploadPartResult is the result of DoUploadPart.
UserQoSConfiguration define QoS and Range configuration.
VersioningConfig for the bucket.
WebsiteXML defines Website configuration.
WormConfiguration define WormConfiguration.
# Interfaces
Credentials is interface for get AccessKeyID,AccessKeySecret,SecurityToken.
CredentialsProvider is interface for get Credential Info.
No description provided by the author
ProgressListener listens progress change.
# Type aliases
ACLType bucket/object ACL.
AlgorithmType specifying the server side encryption algorithm name.
AuthVersion the version of auth.
Client SDK's entry point.
CreateBucketCnameTokenResult defines result object for CreateBucketCnameToken request.
RedundancyType bucket data Redundancy type.
DescribeRegionsResult define get the describe regions result.
DoMetaQueryResult defines result for DoMetaQuery result.
GetBucketAccessMonitorResult define config for get bucket access monitor.
GetBucketCnameTokenResult defines result object for GetBucketCnameToken request.
GetBucketCORSResult defines the result from GetBucketCORS request.
No description provided by the author
GetBucketLifecycleResult defines GetBucketLifecycle's result object.
GetBucketListStyleResult define the list style for the bucket.
GetBucketLoggingResult defines the result from GetBucketLogging request.
GetBucketRefererResult defines result object for GetBucketReferer request.
GetBucketReplicationLocationResult define get bucket's replication location.
GetBucketReplicationProgressResult define get bucket's replication progress.
GetBucketReplicationResult define get bucket's replication config.
GetBucketResourceGroupResult define resource group for the bucket.
GetBucketResponseHeaderResult define the xml of bucket's response header result.
No description provided by the author
GetBucketStyleResult define style for the bucket.
No description provided by the author
No description provided by the author
GetBucketWebsiteResult defines the result from GetBucketWebsite request.
GetMetaQueryStatusResult defines result for GetMetaQueryStatus result.
GetObjectACLResult defines result of GetObjectACL request.
GetObjectTaggingResult for GetObjectTagging return value.
HTTPMethod HTTP request method.
ListBucketCnameResult define the cname list of the bucket.
MetadataDirectiveType specifying whether use the metadata of source object when copying object.
ObjecthashFuncType.
No description provided by the author
PayerType the type of request payer.
ProgressEventType defines transfer progress event type.
PutBucketAccessMonitor define the xml of bucket access monitor config.
No description provided by the author
PutBucketCORS defines the PutBucketCORS config xml.
PutBucketReplication define the bucket replication config.
PutBucketResourceGroup define the xml of bucket's resource group config.
PutBucketResponseHeader define the xml of bucket's response header config.
PutBucketRTC define the bucket rtc config.
RestoreMode the restore mode for coldArchive object.
StorageClassType bucket storage type.
TaggingDirectiveType specifying whether use the tagging of source object when copying object.
No description provided by the author
bucket versioning status.