cycler

package
v0.0.0-...-b13b715 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2025 License: BSD-3-Clause Imports: 4 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ChillEffectConfiguration_EnumStorageClass_name = map[int32]string{
		0: "UNKNOWN",
		1: "STANDARD",
		2: "NEARLINE",
		3: "COLDLINE",
		4: "ARCHIVE",
	}
	ChillEffectConfiguration_EnumStorageClass_value = map[string]int32{
		"UNKNOWN":  0,
		"STANDARD": 1,
		"NEARLINE": 2,
		"COLDLINE": 3,
		"ARCHIVE":  4,
	}
)

Enum value maps for ChillEffectConfiguration_EnumStorageClass.

View Source 
var File_cycler_config_proto protoreflect.FileDescriptor
View Source 
var File_cycler_effect_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type ChillEffectConfiguration 

type ChillEffectConfiguration struct {

	// The desired destination storage class.
	ToStorageClass ChillEffectConfiguration_EnumStorageClass `` /* 160-byte string literal not displayed */
	// contains filtered or unexported fields
}

Change the storage class of an object in place.

func (*ChillEffectConfiguration) Descriptor deprecated 

func (*ChillEffectConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use ChillEffectConfiguration.ProtoReflect.Descriptor instead.

func (*ChillEffectConfiguration) GetToStorageClass 

func (x *ChillEffectConfiguration) GetToStorageClass() ChillEffectConfiguration_EnumStorageClass

func (*ChillEffectConfiguration) ProtoMessage 

func (*ChillEffectConfiguration) ProtoMessage()

func (*ChillEffectConfiguration) ProtoReflect 

func (x *ChillEffectConfiguration) ProtoReflect() protoreflect.Message

func (*ChillEffectConfiguration) Reset 

func (x *ChillEffectConfiguration) Reset()

func (*ChillEffectConfiguration) String 

func (x *ChillEffectConfiguration) String() string

type ChillEffectConfiguration_EnumStorageClass 

type ChillEffectConfiguration_EnumStorageClass int32

The existing storage classes. 

const (
	ChillEffectConfiguration_UNKNOWN  ChillEffectConfiguration_EnumStorageClass = 0
	ChillEffectConfiguration_STANDARD ChillEffectConfiguration_EnumStorageClass = 1
	ChillEffectConfiguration_NEARLINE ChillEffectConfiguration_EnumStorageClass = 2
	ChillEffectConfiguration_COLDLINE ChillEffectConfiguration_EnumStorageClass = 3
	ChillEffectConfiguration_ARCHIVE  ChillEffectConfiguration_EnumStorageClass = 4
)

func (ChillEffectConfiguration_EnumStorageClass) Descriptor 

func (ChillEffectConfiguration_EnumStorageClass) Descriptor() protoreflect.EnumDescriptor

func (ChillEffectConfiguration_EnumStorageClass) Enum 

func (x ChillEffectConfiguration_EnumStorageClass) Enum() *ChillEffectConfiguration_EnumStorageClass

func (ChillEffectConfiguration_EnumStorageClass) EnumDescriptor deprecated 

func (ChillEffectConfiguration_EnumStorageClass) EnumDescriptor() ([]byte, []int)

Deprecated: Use ChillEffectConfiguration_EnumStorageClass.Descriptor instead.

func (ChillEffectConfiguration_EnumStorageClass) Number 

func (x ChillEffectConfiguration_EnumStorageClass) Number() protoreflect.EnumNumber

func (ChillEffectConfiguration_EnumStorageClass) String 

func (x ChillEffectConfiguration_EnumStorageClass) String() string

func (ChillEffectConfiguration_EnumStorageClass) Type 

func (ChillEffectConfiguration_EnumStorageClass) Type() protoreflect.EnumType

type DeleteEffectConfiguration 

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

Delete the objects that match the configuration.

func (*DeleteEffectConfiguration) Descriptor deprecated 

func (*DeleteEffectConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use DeleteEffectConfiguration.ProtoReflect.Descriptor instead.

func (*DeleteEffectConfiguration) ProtoMessage 

func (*DeleteEffectConfiguration) ProtoMessage()

func (*DeleteEffectConfiguration) ProtoReflect 

func (x *DeleteEffectConfiguration) ProtoReflect() protoreflect.Message

func (*DeleteEffectConfiguration) Reset 

func (x *DeleteEffectConfiguration) Reset()

func (*DeleteEffectConfiguration) String 

func (x *DeleteEffectConfiguration) String() string

type DuplicateEffectConfiguration 

type DuplicateEffectConfiguration struct {

	// The destination bucket for the copied objects (e.g.
	// 'engeg-testing-bucket').
	DestinationBucket string `protobuf:"bytes,1,opt,name=destination_bucket,json=destinationBucket,proto3" json:"destination_bucket,omitempty"`
	// The destination prefix for the copied objects (e.g.
	// 'copied-files-prefix/'). Note: Prefixes are literal, and no '/' will be
	// infered/appended.
	DestinationPrefix string `protobuf:"bytes,2,opt,name=destination_prefix,json=destinationPrefix,proto3" json:"destination_prefix,omitempty"`
	// contains filtered or unexported fields
}

Duplicate objects that match the configuration to another bucket + prefix. If the destination is within the configured bucket/prefix the behavior on those objects created via the duplicate is undefined. They may or may not exist in whole or in part at the time the prefix is iterated.

func (*DuplicateEffectConfiguration) Descriptor deprecated 

func (*DuplicateEffectConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use DuplicateEffectConfiguration.ProtoReflect.Descriptor instead.

func (*DuplicateEffectConfiguration) GetDestinationBucket 

func (x *DuplicateEffectConfiguration) GetDestinationBucket() string

func (*DuplicateEffectConfiguration) GetDestinationPrefix 

func (x *DuplicateEffectConfiguration) GetDestinationPrefix() string

func (*DuplicateEffectConfiguration) ProtoMessage 

func (*DuplicateEffectConfiguration) ProtoMessage()

func (*DuplicateEffectConfiguration) ProtoReflect 

func (x *DuplicateEffectConfiguration) ProtoReflect() protoreflect.Message

func (*DuplicateEffectConfiguration) Reset 

func (x *DuplicateEffectConfiguration) Reset()

func (*DuplicateEffectConfiguration) String 

func (x *DuplicateEffectConfiguration) String() string

type HistogramOptions 

type HistogramOptions struct {

	// The number of unique buckets in the histrogram.
	NumBuckets int32 `protobuf:"varint,1,opt,name=num_buckets,json=numBuckets,proto3" json:"num_buckets,omitempty"`
	// The growth factor of each bucket to the next.
	GrowthFactor float64 `protobuf:"fixed64,2,opt,name=growth_factor,json=growthFactor,proto3" json:"growth_factor,omitempty"`
	// The base bucket's size.
	BaseBucketSize float64 `protobuf:"fixed64,3,opt,name=base_bucket_size,json=baseBucketSize,proto3" json:"base_bucket_size,omitempty"`
	// The minimum valued bucket's value.
	MinValue int64 `protobuf:"varint,4,opt,name=min_value,json=minValue,proto3" json:"min_value,omitempty"`
	// contains filtered or unexported fields
}

Options for the Histogram generation during a cycler run. See definition in: "google.golang.org/grpc/benchmark/stats"

func (*HistogramOptions) Descriptor deprecated 

func (*HistogramOptions) Descriptor() ([]byte, []int)

Deprecated: Use HistogramOptions.ProtoReflect.Descriptor instead.

func (*HistogramOptions) GetBaseBucketSize 

func (x *HistogramOptions) GetBaseBucketSize() float64

func (*HistogramOptions) GetGrowthFactor 

func (x *HistogramOptions) GetGrowthFactor() float64

func (*HistogramOptions) GetMinValue 

func (x *HistogramOptions) GetMinValue() int64

func (*HistogramOptions) GetNumBuckets 

func (x *HistogramOptions) GetNumBuckets() int32

func (*HistogramOptions) ProtoMessage 

func (*HistogramOptions) ProtoMessage()

func (*HistogramOptions) ProtoReflect 

func (x *HistogramOptions) ProtoReflect() protoreflect.Message

func (*HistogramOptions) Reset 

func (x *HistogramOptions) Reset()

func (*HistogramOptions) String 

func (x *HistogramOptions) String() string

type MoveEffectConfiguration 

type MoveEffectConfiguration struct {

	// The destination bucket for the moved objects (e.g. 'engeg-testing-bucket').
	DestinationBucket string `protobuf:"bytes,1,opt,name=destination_bucket,json=destinationBucket,proto3" json:"destination_bucket,omitempty"`
	// The destination prefix for the moved objects (e.g. 'moved-files-prefix/').
	// Note: Prefixes are literal, and no '/' will be infered/appended.
	DestinationPrefix string `protobuf:"bytes,2,opt,name=destination_prefix,json=destinationPrefix,proto3" json:"destination_prefix,omitempty"`
	// contains filtered or unexported fields
}

Move objects that match the configuration to another bucket + prefix. If the destination is within the configured bucket/prefix the behavior on those objects created via the move is undefined. They may or may not exist in whole or in part at the time the prefix is iterated.

func (*MoveEffectConfiguration) Descriptor deprecated 

func (*MoveEffectConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use MoveEffectConfiguration.ProtoReflect.Descriptor instead.

func (*MoveEffectConfiguration) GetDestinationBucket 

func (x *MoveEffectConfiguration) GetDestinationBucket() string

func (*MoveEffectConfiguration) GetDestinationPrefix 

func (x *MoveEffectConfiguration) GetDestinationPrefix() string

func (*MoveEffectConfiguration) ProtoMessage 

func (*MoveEffectConfiguration) ProtoMessage()

func (*MoveEffectConfiguration) ProtoReflect 

func (x *MoveEffectConfiguration) ProtoReflect() protoreflect.Message

func (*MoveEffectConfiguration) Reset 

func (x *MoveEffectConfiguration) Reset()

func (*MoveEffectConfiguration) String 

func (x *MoveEffectConfiguration) String() string

type NoopEffectConfiguration 

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

Like it says on the tin, will run stats only.

func (*NoopEffectConfiguration) Descriptor deprecated 

func (*NoopEffectConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use NoopEffectConfiguration.ProtoReflect.Descriptor instead.

func (*NoopEffectConfiguration) ProtoMessage 

func (*NoopEffectConfiguration) ProtoMessage()

func (*NoopEffectConfiguration) ProtoReflect 

func (x *NoopEffectConfiguration) ProtoReflect() protoreflect.Message

func (*NoopEffectConfiguration) Reset 

func (x *NoopEffectConfiguration) Reset()

func (*NoopEffectConfiguration) String 

func (x *NoopEffectConfiguration) String() string

type PolicyEffectConfiguration 

type PolicyEffectConfiguration struct {

	// The effect configuration must be one of the following configs.
	//
	// Types that are assignable to EffectConfiguration:
	//	*PolicyEffectConfiguration_Noop
	//	*PolicyEffectConfiguration_Move
	//	*PolicyEffectConfiguration_Chill
	//	*PolicyEffectConfiguration_Duplicate
	//	*PolicyEffectConfiguration_Delete
	EffectConfiguration isPolicyEffectConfiguration_EffectConfiguration `protobuf_oneof:"effect_configuration"`
	// The policy document to be parsed by rego and executed to determine if an
	// effect is going to be taken upon the object.
	PolicyDocumentPath string `protobuf:"bytes,5,opt,name=policy_document_path,json=policyDocumentPath,proto3" json:"policy_document_path,omitempty"`
	// Constrain the prefix iterators to paths that match the following go regexp.
	PrefixRegexp string `protobuf:"bytes,6,opt,name=prefix_regexp,json=prefixRegexp,proto3" json:"prefix_regexp,omitempty"`
	// contains filtered or unexported fields
}

A policy effect configuration defines the policy and the resulting effect.

func (*PolicyEffectConfiguration) Descriptor deprecated 

func (*PolicyEffectConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use PolicyEffectConfiguration.ProtoReflect.Descriptor instead.

func (*PolicyEffectConfiguration) GetChill 

func (x *PolicyEffectConfiguration) GetChill() *ChillEffectConfiguration

func (*PolicyEffectConfiguration) GetDelete 

func (x *PolicyEffectConfiguration) GetDelete() *DeleteEffectConfiguration

func (*PolicyEffectConfiguration) GetDuplicate 

func (x *PolicyEffectConfiguration) GetDuplicate() *DuplicateEffectConfiguration

func (*PolicyEffectConfiguration) GetEffectConfiguration 

func (m *PolicyEffectConfiguration) GetEffectConfiguration() isPolicyEffectConfiguration_EffectConfiguration

func (*PolicyEffectConfiguration) GetMove 

func (x *PolicyEffectConfiguration) GetMove() *MoveEffectConfiguration

func (*PolicyEffectConfiguration) GetNoop 

func (x *PolicyEffectConfiguration) GetNoop() *NoopEffectConfiguration

func (*PolicyEffectConfiguration) GetPolicyDocumentPath 

func (x *PolicyEffectConfiguration) GetPolicyDocumentPath() string

func (*PolicyEffectConfiguration) GetPrefixRegexp 

func (x *PolicyEffectConfiguration) GetPrefixRegexp() string

func (*PolicyEffectConfiguration) ProtoMessage 

func (*PolicyEffectConfiguration) ProtoMessage()

func (*PolicyEffectConfiguration) ProtoReflect 

func (x *PolicyEffectConfiguration) ProtoReflect() protoreflect.Message

func (*PolicyEffectConfiguration) Reset 

func (x *PolicyEffectConfiguration) Reset()

func (*PolicyEffectConfiguration) String 

func (x *PolicyEffectConfiguration) String() string

type PolicyEffectConfiguration_Chill 

type PolicyEffectConfiguration_Chill struct {
	// Change the storage class of the objects.
	Chill *ChillEffectConfiguration `protobuf:"bytes,3,opt,name=chill,proto3,oneof"`
}

type PolicyEffectConfiguration_Delete 

type PolicyEffectConfiguration_Delete struct {
	// Delete the object.
	Delete *DeleteEffectConfiguration `protobuf:"bytes,7,opt,name=delete,proto3,oneof"`
}

type PolicyEffectConfiguration_Duplicate 

type PolicyEffectConfiguration_Duplicate struct {
	// Duplicate the object to another location (same bucket or another).
	Duplicate *DuplicateEffectConfiguration `protobuf:"bytes,4,opt,name=duplicate,proto3,oneof"`
}

type PolicyEffectConfiguration_Move 

type PolicyEffectConfiguration_Move struct {
	// Move the object to another location (same bucket or another).
	Move *MoveEffectConfiguration `protobuf:"bytes,2,opt,name=move,proto3,oneof"`
}

type PolicyEffectConfiguration_Noop 

type PolicyEffectConfiguration_Noop struct {
	// Do nothing, will still gather stats.
	Noop *NoopEffectConfiguration `protobuf:"bytes,1,opt,name=noop,proto3,oneof"`
}

type RunConfig 

type RunConfig struct {

	// The runlog configuration.
	RunLogConfiguration *RunLogConfiguration `protobuf:"bytes,1,opt,name=run_log_configuration,json=runLogConfiguration,proto3" json:"run_log_configuration,omitempty"`
	// The stats configuration for the prefix and the action statistics.
	StatsConfiguration *StatsConfiguration `protobuf:"bytes,2,opt,name=stats_configuration,json=statsConfiguration,proto3" json:"stats_configuration,omitempty"`
	// Policy effect configuration.
	PolicyEffectConfiguration *PolicyEffectConfiguration `` /* 138-byte string literal not displayed */
	// Must match the command line argument and policy effect as well.
	MutationAllowed bool `protobuf:"varint,4,opt,name=mutation_allowed,json=mutationAllowed,proto3" json:"mutation_allowed,omitempty"`
	// The bucket to operate on (can be overridden on the command line).
	Bucket string `protobuf:"bytes,5,opt,name=bucket,proto3" json:"bucket,omitempty"`
	// contains filtered or unexported fields
}

Closure of all config for a single cycler run.

func (*RunConfig) Descriptor deprecated 

func (*RunConfig) Descriptor() ([]byte, []int)

Deprecated: Use RunConfig.ProtoReflect.Descriptor instead.

func (*RunConfig) GetBucket 

func (x *RunConfig) GetBucket() string

func (*RunConfig) GetMutationAllowed 

func (x *RunConfig) GetMutationAllowed() bool

func (*RunConfig) GetPolicyEffectConfiguration 

func (x *RunConfig) GetPolicyEffectConfiguration() *PolicyEffectConfiguration

func (*RunConfig) GetRunLogConfiguration 

func (x *RunConfig) GetRunLogConfiguration() *RunLogConfiguration

func (*RunConfig) GetStatsConfiguration 

func (x *RunConfig) GetStatsConfiguration() *StatsConfiguration

func (*RunConfig) ProtoMessage 

func (*RunConfig) ProtoMessage()

func (*RunConfig) ProtoReflect 

func (x *RunConfig) ProtoReflect() protoreflect.Message

func (*RunConfig) Reset 

func (x *RunConfig) Reset()

func (*RunConfig) String 

func (x *RunConfig) String() string

type RunLogConfiguration 

type RunLogConfiguration struct {

	// The destination url 'directory' for the logs, can be file:// or gs://.
	DestinationUrl string `protobuf:"bytes,1,opt,name=destination_url,json=destinationUrl,proto3" json:"destination_url,omitempty"`
	// The rough chunk size in bytes to deliver the logs in (before compression).
	ChunkSizeBytes int64 `protobuf:"varint,2,opt,name=chunk_size_bytes,json=chunkSizeBytes,proto3" json:"chunk_size_bytes,omitempty"`
	// How many outstanding log messages can we have before blocking producers.
	ChannelSize int64 `protobuf:"varint,3,opt,name=channel_size,json=channelSize,proto3" json:"channel_size,omitempty"`
	// How many retries we should make to persist logs.
	PersistRetries int64 `protobuf:"varint,4,opt,name=persist_retries,json=persistRetries,proto3" json:"persist_retries,omitempty"`
	// How many logs we'll allow to fail persistence and still continue.
	// Since we do log shipping in goroutines this is also the cap on the number
	// of those.
	MaxUnpersistedLogs int64 `protobuf:"varint,5,opt,name=max_unpersisted_logs,json=maxUnpersistedLogs,proto3" json:"max_unpersisted_logs,omitempty"`
	// contains filtered or unexported fields
}

Options for the log generation during a cycler run.

func (*RunLogConfiguration) Descriptor deprecated 

func (*RunLogConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use RunLogConfiguration.ProtoReflect.Descriptor instead.

func (*RunLogConfiguration) GetChannelSize 

func (x *RunLogConfiguration) GetChannelSize() int64

func (*RunLogConfiguration) GetChunkSizeBytes 

func (x *RunLogConfiguration) GetChunkSizeBytes() int64

func (*RunLogConfiguration) GetDestinationUrl 

func (x *RunLogConfiguration) GetDestinationUrl() string

func (*RunLogConfiguration) GetMaxUnpersistedLogs 

func (x *RunLogConfiguration) GetMaxUnpersistedLogs() int64

func (*RunLogConfiguration) GetPersistRetries 

func (x *RunLogConfiguration) GetPersistRetries() int64

func (*RunLogConfiguration) ProtoMessage 

func (*RunLogConfiguration) ProtoMessage()

func (*RunLogConfiguration) ProtoReflect 

func (x *RunLogConfiguration) ProtoReflect() protoreflect.Message

func (*RunLogConfiguration) Reset 

func (x *RunLogConfiguration) Reset()

func (*RunLogConfiguration) String 

func (x *RunLogConfiguration) String() string

type StatsConfiguration 

type StatsConfiguration struct {

	// When generating a report for a prefix, how deep should the breakdown be.
	PrefixReportMaxDepth int64 `` /* 126-byte string literal not displayed */
	// Histogram options for the objects ages.
	AgeDaysHistogramOptions *HistogramOptions `` /* 134-byte string literal not displayed */
	// Histogram options for the objects sizes.
	SizeBytesHistogramOptions *HistogramOptions `` /* 140-byte string literal not displayed */
	// contains filtered or unexported fields
}

Options provided to any run providing stats.

func (*StatsConfiguration) Descriptor deprecated 

func (*StatsConfiguration) Descriptor() ([]byte, []int)

Deprecated: Use StatsConfiguration.ProtoReflect.Descriptor instead.

func (*StatsConfiguration) GetAgeDaysHistogramOptions 

func (x *StatsConfiguration) GetAgeDaysHistogramOptions() *HistogramOptions

func (*StatsConfiguration) GetPrefixReportMaxDepth 

func (x *StatsConfiguration) GetPrefixReportMaxDepth() int64

func (*StatsConfiguration) GetSizeBytesHistogramOptions 

func (x *StatsConfiguration) GetSizeBytesHistogramOptions() *HistogramOptions

func (*StatsConfiguration) ProtoMessage 

func (*StatsConfiguration) ProtoMessage()

func (*StatsConfiguration) ProtoReflect 

func (x *StatsConfiguration) ProtoReflect() protoreflect.Message

func (*StatsConfiguration) Reset 

func (x *StatsConfiguration) Reset()

func (*StatsConfiguration) String 

func (x *StatsConfiguration) String() string

Source Files

View all Source files

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.