api

package
v0.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 30, 2024 License: MPL-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const HostURL string = "https://api.prod.us-east-1.warpstream.com/api/v1"

HostURL - Default Warpstream URL.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client

type Client struct {
	HostURL    string
	HTTPClient *retryablehttp.Client
	Token      string
}

Client.

func NewClient

func NewClient(host string, token *string) (*Client, error)

NewClient.

func (*Client) CreateCredentials added in v0.2.0

func (c *Client) CreateCredentials(name string, su bool, vc VirtualCluster) (*VirtualClusterCredentials, error)

CreateCredentials - Create new virtual cluster credentials.

func (*Client) CreateVirtualCluster

func (c *Client) CreateVirtualCluster(name string, opts ClusterParameters) (*VirtualCluster, error)

CreateVirtualCluster - Create new virtual cluster.

func (*Client) DeleteCredentials added in v0.2.0

func (c *Client) DeleteCredentials(id string, vc VirtualCluster) error

DeleteCredentials - Delete virtual cluster credentials.

func (*Client) DeleteVirtualCluster

func (c *Client) DeleteVirtualCluster(id string, name string) error

DeleteVirtualCluster - Delete a virtual cluster.

func (*Client) FindVirtualCluster added in v0.3.1

func (c *Client) FindVirtualCluster(name string) (*VirtualCluster, error)

FindVirtualCluster - Returns virtual cluster with given name.

func (*Client) GetConfiguration added in v0.4.0

func (c *Client) GetConfiguration(vc VirtualCluster) (*VirtualClusterConfiguration, error)

GetConfiguration - Describe virtual cluster configuration.

func (*Client) GetCredentials added in v0.2.0

func (c *Client) GetCredentials(vc VirtualCluster) (map[string]VirtualClusterCredentials, error)

GetCredentials - Returns all virtual clusters credentials of a given Virtual Cluster (indexed by ID).

func (*Client) GetDefaultCluster added in v0.3.1

func (c *Client) GetDefaultCluster() (*VirtualCluster, error)

GetDefaultCluster - Return the default virtual cluster.

func (*Client) GetVirtualCluster

func (c *Client) GetVirtualCluster(id string) (*VirtualCluster, error)

GetVirtualCluster - Returns description of virtual cluster.

func (*Client) GetVirtualClusters

func (c *Client) GetVirtualClusters() ([]VirtualCluster, error)

GetVirtualClusters - Returns list of virtual clusters.

func (*Client) UpdateConfiguration added in v0.4.0

func (c *Client) UpdateConfiguration(cfg VirtualClusterConfiguration, vc VirtualCluster) error

UpdateConfiguration - Update virtual cluster configuration.

type ClusterParameters added in v0.8.0

type ClusterParameters struct {
	Type   string
	Region string
	Cloud  string
}

type ConfigurationDescribeRequest added in v0.4.0

type ConfigurationDescribeRequest struct {
	VirtualClusterID string `json:"virtual_cluster_id"`
}

type ConfigurationDescribeResponse added in v0.4.0

type ConfigurationDescribeResponse struct {
	Configuration VirtualClusterConfiguration `json:"virtual_cluster_configuration"`
}

type ConfigurationUpdateRequest added in v0.4.0

type ConfigurationUpdateRequest struct {
	VirtualClusterID string                      `json:"virtual_cluster_id"`
	Configuration    VirtualClusterConfiguration `json:"virtual_cluster_configuration"`
}

type CredentialsCreateRequest added in v0.2.0

type CredentialsCreateRequest struct {
	Name             string `json:"credentials_name"`
	AgentPoolID      string `json:"agent_pool_id"`
	VirtualClusterID string `json:"virtual_cluster_id"`
	ClusterSuperuser bool   `json:"is_cluster_superuser"`
}

type CredentialsCreateResponse added in v0.2.0

type CredentialsCreateResponse struct {
	ID       string `json:"id"`
	UserName string `json:"username"`
	Password string `json:"password"`
}

type CredentialsDeleteRequest added in v0.2.0

type CredentialsDeleteRequest struct {
	ID               string `json:"id"`
	VirtualClusterID string `json:"virtual_cluster_id"`
}

type CredentialsListRequest added in v0.2.0

type CredentialsListRequest struct {
	VirtualClusterID string `json:"virtual_cluster_id"`
}

type CredentialsListResponse added in v0.2.0

type CredentialsListResponse struct {
	Credentials []VirtualClusterCredentials `json:"credentials"`
}

type VirtualCluster

type VirtualCluster struct {
	ID            string `json:"id"`
	Name          string `json:"name"`
	Type          string `json:"type"`
	AgentPoolID   string `json:"agent_pool_id"`
	AgentPoolName string `json:"agent_pool_name"`
	CreatedAt     string `json:"created_at"`
	Region        string `json:"region"`
	CloudProvider string `json:"cloud_provider"`
}

type VirtualClusterConfiguration added in v0.4.0

type VirtualClusterConfiguration struct {
	AclsEnabled            bool  `json:"are_acls_enabled"`
	AutoCreateTopic        bool  `json:"is_auto_create_topic_enabled"`
	DefaultNumPartitions   int64 `json:"default_num_partitions"`
	DefaultRetentionMillis int64 `json:"default_retention_millis"`
}

type VirtualClusterCreateRequest

type VirtualClusterCreateRequest struct {
	Name          string `json:"virtual_cluster_name"`
	Type          string `json:"virtual_cluster_type,omitempty"`
	Region        string `json:"virtual_cluster_region,omitempty"`
	CloudProvider string `json:"virtual_cluster_cloud_provider,omitempty"`
}

type VirtualClusterCreateResponse

type VirtualClusterCreateResponse struct {
	VirtualClusterID string `json:"virtual_cluster_id"`
	AgentPoolID      string `json:"agent_pool_id"`
	AgentPoolName    string `json:"agent_pool_name"`
}

type VirtualClusterCredentials added in v0.2.0

type VirtualClusterCredentials struct {
	ID               string `json:"id"`
	Name             string `json:"name"`
	UserName         string `json:"username"`
	Password         string `json:"password"`
	CreatedAt        string `json:"created_at"`
	AgentPoolID      string `json:"agent_pool_id"`
	AgentPoolName    string `json:"agent_pool_name"`
	ClusterSuperuser bool   `json:"is_cluster_superuser"`
}

type VirtualClusterDeleteRequest

type VirtualClusterDeleteRequest struct {
	ID   string `json:"virtual_cluster_id"`
	Name string `json:"virtual_cluster_name"`
}

type VirtualClusterDescribeRequest

type VirtualClusterDescribeRequest struct {
	ID string `json:"virtual_cluster_id"`
}

type VirtualClusterDescribeResponse

type VirtualClusterDescribeResponse struct {
	VirtualCluster VirtualCluster `json:"virtual_cluster"`
}

type VirtualClusterListResponse

type VirtualClusterListResponse struct {
	VirtualClusters []VirtualCluster `json:"virtual_clusters"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL