milvus-io--milvus/pkg/objectstorage/options.go

package objectstorage

import "github.com/milvus-io/milvus/pkg/v3/util/paramtable"

// Config for setting params used by chunk manager client.
type Config struct {
	Address              string
	BucketName           string
	AccessKeyID          string
	SecretAccessKeyID    string
	UseSSL               bool
	SslCACert            string
	SslTLSMinVersion     string
	CreateBucket         bool
	RootPath             string
	UseIAM               bool
	CloudProvider        string
	IAMEndpoint          string
	UseVirtualHost       bool
	Region               string
	RequestTimeoutMs     int64
	GcpCredentialJSON    string
	GcpNativeWithoutAuth bool // used for Unit Testing
	ReadRetryAttempts    uint
}

func NewDefaultConfig() *Config {
	return &Config{
		ReadRetryAttempts: paramtable.Get().CommonCfg.StorageReadRetryAttempts.GetAsUint(),
	}
}

// Option is used to Config the retry function.
type Option func(*Config)

func Address(addr string) Option {
	return func(c *Config) {
		c.Address = addr
	}
}

func BucketName(bucketName string) Option {
	return func(c *Config) {
		c.BucketName = bucketName
	}
}

func AccessKeyID(accessKeyID string) Option {
	return func(c *Config) {
		c.AccessKeyID = accessKeyID
	}
}

func SecretAccessKeyID(secretAccessKeyID string) Option {
	return func(c *Config) {
		c.SecretAccessKeyID = secretAccessKeyID
	}
}

func UseSSL(useSSL bool) Option {
	return func(c *Config) {
		c.UseSSL = useSSL
	}
}

func SslCACert(sslCACert string) Option {
	return func(c *Config) {
		c.SslCACert = sslCACert
	}
}

func SslTLSMinVersion(v string) Option {
	return func(c *Config) {
		c.SslTLSMinVersion = v
	}
}

func CreateBucket(createBucket bool) Option {
	return func(c *Config) {
		c.CreateBucket = createBucket
	}
}

func RootPath(rootPath string) Option {
	return func(c *Config) {
		c.RootPath = rootPath
	}
}

func UseIAM(useIAM bool) Option {
	return func(c *Config) {
		c.UseIAM = useIAM
	}
}

func CloudProvider(cloudProvider string) Option {
	return func(c *Config) {
		c.CloudProvider = cloudProvider
	}
}

func IAMEndpoint(iamEndpoint string) Option {
	return func(c *Config) {
		c.IAMEndpoint = iamEndpoint
	}
}

func UseVirtualHost(useVirtualHost bool) Option {
	return func(c *Config) {
		c.UseVirtualHost = useVirtualHost
	}
}

func Region(region string) Option {
	return func(c *Config) {
		c.Region = region
	}
}

func RequestTimeout(requestTimeoutMs int64) Option {
	return func(c *Config) {
		c.RequestTimeoutMs = requestTimeoutMs
	}
}

func GcpCredentialJSON(gcpCredentialJSON string) Option {
	return func(c *Config) {
		c.GcpCredentialJSON = gcpCredentialJSON
	}
}