madmin

package module
v4.4.7 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 18, 2025 License: AGPL-3.0 Imports: 71 Imported by: 3

README

Golang Admin Client API Reference Slack

The MinIO Admin Golang Client SDK provides APIs to manage MinIO services.

This document assumes that you have a working Golang setup.

Initialize MinIO Admin Client object.

MinIO


package main

import (
    "fmt"

    "github.com/minio/madmin-go/v4"
)

func main() {
    // Use a secure connection.
    ssl := true

    // Initialize minio client object.
    mdmClnt, err := madmin.New("your-minio.example.com:9000", "YOUR-ACCESSKEYID", "YOUR-SECRETKEY", ssl)
    if err != nil {
        fmt.Println(err)
        return
    }

    // Fetch service status.
	info, err := mdmClnt.ClusterInfo(context.Background())
    if err != nil {
        fmt.Println(err)
        return
    }
	fmt.Printf("%#v\n", info)
}

Documentation

All documentation is available here

License

This SDK is licensed under GNU AGPLv3.

Documentation

Index

Examples

Constants

View Source 
const (
	ReplicateAddStatusSuccess = "Requested sites were configured for replication successfully."
	ReplicateAddStatusPartial = "Some sites could not be configured for replication."
)

Meaningful values for ReplicateAddStatus.Status

View Source 
const (
	SRIAMItemPolicy        = "policy"
	SRIAMItemPolicyMapping = "policy-mapping"
	SRIAMItemGroupInfo     = "group-info"
	SRIAMItemCredential    = "credential"
	SRIAMItemSvcAcc        = "service-account"
	SRIAMItemSTSAcc        = "sts-account"
	SRIAMItemIAMUser       = "iam-user"
	SRIAMItemExternalUser  = "external-user"
)

SRIAMItem.Type constants.

View Source 
const (
	SRBucketMetaTypePolicy           = "policy"
	SRBucketMetaTypeTags             = "tags"
	SRBucketMetaTypeVersionConfig    = "version-config"
	SRBucketMetaTypeObjectLockConfig = "object-lock-config"
	SRBucketMetaTypeSSEConfig        = "sse-config"
	SRBucketMetaTypeQuotaConfig      = "quota-config"
	SRBucketMetaLCConfig             = "lc-config"
	SRBucketMetaTypeCorsConfig       = "cors-config"
)

SRBucketMeta.Type constants

View Source 
const (
	ReplicateRemoveStatusSuccess = "Requested site(s) were removed from cluster replication successfully."
	ReplicateRemoveStatusPartial = "Some site(s) could not be removed from cluster replication configuration."
)
View Source 
const (
	// ConfigAppliedHeader is the header indicating whether the config was applied without requiring a restart.
	ConfigAppliedHeader = "x-minio-config-applied"

	// ConfigAppliedTrue is the value set in header if the config was applied.
	ConfigAppliedTrue = "true"
)
View Source 
const (
	DriveStateOk          string = "ok"
	DriveStateOffline     string = "offline"
	DriveStateCorrupt     string = "corrupt"
	DriveStateMissing     string = "missing"
	DriveStatePermission  string = "permission-denied"
	DriveStateFaulty      string = "faulty"
	DriveStateRootMount   string = "root-mount"
	DriveStateUnknown     string = "unknown"
	DriveStateUnformatted string = "unformatted" // only returned by disk
)

Drive state constants

View Source 
const (
	// HealthInfoVersion0 is version 0
	HealthInfoVersion0 = ""
	// HealthInfoVersion1 is version 1
	HealthInfoVersion1 = "1"
	// HealthInfoVersion2 is version 2
	HealthInfoVersion2 = "2"
	// HealthInfoVersion3 is version 3
	HealthInfoVersion3 = "3"
	// HealthInfoVersion is current health info version.
	HealthInfoVersion = HealthInfoVersion3
)
View Source 
const (
	SysErrAuditEnabled      = "audit is enabled"
	SysErrUpdatedbInstalled = "updatedb is installed"
)
View Source 
const (
	SrvSELinux      = "selinux"
	SrvNotInstalled = "not-installed"
)
View Source 
const (
	OpenidIDPCfg string = "openid"
	LDAPIDPCfg   string = "ldap"
)

Constants for IDP configuration types.

View Source 
const (
	IDPErrNone       = "none"
	IDPErrDisabled   = "disabled"
	IDPErrConnection = "connection"
	IDPErrInvalid    = "invalid"
)

IDP validity check error types

View Source 
const (

	// ItemOffline indicates that the item is offline
	ItemOffline = ItemState("offline")
	// ItemInitializing indicates that the item is still in initialization phase
	ItemInitializing = ItemState("initializing")
	// ItemOnline indicates that the item is online
	ItemOnline = ItemState("online")
)
View Source 
const (
	// FsType - Backend is FS Type
	FsType = backendType("FS")
	// ErasureType - Backend is Erasure type
	ErasureType = backendType("Erasure")
)
View Source 
const (
	DriveSetPrefix  = "::drive-set::"
	DrivePoolPrefix = "::drive-pool::"
)

DriveSetPrefix will be used to select drives from specific sets.

View Source 
const (
	CredentialsSubSys    = "credentials"
	PolicyOPASubSys      = "policy_opa"
	PolicyPluginSubSys   = "policy_plugin"
	IdentityOpenIDSubSys = "identity_openid"
	IdentityLDAPSubSys   = "identity_ldap"
	IdentityTLSSubSys    = "identity_tls"
	IdentityPluginSubSys = "identity_plugin"
	CacheSubSys          = "cache"
	SiteSubSys           = "site"
	RegionSubSys         = "region"
	EtcdSubSys           = "etcd"
	StorageClassSubSys   = "storage_class"
	APISubSys            = "api"
	CompressionSubSys    = "compression"
	LoggerWebhookSubSys  = "logger_webhook"
	AuditWebhookSubSys   = "audit_webhook"
	AuditKafkaSubSys     = "audit_kafka"
	HealSubSys           = "heal"
	ScannerSubSys        = "scanner"
	CrawlerSubSys        = "crawler"
	SubnetSubSys         = "subnet"
	CallhomeSubSys       = "callhome"
	BatchSubSys          = "batch"
	DriveSubSys          = "drive"
	ILMSubsys            = "ilm"
	ReplicationSubSys    = "replication"

	NotifyKafkaSubSys    = "notify_kafka"
	NotifyMQTTSubSys     = "notify_mqtt"
	NotifyMySQLSubSys    = "notify_mysql"
	NotifyNATSSubSys     = "notify_nats"
	NotifyNSQSubSys      = "notify_nsq"
	NotifyESSubSys       = "notify_elasticsearch"
	NotifyAMQPSubSys     = "notify_amqp"
	NotifyPostgresSubSys = "notify_postgres"
	NotifyRedisSubSys    = "notify_redis"
	NotifyWebhookSubSys  = "notify_webhook"

	LambdaWebhookSubSys = "lambda_webhook"

	BrowserSubSys          = "browser"
	KubernetesSubSys       = "kubernetes"
	AuditEventQueueSubSys  = "audit_event_queue"
	ErasureSubSys          = "erasure"
	BucketEventQueueSubSys = "bucket_event_queue"
	TelemetryTargetSubSys  = "telemetry_target"
	LogRecorderSubSys      = "log"
)

Top level configuration key constants.

View Source 
const (
	EnableKey  = "enable"
	CommentKey = "comment"

	// Enable values
	EnableOn  = "on"
	EnableOff = "off"
)

Standard config keys and values.

View Source 
const (
	SubSystemSeparator = `:`
	KvSeparator        = `=`
	KvComment          = `#`
	KvSpaceSeparator   = ` `
	KvNewline          = "\n"
	KvDoubleQuote      = `"`
	KvSingleQuote      = `'`

	Default = `_`

	EnvPrefix        = "MINIO_"
	EnvWordDelimiter = `_`

	EnvLinePrefix = KvComment + KvSpaceSeparator + EnvPrefix
)

Constant separators

View Source 
const (
	// MaxClientPerfTimeout for max time out for client perf
	MaxClientPerfTimeout = time.Second * 30
	// MinClientPerfTimeout for min time out for client perf
	MinClientPerfTimeout = time.Second * 5
)
View Source 
const (
	// ServiceActionRestart represents restart action
	ServiceActionRestart ServiceAction = "restart"
	// ServiceActionStop represents stop action
	ServiceActionStop = "stop"
	// ServiceActionFreeze represents freeze action
	ServiceActionFreeze = "freeze"
	// ServiceActionUnfreeze represents unfreeze a previous freeze action
	ServiceActionUnfreeze = "unfreeze"
)
View Source 
const (
	AccessKeyListUsersOnly  = "users-only"
	AccessKeyListSTSOnly    = "sts-only"
	AccessKeyListSvcaccOnly = "svcacc-only"
	AccessKeyListAll        = "all"
)
View Source 
const (
	BuiltinProvider     = "builtin"
	LDAPProvider        = "ldap"
	OpenIDProvider      = "openid"
	K8SProvider         = "k8s"
	CertificateProvider = "tls"
	CustomTokenProvider = "custom"
)

User provider types

View Source 
const BatchJobExpireTemplate = `` /* 1992-byte string literal not displayed */

BatchJobExpireTemplate provides a sample template for batch expiring objects

View Source 
const BatchJobKeyRotateTemplate = `` /* 1310-byte string literal not displayed */

BatchJobKeyRotateTemplate provides a sample template for batch key rotation

View Source 
const BatchJobReplicateTemplate = `` /* 3240-byte string literal not displayed */

BatchJobReplicateTemplate provides a sample template for batch replication

View Source 
const DefaultRetryCap = time.Second * 30

DefaultRetryCap - Each retry attempt never waits no longer than this maximum time duration.

View Source 
const DefaultRetryUnit = time.Second

DefaultRetryUnit - default unit multiplicative per retry. defaults to 1 second.

View Source 
const MaxJitter = 1.0

MaxJitter will randomize over the full exponential backoff time

View Source 
const NoJitter = 0.0

NoJitter disables the use of jitter for randomizing the exponential backoff time

View Source 
const SiteReplAPIVersion = "1"

SiteReplAPIVersion holds the supported version of the server Replication API

View Source 
const TierConfigVer = "v1"

TierConfigVer refers to the current tier config version

View Source 
const (
	// TraceBatch will trace all batch operations.
	TraceBatch = TraceBatchReplication | TraceBatchKeyRotation | TraceBatchExpire // |TraceBatch<NextFeature>
)

Variables

View Source 
var (
	ErrInvalidEnvVarLine = errors.New("expected env var line of the form `# MINIO_...=...`")
	ErrInvalidConfigKV   = errors.New("expected config value in the format `key=value`")
)
View Source 
var (
	ClusterV2Metrics = []string{

		"minio_cluster_bucket_total",
		"minio_cluster_capacity_raw_free_bytes",
		"minio_cluster_capacity_raw_total_bytes",
		"minio_cluster_capacity_usable_free_bytes",
		"minio_cluster_capacity_usable_total_bytes",
		"minio_cluster_objects_size_distribution",
		"minio_cluster_objects_version_distribution",
		"minio_cluster_usage_object_total",
		"minio_cluster_usage_total_bytes",
		"minio_cluster_usage_version_total",
		"minio_cluster_usage_deletemarker_total",

		"minio_cluster_drive_offline_total",
		"minio_cluster_drive_online_total",
		"minio_cluster_drive_total",

		"minio_cluster_nodes_offline_total",
		"minio_cluster_nodes_online_total",
		"minio_cluster_write_quorum",
		"minio_cluster_health_status",
		"minio_cluster_health_erasure_set_healing_drives",
		"minio_cluster_health_erasure_set_online_drives",
		"minio_cluster_health_erasure_set_read_quorum",
		"minio_cluster_health_erasure_set_write_quorum",
		"minio_cluster_health_erasure_set_status",

		"minio_s3_requests_incoming_total",
		"minio_s3_requests_inflight_total",
		"minio_s3_requests_rejected_auth_total",
		"minio_s3_requests_rejected_header_total",
		"minio_s3_requests_rejected_invalid_total",
		"minio_s3_requests_rejected_timestamp_total",
		"minio_s3_requests_total",
		"minio_s3_requests_waiting_total",
		"minio_s3_requests_ttfb_seconds_distribution",
		"minio_s3_traffic_received_bytes",
		"minio_s3_traffic_sent_bytes",

		"minio_node_scanner_bucket_scans_finished",
		"minio_node_scanner_bucket_scans_started",
		"minio_node_scanner_directories_scanned",
		"minio_node_scanner_objects_scanned",
		"minio_node_scanner_versions_scanned",
		"minio_node_syscall_read_total",
		"minio_node_syscall_write_total",
		"minio_usage_last_activity_nano_seconds",

		"minio_inter_node_traffic_dial_avg_time",
		"minio_inter_node_traffic_received_bytes",
		"minio_inter_node_traffic_sent_bytes",

		"minio_node_process_cpu_total_seconds",
		"minio_node_process_resident_memory_bytes",
		"minio_node_process_starttime_seconds",
		"minio_node_process_uptime_seconds",

		"minio_node_file_descriptor_limit_total",
		"minio_node_file_descriptor_open_total",

		"minio_node_go_routine_total",
		"minio_node_io_rchar_bytes",
		"minio_node_io_read_bytes",
		"minio_node_io_wchar_bytes",
		"minio_node_io_write_bytes",
	}
	ReplicationV2Metrics = []string{

		"minio_cluster_replication_last_hour_failed_bytes",
		"minio_cluster_replication_last_hour_failed_count",
		"minio_cluster_replication_last_minute_failed_bytes",
		"minio_cluster_replication_last_minute_failed_count",
		"minio_cluster_replication_total_failed_bytes",
		"minio_cluster_replication_total_failed_count",
		"minio_cluster_replication_received_bytes",
		"minio_cluster_replication_received_count",
		"minio_cluster_replication_sent_bytes",
		"minio_cluster_replication_sent_count",
		"minio_cluster_replication_proxied_get_requests_total",
		"minio_cluster_replication_proxied_head_requests_total",
		"minio_cluster_replication_proxied_delete_tagging_requests_total",
		"minio_cluster_replication_proxied_get_tagging_requests_total",
		"minio_cluster_replication_proxied_put_tagging_requests_total",
		"minio_cluster_replication_proxied_get_requests_failures",
		"minio_cluster_replication_proxied_head_requests_failures",
		"minio_cluster_replication_proxied_delete_tagging_requests_failures",
		"minio_cluster_replication_proxied_get_tagging_requests_failures",
		"minio_cluster_replication_proxied_put_tagging_requests_failures",

		"minio_node_replication_current_active_workers",
		"minio_node_replication_average_active_workers",
		"minio_node_replication_max_active_workers",
		"minio_node_replication_link_online",
		"minio_node_replication_link_offline_duration_seconds",
		"minio_node_replication_link_downtime_duration_seconds",
		"minio_node_replication_average_link_latency_ms",
		"minio_node_replication_max_link_latency_ms",
		"minio_node_replication_current_link_latency_ms",
		"minio_node_replication_current_transfer_rate",
		"minio_node_replication_average_transfer_rate",
		"minio_node_replication_max_transfer_rate",
		"minio_node_replication_last_minute_queued_count",
		"minio_node_replication_last_minute_queued_bytes",
		"minio_node_replication_average_queued_count",
		"minio_node_replication_average_queued_bytes",
		"minio_node_replication_max_queued_bytes",
		"minio_node_replication_max_queued_count",
		"minio_node_replication_recent_backlog_count",
	}
	BucketV2Metrics = []string{

		"minio_bucket_objects_size_distribution",
		"minio_bucket_objects_version_distribution",
		"minio_bucket_traffic_received_bytes",
		"minio_bucket_traffic_sent_bytes",
		"minio_bucket_usage_object_total",
		"minio_bucket_usage_version_total",
		"minio_bucket_usage_deletemarker_total",
		"minio_bucket_usage_total_bytes",
		"minio_bucket_requests_inflight_total",
		"minio_bucket_requests_total",
		"minio_bucket_requests_ttfb_seconds_distribution",

		"minio_bucket_replication_last_minute_failed_bytes",
		"minio_bucket_replication_last_minute_failed_count",
		"minio_bucket_replication_last_hour_failed_bytes",
		"minio_bucket_replication_last_hour_failed_count",
		"minio_bucket_replication_total_failed_bytes",
		"minio_bucket_replication_total_failed_count",
		"minio_bucket_replication_latency_ms",
		"minio_bucket_replication_received_bytes",
		"minio_bucket_replication_received_count",
		"minio_bucket_replication_sent_bytes",
		"minio_bucket_replication_sent_count",
		"minio_bucket_replication_proxied_get_requests_total",
		"minio_bucket_replication_proxied_head_requests_total",
		"minio_bucket_replication_proxied_delete_tagging_requests_total",
		"minio_bucket_replication_proxied_get_tagging_requests_total",
		"minio_bucket_replication_proxied_put_tagging_requests_total",
		"minio_bucket_replication_proxied_get_requests_failures",
		"minio_bucket_replication_proxied_head_requests_failures",
		"minio_bucket_replication_proxied_delete_tagging_requests_failures",
		"minio_bucket_replication_proxied_get_tagging_requests_failures",
		"minio_bucket_replication_proxied_put_tagging_requests_failures",
	}
	NodeV2Metrics = []string{
		"minio_node_drive_free_bytes",
		"minio_node_drive_free_inodes",
		"minio_node_drive_latency_us",
		"minio_node_drive_offline_total",
		"minio_node_drive_online_total",
		"minio_node_drive_total",
		"minio_node_drive_total_bytes",
		"minio_node_drive_used_bytes",
		"minio_node_drive_errors_timeout",
		"minio_node_drive_errors_ioerror",
		"minio_node_drive_errors_availability",
		"minio_node_drive_io_waiting",
	}
	ResourceV2Metrics = []string{
		"minio_node_drive_total_bytes",
		"minio_node_drive_used_bytes",
		"minio_node_drive_total_inodes  ",
		"minio_node_drive_used_inodes",
		"minio_node_drive_reads_per_sec",
		"minio_node_drive_reads_kb_per_sec",
		"minio_node_drive_reads_await",
		"minio_node_drive_writes_per_sec",
		"minio_node_drive_writes_kb_per_sec",
		"minio_node_drive_writes_await",
		"minio_node_drive_perc_util",
		"minio_node_if_rx_bytes",
		"minio_node_if_rx_bytes_avg",
		"minio_node_if_rx_bytes_max",
		"minio_node_if_rx_errors",
		"minio_node_if_rx_errors_avg",
		"minio_node_if_rx_errors_max",
		"minio_node_if_tx_bytes",
		"minio_node_if_tx_bytes_avg",
		"minio_node_if_tx_bytes_max",
		"minio_node_if_tx_errors",
		"minio_node_if_tx_errors_avg",
		"minio_node_if_tx_errors_max",
		"minio_node_cpu_avg_user",
		"minio_node_cpu_avg_user_avg",
		"minio_node_cpu_avg_user_max",
		"minio_node_cpu_avg_system",
		"minio_node_cpu_avg_system_avg",
		"minio_node_cpu_avg_system_max",
		"minio_node_cpu_avg_idle",
		"minio_node_cpu_avg_idle_avg",
		"minio_node_cpu_avg_idle_max",
		"minio_node_cpu_avg_iowait",
		"minio_node_cpu_avg_iowait_avg",
		"minio_node_cpu_avg_iowait_max",
		"minio_node_cpu_avg_nice",
		"minio_node_cpu_avg_nice_avg",
		"minio_node_cpu_avg_nice_max",
		"minio_node_cpu_avg_steal",
		"minio_node_cpu_avg_steal_avg",
		"minio_node_cpu_avg_steal_max",
		"minio_node_cpu_avg_load1",
		"minio_node_cpu_avg_load1_avg",
		"minio_node_cpu_avg_load1_max",
		"minio_node_cpu_avg_load1_perc",
		"minio_node_cpu_avg_load1_perc_avg",
		"minio_node_cpu_avg_load1_perc_max",
		"minio_node_cpu_avg_load5",
		"minio_node_cpu_avg_load5_avg",
		"minio_node_cpu_avg_load5_max",
		"minio_node_cpu_avg_load5_perc",
		"minio_node_cpu_avg_load5_perc_avg",
		"minio_node_cpu_avg_load5_perc_max",
		"minio_node_cpu_avg_load15",
		"minio_node_cpu_avg_load15_avg",
		"minio_node_cpu_avg_load15_max",
		"minio_node_cpu_avg_load15_perc",
		"minio_node_cpu_avg_load15_perc_avg",
		"minio_node_cpu_avg_load15_perc_max",
		"minio_node_mem_available",
		"minio_node_mem_available_avg",
		"minio_node_mem_available_max",
		"minio_node_mem_buffers",
		"minio_node_mem_buffers_avg",
		"minio_node_mem_buffers_max",
		"minio_node_mem_cache",
		"minio_node_mem_cache_avg",
		"minio_node_mem_cache_max",
		"minio_node_mem_free",
		"minio_node_mem_free_avg",
		"minio_node_mem_free_max",
		"minio_node_mem_shared",
		"minio_node_mem_shared_avg",
		"minio_node_mem_shared_max",
		"minio_node_mem_total",
		"minio_node_mem_total_avg",
		"minio_node_mem_total_max",
		"minio_node_mem_used",
		"minio_node_mem_used_avg",
		"minio_node_mem_used_max",
		"minio_node_mem_used_perc",
		"minio_node_mem_used_perc_avg",
		"minio_node_mem_used_perc_max",
	}
)

Prometheus v2 metrics

View Source 
var (
	// ErrTierNameEmpty "remote tier name empty"
	ErrTierNameEmpty = errors.New("remote tier name empty")
	// ErrTierInvalidConfig "invalid tier config"
	ErrTierInvalidConfig = errors.New("invalid tier config")
	// ErrTierInvalidConfigVersion "invalid tier config version"
	ErrTierInvalidConfigVersion = errors.New("invalid tier config version")
	// ErrTierTypeUnsupported "unsupported tier type"
	ErrTierTypeUnsupported = errors.New("unsupported tier type")
)
View Source 
var (

	// AdminAPIVersion - admin api version used in the request.
	AdminAPIVersion = func() string {
		if v := os.Getenv("MADMIN_API_VERSION"); v == "v3" {
			return "v3"
		}
		return "v4"
	}()
)
View Source 
var DefaultTransport = func(secure bool) http.RoundTripper {
	tr := &http.Transport{
		Proxy: http.ProxyFromEnvironment,
		DialContext: (&net.Dialer{
			Timeout:       5 * time.Second,
			KeepAlive:     15 * time.Second,
			FallbackDelay: 100 * time.Millisecond,
		}).DialContext,
		MaxIdleConns:          1024,
		MaxIdleConnsPerHost:   1024,
		ResponseHeaderTimeout: 60 * time.Second,
		IdleConnTimeout:       60 * time.Second,
		TLSHandshakeTimeout:   10 * time.Second,
		ExpectContinueTimeout: 1 * time.Second,

		DisableCompression: true,
	}

	if secure {
		tr.TLSClientConfig = &tls.Config{

			MinVersion: tls.VersionTLS12,
		}
	}
	return tr
}

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.

View Source 
var EOSSubSystems = set.CreateStringSet(
	CredentialsSubSys,
	PolicyOPASubSys,
	PolicyPluginSubSys,
	IdentityOpenIDSubSys,
	IdentityLDAPSubSys,
	IdentityTLSSubSys,
	IdentityPluginSubSys,
	CacheSubSys,
	SiteSubSys,
	RegionSubSys,
	EtcdSubSys,
	StorageClassSubSys,
	APISubSys,
	CompressionSubSys,
	LoggerWebhookSubSys,
	AuditWebhookSubSys,
	AuditKafkaSubSys,
	HealSubSys,
	ScannerSubSys,
	CrawlerSubSys,
	SubnetSubSys,
	CallhomeSubSys,
	BatchSubSys,
	DriveSubSys,
	ILMSubsys,
	ReplicationSubSys,
	NotifyKafkaSubSys,
	NotifyMQTTSubSys,
	NotifyMySQLSubSys,
	NotifyNATSSubSys,
	NotifyNSQSubSys,
	NotifyESSubSys,
	NotifyAMQPSubSys,
	NotifyPostgresSubSys,
	NotifyRedisSubSys,
	NotifyWebhookSubSys,
	LambdaWebhookSubSys,
	BrowserSubSys,
	AuditEventQueueSubSys,
	ErasureSubSys,
	BucketEventQueueSubSys,
	KubernetesSubSys,
	TelemetryTargetSubSys,
	LogRecorderSubSys,
)

EOSSubSystems - list of all subsystems for EOS

View Source 
var ErrMaliciousData = sio.NotAuthentic

ErrMaliciousData indicates that the stream cannot be decrypted by provided credentials.

View Source 
var ErrUnexpectedHeader = errors.New("unexpected header")

ErrUnexpectedHeader indicates that the data stream returned unexpected header

View Source 
var HealthDataTypesList = []HealthDataType{
	HealthDataTypeMinioInfo,
	HealthDataTypeMinioConfig,
	HealthDataTypeSysCPU,
	HealthDataTypeSysDriveHw,
	HealthDataTypeSysOsInfo,
	HealthDataTypeSysMem,
	HealthDataTypeSysNet,
	HealthDataTypeSysProcess,
	HealthDataTypeSysErrors,
	HealthDataTypeSysServices,
	HealthDataTypeSysConfig,
	HealthDataTypeReplication,
	HealthDataTypeShardsHealth,
}

HealthDataTypesList - List of health datatypes

View Source 
var HealthDataTypesMap = map[string]HealthDataType{
	"minioinfo":    HealthDataTypeMinioInfo,
	"minioconfig":  HealthDataTypeMinioConfig,
	"syscpu":       HealthDataTypeSysCPU,
	"sysdrivehw":   HealthDataTypeSysDriveHw,
	"sysosinfo":    HealthDataTypeSysOsInfo,
	"sysmem":       HealthDataTypeSysMem,
	"sysnet":       HealthDataTypeSysNet,
	"sysprocess":   HealthDataTypeSysProcess,
	"syserrors":    HealthDataTypeSysErrors,
	"sysservices":  HealthDataTypeSysServices,
	"sysconfig":    HealthDataTypeSysConfig,
	"replication":  HealthDataTypeReplication,
	"shardshealth": HealthDataTypeShardsHealth,
}

HealthDataTypesMap - Map of Health datatypes

View Source 
var MaxRetry = 10

MaxRetry is the maximum number of retries before stopping.

View Source 
var (
	MetricsRespBodyLimit = int64(humanize.GiByte)
)

MetricsRespBodyLimit sets the top level limit to the size of the metrics results supported by this library.

View Source 
var SubSystems = set.CreateStringSet(
	CredentialsSubSys,
	PolicyOPASubSys,
	PolicyPluginSubSys,
	IdentityOpenIDSubSys,
	IdentityLDAPSubSys,
	IdentityTLSSubSys,
	IdentityPluginSubSys,
	CacheSubSys,
	SiteSubSys,
	RegionSubSys,
	EtcdSubSys,
	StorageClassSubSys,
	APISubSys,
	CompressionSubSys,
	LoggerWebhookSubSys,
	AuditWebhookSubSys,
	AuditKafkaSubSys,
	HealSubSys,
	ScannerSubSys,
	CrawlerSubSys,
	SubnetSubSys,
	CallhomeSubSys,
	BatchSubSys,
	DriveSubSys,
	ILMSubsys,
	ReplicationSubSys,
	NotifyKafkaSubSys,
	NotifyMQTTSubSys,
	NotifyMySQLSubSys,
	NotifyNATSSubSys,
	NotifyNSQSubSys,
	NotifyESSubSys,
	NotifyAMQPSubSys,
	NotifyPostgresSubSys,
	NotifyRedisSubSys,
	NotifyWebhookSubSys,
	LambdaWebhookSubSys,
	BrowserSubSys,
)

SubSystems - list of all subsystems in MinIO

View Source 
var SupportedJobTypes = []BatchJobType{
	BatchJobReplicate,
	BatchJobKeyRotate,
	BatchJobExpire,
}

SupportedJobTypes supported job types

View Source 
var ValidIDPConfigTypes = set.CreateStringSet(OpenidIDPCfg, LDAPIDPCfg)

ValidIDPConfigTypes - set of valid IDP configs.

Functions

func AzureEndpoint 

func AzureEndpoint(endpoint string) func(az *TierAzure) error

AzureEndpoint helper to supply optional endpoint to NewTierAzure

func AzurePrefix 

func AzurePrefix(prefix string) func(az *TierAzure) error

AzurePrefix helper to supply optional object prefix to NewTierAzure

func AzureRegion 

func AzureRegion(region string) func(az *TierAzure) error

AzureRegion helper to supply optional region to NewTierAzure

func AzureServicePrincipal 

func AzureServicePrincipal(tenantID, clientID, clientSecret string) func(az *TierAzure) error

AzureServicePrincipal helper to supply optional service principal credentials

func AzureStorageClass 

func AzureStorageClass(sc string) func(az *TierAzure) error

AzureStorageClass helper to supply optional storage class to NewTierAzure

func DecryptData 

func DecryptData(password string, data io.Reader) ([]byte, error)

DecryptData decrypts the data with the key derived from the salt (part of data) and the password using the PBKDF used in EncryptData. DecryptData returns the decrypted plaintext on success.

The data must be a valid ciphertext produced by EncryptData. Otherwise, the decryption will fail.

func EncryptData 

func EncryptData(password string, data []byte) ([]byte, error)

EncryptData encrypts the data with an unique key derived from password using the Argon2id PBKDF.

The returned ciphertext data consists of: 

salt | AEAD ID | nonce | encrypted data
 32      1         8      ~ len(data)

func ErrInvalidArgument 

func ErrInvalidArgument(message string) error

ErrInvalidArgument - Invalid argument response.

func FIPSEnabled 

func FIPSEnabled() bool

FIPSEnabled returns true if and only if FIPS 140-2 support is enabled.

FIPS 140-2 requires that only specifc cryptographic primitives, like AES or SHA-256, are used and that those primitives are implemented by a FIPS 140-2 certified cryptographic module.

func GCSPrefix 

func GCSPrefix(prefix string) func(*TierGCS) error

GCSPrefix helper to supply optional object prefix to NewTierGCS

func GCSRegion 

func GCSRegion(region string) func(*TierGCS) error

GCSRegion helper to supply optional region to NewTierGCS

func GCSStorageClass 

func GCSStorageClass(sc string) func(*TierGCS) error

GCSStorageClass helper to supply optional storage class to NewTierGCS

func HasSpace 

func HasSpace(s string) bool

HasSpace - returns if given string has space.

func IsEncrypted 

func IsEncrypted(data []byte) bool

IsEncrypted reports whether data is encrypted.

func MinIOPrefix 

func MinIOPrefix(prefix string) func(m *TierMinIO) error

MinIOPrefix helper to supply optional object prefix to NewTierMinIO

func MinIORegion 

func MinIORegion(region string) func(m *TierMinIO) error

MinIORegion helper to supply optional region to NewTierMinIO

func ParsePrometheusResults 

func ParsePrometheusResults(reader io.Reader) (results []*prom2json.Family, err error)

func ParseSampleRate added in v4.0.18 

func ParseSampleRate(s string) (float64, error)

ParseSampleRate converts a sample rate from string format to float64.

func S3AWSRole 

func S3AWSRole() func(s3 *TierS3) error

S3AWSRole helper to use optional AWS Role to NewTierS3

func S3AWSRoleARN 

func S3AWSRoleARN(roleARN string) func(s3 *TierS3) error

S3AWSRoleARN helper to use optional AWS RoleARN to NewTierS3

func S3AWSRoleDurationSeconds 

func S3AWSRoleDurationSeconds(dsecs int) func(s3 *TierS3) error

S3AWSRoleDurationSeconds helper to use optional token duration to NewTierS3

func S3AWSRoleSessionName 

func S3AWSRoleSessionName(roleSessionName string) func(s3 *TierS3) error

S3AWSRoleSessionName helper to use optional AWS RoleSessionName to NewTierS3

func S3AWSRoleWebIdentityTokenFile 

func S3AWSRoleWebIdentityTokenFile(tokenFile string) func(s3 *TierS3) error

S3AWSRoleWebIdentityTokenFile helper to use optional AWS Role token file to NewTierS3

func S3Endpoint 

func S3Endpoint(endpoint string) func(s3 *TierS3) error

S3Endpoint helper to supply optional endpoint to NewTierS3

func S3Prefix 

func S3Prefix(prefix string) func(s3 *TierS3) error

S3Prefix helper to supply optional object prefix to NewTierS3

func S3Region 

func S3Region(region string) func(s3 *TierS3) error

S3Region helper to supply optional region to NewTierS3

func S3StorageClass 

func S3StorageClass(storageClass string) func(s3 *TierS3) error

S3StorageClass helper to supply optional storage class to NewTierS3

func SanitizeValue 

func SanitizeValue(v string) string

SanitizeValue - this function is needed, to trim off single or double quotes, creeping into the values.

func SortSlice added in v4.3.0 

func SortSlice[T any](slice []T, field string, reversed bool)

SortSlice allows for slice sorting based on a field as string. The referred field must be a string, int, uint, float or a pointer to one of these. The field must be exported. Structs can be traversed using dot notation, e.g. "Field1.Field2".

func WithDriveMetrics 

func WithDriveMetrics(metrics bool) func(*ServerInfoOpts)

WithDriveMetrics asks server to return additional metrics per drive

Types

type APILogOpts added in v4.2.10 

type APILogOpts struct {
	Node       string        `json:"node,omitempty"`
	API        string        `json:"api,omitempty"`
	Bucket     string        `json:"bucket,omitempty"`
	Prefix     string        `json:"prefix,omitempty"`
	StatusCode int           `json:"statusCode,omitempty"`
	Interval   time.Duration `json:"interval,omitempty"`
	Origin     log.Origin    `json:"origin,omitempty"`
	Type       log.APIType   `json:"type,omitempty"`
}

APILogOpts represents the options for the APILogOpts

type APIMetrics added in v4.2.9 

type APIMetrics struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	// Nodes responded to the request.
	Nodes int `json:"nodes"`

	// Number of active requests.
	ActiveRequests int64 `json:"activeRequests,omitempty"`

	// Number of queued requests.
	QueuedRequests int64 `json:"queuedRequests,omitempty"`

	// Last minute operation statistics by API.
	LastMinuteAPI map[string]APIStats `json:"lastMinuteApi,omitempty"`

	// Last day operation statistics by API, segmented.
	LastDayAPI map[string]SegmentedAPIMetrics `json:"lastDayApi,omitempty"`

	// SinceStart contains operation statistics since server(s) started.
	SinceStart APIStats `json:"since_start"`
}

APIMetrics contains metrics for API operations.

func (*APIMetrics) DecodeMsg added in v4.2.9 

func (z *APIMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*APIMetrics) EncodeMsg added in v4.2.9 

func (z *APIMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (APIMetrics) LastDayTotal added in v4.2.9 

func (a APIMetrics) LastDayTotal() APIStats

LastDayTotal returns the accumulated APIStats for the last day.

func (APIMetrics) LastDayTotalSegmented added in v4.2.9 

func (a APIMetrics) LastDayTotalSegmented() SegmentedAPIMetrics

LastDayTotalSegmented returns the total SegmentedAPIMetrics for the last day. There will be no node-count for values.

func (APIMetrics) LastMinuteTotal added in v4.2.9 

func (a APIMetrics) LastMinuteTotal() APIStats

LastMinuteTotal returns the total APIStats for the last minute.

func (*APIMetrics) MarshalMsg added in v4.2.9 

func (z *APIMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*APIMetrics) Merge added in v4.2.9 

func (a *APIMetrics) Merge(b *APIMetrics)

func (*APIMetrics) Msgsize added in v4.2.9 

func (z *APIMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*APIMetrics) UnmarshalMsg added in v4.2.9 

func (z *APIMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type APIStats added in v4.2.9 

type APIStats struct {
	Nodes         int        `json:"nodes,omitempty"`         // Number of nodes that have reported data.
	StartTime     *time.Time `json:"startTime,omitempty"`     // Time range this data covers unless merged from sources with different start times..
	EndTime       *time.Time `json:"endTime,omitempty"`       // Time range this data covers unless merged from sources with different end times.
	WallTimeSecs  float64    `json:"wallTimeSecs,omitempty"`  // Wall time this data covers, accumulated from all nodes.
	Requests      int64      `json:"requests,omitempty"`      // Total number of requests.
	IncomingBytes int64      `json:"incomingBytes,omitempty"` // Total number of bytes received.
	OutgoingBytes int64      `json:"outgoingBytes,omitempty"` // Total number of bytes sent.
	Errors4xx     int        `json:"errors_4xx,omitempty"`    // Total number of 4xx (client request) errors.
	Errors5xx     int        `json:"errors_5xx,omitempty"`    // Total number of 5xx (serverside) errors.
	Canceled      int64      `json:"canceled,omitempty"`      // Requests that were canceled before they finished processing.

	// Request times
	RequestTimeSecs float64 `json:"requestTimeSecs,omitempty"` // Total request time.
	ReqReadSecs     float64 `json:"reqReadSecs,omitempty"`     // Total time spent on request reads in seconds.
	RespSecs        float64 `json:"respSecs,omitempty"`        // Total time spent on responses in seconds.
	RespTTFBSecs    float64 `json:"respTtfbSecs,omitempty"`    // Total time spent on TTFB (req read -> response first byte) in seconds.

	// Request times min/max
	RequestTimeSecsMin float64 `json:"requestTimeSecsMin,omitempty"` // Min request time.
	RequestTimeSecsMax float64 `json:"requestTimeSecsMax,omitempty"` // Max request time.
	ReqReadSecsMin     float64 `json:"reqReadSecsMin,omitempty"`     // Min time spent on request reads in seconds.
	ReqReadSecsMax     float64 `json:"reqReadSecsMax,omitempty"`     // Max time spent on request reads in seconds.
	RespSecsMin        float64 `json:"respSecsMin,omitempty"`        // Min time spent on responses in seconds.
	RespSecsMax        float64 `json:"respSecsMax,omitempty"`        // Max time spent on responses in seconds.
	RespTTFBSecsMin    float64 `json:"respTtfbSecsMin,omitempty"`    // Min time spent on TTFB (req read -> response first byte) in seconds.
	RespTTFBSecsMax    float64 `json:"respTtfbSecsMax,omitempty"`    // Max time spent on TTFB (req read -> response first byte) in seconds.

	Rejected RejectedAPIStats `json:"rejected,omitempty"`
}

APIStats contains accumulated statistics for the API on a number of nodes.

func (*APIStats) Add added in v4.2.10 

func (a *APIStats) Add(other *APIStats)

Add 'other' to a.

func (*APIStats) DecodeMsg added in v4.2.9 

func (z *APIStats) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*APIStats) EncodeMsg added in v4.2.9 

func (z *APIStats) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*APIStats) MarshalMsg added in v4.2.9 

func (z *APIStats) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*APIStats) Merge added in v4.2.9 

func (a *APIStats) Merge(other APIStats)

Merge other into 'a'.

func (*APIStats) Msgsize added in v4.2.9 

func (z *APIStats) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*APIStats) UnmarshalMsg added in v4.2.9 

func (z *APIStats) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ARN 

type ARN struct {
	Type     ServiceType
	ID       string
	Region   string
	Resource string
	Bucket   string
}

ARN is a struct to define arn.

func ParseARN 

func ParseARN(s string) (*ARN, error)

ParseARN return ARN struct from string in arn format.

func (ARN) Empty 

func (a ARN) Empty() bool

Empty returns true if arn struct is empty

func (ARN) String 

func (a ARN) String() string

type AccountAccess 

type AccountAccess struct {
	Read  bool `json:"read"`
	Write bool `json:"write"`
}

AccountAccess contains information about

type AccountInfo 

type AccountInfo struct {
	AccountName string
	Server      BackendInfo
	Policy      json.RawMessage // Use iam/policy.Parse to parse the result, to be done by the caller.
	Buckets     []BucketAccessInfo
}

AccountInfo represents the account usage info of an account across buckets.

type AccountOpts 

type AccountOpts struct {
	PrefixUsage bool
}

AccountOpts allows for configurable behavior with "prefix-usage"

type AccountStatus 

type AccountStatus string

AccountStatus - account status. 

const (
	AccountEnabled  AccountStatus = "enabled"
	AccountDisabled AccountStatus = "disabled"
)

Account status per user.

type AddAzureCannedPolicyReq added in v4.2.13 

type AddAzureCannedPolicyReq struct {
	Name       string
	ConfigName string
	Policy     []byte
}

AddAzureCannedPolicyReq represents a request to add an Azure canned policy.

func (*AddAzureCannedPolicyReq) Validate added in v4.2.13 

func (r *AddAzureCannedPolicyReq) Validate() error

type AddOrUpdateUserReq 

type AddOrUpdateUserReq struct {
	SecretKey string        `json:"secretKey,omitempty"`
	Policy    string        `json:"policy,omitempty"`
	Status    AccountStatus `json:"status"`
}

AddOrUpdateUserReq allows to update

  • user details such as secret key
  • account status.
  • optionally a comma separated list of policies to be applied for the user.

type AddServiceAccountReq 

type AddServiceAccountReq struct {
	Policy     json.RawMessage `json:"policy,omitempty"` // Parsed value from iam/policy.Parse()
	TargetUser string          `json:"targetUser,omitempty"`
	AccessKey  string          `json:"accessKey,omitempty"`
	SecretKey  string          `json:"secretKey,omitempty"`

	// Name for this access key
	Name string `json:"name,omitempty"`
	// Description for this access key
	Description string `json:"description,omitempty"`
	// Time at which this access key expires
	Expiration *time.Time `json:"expiration,omitempty"`
}

AddServiceAccountReq is the request options of the add service account admin call

func (*AddServiceAccountReq) Validate 

func (r *AddServiceAccountReq) Validate() error

Validate validates the request parameters.

type AddServiceAccountResp 

type AddServiceAccountResp struct {
	Credentials Credentials `json:"credentials"`
}

AddServiceAccountResp is the response body of the add service account admin call

type AdminClient 

type AdminClient struct {
	// contains filtered or unexported fields
}

AdminClient implements Amazon S3 compatible methods.

func New deprecated 

func New(endpoint string, accessKeyID, secretAccessKey string, secure bool) (*AdminClient, error)

New - instantiate minio admin client

Deprecated: please use NewWithOptions

func NewWithOptions 

func NewWithOptions(endpoint string, opts *Options) (*AdminClient, error)

NewWithOptions - instantiate minio admin client with options.

func (*AdminClient) AccountInfo 

func (adm *AdminClient) AccountInfo(ctx context.Context, opts AccountOpts) (AccountInfo, error)

AccountInfo returns the usage info for the authenticating account.

func (*AdminClient) AddAzureCannedPolicy added in v4.2.13 

func (adm *AdminClient) AddAzureCannedPolicy(ctx context.Context, r AddAzureCannedPolicyReq) error

AddAzureCannedPolicy - adds a policy corresponding to the Azure group ID for the given Azure group name

func (*AdminClient) AddCannedPolicy 

func (adm *AdminClient) AddCannedPolicy(ctx context.Context, policyName string, policy []byte) error

AddCannedPolicy - adds a policy for a canned.

func (*AdminClient) AddOrUpdateIDPConfig 

func (adm *AdminClient) AddOrUpdateIDPConfig(ctx context.Context, cfgType, cfgName, cfgData string, update bool) (restart bool, err error)

AddOrUpdateIDPConfig - creates a new or updates an existing IDP configuration on the server.

func (*AdminClient) AddServiceAccount 

func (adm *AdminClient) AddServiceAccount(ctx context.Context, opts AddServiceAccountReq) (Credentials, error)

AddServiceAccount - creates a new service account belonging to the user sending the request while restricting the service account permission by the given policy document.

func (*AdminClient) AddServiceAccountLDAP 

func (adm *AdminClient) AddServiceAccountLDAP(ctx context.Context, opts AddServiceAccountReq) (Credentials, error)

AddServiceAccountLDAP - AddServiceAccount with extra features, restricted to LDAP users.

func (*AdminClient) AddTier 

func (adm *AdminClient) AddTier(ctx context.Context, cfg *TierConfig) error

AddTier adds a new remote tier.

func (*AdminClient) AddTierIgnoreInUse 

func (adm *AdminClient) AddTierIgnoreInUse(ctx context.Context, cfg *TierConfig) error

AddTierIgnoreInUse adds a new remote tier, ignoring if it's being used by another MinIO deployment.

func (*AdminClient) AddUser 

func (adm *AdminClient) AddUser(ctx context.Context, accessKey, secretKey string) error

AddUser - adds a user.

func (*AdminClient) AssignPolicy 

func (adm *AdminClient) AssignPolicy(ctx context.Context, policy string, content []byte) error

AssignPolicy tries to assign a policy to an identity at the KMS connected to a MinIO server.

func (*AdminClient) AttachPolicy 

func (adm *AdminClient) AttachPolicy(ctx context.Context, r PolicyAssociationReq) (PolicyAssociationResp, error)

AttachPolicy - attach policies to a user or group.

func (*AdminClient) AttachPolicyLDAP 

func (adm *AdminClient) AttachPolicyLDAP(ctx context.Context, par PolicyAssociationReq) (PolicyAssociationResp, error)

AttachPolicyLDAP - client call to attach policies for LDAP.

func (*AdminClient) BackgroundHealStatus 

func (adm *AdminClient) BackgroundHealStatus(ctx context.Context) (BgHealState, error)

BackgroundHealStatus returns the background heal status of the current server or cluster.

func (*AdminClient) BatchJobStatus 

func (adm *AdminClient) BatchJobStatus(ctx context.Context, jobID string) (BatchJobStatus, error)

BatchJobStatus returns the status of the given job.

func (*AdminClient) BucketReplicationDiff 

func (adm *AdminClient) BucketReplicationDiff(ctx context.Context, bucketName string, opts ReplDiffOpts) <-chan DiffInfo

BucketReplicationDiff - gets diff for non-replicated entries.

func (*AdminClient) BucketReplicationMRF 

func (adm *AdminClient) BucketReplicationMRF(ctx context.Context, bucketName string, node string) <-chan ReplicationMRF

BucketReplicationMRF - gets MRF entries for bucket and node. Return MRF across buckets if bucket is empty, across nodes if node is `all`

func (*AdminClient) BucketScanInfo 

func (adm *AdminClient) BucketScanInfo(ctx context.Context, bucket string) ([]BucketScanInfo, error)

BucketScanInfo returns information of a bucket scan in all pools/sets

func (*AdminClient) CancelBatchJob 

func (adm *AdminClient) CancelBatchJob(ctx context.Context, jobID string) error

CancelBatchJob cancels ongoing batch job.

func (*AdminClient) CancelDecommissionPool 

func (adm *AdminClient) CancelDecommissionPool(ctx context.Context, pool string) error

CancelDecommissionPool - cancels an on-going decommissioning process, this automatically makes the pool available for writing once canceled.

func (*AdminClient) CancelInventoryJob added in v4.2.13 

func (adm *AdminClient) CancelInventoryJob(ctx context.Context, bucket, inventoryID string) (*InventoryJobControlResponse, error)

CancelInventoryJob cancels a running inventory job

func (*AdminClient) CheckIDPConfig added in v4.0.15 

func (adm *AdminClient) CheckIDPConfig(ctx context.Context, cfgType, cfgName string) (CheckIDPConfigResp, error)

func (*AdminClient) ClearConfigHistoryKV 

func (adm *AdminClient) ClearConfigHistoryKV(ctx context.Context, restoreID string) (err error)

ClearConfigHistoryKV - clears the config entry represented by restoreID. optionally allows setting `all` as a special keyword to automatically erase all config set history entires.

func (*AdminClient) ClientPerf 

func (adm *AdminClient) ClientPerf(ctx context.Context, dur time.Duration) (result ClientPerfResult, err error)

ClientPerf - perform net from client to MinIO servers

func (*AdminClient) ClusterAPIStats added in v4.2.9 

func (adm *AdminClient) ClusterAPIStats(ctx context.Context) (res *ClusterAPIStats, err error)

ClusterAPIStats makes an admin call to retrieve general API metrics.

func (*AdminClient) ClusterInfo 

func (adm *AdminClient) ClusterInfo(ctx context.Context, options ...func(*ClusterInfoOpts)) (ClusterInfo, error)

ClusterInfo - Connect to a minio server and call Server Admin Info Management API to fetch server's information represented by infoMessage structure

func (*AdminClient) ClusterQuery added in v4.1.0 

func (adm *AdminClient) ClusterQuery(ctx context.Context, options ...func(*ClusterResourceOpts)) (ClusterResource, error)

ClusterQuery - Get high-level information about the cluster

func (*AdminClient) CreateKey 

func (adm *AdminClient) CreateKey(ctx context.Context, keyID string) error

CreateKey tries to create a new master key with the given keyID at the KMS connected to a MinIO server.

func (AdminClient) CredContext 

func (adm AdminClient) CredContext() *credentials.CredContext

CredContext returns the context for fetching credentials

func (*AdminClient) DataUsageInfo 

func (adm *AdminClient) DataUsageInfo(ctx context.Context) (DataUsageInfo, error)

DataUsageInfo - returns data usage of the current object API

func (*AdminClient) DecommissionPool 

func (adm *AdminClient) DecommissionPool(ctx context.Context, pool string) error

DecommissionPool - starts moving data from specified pool to all other existing pools. Decommissioning if successfully started this function will return `nil`, to check for on-going draining cycle use StatusPool.

func (*AdminClient) DelConfigKV 

func (adm *AdminClient) DelConfigKV(ctx context.Context, k string) (restart bool, err error)

DelConfigKV - delete key from server config.

func (*AdminClient) DeleteIDPConfig 

func (adm *AdminClient) DeleteIDPConfig(ctx context.Context, cfgType, cfgName string) (restart bool, err error)

DeleteIDPConfig - delete an IDP configuration on the server.

func (*AdminClient) DeleteIdentity 

func (adm *AdminClient) DeleteIdentity(ctx context.Context, identity string) error

DeleteIdentity tries to delete a identity at the KMS connected to a MinIO server.

func (*AdminClient) DeleteKey 

func (adm *AdminClient) DeleteKey(ctx context.Context, keyID string) error

DeleteKey tries to delete a key with the given keyID at the KMS connected to a MinIO server.

func (*AdminClient) DeletePolicy 

func (adm *AdminClient) DeletePolicy(ctx context.Context, policy string) error

DeletePolicy tries to delete a policy at the KMS connected to a MinIO server.

func (*AdminClient) DeleteServiceAccount 

func (adm *AdminClient) DeleteServiceAccount(ctx context.Context, serviceAccount string) error

DeleteServiceAccount - delete a specified service account. The server will reject the request if the service account does not belong to the user initiating the request

func (*AdminClient) DescribeBatchJob 

func (adm *AdminClient) DescribeBatchJob(ctx context.Context, jobID string) (string, error)

DescribeBatchJob - describes a currently running Job.

func (*AdminClient) DescribeIdentity 

func (adm *AdminClient) DescribeIdentity(ctx context.Context, identity string) (*KMSDescribeIdentity, error)

DescribeIdentity tries to describe a KMS identity

func (*AdminClient) DescribePolicy 

func (adm *AdminClient) DescribePolicy(ctx context.Context, policy string) (*KMSDescribePolicy, error)

DescribePolicy tries to describe a KMS policy

func (*AdminClient) DescribeSelfIdentity 

func (adm *AdminClient) DescribeSelfIdentity(ctx context.Context) (*KMSDescribeSelfIdentity, error)

DescribeSelfIdentity tries to describe the identity issuing the request.

func (*AdminClient) DetachPolicy 

func (adm *AdminClient) DetachPolicy(ctx context.Context, r PolicyAssociationReq) (PolicyAssociationResp, error)

DetachPolicy - detach policies from a user or group.

func (*AdminClient) DetachPolicyLDAP 

func (adm *AdminClient) DetachPolicyLDAP(ctx context.Context, par PolicyAssociationReq) (PolicyAssociationResp, error)

DetachPolicyLDAP - client call to detach policies for LDAP.

func (*AdminClient) DownloadProfilingData 

func (adm *AdminClient) DownloadProfilingData(ctx context.Context) (io.ReadCloser, error)

DownloadProfilingData makes an admin call to download profiling data of a standalone server or of the whole cluster in case of a distributed setup. NOTE: For simpler use cases use Profile() API, must be

func (*AdminClient) DriveInfo 

func (adm *AdminClient) DriveInfo(ctx context.Context, poolIndex, setIndex, diskIndex int, options ...func(*DriveInfoOpts)) (Disk, error)

DriveInfo returns information for a specific drive

func (*AdminClient) DriveSpeedtest 

func (adm *AdminClient) DriveSpeedtest(ctx context.Context, opts DriveSpeedTestOpts) (chan DriveSpeedTestResult, error)

DriveSpeedtest - perform drive speedtest on the MinIO servers

func (*AdminClient) DrivesQuery added in v4.1.0 

func (adm *AdminClient) DrivesQuery(ctx context.Context, options *DrivesResourceOpts) (*PaginatedDrivesResponse, error)

DrivesQuery - Get list of drives

func (*AdminClient) EditTier 

func (adm *AdminClient) EditTier(ctx context.Context, tierName string, creds TierCreds) error

EditTier supports updating credentials for the remote tier identified by tierName.

func (*AdminClient) ErasureSetsQuery added in v4.1.0 

func (adm *AdminClient) ErasureSetsQuery(ctx context.Context, options *ErasureSetsResourceOpts) (*PaginatedErasureSetsResponse, error)

ErasureSetsQuery - Get list of erasure sets

func (AdminClient) ExecuteMethod 

func (adm AdminClient) ExecuteMethod(ctx context.Context, method string, reqData RequestData) (res *http.Response, err error)

ExecuteMethod - similar to internal method executeMethod() useful for writing custom requests.

func (*AdminClient) ExportBucketMetadata 

func (adm *AdminClient) ExportBucketMetadata(ctx context.Context, bucket string) (io.ReadCloser, error)

ExportBucketMetadata makes an admin call to export bucket metadata of a bucket

func (*AdminClient) ExportIAM 

func (adm *AdminClient) ExportIAM(ctx context.Context) (io.ReadCloser, error)

ExportIAM makes an admin call to export IAM data

func (*AdminClient) ForceUnlock 

func (adm *AdminClient) ForceUnlock(ctx context.Context, paths ...string) error

ForceUnlock force unlocks input paths...

func (*AdminClient) GenerateBatchJob 

func (adm *AdminClient) GenerateBatchJob(_ context.Context, opts GenerateBatchJobOpts) (string, error)

GenerateBatchJob creates a new job template from standard template TODO: allow configuring yaml values

func (*AdminClient) GenerateBatchJobV2 

func (adm *AdminClient) GenerateBatchJobV2(ctx context.Context, opts GenerateBatchJobOpts) (template string, apiUnavailable bool, err error)

GenerateBatchJobV2 creates a new job template by requesting the server. This is an EOS only API and returns apiUnavailable=true when API is unsupported.

func (AdminClient) GetAPILogs added in v4.2.10 

func (adm AdminClient) GetAPILogs(ctx context.Context, opts APILogOpts) iter.Seq2[log.API, error]

GetAPILogs fetches the persisted API logs from MinIO

func (AdminClient) GetAccessAndSecretKey 

func (adm AdminClient) GetAccessAndSecretKey() (string, string)

GetAccessAndSecretKey - retrieves the access and secret keys.

func (AdminClient) GetAuditLogs added in v4.2.10 

func (adm AdminClient) GetAuditLogs(ctx context.Context, opts AuditLogOpts) iter.Seq2[log.Audit, error]

GetAuditLogs fetches the persisted audit logs from MinIO

func (*AdminClient) GetBucketBandwidth 

func (adm *AdminClient) GetBucketBandwidth(ctx context.Context, buckets ...string) <-chan Report

GetBucketBandwidth - Gets a channel reporting bandwidth measurements for replication buckets. If no buckets generate replication traffic an empty map is returned in the report until traffic is seen.

func (*AdminClient) GetBucketQuota 

func (adm *AdminClient) GetBucketQuota(ctx context.Context, bucket string) (q BucketQuota, err error)

GetBucketQuota - get info on a user

func (*AdminClient) GetConfig 

func (adm *AdminClient) GetConfig(ctx context.Context) ([]byte, error)

GetConfig - returns the config.json of a minio setup, incoming data is encrypted.

func (*AdminClient) GetConfigKV 

func (adm *AdminClient) GetConfigKV(ctx context.Context, key string) ([]byte, error)

GetConfigKV - returns the key, value of the requested key, incoming data is encrypted.

func (*AdminClient) GetConfigKVWithOptions 

func (adm *AdminClient) GetConfigKVWithOptions(ctx context.Context, key string, opts KVOptions) ([]byte, error)

GetConfigKVWithOptions - returns the key, value of the requested key, incoming data is encrypted.

func (AdminClient) GetEndpointURL 

func (adm AdminClient) GetEndpointURL() *url.URL

GetEndpointURL - returns the endpoint for the admin client.

func (AdminClient) GetErrorLogs added in v4.2.10 

func (adm AdminClient) GetErrorLogs(ctx context.Context, opts ErrorLogOpts) iter.Seq2[log.Error, error]

GetErrorLogs fetches the persisted error logs from MinIO

func (*AdminClient) GetGroupDescription 

func (adm *AdminClient) GetGroupDescription(ctx context.Context, group string) (*GroupDesc, error)

GetGroupDescription - fetches information on a group.

func (*AdminClient) GetIDPConfig 

func (adm *AdminClient) GetIDPConfig(ctx context.Context, cfgType, cfgName string) (c IDPConfig, err error)

GetIDPConfig - fetch IDP config from server.

func (*AdminClient) GetKeyStatus 

func (adm *AdminClient) GetKeyStatus(ctx context.Context, keyID string) (*KMSKeyStatus, error)

GetKeyStatus requests status information about the key referenced by keyID from the KMS connected to a MinIO by performing a Admin-API request. It basically hits the `/minio/admin/v4/kms/key/status` API endpoint.

func (*AdminClient) GetLDAPPolicyEntities 

func (adm *AdminClient) GetLDAPPolicyEntities(ctx context.Context,
	q PolicyEntitiesQuery,
) (r PolicyEntitiesResult, err error)

GetLDAPPolicyEntities - returns LDAP policy entities.

func (*AdminClient) GetLicenseInfo 

func (adm *AdminClient) GetLicenseInfo(ctx context.Context) (*LicenseInfo, error)

GetLicenseInfo - returns the license info

func (AdminClient) GetLogs 

func (adm AdminClient) GetLogs(ctx context.Context, node string, lineCnt int, logKind string) <-chan LogInfo

GetLogs - listen on console log messages.

func (*AdminClient) GetPolicy 

func (adm *AdminClient) GetPolicy(ctx context.Context, policy string) (*KMSPolicy, error)

GetPolicy tries to get a KMS policy

func (*AdminClient) GetPolicyEntities 

func (adm *AdminClient) GetPolicyEntities(ctx context.Context, q PolicyEntitiesQuery) (r PolicyEntitiesResult, err error)

GetPolicyEntities - returns builtin policy entities.

func (*AdminClient) GetSupportedBatchJobTypes 

func (adm *AdminClient) GetSupportedBatchJobTypes(ctx context.Context) (supportedTypes []BatchJobType, apiUnavailable bool, err error)

GetSupportedBatchJobTypes returns the list of server supported batch job types.

func (*AdminClient) GetUserInfo 

func (adm *AdminClient) GetUserInfo(ctx context.Context, name string) (u UserInfo, err error)

GetUserInfo - get info on a user

func (*AdminClient) Heal 

func (adm *AdminClient) Heal(ctx context.Context, bucket, prefix string,
	healOpts HealOpts, clientToken string, forceStart, forceStop bool) (
	healStart HealStartSuccess, healTaskStatus HealTaskStatus, err error,
)

Heal - API endpoint to start heal and to fetch status forceStart and forceStop are mutually exclusive, you can either set one of them to 'true'. If both are set 'forceStart' will be honored.

func (*AdminClient) HelpConfigKV 

func (adm *AdminClient) HelpConfigKV(ctx context.Context, subSys, key string, envOnly bool) (Help, error)

HelpConfigKV - return help for a given sub-system.

func (*AdminClient) ImportBucketMetadata 

func (adm *AdminClient) ImportBucketMetadata(ctx context.Context, bucket string, contentReader io.ReadCloser) (r BucketMetaImportErrs, err error)

ImportBucketMetadata makes an admin call to set bucket metadata of a bucket from imported content

func (*AdminClient) ImportIAM 

func (adm *AdminClient) ImportIAM(ctx context.Context, contentReader io.ReadCloser) error

ImportIAM makes an admin call to setup IAM from imported content

func (*AdminClient) ImportIAMV2 

func (adm *AdminClient) ImportIAMV2(ctx context.Context, contentReader io.ReadCloser) (iamr ImportIAMResult, err error)

ImportIAMV2 makes an admin call to setup IAM from imported content

func (*AdminClient) ImportKey 

func (adm *AdminClient) ImportKey(ctx context.Context, keyID string, content []byte) error

ImportKey tries to import a cryptographic key at the KMS connected to a MinIO server.

func (*AdminClient) InfoAccessKey 

func (adm *AdminClient) InfoAccessKey(ctx context.Context, accessKey string) (InfoAccessKeyResp, error)

InfoAccessKey - returns the info of an access key

func (*AdminClient) InfoAzureCannedPolicy added in v4.2.13 

func (adm *AdminClient) InfoAzureCannedPolicy(ctx context.Context, r InfoAzureCannedPolicyReq) (InfoAzureCannedPolicyResp, error)

InfoAzureCannedPolicy - gets info on an Azure canned policy including timestamps and policy json

func (*AdminClient) InfoCannedPolicy 

func (adm *AdminClient) InfoCannedPolicy(ctx context.Context, policyName string) (*PolicyInfo, error)

InfoCannedPolicy - get info on a policy including timestamps and policy json.

func (*AdminClient) InfoServiceAccount 

func (adm *AdminClient) InfoServiceAccount(ctx context.Context, accessKey string) (InfoServiceAccountResp, error)

InfoServiceAccount - returns the info of service account belonging to the specified user

func (*AdminClient) Inspect 

func (adm *AdminClient) Inspect(ctx context.Context, d InspectOptions) (key []byte, c io.ReadCloser, err error)

Inspect makes an admin call to download a raw files from disk. If inspect is called with a public key no key will be returned and the data is returned encrypted with the public key.

func (*AdminClient) KMSAPIs 

func (adm *AdminClient) KMSAPIs(ctx context.Context) ([]KMSAPI, error)

KMSAPIs returns a list of supported API endpoints in the KMS connected to the MinIO server, if configured.

func (*AdminClient) KMSMetrics 

func (adm *AdminClient) KMSMetrics(ctx context.Context) (*KMSMetrics, error)

KMSMetrics returns metrics about the KMS connected to the MinIO server, if configured.

func (*AdminClient) KMSStatus 

func (adm *AdminClient) KMSStatus(ctx context.Context) (KMSStatus, error)

KMSStatus returns status information about the KMS connected to the MinIO server, if configured.

func (*AdminClient) KMSVersion 

func (adm *AdminClient) KMSVersion(ctx context.Context) (*KMSVersion, error)

KMSVersion returns a list of supported API endpoints in the KMS connected to the MinIO server, if configured.

func (*AdminClient) ListAccessKeysBulk 

func (adm *AdminClient) ListAccessKeysBulk(ctx context.Context, users []string, opts ListAccessKeysOpts) (map[string]ListAccessKeysResp, error)

ListAccessKeysBulk - list access keys belonging to the given users or all users

func (*AdminClient) ListAccessKeysLDAPBulk 

func (adm *AdminClient) ListAccessKeysLDAPBulk(ctx context.Context, users []string, listType string, all bool) (map[string]ListAccessKeysLDAPResp, error)

ListAccessKeysLDAPBulk - list access keys belonging to the given users or all users

func (*AdminClient) ListAccessKeysLDAPBulkWithOpts 

func (adm *AdminClient) ListAccessKeysLDAPBulkWithOpts(ctx context.Context, users []string, opts ListAccessKeysOpts) (map[string]ListAccessKeysLDAPResp, error)

ListAccessKeysLDAPBulkWithOpts - list access keys belonging to the given users or all users

func (*AdminClient) ListAccessKeysOpenIDBulk 

func (adm *AdminClient) ListAccessKeysOpenIDBulk(ctx context.Context, users []string, opts ListAccessKeysOpts) ([]ListAccessKeysOpenIDResp, error)

ListAccessKeysOpenIDBulk - list access keys belonging to the given users or all users

func (*AdminClient) ListAzureCannedPolicies added in v4.2.13 

func (adm *AdminClient) ListAzureCannedPolicies(ctx context.Context, r ListAzureCannedPoliciesReq) (ListAzureCannedPoliciesResp, error)

ListAzureCannedPolicies - lists all Azure canned policies for the given configuration

func (*AdminClient) ListBatchJobs 

func (adm *AdminClient) ListBatchJobs(ctx context.Context, fl *ListBatchJobsFilter) (ListBatchJobsResult, error)

ListBatchJobs list all the currently active batch jobs

func (*AdminClient) ListCannedPolicies 

func (adm *AdminClient) ListCannedPolicies(ctx context.Context) (map[string]json.RawMessage, error)

ListCannedPolicies - list all configured canned policies.

func (*AdminClient) ListConfigHistoryKV 

func (adm *AdminClient) ListConfigHistoryKV(ctx context.Context, count int) ([]ConfigHistoryEntry, error)

ListConfigHistoryKV - lists a slice of ConfigHistoryEntries sorted by createTime.

func (*AdminClient) ListGroups 

func (adm *AdminClient) ListGroups(ctx context.Context) ([]string, error)

ListGroups - lists all groups names present on the server.

func (*AdminClient) ListIDPConfig 

func (adm *AdminClient) ListIDPConfig(ctx context.Context, cfgType string) ([]IDPListItem, error)

ListIDPConfig - list IDP configuration on the server.

func (*AdminClient) ListIdentities 

func (adm *AdminClient) ListIdentities(ctx context.Context, pattern string) ([]KMSIdentityInfo, error)

ListIdentities tries to get all identities that match the specified pattern

func (*AdminClient) ListKeys 

func (adm *AdminClient) ListKeys(ctx context.Context, pattern string) ([]KMSKeyInfo, error)

ListKeys tries to get all key names that match the specified pattern

func (*AdminClient) ListPolicies 

func (adm *AdminClient) ListPolicies(ctx context.Context, pattern string) ([]KMSPolicyInfo, error)

ListPolicies tries to get all policies that match the specified pattern

func (*AdminClient) ListPoolsStatus 

func (adm *AdminClient) ListPoolsStatus(ctx context.Context) ([]PoolStatus, error)

ListPoolsStatus returns list of pools currently configured and being used on the cluster.

func (*AdminClient) ListRemoteTargets 

func (adm *AdminClient) ListRemoteTargets(ctx context.Context, bucket, arnType string) (targets []BucketTarget, err error)

ListRemoteTargets - gets target(s) for this bucket

func (*AdminClient) ListServiceAccounts 

func (adm *AdminClient) ListServiceAccounts(ctx context.Context, user string) (ListServiceAccountsResp, error)

ListServiceAccounts - list service accounts belonging to the specified user

func (*AdminClient) ListTiers 

func (adm *AdminClient) ListTiers(ctx context.Context) ([]*TierConfig, error)

ListTiers returns a list of remote tiers configured.

func (*AdminClient) ListUsers 

func (adm *AdminClient) ListUsers(ctx context.Context) (map[string]UserInfo, error)

ListUsers - list all users.

func (*AdminClient) Metrics 

func (adm *AdminClient) Metrics(ctx context.Context, o MetricsOptions, out func(RealtimeMetrics)) (err error)

Metrics makes an admin call to retrieve metrics. The provided function is called for each received entry.

func (*AdminClient) Netperf 

func (adm *AdminClient) Netperf(ctx context.Context, duration time.Duration) (result NetperfResult, err error)

Netperf - perform netperf on the MinIO servers

func (*AdminClient) NodeInfo added in v4.0.11 

func (adm *AdminClient) NodeInfo(ctx context.Context, hostname string, options ...func(*NodeInfoOpts)) (node *Node, err error)

NodeInfo - fetch information about a specific node

func (*AdminClient) NodeList added in v4.0.11 

func (adm *AdminClient) NodeList(ctx context.Context, options ...func(*NodeListOpts)) (nodeList *NodeListResponse, err error)

NodeList - list all nodes in the cluster

func (*AdminClient) NodesQuery added in v4.1.0 

func (adm *AdminClient) NodesQuery(ctx context.Context, options *NodesResourceOpts) (*PaginatedNodesResponse, error)

NodesQuery - Get list of nodes

func (*AdminClient) ObjectSummary 

func (adm *AdminClient) ObjectSummary(ctx context.Context, objOpts ObjectSummaryOptions) (objectSummary *ObjectSummary, err error)

ObjectSummary calls minio to search for all files and parts related to the given object, across all disks.

func (*AdminClient) PoolInfo 

func (adm *AdminClient) PoolInfo(ctx context.Context, poolIndex int, options ...func(*PoolInfoOpts)) (PoolInfo, error)

PoolInfo returns pool information about a specific pool referenced by poolIndex

func (*AdminClient) PoolList 

func (adm *AdminClient) PoolList(ctx context.Context, options ...func(*PoolInfoOpts)) (pools []PoolInfo, err error)

PoolList list all the pools on the server

func (*AdminClient) PoolsQuery added in v4.1.0 

func (adm *AdminClient) PoolsQuery(ctx context.Context, options *PoolsResourceOpts) (*PaginatedPoolsResponse, error)

func (*AdminClient) Profile 

func (adm *AdminClient) Profile(ctx context.Context, profiler ProfilerType, duration time.Duration) (io.ReadCloser, error)

Profile makes an admin call to remotely start profiling on a standalone server or the whole cluster in case of a distributed setup for a specified duration.

func (*AdminClient) RebalanceStart 

func (adm *AdminClient) RebalanceStart(ctx context.Context) (id string, err error)

RebalanceStart starts a rebalance operation if one isn't in progress already

func (*AdminClient) RebalanceStatus 

func (adm *AdminClient) RebalanceStatus(ctx context.Context) (r RebalanceStatus, err error)

func (*AdminClient) RebalanceStop 

func (adm *AdminClient) RebalanceStop(ctx context.Context) error

func (*AdminClient) RemoveAzureCannedPolicy added in v4.2.13 

func (adm *AdminClient) RemoveAzureCannedPolicy(ctx context.Context, r RemoveAzureCannedPolicyReq) error

RemoveAzureCannedPolicy - removes a policy corresponding to the Azure group ID for the given Azure group name

func (*AdminClient) RemoveCannedPolicy 

func (adm *AdminClient) RemoveCannedPolicy(ctx context.Context, policyName string) error

RemoveCannedPolicy - remove a policy for a canned.

func (*AdminClient) RemoveRemoteTarget 

func (adm *AdminClient) RemoveRemoteTarget(ctx context.Context, bucket, arn string) error

RemoveRemoteTarget removes a remote target associated with particular ARN for this bucket

func (*AdminClient) RemoveTier 

func (adm *AdminClient) RemoveTier(ctx context.Context, tierName string) error

RemoveTier removes an empty tier identified by tierName

func (*AdminClient) RemoveTierV2 

func (adm *AdminClient) RemoveTierV2(ctx context.Context, tierName string, opts RemoveTierOpts) error

RemoveTierV2 removes an empty tier identified by tierName, the tier is not required to be reachable or empty if force flag is set to true.

func (*AdminClient) RemoveUser 

func (adm *AdminClient) RemoveUser(ctx context.Context, accessKey string) error

RemoveUser - remove a user.

func (*AdminClient) RestoreConfigHistoryKV 

func (adm *AdminClient) RestoreConfigHistoryKV(ctx context.Context, restoreID string) (err error)

RestoreConfigHistoryKV - Restore a previous config set history. Input is a unique id which represents the previous setting.

func (*AdminClient) ResumeInventoryJob added in v4.2.13 

func (adm *AdminClient) ResumeInventoryJob(ctx context.Context, bucket, inventoryID string) (*InventoryJobControlResponse, error)

ResumeInventoryJob resumes a suspended inventory job

func (*AdminClient) RevokeTokens 

func (adm *AdminClient) RevokeTokens(ctx context.Context, opts RevokeTokensReq) error

RevokeTokens - revokes tokens for the specified builtin user, or for an external (LDAP, OpenID, etc.) user being sent by one of its STS credentials.

func (*AdminClient) RevokeTokensLDAP 

func (adm *AdminClient) RevokeTokensLDAP(ctx context.Context, opts RevokeTokensReq) error

RevokeTokensLDAP - revokes tokens for the specified LDAP user.

func (*AdminClient) SRMetaInfo 

func (adm *AdminClient) SRMetaInfo(ctx context.Context, opts SRStatusOptions) (info SRInfo, err error)

SRMetaInfo - returns replication metadata info for a site.

func (*AdminClient) SRPeerBucketOps 

func (adm *AdminClient) SRPeerBucketOps(ctx context.Context, bucket string, op BktOp, opts map[string]string) error

SRPeerBucketOps - tells peers to create bucket and setup replication.

func (*AdminClient) SRPeerEdit 

func (adm *AdminClient) SRPeerEdit(ctx context.Context, pi PeerInfo) error

SRPeerEdit - used only by minio server to update peer endpoint for a server already in the site replication setup

func (*AdminClient) SRPeerGetIDPSettings 

func (adm *AdminClient) SRPeerGetIDPSettings(ctx context.Context) (info IDPSettings, err error)

SRPeerGetIDPSettings - fetches IDP settings from the server.

func (*AdminClient) SRPeerJoin 

func (adm *AdminClient) SRPeerJoin(ctx context.Context, r SRPeerJoinReq) error

SRPeerJoin - used only by minio server to send SR join requests to peer servers.

func (*AdminClient) SRPeerRemove 

func (adm *AdminClient) SRPeerRemove(ctx context.Context, removeReq SRRemoveReq) (st ReplicateRemoveStatus, err error)

SRPeerRemove - used only by minio server to unlink cluster replication for a server already in the site replication setup

func (*AdminClient) SRPeerReplicateBucketMeta 

func (adm *AdminClient) SRPeerReplicateBucketMeta(ctx context.Context, item SRBucketMeta) error

SRPeerReplicateBucketMeta - copies a bucket metadata change to a peer cluster.

func (*AdminClient) SRPeerReplicateIAMItem 

func (adm *AdminClient) SRPeerReplicateIAMItem(ctx context.Context, item SRIAMItem) error

SRPeerReplicateIAMItem - copies an IAM object to a peer cluster.

func (*AdminClient) SRStateEdit 

func (adm *AdminClient) SRStateEdit(ctx context.Context, state SRStateEditReq) error

SRStateEdit - used only by minio server to update peer state for a server already in the site replication setup

func (*AdminClient) SRStatusInfo 

func (adm *AdminClient) SRStatusInfo(ctx context.Context, opts SRStatusOptions) (info SRStatusInfo, err error)

SRStatusInfo - returns site replication status

func (*AdminClient) ServerHealthInfo 

func (adm *AdminClient) ServerHealthInfo(ctx context.Context, types []HealthDataType, deadline time.Duration, anonymize string) (*http.Response, string, error)

ServerHealthInfo - Connect to a minio server and call Health Info Management API to fetch server's information represented by HealthInfo structure

func (*AdminClient) ServerInfo 

func (adm *AdminClient) ServerInfo(ctx context.Context, options ...func(*ServerInfoOpts)) (InfoMessage, error)

ServerInfo - Connect to a minio server and call Server Admin Info Management API to fetch server's information represented by infoMessage structure

func (*AdminClient) ServerUpdate 

func (adm *AdminClient) ServerUpdate(ctx context.Context, opts ServerUpdateOpts) (us ServerUpdateStatus, err error)

ServerUpdate - updates and restarts the MinIO cluster to latest version. optionally takes an input URL to specify a custom update binary link

func (*AdminClient) ServiceAction 

func (adm *AdminClient) ServiceAction(ctx context.Context, opts ServiceActionOpts) (ServiceActionResult, error)

ServiceAction - specify the type of service action that we are requesting the server to perform

func (*AdminClient) ServiceFreeze 

func (adm *AdminClient) ServiceFreeze(ctx context.Context) error

ServiceFreeze - freezes all incoming S3 API calls on MinIO cluster

func (*AdminClient) ServiceRestart 

func (adm *AdminClient) ServiceRestart(ctx context.Context) error

ServiceRestart - restarts the MinIO cluster

func (*AdminClient) ServiceStop 

func (adm *AdminClient) ServiceStop(ctx context.Context) error

ServiceStop - stops the MinIO cluster

func (AdminClient) ServiceTelemetry 

func (adm AdminClient) ServiceTelemetry(ctx context.Context, opts ServiceTelemetryOpts, dst chan<- ServiceTelemetry, pk *rsa.PrivateKey)

ServiceTelemetry - perform trace request and return individual packages. If options contains a public key the private key must be provided. If context is canceled the function will return.

func (AdminClient) ServiceTelemetryStream 

func (adm AdminClient) ServiceTelemetryStream(ctx context.Context, opts ServiceTelemetryOpts) (io.ReadCloser, error)

ServiceTelemetryStream - gets raw stream for service telemetry.

func (AdminClient) ServiceTrace 

func (adm AdminClient) ServiceTrace(ctx context.Context, opts ServiceTraceOpts) <-chan ServiceTraceInfo

ServiceTrace - listen on http trace notifications.

func (AdminClient) ServiceTraceIter added in v4.2.5 

func (adm AdminClient) ServiceTraceIter(ctx context.Context, opts ServiceTraceOpts) iter.Seq[ServiceTraceInfo]

ServiceTraceIter - listen on http trace notifications via iter.Seq

func (*AdminClient) ServiceUnfreeze 

func (adm *AdminClient) ServiceUnfreeze(ctx context.Context) error

ServiceUnfreeze - un-freezes all incoming S3 API calls on MinIO cluster

func (*AdminClient) ServicesQuery added in v4.1.0 

func (adm *AdminClient) ServicesQuery(ctx context.Context, options ...func(*ServicesResourceOpts)) (ServicesResourceInfo, error)

ServicesQuery - Get information about services connected to the cluster

func (*AdminClient) SetAppInfo 

func (adm *AdminClient) SetAppInfo(appName string, appVersion string)

SetAppInfo - add application details to user agent.

func (*AdminClient) SetBucketQuota 

func (adm *AdminClient) SetBucketQuota(ctx context.Context, bucket string, quota *BucketQuota) error

SetBucketQuota - sets a bucket's quota, if quota is set to '0' quota is disabled.

func (*AdminClient) SetConfig 

func (adm *AdminClient) SetConfig(ctx context.Context, config io.Reader) (err error)

SetConfig - set config supplied as config.json for the setup.

func (*AdminClient) SetConfigKV 

func (adm *AdminClient) SetConfigKV(ctx context.Context, kv string) (restart bool, err error)

SetConfigKV - set key value config to server.

func (*AdminClient) SetGroupStatus 

func (adm *AdminClient) SetGroupStatus(ctx context.Context, group string, status GroupStatus) error

SetGroupStatus - sets the status of a group.

func (*AdminClient) SetInfo 

func (adm *AdminClient) SetInfo(ctx context.Context, poolIndex int, setIndex int, options ...func(*SetInfoOpts)) (ExtendedErasureSetInfo, error)

func (*AdminClient) SetKMSPolicy 

func (adm *AdminClient) SetKMSPolicy(ctx context.Context, policy string, content []byte) error

SetKMSPolicy tries to create or update a policy at the KMS connected to a MinIO server.

func (*AdminClient) SetRemoteTarget 

func (adm *AdminClient) SetRemoteTarget(ctx context.Context, bucket string, target *BucketTarget) (string, error)

SetRemoteTarget sets up a remote target for this bucket

func (*AdminClient) SetUser 

func (adm *AdminClient) SetUser(ctx context.Context, accessKey, secretKey string, status AccountStatus) error

SetUser - update user secret key or account status.

func (*AdminClient) SetUserReq 

func (adm *AdminClient) SetUserReq(ctx context.Context, accessKey string, req AddOrUpdateUserReq) error

SetUserReq - update user secret key, account status or policies.

func (*AdminClient) SetUserStatus 

func (adm *AdminClient) SetUserStatus(ctx context.Context, accessKey string, status AccountStatus) error

SetUserStatus - adds a status for a user.

func (*AdminClient) SiteReplicationAdd 

func (adm *AdminClient) SiteReplicationAdd(ctx context.Context, sites []PeerSite, opts SRAddOptions) (ReplicateAddStatus, error)

SiteReplicationAdd - sends the SR add API call.

func (*AdminClient) SiteReplicationEdit 

func (adm *AdminClient) SiteReplicationEdit(ctx context.Context, site PeerInfo, opts SREditOptions) (ReplicateEditStatus, error)

SiteReplicationEdit - sends the SR edit API call.

func (*AdminClient) SiteReplicationInfo 

func (adm *AdminClient) SiteReplicationInfo(ctx context.Context) (info SiteReplicationInfo, err error)

SiteReplicationInfo - returns cluster replication information.

func (*AdminClient) SiteReplicationPerf 

func (adm *AdminClient) SiteReplicationPerf(ctx context.Context, duration time.Duration) (result SiteNetPerfResult, err error)

SiteReplicationPerf - perform site-replication on the MinIO servers

func (*AdminClient) SiteReplicationRemove 

func (adm *AdminClient) SiteReplicationRemove(ctx context.Context, removeReq SRRemoveReq) (st ReplicateRemoveStatus, err error)

SiteReplicationRemove - unlinks a site from site replication

func (*AdminClient) SiteReplicationResyncOp 

func (adm *AdminClient) SiteReplicationResyncOp(ctx context.Context, site PeerInfo, op SiteResyncOp) (SRResyncOpStatus, error)

SiteReplicationResyncOp - perform a site replication resync operation

func (*AdminClient) Speedtest 

func (adm *AdminClient) Speedtest(ctx context.Context, opts SpeedtestOpts) (chan SpeedTestResult, error)

Speedtest - perform speedtest on the MinIO servers

func (*AdminClient) StartBatchJob 

func (adm *AdminClient) StartBatchJob(ctx context.Context, job string) (BatchJobResult, error)

StartBatchJob start a new batch job, input job description is in YAML.

func (*AdminClient) StartProfiling 

func (adm *AdminClient) StartProfiling(ctx context.Context, profiler ProfilerType) ([]StartProfilingResult, error)

StartProfiling makes an admin call to remotely start profiling on a standalone server or the whole cluster in case of a distributed setup. NOTE: For simpler use cases use Profile() API.

func (*AdminClient) StatusPool 

func (adm *AdminClient) StatusPool(ctx context.Context, pool string) (PoolStatus, error)

StatusPool return current status about pool, reports any draining activity in progress and elapsed time.

func (*AdminClient) StorageInfo 

func (adm *AdminClient) StorageInfo(ctx context.Context) (StorageInfo, error)

StorageInfo - Connect to a minio server and call Storage Info Management API to fetch server's information represented by StorageInfo structure

func (*AdminClient) SuspendInventoryJob added in v4.2.13 

func (adm *AdminClient) SuspendInventoryJob(ctx context.Context, bucket, inventoryID string) (*InventoryJobControlResponse, error)

SuspendInventoryJob suspends a running inventory job

func (*AdminClient) TemporaryAccountInfo 

func (adm *AdminClient) TemporaryAccountInfo(ctx context.Context, accessKey string) (TemporaryAccountInfoResp, error)

TemporaryAccountInfo - returns the info of a temporary account

func (*AdminClient) TierStats 

func (adm *AdminClient) TierStats(ctx context.Context) ([]TierInfo, error)

TierStats returns per-tier stats of all configured tiers (incl. internal hot-tier)

func (*AdminClient) TopLocks 

func (adm *AdminClient) TopLocks(ctx context.Context) (LockEntries, error)

TopLocks - returns top '10' oldest locks currently active on the server.

func (*AdminClient) TopLocksWithOpts 

func (adm *AdminClient) TopLocksWithOpts(ctx context.Context, opts TopLockOpts) (LockEntries, error)

TopLocksWithOpts - returns the count number of oldest locks currently active on the server. additionally we can also enable `stale` to get stale locks currently present on server.

func (*AdminClient) TraceOff 

func (adm *AdminClient) TraceOff()

TraceOff - disable HTTP tracing.

func (*AdminClient) TraceOn 

func (adm *AdminClient) TraceOn(outputStream io.Writer)

TraceOn - enable HTTP tracing.

func (*AdminClient) UpdateGroupMembers 

func (adm *AdminClient) UpdateGroupMembers(ctx context.Context, g GroupAddRemove) error

UpdateGroupMembers - adds/removes users to/from a group. Server creates the group as needed. Group is removed if remove request is made on empty group.

func (*AdminClient) UpdateRemoteTarget 

func (adm *AdminClient) UpdateRemoteTarget(ctx context.Context, target *BucketTarget, ops ...TargetUpdateType) (string, error)

UpdateRemoteTarget updates credentials for a remote bucket target

func (*AdminClient) UpdateServiceAccount 

func (adm *AdminClient) UpdateServiceAccount(ctx context.Context, accessKey string, opts UpdateServiceAccountReq) error

UpdateServiceAccount - edit an existing service account

func (*AdminClient) VerifyTier 

func (adm *AdminClient) VerifyTier(ctx context.Context, tierName string) error

VerifyTier verifies tierName's remote tier config

type AliveOpts 

type AliveOpts struct {
	Readiness bool // send request to /minio/health/ready
}

AliveOpts customizing liveness check.

type AliveResult 

type AliveResult struct {
	Endpoint       *url.URL      `json:"endpoint"`
	ResponseTime   time.Duration `json:"responseTime"`
	DNSResolveTime time.Duration `json:"dnsResolveTime"`
	Online         bool          `json:"online"` // captures x-minio-server-status
	Error          error         `json:"error"`
}

AliveResult returns the time spent getting a response back from the server on /minio/health/live endpoint

type AnonymousClient 

type AnonymousClient struct {
	// contains filtered or unexported fields
}

AnonymousClient implements an anonymous http client for MinIO

func NewAnonymousClient 

func NewAnonymousClient(endpoint string, secure bool) (*AnonymousClient, error)

NewAnonymousClient can be used for anonymous APIs without credentials set

func NewAnonymousClientNoEndpoint 

func NewAnonymousClientNoEndpoint() (*AnonymousClient, error)

func (*AnonymousClient) Alive 

func (an *AnonymousClient) Alive(ctx context.Context, opts AliveOpts, servers ...ServerProperties) (resultsCh chan AliveResult)

Alive will hit `/minio/health/live` to check if server is reachable, optionally returns the amount of time spent getting a response back from the server.

func (*AnonymousClient) Healthy 

func (an *AnonymousClient) Healthy(ctx context.Context, opts HealthOpts) (result HealthResult, err error)

Healthy will hit `/minio/health/cluster` and `/minio/health/cluster/ready` anonymous APIs to check the cluster health

func (*AnonymousClient) SetCustomTransport 

func (an *AnonymousClient) SetCustomTransport(customHTTPTransport http.RoundTripper)

SetCustomTransport - set new custom transport.

func (*AnonymousClient) TraceOn 

func (an *AnonymousClient) TraceOn(outputStream io.Writer)

TraceOn - enable HTTP tracing.

type Audit 

type Audit map[string]Status

Audit contains audit logger status

func (*Audit) DecodeMsg 

func (z *Audit) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (Audit) EncodeMsg 

func (z Audit) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Audit) MarshalMsg 

func (z Audit) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (Audit) Msgsize 

func (z Audit) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Audit) UnmarshalMsg 

func (z *Audit) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type AuditLogOpts added in v4.2.10 

type AuditLogOpts struct {
	Node     string        `json:"node,omitempty"`
	API      string        `json:"api,omitempty"`
	Bucket   string        `json:"bucket,omitempty"`
	Interval time.Duration `json:"interval,omitempty"`
}

AuditLogOpts represents the options for the audit logs

type AzureOptions 

type AzureOptions func(*TierAzure) error

AzureOptions supports NewTierAzure to take variadic options

type BackendDisks 

type BackendDisks map[string]int

BackendDisks - represents the map of endpoint-disks.

func (*BackendDisks) DecodeMsg 

func (z *BackendDisks) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (BackendDisks) EncodeMsg 

func (z BackendDisks) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (BackendDisks) MarshalMsg 

func (z BackendDisks) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (BackendDisks) Merge 

func (d1 BackendDisks) Merge(d2 BackendDisks) BackendDisks

Merge - Reduces two endpoint-disk maps.

func (BackendDisks) Msgsize 

func (z BackendDisks) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (BackendDisks) Sum 

func (d1 BackendDisks) Sum() (sum int)

Sum - Return the sum of the disks in the endpoint-disk map.

func (*BackendDisks) UnmarshalMsg 

func (z *BackendDisks) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type BackendInfo 

type BackendInfo struct {
	// Represents various backend types, currently on FS, Erasure and Gateway
	Type BackendType

	// Following fields are only meaningful if BackendType is Gateway.
	GatewayOnline bool

	// Following fields are only meaningful if BackendType is Erasure.
	OnlineDisks  BackendDisks // Online disks during server startup.
	OfflineDisks BackendDisks // Offline disks during server startup.

	// Following fields are only meaningful if BackendType is Erasure.
	StandardSCData     []int // Data disks for currently configured Standard storage class.
	StandardSCParities []int // Parity disks per pool for currently configured Standard storage class
	RRSCData           []int // Data disks for currently configured Reduced Redundancy storage class.
	RRSCParities       []int // Parity disks per pool for currently configured Reduced Redundancy storage class.

	// Adds number of erasure sets and drives per set.
	TotalSets    []int // Each index value corresponds to per pool
	DrivesPerSet []int // Each index value corresponds to per pool
}

BackendInfo - contains info of the underlying backend

func (*BackendInfo) DecodeMsg 

func (z *BackendInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*BackendInfo) EncodeMsg 

func (z *BackendInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*BackendInfo) MarshalMsg 

func (z *BackendInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*BackendInfo) Msgsize 

func (z *BackendInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*BackendInfo) UnmarshalMsg 

func (z *BackendInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type BackendType 

type BackendType int

BackendType - represents different backend types. 

const (
	Unknown BackendType = iota
	// Filesystem backend.
	FS
	// Multi disk Erasure (single, distributed) backend.
	Erasure
	// Gateway to other storage
	Gateway
)

Enum for different backend types.

func (*BackendType) DecodeMsg 

func (z *BackendType) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (BackendType) EncodeMsg 

func (z BackendType) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (BackendType) MarshalMsg 

func (z BackendType) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (BackendType) Msgsize 

func (z BackendType) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*BackendType) UnmarshalMsg 

func (z *BackendType) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type BandwidthDetails 

type BandwidthDetails struct {
	LimitInBytesPerSecond            int64   `json:"limitInBits"`
	CurrentBandwidthInBytesPerSecond float64 `json:"currentBandwidth"`
}

BandwidthDetails for the measured bandwidth

type BatchJobMetrics 

type BatchJobMetrics struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	// Jobs by ID.
	Jobs map[string]JobMetric
}

BatchJobMetrics contains metrics for batch operations

func (*BatchJobMetrics) DecodeMsg 

func (z *BatchJobMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*BatchJobMetrics) EncodeMsg 

func (z *BatchJobMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*BatchJobMetrics) MarshalMsg 

func (z *BatchJobMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*BatchJobMetrics) Merge 

func (o *BatchJobMetrics) Merge(other *BatchJobMetrics)

Merge other into 'o'.

func (*BatchJobMetrics) Msgsize 

func (z *BatchJobMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*BatchJobMetrics) UnmarshalMsg 

func (z *BatchJobMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type BatchJobResult 

type BatchJobResult struct {
	ID      string             `json:"id"`
	Type    BatchJobType       `json:"type"`
	User    string             `json:"user,omitempty"`
	Started time.Time          `json:"started"`
	Elapsed time.Duration      `json:"elapsed,omitempty"`
	Status  BatchJobStatusType `json:"status,omitempty"`
	Error   string             `json:"error,omitempty"`
}

BatchJobResult returned by StartBatchJob

type BatchJobStatus 

type BatchJobStatus struct {
	LastMetric JobMetric
}

BatchJobStatus contains the last batch job metric

type BatchJobStatusType added in v4.0.16 

type BatchJobStatusType string

BatchJobStatusType describes batch job statuses 

const (
	BatchJobStatusCompleted  BatchJobStatusType = "completed"
	BatchJobStatusFailed     BatchJobStatusType = "failed"
	BatchJobStatusInProgress BatchJobStatusType = "in-progress"
	BatchJobStatusUnknown    BatchJobStatusType = "unknown"
)

type BatchJobType 

type BatchJobType string

BatchJobType describes batch jobs 

const (
	BatchJobReplicate BatchJobType = "replicate"
	BatchJobKeyRotate BatchJobType = "keyrotate"
	BatchJobExpire    BatchJobType = "expire"
	BatchJobCatalog   BatchJobType = "catalog"
)

type BgHealState 

type BgHealState struct {
	// List of offline endpoints with no background heal state info
	OfflineEndpoints []string `json:"offline_nodes"`
	// Total items scanned by the continuous background healing
	ScannedItemsCount int64
	// Disks currently in heal states
	HealDisks []string
	// SetStatus contains information for each set.
	Sets []SetStatus `json:"sets"`
	// Endpoint -> MRF Status
	MRF map[string]MRFStatus `json:"mrf"`
	// Parity per storage class
	SCParity map[string]int `json:"sc_parity"`
}

BgHealState represents the status of the background heal

func (*BgHealState) DecodeMsg 

func (z *BgHealState) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*BgHealState) EncodeMsg 

func (z *BgHealState) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*BgHealState) MarshalMsg 

func (z *BgHealState) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*BgHealState) Merge 

func (b *BgHealState) Merge(others ...BgHealState)

Merge others into b.

func (*BgHealState) Msgsize 

func (z *BgHealState) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*BgHealState) UnmarshalMsg 

func (z *BgHealState) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type BktOp 

type BktOp string

BktOp represents the bucket operation being requested. 

const (
	// make bucket and enable versioning
	MakeWithVersioningBktOp BktOp = "make-with-versioning"
	// add replication configuration
	ConfigureReplBktOp BktOp = "configure-replication"
	// delete bucket (forceDelete = off)
	DeleteBucketBktOp BktOp = "delete-bucket"
	// delete bucket (forceDelete = on)
	ForceDeleteBucketBktOp BktOp = "force-delete-bucket"
	// purge bucket
	PurgeDeletedBucketOp BktOp = "purge-deleted-bucket"
)

BktOp value constants.

type BucketAccessInfo 

type BucketAccessInfo struct {
	Name                    string            `json:"name"`
	Size                    uint64            `json:"size"`
	Objects                 uint64            `json:"objects"`
	ObjectSizesHistogram    map[string]uint64 `json:"objectHistogram"`
	ObjectVersionsHistogram map[string]uint64 `json:"objectsVersionsHistogram"`
	Details                 *BucketDetails    `json:"details"`
	PrefixUsage             map[string]uint64 `json:"prefixUsage"`
	Created                 time.Time         `json:"created"`
	Access                  AccountAccess     `json:"access"`
}

BucketAccessInfo represents bucket usage of a bucket, and its relevant access type for an account

type BucketBandwidth 

type BucketBandwidth struct {
	Limit     uint64    `json:"bandwidthLimitPerBucket"`
	IsSet     bool      `json:"set"`
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
}

BucketBandwidth has default bandwidth limit per bucket in bytes/sec

type BucketBandwidthReport 

type BucketBandwidthReport struct {
	BucketStats map[string]BandwidthDetails `json:"bucketStats,omitempty"`
}

BucketBandwidthReport captures the details for all buckets.

type BucketDetails 

type BucketDetails struct {
	Versioning          bool         `json:"versioning"`
	VersioningSuspended bool         `json:"versioningSuspended"`
	Locking             bool         `json:"locking"`
	Replication         bool         `json:"replication"`
	Tagging             *tags.Tags   `json:"tags"`
	Quota               *BucketQuota `json:"quota"`
}

BucketDetails provides information about features currently turned-on per bucket.

type BucketMetaImportErrs 

type BucketMetaImportErrs struct {
	Buckets map[string]BucketStatus `json:"buckets,omitempty"`
}

BucketMetaImportErrs reports on bucket metadata import status.

type BucketQuota 

type BucketQuota struct {
	Size     uint64    `json:"size"`     // Indicates maximum size allowed per bucket
	Rate     uint64    `json:"rate"`     // Indicates bandwidth rate allocated per bucket
	Requests uint64    `json:"requests"` // Indicates number of requests allocated per bucket
	Type     QuotaType `json:"quotatype,omitempty"`
}

BucketQuota holds bucket quota restrictions

type BucketQuotaDiag added in v4.2.10 

type BucketQuotaDiag struct {
	Buckets []BucketQuotaDiagInfo `json:"buckets,omitempty"`
	Error   string                `json:"error,omitempty"`
}

BucketQuotaDiag holds quota diagnostics for all buckets with quota.

type BucketQuotaDiagInfo added in v4.2.10 

type BucketQuotaDiagInfo struct {
	Bucket string `json:"bucket"`
	Quota  int64  `json:"quota"` // Quota in bytes
	Usage  int64  `json:"usage"` // Usage in bytes
}

BucketQuotaDiagInfo represents usage and quota info for a single bucket.

type BucketReplTarget 

type BucketReplTarget struct {
	SourceBucket    string        `json:"source_bucket,omitempty"`
	TargetBucket    string        `json:"target_bucket,omitempty"`
	Addr            string        `json:"addr,omitempty"`
	Online          bool          `json:"online"`
	TotalDowntime   time.Duration `json:"total_downtime,omitempty"`
	CurrentDowntime time.Duration `json:"current_downtime,omitempty"`
}

type BucketScanInfo 

type BucketScanInfo struct {
	Pool        int         `msg:"pool"`
	Set         int         `msg:"set"`
	Cycle       uint64      `msg:"cycle"`
	Ongoing     bool        `msg:"ongoing"`
	LastUpdate  time.Time   `msg:"last_update"`
	LastStarted time.Time   `msg:"last_started"`
	LastError   string      `msg:"last_error"`
	Completed   []time.Time `msg:"completed,omitempty"`
}

BucketScanInfo contains information of a bucket scan in a given pool/set

func (*BucketScanInfo) DecodeMsg 

func (z *BucketScanInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*BucketScanInfo) EncodeMsg 

func (z *BucketScanInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*BucketScanInfo) MarshalMsg 

func (z *BucketScanInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*BucketScanInfo) Msgsize 

func (z *BucketScanInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*BucketScanInfo) UnmarshalMsg 

func (z *BucketScanInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type BucketStatus 

type BucketStatus struct {
	ObjectLock   MetaStatus `json:"olock"`
	Versioning   MetaStatus `json:"versioning"`
	Policy       MetaStatus `json:"policy"`
	Tagging      MetaStatus `json:"tagging"`
	SSEConfig    MetaStatus `json:"sse"`
	Lifecycle    MetaStatus `json:"lifecycle"`
	Notification MetaStatus `json:"notification"`
	Quota        MetaStatus `json:"quota"`
	Cors         MetaStatus `json:"cors"`
	Err          string     `json:"error,omitempty"`
}

BucketStatus reflects status of bucket metadata import

type BucketTarget 

type BucketTarget struct {
	SourceBucket         string        `json:"sourcebucket"`
	Endpoint             string        `json:"endpoint"`
	Credentials          *Credentials  `json:"credentials"`
	TargetBucket         string        `json:"targetbucket"`
	Secure               bool          `json:"secure"`
	Path                 string        `json:"path,omitempty"`
	API                  string        `json:"api,omitempty"`
	Arn                  string        `json:"arn,omitempty"`
	Type                 ServiceType   `json:"type"`
	Region               string        `json:"region,omitempty"`
	BandwidthLimit       int64         `json:"bandwidthlimit,omitempty"`
	ReplicationSync      bool          `json:"replicationSync"`
	StorageClass         string        `json:"storageclass,omitempty"`
	HealthCheckDuration  time.Duration `json:"healthCheckDuration,omitempty"`
	DisableProxy         bool          `json:"disableProxy"`
	ResetBeforeDate      time.Time     `json:"resetBeforeDate,omitempty"`
	ResetID              string        `json:"resetID,omitempty"`
	TotalDowntime        time.Duration `json:"totalDowntime"`
	LastOnline           time.Time     `json:"lastOnline"`
	Online               bool          `json:"isOnline"`
	Latency              LatencyStat   `json:"latency"`
	DeploymentID         string        `json:"deploymentID,omitempty"`
	Edge                 bool          `json:"edge"`                 // target is recipient of edge traffic
	EdgeSyncBeforeExpiry bool          `json:"edgeSyncBeforeExpiry"` // must replicate to edge before expiry
	OfflineCount         int64         `json:"offlineCount"`
	InsecureTLS          bool          `json:"insecureTLS"`
}

BucketTarget represents the target bucket and site association.

func (*BucketTarget) Clone 

func (t *BucketTarget) Clone() BucketTarget

Clone returns shallow clone of BucketTarget without secret key in credentials

func (*BucketTarget) DecodeMsg 

func (z *BucketTarget) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (BucketTarget) Empty 

func (t BucketTarget) Empty() bool

Empty returns true if struct is empty.

func (*BucketTarget) EncodeMsg 

func (z *BucketTarget) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*BucketTarget) MarshalMsg 

func (z *BucketTarget) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*BucketTarget) Msgsize 

func (z *BucketTarget) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*BucketTarget) String 

func (t *BucketTarget) String() string

func (BucketTarget) URL 

func (t BucketTarget) URL() *url.URL

URL returns target url

func (*BucketTarget) UnmarshalMsg 

func (z *BucketTarget) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type BucketTargets 

type BucketTargets struct {
	Targets []BucketTarget `json:"targets"`
}

BucketTargets represents a slice of bucket targets by type and endpoint

func (*BucketTargets) DecodeMsg 

func (z *BucketTargets) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (BucketTargets) Empty 

func (t BucketTargets) Empty() bool

Empty returns true if struct is empty.

func (*BucketTargets) EncodeMsg 

func (z *BucketTargets) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*BucketTargets) MarshalMsg 

func (z *BucketTargets) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*BucketTargets) Msgsize 

func (z *BucketTargets) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*BucketTargets) UnmarshalMsg 

func (z *BucketTargets) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type BucketUsageInfo 

type BucketUsageInfo struct {
	Size                    uint64 `json:"size"`
	ReplicationPendingSize  uint64 `json:"objectsPendingReplicationTotalSize"`
	ReplicationFailedSize   uint64 `json:"objectsFailedReplicationTotalSize"`
	ReplicatedSize          uint64 `json:"objectsReplicatedTotalSize"`
	ReplicaSize             uint64 `json:"objectReplicaTotalSize"`
	ReplicationPendingCount uint64 `json:"objectsPendingReplicationCount"`
	ReplicationFailedCount  uint64 `json:"objectsFailedReplicationCount"`

	VersionsCount           uint64            `json:"versionsCount"`
	ObjectsCount            uint64            `json:"objectsCount"`
	DeleteMarkersCount      uint64            `json:"deleteMarkersCount"`
	ObjectSizesHistogram    map[string]uint64 `json:"objectsSizesHistogram"`
	ObjectVersionsHistogram map[string]uint64 `json:"objectsVersionsHistogram"`
}

BucketUsageInfo - bucket usage info provides - total size of the bucket - total objects in a bucket - object size histogram per bucket

func (*BucketUsageInfo) DecodeMsg 

func (z *BucketUsageInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*BucketUsageInfo) EncodeMsg 

func (z *BucketUsageInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*BucketUsageInfo) MarshalMsg 

func (z *BucketUsageInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*BucketUsageInfo) Msgsize 

func (z *BucketUsageInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*BucketUsageInfo) UnmarshalMsg 

func (z *BucketUsageInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Buckets 

type Buckets struct {
	Count uint64 `json:"count"`
	Error string `json:"error,omitempty"`
}

Buckets contains the number of buckets

func (*Buckets) DecodeMsg 

func (z *Buckets) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (Buckets) EncodeMsg 

func (z Buckets) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Buckets) MarshalMsg 

func (z Buckets) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (Buckets) Msgsize 

func (z Buckets) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Buckets) UnmarshalMsg 

func (z *Buckets) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type CPU 

type CPU struct {
	VendorID   string   `json:"vendor_id"`
	Family     string   `json:"family"`
	Model      string   `json:"model"`
	Stepping   int32    `json:"stepping"`
	PhysicalID string   `json:"physical_id"`
	ModelName  string   `json:"model_name"`
	Mhz        float64  `json:"mhz"`
	CacheSize  int32    `json:"cache_size"`
	Flags      []string `json:"flags"`
	Microcode  string   `json:"microcode"`
	Cores      int      `json:"cores"` // computed
}

CPU contains system's CPU information.

type CPUFreqStats 

type CPUFreqStats struct {
	Name     string `json:",omitempty"`
	Governor string `json:",omitempty"`

	// All these fields are not set, kept here for future purposes.
	CpuinfoCurrentFrequency  *uint64 `json:",omitempty"`
	CpuinfoMinimumFrequency  *uint64 `json:",omitempty"`
	CpuinfoMaximumFrequency  *uint64 `json:",omitempty"`
	CpuinfoTransitionLatency *uint64 `json:",omitempty"`
	ScalingCurrentFrequency  *uint64 `json:",omitempty"`
	ScalingMinimumFrequency  *uint64 `json:",omitempty"`
	ScalingMaximumFrequency  *uint64 `json:",omitempty"`
	AvailableGovernors       string  `json:",omitempty"`
	Driver                   string  `json:",omitempty"`
	RelatedCpus              string  `json:",omitempty"`
	SetSpeed                 string  `json:",omitempty"`
}

CPUFreqStats CPU frequency stats

type CPUMetrics 

type CPUMetrics struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	TimesStat *cpu.TimesStat `json:"timesStat"`
	LoadStat  *load.AvgStat  `json:"loadStat"`
	CPUCount  int            `json:"cpuCount"`
}

func (*CPUMetrics) DecodeMsg 

func (z *CPUMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*CPUMetrics) EncodeMsg 

func (z *CPUMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*CPUMetrics) MarshalMsg 

func (z *CPUMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*CPUMetrics) Merge 

func (m *CPUMetrics) Merge(other *CPUMetrics)

Merge other into 'm'.

func (*CPUMetrics) Msgsize 

func (z *CPUMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*CPUMetrics) UnmarshalMsg 

func (z *CPUMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type CPUs 

type CPUs struct {
	NodeCommon

	CPUs         []CPU          `json:"cpus,omitempty"`
	CPUFreqStats []CPUFreqStats `json:"freq_stats,omitempty"`
}

CPUs contains all CPU information of a node.

func GetCPUs 

func GetCPUs(ctx context.Context, addr string) CPUs

GetCPUs returns system's all CPU information.

type CacheStats 

type CacheStats struct {
	N          int   `json:"n"`
	Capacity   int64 `json:"cap"`
	Used       int64 `json:"used"`
	Hits       int64 `json:"hits"`
	Misses     int64 `json:"misses"`
	DelHits    int64 `json:"delHits"`
	DelMisses  int64 `json:"delMisses"`
	Collisions int64 `json:"collisions"`
}

CacheStats drive cache stats

func (*CacheStats) DecodeMsg 

func (z *CacheStats) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*CacheStats) EncodeMsg 

func (z *CacheStats) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*CacheStats) MarshalMsg 

func (z *CacheStats) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*CacheStats) Merge added in v4.2.10 

func (c *CacheStats) Merge(other *CacheStats)

Merge other into 'c'.

func (*CacheStats) Msgsize 

func (z *CacheStats) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*CacheStats) UnmarshalMsg 

func (z *CacheStats) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type CatalogDataFile 

type CatalogDataFile struct {
	Key         string `json:"key"`
	Size        uint64 `json:"size"`
	MD5Checksum string `json:"MD5Checksum"`
}

CatalogDataFile contains information about an output file from a catalog job run.

func (*CatalogDataFile) DecodeMsg added in v4.0.20 

func (z *CatalogDataFile) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (CatalogDataFile) EncodeMsg added in v4.0.20 

func (z CatalogDataFile) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (CatalogDataFile) MarshalMsg added in v4.0.20 

func (z CatalogDataFile) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (CatalogDataFile) Msgsize added in v4.0.20 

func (z CatalogDataFile) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*CatalogDataFile) UnmarshalMsg added in v4.0.20 

func (z *CatalogDataFile) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type CatalogInfo 

type CatalogInfo struct {
	Bucket            string `json:"bucket"`
	LastBucketScanned string `json:"lastBucketScanned,omitempty"` // Deprecated 07/01/2025; Replaced by `bucket`
	LastObjectScanned string `json:"lastObjectScanned"`
	LastBucketMatched string `json:"lastBucketMatched,omitempty"` // Deprecated 07/01/2025; Replaced by `bucket`
	LastObjectMatched string `json:"lastObjectMatched"`

	ObjectsScannedCount uint64 `json:"objectsScannedCount"`
	ObjectsMatchedCount uint64 `json:"objectsMatchedCount"`

	// Represents the number of objects' metadata that were written to output
	// objects.
	RecordsWrittenCount uint64 `json:"recordsWrittenCount"`
	// Represents the number of output objects created.
	OutputObjectsCount uint64 `json:"outputObjectsCount"`
	// Manifest file path (part of the output of a catalog job)
	ManifestPathBucket string `json:"manifestPathBucket"`
	ManifestPathObject string `json:"manifestPathObject"`

	// Error message
	ErrorMsg string `json:"errorMsg"`

	// Used to resume catalog jobs
	LastObjectWritten string            `json:"lastObjectWritten,omitempty"`
	OutputFiles       []CatalogDataFile `json:"outputFiles,omitempty"`
}

func (*CatalogInfo) DecodeMsg 

func (z *CatalogInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*CatalogInfo) EncodeMsg 

func (z *CatalogInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*CatalogInfo) MarshalMsg 

func (z *CatalogInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*CatalogInfo) Msgsize 

func (z *CatalogInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*CatalogInfo) UnmarshalMsg 

func (z *CatalogInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type CatalogManifest 

type CatalogManifest struct {
	SourceBucket      string                 `json:"sourceBucket"`
	DestinationBucket string                 `json:"destinationBucket"`
	Version           CatalogManifestVersion `json:"version"`
	CreationTimestamp string                 `json:"creationTimestamp"`
	FileFormat        string                 `json:"fileFormat"`
	FileSchema        string                 `json:"fileSchema"`
	Files             []CatalogDataFile      `json:"files"`
}

CatalogManifest represents the manifest of a catalog job's result.

func (*CatalogManifest) DecodeMsg added in v4.0.20 

func (z *CatalogManifest) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*CatalogManifest) EncodeMsg added in v4.0.20 

func (z *CatalogManifest) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*CatalogManifest) MarshalMsg added in v4.0.20 

func (z *CatalogManifest) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*CatalogManifest) Msgsize added in v4.0.20 

func (z *CatalogManifest) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*CatalogManifest) UnmarshalMsg added in v4.0.20 

func (z *CatalogManifest) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type CatalogManifestVersion 

type CatalogManifestVersion string

CatalogManifestVersion represents the version of a catalog manifest. 

const (
	// We use AWS S3's manifest file version here as we are following the same
	// format at least initially.
	CatalogManifestVersion1 CatalogManifestVersion = "2016-11-30"
)

Valid values for CatalogManifestVersion.

func (*CatalogManifestVersion) DecodeMsg added in v4.0.20 

func (z *CatalogManifestVersion) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (CatalogManifestVersion) EncodeMsg added in v4.0.20 

func (z CatalogManifestVersion) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (CatalogManifestVersion) MarshalMsg added in v4.0.20 

func (z CatalogManifestVersion) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (CatalogManifestVersion) Msgsize added in v4.0.20 

func (z CatalogManifestVersion) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*CatalogManifestVersion) UnmarshalMsg added in v4.0.20 

func (z *CatalogManifestVersion) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type CheckIDPConfigResp added in v4.0.15 

type CheckIDPConfigResp struct {
	ErrType string `json:"errType"`
	ErrMsg  string `json:"errMsg"`
}

type ClientPerfExtraTime 

type ClientPerfExtraTime struct {
	TimeSpent int64 `json:"dur,omitempty"`
}

ClientPerfExtraTime - time for get lock or other

type ClientPerfResult 

type ClientPerfResult struct {
	Endpoint  string `json:"endpoint,omitempty"`
	Error     string `json:"error,omitempty"`
	BytesSend uint64
	TimeSpent int64
}

ClientPerfResult - stats from client to server

type ClusterAPIStats added in v4.2.9 

type ClusterAPIStats struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	// Nodes responded to the request.
	Nodes int `json:"nodes"`

	// Errors will contain any errors encountered while collecting the metrics.
	Errors []string `json:"errors,omitempty"`

	// Number of active requests.
	ActiveRequests int64 `json:"activeRequests,omitempty"`

	// Number of queued requests.
	QueuedRequests int64 `json:"queuedRequests,omitempty"`

	// lastMinute is the combined stats for the last minute.
	LastMinute APIStats `json:"lastMinute"`

	// LastDay is the combined stats for the last day.
	LastDay APIStats `json:"lastDay"`

	// LastDaySegmented are the stats for the last day, accumulated in time segments.
	LastDaySegmented SegmentedAPIMetrics `json:"lastDaySegmented"`
}

ClusterAPIStats is a simplified version of madmin.APIStats that is used to report cluster-wide API metrics.

type ClusterInfo 

type ClusterInfo struct {
	Version      string `msg:"version"`
	DeploymentID string `msg:"deploymentID"`
	SiteName     string `msg:"siteName"`
	SiteRegion   string `msg:"siteRegion"`
	License      struct {
		Organization string `msg:"org"`
		Type         string `msg:"type"`
		Expiry       string `msg:"expiry"`
	} `msg:"license"`
	Platform string     `msg:"platform"`
	Domain   []string   `msg:"domain"`
	Pools    []PoolInfo `msg:"pools"`
	Metrics  struct {
		Buckets       uint64 `msg:"buckets"`
		Objects       uint64 `msg:"objects"`
		Versions      uint64 `msg:"versions"`
		DeleteMarkers uint64 `msg:"deleteMarkers"`
		Usage         uint64 `msg:"usage"`
	} `msg:"metrics"`
}

ClusterInfo cluster level information

func (*ClusterInfo) DecodeMsg 

func (z *ClusterInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ClusterInfo) EncodeMsg 

func (z *ClusterInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ClusterInfo) MarshalMsg 

func (z *ClusterInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ClusterInfo) Msgsize 

func (z *ClusterInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ClusterInfo) UnmarshalMsg 

func (z *ClusterInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ClusterInfoOpts 

type ClusterInfoOpts struct{}

ClusterInfoOpts ask for additional data from the server this is not used at the moment, kept here for future extensibility.

type ClusterRegistrationInfo 

type ClusterRegistrationInfo struct {
	DeploymentID string `json:"deployment_id"`
	LicenseID    string `json:"license_id,omitempty"`
	ClusterName  string `json:"cluster_name"`
	UsedCapacity uint64 `json:"used_capacity"`
	// The "info" sub-node of the cluster registration information struct
	// Intended to be extensible i.e. more fields will be added as and when required
	Info struct {
		MinioVersion    string `json:"minio_version"`
		NoOfServerPools int    `json:"no_of_server_pools"`
		NoOfServers     int    `json:"no_of_servers"`
		NoOfDrives      int    `json:"no_of_drives"`
		NoOfBuckets     uint64 `json:"no_of_buckets"`
		NoOfObjects     uint64 `json:"no_of_objects"`
		TotalDriveSpace uint64 `json:"total_drive_space"`
		UsedDriveSpace  uint64 `json:"used_drive_space"`
		Edition         string `json:"edition"`
	} `json:"info"`
}

ClusterRegistrationInfo - Information stored in the cluster registration token

type ClusterRegistrationReq 

type ClusterRegistrationReq struct {
	Token string `json:"token"`
}

ClusterRegistrationReq - JSON payload of the subnet api for cluster registration Contains a registration token created by base64 encoding of the registration info

type ClusterResource added in v4.1.0 

type ClusterResource struct {
	Mode              string       `json:"mode" msg:"m"`
	Domains           []string     `json:"domains,omitempty" msg:"d,omitempty"`
	Region            string       `json:"region,omitempty" msg:"r,omitempty"`
	DeploymentID      string       `json:"deploymentId" msg:"di"`
	PoolCount         int          `json:"poolCount" msg:"pc"`
	PoolsLayout       []PoolLayout `json:"poolsLayout,omitempty" msg:"pl,omitempty"`
	NodeCount         int          `json:"nodeCount" msg:"nc"`
	DriveCount        int          `json:"driveCount" msg:"dc"`
	SetCount          int          `json:"setCount" msg:"sc"`
	BucketCount       int          `json:"bucketCount" msg:"bc"`
	ObjectCount       int          `json:"objectCount" msg:"oc"`
	VersionCount      int          `json:"versionCount" msg:"vc"`
	DeleteMarkerCount int          `json:"deleteMarkerCount" msg:"dmc"`
	TotalSize         uint64       `json:"totalSize" msg:"ts"`
	OnlineDrives      int          `json:"onlineDrives" msg:"od"`
	OfflineDrives     int          `json:"offlineDrives" msg:"fd"`
}

ClusterResource represents high-level information about the cluster

func (*ClusterResource) DecodeMsg added in v4.1.0 

func (z *ClusterResource) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ClusterResource) EncodeMsg added in v4.1.0 

func (z *ClusterResource) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ClusterResource) MarshalMsg added in v4.1.0 

func (z *ClusterResource) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ClusterResource) Msgsize added in v4.1.0 

func (z *ClusterResource) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ClusterResource) UnmarshalMsg added in v4.1.0 

func (z *ClusterResource) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ClusterResourceOpts added in v4.1.0 

type ClusterResourceOpts struct{}

ClusterResourceOpts ask for additional data from the server this is not used at the moment, kept here for future extensibility.

type ConfigHistoryEntry 

type ConfigHistoryEntry struct {
	RestoreID  string    `json:"restoreId"`
	CreateTime time.Time `json:"createTime"`
	Data       string    `json:"data"`
}

ConfigHistoryEntry - captures config set history with a unique restore ID and createTime

func (ConfigHistoryEntry) CreateTimeFormatted 

func (ch ConfigHistoryEntry) CreateTimeFormatted() string

CreateTimeFormatted is used to print formatted time for CreateTime.

type ConfigKV 

type ConfigKV struct {
	Key         string       `json:"key"`
	Value       string       `json:"value"`
	EnvOverride *EnvOverride `json:"envOverride,omitempty"`
}

ConfigKV represents a configuration key and value, along with any environment override if present.

type CountWithList added in v4.0.18 

type CountWithList struct {
	Count int          `json:"count"`
	List  []EntityDiag `json:"list,omitempty"`
}

CountWithList is a type that holds a count and a list of items

type Counter 

type Counter struct {
	// Counted last 1hr
	Last1hr uint64 `json:"last1hr"`
	// Counted last 1m
	Last1m uint64 `json:"last1m"`
	// Total count
	Total uint64 `json:"total"`
}

Counter denotes the counts

type Credentials 

type Credentials struct {
	AccessKey    string    `xml:"AccessKeyId" json:"accessKey,omitempty"`
	SecretKey    string    `xml:"SecretAccessKey" json:"secretKey,omitempty"`
	SessionToken string    `xml:"SessionToken" json:"sessionToken,omitempty"`
	Expiration   time.Time `xml:"Expiration" json:"expiration,omitempty"`
}

Credentials holds access and secret keys.

func (*Credentials) DecodeMsg 

func (z *Credentials) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*Credentials) EncodeMsg 

func (z *Credentials) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*Credentials) MarshalMsg 

func (z *Credentials) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*Credentials) Msgsize 

func (z *Credentials) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Credentials) UnmarshalMsg 

func (z *Credentials) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DailyTierStats 

type DailyTierStats struct {
	Bins      [24]TierStats
	UpdatedAt time.Time
}

type DataUsageInfo 

type DataUsageInfo struct {
	// LastUpdate is the timestamp of when the data usage info was last updated.
	// This does not indicate a full scan.
	LastUpdate time.Time `json:"lastUpdate"`

	// Objects total count across all buckets
	ObjectsTotalCount uint64 `json:"objectsCount"`

	// Objects total size across all buckets
	ObjectsTotalSize uint64 `json:"objectsTotalSize"`

	// Total Size for objects that have not yet been replicated
	ReplicationPendingSize uint64 `json:"objectsPendingReplicationTotalSize"`

	// Total size for objects that have witness one or more failures and will be retried
	ReplicationFailedSize uint64 `json:"objectsFailedReplicationTotalSize"`

	// Total size for objects that have been replicated to destination
	ReplicatedSize uint64 `json:"objectsReplicatedTotalSize"`

	// Total size for objects that are replicas
	ReplicaSize uint64 `json:"objectsReplicaTotalSize"`

	// Total number of objects pending replication
	ReplicationPendingCount uint64 `json:"objectsPendingReplicationCount"`

	// Total number of objects that failed replication
	ReplicationFailedCount uint64 `json:"objectsFailedReplicationCount"`

	// Total number of buckets in this cluster
	BucketsCount uint64 `json:"bucketsCount"`

	// Buckets usage info provides following information across all buckets
	// - total size of the bucket
	// - total objects in a bucket
	// - object size histogram per bucket
	BucketsUsage map[string]BucketUsageInfo `json:"bucketsUsageInfo"`

	// TierStats holds per-tier stats like bytes tiered, etc.
	TierStats map[string]TierStats `json:"tierStats"`

	// Server capacity related data
	TotalCapacity     uint64 `json:"capacity"`
	TotalFreeCapacity uint64 `json:"freeCapacity"`
	TotalUsedCapacity uint64 `json:"usedCapacity"`
}

DataUsageInfo represents data usage stats of the underlying Object API

func (*DataUsageInfo) DecodeMsg 

func (z *DataUsageInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DataUsageInfo) EncodeMsg 

func (z *DataUsageInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*DataUsageInfo) MarshalMsg 

func (z *DataUsageInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DataUsageInfo) Msgsize 

func (z *DataUsageInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DataUsageInfo) UnmarshalMsg 

func (z *DataUsageInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DeleteMarkers 

type DeleteMarkers struct {
	Count uint64 `json:"count"`
	Error string `json:"error,omitempty"`
}

DeleteMarkers contains the number of delete markers

func (*DeleteMarkers) DecodeMsg 

func (z *DeleteMarkers) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (DeleteMarkers) EncodeMsg 

func (z DeleteMarkers) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (DeleteMarkers) MarshalMsg 

func (z DeleteMarkers) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (DeleteMarkers) Msgsize 

func (z DeleteMarkers) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DeleteMarkers) UnmarshalMsg 

func (z *DeleteMarkers) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DiffInfo 

type DiffInfo struct {
	Object                  string                 `json:"object"`
	VersionID               string                 `json:"versionId"`
	Targets                 map[string]TgtDiffInfo `json:"targets,omitempty"`
	Err                     error                  `json:"error,omitempty"`
	ReplicationStatus       string                 `json:"rStatus,omitempty"` // overall replication status
	DeleteReplicationStatus string                 `json:"dStatus,omitempty"` // overall replication status of version delete
	ReplicationTimestamp    time.Time              `json:"replTimestamp,omitempty"`
	LastModified            time.Time              `json:"lastModified,omitempty"`
	IsDeleteMarker          bool                   `json:"deletemarker"`
}

type Disk 

type Disk struct {
	Endpoint        string       `json:"endpoint,omitempty"`
	RootDisk        bool         `json:"rootDisk,omitempty"`
	DrivePath       string       `json:"path,omitempty"`
	Healing         bool         `json:"healing,omitempty"`
	HealingQueued   bool         `json:"healing_queued,omitempty"`
	Scanning        bool         `json:"scanning,omitempty"`
	State           string       `json:"state,omitempty"`
	UUID            string       `json:"uuid,omitempty"`
	Major           uint32       `json:"major"`
	Minor           uint32       `json:"minor"`
	Model           string       `json:"model,omitempty"`
	TotalSpace      uint64       `json:"totalspace,omitempty"`
	UsedSpace       uint64       `json:"usedspace,omitempty"`
	AvailableSpace  uint64       `json:"availspace,omitempty"`
	ReadThroughput  float64      `json:"readthroughput,omitempty"`
	WriteThroughPut float64      `json:"writethroughput,omitempty"`
	ReadLatency     float64      `json:"readlatency,omitempty"`
	WriteLatency    float64      `json:"writelatency,omitempty"`
	Utilization     float64      `json:"utilization,omitempty"`
	Metrics         *DiskStatus  `json:"metrics,omitempty"`
	HealInfo        *HealingDisk `json:"heal_info,omitempty"`
	OfflineInfo     *OfflineInfo `json:"offline_info,omitempty"`
	UsedInodes      uint64       `json:"used_inodes"`
	FreeInodes      uint64       `json:"free_inodes,omitempty"`
	Local           bool         `json:"local,omitempty"`
	Cache           *CacheStats  `json:"cacheStats,omitempty"`

	// Indexes, will be -1 until assigned a set.
	PoolIndex int `json:"pool_index"`
	SetIndex  int `json:"set_index"`
	DiskIndex int `json:"disk_index"`
}

Disk holds Disk information

func (*Disk) DecodeMsg 

func (z *Disk) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*Disk) EncodeMsg 

func (z *Disk) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*Disk) MarshalMsg 

func (z *Disk) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*Disk) Msgsize 

func (z *Disk) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Disk) UnmarshalMsg 

func (z *Disk) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DiskAction added in v4.2.10 

type DiskAction struct {
	// Number of actions performed.
	Count uint64 `json:"n,omitempty"`

	// Accumulated time spent on the action in seconds.
	AccTime float64 `json:"time_s,omitempty"`

	// Min and max time spent on the action in seconds.
	MinTime float64 `json:"min_s,omitempty"`
	MaxTime float64 `json:"max_s,omitempty"`

	// Total number of bytes read or written.
	Bytes uint64 `json:"b,omitempty"`

	// Captures all data availability errors such as
	// permission denied, faulty disk and timeout errors.
	AvailabilityErrs uint64 `json:"errs_avail,omitempty"`

	// Captures all timeouts, if set on individual operations.
	Timeouts uint64 `json:"timeouts,omitempty"`
}

DiskAction contains a number of actions and their accumulated duration in nanoseconds.

func (*DiskAction) Add added in v4.2.10 

func (t *DiskAction) Add(other *DiskAction)

Add other to t.

func (DiskAction) Avg added in v4.2.10 

func (t DiskAction) Avg() time.Duration

Avg returns the average time spent on the action.

func (DiskAction) AvgBytes added in v4.2.10 

func (t DiskAction) AvgBytes() uint64

AvgBytes returns the average time spent on the action.

func (*DiskAction) DecodeMsg added in v4.2.10 

func (z *DiskAction) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DiskAction) EncodeMsg added in v4.2.10 

func (z *DiskAction) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*DiskAction) MarshalMsg added in v4.2.10 

func (z *DiskAction) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DiskAction) Msgsize added in v4.2.10 

func (z *DiskAction) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DiskAction) UnmarshalMsg added in v4.2.10 

func (z *DiskAction) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DiskIOStats 

type DiskIOStats struct {
	N              int    `json:"n,omitempty"`
	ReadIOs        uint64 `json:"read_ios,omitempty"`
	ReadMerges     uint64 `json:"read_merges,omitempty"`
	ReadSectors    uint64 `json:"read_sectors,omitempty"`
	ReadTicks      uint64 `json:"read_ticks,omitempty"`
	WriteIOs       uint64 `json:"write_ios,omitempty"`
	WriteMerges    uint64 `json:"write_merges,omitempty"`
	WriteSectors   uint64 `json:"write_sectors,omitempty"`
	WriteTicks     uint64 `json:"write_ticks,omitempty"`
	CurrentIOs     uint64 `json:"current_ios,omitempty"`
	TotalTicks     uint64 `json:"total_ticks,omitempty"`
	ReqTicks       uint64 `json:"req_ticks,omitempty"`
	DiscardIOs     uint64 `json:"discard_ios,omitempty"`
	DiscardMerges  uint64 `json:"discard_merges,omitempty"`
	DiscardSectors uint64 `json:"discard_sectors,omitempty"`
	DiscardTicks   uint64 `json:"discard_ticks,omitempty"`
	FlushIOs       uint64 `json:"flush_ios,omitempty"`
	FlushTicks     uint64 `json:"flush_ticks,omitempty"`
}

DiskIOStats contains IO stats of a single drive

func (*DiskIOStats) Add added in v4.2.10 

func (d *DiskIOStats) Add(other *DiskIOStats)

Add 'other' to 'd'.

func (*DiskIOStats) DecodeMsg 

func (z *DiskIOStats) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DiskIOStats) EncodeMsg 

func (z *DiskIOStats) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*DiskIOStats) MarshalMsg 

func (z *DiskIOStats) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DiskIOStats) Msgsize 

func (z *DiskIOStats) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DiskIOStats) UnmarshalMsg 

func (z *DiskIOStats) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DiskIOStatsLegacy added in v4.2.10 

type DiskIOStatsLegacy struct {
	N              int    `json:"n,omitempty"`
	ReadIOs        uint64 `json:"read_ios,omitempty"`
	ReadMerges     uint64 `json:"read_merges,omitempty"`
	ReadSectors    uint64 `json:"read_sectors,omitempty"`
	ReadTicks      uint64 `json:"read_ticks,omitempty"`
	WriteIOs       uint64 `json:"write_ios,omitempty"`
	WriteMerges    uint64 `json:"write_merges,omitempty"`
	WriteSectors   uint64 `json:"wrte_sectors,omitempty"` // note "spelling"
	WriteTicks     uint64 `json:"write_ticks,omitempty"`
	CurrentIOs     uint64 `json:"current_ios,omitempty"`
	TotalTicks     uint64 `json:"total_ticks,omitempty"`
	ReqTicks       uint64 `json:"req_ticks,omitempty"`
	DiscardIOs     uint64 `json:"discard_ios,omitempty"`
	DiscardMerges  uint64 `json:"discard_merges,omitempty"`
	DiscardSectors uint64 `json:"discard_secotrs,omitempty"` // note "spelling"
	DiscardTicks   uint64 `json:"discard_ticks,omitempty"`
	FlushIOs       uint64 `json:"flush_ios,omitempty"`
	FlushTicks     uint64 `json:"flush_ticks,omitempty"`
}

func (*DiskIOStatsLegacy) DecodeMsg added in v4.2.10 

func (z *DiskIOStatsLegacy) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DiskIOStatsLegacy) EncodeMsg added in v4.2.10 

func (z *DiskIOStatsLegacy) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*DiskIOStatsLegacy) MarshalMsg added in v4.2.10 

func (z *DiskIOStatsLegacy) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DiskIOStatsLegacy) Msgsize added in v4.2.10 

func (z *DiskIOStatsLegacy) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DiskIOStatsLegacy) UnmarshalMsg added in v4.2.10 

func (z *DiskIOStatsLegacy) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DiskLatency 

type DiskLatency struct {
	Avg          float64 `json:"avg_secs,omitempty"`
	Percentile50 float64 `json:"percentile50_secs,omitempty"`
	Percentile90 float64 `json:"percentile90_secs,omitempty"`
	Percentile99 float64 `json:"percentile99_secs,omitempty"`
	Min          float64 `json:"min_secs,omitempty"`
	Max          float64 `json:"max_secs,omitempty"`
}

DiskLatency holds latency information for write operations to the drive

type DiskMetric 

type DiskMetric struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	// Number of disks
	NDisks int `json:"n_disks"`

	// DiskIdx will be populated if all disks in the metrics have the same drive index.
	DiskIdx *int `json:"disk_idx,omitempty"`

	// SetIdx will be populated if all disks in the metrics are part of the same set.
	SetIdx *int `json:"set_idx,omitempty"`

	// PoolIdx will be populated if all disks in the metrics are part of the same pool.
	PoolIdx *int `json:"pool_idx,omitempty"`

	// Offline disks
	Offline int `json:"offline,omitempty"`

	// Hanging - drives hanging.
	Hanging int `json:"waiting,omitempty"`

	// Healing disks
	Healing int `json:"healing,omitempty"`

	// Cache stats if enabled.
	Cache *CacheStats `json:"cache,omitempty"`

	// Space info.
	Space DriveSpaceInfo `json:"space,omitempty"`

	// Number of accumulated operations by type.
	LifetimeOps map[string]DiskAction `json:"lifetime_ops,omitempty"`

	// Last minute statistics.
	LastMinute map[string]DiskAction `json:"last_minute,omitempty"`

	// LastDaySegmented contains the segmented metrics for the last day.
	LastDaySegmented map[string]SegmentedDiskActions `json:"last_day,omitempty"`

	// IO stats.
	// Deprecated: use io_min, io_day instead.
	IOStats *DiskIOStatsLegacy `json:"iostats,omitempty"`

	// Rolling window last minute IO stats.
	IOStatsMinute DiskIOStats `json:"io_min,omitempty"`

	// Rolling window daily IO stats.
	IOStatsDay SegmentedDiskIO `json:"io_day,omitempty"`
}

DiskMetric contains metrics for one or more disks.

func (*DiskMetric) DecodeMsg 

func (z *DiskMetric) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DiskMetric) EncodeMsg 

func (z *DiskMetric) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (DiskMetric) LifetimeTotal added in v4.2.10 

func (d DiskMetric) LifetimeTotal() DiskAction

LifetimeTotal returns the accumulated Disk metrics for all operations

func (*DiskMetric) MarshalMsg 

func (z *DiskMetric) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DiskMetric) Merge 

func (d *DiskMetric) Merge(other *DiskMetric)

Merge other into 's'.

func (*DiskMetric) Msgsize 

func (z *DiskMetric) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DiskMetric) UnmarshalMsg 

func (z *DiskMetric) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DiskStatus added in v4.2.10 

type DiskStatus struct {
	// TotalWaiting is something. Seems to be related to offline disks.
	TotalWaiting uint32 `json:"totalWaiting,omitempty"`

	// Captures all data availability errors such as
	// permission denied, faulty disk and timeout errors.
	TotalErrorsAvailability uint64 `json:"totalErrorsAvailability,omitempty"`

	// Captures all timeout only errors
	TotalErrorsTimeout uint64 `json:"totalErrorsTimeout,omitempty"`
}

DiskStatus has the information about XL Storage APIs the number of calls of each API and the moving average of the duration, in nanosecond, of each API.

func (*DiskStatus) DecodeMsg added in v4.2.10 

func (z *DiskStatus) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (DiskStatus) EncodeMsg added in v4.2.10 

func (z DiskStatus) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (DiskStatus) MarshalMsg added in v4.2.10 

func (z DiskStatus) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (DiskStatus) Msgsize added in v4.2.10 

func (z DiskStatus) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DiskStatus) UnmarshalMsg added in v4.2.10 

func (z *DiskStatus) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DiskThroughput 

type DiskThroughput struct {
	Avg          float64 `json:"avg_bytes_per_sec,omitempty"`
	Percentile50 float64 `json:"percentile50_bytes_per_sec,omitempty"`
	Percentile90 float64 `json:"percentile90_bytes_per_sec,omitempty"`
	Percentile99 float64 `json:"percentile99_bytes_per_sec,omitempty"`
	Min          float64 `json:"min_bytes_per_sec,omitempty"`
	Max          float64 `json:"max_bytes_per_sec,omitempty"`
}

DiskThroughput holds throughput information for write operations to the drive

type DowntimeInfo 

type DowntimeInfo struct {
	Duration StatRecorder `json:"duration"`
	Count    StatRecorder `json:"count"`
}

DowntimeInfo captures the downtime information

func (*DowntimeInfo) DecodeMsg 

func (z *DowntimeInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DowntimeInfo) EncodeMsg 

func (z *DowntimeInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*DowntimeInfo) MarshalMsg 

func (z *DowntimeInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DowntimeInfo) Msgsize 

func (z *DowntimeInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DowntimeInfo) RecordCount 

func (d *DowntimeInfo) RecordCount(value int64)

RecordCount records the value

func (*DowntimeInfo) RecordDuration 

func (d *DowntimeInfo) RecordDuration(value int64)

RecordDuration records the value

func (*DowntimeInfo) UnmarshalMsg 

func (z *DowntimeInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DriveCounts added in v4.1.0 

type DriveCounts struct {
	Ok          int `json:"ok" msg:"ok"`
	Offline     int `json:"offline" msg:"of"`
	Corrupt     int `json:"corrupt" msg:"cr"`
	Missing     int `json:"missing" msg:"mi"`
	Permission  int `json:"permission" msg:"pe"`
	Faulty      int `json:"faulty" msg:"fa"`
	RootMount   int `json:"rootMount" msg:"ro"`
	Unknown     int `json:"unknown" msg:"un"`
	Unformatted int `json:"unformatted" msg:"uf"`
}

DriveCounts ...

func (*DriveCounts) DecodeMsg added in v4.1.0 

func (z *DriveCounts) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DriveCounts) EncodeMsg added in v4.1.0 

func (z *DriveCounts) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*DriveCounts) MarshalMsg added in v4.1.0 

func (z *DriveCounts) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DriveCounts) Msgsize added in v4.1.0 

func (z *DriveCounts) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DriveCounts) UnmarshalMsg added in v4.1.0 

func (z *DriveCounts) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DriveInfoOpts 

type DriveInfoOpts struct{}

DriveInfoOpts ask for additional data from the server this is not used at the moment, kept here for future extensibility.

type DrivePerf 

type DrivePerf struct {
	Path            string `json:"path"`
	ReadThroughput  uint64 `json:"readThroughput"`
	WriteThroughput uint64 `json:"writeThroughput"`

	Error string `json:"error,omitempty"`
}

DrivePerf - result of drive speed test on 1 drive mounted at path

type DrivePerfInfo 

type DrivePerfInfo struct {
	Error string `json:"error,omitempty"`

	Path       string     `json:"path"`
	Latency    Latency    `json:"latency,omitempty"`
	Throughput Throughput `json:"throughput,omitempty"`
}

DrivePerfInfo contains disk drive's performance information.

type DrivePerfInfoV0 

type DrivePerfInfoV0 struct {
	Path       string         `json:"endpoint"`
	Latency    DiskLatency    `json:"latency,omitempty"`
	Throughput DiskThroughput `json:"throughput,omitempty"`
	Error      string         `json:"error,omitempty"`
}

DrivePerfInfoV0 - Stats about a single drive in a MinIO node

type DrivePerfInfos 

type DrivePerfInfos struct {
	NodeCommon

	SerialPerf   []DrivePerfInfo `json:"serial_perf,omitempty"`
	ParallelPerf []DrivePerfInfo `json:"parallel_perf,omitempty"`
}

DrivePerfInfos contains all disk drive's performance information of a node.

type DriveResource added in v4.1.0 

type DriveResource struct {
	ID          string `json:"id" msg:"i"`
	DriveIndex  int    `json:"idx" msg:"idx"`
	ServerIndex int    `json:"serverIndex" msg:"sidx"`
	Path        string `json:"path" msg:"p"`
	NodeID      string `json:"nodeId" msg:"ni"`
	PoolIndex   int    `json:"poolIndex" msg:"pi"`
	SetIndex    int    `json:"setIndex" msg:"si"`
	State       string `json:"state" msg:"s"`
	Healing     bool   `json:"healing" msg:"h"`
	Size        uint64 `json:"size" msg:"sz"`
	Used        uint64 `json:"used" msg:"u"`
	Available   uint64 `json:"available" msg:"a"`
	UUID        string `json:"uuid" msg:"uid"`
}

DriveResource represents information about a drive

func (*DriveResource) DecodeMsg added in v4.1.0 

func (z *DriveResource) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DriveResource) EncodeMsg added in v4.1.0 

func (z *DriveResource) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*DriveResource) MarshalMsg added in v4.1.0 

func (z *DriveResource) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DriveResource) Msgsize added in v4.1.0 

func (z *DriveResource) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DriveResource) UnmarshalMsg added in v4.1.0 

func (z *DriveResource) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DriveSpaceInfo added in v4.2.10 

type DriveSpaceInfo struct {
	N          int               `json:"n"`
	Free       TotalMinMaxUint64 `json:"free"`
	Used       TotalMinMaxUint64 `json:"used"`
	UsedInodes TotalMinMaxUint64 `json:"used_inodes"`
	FreeInodes TotalMinMaxUint64 `json:"free_inodes"`
}

DriveSpaceInfo is the space info of one or more drives.

func (*DriveSpaceInfo) DecodeMsg added in v4.2.10 

func (z *DriveSpaceInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*DriveSpaceInfo) EncodeMsg added in v4.2.10 

func (z *DriveSpaceInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*DriveSpaceInfo) MarshalMsg added in v4.2.10 

func (z *DriveSpaceInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*DriveSpaceInfo) Merge added in v4.2.10 

func (d *DriveSpaceInfo) Merge(other DriveSpaceInfo)

func (*DriveSpaceInfo) Msgsize added in v4.2.10 

func (z *DriveSpaceInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*DriveSpaceInfo) UnmarshalMsg added in v4.2.10 

func (z *DriveSpaceInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type DriveSpeedTestOpts 

type DriveSpeedTestOpts struct {
	Serial    bool   // Run speed tests one drive at a time
	BlockSize uint64 // BlockSize for read/write (default 4MiB)
	FileSize  uint64 // Total fileSize to write and read (default 1GiB)
}

DriveSpeedTestOpts provide configurable options for drive speedtest

type DriveSpeedTestResult 

type DriveSpeedTestResult struct {
	Version   string      `json:"version"`
	Endpoint  string      `json:"endpoint"`
	DrivePerf []DrivePerf `json:"drivePerf,omitempty"`

	Error string `json:"string,omitempty"`
}

DriveSpeedTestResult - result of the drive speed test

type DrivesResourceOpts added in v4.1.0 

type DrivesResourceOpts struct {
	Limit  int
	Offset int
	Filter string
	// Sort fields contained in DriveResource.
	//
	// Example: DrivesResourceOpts.Sort = "ServerIndex"
	// Assuming the value of ServerIndex is of a supported value type.
	//
	// Supported Values Types: int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64, float32, float64, string
	Sort string
	// SortReversed will only take effect if Sort is defined
	SortReversed bool
}

DrivesResourceOpts contains the available options for the DrivesQuery API

type EntityDiag added in v4.0.18 

type EntityDiag struct {
	Name string `json:"name"`
	// deploymentid/peer name will be present if entity missing on current site or entity present but other sites have more recent update (check UpdatedAt field)
	SyncFrom []string `json:"sync_from,omitempty"`
	// deploymentid/peer name will be present if current site is latest  and other sites are missing this entity
	SyncTo []string `json:"sync_to,omitempty"`
}

EntityDiag represents the entity diagnostic information

type EnvOverride 

type EnvOverride struct {
	Name  string `json:"name"`
	Value string `json:"value"`
}

EnvOverride contains the name of the environment variable and its value.

type ErasureBackend 

type ErasureBackend struct {
	Type         backendType `json:"backendType"`
	OnlineDisks  int         `json:"onlineDisks"`
	OfflineDisks int         `json:"offlineDisks"`
	// Parity disks for currently configured Standard storage class.
	StandardSCParity int `json:"standardSCParity"`
	// Parity disks for currently configured Reduced Redundancy storage class.
	RRSCParity int `json:"rrSCParity"`

	// Per pool information
	TotalSets    []int `json:"totalSets"`
	DrivesPerSet []int `json:"totalDrivesPerSet"`
}

ErasureBackend contains specific erasure storage information

func (*ErasureBackend) DecodeMsg 

func (z *ErasureBackend) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ErasureBackend) EncodeMsg 

func (z *ErasureBackend) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ErasureBackend) MarshalMsg 

func (z *ErasureBackend) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ErasureBackend) Msgsize 

func (z *ErasureBackend) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ErasureBackend) UnmarshalMsg 

func (z *ErasureBackend) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ErasureSetInfo 

type ErasureSetInfo struct {
	ID                 int      `json:"id"`
	RawUsage           uint64   `json:"rawUsage"`
	RawCapacity        uint64   `json:"rawCapacity"`
	Usage              uint64   `json:"usage"`
	ObjectsCount       uint64   `json:"objectsCount"`
	VersionsCount      uint64   `json:"versionsCount"`
	DeleteMarkersCount uint64   `json:"deleteMarkersCount"`
	HealDisks          int      `json:"healDisks"`
	OnlineDisks        int      `json:"onlineDisks,omitempty"`
	OfflineDisks       int      `json:"offlineDisks,omitempty"`
	Nodes              []string `json:"nodes,omitempty"`
}

ErasureSetInfo provides information per erasure set

func (*ErasureSetInfo) DecodeMsg 

func (z *ErasureSetInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ErasureSetInfo) EncodeMsg 

func (z *ErasureSetInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ErasureSetInfo) MarshalMsg 

func (z *ErasureSetInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ErasureSetInfo) Msgsize 

func (z *ErasureSetInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ErasureSetInfo) UnmarshalMsg 

func (z *ErasureSetInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ErasureSetResource added in v4.1.0 

type ErasureSetResource struct {
	PoolIndex          int      `json:"poolIndex" msg:"pi"`
	SetIndex           int      `json:"setIndex" msg:"si"`
	DriveCount         int      `json:"driveCount" msg:"dc"`
	OfflineDrives      int      `json:"offlineDrives" msg:"od"`
	OnlineDrives       int      `json:"onlineDrives" msg:"ond"`
	HealDisks          int      `json:"healDisks" msg:"hd"`
	ReadQuorum         int      `json:"readQuorum" msg:"rq"`
	WriteQuorum        int      `json:"writeQuorum" msg:"wq"`
	Nodes              []string `json:"nodes,omitempty" msg:"n,omitempty"`
	RawUsage           uint64   `json:"rawUsage" msg:"ru"`
	RawCapacity        uint64   `json:"rawCapacity" msg:"rc"`
	Usage              uint64   `json:"usage" msg:"u"`
	ObjectsCount       uint64   `json:"objectsCount" msg:"oc"`
	VersionsCount      uint64   `json:"versionsCount" msg:"vc"`
	DeleteMarkersCount uint64   `json:"deleteMarkersCount" msg:"dmc"`
}

ErasureSetResource represents information about an erasure set

func (*ErasureSetResource) DecodeMsg added in v4.1.0 

func (z *ErasureSetResource) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ErasureSetResource) EncodeMsg added in v4.1.0 

func (z *ErasureSetResource) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ErasureSetResource) MarshalMsg added in v4.1.0 

func (z *ErasureSetResource) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ErasureSetResource) Msgsize added in v4.1.0 

func (z *ErasureSetResource) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ErasureSetResource) UnmarshalMsg added in v4.1.0 

func (z *ErasureSetResource) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ErasureSetsResourceOpts added in v4.1.0 

type ErasureSetsResourceOpts struct {
	Limit  int
	Offset int
	Filter string
	// Sort fields contained in ErasureSetResource.
	//
	// Example: ErasureSetsResourceOpts.Sort = "SetIndex"
	// Assuming the value of SetIndex is of a supported value type.
	//
	// Supported Values Types: int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64, float32, float64, string
	Sort string
	// SortReversed will only take effect if Sort is defined
	SortReversed bool
}

ErasureSetsResourceOpts contains the available options for the ErasureSetsQuery API

type ErrorLogOpts added in v4.2.10 

type ErrorLogOpts struct {
	Node     string        `json:"node,omitempty"`
	API      string        `json:"api,omitempty"`
	Bucket   string        `json:"bucket,omitempty"`
	Prefix   string        `json:"prefix,omitempty"`
	Interval time.Duration `json:"interval,omitempty"`
}

ErrorLogOpts represents the options for the ErrorLogs

type ErrorResponse 

type ErrorResponse struct {
	XMLName    xml.Name `xml:"Error" json:"-"`
	Code       string
	Message    string
	BucketName string
	Key        string
	RequestID  string `xml:"RequestId"`
	HostID     string `xml:"HostId"`

	// Region where the bucket is located. This header is returned
	// only in HEAD bucket and ListObjects response.
	Region string
}

ErrorResponse - Is the typed error returned by all API operations.

func ToErrorResponse 

func ToErrorResponse(err error) ErrorResponse

ToErrorResponse - Returns parsed ErrorResponse struct from body and http headers.

For example: 

import admin "github.com/minio/madmin-go/v4"
...
...
ss, err := adm.ServiceStatus(...)
if err != nil {
   resp := admin.ToErrorResponse(err)
}
...

func (ErrorResponse) Error 

func (e ErrorResponse) Error() string

Error - Returns HTTP error string

type ExpirationInfo 

type ExpirationInfo struct {
	// Last bucket/object key rotated
	Bucket string `json:"lastBucket"`
	Object string `json:"lastObject"`

	// Verbose information
	Objects             int64 `json:"objects"`
	ObjectsFailed       int64 `json:"objectsFailed"`
	DeleteMarkers       int64 `json:"deleteMarkers"`
	DeleteMarkersFailed int64 `json:"deleteMarkersFailed"`
}

func (*ExpirationInfo) DecodeMsg 

func (z *ExpirationInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ExpirationInfo) EncodeMsg 

func (z *ExpirationInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ExpirationInfo) MarshalMsg 

func (z *ExpirationInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ExpirationInfo) Msgsize 

func (z *ExpirationInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ExpirationInfo) UnmarshalMsg 

func (z *ExpirationInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ExtendedErasureSetInfo 

type ExtendedErasureSetInfo struct {
	ID                 int    `json:"id"`
	RawUsage           uint64 `json:"rawUsage"`
	RawCapacity        uint64 `json:"rawCapacity"`
	Usage              uint64 `json:"usage"`
	ObjectsCount       uint64 `json:"objectsCount"`
	VersionsCount      uint64 `json:"versionsCount"`
	DeleteMarkersCount uint64 `json:"deleteMarkersCount"`
	HealDrives         int    `json:"healDrives"`
	Drives             []Disk `json:"drives,omitempty"`
}

ExtendedErasureSetInfo provides information per erasure set

func (*ExtendedErasureSetInfo) DecodeMsg 

func (z *ExtendedErasureSetInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ExtendedErasureSetInfo) EncodeMsg 

func (z *ExtendedErasureSetInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ExtendedErasureSetInfo) MarshalMsg 

func (z *ExtendedErasureSetInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ExtendedErasureSetInfo) Msgsize 

func (z *ExtendedErasureSetInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ExtendedErasureSetInfo) UnmarshalMsg 

func (z *ExtendedErasureSetInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type FSBackend 

type FSBackend struct {
	Type backendType `json:"backendType"`
}

FSBackend contains specific FS storage information

func (*FSBackend) DecodeMsg 

func (z *FSBackend) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (FSBackend) EncodeMsg 

func (z FSBackend) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (FSBackend) MarshalMsg 

func (z FSBackend) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (FSBackend) Msgsize 

func (z FSBackend) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*FSBackend) UnmarshalMsg 

func (z *FSBackend) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type GCSOptions 

type GCSOptions func(*TierGCS) error

GCSOptions supports NewTierGCS to take variadic options

type GCStats 

type GCStats struct {
	LastGC     time.Time       `json:"last_gc"`     // time of last collection
	NumGC      int64           `json:"num_gc"`      // number of garbage collections
	PauseTotal time.Duration   `json:"pause_total"` // total pause for all collections
	Pause      []time.Duration `json:"pause"`       // pause history, most recent first
	PauseEnd   []time.Time     `json:"pause_end"`   // pause end times history, most recent first
}

GCStats collect information about recent garbage collections.

func (*GCStats) DecodeMsg 

func (z *GCStats) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*GCStats) EncodeMsg 

func (z *GCStats) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*GCStats) MarshalMsg 

func (z *GCStats) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*GCStats) Msgsize 

func (z *GCStats) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*GCStats) UnmarshalMsg 

func (z *GCStats) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type GenerateBatchJobOpts 

type GenerateBatchJobOpts struct {
	Type BatchJobType
}

GenerateBatchJobOpts is to be implemented in future.

type GroupAddRemove 

type GroupAddRemove struct {
	Group    string      `json:"group"`
	Members  []string    `json:"members"`
	Status   GroupStatus `json:"groupStatus"`
	IsRemove bool        `json:"isRemove"`
}

GroupAddRemove is type for adding/removing members to/from a group.

type GroupDesc 

type GroupDesc struct {
	Name      string    `json:"name"`
	Status    string    `json:"status"`
	Members   []string  `json:"members"`
	Policy    string    `json:"policy"`
	UpdatedAt time.Time `json:"updatedAt,omitempty"`
}

GroupDesc is a type that holds group info along with the policy attached to it.

type GroupPolicyEntities 

type GroupPolicyEntities struct {
	Group    string   `json:"group"`
	Policies []string `json:"policies"`
}

GroupPolicyEntities - group -> policies mapping

type GroupStatus 

type GroupStatus string

GroupStatus - group status. 

const (
	GroupEnabled  GroupStatus = "enabled"
	GroupDisabled GroupStatus = "disabled"
)

GroupStatus values.

type HTTPFilter added in v4.0.18 

type HTTPFilter struct {
	Func      string            `json:"funcFilter"`
	UserAgent string            `json:"userAgent"`
	Header    map[string]string `json:"header"`
}

HTTPFilter defines parameters for filtering traces based on incoming http request properties

func (*HTTPFilter) DecodeMsg added in v4.0.18 

func (z *HTTPFilter) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*HTTPFilter) EncodeMsg added in v4.0.18 

func (z *HTTPFilter) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*HTTPFilter) MarshalMsg added in v4.0.18 

func (z *HTTPFilter) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*HTTPFilter) Msgsize added in v4.0.18 

func (z *HTTPFilter) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HTTPFilter) UnmarshalMsg added in v4.0.18 

func (z *HTTPFilter) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealDriveInfo 

type HealDriveInfo struct {
	UUID     string `json:"uuid"`
	Endpoint string `json:"endpoint"`
	State    string `json:"state"`
}

HealDriveInfo - struct for an individual drive info item.

func (*HealDriveInfo) DecodeMsg 

func (z *HealDriveInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HealDriveInfo) EncodeMsg 

func (z HealDriveInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HealDriveInfo) MarshalMsg 

func (z HealDriveInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HealDriveInfo) Msgsize 

func (z HealDriveInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealDriveInfo) UnmarshalMsg 

func (z *HealDriveInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealItemType 

type HealItemType string

HealItemType - specify the type of heal operation in a healing result 

const (
	HealItemMetadata       HealItemType = "metadata"
	HealItemBucket         HealItemType = "bucket"
	HealItemBucketMetadata HealItemType = "bucket-metadata"
	HealItemObject         HealItemType = "object"
)

HealItemType constants

func (*HealItemType) DecodeMsg 

func (z *HealItemType) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HealItemType) EncodeMsg 

func (z HealItemType) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HealItemType) MarshalMsg 

func (z HealItemType) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HealItemType) Msgsize 

func (z HealItemType) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealItemType) UnmarshalMsg 

func (z *HealItemType) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealOpts 

type HealOpts struct {
	Recursive    bool         `json:"recursive"`
	DryRun       bool         `json:"dryRun"`
	Remove       bool         `json:"remove"`
	Recreate     bool         `json:"recreate"` // Rewrite all resources specified at the bucket or prefix.
	ScanMode     HealScanMode `json:"scanMode"`
	UpdateParity bool         `json:"updateParity"` // Update the parity of the existing object with a new one
	NoLock       bool         `json:"nolock"`

	// Pool to heal. nil indicates "all pools" (and sets).
	Pool *int `json:"pool,omitempty"`
	// Set to heal. nil indicates "all sets". Should always be nil if Pool is nil.
	Set *int `json:"set,omitempty"`
}

HealOpts - collection of options for a heal sequence

func (*HealOpts) DecodeMsg 

func (z *HealOpts) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*HealOpts) EncodeMsg 

func (z *HealOpts) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HealOpts) Equal 

func (o HealOpts) Equal(no HealOpts) bool

Equal returns true if no is same as o.

func (*HealOpts) MarshalMsg 

func (z *HealOpts) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*HealOpts) Msgsize 

func (z *HealOpts) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealOpts) UnmarshalMsg 

func (z *HealOpts) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealResultItem 

type HealResultItem struct {
	ResultIndex  int64        `json:"resultId"`
	Type         HealItemType `json:"type"`
	Bucket       string       `json:"bucket"`
	Object       string       `json:"object"`
	VersionID    string       `json:"versionId"`
	Detail       string       `json:"detail"`
	ParityBlocks int          `json:"parityBlocks,omitempty"`
	DataBlocks   int          `json:"dataBlocks,omitempty"`
	DiskCount    int          `json:"diskCount"`
	SetCount     int          `json:"setCount"`
	// below slices are from drive info.
	Before struct {
		Drives []HealDriveInfo `json:"drives"`
	} `json:"before"`
	After struct {
		Drives []HealDriveInfo `json:"drives"`
	} `json:"after"`
	ObjectSize int64 `json:"objectSize"`
}

HealResultItem - struct for an individual heal result item

func (*HealResultItem) DecodeMsg 

func (z *HealResultItem) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*HealResultItem) EncodeMsg 

func (z *HealResultItem) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*HealResultItem) GetCorruptedCounts 

func (hri *HealResultItem) GetCorruptedCounts() (b, a int)

GetCorruptedCounts - returns the number of corrupted disks before and after heal

func (*HealResultItem) GetMissingCounts 

func (hri *HealResultItem) GetMissingCounts() (b, a int)

GetMissingCounts - returns the number of missing disks before and after heal

func (*HealResultItem) GetOfflineCounts 

func (hri *HealResultItem) GetOfflineCounts() (b, a int)

GetOfflineCounts - returns the number of offline disks before and after heal

func (*HealResultItem) GetOnlineCounts 

func (hri *HealResultItem) GetOnlineCounts() (b, a int)

GetOnlineCounts - returns the number of online disks before and after heal

func (*HealResultItem) MarshalMsg 

func (z *HealResultItem) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*HealResultItem) Msgsize 

func (z *HealResultItem) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealResultItem) UnmarshalMsg 

func (z *HealResultItem) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealScanMode 

type HealScanMode int

HealScanMode represents the type of healing scan 

const (
	// HealUnknownScan default is unknown
	HealUnknownScan HealScanMode = 0

	// HealNormalScan checks if parts are present and not outdated
	HealNormalScan HealScanMode = 1 << (iota - 1)

	// HealDeepScan checks for parts bitrot checksums
	HealDeepScan

	// HealUncommittedScan will only pick objects that are dangling (uncommitted objects in the namespace without quorum)
	HealUncommittedScan
)

func (*HealScanMode) DecodeMsg 

func (z *HealScanMode) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HealScanMode) EncodeMsg 

func (z HealScanMode) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HealScanMode) MarshalMsg 

func (z HealScanMode) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HealScanMode) Msgsize 

func (z HealScanMode) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealScanMode) UnmarshalMsg 

func (z *HealScanMode) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealStartSuccess 

type HealStartSuccess struct {
	ClientToken   string    `json:"clientToken"`
	ClientAddress string    `json:"clientAddress"`
	StartTime     time.Time `json:"startTime"`
}

HealStartSuccess - holds information about a successfully started heal operation

func (*HealStartSuccess) DecodeMsg 

func (z *HealStartSuccess) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HealStartSuccess) EncodeMsg 

func (z HealStartSuccess) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HealStartSuccess) MarshalMsg 

func (z HealStartSuccess) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HealStartSuccess) Msgsize 

func (z HealStartSuccess) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealStartSuccess) UnmarshalMsg 

func (z *HealStartSuccess) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealStopSuccess 

type HealStopSuccess HealStartSuccess

HealStopSuccess - holds information about a successfully stopped heal operation.

func (*HealStopSuccess) DecodeMsg 

func (z *HealStopSuccess) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HealStopSuccess) EncodeMsg 

func (z HealStopSuccess) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HealStopSuccess) MarshalMsg 

func (z HealStopSuccess) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HealStopSuccess) Msgsize 

func (z HealStopSuccess) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealStopSuccess) UnmarshalMsg 

func (z *HealStopSuccess) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealTaskStatus 

type HealTaskStatus struct {
	Summary       string    `json:"summary"`
	FailureDetail string    `json:"detail"`
	StartTime     time.Time `json:"startTime"`
	HealSettings  HealOpts  `json:"settings"`

	Items []HealResultItem `json:"items,omitempty"`
}

HealTaskStatus - status struct for a heal task

func (*HealTaskStatus) DecodeMsg 

func (z *HealTaskStatus) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*HealTaskStatus) EncodeMsg 

func (z *HealTaskStatus) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*HealTaskStatus) MarshalMsg 

func (z *HealTaskStatus) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*HealTaskStatus) Msgsize 

func (z *HealTaskStatus) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealTaskStatus) UnmarshalMsg 

func (z *HealTaskStatus) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealingDisk 

type HealingDisk struct {
	ID         string    `json:"id"`
	HealID     string    `json:"heal_id"`
	PoolIndex  int       `json:"pool_index"`
	SetIndex   int       `json:"set_index"`
	DiskIndex  int       `json:"disk_index"`
	Endpoint   string    `json:"endpoint"`
	Path       string    `json:"path"`
	Started    time.Time `json:"started"`
	LastUpdate time.Time `json:"last_update"`

	RetryAttempts uint64 `json:"retry_attempts"`

	ObjectsTotalCount uint64 `json:"objects_total_count"`
	ObjectsTotalSize  uint64 `json:"objects_total_size"`

	ItemsHealed  uint64 `json:"items_healed"`
	ItemsFailed  uint64 `json:"items_failed"`
	ItemsSkipped uint64 `json:"items_skipped"`
	BytesDone    uint64 `json:"bytes_done"`
	BytesFailed  uint64 `json:"bytes_failed"`
	BytesSkipped uint64 `json:"bytes_skipped"`

	// Last object scanned.
	Bucket string `json:"current_bucket"`
	Object string `json:"current_object"`

	// Filled on startup/restarts.
	QueuedBuckets []string `json:"queued_buckets"`
	// Filled during heal.
	HealedBuckets []string `json:"healed_buckets"`

	// Healing of this drive is finished, successfully or not
	Finished bool `json:"finished"`

	// The reason the healing was started, in order to decide which drive has priority.
	Reason HealingDriveReason `json:"reason"`
}

HealingDisk contains information from a disk's healing tracker.

func (*HealingDisk) DecodeMsg 

func (z *HealingDisk) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*HealingDisk) EncodeMsg 

func (z *HealingDisk) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*HealingDisk) MarshalMsg 

func (z *HealingDisk) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*HealingDisk) Msgsize 

func (z *HealingDisk) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*HealingDisk) UnmarshalMsg 

func (z *HealingDisk) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealingDriveReason 

type HealingDriveReason int8
const (
	// HealingReasonFreshDisk is the 0 value default, which is a fresh disk
	HealingReasonFreshDisk HealingDriveReason = iota
	// HealingReasonOfflineDisk means the disk was detected as being offline for too long
	HealingReasonOfflineDisk
)

func (*HealingDriveReason) DecodeMsg 

func (z *HealingDriveReason) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (HealingDriveReason) EncodeMsg 

func (z HealingDriveReason) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (HealingDriveReason) MarshalMsg 

func (z HealingDriveReason) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (HealingDriveReason) Msgsize 

func (z HealingDriveReason) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (HealingDriveReason) String added in v4.2.13 

func (i HealingDriveReason) String() string

func (*HealingDriveReason) UnmarshalMsg 

func (z *HealingDriveReason) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type HealthDataType 

type HealthDataType string

HealthDataType - Typed Health data types 

const (
	HealthDataTypeMinioInfo    HealthDataType = "minioinfo"
	HealthDataTypeMinioConfig  HealthDataType = "minioconfig"
	HealthDataTypeSysCPU       HealthDataType = "syscpu"
	HealthDataTypeSysDriveHw   HealthDataType = "sysdrivehw"
	HealthDataTypeSysOsInfo    HealthDataType = "sysosinfo"
	HealthDataTypeSysMem       HealthDataType = "sysmem"
	HealthDataTypeSysNet       HealthDataType = "sysnet"
	HealthDataTypeSysProcess   HealthDataType = "sysprocess"
	HealthDataTypeSysErrors    HealthDataType = "syserrors"
	HealthDataTypeSysServices  HealthDataType = "sysservices"
	HealthDataTypeSysConfig    HealthDataType = "sysconfig"
	HealthDataTypeReplication  HealthDataType = "replication"
	HealthDataTypeShardsHealth HealthDataType = "shardshealth"
)

HealthDataTypes

type HealthInfo 

type HealthInfo struct {
	Version string `json:"version"`
	Error   string `json:"error,omitempty"`

	TimeStamp time.Time       `json:"timestamp,omitempty"`
	Sys       SysInfo         `json:"sys,omitempty"`
	Minio     MinioHealthInfo `json:"minio,omitempty"`
}

HealthInfo - MinIO cluster's health Info

func (HealthInfo) GetError 

func (info HealthInfo) GetError() string

GetError - returns error from the cluster health info

func (HealthInfo) GetStatus 

func (info HealthInfo) GetStatus() string

GetStatus - returns status of the cluster health info

func (HealthInfo) GetTimestamp 

func (info HealthInfo) GetTimestamp() time.Time

GetTimestamp - returns timestamp from the cluster health info

func (HealthInfo) JSON 

func (info HealthInfo) JSON() string

JSON returns this structure as JSON formatted string.

func (HealthInfo) String 

func (info HealthInfo) String() string

type HealthInfoV0 

type HealthInfoV0 struct {
	TimeStamp time.Time         `json:"timestamp,omitempty"`
	Error     string            `json:"error,omitempty"`
	Perf      PerfInfoV0        `json:"perf,omitempty"`
	Minio     MinioHealthInfoV0 `json:"minio,omitempty"`
	Sys       SysHealthInfo     `json:"sys,omitempty"`
}

HealthInfoV0 - MinIO cluster's health Info version 0

func (HealthInfoV0) JSON 

func (info HealthInfoV0) JSON() string

JSON returns this structure as JSON formatted string.

func (HealthInfoV0) String 

func (info HealthInfoV0) String() string

type HealthInfoV2 

type HealthInfoV2 struct {
	Version string `json:"version"`
	Error   string `json:"error,omitempty"`

	TimeStamp time.Time       `json:"timestamp,omitempty"`
	Sys       SysInfo         `json:"sys,omitempty"`
	Perf      PerfInfo        `json:"perf,omitempty"`
	Minio     MinioHealthInfo `json:"minio,omitempty"`
}

HealthInfoV2 - MinIO cluster's health Info version 2

func (HealthInfoV2) GetError 

func (info HealthInfoV2) GetError() string

GetError - returns error from the cluster health info v2

func (HealthInfoV2) GetStatus 

func (info HealthInfoV2) GetStatus() string

GetStatus - returns status of the cluster health info v2

func (HealthInfoV2) GetTimestamp 

func (info HealthInfoV2) GetTimestamp() time.Time

GetTimestamp - returns timestamp from the cluster health info v2

func (HealthInfoV2) JSON 

func (info HealthInfoV2) JSON() string

JSON returns this structure as JSON formatted string.

func (HealthInfoV2) String 

func (info HealthInfoV2) String() string

type HealthInfoVersionStruct 

type HealthInfoVersionStruct struct {
	Version string `json:"version,omitempty"`
	Error   string `json:"error,omitempty"`
}

HealthInfoVersionStruct - struct for health info version

type HealthOpts 

type HealthOpts struct {
	ClusterRead bool
	Maintenance bool
}

HealthOpts represents the input options for the health check

type HealthResult 

type HealthResult struct {
	Healthy         bool
	MaintenanceMode bool
	WriteQuorum     int
	HealingDrives   int
}

HealthResult represents the cluster health result

type Help 

type Help struct {
	SubSys          string  `json:"subSys"`
	Description     string  `json:"description"`
	MultipleTargets bool    `json:"multipleTargets"`
	KeysHelp        HelpKVS `json:"keysHelp"`
}

Help - return sub-system level help

func (Help) Keys 

func (h Help) Keys() []string

Keys returns help keys

type HelpKV 

type HelpKV struct {
	Key             string `json:"key"`
	Description     string `json:"description"`
	Optional        bool   `json:"optional"`
	Type            string `json:"type"`
	MultipleTargets bool   `json:"multipleTargets"`
}

HelpKV - implements help messages for keys with value as description of the keys.

type HelpKVS 

type HelpKVS []HelpKV

HelpKVS - implement order of keys help messages.

type IAMEntities 

type IAMEntities struct {
	// List of policy names
	Policies []string `json:"policies,omitempty"`
	// List of user names
	Users []string `json:"users,omitempty"`
	// List of group names
	Groups []string `json:"groups,omitempty"`
	// List of Service Account names
	ServiceAccounts []string `json:"serviceAccounts,omitempty"`
	// List of user policies, each entry in map represents list of policies
	// applicable to the user
	UserPolicies []map[string][]string `json:"userPolicies,omitempty"`
	// List of group policies, each entry in map represents list of policies
	// applicable to the group
	GroupPolicies []map[string][]string `json:"groupPolicies,omitempty"`
	// List of STS policies, each entry in map represents list of policies
	// applicable to the STS
	STSPolicies []map[string][]string `json:"stsPolicies,omitempty"`
}

IAMEntities - represents different IAM entities

type IAMErrEntities 

type IAMErrEntities struct {
	// List of errored out policies with errors
	Policies []IAMErrEntity `json:"policies,omitempty"`
	// List of errored out users with errors
	Users []IAMErrEntity `json:"users,omitempty"`
	// List of errored out groups with errors
	Groups []IAMErrEntity `json:"groups,omitempty"`
	// List of errored out service accounts with errors
	ServiceAccounts []IAMErrEntity `json:"serviceAccounts,omitempty"`
	// List of errored out user policies with errors
	UserPolicies []IAMErrPolicyEntity `json:"userPolicies,omitempty"`
	// List of errored out group policies with errors
	GroupPolicies []IAMErrPolicyEntity `json:"groupPolicies,omitempty"`
	// List of errored out STS policies with errors
	STSPolicies []IAMErrPolicyEntity `json:"stsPolicies,omitempty"`
}

IAMErrEntities - represents errored out IAM entries while import with error

type IAMErrEntity 

type IAMErrEntity struct {
	// Name of the errored IAM entity
	Name string `json:"name,omitempty"`
	// Actual error
	Error error `json:"error,omitempty"`
}

IAMErrEntity - represents errored out IAM entity

type IAMErrPolicyEntity 

type IAMErrPolicyEntity struct {
	// Name of entity (user, group, STS)
	Name string `json:"name,omitempty"`
	// List of policies
	Policies []string `json:"policies,omitempty"`
	// Actual error
	Error error `json:"error,omitempty"`
}

IAMErrPolicyEntity - represents errored out IAM policies

type IDPCfgInfo 

type IDPCfgInfo struct {
	Key   string `json:"key"`
	Value string `json:"value"`
	IsCfg bool   `json:"isCfg"`
	IsEnv bool   `json:"isEnv"` // relevant only when isCfg=true
}

IDPCfgInfo represents a single configuration or related parameter

type IDPConfig 

type IDPConfig struct {
	Type string       `json:"type"`
	Name string       `json:"name,omitempty"`
	Info []IDPCfgInfo `json:"info"`
}

IDPConfig contains IDP configuration information returned by server.

type IDPListItem 

type IDPListItem struct {
	Type    string `json:"type"`
	Name    string `json:"name"`
	Enabled bool   `json:"enabled"`
	RoleARN string `json:"roleARN,omitempty"`
}

IDPListItem - represents an item in the List IDPs call.

type IDPSettings 

type IDPSettings struct {
	LDAP   LDAPSettings
	OpenID OpenIDSettings
}

IDPSettings contains key IDentity Provider settings to validate that all peers have the same configuration.

type ILMExpiryRule 

type ILMExpiryRule struct {
	ILMRule    string    `json:"ilm-rule"`
	Bucket     string    `json:"bucket"`
	UpdatedAt  time.Time `json:"updatedAt,omitempty"`
	APIVersion string    `json:"apiVersion,omitempty"`
}

ILMExpiryRule - represents an ILM expiry rule

type ImportIAMResult 

type ImportIAMResult struct {
	// Skipped entries while import
	// This could be due to groups, policies etc missing for
	// impoprted entries. We dont fail hard in this case and
	// skip those entries
	Skipped IAMEntities `json:"skipped,omitempty"`

	// Removed entries - this mostly happens for policies
	// where empty might be getting imported and that's invalid
	Removed IAMEntities `json:"removed,omitempty"`

	// Newly added entries
	Added IAMEntities `json:"added,omitempty"`

	// Failed entries while import. This would have details of
	// failed entities with respective errors
	Failed IAMErrEntities `json:"failed,omitempty"`
}

ImportIAMResult - represents the structure iam import response

type InProgressMetric added in v4.0.15 

type InProgressMetric InQueueMetric

InProgressMetric holds stats for objects with replication in progress

type InQueueMetric 

type InQueueMetric struct {
	Curr QStat `json:"curr" msg:"cq"`
	Avg  QStat `json:"avg" msg:"aq"`
	Max  QStat `json:"max" msg:"pq"`
}

InQueueMetric holds stats for objects in replication queue

type InfoAccessKeyResp 

type InfoAccessKeyResp struct {
	AccessKey string

	InfoServiceAccountResp

	UserType           string                      `json:"userType"`
	UserProvider       string                      `json:"userProvider"`
	LDAPSpecificInfo   LDAPSpecificAccessKeyInfo   `json:"ldapSpecificInfo,omitempty"`
	OpenIDSpecificInfo OpenIDSpecificAccessKeyInfo `json:"openIDSpecificInfo,omitempty"`
}

InfoAccessKeyResp is the response body of the info access key call

type InfoAzureCannedPolicyReq added in v4.2.13 

type InfoAzureCannedPolicyReq struct {
	Name       string
	ConfigName string
}

InfoAzureCannedPolicyReq represents a request to get information about an Azure canned policy.

func (*InfoAzureCannedPolicyReq) Validate added in v4.2.13 

func (r *InfoAzureCannedPolicyReq) Validate() error

type InfoAzureCannedPolicyResp added in v4.2.13 

type InfoAzureCannedPolicyResp struct {
	GroupName string
	PI        PolicyInfo
}

InfoAzureCannedPolicyResp represents the response containing information about an Azure canned policy.

type InfoMessage 

type InfoMessage struct {
	Mode          string             `json:"mode,omitempty"`
	Domain        []string           `json:"domain,omitempty"`
	Region        string             `json:"region,omitempty"`
	SQSARN        []string           `json:"sqsARN,omitempty"`
	DeploymentID  string             `json:"deploymentID,omitempty"`
	Buckets       Buckets            `json:"buckets,omitempty"`
	Objects       Objects            `json:"objects,omitempty"`
	Versions      Versions           `json:"versions,omitempty"`
	DeleteMarkers DeleteMarkers      `json:"deletemarkers,omitempty"`
	Usage         Usage              `json:"usage,omitempty"`
	Services      Services           `json:"services,omitempty"`
	Backend       ErasureBackend     `json:"backend,omitempty"`
	Servers       []ServerProperties `json:"servers,omitempty"`

	Pools map[int]map[int]ErasureSetInfo `json:"pools,omitempty"`
}

InfoMessage container to hold server admin related information.

func (InfoMessage) BackendType 

func (info InfoMessage) BackendType() BackendType

func (*InfoMessage) DecodeMsg 

func (z *InfoMessage) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*InfoMessage) EncodeMsg 

func (z *InfoMessage) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*InfoMessage) MarshalMsg 

func (z *InfoMessage) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*InfoMessage) Msgsize 

func (z *InfoMessage) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (InfoMessage) StandardParity 

func (info InfoMessage) StandardParity() int

func (*InfoMessage) UnmarshalMsg 

func (z *InfoMessage) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type InfoServiceAccountResp 

type InfoServiceAccountResp struct {
	ParentUser    string     `json:"parentUser"`
	AccountStatus string     `json:"accountStatus"`
	ImpliedPolicy bool       `json:"impliedPolicy"`
	Policy        string     `json:"policy"`
	Name          string     `json:"name,omitempty"`
	Description   string     `json:"description,omitempty"`
	Expiration    *time.Time `json:"expiration,omitempty"`
}

InfoServiceAccountResp is the response body of the info service account call

type InspectOptions 

type InspectOptions struct {
	Volume, File string
	PublicKey    []byte // PublicKey to use for inspected data.
}

InspectOptions provides options to Inspect.

type InventoryJobControlResponse added in v4.2.13 

type InventoryJobControlResponse struct {
	Status      InventoryJobControlStatus `json:"status"`
	Bucket      string                    `json:"bucket"`
	InventoryID string                    `json:"inventoryId"`
	Message     string                    `json:"message,omitempty"`
}

InventoryJobControlResponse represents the response from inventory job control operations

type InventoryJobControlStatus added in v4.2.13 

type InventoryJobControlStatus string

InventoryJobControlStatus represents the status of an inventory job control operation 

const (
	InventoryJobStatusCanceled  InventoryJobControlStatus = "canceled"
	InventoryJobStatusSuspended InventoryJobControlStatus = "suspended"
	InventoryJobStatusResumed   InventoryJobControlStatus = "resumed"
)

type ItemState 

type ItemState string

ItemState - represents the status of any item in offline,init,online state

func (*ItemState) DecodeMsg 

func (z *ItemState) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (ItemState) EncodeMsg 

func (z ItemState) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (ItemState) MarshalMsg 

func (z ItemState) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (ItemState) Msgsize 

func (z ItemState) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ItemState) UnmarshalMsg 

func (z *ItemState) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type JobMetric 

type JobMetric struct {
	JobID         string    `json:"jobID"`
	JobType       string    `json:"jobType"`
	StartTime     time.Time `json:"startTime"`
	LastUpdate    time.Time `json:"lastUpdate"`
	RetryAttempts int       `json:"retryAttempts"`

	Complete bool   `json:"complete"`
	Failed   bool   `json:"failed"`
	Status   string `json:"status"`

	// Specific job type data:
	Replicate *ReplicateInfo   `json:"replicate,omitempty"`
	KeyRotate *KeyRotationInfo `json:"rotation,omitempty"`
	Expired   *ExpirationInfo  `json:"expired,omitempty"`
	Catalog   *CatalogInfo     `json:"catalog,omitempty"`
}

func (*JobMetric) DecodeMsg 

func (z *JobMetric) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*JobMetric) EncodeMsg 

func (z *JobMetric) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*JobMetric) MarshalMsg 

func (z *JobMetric) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*JobMetric) Msgsize 

func (z *JobMetric) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*JobMetric) UnmarshalMsg 

func (z *JobMetric) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type KMS 

type KMS struct {
	Status   string `json:"status,omitempty"`
	Encrypt  string `json:"encrypt,omitempty"`
	Decrypt  string `json:"decrypt,omitempty"`
	Endpoint string `json:"endpoint,omitempty"`
	Version  string `json:"version,omitempty"`
}

KMS contains KMS status information

func (*KMS) DecodeMsg 

func (z *KMS) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*KMS) EncodeMsg 

func (z *KMS) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*KMS) MarshalMsg 

func (z *KMS) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*KMS) Msgsize 

func (z *KMS) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*KMS) UnmarshalMsg 

func (z *KMS) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type KMSAPI 

type KMSAPI struct {
	Method  string
	Path    string
	MaxBody int64
	Timeout int64
}

type KMSDescribeIdentity 

type KMSDescribeIdentity struct {
	Policy    string    `json:"policy"`
	Identity  string    `json:"identity"`
	IsAdmin   bool      `json:"isAdmin"`
	CreatedAt time.Time `json:"createdAt"`
	CreatedBy string    `json:"createdBy"`
}

KMSDescribeIdentity contains identity metadata

type KMSDescribePolicy 

type KMSDescribePolicy struct {
	Name      string    `json:"name"`
	CreatedAt time.Time `json:"created_at"`
	CreatedBy string    `json:"created_by"`
}

KMSDescribePolicy contains policy metadata

type KMSDescribeSelfIdentity 

type KMSDescribeSelfIdentity struct {
	Policy     *KMSPolicy `json:"policy"`
	PolicyName string     `json:"policyName"`
	Identity   string     `json:"identity"`
	IsAdmin    bool       `json:"isAdmin"`
	CreatedAt  string     `json:"createdAt"`
	CreatedBy  string     `json:"createdBy"`
}

KMSDescribeSelfIdentity describes the identity issuing the request

type KMSIdentityInfo 

type KMSIdentityInfo struct {
	CreatedAt time.Time `json:"createdAt"`
	CreatedBy string    `json:"createdBy"`
	Identity  string    `json:"identity"`
	Policy    string    `json:"policy"`
	Error     string    `json:"error"`
}

KMSIdentityInfo contains policy metadata

type KMSKeyInfo 

type KMSKeyInfo struct {
	CreatedAt time.Time `json:"createdAt"`
	CreatedBy string    `json:"createdBy"`
	Name      string    `json:"name"`
}

KMSKeyInfo contains key metadata

type KMSKeyStatus 

type KMSKeyStatus struct {
	KeyID         string `json:"key-id"`
	EncryptionErr string `json:"encryption-error,omitempty"` // An empty error == success
	DecryptionErr string `json:"decryption-error,omitempty"` // An empty error == success
}

KMSKeyStatus contains some status information about a KMS master key. The MinIO server tries to access the KMS and perform encryption and decryption operations. If the MinIO server can access the KMS and all master key operations succeed it returns a status containing only the master key ID but no error.

type KMSMetrics 

type KMSMetrics struct {
	RequestOK     int64 `json:"kes_http_request_success"`
	RequestErr    int64 `json:"kes_http_request_error"`
	RequestFail   int64 `json:"kes_http_request_failure"`
	RequestActive int64 `json:"kes_http_request_active"`

	AuditEvents int64 `json:"kes_log_audit_events"`
	ErrorEvents int64 `json:"kes_log_error_events"`

	LatencyHistogram map[int64]int64 `json:"kes_http_response_time"`

	UpTime     int64 `json:"kes_system_up_time"`
	CPUs       int64 `json:"kes_system_num_cpu"`
	UsableCPUs int64 `json:"kes_system_num_cpu_used"`

	Threads     int64 `json:"kes_system_num_threads"`
	HeapAlloc   int64 `json:"kes_system_mem_heap_used"`
	HeapObjects int64 `json:"kes_system_mem_heap_objects"`
	StackAlloc  int64 `json:"kes_system_mem_stack_used"`
}

type KMSPolicy 

type KMSPolicy struct {
	Allow []string `json:"allow"`
	Deny  []string `json:"deny"`
}

KMSPolicy represents a KMS policy

type KMSPolicyInfo 

type KMSPolicyInfo struct {
	CreatedAt time.Time `json:"created_at"`
	CreatedBy string    `json:"created_by"`
	Name      string    `json:"name"`
}

KMSPolicyInfo contains policy metadata

type KMSState 

type KMSState struct {
	Version           string
	KeyStoreLatency   time.Duration
	KeyStoreReachable bool
	KeystoreAvailable bool

	OS         string
	Arch       string
	UpTime     time.Duration
	CPUs       int
	UsableCPUs int
	HeapAlloc  uint64
	StackAlloc uint64
}

KMSState is a KES server status snapshot.

type KMSStatus 

type KMSStatus struct {
	Name         string               `json:"name"`           // Name or type of the KMS
	DefaultKeyID string               `json:"default-key-id"` // The key ID used when no explicit key is specified
	Endpoints    map[string]ItemState `json:"endpoints"`      // List of KMS endpoints and their status (online/offline)
	State        KMSState             `json:"state"`          // Current KMS server state
}

KMSStatus contains various informations about the KMS connected to a MinIO server - like the KMS endpoints and the default key ID.

type KMSVersion 

type KMSVersion struct {
	Version string `json:"version"`
}

type KVOptions 

type KVOptions struct {
	Env bool
}

KVOptions takes specific inputs for KV functions

type KeyRotationInfo 

type KeyRotationInfo struct {
	// Last bucket/object key rotated
	Bucket string `json:"lastBucket"`
	Object string `json:"lastObject"`

	// Verbose information
	Objects       int64 `json:"objects"`
	ObjectsFailed int64 `json:"objectsFailed"`
}

func (*KeyRotationInfo) DecodeMsg 

func (z *KeyRotationInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*KeyRotationInfo) EncodeMsg 

func (z *KeyRotationInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*KeyRotationInfo) MarshalMsg 

func (z *KeyRotationInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*KeyRotationInfo) Msgsize 

func (z *KeyRotationInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*KeyRotationInfo) UnmarshalMsg 

func (z *KeyRotationInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type KubernetesInfo 

type KubernetesInfo struct {
	Major      string    `json:"major,omitempty"`
	Minor      string    `json:"minor,omitempty"`
	GitVersion string    `json:"gitVersion,omitempty"`
	GitCommit  string    `json:"gitCommit,omitempty"`
	BuildDate  time.Time `json:"buildDate,omitempty"`
	Platform   string    `json:"platform,omitempty"`
	Error      string    `json:"error,omitempty"`
}

KubernetesInfo - Information about the kubernetes platform

type LDAP 

type LDAP struct {
	Status string `json:"status,omitempty"`
}

LDAP contains ldap status

func (*LDAP) DecodeMsg 

func (z *LDAP) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (LDAP) EncodeMsg 

func (z LDAP) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (LDAP) MarshalMsg 

func (z LDAP) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (LDAP) Msgsize 

func (z LDAP) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*LDAP) UnmarshalMsg 

func (z *LDAP) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type LDAPSettings 

type LDAPSettings struct {
	IsLDAPEnabled          bool
	LDAPUserDNSearchBase   string
	LDAPUserDNSearchFilter string
	LDAPGroupSearchBase    string
	LDAPGroupSearchFilter  string
}

LDAPSettings contains LDAP configuration info of a cluster.

type LDAPSpecificAccessKeyInfo 

type LDAPSpecificAccessKeyInfo struct {
	Username string `json:"username"`
}

type Latency 

type Latency struct {
	Avg          float64 `json:"avg"`
	Max          float64 `json:"max"`
	Min          float64 `json:"min"`
	Percentile50 float64 `json:"percentile_50"`
	Percentile90 float64 `json:"percentile_90"`
	Percentile99 float64 `json:"percentile_99"`
}

Latency contains write operation latency in seconds of a disk drive.

type LatencyStat 

type LatencyStat struct {
	Curr time.Duration `json:"curr"`
	Avg  time.Duration `json:"avg"`
	Max  time.Duration `json:"max"`
}

LatencyStat represents replication link latency statistics

func (*LatencyStat) DecodeMsg 

func (z *LatencyStat) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (LatencyStat) EncodeMsg 

func (z LatencyStat) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (LatencyStat) MarshalMsg 

func (z LatencyStat) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (LatencyStat) Msgsize 

func (z LatencyStat) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*LatencyStat) UnmarshalMsg 

func (z *LatencyStat) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type LicenseInfo 

type LicenseInfo struct {
	ID           string    `json:"ID"`           // The license ID
	Organization string    `json:"Organization"` // Name of the organization using the license
	Plan         string    `json:"Plan"`         // License plan. E.g. "ENTERPRISE-PLUS"
	IssuedAt     time.Time `json:"IssuedAt"`     // Point in time when the license was issued
	ExpiresAt    time.Time `json:"ExpiresAt"`    // Point in time when the license expires
	Trial        bool      `json:"Trial"`        // Whether the license is on trial
	APIKey       string    `json:"APIKey"`       // Subnet account API Key
}

func (*LicenseInfo) DecodeMsg 

func (z *LicenseInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*LicenseInfo) EncodeMsg 

func (z *LicenseInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*LicenseInfo) MarshalMsg 

func (z *LicenseInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*LicenseInfo) Msgsize 

func (z *LicenseInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*LicenseInfo) UnmarshalMsg 

func (z *LicenseInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ListAccessKeysLDAPResp 

type ListAccessKeysLDAPResp ListAccessKeysResp

ListAccessKeysLDAPResp is the response body of the list service accounts call

type ListAccessKeysOpenIDResp 

type ListAccessKeysOpenIDResp struct {
	ConfigName string                 `json:"configName"`
	Users      []OpenIDUserAccessKeys `json:"users"`
}

type ListAccessKeysOpts 

type ListAccessKeysOpts struct {
	ListType   string
	All        bool
	ConfigName string // blank for default config or if AllConfigs is true
	AllConfigs bool
}

ListAccessKeysOpts - options for listing access keys

func (*ListAccessKeysOpts) BuiltinValidate 

func (opts *ListAccessKeysOpts) BuiltinValidate(n int) error

func (*ListAccessKeysOpts) LDAPValidate 

func (opts *ListAccessKeysOpts) LDAPValidate(n int) error

func (*ListAccessKeysOpts) OpenIDValidate 

func (opts *ListAccessKeysOpts) OpenIDValidate(n int) error

type ListAccessKeysResp 

type ListAccessKeysResp struct {
	ServiceAccounts []ServiceAccountInfo `json:"serviceAccounts"`
	STSKeys         []ServiceAccountInfo `json:"stsKeys"`
}

type ListAzureCannedPoliciesReq added in v4.2.13 

type ListAzureCannedPoliciesReq struct {
	ConfigName  string
	GetAllUUIDs bool // whether to also get policies that exist in MinIO but not in Azure
}

ListAzureCannedPoliciesReq represents a request to list Azure canned policies.

func (*ListAzureCannedPoliciesReq) Validate added in v4.2.13 

func (r *ListAzureCannedPoliciesReq) Validate() error

type ListAzureCannedPoliciesResp added in v4.2.13 

type ListAzureCannedPoliciesResp []InfoAzureCannedPolicyResp

ListAzureCannedPoliciesResp represents the response containing a list of Azure canned policies.

type ListBatchJobsFilter 

type ListBatchJobsFilter struct {
	ByJobType string
}

ListBatchJobsFilter returns list based on following filtering params.

type ListBatchJobsResult 

type ListBatchJobsResult struct {
	Jobs []BatchJobResult `json:"jobs"`
}

ListBatchJobsResult contains entries for all current jobs.

type ListServiceAccountsResp 

type ListServiceAccountsResp struct {
	Accounts []ServiceAccountInfo `json:"accounts"`
}

ListServiceAccountsResp is the response body of the list service accounts call

type LockEntries 

type LockEntries []LockEntry

LockEntries - To sort the locks

func (LockEntries) Len 

func (l LockEntries) Len() int

func (LockEntries) Less 

func (l LockEntries) Less(i, j int) bool

func (LockEntries) Swap 

func (l LockEntries) Swap(i, j int)

type LockEntry 

type LockEntry struct {
	Timestamp       time.Time     `json:"time"`            // When the lock was first granted
	TimeLastRefresh time.Time     `json:"timeLastRefresh"` // When the lock was last refreshed
	Elapsed         time.Duration `json:"elapsed"`         // Duration for which lock has been held
	Resource        string        `json:"resource"`        // Resource contains info like bucket+object
	Type            string        `json:"type"`            // Type indicates if 'Write' or 'Read' lock
	Source          string        `json:"source"`          // Source at which lock was granted
	ServerList      []string      `json:"serverlist"`      // List of servers participating in the lock.
	Owner           string        `json:"owner"`           // Owner UUID indicates server owns the lock.
	ID              string        `json:"id"`              // UID to uniquely identify request of client.
	// Represents quorum number of servers required to hold this lock, used to look for stale locks.
	Quorum int `json:"quorum"`
}

LockEntry holds information about client requesting the lock, servers holding the lock, source on the client machine, ID, type(read or write) and time stamp.

type LogInfo 

type LogInfo struct {
	NodeName string `json:"node"`
	Err      error  `json:"-"`
	// contains filtered or unexported fields
}

LogInfo holds console log messages

func (LogInfo) Mask 

func (l LogInfo) Mask() uint64

Mask returns the mask based on the error level.

type LogKind 

type LogKind string

LogKind specifies the kind of error log 

const (
	LogKindFatal   LogKind = "FATAL"
	LogKindWarning LogKind = "WARNING"
	LogKindError   LogKind = "ERROR"
	LogKindEvent   LogKind = "EVENT"
	LogKindInfo    LogKind = "INFO"
)

func (LogKind) LogMask 

func (l LogKind) LogMask() LogMask

LogMask returns the mask based on the kind.

func (LogKind) String 

func (l LogKind) String() string

type LogMask 

type LogMask uint64

LogMask is a bit mask for log types. 

const (
	LogMaskFatal LogMask = 1 << iota
	LogMaskWarning
	LogMaskError
	LogMaskEvent
	LogMaskInfo

	// LogMaskAll must be the last.
	LogMaskAll LogMask = (1 << iota) - 1
)

func (LogMask) Contains 

func (m LogMask) Contains(other LogMask) bool

Contains returns whether all flags in other is present in t.

func (LogMask) Mask 

func (m LogMask) Mask() uint64

Mask returns the LogMask as uint64

type Logger 

type Logger map[string]Status

Logger contains logger status

func (*Logger) DecodeMsg 

func (z *Logger) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (Logger) EncodeMsg 

func (z Logger) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Logger) MarshalMsg 

func (z Logger) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (Logger) Msgsize 

func (z Logger) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Logger) UnmarshalMsg 

func (z *Logger) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MRFStatus 

type MRFStatus struct {
	BytesHealed uint64 `json:"bytes_healed"`
	ItemsHealed uint64 `json:"items_healed"`
}

MRFStatus exposes MRF metrics of a server

func (*MRFStatus) DecodeMsg 

func (z *MRFStatus) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (MRFStatus) EncodeMsg 

func (z MRFStatus) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (MRFStatus) MarshalMsg 

func (z MRFStatus) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (MRFStatus) Msgsize 

func (z MRFStatus) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*MRFStatus) UnmarshalMsg 

func (z *MRFStatus) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MemInfo 

type MemInfo struct {
	NodeCommon

	Total          uint64 `json:"total,omitempty"`
	Used           uint64 `json:"used,omitempty"`
	Free           uint64 `json:"free,omitempty"`
	Available      uint64 `json:"available,omitempty"`
	Shared         uint64 `json:"shared,omitempty"`
	Cache          uint64 `json:"cache,omitempty"`
	Buffers        uint64 `json:"buffer,omitempty"`
	SwapSpaceTotal uint64 `json:"swap_space_total,omitempty"`
	SwapSpaceFree  uint64 `json:"swap_space_free,omitempty"`
	// Limit will store cgroup limit if configured and
	// less than Total, otherwise same as Total
	Limit uint64 `json:"limit,omitempty"`
}

MemInfo contains system's RAM and swap information.

func GetMemInfo 

func GetMemInfo(ctx context.Context, addr string) MemInfo

GetMemInfo returns system's RAM and swap information.

func (*MemInfo) DecodeMsg 

func (z *MemInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*MemInfo) EncodeMsg 

func (z *MemInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*MemInfo) MarshalMsg 

func (z *MemInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*MemInfo) Msgsize 

func (z *MemInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*MemInfo) UnmarshalMsg 

func (z *MemInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MemMetrics 

type MemMetrics struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	Info MemInfo `json:"memInfo"`
}

func (*MemMetrics) DecodeMsg 

func (z *MemMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*MemMetrics) EncodeMsg 

func (z *MemMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*MemMetrics) MarshalMsg 

func (z *MemMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*MemMetrics) Merge 

func (m *MemMetrics) Merge(other *MemMetrics)

Merge other into 'm'.

func (*MemMetrics) Msgsize 

func (z *MemMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*MemMetrics) UnmarshalMsg 

func (z *MemMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MemStats 

type MemStats struct {
	Alloc      uint64
	TotalAlloc uint64
	Mallocs    uint64
	Frees      uint64
	HeapAlloc  uint64
}

MemStats is strip down version of runtime.MemStats containing memory stats of MinIO server.

func (*MemStats) DecodeMsg 

func (z *MemStats) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*MemStats) EncodeMsg 

func (z *MemStats) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*MemStats) MarshalMsg 

func (z *MemStats) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*MemStats) Msgsize 

func (z *MemStats) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*MemStats) UnmarshalMsg 

func (z *MemStats) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MetaStatus 

type MetaStatus struct {
	IsSet bool   `json:"isSet"`
	Err   string `json:"error,omitempty"`
}

MetaStatus status of metadata import

type MetricFlags added in v4.2.10 

type MetricFlags uint64

MetricFlags is a bitfield representation of different metric flags. 

const (
	MetricsDayStats     MetricFlags = 1 << (iota) // Include daily statistics
	MetricsByHost                                 // Aggregate metrics by host/node.
	MetricsByDisk                                 // Aggregate metrics by disk.
	MetricsLegacyDiskIO                           // Add legacy disk IO metrics.
)

func (*MetricFlags) Add added in v4.2.10 

func (m *MetricFlags) Add(x ...MetricFlags)

Add one or more flags to m.

func (MetricFlags) Contains added in v4.2.10 

func (m MetricFlags) Contains(x MetricFlags) bool

Contains returns whether m contains all of x.

func (*MetricFlags) DecodeMsg added in v4.2.10 

func (z *MetricFlags) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (MetricFlags) EncodeMsg added in v4.2.10 

func (z MetricFlags) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (MetricFlags) MarshalMsg added in v4.2.10 

func (z MetricFlags) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (MetricFlags) Msgsize added in v4.2.10 

func (z MetricFlags) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*MetricFlags) UnmarshalMsg added in v4.2.10 

func (z *MetricFlags) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MetricType 

type MetricType uint32

MetricType is a bitfield representation of different metric types. 

const (
	MetricsScanner MetricType = 1 << (iota)
	MetricsDisk
	MetricsOS
	MetricsBatchJobs
	MetricsSiteResync
	MetricNet
	MetricsMem
	MetricsCPU
	MetricsRPC
	MetricsRuntime
	MetricsAPI

	// MetricsAll must be last.
	// Enables all metrics.
	MetricsAll = 1<<(iota) - 1
)
const MetricsNone MetricType = 0

MetricsNone indicates no metrics.

func (MetricType) Contains 

func (m MetricType) Contains(x MetricType) bool

Contains returns whether m contains all of x.

func (*MetricType) DecodeMsg 

func (z *MetricType) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (MetricType) EncodeMsg 

func (z MetricType) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (MetricType) MarshalMsg 

func (z MetricType) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (MetricType) Msgsize 

func (z MetricType) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*MetricType) UnmarshalMsg 

func (z *MetricType) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Metrics 

type Metrics struct {
	Scanner    *ScannerMetrics    `json:"scanner,omitempty"`
	Disk       *DiskMetric        `json:"disk,omitempty"`
	OS         *OSMetrics         `json:"os,omitempty"`
	BatchJobs  *BatchJobMetrics   `json:"batchJobs,omitempty"`
	SiteResync *SiteResyncMetrics `json:"siteResync,omitempty"`
	Net        *NetMetrics        `json:"net,omitempty"`
	Mem        *MemMetrics        `json:"mem,omitempty"`
	CPU        *CPUMetrics        `json:"cpu,omitempty"`
	RPC        *RPCMetrics        `json:"rpc,omitempty"`
	Go         *RuntimeMetrics    `json:"go,omitempty"`
	API        *APIMetrics        `json:"api,omitempty"`
}

Metrics contains all metric types.

func (*Metrics) DecodeMsg 

func (z *Metrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*Metrics) EncodeMsg 

func (z *Metrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*Metrics) MarshalMsg 

func (z *Metrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*Metrics) Merge 

func (r *Metrics) Merge(other *Metrics)

Merge other into r.

func (*Metrics) Msgsize 

func (z *Metrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Metrics) UnmarshalMsg 

func (z *Metrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MetricsClient 

type MetricsClient struct {
	// contains filtered or unexported fields
}

MetricsClient implements MinIO metrics operations

func NewMetricsClientWithOptions 

func NewMetricsClientWithOptions(endpoint string, opts *Options) (*MetricsClient, error)

NewMetricsClientWithOptions - instantiate minio metrics client honoring Prometheus format

func (*MetricsClient) BucketMetrics 

func (client *MetricsClient) BucketMetrics(ctx context.Context) ([]*prom2json.Family, error)

BucketMetrics - returns Bucket Metrics in Prometheus format

func (*MetricsClient) ClusterMetrics 

func (client *MetricsClient) ClusterMetrics(ctx context.Context) ([]*prom2json.Family, error)

ClusterMetrics - returns Cluster Metrics in Prometheus format

func (*MetricsClient) CredContext 

func (client *MetricsClient) CredContext() *credentials.CredContext

CredContext returns the context for fetching credentials

func (*MetricsClient) GetMetrics 

func (client *MetricsClient) GetMetrics(ctx context.Context, subSystem string) ([]*prom2json.Family, error)

GetMetrics - returns Metrics of given subsystem in Prometheus format

func (*MetricsClient) NodeMetrics 

func (client *MetricsClient) NodeMetrics(ctx context.Context) ([]*prom2json.Family, error)

NodeMetrics - returns Node Metrics in Prometheus format 

The client needs to be configured with the endpoint of the desired node

func (*MetricsClient) ResourceMetrics 

func (client *MetricsClient) ResourceMetrics(ctx context.Context) ([]*prom2json.Family, error)

ResourceMetrics - returns Resource Metrics in Prometheus format

type MetricsOptions 

type MetricsOptions struct {
	Type         MetricType    // Return only these metric types. Several types can be combined using |. Leave at 0 to return all.
	Flags        MetricFlags   // Flags to control returned metrics.
	N            int           // Maximum number of samples to return. 0 will return endless stream.
	Interval     time.Duration // Interval between samples. Will be rounded up to 1s.
	PoolIdx      []int         // Only include metrics for these pools. Leave empty for all.
	Hosts        []string      // Only include specified hosts. Leave empty for all.
	DrivePoolIdx []int         // Only include metrics for these drive pools. Leave empty for all.
	DriveSetIdx  []int         // Only include metrics for these drive sets (combine with PoolIdx if needed).
	Disks        []string      // Include only specific disks. Leave empty for all.
	ByJobID      string
	ByDepID      string

	// Alternative output merging.
	// Populates maps of the same name in the result.
	ByHost bool // Return individual metrics by host. Deprecated: use MetricsByHost instead.
	ByDisk bool // Return individual metrics by disk. Deprecated: use MetricsByDisk instead.
}

MetricsOptions are options provided to Metrics call.

func (*MetricsOptions) DecodeMsg 

func (z *MetricsOptions) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*MetricsOptions) EncodeMsg 

func (z *MetricsOptions) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*MetricsOptions) MarshalMsg 

func (z *MetricsOptions) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*MetricsOptions) Msgsize 

func (z *MetricsOptions) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*MetricsOptions) UnmarshalMsg 

func (z *MetricsOptions) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type MinIOOptions 

type MinIOOptions func(*TierMinIO) error

MinIOOptions supports NewTierMinIO to take variadic options

type MinioConfig 

type MinioConfig struct {
	Error string `json:"error,omitempty"`

	Config interface{} `json:"config,omitempty"`
}

MinioConfig contains minio configuration of a node.

type MinioHealthInfo 

type MinioHealthInfo struct {
	Error string `json:"error,omitempty"`

	Config          MinioConfig       `json:"config,omitempty"`
	Info            MinioInfo         `json:"info,omitempty"`
	Replication     *ReplDiagInfo     `json:"replication,omitempty"` // Deprecated May 2025
	ReplicationInfo *ReplDiagInfoV2   `json:"replication_info,omitempty"`
	ShardsHealth    *ShardsHealthInfo `json:"shards_health,omitempty"`
}

MinioHealthInfo - Includes MinIO confifuration information

type MinioHealthInfoV0 

type MinioHealthInfoV0 struct {
	Info   InfoMessage `json:"info,omitempty"`
	Config interface{} `json:"config,omitempty"`
	Error  string      `json:"error,omitempty"`
}

MinioHealthInfoV0 - Includes MinIO confifuration information

type MinioInfo 

type MinioInfo struct {
	Mode         string           `json:"mode,omitempty"`
	Domain       []string         `json:"domain,omitempty"`
	Region       string           `json:"region,omitempty"`
	SQSARN       []string         `json:"sqsARN,omitempty"`
	DeploymentID string           `json:"deploymentID,omitempty"`
	Buckets      Buckets          `json:"buckets,omitempty"`
	BucketQuota  *BucketQuotaDiag `json:"bucket_quota,omitempty"`
	Objects      Objects          `json:"objects,omitempty"`
	Usage        Usage            `json:"usage,omitempty"`
	Services     Services         `json:"services,omitempty"`
	Backend      interface{}      `json:"backend,omitempty"`
	Servers      []ServerInfo     `json:"servers,omitempty"`
	TLS          *TLSInfo         `json:"tls"`
	IsKubernetes *bool            `json:"is_kubernetes"`
	IsDocker     *bool            `json:"is_docker"`
	Metrics      *RealtimeMetrics `json:"metrics,omitempty"`
	TierConfigs  []TierConfig     `json:"tier_configs,omitempty"`
}

MinioInfo contains MinIO server and object storage information.

type NetInfo 

type NetInfo struct {
	NodeCommon
	Interface       string       `json:"interface,omitempty"`
	Driver          string       `json:"driver,omitempty"`
	FirmwareVersion string       `json:"firmware_version,omitempty"`
	Settings        *NetSettings `json:"settings,omitempty"`
}

NetInfo contains information about a network inerface

func GetNetInfo 

func GetNetInfo(addr string, iface string) (ni NetInfo)

GetNetInfo returns information of the given network interface

type NetLatency 

type NetLatency struct {
	Avg          float64 `json:"avg_secs,omitempty"`
	Percentile50 float64 `json:"percentile50_secs,omitempty"`
	Percentile90 float64 `json:"percentile90_secs,omitempty"`
	Percentile99 float64 `json:"percentile99_secs,omitempty"`
	Min          float64 `json:"min_secs,omitempty"`
	Max          float64 `json:"max_secs,omitempty"`
}

NetLatency holds latency information for read/write operations to the drive

type NetMetrics 

type NetMetrics struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	// net of Interface
	InterfaceName string `json:"interfaceName"`

	NetStats procfs.NetDevLine `json:"netstats"`
}

func (*NetMetrics) DecodeMsg 

func (z *NetMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*NetMetrics) EncodeMsg 

func (z *NetMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*NetMetrics) MarshalMsg 

func (z *NetMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*NetMetrics) Merge 

func (n *NetMetrics) Merge(other *NetMetrics)

Merge other into 'o'.

func (*NetMetrics) Msgsize 

func (z *NetMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*NetMetrics) UnmarshalMsg 

func (z *NetMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type NetPerfInfo 

type NetPerfInfo struct {
	NodeCommon

	RemotePeers []PeerNetPerfInfo `json:"remote_peers,omitempty"`
}

NetPerfInfo contains network performance information of a node to other nodes.

type NetPerfInfoV0 

type NetPerfInfoV0 struct {
	Addr       string        `json:"remote"`
	Latency    NetLatency    `json:"latency,omitempty"`
	Throughput NetThroughput `json:"throughput,omitempty"`
	Error      string        `json:"error,omitempty"`
}

NetPerfInfoV0 - one-to-one network connectivity Stats between 2 MinIO nodes

type NetSettings 

type NetSettings struct {
	// hardware capacity
	RxMaxPending uint32 `json:"rx_max_pending"`
	TxMaxPending uint32 `json:"tx_max_pending"`
	MaxCombined  uint32 `json:"max_combined"`

	// configured limits
	RxPending     uint32 `json:"rx_pending"`
	TxPending     uint32 `json:"tx_pending"`
	CombinedCount uint32 `json:"combined_count"`
}

NetSettings - rx/tx settings of an interface

type NetThroughput 

type NetThroughput struct {
	Avg          float64 `json:"avg_bytes_per_sec,omitempty"`
	Percentile50 float64 `json:"percentile50_bytes_per_sec,omitempty"`
	Percentile90 float64 `json:"percentile90_bytes_per_sec,omitempty"`
	Percentile99 float64 `json:"percentile99_bytes_per_sec,omitempty"`
	Min          float64 `json:"min_bytes_per_sec,omitempty"`
	Max          float64 `json:"max_bytes_per_sec,omitempty"`
}

NetThroughput holds throughput information for read/write operations to the drive

type NetperfNodeResult 

type NetperfNodeResult struct {
	Endpoint string `json:"endpoint"`
	TX       uint64 `json:"tx"`
	RX       uint64 `json:"rx"`
	Error    string `json:"error,omitempty"`
}

NetperfNodeResult - stats from each server

type NetperfResult 

type NetperfResult struct {
	NodeResults []NetperfNodeResult `json:"nodeResults"`
}

NetperfResult - aggregate results from all servers

type Node added in v4.0.11 

type Node struct {
	Host        string `msg:"host,omitempty"`
	TotalDrives int    `msg:"totalDrives,omitempty"`
}

Node provides information on a specific node

func (*Node) DecodeMsg added in v4.0.11 

func (z *Node) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (Node) EncodeMsg added in v4.0.11 

func (z Node) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Node) MarshalMsg added in v4.0.11 

func (z Node) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (Node) Msgsize added in v4.0.11 

func (z Node) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Node) UnmarshalMsg added in v4.0.11 

func (z *Node) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type NodeCommon 

type NodeCommon struct {
	Addr  string `json:"addr"`
	Error string `json:"error,omitempty"`
}

NodeCommon - Common fields across most node-specific health structs

func (*NodeCommon) GetAddr 

func (n *NodeCommon) GetAddr() string

GetAddr - return the address of the node

func (*NodeCommon) SetAddr 

func (n *NodeCommon) SetAddr(addr string)

SetAddr - set the address of the node

func (*NodeCommon) SetError 

func (n *NodeCommon) SetError(err string)

SetError - set the address of the node

type NodeInfo 

type NodeInfo interface {
	GetAddr() string
	SetAddr(addr string)
	SetError(err string)
}

NodeInfo - Interface to abstract any struct that contains address/endpoint and error fields

type NodeInfoOpts added in v4.0.11 

type NodeInfoOpts struct{}

type NodeListOpts added in v4.0.11 

type NodeListOpts struct {
	Limit  int
	Offset int
}

type NodeListResponse added in v4.0.11 

type NodeListResponse struct {
	Nodes []Node `msg:"nodes,omitempty"`
	Total int    `msg:"total,omitempty"`
}

NodeListResponse includes a paginated list of nodes and the total node count

func (*NodeListResponse) DecodeMsg added in v4.0.11 

func (z *NodeListResponse) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*NodeListResponse) EncodeMsg added in v4.0.11 

func (z *NodeListResponse) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*NodeListResponse) MarshalMsg added in v4.0.11 

func (z *NodeListResponse) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*NodeListResponse) Msgsize added in v4.0.11 

func (z *NodeListResponse) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*NodeListResponse) UnmarshalMsg added in v4.0.11 

func (z *NodeListResponse) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type NodeResource added in v4.1.0 

type NodeResource struct {
	Host        string      `json:"host" msg:"h"`
	Version     string      `json:"version" msg:"v"`
	CommitID    string      `json:"commitId" msg:"c"`
	Uptime      int64       `json:"uptime" msg:"u"`
	State       string      `json:"state" msg:"s"`
	TotalDrives int         `json:"totalDrives" msg:"td"`
	DriveCounts DriveCounts `json:"driveCounts" msg:"dc"`
	PoolIndex   int         `json:"poolIndex" msg:"pi"`
	PoolIndexes []int       `json:"poolIndexes,omitempty" msg:"pis,omitempty"`
}

NodeResource represents information about a node

func (*NodeResource) DecodeMsg added in v4.1.0 

func (z *NodeResource) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*NodeResource) EncodeMsg added in v4.1.0 

func (z *NodeResource) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*NodeResource) MarshalMsg added in v4.1.0 

func (z *NodeResource) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*NodeResource) Msgsize added in v4.1.0 

func (z *NodeResource) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*NodeResource) UnmarshalMsg added in v4.1.0 

func (z *NodeResource) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type NodesResourceOpts added in v4.1.0 

type NodesResourceOpts struct {
	Limit  int
	Offset int
	Filter string
	// Sort fields contained in NodeResource.
	//
	// Example: NodesResourceOpts.Sort = "PoolIndex"
	// Assuming the value of PoolIndex is of a supported value type.
	//
	// Supported Values Types: int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64, float32, float64, string
	Sort string
	// SortReversed will only take effect if Sort is defined
	SortReversed bool
}

NodesResourceOpts contains the available options for the NodesQuery API

type OSInfo 

type OSInfo struct {
	NodeCommon

	Info    host.InfoStat             `json:"info,omitempty"`
	Sensors []sensors.TemperatureStat `json:"sensors,omitempty"`
}

OSInfo contains operating system's information.

func GetOSInfo 

func GetOSInfo(ctx context.Context, addr string) OSInfo

GetOSInfo returns linux only operating system's information.

type OSMetrics 

type OSMetrics struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	// Number of accumulated operations by type since server restart.
	LifeTimeOps map[string]uint64 `json:"life_time_ops,omitempty"`

	// Last minute statistics.
	LastMinute struct {
		Operations map[string]TimedAction `json:"operations,omitempty"`
	} `json:"last_minute"`
}

OSMetrics contains metrics for OS operations.

func (*OSMetrics) DecodeMsg 

func (z *OSMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*OSMetrics) EncodeMsg 

func (z *OSMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*OSMetrics) MarshalMsg 

func (z *OSMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*OSMetrics) Merge 

func (o *OSMetrics) Merge(other *OSMetrics)

Merge other into 'o'.

func (*OSMetrics) Msgsize 

func (z *OSMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*OSMetrics) UnmarshalMsg 

func (z *OSMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ObjectBitrotSummary 

type ObjectBitrotSummary struct {
	Host  string
	Disk  string
	Parts []int
}

ObjectBitrotSummary is returned from minio when calling ObjectSummary. This struct contains bitrot information for and object on a specific host and drive.

func (*ObjectBitrotSummary) DecodeMsg 

func (z *ObjectBitrotSummary) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ObjectBitrotSummary) EncodeMsg 

func (z *ObjectBitrotSummary) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ObjectBitrotSummary) MarshalMsg 

func (z *ObjectBitrotSummary) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ObjectBitrotSummary) Msgsize 

func (z *ObjectBitrotSummary) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ObjectBitrotSummary) UnmarshalMsg 

func (z *ObjectBitrotSummary) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ObjectMetaSummary 

type ObjectMetaSummary struct {
	Filename       string
	Host           string
	Drive          string
	Size           int64
	Errors         []string
	IsDeleteMarker bool
	ModTime        int64
	Signature      [4]byte
	Pool           int
	Set            int
}

ObjectMetaSummary is returned from minio when calling ObjectSummary This struct gives specific information about xl.meta files belonging to the object being inspected by the ObjectSummary API.

func (*ObjectMetaSummary) DecodeMsg 

func (z *ObjectMetaSummary) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ObjectMetaSummary) EncodeMsg 

func (z *ObjectMetaSummary) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ObjectMetaSummary) MarshalMsg 

func (z *ObjectMetaSummary) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ObjectMetaSummary) Msgsize 

func (z *ObjectMetaSummary) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ObjectMetaSummary) UnmarshalMsg 

func (z *ObjectMetaSummary) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ObjectPartSummary 

type ObjectPartSummary struct {
	Part     int
	Pool     int
	Host     string
	Set      int
	Drive    string
	Filename string
	Size     int64
}

ObjectPartSummary is returned from minio when calling ObjectSummary. This struct gives specific information about each part of the object being inspected by the ObjectSummary API.

func (*ObjectPartSummary) DecodeMsg 

func (z *ObjectPartSummary) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ObjectPartSummary) EncodeMsg 

func (z *ObjectPartSummary) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ObjectPartSummary) MarshalMsg 

func (z *ObjectPartSummary) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ObjectPartSummary) Msgsize 

func (z *ObjectPartSummary) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ObjectPartSummary) UnmarshalMsg 

func (z *ObjectPartSummary) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ObjectSummary 

type ObjectSummary struct {
	Name   string
	Errors []string
	// DataDir represents the directory on disk created using
	// the version ID's or a random uuid if the object is not
	// versioned.
	DataDir      string
	Version      string
	PartNumbers  []int
	ErasureDist  []uint8
	ParityCount  int // deprecated
	DeleteMarker bool
	Metas        []*ObjectMetaSummary
	Parts        []*ObjectPartSummary
	Unknown      []*ObjectUnknownSummary
	Versions     []*ObjectVersionSummary
	Bitrot       []*ObjectBitrotSummary
}

ObjectSummary is returned from minio when calling ObjectSummary.

func (*ObjectSummary) DecodeMsg 

func (z *ObjectSummary) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ObjectSummary) EncodeMsg 

func (z *ObjectSummary) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ObjectSummary) MarshalMsg 

func (z *ObjectSummary) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ObjectSummary) Msgsize 

func (z *ObjectSummary) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ObjectSummary) UnmarshalMsg 

func (z *ObjectSummary) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ObjectSummaryOptions 

type ObjectSummaryOptions struct {
	Bucket string
	Object string
	Bitrot bool
}

ObjectSummaryOptions provides options for ObjectSummary call.

func (*ObjectSummaryOptions) DecodeMsg 

func (z *ObjectSummaryOptions) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (ObjectSummaryOptions) EncodeMsg 

func (z ObjectSummaryOptions) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (ObjectSummaryOptions) MarshalMsg 

func (z ObjectSummaryOptions) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (ObjectSummaryOptions) Msgsize 

func (z ObjectSummaryOptions) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ObjectSummaryOptions) UnmarshalMsg 

func (z *ObjectSummaryOptions) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ObjectUnknownSummary 

type ObjectUnknownSummary struct {
	Pool     int
	Host     string
	Set      int
	Drive    string
	Filename string
	Size     int64
	Dir      bool
	Err      string
}

ObjectUnknownSummary is returned from minio when calling ObjectSummary. This struct contains information about files that are not part of any object structure.

func (*ObjectUnknownSummary) DecodeMsg 

func (z *ObjectUnknownSummary) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ObjectUnknownSummary) EncodeMsg 

func (z *ObjectUnknownSummary) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ObjectUnknownSummary) MarshalMsg 

func (z *ObjectUnknownSummary) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ObjectUnknownSummary) Msgsize 

func (z *ObjectUnknownSummary) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ObjectUnknownSummary) UnmarshalMsg 

func (z *ObjectUnknownSummary) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ObjectVersionSummary 

type ObjectVersionSummary struct {
	DeleteMarker bool
	InLined      bool
	Size         int64
	VersionID    string
	Checksum     []byte
	ModTime      time.Time
	DataDir      string
	DataBlocks   int
	ParityBlocks int
}

ObjectVersionSummary is returned from minio when calling ObjectSummary. This struct contains information on a single version.

func (*ObjectVersionSummary) DecodeMsg 

func (z *ObjectVersionSummary) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ObjectVersionSummary) EncodeMsg 

func (z *ObjectVersionSummary) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ObjectVersionSummary) MarshalMsg 

func (z *ObjectVersionSummary) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ObjectVersionSummary) Msgsize 

func (z *ObjectVersionSummary) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ObjectVersionSummary) UnmarshalMsg 

func (z *ObjectVersionSummary) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Objects 

type Objects struct {
	Count uint64 `json:"count"`
	Error string `json:"error,omitempty"`
}

Objects contains the number of objects

func (*Objects) DecodeMsg 

func (z *Objects) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (Objects) EncodeMsg 

func (z Objects) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Objects) MarshalMsg 

func (z Objects) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (Objects) Msgsize 

func (z Objects) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Objects) UnmarshalMsg 

func (z *Objects) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type OfflineDecision added in v4.2.13 

type OfflineDecision int8
const (
	OfflineDecisionNone OfflineDecision = iota
	OfflineDecisionHealDrive
	OfflineDecisionSkipHealing
)

func (*OfflineDecision) DecodeMsg added in v4.2.13 

func (z *OfflineDecision) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (OfflineDecision) EncodeMsg added in v4.2.13 

func (z OfflineDecision) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (OfflineDecision) MarshalMsg added in v4.2.13 

func (z OfflineDecision) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (OfflineDecision) Msgsize added in v4.2.13 

func (z OfflineDecision) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (OfflineDecision) String added in v4.2.13 

func (i OfflineDecision) String() string

func (*OfflineDecision) UnmarshalMsg added in v4.2.13 

func (z *OfflineDecision) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type OfflineEvent added in v4.2.13 

type OfflineEvent struct {
	FromTime time.Time       `json:"from_time"`
	ToTime   time.Time       `json:"to_time"`
	Reason   OfflineReason   `json:"reason"`
	Decision OfflineDecision `json:"decision"`
}

OfflineEvent is copied from drive-offline-tracker.go

func (*OfflineEvent) DecodeMsg added in v4.2.13 

func (z *OfflineEvent) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*OfflineEvent) EncodeMsg added in v4.2.13 

func (z *OfflineEvent) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*OfflineEvent) MarshalMsg added in v4.2.13 

func (z *OfflineEvent) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*OfflineEvent) Msgsize added in v4.2.13 

func (z *OfflineEvent) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*OfflineEvent) UnmarshalMsg added in v4.2.13 

func (z *OfflineEvent) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type OfflineInfo added in v4.2.13 

type OfflineInfo struct {
	// Copied from drive-offline-tracker.go/driveOfflineInfo
	Events []OfflineEvent `json:"events"`
}

OfflineInfo contains information from a disk's offline tracker.

func (*OfflineInfo) DecodeMsg added in v4.2.13 

func (z *OfflineInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*OfflineInfo) EncodeMsg added in v4.2.13 

func (z *OfflineInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*OfflineInfo) MarshalMsg added in v4.2.13 

func (z *OfflineInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*OfflineInfo) Msgsize added in v4.2.13 

func (z *OfflineInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*OfflineInfo) UnmarshalMsg added in v4.2.13 

func (z *OfflineInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type OfflineReason added in v4.2.13 

type OfflineReason int8
const (
	OfflineReasonInvalid OfflineReason = iota
	OfflineReasonNodeDown
	OfflineReasonDriveIOError
	OfflineReasonDriveDown
	OfflineReasonDriveTimeout
)

func (*OfflineReason) DecodeMsg added in v4.2.13 

func (z *OfflineReason) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (OfflineReason) EncodeMsg added in v4.2.13 

func (z OfflineReason) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (OfflineReason) MarshalMsg added in v4.2.13 

func (z OfflineReason) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (OfflineReason) Msgsize added in v4.2.13 

func (z OfflineReason) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (OfflineReason) String added in v4.2.13 

func (i OfflineReason) String() string

func (*OfflineReason) UnmarshalMsg added in v4.2.13 

func (z *OfflineReason) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type OpenIDProviderSettings 

type OpenIDProviderSettings struct {
	ClaimName            string
	ClaimUserinfoEnabled bool
	RolePolicy           string
	ClientID             string
	HashedClientSecret   string
}

OpenIDProviderSettings contains info on a particular OIDC based provider.

type OpenIDSettings 

type OpenIDSettings struct {
	// Enabled is true iff there is at least one OpenID provider configured.
	Enabled bool
	Region  string
	// Map of role ARN to provider info
	Roles map[string]OpenIDProviderSettings
	// Info on the claim based provider (all fields are empty if not
	// present)
	ClaimProvider OpenIDProviderSettings
}

OpenIDSettings contains OpenID configuration info of a cluster.

type OpenIDSpecificAccessKeyInfo 

type OpenIDSpecificAccessKeyInfo struct {
	ConfigName       string `json:"configName"`
	UserID           string `json:"userID"`
	UserIDClaim      string `json:"userIDClaim"`
	DisplayName      string `json:"displayName,omitempty"`
	DisplayNameClaim string `json:"displayNameClaim,omitempty"`
}

type OpenIDUser 

type OpenIDUser struct {
	AccessInfo OpenIDUserAccessInfo `json:"accessInfo,omitempty"`
}

OpenIDUser holds information to maintain an virtual user in OpenID

type OpenIDUserAccessInfo 

type OpenIDUserAccessInfo struct {
	RefreshToken string `json:"refreshToken,omitempty"`
	AccessToken  string `json:"accessToken,omitempty"`
}

OpenIDUserAccessInfo contains information to access and refresh the token that is used to access to UserInfo OpenID endpoint.

type OpenIDUserAccessKeys 

type OpenIDUserAccessKeys struct {
	MinioAccessKey  string               `json:"minioAccessKey"`
	ID              string               `json:"ID"`
	ReadableName    string               `json:"readableName"`
	ServiceAccounts []ServiceAccountInfo `json:"serviceAccounts"`
	STSKeys         []ServiceAccountInfo `json:"stsKeys"`
}

type Options 

type Options struct {
	Creds     *credentials.Credentials
	Secure    bool
	Transport http.RoundTripper
}

Options for New method

type PaginatedDrivesResponse added in v4.1.0 

type PaginatedDrivesResponse struct {
	Results      []DriveResource `json:"results" msg:"r,omitempty"`
	Count        int             `json:"count" msg:"c"`
	Total        int             `json:"total" msg:"t"`
	Offset       int             `json:"offset" msg:"o"`
	Sort         string          `json:"sort" msg:"s"`
	SortReversed bool            `json:"sortReversed" msg:"sr"`
}

PaginatedDrivesResponse represents a paginated response for drives

func (*PaginatedDrivesResponse) DecodeMsg added in v4.1.0 

func (z *PaginatedDrivesResponse) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*PaginatedDrivesResponse) EncodeMsg added in v4.1.0 

func (z *PaginatedDrivesResponse) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*PaginatedDrivesResponse) MarshalMsg added in v4.1.0 

func (z *PaginatedDrivesResponse) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*PaginatedDrivesResponse) Msgsize added in v4.1.0 

func (z *PaginatedDrivesResponse) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*PaginatedDrivesResponse) UnmarshalMsg added in v4.1.0 

func (z *PaginatedDrivesResponse) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type PaginatedErasureSetsResponse added in v4.1.0 

type PaginatedErasureSetsResponse struct {
	Results      []ErasureSetResource `json:"results" msg:"r,omitempty"`
	Count        int                  `json:"count" msg:"c"`
	Total        int                  `json:"total" msg:"t"`
	Offset       int                  `json:"offset" msg:"o"`
	Sort         string               `json:"sort" msg:"s"`
	SortReversed bool                 `json:"sortReversed" msg:"sr"`
}

PaginatedErasureSetsResponse represents a paginated response for erasure sets

func (*PaginatedErasureSetsResponse) DecodeMsg added in v4.1.0 

func (z *PaginatedErasureSetsResponse) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*PaginatedErasureSetsResponse) EncodeMsg added in v4.1.0 

func (z *PaginatedErasureSetsResponse) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*PaginatedErasureSetsResponse) MarshalMsg added in v4.1.0 

func (z *PaginatedErasureSetsResponse) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*PaginatedErasureSetsResponse) Msgsize added in v4.1.0 

func (z *PaginatedErasureSetsResponse) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*PaginatedErasureSetsResponse) UnmarshalMsg added in v4.1.0 

func (z *PaginatedErasureSetsResponse) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type PaginatedNodesResponse added in v4.1.0 

type PaginatedNodesResponse struct {
	Results      []NodeResource `json:"results" msg:"r,omitempty"`
	Count        int            `json:"count" msg:"c"`
	Total        int            `json:"total" msg:"t"`
	Offset       int            `json:"offset" msg:"o"`
	Sort         string         `json:"sort" msg:"s"`
	SortReversed bool           `json:"sortReversed" msg:"sr"`
}

PaginatedNodesResponse represents a paginated response for nodes

func (*PaginatedNodesResponse) DecodeMsg added in v4.1.0 

func (z *PaginatedNodesResponse) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*PaginatedNodesResponse) EncodeMsg added in v4.1.0 

func (z *PaginatedNodesResponse) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*PaginatedNodesResponse) MarshalMsg added in v4.1.0 

func (z *PaginatedNodesResponse) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*PaginatedNodesResponse) Msgsize added in v4.1.0 

func (z *PaginatedNodesResponse) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*PaginatedNodesResponse) UnmarshalMsg added in v4.1.0 

func (z *PaginatedNodesResponse) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type PaginatedPoolsResponse added in v4.1.0 

type PaginatedPoolsResponse struct {
	Results      []PoolResource `json:"results" msg:"r,omitempty"`
	Count        int            `json:"count" msg:"c"`
	Total        int            `json:"total" msg:"t"`
	Offset       int            `json:"offset" msg:"o"`
	Sort         string         `json:"sort" msg:"s"`
	SortReversed bool           `json:"sortReversed" msg:"sr"`
}

PaginatedPoolsResponse represents a paginated response for pools

func (*PaginatedPoolsResponse) DecodeMsg added in v4.1.0 

func (z *PaginatedPoolsResponse) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*PaginatedPoolsResponse) EncodeMsg added in v4.1.0 

func (z *PaginatedPoolsResponse) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*PaginatedPoolsResponse) MarshalMsg added in v4.1.0 

func (z *PaginatedPoolsResponse) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*PaginatedPoolsResponse) Msgsize added in v4.1.0 

func (z *PaginatedPoolsResponse) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*PaginatedPoolsResponse) UnmarshalMsg added in v4.1.0 

func (z *PaginatedPoolsResponse) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Partition 

type Partition struct {
	Error string `json:"error,omitempty"`

	Device       string `json:"device,omitempty"`
	Major        uint32 `json:"major"`
	Minor        uint32 `json:"minor"`
	Model        string `json:"model,omitempty"`
	Revision     string `json:"revision,omitempty"`
	Mountpoint   string `json:"mountpoint,omitempty"`
	FSType       string `json:"fs_type,omitempty"`
	MountOptions string `json:"mount_options,omitempty"`
	MountFSType  string `json:"mount_fs_type,omitempty"`
	SpaceTotal   uint64 `json:"space_total,omitempty"`
	SpaceFree    uint64 `json:"space_free,omitempty"`
	InodeTotal   uint64 `json:"inode_total,omitempty"`
	InodeFree    uint64 `json:"inode_free,omitempty"`
}

Partition contains disk partition's information.

type PartitionStat 

type PartitionStat struct {
	Device     string    `json:"device"`
	Mountpoint string    `json:"mountpoint,omitempty"`
	Fstype     string    `json:"fstype,omitempty"`
	Opts       string    `json:"opts,omitempty"`
	SmartInfo  SmartInfo `json:"smartInfo,omitempty"`
}

PartitionStat - includes data from both shirou/psutil.diskHw.PartitionStat as well as SMART data

type Partitions 

type Partitions struct {
	NodeCommon

	Partitions []Partition `json:"partitions,omitempty"`
}

Partitions contains all disk partitions information of a node.

func GetPartitions 

func GetPartitions(ctx context.Context, addr string) Partitions

GetPartitions returns all disk partitions information of a node running linux only operating system.

type PeerInfo 

type PeerInfo struct {
	Endpoint string `json:"endpoint"`
	Name     string `json:"name"`
	// Deployment ID is useful as it is immutable - though endpoint may
	// change.
	DeploymentID       string          `json:"deploymentID"`
	SyncState          SyncStatus      `json:"sync"`             // whether to enable| disable synchronous replication
	DefaultBandwidth   BucketBandwidth `json:"defaultbandwidth"` // bandwidth limit per bucket in bytes/sec
	ReplicateILMExpiry bool            `json:"replicate-ilm-expiry"`
	APIVersion         string          `json:"apiVersion,omitempty"`
}

PeerInfo - contains some properties of a cluster peer.

type PeerNetPerfInfo 

type PeerNetPerfInfo struct {
	NodeCommon

	Latency    Latency    `json:"latency,omitempty"`
	Throughput Throughput `json:"throughput,omitempty"`
}

PeerNetPerfInfo contains network performance information of a node.

type PeerSite 

type PeerSite struct {
	Name      string `json:"name"`
	Endpoint  string `json:"endpoints"`
	AccessKey string `json:"accessKey"`
	SecretKey string `json:"secretKey"`
}

PeerSite - represents a cluster/site to be added to the set of replicated sites.

type PerfInfo 

type PerfInfo struct {
	Drives      []DrivePerfInfos `json:"drives,omitempty"`
	Net         []NetPerfInfo    `json:"net,omitempty"`
	NetParallel NetPerfInfo      `json:"net_parallel,omitempty"`
}

PerfInfo - Includes Drive and Net perf info for the entire MinIO cluster

type PerfInfoV0 

type PerfInfoV0 struct {
	DriveInfo   []ServerDrivesInfo    `json:"drives,omitempty"`
	Net         []ServerNetHealthInfo `json:"net,omitempty"`
	NetParallel ServerNetHealthInfo   `json:"net_parallel,omitempty"`
	Error       string                `json:"error,omitempty"`
}

PerfInfoV0 - Includes Drive and Net perf info for the entire MinIO cluster

type PolicyAssociationReq 

type PolicyAssociationReq struct {
	Policies []string `json:"policies"`

	// Exactly one of the following must be non-empty in a valid request.
	User  string `json:"user,omitempty"`
	Group string `json:"group,omitempty"`
}

PolicyAssociationReq - request to attach/detach policies from/to a user or group.

func (PolicyAssociationReq) IsValid 

func (p PolicyAssociationReq) IsValid() error

IsValid validates the object and returns a reason for when it is not.

type PolicyAssociationResp 

type PolicyAssociationResp struct {
	PoliciesAttached []string `json:"policiesAttached,omitempty"`
	PoliciesDetached []string `json:"policiesDetached,omitempty"`

	UpdatedAt time.Time `json:"updatedAt"`
}

PolicyAssociationResp - result of a policy association request.

type PolicyEntities 

type PolicyEntities struct {
	Policy string   `json:"policy"`
	Users  []string `json:"users"`
	Groups []string `json:"groups"`
}

PolicyEntities - policy -> user+group mapping

type PolicyEntitiesQuery 

type PolicyEntitiesQuery struct {
	Users  []string
	Groups []string
	Policy []string
}

PolicyEntitiesQuery - contains request info for policy entities query.

type PolicyEntitiesResult 

type PolicyEntitiesResult struct {
	Timestamp      time.Time             `json:"timestamp"`
	UserMappings   []UserPolicyEntities  `json:"userMappings,omitempty"`
	GroupMappings  []GroupPolicyEntities `json:"groupMappings,omitempty"`
	PolicyMappings []PolicyEntities      `json:"policyMappings,omitempty"`
}

PolicyEntitiesResult - contains response to a policy entities query.

type PolicyInfo 

type PolicyInfo struct {
	PolicyName string
	Policy     json.RawMessage
	CreateDate time.Time `json:",omitempty"`
	UpdateDate time.Time `json:",omitempty"`
}

PolicyInfo contains information on a policy.

func (PolicyInfo) MarshalJSON 

func (pi PolicyInfo) MarshalJSON() ([]byte, error)

MarshalJSON marshaller for JSON

type PoolDecommissionInfo 

type PoolDecommissionInfo struct {
	StartTime   time.Time `json:"startTime"`
	StartSize   int64     `json:"startSize"`
	TotalSize   int64     `json:"totalSize"`
	CurrentSize int64     `json:"currentSize"`
	Complete    bool      `json:"complete"`
	Failed      bool      `json:"failed"`
	Canceled    bool      `json:"canceled"`

	ObjectsDecommissioned     int64 `json:"objectsDecommissioned"`
	ObjectsDecommissionFailed int64 `json:"objectsDecommissionedFailed"`
	BytesDone                 int64 `json:"bytesDecommissioned"`
	BytesFailed               int64 `json:"bytesDecommissionedFailed"`
}

PoolDecommissionInfo currently draining information

type PoolInfo 

type PoolInfo struct {
	Index int `msg:"index"`
	Nodes struct {
		Total   int `msg:"total"`
		Offline int `msg:"offline"`
	} `msg:"nodes"`
	Drives struct {
		PerNodeTotal   int `msg:"perNode"`
		PerNodeOffline int `msg:"perNodeOffline"`
	}
	TotalSets   int `msg:"numberOfSets"`
	StripeSize  int `msg:"stripeSize"`
	WriteQuorum int `msg:"writeQuorum"`
	ReadQuorum  int `msg:"readQuorum"`

	// Optional value, not returned in ClusterInfo, PoolList API calls
	Hosts []string `msg:"hosts,omitempty"`
}

PoolInfo per pool specific information

func (*PoolInfo) DecodeMsg 

func (z *PoolInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*PoolInfo) EncodeMsg 

func (z *PoolInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*PoolInfo) MarshalMsg 

func (z *PoolInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*PoolInfo) Msgsize 

func (z *PoolInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*PoolInfo) UnmarshalMsg 

func (z *PoolInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type PoolInfoOpts 

type PoolInfoOpts struct{}

PoolInfoOpts ask for additional data from the server this is not used at the moment, kept here for future extensibility.

type PoolLayout added in v4.1.0 

type PoolLayout struct {
	Servers       int `json:"servers" msg:"s"`
	Drives        int `json:"drives" msg:"d"`
	DrivesOffline int `json:"drivesOffline" msg:"do"`
	DrivesHealing int `json:"drivesHealing" msg:"dh"`
}

PoolLayout ...

func (*PoolLayout) DecodeMsg added in v4.1.0 

func (z *PoolLayout) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*PoolLayout) EncodeMsg added in v4.1.0 

func (z *PoolLayout) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*PoolLayout) MarshalMsg added in v4.1.0 

func (z *PoolLayout) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*PoolLayout) Msgsize added in v4.1.0 

func (z *PoolLayout) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*PoolLayout) UnmarshalMsg added in v4.1.0 

func (z *PoolLayout) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type PoolResource added in v4.1.0 

type PoolResource struct {
	PoolIndex          int      `json:"poolindex" msg:"i"`
	StripeSize         int      `json:"stripeSize" msg:"ss"`
	TotalSets          int      `json:"totalSets" msg:"ts"`
	WriteQuorum        int      `json:"writeQuorum" msg:"wq"`
	ReadQuorum         int      `json:"readQuorum" msg:"rq"`
	Nodes              []string `json:"nodes,omitempty" msg:"n,omitempty"`
	DriveCount         int      `json:"driveCount" msg:"dc"`
	DrivesOnline       int      `json:"drivesOnline" msg:"do"`
	DrivesOffline      int      `json:"drivesOffline" msg:"doff"`
	DrivesHealing      int      `json:"drivesHealing" msg:"dh"`
	NodeCount          int      `json:"nodeCount" msg:"nc"`
	RawUsage           uint64   `json:"rawUsage" msg:"ru"`
	RawCapacity        uint64   `json:"rawCapacity" msg:"rc"`
	Usage              uint64   `json:"usage" msg:"u"`
	ObjectsCount       uint64   `json:"objectsCount" msg:"oc"`
	VersionsCount      uint64   `json:"versionsCount" msg:"vc"`
	DeleteMarkersCount uint64   `json:"deleteMarkersCount" msg:"dmc"`
}

PoolResource represents information about a storage pool

func (*PoolResource) DecodeMsg added in v4.1.0 

func (z *PoolResource) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*PoolResource) EncodeMsg added in v4.1.0 

func (z *PoolResource) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*PoolResource) MarshalMsg added in v4.1.0 

func (z *PoolResource) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*PoolResource) Msgsize added in v4.1.0 

func (z *PoolResource) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*PoolResource) UnmarshalMsg added in v4.1.0 

func (z *PoolResource) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type PoolStatus 

type PoolStatus struct {
	ID           int                   `json:"id"`
	CmdLine      string                `json:"cmdline"`
	LastUpdate   time.Time             `json:"lastUpdate"`
	Decommission *PoolDecommissionInfo `json:"decommissionInfo,omitempty"`
}

PoolStatus captures current pool status

type PoolsResourceOpts added in v4.1.0 

type PoolsResourceOpts struct {
	Limit  int
	Offset int
	Filter string
	// Sort fields contained in PoolResource.
	//
	// Example: PoolsResourceOpts.Sort = "PoolIndex"
	// Assuming the value of PoolIndex is of a supported value type.
	//
	// Supported Values Types: int, int8, int16, int32, int64, uint, uint8, uint16, uint32, uint64, float32, float64, string
	Sort string
	// SortReversed will only take effect if Sort is defined
	SortReversed bool
}

PoolsResourceOpts contains the available options for the PoolsQuery API

type ProcInfo 

type ProcInfo struct {
	NodeCommon

	PID            int32                      `json:"pid,omitempty"`
	IsBackground   bool                       `json:"is_background,omitempty"`
	CPUPercent     float64                    `json:"cpu_percent,omitempty"`
	ChildrenPIDs   []int32                    `json:"children_pids,omitempty"`
	CmdLine        string                     `json:"cmd_line,omitempty"`
	NumConnections int                        `json:"num_connections,omitempty"`
	CreateTime     int64                      `json:"create_time,omitempty"`
	CWD            string                     `json:"cwd,omitempty"`
	ExecPath       string                     `json:"exec_path,omitempty"`
	GIDs           []int32                    `json:"gids,omitempty"`
	IOCounters     process.IOCountersStat     `json:"iocounters,omitempty"`
	IsRunning      bool                       `json:"is_running,omitempty"`
	MemInfo        process.MemoryInfoStat     `json:"mem_info,omitempty"`
	MemMaps        []process.MemoryMapsStat   `json:"mem_maps,omitempty"`
	MemPercent     float32                    `json:"mem_percent,omitempty"`
	Name           string                     `json:"name,omitempty"`
	Nice           int32                      `json:"nice,omitempty"`
	NumCtxSwitches process.NumCtxSwitchesStat `json:"num_ctx_switches,omitempty"`
	NumFDs         int32                      `json:"num_fds,omitempty"`
	NumThreads     int32                      `json:"num_threads,omitempty"`
	PageFaults     process.PageFaultsStat     `json:"page_faults,omitempty"`
	PPID           int32                      `json:"ppid,omitempty"`
	Status         string                     `json:"status,omitempty"`
	TGID           int32                      `json:"tgid,omitempty"`
	Times          cpu.TimesStat              `json:"times,omitempty"`
	UIDs           []int32                    `json:"uids,omitempty"`
	Username       string                     `json:"username,omitempty"`
}

ProcInfo contains current process's information.

func GetProcInfo 

func GetProcInfo(ctx context.Context, addr string) ProcInfo

GetProcInfo returns current MinIO process information.

type ProductInfo 

type ProductInfo struct {
	NodeCommon

	Family       string `json:"family"`
	Name         string `json:"name"`
	Vendor       string `json:"vendor"`
	SerialNumber string `json:"serial_number"`
	UUID         string `json:"uuid"`
	SKU          string `json:"sku"`
	Version      string `json:"version"`
}

ProductInfo defines a host's product information

func GetProductInfo 

func GetProductInfo(addr string) ProductInfo

GetProductInfo returns a host's product information

type ProfilerType 

type ProfilerType string

ProfilerType represents the profiler type passed to the profiler subsystem. 

const (
	ProfilerCPU        ProfilerType = "cpu"        // represents CPU profiler type
	ProfilerCPUIO      ProfilerType = "cpuio"      // represents CPU with IO (fgprof) profiler type
	ProfilerMEM        ProfilerType = "mem"        // represents MEM profiler type
	ProfilerBlock      ProfilerType = "block"      // represents Block profiler type
	ProfilerMutex      ProfilerType = "mutex"      // represents Mutex profiler type
	ProfilerTrace      ProfilerType = "trace"      // represents Trace profiler type
	ProfilerThreads    ProfilerType = "threads"    // represents ThreadCreate profiler type
	ProfilerGoroutines ProfilerType = "goroutines" // represents Goroutine dumps.
	ProfilerRuntime    ProfilerType = "runtime"    // Include runtime metrics
)

Different supported profiler types.

type QStat 

type QStat struct {
	Count float64 `json:"count"`
	Bytes float64 `json:"bytes"`
}

QStat represents number of objects and bytes in queue

func (*QStat) Add 

func (q *QStat) Add(o QStat) QStat

Add two QStat

type QuotaType 

type QuotaType string

QuotaType represents bucket quota type 

const (
	// HardQuota specifies a hard quota of usage for bucket
	HardQuota QuotaType = "hard"
)

func (QuotaType) IsValid 

func (t QuotaType) IsValid() bool

IsValid returns true if quota type is one of Hard

type RPCMetrics 

type RPCMetrics struct {
	CollectedAt      time.Time `json:"collectedAt"`
	Connected        int       `json:"connected"`
	ReconnectCount   int       `json:"reconnectCount"`
	Disconnected     int       `json:"disconnected"`
	OutgoingStreams  int       `json:"outgoingStreams"`
	IncomingStreams  int       `json:"incomingStreams"`
	OutgoingBytes    int64     `json:"outgoingBytes"`
	IncomingBytes    int64     `json:"incomingBytes"`
	OutgoingMessages int64     `json:"outgoingMessages"`
	IncomingMessages int64     `json:"incomingMessages"`
	OutQueue         int       `json:"outQueue"`
	LastPongTime     time.Time `json:"lastPongTime"`
	LastPingMS       float64   `json:"lastPingMS"`
	MaxPingDurMS     float64   `json:"maxPingDurMS"` // Maximum across all merged entries.
	LastConnectTime  time.Time `json:"lastConnectTime"`

	ByDestination map[string]RPCMetrics `json:"byDestination,omitempty"`
	ByCaller      map[string]RPCMetrics `json:"byCaller,omitempty"`
}

RPCMetrics contains metrics for RPC operations.

func (*RPCMetrics) DecodeMsg 

func (z *RPCMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*RPCMetrics) EncodeMsg 

func (z *RPCMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*RPCMetrics) MarshalMsg 

func (z *RPCMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*RPCMetrics) Merge 

func (m *RPCMetrics) Merge(other *RPCMetrics)

Merge other into 'm'.

func (*RPCMetrics) Msgsize 

func (z *RPCMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RPCMetrics) UnmarshalMsg 

func (z *RPCMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type RStat 

type RStat struct {
	Count float64 `json:"count"`
	Bytes int64   `json:"bytes"`
}

RStat represents count and bytes replicated/failed

func (RStat) Add 

func (r RStat) Add(r1 RStat) RStat

Add - adds two RStats

func (*RStat) DecodeMsg 

func (z *RStat) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (RStat) EncodeMsg 

func (z RStat) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (RStat) MarshalMsg 

func (z RStat) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (RStat) Msgsize 

func (z RStat) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RStat) UnmarshalMsg 

func (z *RStat) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type RealtimeMetrics 

type RealtimeMetrics struct {
	// Error indicates an error occurred.
	Errors []string `json:"errors,omitempty"`

	// Hosts indicates the scanned hosts
	Hosts []string `json:"hosts"`

	// Aggregated contains aggregated metrics for all hosts
	Aggregated Metrics `json:"aggregated"`

	// ByHost contains metrics for each host if requested.
	ByHost map[string]Metrics `json:"by_host,omitempty"`

	// ByDisk contains metrics for each disk if requested.
	ByDisk map[string]DiskMetric `json:"by_disk,omitempty"`

	// Final indicates whether this is the final packet and the receiver can exit.
	Final bool `json:"final"`
}

RealtimeMetrics provides realtime metrics. This is intended to be expanded over time to cover more types.

func (*RealtimeMetrics) DecodeMsg 

func (z *RealtimeMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*RealtimeMetrics) EncodeMsg 

func (z *RealtimeMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*RealtimeMetrics) MarshalMsg 

func (z *RealtimeMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*RealtimeMetrics) Merge 

func (r *RealtimeMetrics) Merge(other *RealtimeMetrics)

Merge will merge other into r.

func (*RealtimeMetrics) Msgsize 

func (z *RealtimeMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RealtimeMetrics) UnmarshalMsg 

func (z *RealtimeMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type RebalPoolProgress 

type RebalPoolProgress struct {
	NumObjects  uint64        `json:"objects"`
	NumVersions uint64        `json:"versions"`
	Bytes       uint64        `json:"bytes"`
	Bucket      string        `json:"bucket"`
	Object      string        `json:"object"`
	Elapsed     time.Duration `json:"elapsed"`
	ETA         time.Duration `json:"eta"`
}

RebalPoolProgress contains metrics like number of objects, versions, etc rebalanced so far.

type RebalancePoolStatus 

type RebalancePoolStatus struct {
	ID       int               `json:"id"`                 // Pool index (zero-based)
	Status   string            `json:"status"`             // Active if rebalance is running, empty otherwise
	Used     float64           `json:"used"`               // Percentage used space
	Progress RebalPoolProgress `json:"progress,omitempty"` // is empty when rebalance is not running
}

RebalancePoolStatus contains metrics of a rebalance operation on a given pool

type RebalanceStatus 

type RebalanceStatus struct {
	ID        string                // identifies the ongoing rebalance operation by a uuid
	StoppedAt time.Time             `json:"stoppedAt,omitempty"`
	Pools     []RebalancePoolStatus `json:"pools"` // contains all pools, including inactive
}

RebalanceStatus contains metrics and progress related information on all pools

type RejectedAPIStats added in v4.2.9 

type RejectedAPIStats struct {
	Auth           int64 `json:"auth,omitempty"`           // Total number of rejected authentication requests.
	RequestsTime   int64 `json:"requestsTime,omitempty"`   // Requests that were rejected due to outdated request signature.
	Header         int64 `json:"header,omitempty"`         // Requests that were rejected due to header signature.
	Invalid        int64 `json:"invalid,omitempty"`        // Requests that were rejected due to invalid request signature.
	NotImplemented int64 `json:"notImplemented,omitempty"` // Requests that were rejected due to not implemented API.
}

RejectedAPIStats contains statistics for rejected requests.

func (*RejectedAPIStats) DecodeMsg added in v4.2.9 

func (z *RejectedAPIStats) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*RejectedAPIStats) EncodeMsg added in v4.2.9 

func (z *RejectedAPIStats) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*RejectedAPIStats) MarshalMsg added in v4.2.9 

func (z *RejectedAPIStats) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*RejectedAPIStats) Msgsize added in v4.2.9 

func (z *RejectedAPIStats) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RejectedAPIStats) UnmarshalMsg added in v4.2.9 

func (z *RejectedAPIStats) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type RemoveAzureCannedPolicyReq added in v4.2.13 

type RemoveAzureCannedPolicyReq struct {
	Name       string
	ConfigName string
}

RemoveAzureCannedPolicyReq represents a request to remove an Azure canned policy.

func (*RemoveAzureCannedPolicyReq) Validate added in v4.2.13 

func (r *RemoveAzureCannedPolicyReq) Validate() error

type RemoveTierOpts 

type RemoveTierOpts struct {
	Force bool
}

RemoveTierOpts - options for a remote tiering removal

type ReplDiagBucket 

type ReplDiagBucket struct {
	Name               string                          `json:"name,omitempty"`
	MetadataMismatches map[string]SRBucketStatsSummary `json:"metadata_mismatches,omitempty"`
	Targets            []BucketReplTarget              `json:"targets,omitempty"`
}

ReplDiagBucket represents the replication target information for a bucket

type ReplDiagBucketV2 added in v4.0.18 

type ReplDiagBucketV2 struct {
	Name               string               `json:"name,omitempty"`
	MetadataMismatches SRBucketStatsSummary `json:"metadata_mismatches,omitempty"`
	Targets            []BucketReplTarget   `json:"targets,omitempty"`
}

ReplDiagBucketV2 represents the replication target information for a bucket

type ReplDiagInfo 

type ReplDiagInfo struct {
	Error                  string                                     `json:"error,omitempty"`
	SREnabled              bool                                       `json:"site_replication_enabled"`
	TotalUsers             int                                        `json:"total_users,omitempty"`
	SyncPendingUsers       int                                        `json:"sync_pending_users,omitempty"`
	TotalGroups            int                                        `json:"total_groups,omitempty"`
	SyncPendingGroups      int                                        `json:"sync_pending_groups,omitempty"`
	TotalPolicies          int                                        `json:"total_policies,omitempty"`
	SyncPendingPolicies    int                                        `json:"sync_pending_policies,omitempty"`
	TotalILMExpRules       int                                        `json:"total_ilm_exp_rules,omitempty"`
	SyncPendingILMExpRules int                                        `json:"sync_pending_ilm_exp_rules,omitempty"`
	TotalBuckets           int                                        `json:"total_buckets,omitempty"`
	SyncPendingBuckets     int                                        `json:"sync_pending_buckets,omitempty"`
	Errors                 Counter                                    `json:"errors,omitempty"`
	Retries                Counter                                    `json:"retries,omitempty"`
	Sites                  []ReplDiagSite                             `json:"sites,omitempty"`
	ReplBuckets            []ReplDiagBucket                           `json:"repl_buckets,omitempty"`
	UserPolMismatches      map[string]map[string]SRPolicyStatsSummary `json:"user_policy_mismatches,omitempty"`
	GroupPolMismatches     map[string]map[string]SRGroupStatsSummary  `json:"group_policy_mismatches,omitempty"`
}

ReplDiagInfo represents the replication diagnostic information to be captured as part of health diagnostic information

type ReplDiagInfoV2 added in v4.0.18 

type ReplDiagInfoV2 struct {
	Error                  string                          `json:"error,omitempty"`
	SREnabled              bool                            `json:"site_replication_enabled"`
	TotalUsers             int                             `json:"total_users,omitempty"`
	SyncPendingUsers       CountWithList                   `json:"sync_pending_users,omitempty"`
	TotalGroups            int                             `json:"total_groups,omitempty"`
	SyncPendingGroups      CountWithList                   `json:"sync_pending_groups,omitempty"`
	TotalPolicies          int                             `json:"total_policies,omitempty"`
	SyncPendingPolicies    CountWithList                   `json:"sync_pending_policies,omitempty"`
	TotalILMExpRules       int                             `json:"total_ilm_exp_rules,omitempty"`
	SyncPendingILMExpRules CountWithList                   `json:"sync_pending_ilm_exp_rules,omitempty"`
	TotalBuckets           int                             `json:"total_buckets,omitempty"`
	SyncPendingBuckets     CountWithList                   `json:"sync_pending_buckets,omitempty"`
	Errors                 Counter                         `json:"errors,omitempty"`
	Retries                Counter                         `json:"retries,omitempty"`
	Sites                  []ReplDiagSite                  `json:"sites,omitempty"`
	ReplBuckets            []ReplDiagBucketV2              `json:"repl_buckets,omitempty"`
	UserPolMismatches      map[string]SRPolicyStatsSummary `json:"user_policy_mismatches,omitempty"`
	GroupPolMismatches     map[string]SRGroupStatsSummary  `json:"group_policy_mismatches,omitempty"`
}

ReplDiagInfoV2 represents the replication diagnostic information to be captured as part of health diagnostic information

type ReplDiagSite 

type ReplDiagSite struct {
	Addr         string `json:"addr,omitempty"`
	DeploymentID string `json:"deployment_id"`
	Online       bool   `json:"online"`
}

ReplDiagSite represents the replication site information

type ReplDiffOpts 

type ReplDiffOpts struct {
	ARN     string
	Verbose bool
	Prefix  string
}

ReplDiffOpts holds options for `mc replicate diff` command

type ReplProxyMetric 

type ReplProxyMetric struct {
	PutTagTotal       uint64 `json:"putTaggingProxyTotal" msg:"ptc"`
	GetTagTotal       uint64 `json:"getTaggingProxyTotal" msg:"gtc"`
	RmvTagTotal       uint64 `json:"removeTaggingProxyTotal" msg:"rtc"`
	GetTotal          uint64 `json:"getProxyTotal" msg:"gc"`
	HeadTotal         uint64 `json:"headProxyTotal" msg:"hc"`
	PutTagFailedTotal uint64 `json:"putTaggingProxyFailed" msg:"ptc"`
	GetTagFailedTotal uint64 `json:"getTaggingProxyFailed" msg:"gtc"`
	RmvTagFailedTotal uint64 `json:"removeTaggingProxyFailed" msg:"rtc"`
	GetFailedTotal    uint64 `json:"getProxyFailed" msg:"gc"`
	HeadFailedTotal   uint64 `json:"headProxyFailed" msg:"hc"`
}

ReplProxyMetric holds stats for replication proxying

func (*ReplProxyMetric) Add 

func (p *ReplProxyMetric) Add(p2 ReplProxyMetric)

Add updates proxy metrics

type ReplicateAddStatus 

type ReplicateAddStatus struct {
	Success                 bool   `json:"success"`
	Status                  string `json:"status"`
	ErrDetail               string `json:"errorDetail,omitempty"`
	InitialSyncErrorMessage string `json:"initialSyncErrorMessage,omitempty"`
}

ReplicateAddStatus - returns status of add request.

type ReplicateEditStatus 

type ReplicateEditStatus struct {
	Success   bool   `json:"success"`
	Status    string `json:"status"`
	ErrDetail string `json:"errorDetail,omitempty"`
}

ReplicateEditStatus - returns status of edit request.

type ReplicateInfo 

type ReplicateInfo struct {
	// Last bucket/object batch replicated
	Bucket string `json:"lastBucket"`
	Object string `json:"lastObject"`

	// Verbose information
	Objects             int64 `json:"objects"`
	ObjectsFailed       int64 `json:"objectsFailed"`
	DeleteMarkers       int64 `json:"deleteMarkers"`
	DeleteMarkersFailed int64 `json:"deleteMarkersFailed"`
	BytesTransferred    int64 `json:"bytesTransferred"`
	BytesFailed         int64 `json:"bytesFailed"`
}

func (*ReplicateInfo) DecodeMsg 

func (z *ReplicateInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ReplicateInfo) EncodeMsg 

func (z *ReplicateInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ReplicateInfo) MarshalMsg 

func (z *ReplicateInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ReplicateInfo) Msgsize 

func (z *ReplicateInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ReplicateInfo) UnmarshalMsg 

func (z *ReplicateInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ReplicateRemoveStatus 

type ReplicateRemoveStatus struct {
	Status     string `json:"status"`
	ErrDetail  string `json:"errorDetail,omitempty"`
	APIVersion string `json:"apiVersion,omitempty"`
}

ReplicateRemoveStatus - returns status of unlink request.

type ReplicationMRF 

type ReplicationMRF struct {
	NodeName   string `json:"nodeName" msg:"n"`
	Bucket     string `json:"bucket" msg:"b"`
	Object     string `json:"object" msg:"o"`
	VersionID  string `json:"versionId" msg:"v"`
	RetryCount int    `json:"retryCount" msg:"rc"`
	Err        string `json:"error,omitempty" msg:"err"`
}

ReplicationMRF represents MRF backlog for a bucket

func (*ReplicationMRF) DecodeMsg 

func (z *ReplicationMRF) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ReplicationMRF) EncodeMsg 

func (z *ReplicationMRF) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ReplicationMRF) MarshalMsg 

func (z *ReplicationMRF) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ReplicationMRF) Msgsize 

func (z *ReplicationMRF) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ReplicationMRF) UnmarshalMsg 

func (z *ReplicationMRF) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Report 

type Report struct {
	Report BucketBandwidthReport `json:"report"`
	Err    error                 `json:"error,omitempty"`
}

Report includes the bandwidth report or the error encountered.

type RequestData 

type RequestData struct {
	CustomHeaders http.Header
	QueryValues   url.Values
	RelPath       string // URL path relative to admin API base endpoint
	Content       []byte
}

RequestData exposing internal data structure requestData

type ResyncBucketStatus 

type ResyncBucketStatus struct {
	Bucket    string `json:"bucket"`
	Status    string `json:"status"`
	ErrDetail string `json:"errorDetail,omitempty"`
}

type RevokeTokensReq 

type RevokeTokensReq struct {
	User            string `json:"user"`
	TokenRevokeType string `json:"tokenRevokeType"`
	FullRevoke      bool   `json:"fullRevoke"`
}

RevokeTokensReq is the request options of the revoke tokens admin call. If User is empty, the requestor's tokens are revoked. If requestor is STS, leaving TokenRevokeType empty revokes requestor's type of tokens.

func (*RevokeTokensReq) Validate 

func (r *RevokeTokensReq) Validate() error

type RuntimeMetrics 

type RuntimeMetrics struct {
	// UintMetrics contains KindUint64 values
	UintMetrics map[string]uint64 `json:"uintMetrics,omitempty"`

	// FloatMetrics contains KindFloat64 values
	FloatMetrics map[string]float64 `json:"floatMetrics,omitempty"`

	// HistMetrics contains KindFloat64Histogram values
	HistMetrics map[string]metrics.Float64Histogram `json:"histMetrics,omitempty"`

	// N tracks the number of merged entries.
	N int `json:"n"`
}

RuntimeMetrics contains metrics for the go runtime. See more at https://pkg.go.dev/runtime/metrics

func (*RuntimeMetrics) DecodeMsg 

func (z *RuntimeMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*RuntimeMetrics) EncodeMsg 

func (z *RuntimeMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*RuntimeMetrics) MarshalMsg 

func (z *RuntimeMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*RuntimeMetrics) Merge 

func (m *RuntimeMetrics) Merge(other *RuntimeMetrics)

Merge other into 'm'.

func (*RuntimeMetrics) Msgsize 

func (z *RuntimeMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*RuntimeMetrics) UnmarshalMsg 

func (z *RuntimeMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type S3Options 

type S3Options func(*TierS3) error

S3Options supports NewTierS3 to take variadic options

type SRAddOptions 

type SRAddOptions struct {
	ReplicateILMExpiry bool
	Force              bool
}

SRAddOptions holds SR Add options

type SRBucketInfo 

type SRBucketInfo struct {
	Bucket string          `json:"bucket"`
	Policy json.RawMessage `json:"policy,omitempty"`

	// Since Versioning config does not have a json representation, we use
	// xml byte presentation directly.
	Versioning *string `json:"versioningConfig,omitempty"`

	// Since tags does not have a json representation, we use its xml byte
	// representation directly.
	Tags *string `json:"tags,omitempty"`

	// Since object lock does not have a json representation, we use its xml
	// byte representation.
	ObjectLockConfig *string `json:"objectLockConfig,omitempty"`

	// Since SSE config does not have a json representation, we use its xml
	// byte respresentation.
	SSEConfig *string `json:"sseConfig,omitempty"`
	// replication config in json representation
	ReplicationConfig *string `json:"replicationConfig,omitempty"`
	// quota config in json representation
	QuotaConfig *string `json:"quotaConfig,omitempty"`

	// Since Expiry Licfecycle config does not have a json representation, we use its xml
	// byte representation
	ExpiryLCConfig *string `json:"expLCConfig,omitempty"`

	CorsConfig *string `json:"corsConfig,omitempty"`

	// time stamps of bucket metadata updates
	PolicyUpdatedAt            time.Time `json:"policyTimestamp,omitempty"`
	TagConfigUpdatedAt         time.Time `json:"tagTimestamp,omitempty"`
	ObjectLockConfigUpdatedAt  time.Time `json:"olockTimestamp,omitempty"`
	SSEConfigUpdatedAt         time.Time `json:"sseTimestamp,omitempty"`
	VersioningConfigUpdatedAt  time.Time `json:"versioningTimestamp,omitempty"`
	ReplicationConfigUpdatedAt time.Time `json:"replicationConfigTimestamp,omitempty"`
	QuotaConfigUpdatedAt       time.Time `json:"quotaTimestamp,omitempty"`
	ExpiryLCConfigUpdatedAt    time.Time `json:"expLCTimestamp,omitempty"`
	CreatedAt                  time.Time `json:"bucketTimestamp,omitempty"`
	DeletedAt                  time.Time `json:"bucketDeletedTimestamp,omitempty"`
	CorsConfigUpdatedAt        time.Time `json:"corsTimestamp,omitempty"`
	Location                   string    `json:"location,omitempty"`
	APIVersion                 string    `json:"apiVersion,omitempty"`
}

SRBucketInfo - returns all the bucket metadata available for bucket

type SRBucketMeta 

type SRBucketMeta struct {
	Type   string          `json:"type"`
	Bucket string          `json:"bucket"`
	Policy json.RawMessage `json:"policy,omitempty"`

	// Since Versioning config does not have a json representation, we use
	// xml byte presentation directly.
	Versioning *string `json:"versioningConfig,omitempty"`

	// Since tags does not have a json representation, we use its xml byte
	// representation directly.
	Tags *string `json:"tags,omitempty"`

	// Since object lock does not have a json representation, we use its xml
	// byte representation.
	ObjectLockConfig *string `json:"objectLockConfig,omitempty"`

	// Since SSE config does not have a json representation, we use its xml
	// byte respresentation.
	SSEConfig *string `json:"sseConfig,omitempty"`

	// Quota has a json representation use it as is.
	Quota json.RawMessage `json:"quota,omitempty"`

	// Since Expiry Lifecycle config does not have a json representation, we use its xml
	// byte respresentation.
	ExpiryLCConfig *string `json:"expLCConfig,omitempty"`

	// UpdatedAt - timestamp of last update
	UpdatedAt time.Time `json:"updatedAt,omitempty"`

	// ExpiryUpdatedAt - timestamp of last update of expiry rule
	ExpiryUpdatedAt time.Time `json:"expiryUpdatedAt,omitempty"`

	// Cors is base64 XML representation of CORS config
	Cors       *string `json:"cors,omitempty"`
	APIVersion string  `json:"apiVersion,omitempty"`
}

SRBucketMeta - represents a bucket metadata change that will be copied to a peer.

type SRBucketStatsSummary 

type SRBucketStatsSummary struct {
	DeploymentID             string
	HasBucket                bool
	BucketMarkedDeleted      bool
	TagMismatch              bool
	VersioningConfigMismatch bool
	OLockConfigMismatch      bool
	PolicyMismatch           bool
	SSEConfigMismatch        bool
	ReplicationCfgMismatch   bool
	QuotaCfgMismatch         bool
	CorsCfgMismatch          bool
	HasTagsSet               bool
	HasOLockConfigSet        bool
	HasPolicySet             bool
	HasSSECfgSet             bool
	HasReplicationCfg        bool
	HasQuotaCfgSet           bool
	HasCorsCfgSet            bool
	APIVersion               string
}

SRBucketStatsSummary has status of bucket metadata replication misses

type SRCredInfo 

type SRCredInfo struct {
	AccessKey string `json:"accessKey"`

	// This type corresponds to github.com/minio/minio/cmd.IAMUserType
	IAMUserType int `json:"iamUserType"`

	IsDeleteReq bool `json:"isDeleteReq,omitempty"`

	// This is the JSON encoded value of github.com/minio/minio/cmd.UserIdentity
	UserIdentityJSON json.RawMessage `json:"userIdentityJSON"`
	APIVersion       string          `json:"apiVersion,omitempty"`
}

SRCredInfo - represents a credential change (create/update/delete) to be replicated. This replaces `SvcAccChange`, `STSCredential` and `IAMUser` and will DEPRECATE them.

type SREditOptions 

type SREditOptions struct {
	DisableILMExpiryReplication bool
	EnableILMExpiryReplication  bool
}

SREditOptions holds SR Edit options

type SREntityType 

type SREntityType int

SREntityType specifies type of entity 

const (
	// Unspecified entity
	Unspecified SREntityType = iota

	// SRBucketEntity Bucket entity type
	SRBucketEntity

	// SRPolicyEntity Policy entity type
	SRPolicyEntity

	// SRUserEntity User entity type
	SRUserEntity

	// SRGroupEntity Group entity type
	SRGroupEntity

	// SRILMExpiryRuleEntity ILM expiry rule entity type
	SRILMExpiryRuleEntity
)

func GetSREntityType 

func GetSREntityType(name string) SREntityType

GetSREntityType returns the SREntityType for a key

type SRExternalUser 

type SRExternalUser struct {
	APIVersion  string `json:"apiVersion,omitempty"`
	Name        string `json:"name"`
	IsDeleteReq bool   `json:"isDeleteReq"`

	OpenIDUser *OpenIDUser `json:"openIDUser,omitempty"`
}

SRExternalUser - represents an external user information to be replicated.

type SRGroupInfo 

type SRGroupInfo struct {
	UpdateReq  GroupAddRemove `json:"updateReq"`
	APIVersion string         `json:"apiVersion,omitempty"`
}

SRGroupInfo - represents a regular (IAM) user to be replicated.

type SRGroupStatsSummary 

type SRGroupStatsSummary struct {
	DeploymentID      string
	PolicyMismatch    bool
	HasGroup          bool
	GroupDescMismatch bool
	HasPolicyMapping  bool
	APIVersion        string
}

SRGroupStatsSummary has status of group replication misses

type SRIAMItem 

type SRIAMItem struct {
	Type string `json:"type"`

	// Name and Policy below are used when Type == SRIAMItemPolicy
	Name   string          `json:"name"`
	Policy json.RawMessage `json:"policy"`

	// Used when Type == SRIAMItemPolicyMapping
	PolicyMapping *SRPolicyMapping `json:"policyMapping"`

	// Used when Type = SRIAMItemGroupInfo
	GroupInfo *SRGroupInfo `json:"groupInfo"`

	// Used when Type = SRIAMItemCredential
	CredentialInfo *SRCredInfo `json:"credentialChange"`

	// Used when Type == SRIAMItemSvcAcc
	SvcAccChange *SRSvcAccChange `json:"serviceAccountChange"`

	// Used when Type = SRIAMItemSTSAcc
	STSCredential *SRSTSCredential `json:"stsCredential"`

	// Used when Type = SRIAMItemIAMUser
	IAMUser *SRIAMUser `json:"iamUser"`

	// Used when Type = SRIAMItemExternalUser
	ExternalUser *SRExternalUser `json:"externalUser"`

	// UpdatedAt - timestamp of last update
	UpdatedAt  time.Time `json:"updatedAt,omitempty"`
	APIVersion string    `json:"apiVersion,omitempty"`
}

SRIAMItem - represents an IAM object that will be copied to a peer.

type SRIAMPolicy 

type SRIAMPolicy struct {
	Policy     json.RawMessage `json:"policy"`
	UpdatedAt  time.Time       `json:"updatedAt,omitempty"`
	APIVersion string          `json:"apiVersion,omitempty"`
}

SRIAMPolicy - represents an IAM policy.

type SRIAMUser 

type SRIAMUser struct {
	AccessKey   string              `json:"accessKey"`
	IsDeleteReq bool                `json:"isDeleteReq"`
	UserReq     *AddOrUpdateUserReq `json:"userReq"`
	APIVersion  string              `json:"apiVersion,omitempty"`
}

SRIAMUser - represents a regular (IAM) user to be replicated. A nil UserReq implies that a user delete operation should be replicated on the peer cluster.

type SRILMExpiryStatsSummary 

type SRILMExpiryStatsSummary struct {
	DeploymentID          string
	ILMExpiryRuleMismatch bool
	HasILMExpiryRules     bool
	APIVersion            string
}

SRILMExpiryStatsSummary has status of ILM Expiry rules metadata replication misses

type SRInfo 

type SRInfo struct {
	Enabled        bool
	Name           string
	DeploymentID   string
	Buckets        map[string]SRBucketInfo       // map of bucket metadata info
	Policies       map[string]SRIAMPolicy        // map of IAM policy name to content
	UserPolicies   map[string]SRPolicyMapping    // map of username -> user policy mapping
	UserInfoMap    map[string]UserInfo           // map of user name to UserInfo
	GroupDescMap   map[string]GroupDesc          // map of group name to GroupDesc
	GroupPolicies  map[string]SRPolicyMapping    // map of groupname -> group policy mapping
	ReplicationCfg map[string]replication.Config // map of bucket -> replication config
	ILMExpiryRules map[string]ILMExpiryRule      // map of ILM Expiry rule to content
	State          SRStateInfo                   // peer state
	APIVersion     string                        `json:"apiVersion,omitempty"`
}

SRInfo gets replication metadata for a site

type SRMetric 

type SRMetric struct {
	DeploymentID  string        `json:"deploymentID"`
	Endpoint      string        `json:"endpoint"`
	TotalDowntime time.Duration `json:"totalDowntime"`
	LastOnline    time.Time     `json:"lastOnline"`
	Online        bool          `json:"isOnline"`

	Latency LatencyStat `json:"latency"`

	// replication metrics across buckets roll up
	ReplicatedSize int64 `json:"replicatedSize"`
	// Total number of completed operations
	ReplicatedCount int64 `json:"replicatedCount"`
	// ReplicationErrorStats captures replication errors
	Failed TimedErrStats `json:"failed,omitempty"`
	// XferStats captures transfer stats
	XferStats map[replication.MetricName]replication.XferStats `json:"transferSummary"`
	// MRFStats captures current backlog entries in the last 5 minutes
	MRFStats replication.ReplMRFStats `json:"mrfStats"`
	// DowntimeInfo captures the link information
	DowntimeInfo DowntimeInfo `json:"downtimeInfo"`
}

SRMetric - captures replication metrics for a site replication peer

type SRMetricsSummary 

type SRMetricsSummary struct {
	// op metrics roll up
	ActiveWorkers WorkerStat `json:"activeWorkers"`
	// Total Replica size in bytes
	ReplicaSize int64 `json:"replicaSize"`
	// Total count of replica received
	ReplicaCount int64 `json:"replicaCount"`
	// queue metrics
	Queued InQueueMetric `json:"queued"`
	// in progress metrics
	InProgress InProgressMetric `json:"inProgress"`
	// proxied metrics
	Proxied ReplProxyMetric `json:"proxied"`
	// replication metrics summary for each site replication peer
	Metrics map[string]SRMetric `json:"replMetrics"`
	// uptime of node being queried for site replication metrics
	Uptime int64 `json:"uptime"`
	// represents the retry count
	Retries Counter `json:"retries"`
	// represents the error count
	Errors Counter `json:"errors"`
}

SRMetricsSummary captures summary of replication counts across buckets on site along with op metrics rollup.

type SRPeerJoinReq 

type SRPeerJoinReq struct {
	SvcAcctAccessKey string              `json:"svcAcctAccessKey"`
	SvcAcctSecretKey string              `json:"svcAcctSecretKey"`
	SvcAcctParent    string              `json:"svcAcctParent"`
	Peers            map[string]PeerInfo `json:"peers"`
	UpdatedAt        time.Time           `json:"updatedAt"`
}

SRPeerJoinReq - arg body for SRPeerJoin

type SRPolicyMapping 

type SRPolicyMapping struct {
	UserOrGroup string    `json:"userOrGroup"`
	UserType    int       `json:"userType"`
	IsGroup     bool      `json:"isGroup"`
	Policy      string    `json:"policy"`
	CreatedAt   time.Time `json:"createdAt,omitempty"`
	UpdatedAt   time.Time `json:"updatedAt,omitempty"`
	APIVersion  string    `json:"apiVersion,omitempty"`
}

SRPolicyMapping - represents mapping of a policy to a user or group.

type SRPolicyStatsSummary 

type SRPolicyStatsSummary struct {
	DeploymentID   string
	PolicyMismatch bool
	HasPolicy      bool
	APIVersion     string
}

SRPolicyStatsSummary has status of policy replication misses

type SRRemoveReq 

type SRRemoveReq struct {
	RequestingDepID string   `json:"requestingDepID"`
	SiteNames       []string `json:"sites"`
	RemoveAll       bool     `json:"all"` // true if all sites are to be removed.
}

SRRemoveReq - arg body for SRRemoveReq

type SRResyncOpStatus 

type SRResyncOpStatus struct {
	OpType    string               `json:"op"` // one of "start" or "cancel"
	ResyncID  string               `json:"id"`
	Status    string               `json:"status"`
	Buckets   []ResyncBucketStatus `json:"buckets"`
	ErrDetail string               `json:"errorDetail,omitempty"`
}

SRResyncOpStatus - returns status of resync start request.

type SRSTSCredential 

type SRSTSCredential struct {
	AccessKey           string `json:"accessKey"`
	SecretKey           string `json:"secretKey"`
	SessionToken        string `json:"sessionToken"`
	ParentUser          string `json:"parentUser"`
	ParentPolicyMapping string `json:"parentPolicyMapping,omitempty"`
	APIVersion          string `json:"apiVersion,omitempty"`
}

SRSTSCredential - represents an STS credential to be replicated.

type SRSessionPolicy 

type SRSessionPolicy json.RawMessage

SRSessionPolicy - represents a session policy to be replicated.

func (SRSessionPolicy) MarshalJSON 

func (s SRSessionPolicy) MarshalJSON() ([]byte, error)

func (*SRSessionPolicy) UnmarshalJSON 

func (s *SRSessionPolicy) UnmarshalJSON(data []byte) error

type SRSiteSummary 

type SRSiteSummary struct {
	ReplicatedBuckets             int // count of buckets replicated across sites
	ReplicatedTags                int // count of buckets with tags replicated across sites
	ReplicatedBucketPolicies      int // count of policies replicated across sites
	ReplicatedIAMPolicies         int // count of IAM policies replicated across sites
	ReplicatedUsers               int // count of users replicated across sites
	ReplicatedGroups              int // count of groups replicated across sites
	ReplicatedLockConfig          int // count of object lock config replicated across sites
	ReplicatedSSEConfig           int // count of SSE config replicated across sites
	ReplicatedVersioningConfig    int // count of versioning config replicated across sites
	ReplicatedQuotaConfig         int // count of bucket with quota config replicated across sites
	ReplicatedUserPolicyMappings  int // count of user policy mappings replicated across sites
	ReplicatedGroupPolicyMappings int // count of group policy mappings replicated across sites
	ReplicatedILMExpiryRules      int // count of ILM expiry rules replicated across sites
	ReplicatedCorsConfig          int // count of CORS config replicated across sites

	TotalBucketsCount            int // total buckets on this site
	TotalTagsCount               int // total count of buckets with tags on this site
	TotalBucketPoliciesCount     int // total count of buckets with bucket policies for this site
	TotalIAMPoliciesCount        int // total count of IAM policies for this site
	TotalLockConfigCount         int // total count of buckets with object lock config for this site
	TotalSSEConfigCount          int // total count of buckets with SSE config
	TotalVersioningConfigCount   int // total count of bucekts with versioning config
	TotalQuotaConfigCount        int // total count of buckets with quota config
	TotalUsersCount              int // total number of users seen on this site
	TotalGroupsCount             int // total number of groups seen on this site
	TotalUserPolicyMappingCount  int // total number of user policy mappings seen on this site
	TotalGroupPolicyMappingCount int // total number of group policy mappings seen on this site
	TotalILMExpiryRulesCount     int // total number of ILM expiry rules seen on the site
	TotalCorsConfigCount         int // total number of CORS config seen on the site
	APIVersion                   string
}

SRSiteSummary holds the count of replicated items in site replication

type SRStateEditReq 

type SRStateEditReq struct {
	Peers     map[string]PeerInfo `json:"peers"`
	UpdatedAt time.Time           `json:"updatedAt"`
}

SRStateEditReq - arg body for SRStateEditReq

type SRStateInfo 

type SRStateInfo struct {
	Name       string              `json:"name"`
	Peers      map[string]PeerInfo `json:"peers"`
	UpdatedAt  time.Time           `json:"updatedAt"`
	APIVersion string              `json:"apiVersion,omitempty"`
}

SRStateInfo - site replication state information

type SRStatusInfo 

type SRStatusInfo struct {
	Enabled           bool
	MaxBuckets        int                      // maximum buckets seen across sites
	MaxUsers          int                      // maximum users seen across sites
	MaxGroups         int                      // maximum groups seen across sites
	MaxPolicies       int                      // maximum policies across sites
	MaxILMExpiryRules int                      // maxmimum ILM Expiry rules across sites
	Sites             map[string]PeerInfo      // deployment->sitename
	StatsSummary      map[string]SRSiteSummary // map of deployment id -> site stat
	// BucketStats map of bucket to slice of deployment IDs with stats. This is populated only if there are
	// mismatches or if a specific bucket's stats are requested
	BucketStats map[string]map[string]SRBucketStatsSummary
	// PolicyStats map of policy to slice of deployment IDs with stats. This is populated only if there are
	// mismatches or if a specific bucket's stats are requested
	PolicyStats map[string]map[string]SRPolicyStatsSummary
	// UserStats map of user to slice of deployment IDs with stats. This is populated only if there are
	// mismatches or if a specific bucket's stats are requested
	UserStats map[string]map[string]SRUserStatsSummary
	// GroupStats map of group to slice of deployment IDs with stats. This is populated only if there are
	// mismatches or if a specific bucket's stats are requested
	GroupStats map[string]map[string]SRGroupStatsSummary
	// Metrics summary of SRMetrics
	Metrics SRMetricsSummary // metrics summary. This is populated if buckets/bucket entity requested
	// ILMExpiryStats map of ILM Expiry rules to slice of deployment IDs with stats. This is populated if there
	// are mismatches or if a specific ILM expiry rule's stats are requested
	ILMExpiryStats map[string]map[string]SRILMExpiryStatsSummary
	APIVersion     string `json:"apiVersion,omitempty"`
}

SRStatusInfo returns detailed status on site replication status

type SRStatusOptions 

type SRStatusOptions struct {
	Buckets        bool
	Policies       bool
	Users          bool
	Groups         bool
	Metrics        bool
	ILMExpiryRules bool
	PeerState      bool
	Entity         SREntityType
	EntityValue    string
	ShowDeleted    bool
	APIVersion     string
}

SRStatusOptions holds SR status options

func (*SRStatusOptions) IsEntitySet 

func (o *SRStatusOptions) IsEntitySet() bool

IsEntitySet returns true if entity option is set

type SRSvcAccChange 

type SRSvcAccChange struct {
	Create     *SRSvcAccCreate `json:"crSvcAccCreate"`
	Update     *SRSvcAccUpdate `json:"crSvcAccUpdate"`
	Delete     *SRSvcAccDelete `json:"crSvcAccDelete"`
	APIVersion string          `json:"apiVersion,omitempty"`
}

SRSvcAccChange - sum-type to represent an svc account change.

type SRSvcAccCreate 

type SRSvcAccCreate struct {
	Parent        string                 `json:"parent"`
	AccessKey     string                 `json:"accessKey"`
	SecretKey     string                 `json:"secretKey"`
	Groups        []string               `json:"groups"`
	Claims        map[string]interface{} `json:"claims"`
	SessionPolicy SRSessionPolicy        `json:"sessionPolicy"`
	Status        string                 `json:"status"`
	Name          string                 `json:"name"`
	Description   string                 `json:"description"`
	Expiration    *time.Time             `json:"expiration,omitempty"`
	APIVersion    string                 `json:"apiVersion,omitempty"`
}

SRSvcAccCreate - create operation

type SRSvcAccDelete 

type SRSvcAccDelete struct {
	AccessKey  string `json:"accessKey"`
	APIVersion string `json:"apiVersion,omitempty"`
}

SRSvcAccDelete - delete operation

type SRSvcAccUpdate 

type SRSvcAccUpdate struct {
	AccessKey     string          `json:"accessKey"`
	SecretKey     string          `json:"secretKey"`
	Status        string          `json:"status"`
	Name          string          `json:"name"`
	Description   string          `json:"description"`
	SessionPolicy SRSessionPolicy `json:"sessionPolicy"`
	Expiration    *time.Time      `json:"expiration,omitempty"`
	APIVersion    string          `json:"apiVersion,omitempty"`
}

SRSvcAccUpdate - update operation

type SRUserStatsSummary 

type SRUserStatsSummary struct {
	DeploymentID     string
	PolicyMismatch   bool
	UserInfoMismatch bool
	HasUser          bool
	HasPolicyMapping bool
	APIVersion       string
}

SRUserStatsSummary has status of user replication misses

type ScannerMetrics 

type ScannerMetrics struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`

	// Number of buckets currently scanning
	OngoingBuckets int `json:"ongoing_buckets"`

	// Stats per bucket, a map between bucket name and scan stats in all erasure sets
	PerBucketStats map[string][]BucketScanInfo `json:"per_bucket_stats,omitempty"`

	// Number of accumulated operations by type since server restart.
	LifeTimeOps map[string]uint64 `json:"life_time_ops,omitempty"`

	// Number of accumulated ILM operations by type since server restart.
	LifeTimeILM map[string]uint64 `json:"ilm_ops,omitempty"`

	// Last minute operation statistics.
	LastMinute struct {
		// Scanner actions.
		Actions map[string]TimedAction `json:"actions,omitempty"`
		// ILM actions.
		ILM map[string]TimedAction `json:"ilm,omitempty"`
	} `json:"last_minute"`

	// Currently active path(s) being scanned.
	ActivePaths []string `json:"active,omitempty"`

	// Excessive prefixes.
	// Paths that have been marked as having excessive number of entries within the last 24 hours.
	ExcessivePrefixes []string `json:"excessive,omitempty"`
}

ScannerMetrics contains scanner information.

func (*ScannerMetrics) DecodeMsg 

func (z *ScannerMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ScannerMetrics) EncodeMsg 

func (z *ScannerMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ScannerMetrics) MarshalMsg 

func (z *ScannerMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ScannerMetrics) Merge 

func (s *ScannerMetrics) Merge(other *ScannerMetrics)

Merge other into 's'.

func (*ScannerMetrics) Msgsize 

func (z *ScannerMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ScannerMetrics) UnmarshalMsg 

func (z *ScannerMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Segmented added in v4.2.10 

type Segmented[T any, PT interface {
	*T
	Segmenter[T]
}] struct {
	Interval  int       `json:"intervalSecs,omitempty"` // Interval covered by each segment in seconds.
	FirstTime time.Time `json:"firstTime,omitzero"`     // Timestamp of first (ie oldest) segment
	Segments  []T       `json:"segments,omitempty"`     // List of DiskAction for each segment ordered by time (oldest first).
}

Segmented contains f type A metrics segmented by time. FirstTime must be aligned to a start time that it a multiple of Interval.

func (*Segmented[T, PT]) Add added in v4.2.10 

func (s *Segmented[T, PT]) Add(other *Segmented[T, PT])

Add 'other' to 'a'.

func (*Segmented[T, PT]) DecodeMsg added in v4.2.10 

func (z *Segmented[T, PT]) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*Segmented[T, PT]) EncodeMsg added in v4.2.10 

func (z *Segmented[T, PT]) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*Segmented[T, PT]) MarshalMsg added in v4.2.10 

func (z *Segmented[T, PT]) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*Segmented[T, PT]) Msgsize added in v4.2.10 

func (z *Segmented[T, PT]) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Segmented[T, PT]) Total added in v4.2.10 

func (s *Segmented[T, PT]) Total() T

Total returns the total of all segments.

func (*Segmented[T, PT]) UnmarshalMsg added in v4.2.10 

func (z *Segmented[T, PT]) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type SegmentedAPIMetrics added in v4.2.9 

type SegmentedAPIMetrics = Segmented[APIStats, *APIStats]

SegmentedAPIMetrics are segmented API metrics.

type SegmentedDiskActions added in v4.2.10 

type SegmentedDiskActions = Segmented[DiskAction, *DiskAction]

type SegmentedDiskIO added in v4.2.10 

type SegmentedDiskIO = Segmented[DiskIOStats, *DiskIOStats]

type Segmenter added in v4.2.10 

type Segmenter[T any] interface {
	msgp.Encodable
	msgp.Marshaler
	msgp.Decodable
	msgp.Unmarshaler
	msgp.Sizer
	Add(*T)
}

Segmenter implement interface on pointers.

type ServerCPUInfo 

type ServerCPUInfo struct {
	Addr     string          `json:"addr"`
	CPUStat  []cpu.InfoStat  `json:"cpu,omitempty"`
	TimeStat []cpu.TimesStat `json:"time,omitempty"`
	Error    string          `json:"error,omitempty"`
}

ServerCPUInfo - Includes cpu and timer stats of each node of the MinIO cluster

type ServerDiskHwInfo 

type ServerDiskHwInfo struct {
	Addr       string                           `json:"addr"`
	Usage      []*diskhw.UsageStat              `json:"usages,omitempty"`
	Partitions []PartitionStat                  `json:"partitions,omitempty"`
	Counters   map[string]diskhw.IOCountersStat `json:"counters,omitempty"`
	Error      string                           `json:"error,omitempty"`
}

ServerDiskHwInfo - Includes usage counters, disk counters and partitions

func (*ServerDiskHwInfo) GetTotalCapacity 

func (s *ServerDiskHwInfo) GetTotalCapacity() (capacity uint64)

GetTotalCapacity gets the total capacity a server holds.

func (*ServerDiskHwInfo) GetTotalFreeCapacity 

func (s *ServerDiskHwInfo) GetTotalFreeCapacity() (capacity uint64)

GetTotalFreeCapacity gets the total capacity that is free.

func (*ServerDiskHwInfo) GetTotalUsedCapacity 

func (s *ServerDiskHwInfo) GetTotalUsedCapacity() (capacity uint64)

GetTotalUsedCapacity gets the total capacity used.

type ServerDrivesInfo 

type ServerDrivesInfo struct {
	Addr     string            `json:"addr"`
	Serial   []DrivePerfInfoV0 `json:"serial,omitempty"`   // Drive perf info collected one drive at a time
	Parallel []DrivePerfInfoV0 `json:"parallel,omitempty"` // Drive perf info collected in parallel
	Error    string            `json:"error,omitempty"`
}

ServerDrivesInfo - Drive info about all drives in a single MinIO node

type ServerInfo 

type ServerInfo struct {
	State          string            `json:"state,omitempty"`
	Endpoint       string            `json:"endpoint,omitempty"`
	Uptime         int64             `json:"uptime,omitempty"`
	Version        string            `json:"version,omitempty"`
	CommitID       string            `json:"commitID,omitempty"`
	Network        map[string]string `json:"network,omitempty"`
	Drives         []Disk            `json:"drives,omitempty"`
	PoolNumber     int               `json:"poolNumber,omitempty"` // Only set if len(PoolNumbers) == 1
	PoolNumbers    []int             `json:"poolNumbers,omitempty"`
	MemStats       MemStats          `json:"mem_stats"`
	GoMaxProcs     int               `json:"go_max_procs"`
	NumCPU         int               `json:"num_cpu"`
	RuntimeVersion string            `json:"runtime_version"`
	GCStats        *GCStats          `json:"gc_stats,omitempty"`
	MinioEnvVars   map[string]string `json:"minio_env_vars,omitempty"`
	Edition        string            `json:"edition"`
	License        *LicenseInfo      `json:"license,omitempty"`
}

ServerInfo holds server information

type ServerInfoOpts 

type ServerInfoOpts struct {
	Metrics bool
}

ServerInfoOpts ask for additional data from the server

func (*ServerInfoOpts) DecodeMsg 

func (z *ServerInfoOpts) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (ServerInfoOpts) EncodeMsg 

func (z ServerInfoOpts) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (ServerInfoOpts) MarshalMsg 

func (z ServerInfoOpts) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (ServerInfoOpts) Msgsize 

func (z ServerInfoOpts) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ServerInfoOpts) UnmarshalMsg 

func (z *ServerInfoOpts) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ServerMemInfo 

type ServerMemInfo struct {
	Addr       string                 `json:"addr"`
	SwapMem    *mem.SwapMemoryStat    `json:"swap,omitempty"`
	VirtualMem *mem.VirtualMemoryStat `json:"virtualmem,omitempty"`
	Error      string                 `json:"error,omitempty"`
}

ServerMemInfo - Includes host virtual and swap mem information

type ServerNetHealthInfo 

type ServerNetHealthInfo struct {
	Addr  string          `json:"addr"`
	Net   []NetPerfInfoV0 `json:"net,omitempty"`
	Error string          `json:"error,omitempty"`
}

ServerNetHealthInfo - Network health info about a single MinIO node

type ServerOsInfo 

type ServerOsInfo struct {
	Addr    string                    `json:"addr"`
	Info    *host.InfoStat            `json:"info,omitempty"`
	Sensors []sensors.TemperatureStat `json:"sensors,omitempty"`
	Users   []host.UserStat           `json:"users,omitempty"`
	Error   string                    `json:"error,omitempty"`
}

ServerOsInfo - Includes host os information

type ServerPeerUpdateStatus 

type ServerPeerUpdateStatus struct {
	Host           string                `json:"host"`
	Err            string                `json:"err,omitempty"`
	CurrentVersion string                `json:"currentVersion"`
	UpdatedVersion string                `json:"updatedVersion"`
	WaitingDrives  map[string]DiskStatus `json:"waitingDrives,omitempty"`
}

ServerPeerUpdateStatus server update peer binary update result

type ServerProcInfo 

type ServerProcInfo struct {
	Addr      string       `json:"addr"`
	Processes []SysProcess `json:"processes,omitempty"`
	Error     string       `json:"error,omitempty"`
}

ServerProcInfo - Includes host process lvl information

type ServerProperties 

type ServerProperties struct {
	State               string            `json:"state,omitempty"`
	Endpoint            string            `json:"endpoint,omitempty"`
	Scheme              string            `json:"scheme,omitempty"`
	Uptime              int64             `json:"uptime,omitempty"`
	Version             string            `json:"version,omitempty"`
	CommitID            string            `json:"commitID,omitempty"`
	Network             map[string]string `json:"network,omitempty"`
	Disks               []Disk            `json:"drives,omitempty"`
	PoolNumber          int               `json:"poolNumber,omitempty"` // Only set if len(PoolNumbers) == 1
	PoolNumbers         []int             `json:"poolNumbers,omitempty"`
	MemStats            MemStats          `json:"mem_stats"`
	GoMaxProcs          int               `json:"go_max_procs,omitempty"`
	NumCPU              int               `json:"num_cpu,omitempty"`
	RuntimeVersion      string            `json:"runtime_version,omitempty"`
	GCStats             *GCStats          `json:"gc_stats,omitempty"`
	MinioEnvVars        map[string]string `json:"minio_env_vars,omitempty"`
	MinioEnvHash        string            `json:"minio_env_hash,omitempty"`
	Edition             string            `json:"edition"`
	License             *LicenseInfo      `json:"license,omitempty"`
	IsLeader            bool              `json:"is_leader"`
	ILMExpiryInProgress bool              `json:"ilm_expiry_in_progress"`
}

ServerProperties holds server information

func (*ServerProperties) DecodeMsg 

func (z *ServerProperties) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ServerProperties) EncodeMsg 

func (z *ServerProperties) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ServerProperties) MarshalMsg 

func (z *ServerProperties) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ServerProperties) Msgsize 

func (z *ServerProperties) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ServerProperties) UnmarshalMsg 

func (z *ServerProperties) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ServerUpdateOpts 

type ServerUpdateOpts struct {
	UpdateURL string
	DryRun    bool
}

ServerUpdateOpts specifies the URL (optionally to download the binary from) also allows a dry-run, the new API is idempotent which means you can run it as many times as you want and any server that is not upgraded automatically does get upgraded eventually to the relevant version.

type ServerUpdateStatus 

type ServerUpdateStatus struct {
	DryRun  bool                     `json:"dryRun"`
	Results []ServerPeerUpdateStatus `json:"results,omitempty"`
}

ServerUpdateStatus server update status

type ServiceAccountInfo 

type ServiceAccountInfo struct {
	ParentUser    string     `json:"parentUser"`
	AccountStatus string     `json:"accountStatus"`
	ImpliedPolicy bool       `json:"impliedPolicy"`
	AccessKey     string     `json:"accessKey"`
	Name          string     `json:"name,omitempty"`
	Description   string     `json:"description,omitempty"`
	Expiration    *time.Time `json:"expiration,omitempty"`
}

type ServiceAction 

type ServiceAction string

ServiceAction - type to restrict service-action values

type ServiceActionOpts 

type ServiceActionOpts struct {
	Action ServiceAction
	DryRun bool
}

ServiceActionOpts specifies the action that the service is requested to take, dryRun indicates if the action is a no-op, force indicates that server must make best effort to restart the process.

type ServiceActionPeerResult 

type ServiceActionPeerResult struct {
	Host          string                `json:"host"`
	Err           string                `json:"err,omitempty"`
	WaitingDrives map[string]DiskStatus `json:"waitingDrives,omitempty"`
}

ServiceActionPeerResult service peer result

type ServiceActionResult 

type ServiceActionResult struct {
	Action  ServiceAction             `json:"action"`
	DryRun  bool                      `json:"dryRun"`
	Results []ServiceActionPeerResult `json:"results,omitempty"`
}

ServiceActionResult service action result

type ServicePrincipalAuth 

type ServicePrincipalAuth struct {
	TenantID     string `json:",omitempty"`
	ClientID     string `json:",omitempty"`
	ClientSecret string `json:",omitempty"`
}

ServicePrincipalAuth holds fields for a successful SP authentication with Azure

func (*ServicePrincipalAuth) DecodeMsg 

func (z *ServicePrincipalAuth) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (ServicePrincipalAuth) EncodeMsg 

func (z ServicePrincipalAuth) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (ServicePrincipalAuth) MarshalMsg 

func (z ServicePrincipalAuth) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (ServicePrincipalAuth) Msgsize 

func (z ServicePrincipalAuth) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ServicePrincipalAuth) UnmarshalMsg 

func (z *ServicePrincipalAuth) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ServiceTelemetry 

type ServiceTelemetry struct {
	SpanMZ []byte // Serialized and Compressed spans.
	Err    error  // Any error that occurred
}

ServiceTelemetry holds http telemetry spans, serialized and compressed.

type ServiceTelemetryOpts 

type ServiceTelemetryOpts struct {
	// Types to add to tracing.
	Types TraceType `json:"types"`

	// Public cert to encrypt stream.
	PubCert []byte

	// Sample rate to set for this filter.
	// If <=0 or >=1 no sampling will be performed
	// and all hits will be traced.
	SampleRate float64 `json:"sampleRate"`

	// Disable sampling and only do tracing when a trace id is set on incoming request.
	ParentOnly bool `json:"parentOnly"`

	// Tag adds a `custom.tag` field to all traces triggered by this.
	TagKV map[string]string `json:"tags"`

	// On incoming HTTP types, only trigger if substring is in request.
	HTTPFilter HTTPFilter `json:"httpFilter"`
}

ServiceTelemetryOpts is a request to add following types to tracing.

func (*ServiceTelemetryOpts) DecodeMsg 

func (z *ServiceTelemetryOpts) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ServiceTelemetryOpts) EncodeMsg 

func (z *ServiceTelemetryOpts) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ServiceTelemetryOpts) MarshalMsg 

func (z *ServiceTelemetryOpts) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ServiceTelemetryOpts) Msgsize 

func (z *ServiceTelemetryOpts) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ServiceTelemetryOpts) UnmarshalMsg 

func (z *ServiceTelemetryOpts) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ServiceTraceInfo 

type ServiceTraceInfo struct {
	Trace TraceInfo
	Err   error `json:"-"`
}

ServiceTraceInfo holds http trace

type ServiceTraceOpts 

type ServiceTraceOpts struct {
	// Trace types:
	S3                bool
	Internal          bool
	Storage           bool
	OS                bool
	Scanner           bool
	Decommission      bool
	Healing           bool
	BatchReplication  bool
	BatchKeyRotation  bool
	BatchExpire       bool
	BatchAll          bool
	Rebalance         bool
	ReplicationResync bool
	Bootstrap         bool
	FTP               bool
	ILM               bool
	KMS               bool
	Formatting        bool

	OnlyErrors    bool
	Threshold     time.Duration
	ThresholdTTFB time.Duration
}

ServiceTraceOpts holds tracing options

func (ServiceTraceOpts) AddParams 

func (t ServiceTraceOpts) AddParams(u url.Values)

AddParams will add parameter to url values.

func (*ServiceTraceOpts) ParseParams 

func (t *ServiceTraceOpts) ParseParams(r *http.Request) (err error)

ParseParams will parse parameters and set them to t.

func (ServiceTraceOpts) TraceTypes 

func (t ServiceTraceOpts) TraceTypes() TraceType

TraceTypes returns the enabled traces as a bitfield value.

type ServiceType 

type ServiceType string

ServiceType represents service type 

const (
	// ReplicationService specifies replication service
	ReplicationService ServiceType = "replication"

	// NotificationService specifies notification/lambda service
	NotificationService ServiceType = "sqs"
)

func (ServiceType) IsValid 

func (t1 ServiceType) IsValid(t2 ServiceType) bool

IsValid returns true if ARN type is set.

type Services 

type Services struct {
	KMS           KMS                           `json:"kms,omitempty"` // deprecated july 2023
	KMSStatus     []KMS                         `json:"kmsStatus,omitempty"`
	LDAP          LDAP                          `json:"ldap,omitempty"`
	Logger        []Logger                      `json:"logger,omitempty"`
	Audit         []Audit                       `json:"audit,omitempty"`
	Notifications []map[string][]TargetIDStatus `json:"notifications,omitempty"`
}

Services contains different services information

func (*Services) DecodeMsg 

func (z *Services) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*Services) EncodeMsg 

func (z *Services) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Services) ListNotificationARNs added in v4.0.17 

func (s Services) ListNotificationARNs() (arns []ARN)

ListNotificationARNs return a list of configured notification ARNs

func (*Services) MarshalMsg 

func (z *Services) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*Services) Msgsize 

func (z *Services) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Services) UnmarshalMsg 

func (z *Services) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ServicesResourceInfo added in v4.1.0 

type ServicesResourceInfo struct {
	LDAP          LDAP                          `json:"ldap" msg:"l"`
	Logger        []Logger                      `json:"logger,omitempty" msg:"lg,omitempty"`
	Audit         []Audit                       `json:"audit,omitempty" msg:"a,omitempty"`
	Notifications []map[string][]TargetIDStatus `json:"notifications,omitempty" msg:"n,omitempty"`
	KMSStatus     []KMS                         `json:"kms,omitempty" msg:"k,omitempty"`
}

ServicesResourceInfo holds information about services connected to the cluster

func (*ServicesResourceInfo) DecodeMsg added in v4.1.0 

func (z *ServicesResourceInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*ServicesResourceInfo) EncodeMsg added in v4.1.0 

func (z *ServicesResourceInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*ServicesResourceInfo) MarshalMsg added in v4.1.0 

func (z *ServicesResourceInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*ServicesResourceInfo) Msgsize added in v4.1.0 

func (z *ServicesResourceInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*ServicesResourceInfo) UnmarshalMsg added in v4.1.0 

func (z *ServicesResourceInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ServicesResourceOpts added in v4.1.0 

type ServicesResourceOpts struct{}

ServicesResourceOpts ask for additional data from the server this is not used at the moment, kept here for future extensibility.

type SetInfoOpts 

type SetInfoOpts struct {
	Metrics bool
}

SetInfoOpts ask for additional data from the server this is not used at the moment, kept here for future extensibility.

type SetStatus 

type SetStatus struct {
	ID           string `json:"id"`
	PoolIndex    int    `json:"pool_index"`
	SetIndex     int    `json:"set_index"`
	HealStatus   string `json:"heal_status"`
	HealPriority string `json:"heal_priority"`
	TotalObjects int    `json:"total_objects"`
	Disks        []Disk `json:"disks"`
}

SetStatus contains information about the heal status of a set.

func (*SetStatus) DecodeMsg 

func (z *SetStatus) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*SetStatus) EncodeMsg 

func (z *SetStatus) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*SetStatus) MarshalMsg 

func (z *SetStatus) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*SetStatus) Msgsize 

func (z *SetStatus) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*SetStatus) UnmarshalMsg 

func (z *SetStatus) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type ShardsHealthInfo added in v4.2.1 

type ShardsHealthInfo struct {
	Error string `json:"error,omitempty"`
	// (Pool, Set) => an array of failed writes count for each drive index
	FailedWrites map[string]map[string][]uint64 `json:"failed_writes,omitempty"`
}

ShardsHealthInfo holds the per drive count of objects that missing shards in that drive

type SiteNetPerfNodeResult 

type SiteNetPerfNodeResult struct {
	Endpoint        string        `json:"endpoint"`
	TX              uint64        `json:"tx"` // transfer rate in bytes
	TXTotalDuration time.Duration `json:"txTotalDuration"`
	RX              uint64        `json:"rx"` // received rate in bytes
	RXTotalDuration time.Duration `json:"rxTotalDuration"`
	TotalConn       uint64        `json:"totalConn"`
	Error           string        `json:"error,omitempty"`
}

SiteNetPerfNodeResult - stats from each server

type SiteNetPerfResult 

type SiteNetPerfResult struct {
	NodeResults []SiteNetPerfNodeResult `json:"nodeResults"`
}

SiteNetPerfResult - aggregate results from all servers

type SiteReplicationInfo 

type SiteReplicationInfo struct {
	Enabled                 bool       `json:"enabled"`
	Name                    string     `json:"name,omitempty"`
	Sites                   []PeerInfo `json:"sites,omitempty"`
	ServiceAccountAccessKey string     `json:"serviceAccountAccessKey,omitempty"`
	APIVersion              string     `json:"apiVersion,omitempty"`
}

SiteReplicationInfo - contains cluster replication information.

type SiteResyncMetrics 

type SiteResyncMetrics struct {
	// Time these metrics were collected
	CollectedAt time.Time `json:"collected"`
	// Status of resync operation
	ResyncStatus string    `json:"resyncStatus,omitempty"`
	StartTime    time.Time `json:"startTime"`
	LastUpdate   time.Time `json:"lastUpdate"`
	NumBuckets   int64     `json:"numBuckets"`
	ResyncID     string    `json:"resyncID"`
	DeplID       string    `json:"deplID"`

	// Completed size in bytes
	ReplicatedSize int64 `json:"completedReplicationSize"`
	// Total number of objects replicated
	ReplicatedCount int64 `json:"replicationCount"`
	// Failed size in bytes
	FailedSize int64 `json:"failedReplicationSize"`
	// Total number of failed operations
	FailedCount int64 `json:"failedReplicationCount"`
	// Buckets that could not be synced
	FailedBuckets []string `json:"failedBuckets"`
	// Last bucket/object replicated.
	Bucket string `json:"bucket,omitempty"`
	Object string `json:"object,omitempty"`
}

SiteResyncMetrics contains metrics for site resync operation

func (SiteResyncMetrics) Complete 

func (o SiteResyncMetrics) Complete() bool

func (*SiteResyncMetrics) DecodeMsg 

func (z *SiteResyncMetrics) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*SiteResyncMetrics) EncodeMsg 

func (z *SiteResyncMetrics) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*SiteResyncMetrics) MarshalMsg 

func (z *SiteResyncMetrics) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*SiteResyncMetrics) Merge 

func (o *SiteResyncMetrics) Merge(other *SiteResyncMetrics)

Merge other into 'o'.

func (*SiteResyncMetrics) Msgsize 

func (z *SiteResyncMetrics) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*SiteResyncMetrics) UnmarshalMsg 

func (z *SiteResyncMetrics) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type SiteResyncOp 

type SiteResyncOp string

SiteResyncOp type of resync operation 

const (
	// SiteResyncStart starts a site resync operation
	SiteResyncStart SiteResyncOp = "start"
	// SiteResyncCancel cancels ongoing site resync
	SiteResyncCancel SiteResyncOp = "cancel"
)

type SmartAtaInfo 

type SmartAtaInfo struct {
	LUWWNDeviceID         string `json:"scsiLuWWNDeviceID,omitempty"`
	SerialNum             string `json:"serialNum,omitempty"`
	ModelNum              string `json:"modelNum,omitempty"`
	FirmwareRevision      string `json:"firmwareRevision,omitempty"`
	RotationRate          string `json:"RotationRate,omitempty"`
	ATAMajorVersion       string `json:"MajorVersion,omitempty"`
	ATAMinorVersion       string `json:"MinorVersion,omitempty"`
	SmartSupportAvailable bool   `json:"smartSupportAvailable,omitempty"`
	SmartSupportEnabled   bool   `json:"smartSupportEnabled,omitempty"`
	ErrorLog              string `json:"smartErrorLog,omitempty"`
	Transport             string `json:"transport,omitempty"`
}

SmartAtaInfo contains ATA drive info

type SmartInfo 

type SmartInfo struct {
	Device string         `json:"device"`
	Scsi   *SmartScsiInfo `json:"scsi,omitempty"`
	Nvme   *SmartNvmeInfo `json:"nvme,omitempty"`
	Ata    *SmartAtaInfo  `json:"ata,omitempty"`
}

SmartInfo contains S.M.A.R.T data about the drive

type SmartNvmeInfo 

type SmartNvmeInfo struct {
	SerialNum       string `json:"serialNum,omitempty"`
	VendorID        string `json:"vendorId,omitempty"`
	FirmwareVersion string `json:"firmwareVersion,omitempty"`
	ModelNum        string `json:"modelNum,omitempty"`
	SpareAvailable  string `json:"spareAvailable,omitempty"`
	SpareThreshold  string `json:"spareThreshold,omitempty"`
	Temperature     string `json:"temperature,omitempty"`
	CriticalWarning string `json:"criticalWarning,omitempty"`

	MaxDataTransferPages        int      `json:"maxDataTransferPages,omitempty"`
	ControllerBusyTime          *big.Int `json:"controllerBusyTime,omitempty"`
	PowerOnHours                *big.Int `json:"powerOnHours,omitempty"`
	PowerCycles                 *big.Int `json:"powerCycles,omitempty"`
	UnsafeShutdowns             *big.Int `json:"unsafeShutdowns,omitempty"`
	MediaAndDataIntegrityErrors *big.Int `json:"mediaAndDataIntgerityErrors,omitempty"`
	DataUnitsReadBytes          *big.Int `json:"dataUnitsReadBytes,omitempty"`
	DataUnitsWrittenBytes       *big.Int `json:"dataUnitsWrittenBytes,omitempty"`
	HostReadCommands            *big.Int `json:"hostReadCommands,omitempty"`
	HostWriteCommands           *big.Int `json:"hostWriteCommands,omitempty"`
}

SmartNvmeInfo contains NVMe drive info

type SmartScsiInfo 

type SmartScsiInfo struct {
	CapacityBytes int64  `json:"scsiCapacityBytes,omitempty"`
	ModeSenseBuf  string `json:"scsiModeSenseBuf,omitempty"`
	RespLen       int64  `json:"scsirespLen,omitempty"`
	BdLen         int64  `json:"scsiBdLen,omitempty"`
	Offset        int64  `json:"scsiOffset,omitempty"`
	RPM           int64  `json:"sciRpm,omitempty"`
}

SmartScsiInfo contains SCSI drive Info

type SpeedTestResult 

type SpeedTestResult struct {
	Version    string `json:"version"`
	Servers    int    `json:"servers"`
	Disks      int    `json:"disks"`
	Size       int    `json:"size"`
	Concurrent int    `json:"concurrent"`
	PUTStats   SpeedTestStats
	GETStats   SpeedTestStats
}

SpeedTestResult - result of the speedtest() call

type SpeedTestResults 

type SpeedTestResults struct {
	DrivePerf []DriveSpeedTestResult `json:"drive,omitempty"`
	ObjPerf   []SpeedTestResult      `json:"obj,omitempty"`
	NetPerf   []NetperfNodeResult    `json:"net,omitempty"`
	Error     string                 `json:"error,omitempty"`
}

SpeedTestResults - Includes perf test results of the MinIO cluster

type SpeedTestStatServer 

type SpeedTestStatServer struct {
	Endpoint         string `json:"endpoint"`
	ThroughputPerSec uint64 `json:"throughputPerSec"`
	ObjectsPerSec    uint64 `json:"objectsPerSec"`
	Err              string `json:"err"`
}

SpeedTestStatServer - stats of a server

type SpeedTestStats 

type SpeedTestStats struct {
	ThroughputPerSec uint64                `json:"throughputPerSec"`
	ObjectsPerSec    uint64                `json:"objectsPerSec"`
	Response         Timings               `json:"responseTime"`
	TTFB             Timings               `json:"ttfb,omitempty"`
	Servers          []SpeedTestStatServer `json:"servers"`
}

SpeedTestStats - stats of all the servers

type SpeedtestOpts 

type SpeedtestOpts struct {
	Size         int           // Object size used in speed test
	Concurrency  int           // Concurrency used in speed test
	Duration     time.Duration // Total duration of the speed test
	Autotune     bool          // Enable autotuning
	StorageClass string        // Choose type of storage-class to be used while performing I/O
	Bucket       string        // Choose a custom bucket name while performing I/O
	NoClear      bool          // Avoid cleanup after running an object speed test
	EnableSha256 bool          // Enable calculating sha256 for uploads
}

SpeedtestOpts provide configurable options for speedtest

type StartProfilingResult 

type StartProfilingResult struct {
	NodeName string `json:"nodeName"`
	Success  bool   `json:"success"`
	Error    string `json:"error"`
}

StartProfilingResult holds the result of starting profiler result in a given node.

type StatRecorder 

type StatRecorder struct {
	Total int64 `json:"total"`
	Avg   int64 `json:"avg"`
	Max   int64 `json:"max"`
	// contains filtered or unexported fields
}

StatRecorder records and calculates the aggregates

func (*StatRecorder) DecodeMsg 

func (z *StatRecorder) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (StatRecorder) EncodeMsg 

func (z StatRecorder) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (StatRecorder) MarshalMsg 

func (z StatRecorder) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (StatRecorder) Msgsize 

func (z StatRecorder) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*StatRecorder) Record 

func (s *StatRecorder) Record(value int64)

Record will record the value and calculates the aggregates on the fly

func (*StatRecorder) UnmarshalMsg 

func (z *StatRecorder) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Status 

type Status struct {
	Status string `json:"status,omitempty"`
}

Status of endpoint

func (*Status) DecodeMsg 

func (z *Status) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (Status) EncodeMsg 

func (z Status) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Status) MarshalMsg 

func (z Status) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (Status) Msgsize 

func (z Status) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Status) UnmarshalMsg 

func (z *Status) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type StorageInfo 

type StorageInfo struct {
	Disks []Disk

	// Backend type.
	Backend BackendInfo
}

StorageInfo - represents total capacity of underlying storage.

func (*StorageInfo) DecodeMsg 

func (z *StorageInfo) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*StorageInfo) EncodeMsg 

func (z *StorageInfo) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*StorageInfo) MarshalMsg 

func (z *StorageInfo) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*StorageInfo) Msgsize 

func (z *StorageInfo) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*StorageInfo) UnmarshalMsg 

func (z *StorageInfo) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type SubnetLoginReq 

type SubnetLoginReq struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

SubnetLoginReq - JSON payload of the SUBNET login api

type SubnetMFAReq 

type SubnetMFAReq struct {
	Username string `json:"username"`
	OTP      string `json:"otp"`
	Token    string `json:"token"`
}

SubnetMFAReq - JSON payload of the SUBNET mfa api

type SubsysConfig 

type SubsysConfig struct {
	SubSystem string `json:"subSystem"`
	Target    string `json:"target,omitempty"`

	// WARNING: Use AddConfigKV() to mutate this.
	KV []ConfigKV `json:"kv"`
	// contains filtered or unexported fields
}

SubsysConfig represents the configuration for a particular subsytem and target.

func ParseServerConfigOutput 

func ParseServerConfigOutput(serverConfigOutput string) ([]SubsysConfig, error)

ParseServerConfigOutput - takes a server config output and returns a slice of configs. Depending on the server config get API request, this may return configuration info for one or more configuration sub-systems.

A configuration subsystem in the server may have one or more subsystem targets (named instances of the sub-system, for example `notify_postres`, `logger_webhook` or `identity_openid`). For every subsystem and target returned in `serverConfigOutput`, this function returns a separate `SubsysConfig` value in the output slice. The default target is returned as "" (empty string) by this function.

Use the `Lookup()` function on the `SubsysConfig` type to query a subsystem-target pair for a configuration parameter. This returns the effective value (i.e. possibly overridden by an environment variable) of the configuration parameter on the server.

func (*SubsysConfig) AddConfigKV 

func (c *SubsysConfig) AddConfigKV(ckv ConfigKV)

AddConfigKV - adds a config parameter to the subsystem.

func (*SubsysConfig) Lookup 

func (c *SubsysConfig) Lookup(key string) (val string, present bool)

Lookup resolves the value of a config parameter. If an env variable is specified on the server for the parameter, it is returned.

func (*SubsysConfig) LookupEnv added in v4.2.10 

func (c *SubsysConfig) LookupEnv(key string) (val string, envVal string, present bool)

LookupEnv finds value based on given key. If env variable is specified on the server for the parameter instead of overwriting it, it returns it as well along with config parameter.

type SyncStatus 

type SyncStatus string // change in sync state

const (
	SyncEnabled  SyncStatus = "enable"
	SyncDisabled SyncStatus = "disable"
)

func (SyncStatus) Empty 

func (s SyncStatus) Empty() bool

type SysConfig 

type SysConfig struct {
	NodeCommon

	Config map[string]interface{} `json:"config,omitempty"`
}

SysConfig - info about services that affect minio

func GetSysConfig 

func GetSysConfig(_ context.Context, addr string) SysConfig

GetSysConfig returns config values from the system (only those affecting minio performance)

type SysErrors 

type SysErrors struct {
	NodeCommon

	Errors []string `json:"errors,omitempty"`
}

SysErrors - contains a system error

func GetSysErrors 

func GetSysErrors(_ context.Context, addr string) SysErrors

GetSysErrors returns issues in system setup/config

type SysHealthInfo 

type SysHealthInfo struct {
	CPUInfo    []ServerCPUInfo    `json:"cpus,omitempty"`
	DiskHwInfo []ServerDiskHwInfo `json:"drives,omitempty"`
	OsInfo     []ServerOsInfo     `json:"osinfos,omitempty"`
	MemInfo    []ServerMemInfo    `json:"meminfos,omitempty"`
	ProcInfo   []ServerProcInfo   `json:"procinfos,omitempty"`
	Error      string             `json:"error,omitempty"`
}

SysHealthInfo - Includes hardware and system information of the MinIO cluster

type SysInfo 

type SysInfo struct {
	CPUInfo        []CPUs         `json:"cpus,omitempty"`
	Partitions     []Partitions   `json:"partitions,omitempty"`
	OSInfo         []OSInfo       `json:"osinfo,omitempty"`
	MemInfo        []MemInfo      `json:"meminfo,omitempty"`
	ProcInfo       []ProcInfo     `json:"procinfo,omitempty"`
	NetInfo        []NetInfo      `json:"netinfo,omitempty"`
	SysErrs        []SysErrors    `json:"errors,omitempty"`
	SysServices    []SysServices  `json:"services,omitempty"`
	SysConfig      []SysConfig    `json:"config,omitempty"`
	ProductInfo    []ProductInfo  `json:"productinfo,omitempty"`
	KubernetesInfo KubernetesInfo `json:"kubernetes"`
}

SysInfo - Includes hardware and system information of the MinIO cluster

type SysProcess 

type SysProcess struct {
	Pid             int32                       `json:"pid"`
	Background      bool                        `json:"background,omitempty"`
	CPUPercent      float64                     `json:"cpupercent,omitempty"`
	Children        []int32                     `json:"children,omitempty"`
	CmdLine         string                      `json:"cmd,omitempty"`
	ConnectionCount int                         `json:"connection_count,omitempty"`
	CreateTime      int64                       `json:"createtime,omitempty"`
	Cwd             string                      `json:"cwd,omitempty"`
	Exe             string                      `json:"exe,omitempty"`
	Gids            []int32                     `json:"gids,omitempty"`
	IOCounters      *process.IOCountersStat     `json:"iocounters,omitempty"`
	IsRunning       bool                        `json:"isrunning,omitempty"`
	MemInfo         *process.MemoryInfoStat     `json:"meminfo,omitempty"`
	MemMaps         *[]process.MemoryMapsStat   `json:"memmaps,omitempty"`
	MemPercent      float32                     `json:"mempercent,omitempty"`
	Name            string                      `json:"name,omitempty"`
	Nice            int32                       `json:"nice,omitempty"`
	NumCtxSwitches  *process.NumCtxSwitchesStat `json:"numctxswitches,omitempty"`
	NumFds          int32                       `json:"numfds,omitempty"`
	NumThreads      int32                       `json:"numthreads,omitempty"`
	PageFaults      *process.PageFaultsStat     `json:"pagefaults,omitempty"`
	Parent          int32                       `json:"parent,omitempty"`
	Ppid            int32                       `json:"ppid,omitempty"`
	Status          string                      `json:"status,omitempty"`
	Tgid            int32                       `json:"tgid,omitempty"`
	Times           *cpu.TimesStat              `json:"cputimes,omitempty"`
	Uids            []int32                     `json:"uids,omitempty"`
	Username        string                      `json:"username,omitempty"`
}

SysProcess - Includes process lvl information about a single process

func (SysProcess) GetOwner 

func (sp SysProcess) GetOwner() string

GetOwner - returns owner of the process

type SysService 

type SysService struct {
	Name   string `json:"name"`
	Status string `json:"status"`
}

SysService - name and status of a sys service

type SysServices 

type SysServices struct {
	NodeCommon

	Services []SysService `json:"services,omitempty"`
}

SysServices - info about services that affect minio

func GetSysServices 

func GetSysServices(_ context.Context, addr string) SysServices

GetSysServices returns info of sys services that affect minio

type TLSCert 

type TLSCert struct {
	PubKeyAlgo    string    `json:"pub_key_algo"`
	SignatureAlgo string    `json:"signature_algo"`
	NotBefore     time.Time `json:"not_before"`
	NotAfter      time.Time `json:"not_after"`
	Checksum      string    `json:"checksum"`
}

type TLSInfo 

type TLSInfo struct {
	TLSEnabled bool      `json:"tls_enabled"`
	Certs      []TLSCert `json:"certs,omitempty"`
}

type TargetIDStatus 

type TargetIDStatus map[string]Status

TargetIDStatus containsid and status

func (*TargetIDStatus) DecodeMsg 

func (z *TargetIDStatus) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (TargetIDStatus) EncodeMsg 

func (z TargetIDStatus) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (TargetIDStatus) MarshalMsg 

func (z TargetIDStatus) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (TargetIDStatus) Msgsize 

func (z TargetIDStatus) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TargetIDStatus) UnmarshalMsg 

func (z *TargetIDStatus) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TargetUpdateType 

type TargetUpdateType int

TargetUpdateType - type of update on the remote target 

const (
	// CredentialsUpdateType update creds
	CredentialsUpdateType TargetUpdateType = 1 + iota
	// SyncUpdateType update synchronous replication setting
	SyncUpdateType
	// ProxyUpdateType update proxy setting
	ProxyUpdateType
	// BandwidthLimitUpdateType update bandwidth limit
	BandwidthLimitUpdateType
	// HealthCheckDurationUpdateType update health check duration
	HealthCheckDurationUpdateType
	// PathUpdateType update Path
	PathUpdateType
	// ResetUpdateType sets ResetBeforeDate and ResetID on a bucket target
	ResetUpdateType
	// EdgeUpdateType sets bucket target as a recipent of edge traffic
	EdgeUpdateType
	// EdgeExpiryUpdateType sets bucket target to sync before expiry
	EdgeExpiryUpdateType
	// InsecureTLSUpdateType update tls setting
	InsecureTLSUpdateType
)

func GetTargetUpdateOps 

func GetTargetUpdateOps(values url.Values) []TargetUpdateType

GetTargetUpdateOps returns a slice of update operations being performed with `mc admin bucket remote edit`

type TemporaryAccountInfoResp 

type TemporaryAccountInfoResp InfoServiceAccountResp

TemporaryAccountInfoResp is the response body of the info temporary call

type TgtDiffInfo 

type TgtDiffInfo struct {
	ReplicationStatus       string `json:"rStatus,omitempty"`  // target replication status
	DeleteReplicationStatus string `json:"drStatus,omitempty"` // target delete replication status
}

type Throughput 

type Throughput struct {
	Avg          uint64 `json:"avg"`
	Max          uint64 `json:"max"`
	Min          uint64 `json:"min"`
	Percentile50 uint64 `json:"percentile_50"`
	Percentile90 uint64 `json:"percentile_90"`
	Percentile99 uint64 `json:"percentile_99"`
}

Throughput contains write performance in bytes per second of a disk drive.

type TierAzure 

type TierAzure struct {
	Endpoint     string `json:",omitempty"`
	AccountName  string `json:",omitempty"`
	AccountKey   string `json:",omitempty"`
	Bucket       string `json:",omitempty"`
	Prefix       string `json:",omitempty"`
	Region       string `json:",omitempty"`
	StorageClass string `json:",omitempty"`

	SPAuth ServicePrincipalAuth `json:",omitempty"`
}

TierAzure represents the remote tier configuration for Azure Blob Storage.

func (*TierAzure) DecodeMsg 

func (z *TierAzure) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*TierAzure) EncodeMsg 

func (z *TierAzure) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (TierAzure) IsSPEnabled 

func (ti TierAzure) IsSPEnabled() bool

IsSPEnabled returns true if all SP related fields are provided

func (*TierAzure) MarshalMsg 

func (z *TierAzure) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*TierAzure) Msgsize 

func (z *TierAzure) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TierAzure) UnmarshalMsg 

func (z *TierAzure) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TierConfig 

type TierConfig struct {
	Version string
	Type    TierType   `json:",omitempty"`
	Name    string     `json:",omitempty"`
	S3      *TierS3    `json:",omitempty"`
	Azure   *TierAzure `json:",omitempty"`
	GCS     *TierGCS   `json:",omitempty"`
	MinIO   *TierMinIO `json:",omitempty"`
}

TierConfig represents the different remote tier backend configurations supported. The specific backend is identified by the Type field. It has a Version field to allow for backwards-compatible extension in the future.

func NewTierAzure 

func NewTierAzure(name, accountName, accountKey, bucket string, options ...AzureOptions) (*TierConfig, error)

NewTierAzure returns a TierConfig of Azure type. Returns error if the given parameters are invalid like name is empty etc.

Example 
simpleAzSC, err := NewTierAzure("simple-az", "accessKey", "secretKey", "testbucket")
if err != nil {
	log.Fatalln(err, "Failed to create azure backed tier")
}
fmt.Println(simpleAzSC)

fullyCustomAzSC, err := NewTierAzure("custom-az", "accessKey", "secretKey", "testbucket", AzureEndpoint("http://blob.core.windows.net"), AzurePrefix("testprefix"))
if err != nil {
	log.Fatalln(err, "Failed to create azure backed tier")
}
fmt.Println(fullyCustomAzSC)

func NewTierGCS 

func NewTierGCS(name string, credsJSON []byte, bucket string, options ...GCSOptions) (*TierConfig, error)

NewTierGCS returns a TierConfig of GCS type. Returns error if the given parameters are invalid like name is empty etc.

Example 
credsJSON := []byte("credentials json content goes here")
simpleGCSSC, err := NewTierGCS("simple-gcs", credsJSON, "testbucket")
if err != nil {
	log.Fatalln(err, "Failed to create GCS backed tier")
}
fmt.Println(simpleGCSSC)

fullyCustomGCSSC, err := NewTierGCS("custom-gcs", credsJSON, "testbucket", GCSPrefix("testprefix"))
if err != nil {
	log.Fatalln(err, "Failed to create GCS backed tier")
}
fmt.Println(fullyCustomGCSSC)

func NewTierMinIO 

func NewTierMinIO(name, endpoint, accessKey, secretKey, bucket string, options ...MinIOOptions) (*TierConfig, error)

func NewTierS3 

func NewTierS3(name, accessKey, secretKey, bucket string, options ...S3Options) (*TierConfig, error)

NewTierS3 returns a TierConfig of S3 type. Returns error if the given parameters are invalid like name is empty etc.

Example 
simpleS3SC, err := NewTierS3("simple-s3", "accessKey", "secretKey", "testbucket")
if err != nil {
	log.Fatalln(err, "Failed to create s3 backed tier")
}
fmt.Println(simpleS3SC)

fullyCustomS3SC, err := NewTierS3("custom-s3", "accessKey", "secretKey", "testbucket",
	S3Endpoint("https://s3.amazonaws.com"), S3Prefix("testprefix"), S3Region("us-west-1"), S3StorageClass("S3_IA"))
if err != nil {
	log.Fatalln(err, "Failed to create s3 tier")
}
fmt.Println(fullyCustomS3SC)

func (*TierConfig) Bucket 

func (cfg *TierConfig) Bucket() string

Bucket returns the remote tier backend bucket.

func (*TierConfig) Clone 

func (cfg *TierConfig) Clone() TierConfig

Clone returns a copy of TierConfig with secret key/credentials redacted.

func (*TierConfig) DecodeMsg 

func (z *TierConfig) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*TierConfig) EncodeMsg 

func (z *TierConfig) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*TierConfig) Endpoint 

func (cfg *TierConfig) Endpoint() string

Endpoint returns the remote tier backend endpoint.

func (*TierConfig) MarshalMsg 

func (z *TierConfig) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*TierConfig) Msgsize 

func (z *TierConfig) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TierConfig) Prefix 

func (cfg *TierConfig) Prefix() string

Prefix returns the remote tier backend prefix.

func (*TierConfig) Region 

func (cfg *TierConfig) Region() string

Region returns the remote tier backend region.

func (*TierConfig) UnmarshalJSON 

func (cfg *TierConfig) UnmarshalJSON(b []byte) error

UnmarshalJSON unmarshals json value to ensure that Type field is filled in correspondence with the tier config supplied. See TestUnmarshalTierConfig for an example json.

func (*TierConfig) UnmarshalMsg 

func (z *TierConfig) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TierCreds 

type TierCreds struct {
	AccessKey string `json:"access,omitempty"`
	SecretKey string `json:"secret,omitempty"`

	AWSRole                     bool   `json:"awsrole"`
	AWSRoleWebIdentityTokenFile string `json:"awsroleWebIdentity,omitempty"`
	AWSRoleARN                  string `json:"awsroleARN,omitempty"`

	AzSP ServicePrincipalAuth `json:"azSP,omitempty"`

	CredsJSON []byte `json:"creds,omitempty"`
}

TierCreds is used to pass remote tier credentials in a tier-edit operation.

type TierGCS 

type TierGCS struct {
	Endpoint     string `json:",omitempty"` // custom endpoint is not supported for GCS
	Creds        string `json:",omitempty"` // base64 encoding of credentials.json
	Bucket       string `json:",omitempty"`
	Prefix       string `json:",omitempty"`
	Region       string `json:",omitempty"`
	StorageClass string `json:",omitempty"`
}

TierGCS represents the remote tier configuration for Google Cloud Storage

func (*TierGCS) DecodeMsg 

func (z *TierGCS) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*TierGCS) EncodeMsg 

func (z *TierGCS) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*TierGCS) GetCredentialJSON 

func (gcs *TierGCS) GetCredentialJSON() ([]byte, error)

GetCredentialJSON method returns the credentials JSON bytes.

func (*TierGCS) MarshalMsg 

func (z *TierGCS) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*TierGCS) Msgsize 

func (z *TierGCS) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TierGCS) UnmarshalMsg 

func (z *TierGCS) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TierInfo 

type TierInfo struct {
	Name       string
	Type       string
	Stats      TierStats
	DailyStats DailyTierStats
}

TierInfo contains tier name, type and statistics

type TierMinIO 

type TierMinIO struct {
	Endpoint  string `json:",omitempty"`
	AccessKey string `json:",omitempty"`
	SecretKey string `json:",omitempty"`
	Bucket    string `json:",omitempty"`
	Prefix    string `json:",omitempty"`
	Region    string `json:",omitempty"`
}

TierMinIO represents the remote tier configuration for MinIO object storage backend.

func (*TierMinIO) DecodeMsg 

func (z *TierMinIO) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*TierMinIO) EncodeMsg 

func (z *TierMinIO) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*TierMinIO) MarshalMsg 

func (z *TierMinIO) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*TierMinIO) Msgsize 

func (z *TierMinIO) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TierMinIO) UnmarshalMsg 

func (z *TierMinIO) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TierS3 

type TierS3 struct {
	Endpoint                    string `json:",omitempty"`
	AccessKey                   string `json:",omitempty"`
	SecretKey                   string `json:",omitempty"`
	Bucket                      string `json:",omitempty"`
	Prefix                      string `json:",omitempty"`
	Region                      string `json:",omitempty"`
	StorageClass                string `json:",omitempty"`
	AWSRole                     bool   `json:",omitempty"`
	AWSRoleWebIdentityTokenFile string `json:",omitempty"`
	AWSRoleARN                  string `json:",omitempty"`
	AWSRoleSessionName          string `json:",omitempty"`
	AWSRoleDurationSeconds      int    `json:",omitempty"`
}

TierS3 represents the remote tier configuration for AWS S3 compatible backend.

func (*TierS3) DecodeMsg 

func (z *TierS3) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*TierS3) EncodeMsg 

func (z *TierS3) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*TierS3) MarshalMsg 

func (z *TierS3) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*TierS3) Msgsize 

func (z *TierS3) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TierS3) UnmarshalMsg 

func (z *TierS3) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TierStats 

type TierStats struct {
	TotalSize   uint64 `json:"totalSize"`
	NumVersions int    `json:"numVersions"`
	NumObjects  int    `json:"numObjects"`
}

TierStats contains per-tier statistics like total size, number of objects/versions transitioned, etc.

func (*TierStats) DecodeMsg 

func (z *TierStats) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (TierStats) EncodeMsg 

func (z TierStats) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (TierStats) MarshalMsg 

func (z TierStats) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (TierStats) Msgsize 

func (z TierStats) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TierStats) UnmarshalMsg 

func (z *TierStats) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TierType 

type TierType int

TierType enumerates different remote tier backends. 

const (
	// Unsupported refers to remote tier backend that is not supported in this version
	Unsupported TierType = iota
	// S3 refers to AWS S3 compatible backend
	S3
	// Azure refers to Azure Blob Storage
	Azure
	// GCS refers to Google Cloud Storage
	GCS
	// MinIO refers to MinIO object storage backend
	MinIO
)

func NewTierType 

func NewTierType(scType string) (TierType, error)

NewTierType creates TierType if scType is a valid tier type string, otherwise returns an error.

func (*TierType) DecodeMsg 

func (z *TierType) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (TierType) EncodeMsg 

func (z TierType) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (TierType) MarshalJSON 

func (tt TierType) MarshalJSON() ([]byte, error)

MarshalJSON returns the canonical json representation of tt.

func (TierType) MarshalMsg 

func (z TierType) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (TierType) Msgsize 

func (z TierType) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (TierType) String 

func (tt TierType) String() string

String returns the name of tt's remote tier backend.

func (*TierType) UnmarshalJSON 

func (tt *TierType) UnmarshalJSON(data []byte) error

UnmarshalJSON parses the provided tier type string, failing unmarshal if data contains invalid tier type.

func (*TierType) UnmarshalMsg 

func (z *TierType) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TimeDurations 

type TimeDurations []time.Duration

TimeDurations is time.Duration segments.

func (TimeDurations) Len 

func (ts TimeDurations) Len() int

func (TimeDurations) Measure 

func (ts TimeDurations) Measure() Timings

Measure - calculate all the latency measurements

type TimeInfo 

type TimeInfo struct {
	CurrentTime       time.Time `json:"current_time"`
	RoundtripDuration int32     `json:"roundtrip_duration"`
	TimeZone          string    `json:"time_zone"`
}

TimeInfo contains current time with timezone, and the roundtrip duration when fetching it remotely

type TimedAction 

type TimedAction struct {
	Count   uint64 `json:"count"`
	AccTime uint64 `json:"acc_time_ns"`
	MinTime uint64 `json:"min_ns,omitempty"`
	MaxTime uint64 `json:"max_ns,omitempty"`
	Bytes   uint64 `json:"bytes,omitempty"`
}

TimedAction contains a number of actions and their accumulated duration in nanoseconds.

func (TimedAction) Avg 

func (t TimedAction) Avg() time.Duration

Avg returns the average time spent on the action.

func (TimedAction) AvgBytes 

func (t TimedAction) AvgBytes() uint64

AvgBytes returns the average time spent on the action.

func (*TimedAction) DecodeMsg 

func (z *TimedAction) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*TimedAction) EncodeMsg 

func (z *TimedAction) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*TimedAction) MarshalMsg 

func (z *TimedAction) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*TimedAction) Merge 

func (t *TimedAction) Merge(other TimedAction)

Merge other into t.

func (*TimedAction) Msgsize 

func (z *TimedAction) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TimedAction) UnmarshalMsg 

func (z *TimedAction) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TimedErrStats 

type TimedErrStats struct {
	LastMinute RStat `json:"lastMinute"`
	LastHour   RStat `json:"lastHour"`
	Totals     RStat `json:"totals"`
	// ErrCounts is a map of error codes to count of errors since server start - tracks
	// only AccessDenied errors for now.
	ErrCounts map[string]int `json:"errCounts,omitempty"`
}

TimedErrStats has failed replication stats across time windows

func (TimedErrStats) Add 

func (te TimedErrStats) Add(o TimedErrStats) TimedErrStats

Add - adds two TimedErrStats

func (*TimedErrStats) DecodeMsg 

func (z *TimedErrStats) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (*TimedErrStats) EncodeMsg 

func (z *TimedErrStats) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (*TimedErrStats) MarshalMsg 

func (z *TimedErrStats) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*TimedErrStats) Msgsize 

func (z *TimedErrStats) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TimedErrStats) UnmarshalMsg 

func (z *TimedErrStats) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type Timings 

type Timings struct {
	Avg     time.Duration `json:"avg"`   // Average duration per sample
	P50     time.Duration `json:"p50"`   // 50th %ile of all the sample durations
	P75     time.Duration `json:"p75"`   // 75th %ile of all the sample durations
	P95     time.Duration `json:"p95"`   // 95th %ile of all the sample durations
	P99     time.Duration `json:"p99"`   // 99th %ile of all the sample durations
	P999    time.Duration `json:"p999"`  // 99.9th %ile of all the sample durations
	Long5p  time.Duration `json:"l5p"`   // Average duration of the longest 5%
	Short5p time.Duration `json:"s5p"`   // Average duration of the shortest 5%
	Max     time.Duration `json:"max"`   // Max duration
	Min     time.Duration `json:"min"`   // Min duration
	StdDev  time.Duration `json:"sdev"`  // Standard deviation among all the sample durations
	Range   time.Duration `json:"range"` // Delta between Max and Min
}

Timings captures all latency metrics

type TopLockOpts 

type TopLockOpts struct {
	Count int
	Stale bool
}

TopLockOpts top lock options

type TotalMinMaxUint64 added in v4.2.10 

type TotalMinMaxUint64 struct {
	Total uint64 `json:"total"`
	Min   uint64 `json:"min"`
	Max   uint64 `json:"max"`
}

func (*TotalMinMaxUint64) DecodeMsg added in v4.2.10 

func (z *TotalMinMaxUint64) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (TotalMinMaxUint64) EncodeMsg added in v4.2.10 

func (z TotalMinMaxUint64) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (TotalMinMaxUint64) MarshalMsg added in v4.2.10 

func (z TotalMinMaxUint64) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (*TotalMinMaxUint64) Merge added in v4.2.10 

func (t *TotalMinMaxUint64) Merge(other TotalMinMaxUint64, tCnt int)

Merge 'other' into 't', assuming both are set.

func (TotalMinMaxUint64) Msgsize added in v4.2.10 

func (z TotalMinMaxUint64) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*TotalMinMaxUint64) SetAll added in v4.2.10 

func (t *TotalMinMaxUint64) SetAll(v uint64)

func (*TotalMinMaxUint64) UnmarshalMsg added in v4.2.10 

func (z *TotalMinMaxUint64) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type TraceCallStats 

type TraceCallStats struct {
	InputBytes      int           `json:"inputbytes"`
	OutputBytes     int           `json:"outputbytes"`
	TimeToFirstByte time.Duration `json:"timetofirstbyte"`
}

TraceCallStats records request stats

type TraceHTTPStats 

type TraceHTTPStats struct {
	ReqInfo   TraceRequestInfo  `json:"request"`
	RespInfo  TraceResponseInfo `json:"response"`
	CallStats TraceCallStats    `json:"stats"`
}

type TraceInfo 

type TraceInfo struct {
	TraceType TraceType `json:"type"`

	NodeName string        `json:"nodename"`
	FuncName string        `json:"funcname"`
	Time     time.Time     `json:"time"`
	Path     string        `json:"path"`
	Duration time.Duration `json:"dur"`
	Bytes    int64         `json:"bytes,omitempty"`

	Message    string            `json:"msg,omitempty"`
	Error      string            `json:"error,omitempty"`
	Custom     map[string]string `json:"custom,omitempty"`
	HTTP       *TraceHTTPStats   `json:"http,omitempty"`
	HealResult *HealResultItem   `json:"healResult,omitempty"`
}

TraceInfo - represents a trace record, additionally also reports errors if any while listening on trace.

func (TraceInfo) Mask 

func (t TraceInfo) Mask() uint64

Mask returns the trace type as uint32.

type TraceRequestInfo 

type TraceRequestInfo struct {
	Time     time.Time   `json:"time"`
	Proto    string      `json:"proto"`
	Method   string      `json:"method"`
	Path     string      `json:"path,omitempty"`
	RawQuery string      `json:"rawquery,omitempty"`
	Headers  http.Header `json:"headers,omitempty"`
	Body     []byte      `json:"body,omitempty"`
	Client   string      `json:"client"`
}

TraceRequestInfo represents trace of http request

type TraceResponseInfo 

type TraceResponseInfo struct {
	Time       time.Time   `json:"time"`
	Headers    http.Header `json:"headers,omitempty"`
	Body       []byte      `json:"body,omitempty"`
	StatusCode int         `json:"statuscode,omitempty"`
}

TraceResponseInfo represents trace of http request

type TraceType 

type TraceType uint64

TraceType indicates the type of the tracing Info 

const (
	// TraceOS tracing (Golang os package calls)
	TraceOS TraceType = 1 << iota
	// TraceStorage tracing (MinIO Storage Layer)
	TraceStorage
	// TraceS3 provides tracing of S3 API calls
	TraceS3
	// TraceInternal tracing internal (.minio.sys/...) HTTP calls
	TraceInternal
	// TraceScanner will trace scan operations.
	TraceScanner
	// TraceDecommission will trace decommission operations.
	TraceDecommission
	// TraceHealing will trace healing operations.
	TraceHealing
	// TraceBatchReplication will trace batch replication operations.
	TraceBatchReplication
	// TraceBatchKeyRotation will trace batch keyrotation operations.
	TraceBatchKeyRotation
	// TraceBatchExpire will trace batch expiration operations.
	TraceBatchExpire
	// TraceRebalance will trace rebalance operations
	TraceRebalance
	// TraceReplicationResync will trace replication resync operations.
	TraceReplicationResync
	// TraceBootstrap will trace events during MinIO cluster bootstrap
	TraceBootstrap
	// TraceFTP will trace events from MinIO FTP Server
	TraceFTP
	// TraceILM will trace events during MinIO ILM operations
	TraceILM
	// TraceKMS are traces for interactions with KMS.
	TraceKMS
	// TraceFormatting will trace formatting events
	TraceFormatting
	// TraceAdmin will trace admin calls
	TraceAdmin
	// TraceObject will trade object layer operations
	TraceObject
	// TraceReplication will trace replication as they are being picked up by workers
	TraceReplication
	// TraceIAM will trace Identity and Access Management
	TraceIAM

	// TraceAll contains all valid trace modes.
	// This *must* be the last entry.
	TraceAll TraceType = (1 << iota) - 1
)

func FindTraceType 

func FindTraceType(s string) TraceType

FindTraceType will find a single trace type from a string, as returned by String(). Matching is not case sensitive. Will return 0 if not found.

func ParseTraceType added in v4.0.18 

func ParseTraceType(typeSlice []string) TraceType

ParseTraceType - given a slice of trace types, returns OR'd tracetypes counterpart

func (TraceType) Contains 

func (t TraceType) Contains(other TraceType) bool

Contains returns whether all flags in other is present in t.

func (TraceType) Mask 

func (t TraceType) Mask() uint64

Mask returns the trace type as uint32.

func (*TraceType) Merge 

func (t *TraceType) Merge(other TraceType)

Merge will merge other into t.

func (TraceType) Overlaps 

func (t TraceType) Overlaps(other TraceType) bool

Overlaps returns whether any flags in t overlaps with other.

func (*TraceType) SetIf 

func (t *TraceType) SetIf(b bool, other TraceType)

SetIf will add other if b is true.

func (TraceType) SingleType 

func (t TraceType) SingleType() bool

SingleType returns whether t has a single type set.

func (TraceType) String 

func (i TraceType) String() string

type UpdateServiceAccountReq 

type UpdateServiceAccountReq struct {
	NewPolicy      json.RawMessage `json:"newPolicy,omitempty"` // Parsed policy from iam/policy.Parse
	NewSecretKey   string          `json:"newSecretKey,omitempty"`
	NewStatus      string          `json:"newStatus,omitempty"`
	NewName        string          `json:"newName,omitempty"`
	NewDescription string          `json:"newDescription,omitempty"`
	NewExpiration  *time.Time      `json:"newExpiration,omitempty"`
}

UpdateServiceAccountReq is the request options of the edit service account admin call

func (*UpdateServiceAccountReq) Validate 

func (u *UpdateServiceAccountReq) Validate() error

type Usage 

type Usage struct {
	Size  uint64 `json:"size"`
	Error string `json:"error,omitempty"`
}

Usage contains the total size used

func (*Usage) DecodeMsg 

func (z *Usage) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (Usage) EncodeMsg 

func (z Usage) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Usage) MarshalMsg 

func (z Usage) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (Usage) Msgsize 

func (z Usage) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Usage) UnmarshalMsg 

func (z *Usage) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type UserAuthInfo 

type UserAuthInfo struct {
	Type UserAuthType `json:"type"`

	// Specifies the external server that authenticated the server (empty for
	// builtin IDP)
	AuthServer string `json:"authServer,omitempty"`

	// Specifies the user ID as present in the external auth server (e.g. in
	// OIDC could be the email of the user). For builtin, this would be the same
	// as the access key.
	AuthServerUserID string `json:"authServerUserID,omitempty"`
}

UserAuthInfo contains info about how the user is authenticated.

type UserAuthType 

type UserAuthType string

UserAuthType indicates the type of authentication for the user. 

const (
	BuiltinUserAuthType UserAuthType = "builtin"
	LDAPUserAuthType    UserAuthType = "ldap"
)

Valid values for UserAuthType.

type UserInfo 

type UserInfo struct {
	AuthInfo   *UserAuthInfo `json:"userAuthInfo,omitempty"`
	SecretKey  string        `json:"secretKey,omitempty"`
	PolicyName string        `json:"policyName,omitempty"`
	Status     AccountStatus `json:"status"`
	MemberOf   []string      `json:"memberOf,omitempty"`
	UpdatedAt  time.Time     `json:"updatedAt,omitempty"`
}

UserInfo carries information about long term users.

type UserPolicyEntities 

type UserPolicyEntities struct {
	User             string                `json:"user"`
	Policies         []string              `json:"policies"`
	MemberOfMappings []GroupPolicyEntities `json:"memberOfMappings,omitempty"`
}

UserPolicyEntities - user -> policies mapping

type Versions 

type Versions struct {
	Count uint64 `json:"count"`
	Error string `json:"error,omitempty"`
}

Versions contains the number of versions

func (*Versions) DecodeMsg 

func (z *Versions) DecodeMsg(dc *msgp.Reader) (err error)

DecodeMsg implements msgp.Decodable

func (Versions) EncodeMsg 

func (z Versions) EncodeMsg(en *msgp.Writer) (err error)

EncodeMsg implements msgp.Encodable

func (Versions) MarshalMsg 

func (z Versions) MarshalMsg(b []byte) (o []byte, err error)

MarshalMsg implements msgp.Marshaler

func (Versions) Msgsize 

func (z Versions) Msgsize() (s int)

Msgsize returns an upper bound estimate of the number of bytes occupied by the serialized message

func (*Versions) UnmarshalMsg 

func (z *Versions) UnmarshalMsg(bts []byte) (o []byte, err error)

UnmarshalMsg implements msgp.Unmarshaler

type WorkerStat 

type WorkerStat struct {
	Curr int     `json:"curr"`
	Avg  float32 `json:"avg"`
	Max  int     `json:"max"`
}

WorkerStat captures number of replication workers

type XFSErrorConfig 

type XFSErrorConfig struct {
	ConfigFile string `json:"config_file"`
	MaxRetries int    `json:"max_retries"`
}

XFSErrorConfig - stores XFS error configuration info for max_retries

type XFSErrorConfigs 

type XFSErrorConfigs struct {
	Configs []XFSErrorConfig `json:"configs,omitempty"`
	Error   string           `json:"error,omitempty"`
}

XFSErrorConfigs - stores the error configs of all XFS devices on the server

Source Files

View all Source files

Directories

Path Synopsis
Package cgroup implements parsing for all the cgroup categories and functionality in a simple way.
 Package cgroup implements parsing for all the cgroup categories and functionality in a simple way.
Package jobs constists of all structs related to batch job requests and related functionality.
 Package jobs constists of all structs related to batch job requests and related functionality.
logger
audit
log

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.