redis

Documentation

Overview

Copyright 2025 Google LLC

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

Index

• Constants
• type Config
  • func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error)
  • func (r Config) SourceConfigKind() string
• type RedisClient
• type Source
  • func (s *Source) RedisClient() RedisClient
  • func (s *Source) SourceKind() string

Constants

const SourceKind string = "redis"

Types

type Config

type Config struct {
	Name           string   `yaml:"name" validate:"required"`
	Kind           string   `yaml:"kind" validate:"required"`
	Address        []string `yaml:"address" validate:"required"`
	Username       string   `yaml:"username"`
	Password       string   `yaml:"password"`
	Database       int      `yaml:"database"`
	UseGCPIAM      bool     `yaml:"useGCPIAM"`
	ClusterEnabled bool     `yaml:"clusterEnabled"`
}

func (Config) Initialize

func (r Config) Initialize(ctx context.Context, tracer trace.Tracer) (sources.Source, error)

func (Config) SourceConfigKind

func (r Config) SourceConfigKind() string

type RedisClient

type RedisClient interface {
	Do(context.Context, ...any) *redis.Cmd
}

RedisClient is an interface for `redis.Client` and `redis.ClusterClient

type Source

type Source struct {
	Name   string `yaml:"name"`
	Kind   string `yaml:"kind"`
	Client RedisClient
}

func (*Source) RedisClient

func (s *Source) RedisClient() RedisClient

func (*Source) SourceKind

func (s *Source) SourceKind() string