Categorygithub.com/trinet2005/oss-go-sdk
modulepackage
1.15.0
Repository: https://github.com/trinet2005/oss-go-sdk.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
58
Dependents
0
Files
12.1k SLOC

# README

杭州瑞网广通公司对象存储服务SDK

此项目为杭州瑞网广通公司对象存储系统的SDK

此项目基于MinIO开发，使用请遵守MinIO相关开源协议

操作存储桶

操作文件对象

操作对象

# Packages

No description provided by the author

# Functions

IsNetworkOrHostDown - if there was a network error or if the host is down.
New - instantiate minio client with options.
NewChecksum sets the checksum to the value of b, which is the raw hash output.
NewChecksumString sets the checksum to the value of s, which is the base 64 encoded raw hash output.
NewCore - Returns new initialized a Core client, this CoreClient should be only used under special conditions such as need to access lower primitives and being able to use them to write your own wrappers.
NewPostPolicy - Instantiate new post policy.
NewSelectResults creates a Select Result parser that parses the response and returns a Reader that will return parsed and assembled select output.
OptimalPartInfo - calculate the optimal part info for a given object size.
ToErrorResponse - Returns parsed ErrorResponse struct from body and http headers.
ToObjectInfo converts http header values into ObjectInfo type, extracts metadata and fills in all the necessary fields in ObjectInfo.

# Constants

No description provided by the author
Different types of url lookup supported by the server.Initialized to BucketLookupAuto.
Different types of url lookup supported by the server.Initialized to BucketLookupAuto.
Different types of url lookup supported by the server.Initialized to BucketLookupAuto.
ChecksumCRC32 indicates a CRC32 checksum with IEEE table.
ChecksumCRC32C indicates a CRC32 checksum with Castagnoli table.
ChecksumNone indicates no checksum.
ChecksumSHA1 indicates a SHA-1 checksum.
ChecksumSHA256 indicates a SHA256 checksum.
Compliance - compliance mode.
Constants for file header info.
Constants for file header info.
Constants for file header info.
Constants for csv quote styles.
Constants for csv quote styles.
No description provided by the author
Days - denotes no.
No description provided by the author
Various supported states.
Governance - governance mode.
No description provided by the author
No description provided by the author
Constants for JSONTypes.
Constants for JSONTypes.
LegalHoldDisabled indicates legal hold is disabled.
LegalHoldEnabled indicates legal hold is enabled.
MaxJitter will randomize over the full exponential backoff time.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
trinet */.
No description provided by the author
No description provided by the author
No description provided by the author
NoJitter disables the use of jitter for randomizing the exponential backoff time.
trinet */.
trinet */.
Constants for expression type.
ReplicationStatusComplete indicates replication completed ok.
ReplicationStatusFailed indicates replication failed.
ReplicationStatusPending indicates replication is pending.
ReplicationStatusReplica indicates object is a replica of a source.
RestoreSelect represents the restore SELECT operation.
Constants for compression types under select API.
Constants for compression types under select API.
LZ4 Stream.
Constants for compression types under select API.
S2 Stream.
Snappy stream.
Zstandard compression.
Constants for input data types.
Constants for input data types.
Constants for input data types.
No description provided by the author
Disabled State = "Disabled" only used by MFA Delete not supported yet.
TierBulk is the bulk retrieval tier.
TierExpedited is the expedited retrieval tier.
TierStandard is the standard retrieval tier.
Years - denotes no.

# Variables

DefaultRetryCap - Each retry attempt never waits no longer than this maximum time duration.
DefaultRetryUnit - default unit multiplicative per retry.
DefaultTransport - this default transport is similar to http.DefaultTransport but with additional param DisableCompression is set to true to avoid decompressing content with 'gzip' encoding.
MaxRetry is the maximum number of retries before stopping.

# Structs

