client

Documentation

Index

• type Client
  • func New(ctx context.Context, cfg Config) (client *Client, err error)
  • func (c *Client) Close() error
  • func (c *Client) CreateApplication(ctx context.Context, request *applicationpb.CreateApplicationRequest) (*applicationpb.CreateApplicationResponse, error)
  • func (c *Client) DeleteApplication(ctx context.Context, request *applicationpb.DeleteApplicationRequest) (*applicationpb.DeleteApplicationResponse, error)
  • func (c *Client) GetApplication(ctx context.Context, request *applicationpb.GetApplicationRequest) (*applicationpb.GetApplicationResponse, error)
  • func (c *Client) GetConnection() *grpc.ClientConn
  • func (c *Client) ListApplications(ctx context.Context, request *applicationpb.ListApplicationsRequest) (*applicationpb.ListApplicationsResponse, error)
  • func (c *Client) UpdateApplication(ctx context.Context, request *applicationpb.UpdateApplicationRequest) (*applicationpb.UpdateApplicationResponse, error)
• type Config
  • func (c *Config) CheckAndSetDefaults() error
• type ConnectionOptions

Types

type Client

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

func New

func New(ctx context.Context, cfg Config) (client *Client, err error)

func (*Client) Close

func (c *Client) Close() error

Close closes the Client connection to the auth server.

func (*Client) CreateApplication

func (c *Client) CreateApplication(ctx context.Context, request *applicationpb.CreateApplicationRequest) (*applicationpb.CreateApplicationResponse, error)

func (*Client) DeleteApplication

func (c *Client) DeleteApplication(ctx context.Context, request *applicationpb.DeleteApplicationRequest) (*applicationpb.DeleteApplicationResponse, error)

func (*Client) GetApplication

func (c *Client) GetApplication(ctx context.Context, request *applicationpb.GetApplicationRequest) (*applicationpb.GetApplicationResponse, error)

func (*Client) GetConnection

func (c *Client) GetConnection() *grpc.ClientConn

GetConnection returns GRPC connection.

func (*Client) ListApplications

func (c *Client) ListApplications(ctx context.Context, request *applicationpb.ListApplicationsRequest) (*applicationpb.ListApplicationsResponse, error)

func (*Client) UpdateApplication

func (c *Client) UpdateApplication(ctx context.Context, request *applicationpb.UpdateApplicationRequest) (*applicationpb.UpdateApplicationResponse, error)

type Config

type Config struct {
	HostPort          string
	AuthToken         string
	ConnectionOptions ConnectionOptions
}

func (*Config) CheckAndSetDefaults

func (c *Config) CheckAndSetDefaults() error

type ConnectionOptions

type ConnectionOptions struct {
	// Optional: To set the host:port for this client to connect to.
	TLSConfig *tls.Config

	DialOptions []grpc.DialOption

	DialTimeout time.Duration

	// Enables keep alive ping from client to the server, which can help detect abruptly closed connections faster.
	EnableKeepAliveCheck bool

	// After a duration of this time if the client doesn't see any activity it
	// pings the server to see if the transport is still alive.
	// If set below 10s, a minimum value of 10s will be used instead.
	KeepAliveTime time.Duration

	// After having pinged for keepalive check, the client waits for a duration
	// of Timeout and if no activity is seen even after that the connection is
	// closed.
	KeepAliveTimeout time.Duration

	// If true, client sends keepalive pings even with no active RPCs. If false,
	// when there are no active RPCs, Time and Timeout will be ignored and no
	// keepalive pings will be sent.
	KeepAlivePermitWithoutStream bool
}