garo

Documentation

Overview

Package garo is a generated twirp stub package. This code was generated with github.com/twitchtv/twirp/protoc-gen-twirp v5.10.1.

It is generated from these files:

rpc/garo/service.proto

Index

• Constants
• func WriteError(resp http.ResponseWriter, err error)
• type AgentConfigurationService
  • func NewAgentConfigurationServiceJSONClient(addr string, client HTTPClient, opts ...twirp.ClientOption) AgentConfigurationService
  • func NewAgentConfigurationServiceProtobufClient(addr string, client HTTPClient, opts ...twirp.ClientOption) AgentConfigurationService
• type GetRepoConfigurationRequest
  • func (*GetRepoConfigurationRequest) Descriptor() ([]byte, []int)
  • func (m *GetRepoConfigurationRequest) GetOrganisation() string
  • func (m *GetRepoConfigurationRequest) GetRepository() string
  • func (*GetRepoConfigurationRequest) ProtoMessage()
  • func (m *GetRepoConfigurationRequest) Reset()
  • func (m *GetRepoConfigurationRequest) String() string
  • func (m *GetRepoConfigurationRequest) XXX_DiscardUnknown()
  • func (m *GetRepoConfigurationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *GetRepoConfigurationRequest) XXX_Merge(src proto.Message)
  • func (m *GetRepoConfigurationRequest) XXX_Size() int
  • func (m *GetRepoConfigurationRequest) XXX_Unmarshal(b []byte) error
• type HTTPClient
• type RepoConfigurationResponse
  • func (*RepoConfigurationResponse) Descriptor() ([]byte, []int)
  • func (m *RepoConfigurationResponse) GetMaxConcurrentRunners() uint32
  • func (m *RepoConfigurationResponse) GetRepository() string
  • func (*RepoConfigurationResponse) ProtoMessage()
  • func (m *RepoConfigurationResponse) Reset()
  • func (m *RepoConfigurationResponse) String() string
  • func (m *RepoConfigurationResponse) XXX_DiscardUnknown()
  • func (m *RepoConfigurationResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *RepoConfigurationResponse) XXX_Merge(src proto.Message)
  • func (m *RepoConfigurationResponse) XXX_Size() int
  • func (m *RepoConfigurationResponse) XXX_Unmarshal(b []byte) error
• type TwirpServer
  • func NewAgentConfigurationServiceServer(svc AgentConfigurationService, hooks *twirp.ServerHooks) TwirpServer

Constants

const AgentConfigurationServicePathPrefix = "/twirp/philips.garo.garo.AgentConfigurationService/"

AgentConfigurationServicePathPrefix is used for all URL paths on a twirp AgentConfigurationService server. Requests are always: POST AgentConfigurationServicePathPrefix/method It can be used in an HTTP mux to route twirp requests along with non-twirp requests on other routes.

Functions

func WriteError

func WriteError(resp http.ResponseWriter, err error)

WriteError writes an HTTP response with a valid Twirp error format (code, msg, meta). Useful outside of the Twirp server (e.g. http middleware), but does not trigger hooks. If err is not a twirp.Error, it will get wrapped with twirp.InternalErrorWith(err)

Types

type AgentConfigurationService

type AgentConfigurationService interface {
	GetRepositoryConfiguration(context.Context, *GetRepoConfigurationRequest) (*RepoConfigurationResponse, error)
}

AgentConfigurationService provides agent configurations

func NewAgentConfigurationServiceJSONClient

func NewAgentConfigurationServiceJSONClient(addr string, client HTTPClient, opts ...twirp.ClientOption) AgentConfigurationService

NewAgentConfigurationServiceJSONClient creates a JSON client that implements the AgentConfigurationService interface. It communicates using JSON and can be configured with a custom HTTPClient.

func NewAgentConfigurationServiceProtobufClient

func NewAgentConfigurationServiceProtobufClient(addr string, client HTTPClient, opts ...twirp.ClientOption) AgentConfigurationService

NewAgentConfigurationServiceProtobufClient creates a Protobuf client that implements the AgentConfigurationService interface. It communicates using Protobuf and can be configured with a custom HTTPClient.

type GetRepoConfigurationRequest

