package
0.0.0-20210831081626-d823fe11ceba
Repository: https://github.com/huaweicloud/golangsdk.git
Documentation: pkg.go.dev

# README

Version:3.21.1

You can get the latest source code from here, then unzip the file.

# Functions

Base64Decode wrapper of base64.StdEncoding.DecodeString.
Base64Encode wrapper of base64.StdEncoding.EncodeToString.
Base64Md5 returns the md5 value of input with Base64Encode.
CloseLog disable logging and synchronize cache data to log files.
ConverntObsRestoreToXml converts RestoreObjectInput value to XML data and returns it.
ConvertAclToXml converts AccessControlPolicy value to XML data and returns it.
ConvertCompleteMultipartUploadInputToXml converts CompleteMultipartUploadInput value to XML data and returns it.
ConvertEncryptionConfigurationToXml converts BucketEncryptionConfiguration value to XML data and returns it.
ConvertLifecyleConfigurationToXml converts BucketLifecyleConfiguration value to XML data and returns it.
ConvertLoggingStatusToXml converts BucketLoggingStatus value to XML data and returns it.
ConvertNotificationToXml converts BucketNotification value to XML data and returns it.
ConvertRequestToIoReader converts req to XML data.
ConvertRequestToIoReaderV2 converts req to XML data.
ConvertWebsiteConfigurationToXml converts BucketWebsiteConfiguration value to XML data and returns it.
DoLog writes log messages to the logger.
DummyQueryEscape return the input string.
FormatUtcNow gets a textual representation of the UTC format time value.
FormatUtcToRfc1123 gets a textual representation of the RFC1123 format time value.
GetAuthorization Authorization.
GetCurrentTimestamp gets unix time in milliseconds.
GetV2Authorization v2 Authorization.
Hex wrapper of hex.EncodeToString.
HexMd5 returns the md5 value of input in hexadecimal format.
HexSha256 returns the Sha256Hash value of input in hexadecimal format.
HmacSha1 gets hmac sha1 value of input.
HmacSha256 get hmac sha256 value if input.
InitLog enable logging function with default cacheCnt.
InitLogWithCacheCnt enable logging function.
Int64ToString converts int64 value to string value.
IntToString converts int value to string value.
IsIP checks whether the value matches ip address.
Md5 gets the md5 value of input.
New creates a new ObsClient instance.
No description provided by the author
No description provided by the author
No description provided by the author
NewNochanPool creates a new NoChanPool instance.
NewRoutinePool creates a RoutinePool instance.
ParseCompleteMultipartUploadOutput sets CompleteMultipartUploadOutput field values with response headers.
ParseCopyObjectOutput sets CopyObjectOutput field values with response headers.
ParseCopyPartOutput sets CopyPartOutput field values with response headers.
ParseDeleteObjectOutput sets DeleteObjectOutput field values with response headers.
ParseGetBucketMetadataOutput sets GetBucketMetadataOutput field values with response headers.
ParseGetObjectMetadataOutput sets GetObjectMetadataOutput field values with response headers.
ParseGetObjectOutput sets GetObjectOutput field values with response headers.
ParseInitiateMultipartUploadOutput sets InitiateMultipartUploadOutput field values with response headers.
ParsePutObjectOutput sets PutObjectOutput field values with response headers.
ParseResponseToBaseModel gets response from OBS.
ParseResponseToObsError gets obsError from OBS.
ParseSetObjectMetadataOutput sets SetObjectMetadataOutput field values with response headers.
ParseStringToEventType converts string value to EventType value and returns it.
ParseStringToStorageClassType converts string value to StorageClassType value and returns it.
ParseUploadPartOutput sets UploadPartOutput field values with response headers.
ParseXml wrapper of xml.Unmarshal.
Sha256Hash returns sha256 checksum.
StringContains replaces subStr in src with subTranscoding and returns the new string.
StringToInt converts string value to int value with default value.
StringToInt64 converts string value to int64 value with default value.
TransToXml wrapper of xml.Marshal.
UrlDecode wrapper of url.QueryUnescape.
UrlDecodeWithoutError wrapper of UrlDecode.
UrlEncode encodes the input value.
V4Auth is a wrapper for v4Auth.
WithConnectTimeout is a configurer for ObsClient to set timeout period for establishing an http/https connection, in seconds.
WithCustomDomainName is a configurer for ObsClient.
WithEnableCompression is a configurer for ObsClient to set the Transport.DisableCompression.
WithHeaderTimeout is a configurer for ObsClient to set the timeout period of obtaining the response headers.
WithHttpTransport is a configurer for ObsClient to set the customized http Transport.
WithIdleConnTimeout is a configurer for ObsClient to set the timeout period of an idle HTTP connection in the connection pool, in seconds.
WithMaxConnections is a configurer for ObsClient to set the maximum number of idle HTTP connections.
WithMaxRedirectCount is a configurer for ObsClient to set the maximum number of times that the request is redirected.
WithMaxRetryCount is a configurer for ObsClient to set the maximum number of retries when an HTTP/HTTPS connection is abnormal.
WithPathStyle is a configurer for ObsClient.
WithProxyUrl is a configurer for ObsClient to set HTTP proxy.
WithRegion is a configurer for ObsClient.
WithReqPaymentHeader sets header for requester-pays.
WithRequestContext is a configurer for ObsClient to set the context for each HTTP request.
No description provided by the author
WithSecurityToken is a configurer for ObsClient to set the security token in the temporary access keys.
WithSignature is a configurer for ObsClient.
WithSocketTimeout is a configurer for ObsClient to set the timeout duration for transmitting data at the socket layer, in seconds.
WithSslVerify is a wrapper for WithSslVerifyAndPemCerts.
WithSslVerifyAndPemCerts is a configurer for ObsClient to set conf.sslVerify and conf.pemCerts.
WithUserAgent is a configurer for ObsClient to set the User-Agent.
XmlTranscoding replaces special characters with their escaped form.

# Constants

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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BucketOwnerPayer type of payer: BucketOwner.
CopyMetadata metadata operation: COPY.
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
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
No description provided by the author
No description provided by the author
FetchStatusClosed type of status: closed.
FetchStatusOpen type of status: open.
No description provided by the author
No description provided by the author
GranteeGroup grantee type: Group.
GranteeUser grantee type: CanonicalUser.
GroupAllUsers grantee uri type: AllUsers.
GroupAuthenticatedUsers grantee uri type: AuthenticatedUsers.
GroupLogDelivery grantee uri type: LogDelivery.
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
No description provided by the author
HTTP_POST
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
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
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
No description provided by the author
No description provided by the author
ObjectCreatedAll type of events: ObjectCreated:*.
ObjectCreatedCompleteMultipartUpload type of events: ObjectCreated:CompleteMultipartUpload.
ObjectCreatedCopy type of events: ObjectCreated:Copy.
ObjectCreatedPost type of events: ObjectCreated:Post.
ObjectCreatedPut type of events: ObjectCreated:Put.
ObjectRemovedAll type of events: ObjectRemoved:*.
ObjectRemovedDelete type of events: ObjectRemoved:Delete.
ObjectRemovedDeleteMarkerCreated type of events: ObjectRemoved:DeleteMarkerCreated.
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
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
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PermissionFullControl permission type: FULL_CONTROL.
PermissionRead permission type: READ.
PermissionReadAcp permission type: READ_ACP.
PermissionWrite permission type: WRITE.
PermissionWriteAcp permission type: WRITE_ACP.
No description provided by the author
ProtocolHttp prorocol type: http.
ProtocolHttps prorocol type: https.
ReplaceMetadata metadata operation: REPLACE.
ReplaceNew metadata operation: REPLACE_NEW.
No description provided by the author
Requester header for requester-Pays.
RequesterPayer type of payer: Requester.
RestoreTierBulk restore options: Bulk.
RestoreTierExpedited restore options: Expedited.
RestoreTierStandard restore options: Standard.
No description provided by the author
RuleStatusDisabled rule status: Disabled.
RuleStatusEnabled rule status: Enabled.
No description provided by the author
SignatureObs signature type OBS.
SignatureV2 signature type v2.
SignatureV4 signature type v4.
StorageClassCold storage class: COLD.
StorageClassStandard storage class: STANDARD.
StorageClassWarm storage class: WARM.
SubResourceAcl subResource value: acl.
SubResourceCors subResource value: cors.
SubResourceDelete subResource value: delete.
SubResourceEncryption subResource value: encryption.
SubResourceLifecycle subResource value: lifecycle.
SubResourceLocation subResource value: location.
SubResourceLogging subResource value: logging.
SubResourceMetadata subResource value: metadata.
SubResourceNotification subResource value: notification.
SubResourcePolicy subResource value: policy.
SubResourceQuota subResource value: quota.
SubResourceRequestPayment subResource value: requestPayment.
SubResourceRestore subResource value: restore.
SubResourceStorageClass subResource value: storageClass.
SubResourceStorageInfo subResource value: storageinfo.
SubResourceStoragePolicy subResource value: storagePolicy.
SubResourceTagging subResource value: tagging.
SubResourceUploads subResource value: uploads.
SubResourceVersioning subResource value: versioning.
SubResourceVersions subResource value: versions.
SubResourceWebsite subResource value: website.
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
No description provided by the author
VersioningStatusEnabled version status: Enabled.
VersioningStatusSuspended version status: Suspended.

