client

Documentation

Index

• Constants
• Variables
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig
• type YugabyteDBAnywhereAPIs
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *YugabyteDBAnywhereAPIs
  • func NewHTTPClient(formats strfmt.Registry) *YugabyteDBAnywhereAPIs
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *YugabyteDBAnywhereAPIs
  • func (c *YugabyteDBAnywhereAPIs) SetTransport(transport runtime.ClientTransport)

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "localhost"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/"
)

Variables

var Default = NewHTTPClient(nil)

Default yugabyte d b anywhere a p is HTTP client.

var DefaultSchemes = []string{"http", "https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.

type YugabyteDBAnywhereAPIs

type YugabyteDBAnywhereAPIs struct {
	AccessKeys access_keys.ClientService

	Alerts alerts.ClientService

	AsynchronousReplication asynchronous_replication.ClientService

	Audit audit.ClientService

	AvailabilityZones availability_zones.ClientService

	Backups backups.ClientService

	CertificateInfo certificate_info.ClientService

	CloudProviders cloud_providers.ClientService

	CustomerConfiguration customer_configuration.ClientService

	CustomerManagement customer_management.ClientService

	CustomerTasks customer_tasks.ClientService

	EncryptionAtRest encryption_at_rest.ClientService

	GrafanaDashboard grafana_dashboard.ClientService

	InstanceTypes instance_types.ClientService

	LoggingConfig logging_config.ClientService

	MaintenanceWindows maintenance_windows.ClientService

	Metrics metrics.ClientService

	NodeInstances node_instances.ClientService

	RegionManagement region_management.ClientService

	ReleaseManagement release_management.ClientService

	RuntimeConfiguration runtime_configuration.ClientService

	ScheduleManagement schedule_management.ClientService

	SessionManagement session_management.ClientService

	SupportBundleManagement support_bundle_management.ClientService

	TableManagement table_management.ClientService

	TabletServerManagement tablet_server_management.ClientService

	UniverseActions universe_actions.ClientService

	UniverseClusterMutations universe_cluster_mutations.ClientService

	UniverseDatabaseManagement universe_database_management.ClientService

	UniverseInformation universe_information.ClientService

	UniverseManagement universe_management.ClientService

	UniverseNodeMetadataMetamaster universe_node_metadata_metamaster.ClientService

	UniverseUpgradesManagement universe_upgrades_management.ClientService

	UserManagement user_management.ClientService

	Transport runtime.ClientTransport
}

YugabyteDBAnywhereAPIs is a client for yugabyte d b anywhere a p is

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *YugabyteDBAnywhereAPIs

New creates a new yugabyte d b anywhere a p is client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *YugabyteDBAnywhereAPIs

NewHTTPClient creates a new yugabyte d b anywhere a p is HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *YugabyteDBAnywhereAPIs

NewHTTPClientWithConfig creates a new yugabyte d b anywhere a p is HTTP client, using a customizable transport config.

func (*YugabyteDBAnywhereAPIs) SetTransport

func (c *YugabyteDBAnywhereAPIs) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources