api

package
v0.10.0 Latest Latest
Warning

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

 Go to latest Published: Jul 23, 2024 License: MPL-2.0 Imports: 12 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.

View Source 
const PrincipalKindAgent = "agent"
View Source 
const ResourceKindVirtualCluster = "virtual_cluster"

Variables

This section is empty.

Functions

This section is empty.

Types

type APIKey added in v0.9.0 

type APIKey struct {
	ID           string        `json:"id"`
	Name         string        `json:"name"`
	Key          string        `json:"key"`
	AccessGrants []AccessGrant `json:"access_grants"`
	CreatedAt    string        `json:"created_at"`
}

type APIKeyCreateRequest added in v0.9.0 

type APIKeyCreateRequest struct {
	Name         string              `json:"name"` // No `akn_` prefix.
	AccessGrants []map[string]string `json:"access_grants"`
}

type APIKeyDeleteRequest added in v0.9.0 

type APIKeyDeleteRequest struct {
	ID string `json:"api_key_id"`
}

type APIKeyListResponse added in v0.9.0 

type APIKeyListResponse struct {
	APIKeys []APIKey `json:"api_keys"`
}

type AccessGrant added in v0.9.0 

type AccessGrant struct {
	PrincipalKind string `json:"principal_kind"`
	ResourceKind  string `json:"resource_kind"`
	ResourceID    string `json:"resource_id"`
}

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) ChangePipelineState added in v0.9.0 

func (c *Client) ChangePipelineState(
	ctx context.Context,
	req HTTPChangePipelineStateRequest,
) (HTTPChangePipelineStateResponse, error)

func (*Client) CreateAgentKey added in v0.9.0 

func (c *Client) CreateAgentKey(name, virtualClusterID string) (*APIKey, error)

CreateAgentKey - Create new Agent Key. Supports creating keys with just one access grant for now.

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) CreatePipeline added in v0.9.0 

func (c *Client) CreatePipeline(
	ctx context.Context,
	req HTTPCreatePipelineRequest,
) (HTTPCreatePipelineResponse, error)

func (*Client) CreatePipelineConfiguration added in v0.9.0 

func (c *Client) CreatePipelineConfiguration(
	ctx context.Context,
	req HTTPCreatePipelineConfigurationRequest,
) (HTTPCreatePipelineConfigurationResponse, error)

func (*Client) CreateVirtualCluster 

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

CreateVirtualCluster - Create new virtual cluster.

func (*Client) DeleteAPIKey added in v0.9.0 

func (c *Client) DeleteAPIKey(id string) error

DeleteAPIKey - Delete an API Key.

func (*Client) DeleteCredentials added in v0.2.0 

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

DeleteCredentials - Delete virtual cluster credentials.

func (*Client) DeletePipeline added in v0.9.0 

func (c *Client) DeletePipeline(
	ctx context.Context,
	req HTTPDeletePipelineRequest,
) (HTTPDeletePipelineResponse, error)

func (*Client) DeleteVirtualCluster 

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

DeleteVirtualCluster - Delete a virtual cluster.

func (*Client) DescribePipeline added in v0.9.0 

func (c *Client) DescribePipeline(
	ctx context.Context,
	req HTTPDescribePipelineRequest,
) (HTTPDescribePipelineResponse, error)

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) GetAPIKey added in v0.9.0 

func (c *Client) GetAPIKey(apiKeyID string) (*APIKey, error)

GetAPIKeys - Returns list of API keys.

func (*Client) GetAPIKeys added in v0.9.0 

func (c *Client) GetAPIKeys() ([]APIKey, error)

GetAPIKeys - Returns list of API keys.

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) ListPipelines added in v0.9.0 

func (c *Client) ListPipelines(
	ctx context.Context,
	req HTTPListPipelinesRequest,
) (HTTPListPipelinesResponse, error)

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 HTTPChangePipelineStateRequest added in v0.9.0 

type HTTPChangePipelineStateRequest struct {
	VirtualClusterID        string  `json:"virtual_cluster_id"`
	PipelineID              string  `json:"pipeline_id"`
	DesiredState            *string `json:"desired_state"`
	DeployedConfigurationID *string `json:"deployed_configuration_id"`
}

type HTTPChangePipelineStateResponse added in v0.9.0 

type HTTPChangePipelineStateResponse struct {
}

type HTTPCreatePipelineConfigurationRequest added in v0.9.0 

type HTTPCreatePipelineConfigurationRequest struct {
	VirtualClusterID  string `json:"virtual_cluster_id"`
	PipelineID        string `json:"pipeline_id"`
	ConfigurationYAML string `json:"configuration_yaml"`
}

type HTTPCreatePipelineConfigurationResponse added in v0.9.0 

type HTTPCreatePipelineConfigurationResponse struct {
	ConfigurationID string `json:"configuration_id"`
}

type HTTPCreatePipelineRequest added in v0.9.0 

type HTTPCreatePipelineRequest struct {
	VirtualClusterID string `json:"virtual_cluster_id"`
	PipelineName     string `json:"pipeline_name"`
}

type HTTPCreatePipelineResponse added in v0.9.0 

type HTTPCreatePipelineResponse struct {
	PipelineID                      string `json:"pipeline_id"`
	PipelineName                    string `json:"pipeline_name"`
	PipelineState                   string `json:"pipeline_state"`
	PipelineType                    string `json:"pipeline_type"`
	PipelineDeployedConfigurationId string `json:"pipeline_deployed_configuration_id"`
}

type HTTPDeletePipelineRequest added in v0.9.0 

type HTTPDeletePipelineRequest struct {
	VirtualClusterID string `json:"virtual_cluster_id"`
	PipelineID       string `json:"pipeline_id"`
}

type HTTPDeletePipelineResponse added in v0.9.0 

type HTTPDeletePipelineResponse struct {
}

type HTTPDescribePipelineRequest added in v0.9.0 

type HTTPDescribePipelineRequest struct {
	VirtualClusterID string `json:"virtual_cluster_id"`
	PipelineID       string `json:"pipeline_id"`
}

type HTTPDescribePipelineResponse added in v0.9.0 

type HTTPDescribePipelineResponse struct {
	PipelineOverview HTTPPipelineOverview        `json:"pipeline_overview"`
	Configurations   []HTTPPipelineConfiguration `json:"pipeline_configurations"`
}

type HTTPListPipelinesRequest added in v0.9.0 

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

type HTTPListPipelinesResponse added in v0.9.0 

type HTTPListPipelinesResponse struct {
	Pipelines []HTTPPipelineOverview `json:"pipelines"`
}

type HTTPPipelineConfiguration added in v0.9.0 

type HTTPPipelineConfiguration struct {
	ID                string `json:"id"`
	Version           int    `json:"version"`
	ConfigurationYAML string `json:"configuration_yaml"`
}

type HTTPPipelineOverview added in v0.9.0 

type HTTPPipelineOverview struct {
	ID                      string `json:"id"`
	Name                    string `json:"name"`
	State                   string `json:"state"`
	Type                    string `json:"type"`
	DeployedConfigurationId string `json:"deployed_configuration_id"`
}

type VirtualCluster 

type VirtualCluster struct {
	ID            string    `json:"id"`
	Name          string    `json:"name"`
	Type          string    `json:"type"`
	AgentKeys     *[]APIKey `json:"agent_keys"`
	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"`
	BootstrapURL  *string   `json:"bootstrap_url"`
}

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"`
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.