Documentation

Overview

    Package settings is a generated protocol buffer package.
    
    Settings Service
    
    Settings Service API retrives ArgoCD settings
    
    It is generated from these files:
    	server/settings/settings.proto
    
    It has these top-level messages:
    	SettingsQuery
    	Settings
    	DexConfig
    	Connector
    

    Package settings is a reverse proxy.

    It translates gRPC into RESTful JSON APIs.

    Index

    Constants

    This section is empty.

    Variables

    View Source
    var (
    	ErrInvalidLengthSettings = fmt.Errorf("proto: negative length found during unmarshaling")
    	ErrIntOverflowSettings   = fmt.Errorf("proto: integer overflow")
    )

    Functions

    func RegisterSettingsServiceHandler

    func RegisterSettingsServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

      RegisterSettingsServiceHandler registers the http handlers for service SettingsService to "mux". The handlers forward requests to the grpc endpoint over "conn".

      func RegisterSettingsServiceHandlerClient

      func RegisterSettingsServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SettingsServiceClient) error

        RegisterSettingsServiceHandler registers the http handlers for service SettingsService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SettingsServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SettingsServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "SettingsServiceClient" to call the correct interceptors.

        func RegisterSettingsServiceHandlerFromEndpoint

        func RegisterSettingsServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

          RegisterSettingsServiceHandlerFromEndpoint is same as RegisterSettingsServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

          func RegisterSettingsServiceServer

          func RegisterSettingsServiceServer(s *grpc.Server, srv SettingsServiceServer)

          Types

          type Connector

          type Connector struct {
          	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
          	Type string `protobuf:"bytes,2,opt,name=type,proto3" json:"type,omitempty"`
          }

          func (*Connector) Descriptor

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

          func (*Connector) GetName

          func (m *Connector) GetName() string

          func (*Connector) GetType

          func (m *Connector) GetType() string

          func (*Connector) Marshal

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

          func (*Connector) MarshalTo

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

          func (*Connector) ProtoMessage

          func (*Connector) ProtoMessage()

          func (*Connector) Reset

          func (m *Connector) Reset()

          func (*Connector) Size

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

          func (*Connector) String

          func (m *Connector) String() string

          func (*Connector) Unmarshal

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

          type DexConfig

          type DexConfig struct {
          	Connectors []*Connector `protobuf:"bytes,1,rep,name=connectors" json:"connectors,omitempty"`
          }

          func (*DexConfig) Descriptor

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

          func (*DexConfig) GetConnectors

          func (m *DexConfig) GetConnectors() []*Connector

          func (*DexConfig) Marshal

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

          func (*DexConfig) MarshalTo

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

          func (*DexConfig) ProtoMessage

          func (*DexConfig) ProtoMessage()

          func (*DexConfig) Reset

          func (m *DexConfig) Reset()

          func (*DexConfig) Size

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

          func (*DexConfig) String

          func (m *DexConfig) String() string

          func (*DexConfig) Unmarshal

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

          type Server

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

            Server provides a Settings service

            func NewServer

            func NewServer(mgr *settings.SettingsManager) *Server

              NewServer returns a new instance of the Repository service

              func (*Server) AuthFuncOverride

              func (s *Server) AuthFuncOverride(ctx context.Context, fullMethodName string) (context.Context, error)

                AuthFuncOverride disables authentication for settings service

                func (*Server) Get

                func (s *Server) Get(ctx context.Context, q *SettingsQuery) (*Settings, error)

                  Get returns ArgoCD settings

                  type Settings

                  type Settings struct {
                  	URL       string     `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
                  	DexConfig *DexConfig `protobuf:"bytes,2,opt,name=dexConfig" json:"dexConfig,omitempty"`
                  }

                  func (*Settings) Descriptor

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

                  func (*Settings) GetDexConfig

                  func (m *Settings) GetDexConfig() *DexConfig

                  func (*Settings) GetURL

                  func (m *Settings) GetURL() string

                  func (*Settings) Marshal

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

                  func (*Settings) MarshalTo

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

                  func (*Settings) ProtoMessage

                  func (*Settings) ProtoMessage()

                  func (*Settings) Reset

                  func (m *Settings) Reset()

                  func (*Settings) Size

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

                  func (*Settings) String

                  func (m *Settings) String() string

                  func (*Settings) Unmarshal

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

                  type SettingsQuery

                  type SettingsQuery struct {
                  }

                    SettingsQuery is a query for ArgoCD settings

                    func (*SettingsQuery) Descriptor

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

                    func (*SettingsQuery) Marshal

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

                    func (*SettingsQuery) MarshalTo

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

                    func (*SettingsQuery) ProtoMessage

                    func (*SettingsQuery) ProtoMessage()

                    func (*SettingsQuery) Reset

                    func (m *SettingsQuery) Reset()

                    func (*SettingsQuery) Size

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

                    func (*SettingsQuery) String

                    func (m *SettingsQuery) String() string

                    func (*SettingsQuery) Unmarshal

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

                    type SettingsServiceClient

                    type SettingsServiceClient interface {
                    	// Get returns ArgoCD settings
                    	Get(ctx context.Context, in *SettingsQuery, opts ...grpc.CallOption) (*Settings, error)
                    }

                    func NewSettingsServiceClient

                    func NewSettingsServiceClient(cc *grpc.ClientConn) SettingsServiceClient

                    type SettingsServiceServer

                    type SettingsServiceServer interface {
                    	// Get returns ArgoCD settings
                    	Get(context.Context, *SettingsQuery) (*Settings, error)
                    }