type GetRepoConfigurationRequest struct {
	Organisation         string   `protobuf:"bytes,1,opt,name=organisation,proto3" json:"organisation,omitempty"`
	Repository           string   `protobuf:"bytes,2,opt,name=repository,proto3" json:"repository,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

GetRepoConfigurationRequest request the configuration for a given repository and organization

func (*GetRepoConfigurationRequest) Descriptor

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

func (*GetRepoConfigurationRequest) GetOrganisation

func (m *GetRepoConfigurationRequest) GetOrganisation() string

func (*GetRepoConfigurationRequest) GetRepository

func (m *GetRepoConfigurationRequest) GetRepository() string

func (*GetRepoConfigurationRequest) ProtoMessage

func (*GetRepoConfigurationRequest) ProtoMessage()

func (*GetRepoConfigurationRequest) Reset

func (m *GetRepoConfigurationRequest) Reset()

func (*GetRepoConfigurationRequest) String

func (m *GetRepoConfigurationRequest) String() string

func (*GetRepoConfigurationRequest) XXX_DiscardUnknown

func (m *GetRepoConfigurationRequest) XXX_DiscardUnknown()

func (*GetRepoConfigurationRequest) XXX_Marshal

func (m *GetRepoConfigurationRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GetRepoConfigurationRequest) XXX_Merge

func (m *GetRepoConfigurationRequest) XXX_Merge(src proto.Message)

func (*GetRepoConfigurationRequest) XXX_Size

func (m *GetRepoConfigurationRequest) XXX_Size() int

func (*GetRepoConfigurationRequest) XXX_Unmarshal

func (m *GetRepoConfigurationRequest) XXX_Unmarshal(b []byte) error

type HTTPClient

type HTTPClient interface {
	Do(req *http.Request) (*http.Response, error)
}

HTTPClient is the interface used by generated clients to send HTTP requests. It is fulfilled by *(net/http).Client, which is sufficient for most users. Users can provide their own implementation for special retry policies.

HTTPClient implementations should not follow redirects. Redirects are automatically disabled if *(net/http).Client is passed to client constructors. See the withoutRedirects function in this file for more details.

type RepoConfigurationResponse

type RepoConfigurationResponse struct {
	Repository           string   `protobuf:"bytes,1,opt,name=repository,proto3" json:"repository,omitempty"`
	MaxConcurrentRunners uint32   `protobuf:"varint,2,opt,name=maxConcurrentRunners,proto3" json:"maxConcurrentRunners,omitempty"`
	XXX_NoUnkeyedLiteral struct{} `json:"-"`
	XXX_unrecognized     []byte   `json:"-"`
	XXX_sizecache        int32    `json:"-"`
}

RepoConfigurationResponse returns agent configuration options

func (*RepoConfigurationResponse) Descriptor

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

func (*RepoConfigurationResponse) GetMaxConcurrentRunners

func (m *RepoConfigurationResponse) GetMaxConcurrentRunners() uint32

func (*RepoConfigurationResponse) GetRepository

func (m *RepoConfigurationResponse) GetRepository() string

func (*RepoConfigurationResponse) ProtoMessage

func (*RepoConfigurationResponse) ProtoMessage()

func (*RepoConfigurationResponse) Reset

func (m *RepoConfigurationResponse) Reset()

func (*RepoConfigurationResponse) String

func (m *RepoConfigurationResponse) String() string

func (*RepoConfigurationResponse) XXX_DiscardUnknown

func (m *RepoConfigurationResponse) XXX_DiscardUnknown()

func (*RepoConfigurationResponse) XXX_Marshal

func (m *RepoConfigurationResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RepoConfigurationResponse) XXX_Merge

func (m *RepoConfigurationResponse) XXX_Merge(src proto.Message)

func (*RepoConfigurationResponse) XXX_Size

func (m *RepoConfigurationResponse) XXX_Size() int

func (*RepoConfigurationResponse) XXX_Unmarshal

func (m *RepoConfigurationResponse) XXX_Unmarshal(b []byte) error

type TwirpServer

type TwirpServer interface {
	http.Handler
	// ServiceDescriptor returns gzipped bytes describing the .proto file that
	// this service was generated from. Once unzipped, the bytes can be
	// unmarshalled as a
	// github.com/golang/protobuf/protoc-gen-go/descriptor.FileDescriptorProto.
	//
	// The returned integer is the index of this particular service within that
	// FileDescriptorProto's 'Service' slice of ServiceDescriptorProtos. This is a
	// low-level field, expected to be used for reflection.
	ServiceDescriptor() ([]byte, int)
	// ProtocGenTwirpVersion is the semantic version string of the version of
	// twirp used to generate this file.
	ProtocGenTwirpVersion() string
	// PathPrefix returns the HTTP URL path prefix for all methods handled by this
	// service. This can be used with an HTTP mux to route twirp requests
	// alongside non-twirp requests on one HTTP listener.
	PathPrefix() string
}

TwirpServer is the interface generated server structs will support: they're HTTP handlers with additional methods for accessing metadata about the service. Those accessors are a low-level API for building reflection tools. Most people can think of TwirpServers as just http.Handlers.

func NewAgentConfigurationServiceServer

func NewAgentConfigurationServiceServer(svc AgentConfigurationService, hooks *twirp.ServerHooks) TwirpServer