package
0.0.0-20250307234622-ce874fdc6a05
Repository: https://github.com/minio/mc.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
BuildS3Config constructs an S3 Config and does signature auto-probe when needed.
DownloadReleaseData - downloads release data from mc official server.
GetClusterRegInfo - returns the cluster registration info.
GetCurrentReleaseTime - returns this process's release time.
GetGlobalHealthDataTypeSlice - returns the list of set health tests set globally.
GetHealthDataTypeSlice - returns the list of set health tests.
IsDCOS returns true if mc is running in DCOS.
IsDeleteEvent checks if the event returned is a delete event.
IsDocker - returns if the environment mc is running in docker or not.
IsGetEvent checks if the event return is a get event.
IsKubernetes returns true if MinIO is running in kubernetes.
IsPutEvent checks if the event returned is a put event.
IsSourceBuild - returns if this binary is a non-official build from source code.
Main starts mc application.
MapHealthInfoToV1 - maps the health info returned by minio server to V1 format.
NewAdminFactory encloses New function with client cache.
NewProgressStatus returns a progress status object.
NewQuietStatus returns a quiet status object.
NewS3Config simply creates a new Config struct using the passed parameters.
NewWatcher creates a new watcher.
ParseDuration parses a duration string.
ParseForm parses a http.Request form and populates the array.
PipeChan builds a new dynamically sized channel.
SubnetAPIKeyAuthHeaders - returns the headers for SUBNET API key authentication.
SubnetBaseURL - returns the base URL of SUBNET.
SubnetLicenseAuthHeaders - returns the headers for SUBNET license authentication.
SubnetPostReq - makes a POST request to SUBNET.
SubnetRegisterURL - returns the cluster registration URL.
SubnetUploadURL - returns the upload URL for the given upload type.
TarGZHealthInfo - compress and tar MinIO diagnostics output.
UTCNow - returns current UTC time.
# Constants
AmzObjectLockLegalHold sets object lock legal hold.
AmzObjectLockMode sets object lock mode.
AmzObjectLockRetainUntilDate sets object lock retain until date.
Constants for performance test type.
DirFirst - include directories before objects in the list.
DirLast - include directories after objects in the list.
DirNone - do not include directories in the list.
Constants for performance test type.
HelpTmpl template used by all sub-systems.
History template used by all sub-systems.
Constants for performance test type.
Constants for performance test type.
Ping is the template for ping result.
PingDist is the template for ping result in distributed mode.
Constants for performance test type.
# Variables
Approximation.
CommitID - latest commit id.
CopyrightYear - dynamic value of the copyright end year.
Standard unit of time.
Approximation.
ErrInvalidFileSystemAttribute reflects invalid fily system attribute.
ErrInvalidMetadata reflects invalid metadata format.
EventTypeDelete contains the notify events that will cause a delete (remove).
EventTypeGet contains the notify events that will cause a get (read).
EventTypePut contains the notify events that will cause a put (write).
Standard unit of time.
GlobalDevMode is set to true if the program is running in development mode.
GlobalSubnetProxyURL is the proxy to be used for communication with subnet.
HelpEnvTemplate - captures config help template.
HelpTemplate - captures config help template.
HistoryTemplate - captures history list template.
Standard unit of time.
Standard unit of time.
Approximation.
Standard unit of time.
Standard unit of time.
Approximation.
Standard unit of time.
PingTemplate - captures ping template.
PingTemplateDist - captures ping template.
ReleaseTag - release tag in TAG.%Y-%m-%dT%H-%M-%SZ.
S3New returns an initialized S3Client structure.
Standard unit of time.
ShortCommitID - first 12 characters from CommitID.
Version - version time.RFC3339.
Standard unit of time.
Approximation.
# Structs
APINotImplemented - api not implemented.
BucketInfo holds info about a bucket.
BucketInvalid - bucket name invalid.
BucketNameEmpty - bucket name empty (http://goo.gl/wJlzDz).
BucketStatOptions - bucket stat.
ClientContent - Content container for content metadata.
ClientResult - result of the network from client to server.
ClientURL url client url structure.
ClusterHealthV1 - main struct of the health report.
ClusterInfo - The "info" sub-node of the cluster registration information struct Intended to be extensible i.e.
ClusterRegistrationInfo - Information stored in the cluster registration token.
ClusterRegistrationReq - JSON payload of the subnet api for cluster registration Contains a registration token created by base64 encoding of the registration info.
Config - see http://docs.amazonwebservices.com/AmazonS3/latest/dev/index.html?RESTAuthentication.html.
ConfigAnyVersion is a generic structure to parse any config.json version file and only extracts its version number.
CopyOptions holds options for copying operation.
DriveTestResult - result of the drive performance test on a given endpoint.
DriveTestResults - results of drive performance test across all endpoints.
EmptyPath (EINVAL) - invalid argument.
EndPointStats - container to hold server ping stats.
EventInfo contains the information of the event that occurred and the source IP:PORT of the client which triggerred the event.
Field configuration: color theme and max content length.
GenericBucketError - generic bucket operations error.
GenericFileError - generic file error.
GetOptions holds options of the GET operation.
Health - intermediate struct for subnet health header Just used to achieve the JSON structure we want.
HealthDataTypeFlag is a typed flag to represent health datatypes.
HealthReportHeader - Header of the subnet health report expected to generate JSON output of the form {"subnet":{"health":{"version":"v1"}}}.
HwCPUV1 - CPU Info.
HwDrivePerfV1 - Network performance info.
HwDriveV1 - Drive info.
HwMemV1 - Includes host virtual and swap mem information.
HwNetPerfV1 - Network performance info.
HwPerfV1 - hardware performance.
HwServersV1 - hardware health Info.
HwServerV1 - server health Info.
InvalidArgument - passed argument is invalid for this operation.
ListOptions holds options for listing operation.
MinioHealthInfoV1 - Health info of the MinIO cluster.
NetStats - Network performance stats.
NetTestResult - result of the network performance test for given endpoint.
NetTestResults - result of the network performance test across all endpoints.
NotificationConfig notification config.
ObjectAlreadyExists - typed return for MethodNotAllowed.
ObjectAlreadyExistsAsDirectory - typed return for XMinioObjectExistsAsDirectory.
ObjectIsDeleteMarker - object is a delete marker as latest.
ObjectMissing (EINVAL) - object key missing.
ObjectNameEmpty - object name empty.
ObjectOnGlacier - object is of storage class glacier.
ObjGETPerfResults - Object GET performance results.
ObjGETStats - GET stats of all the servers.
ObjPUTPerfResults - Object PUT performance results.
ObjPUTStats - PUT stats of all the servers.
ObjStats - Object performance stats.
ObjStatServer - Server level object performance stats.
ObjTestResults - result of the object performance test.
ParallelManager - helps manage parallel workers to run tasks.
PerfTestOutput - stores the final output of performance test(s).
PerfTestResult - stores the result of a performance test.
PingResult contains ping output.
PrettyRecord - an easy struct to format a set of key-value pairs into a record.
PrettyTable - an easy struct to format a set of line.
ProgressStatus shows a progressbar.
PrometheusConfig - container to hold the top level scrape config.
PutOptions holds options for PUT operation.
QuietStatus will only show the progress and summary.
RemoveResult returns the error or result of the removed objects.
Row specifies row description and theme.
S3Client construct.
SameFile - source and destination are same files.
SchemaVersion - version of the health report schema.
ScrapeConfig configures a scraping unit for Prometheus.
SelectObjectOpts - opts entered for select API.
SiteNetStats - status for siteNet.
SiteReplicationTestNodeResult - result of the network performance test for site-replication.
SiteReplicationTestResults - result of the network performance test across all site-replication.
StatConfig - container to hold the targets config.
StatOptions holds options of the HEAD operation.
SubnetFileUploader - struct to upload files to SUBNET.
SubnetLoginReq - JSON payload of the SUBNET login api.
SubnetMFAReq - JSON payload of the SUBNET mfa api.
SwInfoV1 - software health Info.
UnexpectedEOF (EPIPE) - reader closed prematurely.
UnexpectedShortWrite - write wrote less bytes than expected.
URLs contains source and target urls.
Watcher can be used to have one or multiple clients watch for notifications.
WatchObject captures watch channels to read and listen on.
WatchOptions contains watch configuration options.
# Interfaces
Client - client interface.
HealthReportInfo - interface to be implemented by health report schema struct.
Progress - an interface which describes current amount of data written.
ProgressReader can be used to update the progress of an on-going transfer progress.
Status implements a interface that can be used in quit mode or with progressbar.
# Type aliases
BrokenSymlink (ENOTENT) - file has broken symlink.
BucketDoesNotExist - bucket does not exist.
BucketExists - bucket exists.
ClientURLType - enum of different url types.
DirOpt - list directory option.
Duration is a standard unit of time.
HealthDataTypeSlice is a typed list of health tests.
PathInsufficientPermission (EPERM) - permission denied.
PathIsNotRegular (ENOTREG) - file is not a regular file.
PathNotADirectory - this path does not correspond to a directory.
PathNotFound (ENOENT) - file not found.
PerfTestType - The type of performance test (net/drive/object).
SubnetHeaders - type for SUBNET request headers.
TooManyLevelsSymlink (ELOOP) - file has too many levels of symlinks.
UnexpectedExcessRead - reader wrote more data than requested.