config

Documentation

Overview

Package config is a generated protocol buffer package.

It is generated from these files:

client/pkg/config/config.proto

It has these top-level messages:

Config
ConfigV1

Index

• Variables
• type Config
  • func Read() (*Config, error)
  • func (*Config) Descriptor() ([]byte, []int)
  • func (m *Config) GetUserID() string
  • func (m *Config) GetV1() *ConfigV1
  • func (m *Config) Marshal() (dAtA []byte, err error)
  • func (m *Config) MarshalTo(dAtA []byte) (int, error)
  • func (*Config) ProtoMessage()
  • func (m *Config) Reset()
  • func (m *Config) Size() (n int)
  • func (m *Config) String() string
  • func (m *Config) Unmarshal(dAtA []byte) error
  • func (c *Config) Write() error
• type ConfigV1
  • func (*ConfigV1) Descriptor() ([]byte, []int)
  • func (m *ConfigV1) GetPachdAddress() string
  • func (m *ConfigV1) GetSessionToken() string
  • func (m *ConfigV1) Marshal() (dAtA []byte, err error)
  • func (m *ConfigV1) MarshalTo(dAtA []byte) (int, error)
  • func (*ConfigV1) ProtoMessage()
  • func (m *ConfigV1) Reset()
  • func (m *ConfigV1) Size() (n int)
  • func (m *ConfigV1) String() string
  • func (m *ConfigV1) Unmarshal(dAtA []byte) error

Variables

var (
	ErrInvalidLengthConfig = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowConfig   = fmt.Errorf("proto: integer overflow")
)

Types

type Config

type Config struct {
	UserID string `protobuf:"bytes,1,opt,name=user_id,json=userId,proto3" json:"user_id,omitempty"`
	// Configuration options. Exactly one of these fields should be set
	// (depending on which version of the config is being used)
	V1 *ConfigV1 `protobuf:"bytes,2,opt,name=v1" json:"v1,omitempty"`
}

Config specifies the pachyderm config that is read and interpreted by the pachctl command-line tool. Right now, this is stored at $HOME/.pachyderm/config.

Different versions of the pachyderm config are specified as subfields of this message (this allows us to make significant changes to the config structure without breaking existing users by defining a new config version).

DO NOT change or remove field numbers from this proto, otherwise ALL pachyderm user configs will fail to parse.

func Read

func Read() (*Config, error)

Read loads the Pachyderm config on this machine. If an existing configuration cannot be found, it sets up the defaults. Read returns a nil Config if and only if it returns a non-nil error.

func (*Config) Descriptor

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

func (*Config) GetUserID

func (m *Config) GetUserID() string

func (*Config) GetV1

func (m *Config) GetV1() *ConfigV1

func (*Config) Marshal

func (m *Config) Marshal() (dAtA []byte, err error)

func (*Config) MarshalTo

func (m *Config) MarshalTo(dAtA []byte) (int, error)

func (*Config) ProtoMessage

func (*Config) ProtoMessage()

func (*Config) Reset

func (m *Config) Reset()

func (*Config) Size

func (m *Config) Size() (n int)

func (*Config) String

func (m *Config) String() string

func (*Config) Unmarshal

func (m *Config) Unmarshal(dAtA []byte) error

func (*Config) Write

func (c *Config) Write() error

Write writes the configuration in 'c' to this machine's Pachyderm config file.

type ConfigV1

type ConfigV1 struct {
	// A host:port pointing pachd at a pachyderm cluster. Similar to the
	// ADDRESS environment variable, though ADDRESS overrides this.
	PachdAddress string `protobuf:"bytes,2,opt,name=pachd_address,json=pachdAddress,proto3" json:"pachd_address,omitempty"`
	// A secret token identifying the current pachctl user within their
	// pachyderm cluster. This is included in all RPCs sent by pachctl, and used
	// to determine if pachctl actions are authorized.
	SessionToken string `protobuf:"bytes,1,opt,name=session_token,json=sessionToken,proto3" json:"session_token,omitempty"`
}

ConfigV1 specifies v1 of the pachyderm config (June 30 2017 - present) DO NOT change or remove field numbers from this proto, as if you do, v1 user configs will become unparseable.

func (*ConfigV1) Descriptor

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

func (*ConfigV1) GetPachdAddress

func (m *ConfigV1) GetPachdAddress() string

func (*ConfigV1) GetSessionToken

func (m *ConfigV1) GetSessionToken() string

func (*ConfigV1) Marshal

func (m *ConfigV1) Marshal() (dAtA []byte, err error)

func (*ConfigV1) MarshalTo

func (m *ConfigV1) MarshalTo(dAtA []byte) (int, error)

func (*ConfigV1) ProtoMessage

func (*ConfigV1) ProtoMessage()

func (*ConfigV1) Reset

func (m *ConfigV1) Reset()

func (*ConfigV1) Size

func (m *ConfigV1) Size() (n int)

func (*ConfigV1) String

func (m *ConfigV1) String() string

func (*ConfigV1) Unmarshal

func (m *ConfigV1) Unmarshal(dAtA []byte) error