AccessControlList contains the set of grantees and the permissions assigned to each grantee.
No description provided by the author
AdvancedGetOptions for internal use by MinIO server - not intended for client use.
AdvancedPutOptions for internal use - to be utilized by replication, ILM transition implementation on MinIO server.
AdvancedRemoveOptions intended for internal use by replication.
BucketInfo container for bucket metadata.
BucketVersioningConfiguration is the versioning configuration structure.
Checksum is a type and encoded value.
Client implements Amazon S3 compatible methods.
CommonPrefix container for prefix response.
CompletePart sub container lists individual part numbers and their md5sum, part of completeMultipartUpload.
CopyDestOptions represents options specified by user for CopyObject/ComposeObject APIs.
CopySrcOptions represents a source object to be copied, using server-side copying APIs.
Core - Inherits Client and adds new methods to expose the low level S3 APIs.
CSVInputOptions csv input specific options.
CSVOutputOptions csv output specific options.
Encryption contains the type of server-side encryption used during object retrieval.
ErrorResponse - Is the typed error returned by all API operations.
ExcludedPrefix - holds individual prefixes excluded from being versioned.
GetObjectLegalHoldOptions represents options specified by user for GetObjectLegalHold call.
GetObjectOptions are used to specify additional headers or options during GET requests.
GetObjectTaggingOptions holds the object version ID to fetch the tagging key/value pairs.
GlacierJobParameters represents the retrieval tier parameter.
Grant holds grant information.
Grantee represents the person being granted permissions.
JSONInputOptions json input specific options.
JSONOutputOptions - json output specific options.
ListBucketResult container for listObjects response.
ListBucketV2Result container for listObjects response version 2.
ListMultipartUploadsResult container for ListMultipartUploads response.
ListObjectPartsResult container for ListObjectParts response.
ListObjectsOptions holds all options of a list object request.
ListVersionsResult is an element in the list object versions response and has a special Unmarshaler because we need to preserver the order of <Version> and <DeleteMarker> in ListVersionsResult.Versions slice.
MakeBucketOptions holds all options to tweak bucket creation.
MetadataEntry represents a metadata information of the restored object.
No description provided by the author
Object represents an open object.
No description provided by the author
No description provided by the author
ObjectInfo container for object metadata.
ObjectMultipartInfo container for multipart object metadata.
ObjectPart container for particular part of an object.
Options for New method.
OutputLocation holds properties of the copy of the archived object.
Owner name.
ParquetInputOptions parquet input specific options.
No description provided by the author
PostPolicy - Provides strict static type conversion and validation for Amazon S3's POST policy JSON string.
ProgressMessage is a struct for progress xml message.
PutObjectFanOutEntry is per object entry fan-out metadata.
PutObjectFanOutRequest this is the request structure sent to the server to fan-out the stream to multiple objects.
PutObjectFanOutResponse this is the response structure sent by the server upon success or failure for each object fan-out keys.
PutObjectLegalHoldOptions represents options specified by user for PutObjectLegalHold call.
No description provided by the author
No description provided by the author
PutObjectOptions represents options specified by user for PutObject call.
PutObjectPartOptions contains options for PutObjectPart API.
PutObjectRetentionOptions represents options specified by user for PutObject call.
PutObjectTaggingOptions holds an object version id to update tag(s) of a specific object version.
RemoveBucketOptions special headers to purge buckets, only useful when endpoint is MinIO.
RemoveObjectError - container of Multi Delete S3 API error.
RemoveObjectOptions represents options specified by user for RemoveObject call.
RemoveObjectResult - container of Multi Delete S3 API result.
RemoveObjectsOptions represents options specified by user for RemoveObjects call.
RemoveObjectTaggingOptions holds the version id of the object to remove.
RestoreInfo contains information of the restore operation of an archived object.
RestoreRequest holds properties of the restore object request.
Retention - bucket level retention configuration.
S3 holds properties of the copy of the archived object.
SelectObjectInputSerialization - input serialization parameters.
SelectObjectOptions - represents the input select body.
SelectObjectOutputSerialization - output serialization parameters.
SelectParameters holds the select request parameters.
SelectResults is used for the streaming responses from the server.
SnowballObject contains information about a single object to be added to the snowball.
SnowballOptions contains options for PutObjectsSnowball calls.
StatsMessage is a struct for stat xml message.
UploadInfo contains information about the newly uploaded or copied object.
Version is an element in the list object versions response.

# Type aliases

BucketLookupType is type of url lookup supported by server.
Deprecated: BucketOptions will be renamed to RemoveBucketOptions in future versions.
ChecksumType contains information about the checksum type.
CSVFileHeaderInfo - is the parameter for whether to utilize headers.
CSVQuoteFields - is the parameter for how CSV fields are quoted.
No description provided by the author
JSONType determines json input serialization type.
LegalHoldStatus - object legal hold status.
QueryExpressionType - is of what syntax the expression is, this should only be SQL.
ReplicationStatus represents replication status of object.
RestoreType represents the restore request type.
RetentionMode - object retention mode.
SelectCompressionType - is the parameter for what type of compression is present.
SelectObjectType - is the parameter which defines what type of object the operation is being performed on.
StatObjectOptions are used to specify additional headers or options during GET info/stat requests.
StringMap represents map with custom UnmarshalXML.
TierType represents a retrieval tier.
URLMap represents map with custom UnmarshalXML.
ValidityUnit - retention validity unit.