admin

Documentation

Index

• Constants
• Variables
• func RegisterAPIServer(s grpc.ServiceRegistrar, srv APIServer)
• type APIClient
  • func NewAPIClient(cc grpc.ClientConnInterface) APIClient
• type APIServer
• type ClusterInfo
  • func (*ClusterInfo) Descriptor() ([]byte, []int)
  • func (x *ClusterInfo) GetDeploymentId() string
  • func (x *ClusterInfo) GetId() string
  • func (x *ClusterInfo) GetProxyHost() string
  • func (x *ClusterInfo) GetProxyTls() bool
  • func (x *ClusterInfo) GetVersionWarnings() []string
  • func (x *ClusterInfo) GetVersionWarningsOk() bool
  • func (x *ClusterInfo) MarshalLogObject(enc zapcore.ObjectEncoder) error
  • func (*ClusterInfo) ProtoMessage()
  • func (x *ClusterInfo) ProtoReflect() protoreflect.Message
  • func (x *ClusterInfo) Reset()
  • func (x *ClusterInfo) String() string
• type InspectClusterRequest
  • func (*InspectClusterRequest) Descriptor() ([]byte, []int)
  • func (x *InspectClusterRequest) GetClientVersion() *versionpb.Version
  • func (x *InspectClusterRequest) GetCurrentProject() *pfs.Project
  • func (x *InspectClusterRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error
  • func (*InspectClusterRequest) ProtoMessage()
  • func (x *InspectClusterRequest) ProtoReflect() protoreflect.Message
  • func (x *InspectClusterRequest) Reset()
  • func (x *InspectClusterRequest) String() string
• type UnimplementedAPIServer
  • func (UnimplementedAPIServer) InspectCluster(context.Context, *InspectClusterRequest) (*ClusterInfo, error)
• type UnsafeAPIServer

Constants

const (
	API_InspectCluster_FullMethodName = "/admin_v2.API/InspectCluster"
)

Variables

var API_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "admin_v2.API",
	HandlerType: (*APIServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "InspectCluster",
			Handler:    _API_InspectCluster_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "admin/admin.proto",
}

API_ServiceDesc is the grpc.ServiceDesc for API service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

var File_admin_admin_proto protoreflect.FileDescriptor

Functions

func RegisterAPIServer

func RegisterAPIServer(s grpc.ServiceRegistrar, srv APIServer)

Types

type APIClient

type APIClient interface {
	InspectCluster(ctx context.Context, in *InspectClusterRequest, opts ...grpc.CallOption) (*ClusterInfo, error)
}

APIClient is the client API for API service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAPIClient

func NewAPIClient(cc grpc.ClientConnInterface) APIClient

type APIServer

type APIServer interface {
	InspectCluster(context.Context, *InspectClusterRequest) (*ClusterInfo, error)
	// contains filtered or unexported methods
}

APIServer is the server API for API service. All implementations must embed UnimplementedAPIServer for forward compatibility

type ClusterInfo

type ClusterInfo struct {
	Id                string   `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	DeploymentId      string   `protobuf:"bytes,2,opt,name=deployment_id,json=deploymentId,proto3" json:"deployment_id,omitempty"`
	VersionWarningsOk bool     `protobuf:"varint,3,opt,name=version_warnings_ok,json=versionWarningsOk,proto3" json:"version_warnings_ok,omitempty"` // Let the client detect a server that can't generate warnings.
	VersionWarnings   []string `protobuf:"bytes,4,rep,name=version_warnings,json=versionWarnings,proto3" json:"version_warnings,omitempty"`          // Warnings about version skew.
	ProxyHost         string   `protobuf:"bytes,5,opt,name=proxy_host,json=proxyHost,proto3" json:"proxy_host,omitempty"`
	ProxyTls          bool     `protobuf:"varint,6,opt,name=proxy_tls,json=proxyTls,proto3" json:"proxy_tls,omitempty"`
	// contains filtered or unexported fields
}

func (*ClusterInfo) Descriptor

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

Deprecated: Use ClusterInfo.ProtoReflect.Descriptor instead.

func (*ClusterInfo) GetDeploymentId

func (x *ClusterInfo) GetDeploymentId() string

func (*ClusterInfo) GetId

func (x *ClusterInfo) GetId() string

func (*ClusterInfo) GetProxyHost

func (x *ClusterInfo) GetProxyHost() string

func (*ClusterInfo) GetProxyTls

func (x *ClusterInfo) GetProxyTls() bool

func (*ClusterInfo) GetVersionWarnings

func (x *ClusterInfo) GetVersionWarnings() []string

func (*ClusterInfo) GetVersionWarningsOk

func (x *ClusterInfo) GetVersionWarningsOk() bool

func (*ClusterInfo) MarshalLogObject

func (x *ClusterInfo) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*ClusterInfo) ProtoMessage

func (*ClusterInfo) ProtoMessage()

func (*ClusterInfo) ProtoReflect

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

func (*ClusterInfo) Reset

func (x *ClusterInfo) Reset()

func (*ClusterInfo) String

func (x *ClusterInfo) String() string

type InspectClusterRequest

type InspectClusterRequest struct {
	ClientVersion *versionpb.Version `protobuf:"bytes,1,opt,name=client_version,json=clientVersion,proto3" json:"client_version,omitempty"`
	// If CurrentProject is set, then InspectCluster will return an error if the
	// project does not exist.
	CurrentProject *pfs.Project `protobuf:"bytes,2,opt,name=current_project,json=currentProject,proto3" json:"current_project,omitempty"`
	// contains filtered or unexported fields
}

func (*InspectClusterRequest) Descriptor

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

Deprecated: Use InspectClusterRequest.ProtoReflect.Descriptor instead.

func (*InspectClusterRequest) GetClientVersion

func (x *InspectClusterRequest) GetClientVersion() *versionpb.Version

func (*InspectClusterRequest) GetCurrentProject

func (x *InspectClusterRequest) GetCurrentProject() *pfs.Project

func (*InspectClusterRequest) MarshalLogObject

func (x *InspectClusterRequest) MarshalLogObject(enc zapcore.ObjectEncoder) error

func (*InspectClusterRequest) ProtoMessage

func (*InspectClusterRequest) ProtoMessage()

func (*InspectClusterRequest) ProtoReflect

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

func (*InspectClusterRequest) Reset

func (x *InspectClusterRequest) Reset()

func (*InspectClusterRequest) String

func (x *InspectClusterRequest) String() string

type UnimplementedAPIServer

type UnimplementedAPIServer struct {
}

UnimplementedAPIServer must be embedded to have forward compatible implementations.

func (UnimplementedAPIServer) InspectCluster

func (UnimplementedAPIServer) InspectCluster(context.Context, *InspectClusterRequest) (*ClusterInfo, error)

type UnsafeAPIServer

type UnsafeAPIServer interface {
	// contains filtered or unexported methods
}

UnsafeAPIServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to APIServer will result in compilation errors.