# Variables

ErrPoolShutDown will be returned if RoutinePool is shutdown.
ErrSubmitTimeout will be returned if submit task timeout when calling SubmitWithTimeout function.
ErrTaskInvalid will be returned if the task is nil.
ErrTaskReject will be returned if submit task is rejected.

# Structs

AbortMultipartUploadInput is the input parameter of AbortMultipartUpload function.
AccessControlPolicy defines access control policy properties.
BaseModel defines base model response from OBS.
No description provided by the author
Bucket defines bucket properties.
BucketCors defines the bucket CORS configuration.
BucketEncryptionConfiguration defines the bucket encryption configuration.
BucketLifecyleConfiguration defines the bucket lifecycle configuration.
BucketLocation defines bucket location configuration.
BucketLoggingStatus defines the bucket logging configuration.
BucketNotification defines the bucket notification configuration.
BucketPayer defines the request payment configuration.
BucketQuota defines bucket quota configuration.
BucketStoragePolicy defines the bucket storage class.
BucketTagging defines the bucket tag configuration.
BucketVersioningConfiguration defines the versioning configuration.
BucketWebsiteConfiguration defines the bucket website configuration.
CompleteMultipartUploadInput is the input parameter of CompleteMultipartUpload function.
CompleteMultipartUploadOutput is the result of CompleteMultipartUpload function.
Condition defines condition in RoutingRule.
Content defines the object content properties.
CopyObjectInput is the input parameter of CopyObject function.
CopyObjectOutput is the result of CopyObject function.
CopyPartInput is the input parameter of CopyPart function.
CopyPartOutput is the result of CopyPart function.
CorsRule defines the CORS rules.
CreateBrowserBasedSignatureInput is the input parameter of CreateBrowserBasedSignature function.
CreateBrowserBasedSignatureOutput is the result of CreateBrowserBasedSignature function.
CreateBucketInput is the input parameter of CreateBucket function.
CreateSignedUrlInput is the input parameter of CreateSignedUrl function.
CreateSignedUrlOutput is the result of CreateSignedUrl function.
DefaultSerializable defines default serializable struct.
DeleteBucketFetchPolicyInput is the input parameter of DeleteBucketFetchPolicy function.
Deleted defines the deleted property in DeleteObjectsOutput.
DeleteMarker defines the properties of versioning delete markers.
DeleteObjectInput is the input parameter of DeleteObject function.
DeleteObjectOutput is the result of DeleteObject function.
DeleteObjectsInput is the input parameter of DeleteObjects function.
DeleteObjectsOutput is the result of DeleteObjects function.
DownloadCheckpoint defines download checkpoint file properties.
DownloadFileInput is the input parameter of DownloadFile function.
DownloadPartInfo defines download part properties.
No description provided by the author
No description provided by the author
Error defines the error property in DeleteObjectsOutput.
ErrorDocument defines the error page configuration.
Expiration defines expiration property in LifecycleRule.
FetchResponse defines the response fetch policy configuration.
FileStatus defines the upload file properties.
FilterRule defines filter rule in TopicConfiguration.
FutureResult for task result.
GetBucketAclOutput is the result of GetBucketAcl function.
GetBucketCorsOutput is the result of GetBucketCors function.
GetBucketEncryptionOutput is the result of GetBucketEncryption function.
GetBucketFetchJobInput is the input parameter of GetBucketFetchJob function.
GetBucketFetchJobOutput is the result of GetBucketFetchJob function.
GetBucketFetchJobResponse defines the response fetch job configuration.
GetBucketFetchPolicyInput is the input parameter of GetBucketFetchPolicy function.
GetBucketFetchPolicyOutput is the result of GetBucketFetchPolicy function.
GetBucketLifecycleConfigurationOutput is the result of GetBucketLifecycleConfiguration function.
GetBucketLocationOutput is the result of GetBucketLocation function.
GetBucketLoggingConfigurationOutput is the result of GetBucketLoggingConfiguration function.
GetBucketMetadataInput is the input parameter of GetBucketMetadata function.
GetBucketMetadataOutput is the result of GetBucketMetadata function.
GetBucketNotificationOutput is the result of GetBucketNotification function.
GetBucketPolicyOutput is the result of GetBucketPolicy function.
GetBucketQuotaOutput is the result of GetBucketQuota function.
GetBucketRequestPaymentOutput is the result of GetBucketRequestPayment function.
GetBucketStorageInfoOutput is the result of GetBucketStorageInfo function.
GetBucketStoragePolicyOutput is the result of GetBucketStoragePolicy function.
GetBucketTaggingOutput is the result of GetBucketTagging function.
GetBucketVersioningOutput is the result of GetBucketVersioning function.
GetBucketWebsiteConfigurationOutput is the result of GetBucketWebsiteConfiguration function.
GetObjectAclInput is the input parameter of GetObjectAcl function.
GetObjectAclOutput is the result of GetObjectAcl function.
GetObjectInput is the input parameter of GetObject function.
GetObjectMetadataInput is the input parameter of GetObjectMetadata function.
GetObjectMetadataOutput is the result of GetObjectMetadata function.
GetObjectOutput is the result of GetObject function.
Grant defines grant properties.
Grantee defines grantee properties.
HeadObjectInput is the input parameter of HeadObject function.
IndexDocument defines the default page configuration.
InitiateMultipartUploadInput is the input parameter of InitiateMultipartUpload function.
InitiateMultipartUploadOutput is the result of InitiateMultipartUpload function.
Initiator defines initiator properties.
JobResponse defines the response job configuration.
LifecycleRule defines lifecycle rule.
ListBucketsInput is the input parameter of ListBuckets function.
ListBucketsOutput is the result of ListBuckets function.
ListMultipartUploadsInput is the input parameter of ListMultipartUploads function.
ListMultipartUploadsOutput is the result of ListMultipartUploads function.
ListObjectsInput is the input parameter of ListObjects function.
ListObjectsOutput is the result of ListObjects function.
ListObjsInput defines parameters for listing objects.
ListPartsInput is the input parameter of ListParts function.
ListPartsOutput is the result of ListParts function.
ListVersionsInput is the input parameter of ListVersions function.
ListVersionsOutput is the result of ListVersions function.
NoChanPool defines the coroutine pool struct.
NoncurrentVersionExpiration defines noncurrentVersion expiration property in LifecycleRule.
NoncurrentVersionTransition defines noncurrentVersion transition property in LifecycleRule.
ObjectInfo defines download object info.
ObjectOperationInput defines the object operation properties.
ObjectToDelete defines the object property in DeleteObjectsInput.
ObsClient defines OBS client.
ObsError defines error response from OBS.
Owner defines owner properties.
Part defines the part properties.
PutFileInput is the input parameter of PutFile function.
PutObjectBasicInput defines the basic object operation properties.
PutObjectInput is the input parameter of PutObject function.
PutObjectOutput is the result of PutObject function.
Redirect defines redirect in RoutingRule.
RedirectAllRequestsTo defines redirect in BucketWebsiteConfiguration.
RestoreObjectInput is the input parameter of RestoreObject function.
RoutinePool defines the coroutine pool struct.
RoutingRule defines routing rules.
SetBucketAclInput is the input parameter of SetBucketAcl function.
SetBucketCorsInput is the input parameter of SetBucketCors function.
SetBucketEncryptionInput is the input parameter of SetBucketEncryption function.
SetBucketFetchJobInput is the input parameter of SetBucketFetchJob function.
SetBucketFetchJobOutput is the result of SetBucketFetchJob function.
SetBucketFetchJobResponse defines the response SetBucketFetchJob configuration.
SetBucketFetchPolicyInput is the input parameter of SetBucketFetchPolicy function.
SetBucketLifecycleConfigurationInput is the input parameter of SetBucketLifecycleConfiguration function.
SetBucketLoggingConfigurationInput is the input parameter of SetBucketLoggingConfiguration function.
SetBucketNotificationInput is the input parameter of SetBucketNotification function.
SetBucketPolicyInput is the input parameter of SetBucketPolicy function.
SetBucketQuotaInput is the input parameter of SetBucketQuota function.
SetBucketRequestPaymentInput is the input parameter of SetBucketRequestPayment function.
SetBucketStoragePolicyInput is the input parameter of SetBucketStoragePolicy function.
SetBucketTaggingInput is the input parameter of SetBucketTagging function.
SetBucketVersioningInput is the input parameter of SetBucketVersioning function.
SetBucketWebsiteConfigurationInput is the input parameter of SetBucketWebsiteConfiguration function.
SetObjectAclInput is the input parameter of SetObjectAcl function.
SetObjectMetadataInput is the input parameter of SetObjectMetadata function.
SetObjectMetadataOutput is the result of SetObjectMetadata function.
SseCHeader defines the SseC header.
SseKmsHeader defines the SseKms header.
Tag defines tag property in BucketTagging.
TempFileInfo defines temp download file properties.
No description provided by the author
TopicConfiguration defines the topic configuration.
Transition defines transition property in LifecycleRule.
Upload defines multipart upload properties.
UploadCheckpoint defines the upload checkpoint file properties.
UploadFileInput is the input parameter of UploadFile function.
UploadPartInfo defines the upload part properties.
UploadPartInput is the input parameter of UploadPart function.
UploadPartOutput is the result of UploadPart function.
Version defines the properties of versioning objects.

# Interfaces

Future defines interface with function: Get.
IBaseModel defines interface for base response model.
IReadCloser defines interface with function: setReadCloser.
ISerializable defines interface with function: trans.
ISseHeader defines the sse encryption header.
Pool defines coroutine pool interface.
Task defines interface with function: Run.

# Type aliases

AclType defines bucket/object acl type.
AvailableZoneType defines type of az redundancy.
EventType defines bucket notification type of events.
FetchPolicyStatusType defines type of fetch policy status.
FSStatusType defines type of file system status.
GranteeType defines grantee type.
GroupUriType defines grantee uri type.
HttpMethodType defines http method type.
Level defines the level of the log.
MetadataDirectiveType defines metadata operation indicator.
PayerType defines type of payer.
PermissionType defines permission type.
ProtocolType defines protocol type.
RestoreTierType defines restore options.
RuleStatusType defines lifeCycle rule status.
SignatureType defines type of signature.
StorageClassType defines bucket storage class.
SubResourceType defines the subResource value.
VersioningStatusType defines bucket version status.