client

package
v0.0.0-...-55d440c Latest Latest
Warning

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

 Go to latest Published: May 17, 2024 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetHostVersion 

func GetHostVersion() string

GetHostVersion fetches the version of YBA Host

func GetVersion 

func GetVersion() string

GetVersion fetches the version of YBA CLI

func ParseURL 

func ParseURL(host string) (*url.URL, error)

ParseURL returns a URL if string is valid, or returns error

func SetHostVersion 

func SetHostVersion(version string)

SetHostVersion assigns the version of YBA Host

func SetVersion 

func SetVersion(version string)

SetVersion assigns the version of YBA CLI

Types

type AuthAPIClient 

type AuthAPIClient struct {
	APIClient    *ybaclient.APIClient
	CustomerUUID string
	// contains filtered or unexported fields
}

AuthAPIClient contains authenticated api client and customer UUID

func NewAuthAPIClient 

func NewAuthAPIClient() (*AuthAPIClient, error)

NewAuthAPIClient function is returning a new AuthAPIClient Client

func NewAuthAPIClientAndCustomer 

func NewAuthAPIClientAndCustomer() *AuthAPIClient

NewAuthAPIClientAndCustomer before every command to access YBA host

func NewAuthAPIClientInitialize 

func NewAuthAPIClientInitialize(url *url.URL, apiToken string) (*AuthAPIClient, error)

NewAuthAPIClientInitialize function is returning a new AuthAPIClient Client

func (*AuthAPIClient) AbortTask 

func (a *AuthAPIClient) AbortTask(tUUID string) ybaclient.CustomerTasksApiApiAbortTaskRequest

AbortTask triggers abort task API

func (*AuthAPIClient) ApiLogin 

func (a *AuthAPIClient) ApiLogin() ybaclient.SessionManagementApiApiApiLoginRequest

ApiLogin fetches API Token and CustomerUUID

func (*AuthAPIClient) CheckValidYBAVersion 

func (a *AuthAPIClient) CheckValidYBAVersion(versions YBAMinimumVersion) (bool,
	string, error)

CheckValidYBAVersion allows operation if version is higher than listed versions For releases older than 2024.1, keeping both stable and preview min version as the same version would provide the correct result For features on and after 2024.1, min stable and min preview must be different

func (*AuthAPIClient) CreateAllClusters 

func (a *AuthAPIClient) CreateAllClusters() ybaclient.UniverseClusterMutationsApiApiCreateAllClustersRequest

CreateAllClusters creates a universe with a minimum of 1 cluster

func (*AuthAPIClient) CreateBackup 

func (a *AuthAPIClient) CreateBackup() ybaclient.BackupsApiApiCreatebackupRequest

CreateBackup creates backups associated with the universe

func (*AuthAPIClient) CreateBackupSchedule 

func (a *AuthAPIClient) CreateBackupSchedule() ybaclient.BackupsApiApiCreateBackupScheduleAsyncRequest

func (*AuthAPIClient) CreateCustomerConfig 

func (a *AuthAPIClient) CreateCustomerConfig() ybaclient.CustomerConfigurationApiApiCreateCustomerConfigRequest

CreateCustomerConfig creates configs associated with the customer

func (*AuthAPIClient) CreateInstanceType 

func (a *AuthAPIClient) CreateInstanceType(pUUID string) ybaclient.InstanceTypesApiApiCreateInstanceTypeRequest

CreateInstanceType for onprem providers

func (*AuthAPIClient) CreateNodeInstance 

func (a *AuthAPIClient) CreateNodeInstance(azUUID string) ybaclient.NodeInstancesApiApiCreateNodeInstanceRequest

CreateNodeInstance adds a node instance to an onprem provider

func (*AuthAPIClient) CreateProvider 

func (a *AuthAPIClient) CreateProvider() ybaclient.CloudProvidersApiApiCreateProvidersRequest

CreateProvider calls the create provider API

func (*AuthAPIClient) DeleteBackupSchedule 

func (a *AuthAPIClient) DeleteBackupSchedule(scheduleUUID string) ybaclient.ScheduleManagementApiApiDeleteScheduleV2Request

func (*AuthAPIClient) DeleteBackups 

func (a *AuthAPIClient) DeleteBackups() ybaclient.BackupsApiApiDeleteBackupsV2Request

func (*AuthAPIClient) DeleteCustomerConfig 

func (a *AuthAPIClient) DeleteCustomerConfig(configUUID string) ybaclient.CustomerConfigurationApiApiDeleteCustomerConfigRequest

DeleteCustomerConfig deletes configs associated with the customer

func (*AuthAPIClient) DeleteInstance 

func (a *AuthAPIClient) DeleteInstance(pUUID, ip string) ybaclient.NodeInstancesApiApiDeleteInstanceRequest

DeleteInstance deletes the node instance from the onprem provider

func (*AuthAPIClient) DeleteInstanceType 

func (a *AuthAPIClient) DeleteInstanceType(pUUID, instanceTypeName string) ybaclient.InstanceTypesApiApiDeleteInstanceTypeRequest

DeleteInstanceType for onprem providers

func (*AuthAPIClient) DeleteProvider 

func (a *AuthAPIClient) DeleteProvider(pUUID string) ybaclient.CloudProvidersApiApiDeleteRequest

DeleteProvider deletes provider associated with the providerUUID

func (*AuthAPIClient) DeleteUniverse 

func (a *AuthAPIClient) DeleteUniverse(uUUID string) ybaclient.UniverseManagementApiApiDeleteUniverseRequest

DeleteUniverse deletes universe associated with the universeUUID

func (*AuthAPIClient) DetachedNodeAction 

func (a *AuthAPIClient) DetachedNodeAction(pUUID, ip string) ybaclient.NodeInstancesApiApiDetachedNodeActionRequest

DetachedNodeAction deletes the node instance from the onprem provider

func (*AuthAPIClient) EditBackup 

func (a *AuthAPIClient) EditBackup(backupUUID string) ybaclient.BackupsApiApiEditBackupV2Request

func (*AuthAPIClient) EditBackupSchedule 

func (a *AuthAPIClient) EditBackupSchedule(scheduleUUID string) ybaclient.ScheduleManagementApiApiEditBackupScheduleV2Request

func (*AuthAPIClient) EditCustomerConfig 

func (a *AuthAPIClient) EditCustomerConfig(configUUID string) ybaclient.CustomerConfigurationApiApiEditCustomerConfigRequest

EditCustomerConfig edits configs associated with the customer

func (*AuthAPIClient) EditProvider 

func (a *AuthAPIClient) EditProvider(pUUID string) ybaclient.CloudProvidersApiApiEditProviderRequest

EditProvider edits the provider associated with the providerUUIS

func (*AuthAPIClient) GetAppVersion 

func (a *AuthAPIClient) GetAppVersion() ybaclient.SessionManagementApiApiAppVersionRequest

GetAppVersion fetches YugabyteDB Anywhere version

func (*AuthAPIClient) GetBackupByTasKUUID 

func (a *AuthAPIClient) GetBackupByTasKUUID(universeUUID string, taskUUID string) ybaclient.BackupsApiApiFetchBackupsByTaskUUIDRequest

func (*AuthAPIClient) GetBackupSchedule 

func (a *AuthAPIClient) GetBackupSchedule(scheduleUUID string) ybaclient.ScheduleManagementApiApiGetScheduleRequest

func (*AuthAPIClient) GetCustomerTaskStatus 

func (a *AuthAPIClient) GetCustomerTaskStatus(taskUUID string) ybaclient.CustomerTasksApiApiTaskStatusRequest

GetCustomerTaskStatus fetches the customer task status

func (*AuthAPIClient) GetCustomerUUID 

func (a *AuthAPIClient) GetCustomerUUID() error

GetCustomerUUID fetches YugabyteDB Anywhere customer UUID

func (*AuthAPIClient) GetListOfCertificates 

func (a *AuthAPIClient) GetListOfCertificates() ybaclient.CertificateInfoApiApiGetListOfCertificateRequest

GetListOfCertificates fetches list of certificates associated with the customer

func (*AuthAPIClient) GetListOfCustomerConfig 

func (a *AuthAPIClient) GetListOfCustomerConfig() ybaclient.CustomerConfigurationApiApiGetListOfCustomerConfigRequest

GetListOfCustomerConfig fetches list of configs associated with the customer

func (*AuthAPIClient) GetListOfProviders 

func (a *AuthAPIClient) GetListOfProviders() ybaclient.CloudProvidersApiApiGetListOfProvidersRequest

GetListOfProviders fetches list of providers associated with the customer

func (*AuthAPIClient) GetListOfReleases 

func (a *AuthAPIClient) GetListOfReleases(includeMetadata bool) ybaclient.ReleaseManagementApiApiGetListOfReleasesRequest

GetListOfReleases API to fetch list of releases

func (*AuthAPIClient) GetNodeDetails 

func (a *AuthAPIClient) GetNodeDetails(uUUID, nName string) ybaclient.NodeInstancesApiApiGetNodeDetailsRequest

GetNodeDetails fetches a node based on UUID

func (*AuthAPIClient) GetNodeInstance 

func (a *AuthAPIClient) GetNodeInstance(nUUID string) ybaclient.NodeInstancesApiApiGetNodeInstanceRequest

GetNodeInstance fetches a node based on UUID

func (*AuthAPIClient) GetProvider 

func (a *AuthAPIClient) GetProvider(pUUID string) ybaclient.CloudProvidersApiApiGetProviderRequest

GetProvider fetches provider associated with the customer and providerUUID

func (*AuthAPIClient) GetRegion 

func (a *AuthAPIClient) GetRegion(pUUID string) ybaclient.RegionManagementApiApiGetRegionRequest

GetRegion fetches region list of a provider

func (*AuthAPIClient) GetRestore 

func (a *AuthAPIClient) GetRestore() ybaclient.BackupsApiApiListBackupRestoresV2Request

func (*AuthAPIClient) GetSessionInfo 

func (a *AuthAPIClient) GetSessionInfo() ybaclient.SessionManagementApiApiGetSessionInfoRequest

GetSessionInfo fetches YugabyteDB Anywhere session info

func (*AuthAPIClient) GetUniverse 

func (a *AuthAPIClient) GetUniverse(uUUID string) ybaclient.UniverseManagementApiApiGetUniverseRequest

GetUniverse fetches of universe associated with the universeUUID

func (*AuthAPIClient) InstanceTypeDetail 

func (a *AuthAPIClient) InstanceTypeDetail(pUUID, instanceTypeName string) ybaclient.InstanceTypesApiApiInstanceTypeDetailRequest

InstanceTypeDetail fetches details of the instance type in an onprem provider

func (*AuthAPIClient) IsCLISupported 

func (a *AuthAPIClient) IsCLISupported()

func (*AuthAPIClient) List 

func (a *AuthAPIClient) List(pUUID string) ybaclient.AccessKeysApiApiListRequest

List fetches the list of access keys associated with the provider

func (*AuthAPIClient) ListBackupSchedules 

func (a *AuthAPIClient) ListBackupSchedules() ybaclient.ScheduleManagementApiApiListSchedulesV2Request

func (*AuthAPIClient) ListBackups 

func (a *AuthAPIClient) ListBackups() ybaclient.BackupsApiApiListBackupsV2Request

List Backups

func (*AuthAPIClient) ListByProvider 

func (a *AuthAPIClient) ListByProvider(pUUID string) ybaclient.NodeInstancesApiApiListByProviderRequest

ListByProvider fetches node instances associated to an onprem provider

func (*AuthAPIClient) ListFailedSubtasks 

func (a *AuthAPIClient) ListFailedSubtasks(taskUUID string) ybaclient.CustomerTasksApiApiListFailedSubtasksRequest

ListFailedSubtasks fetches the customer failed task status

func (*AuthAPIClient) ListIncrementalBackups 

func (a *AuthAPIClient) ListIncrementalBackups(backupUUID string) ybaclient.BackupsApiApiListIncrementalBackupsRequest

func (*AuthAPIClient) ListKMSConfigs 

func (a *AuthAPIClient) ListKMSConfigs() ybaclient.EncryptionAtRestApiApiListKMSConfigsRequest

ListKMSConfigs fetches list of universes associated with the customer

func (*AuthAPIClient) ListOfAZ 

func (a *AuthAPIClient) ListOfAZ(pUUID, rUUID string) ybaclient.AvailabilityZonesApiApiListOfAZRequest

ListOfAZ fetches az list of a provider region

func (*AuthAPIClient) ListOfInstanceType 

func (a *AuthAPIClient) ListOfInstanceType(pUUID string) ybaclient.InstanceTypesApiApiListOfInstanceTypeRequest

ListOfInstanceType fetches the list of instance types associated with the provider (for onprem)

func (*AuthAPIClient) ListRestores 

func (a *AuthAPIClient) ListRestores() ybaclient.BackupsApiApiListBackupRestoresV2Request

func (*AuthAPIClient) ListUniverses 

func (a *AuthAPIClient) ListUniverses() ybaclient.UniverseManagementApiApiListUniversesRequest

ListUniverses fetches list of universes associated with the customer

func (*AuthAPIClient) NewProviderYBAVersionCheck 

func (a *AuthAPIClient) NewProviderYBAVersionCheck() (bool, string, error)

NewProviderYBAVersionCheck checks if the new API request body can be used for the Create Provider API

func (*AuthAPIClient) NodeAction 

func (a *AuthAPIClient) NodeAction(uUUID, nodeName string) ybaclient.NodeInstancesApiApiNodeActionRequest

NodeAction for the node operations for universes

func (*AuthAPIClient) Refresh 

func (a *AuthAPIClient) Refresh() ybaclient.ReleaseManagementApiApiRefreshRequest

Refresh the releases page to get the latest YugabyteDB releases

func (*AuthAPIClient) RegisterCustomer 

func (a *AuthAPIClient) RegisterCustomer() ybaclient.SessionManagementApiApiRegisterCustomerRequest

RegisterCustomer registers a YugabyteDB Anywhere customer

func (*AuthAPIClient) RestartUniverse 

func (a *AuthAPIClient) RestartUniverse(uUUID string) ybaclient.UniverseUpgradesManagementApiApiRestartUniverseRequest

RestartUniverse for restart operation

func (*AuthAPIClient) RestoreBackup 

func (a *AuthAPIClient) RestoreBackup() ybaclient.BackupsApiApiRestoreBackupV2Request

func (*AuthAPIClient) RetryTask 

func (a *AuthAPIClient) RetryTask(tUUID string) ybaclient.CustomerTasksApiApiRetryTaskRequest

RetryTask triggers retry universe/provider API

func (*AuthAPIClient) TasksList 

func (a *AuthAPIClient) TasksList() ybaclient.CustomerTasksApiApiTasksListRequest

TasksList triggers abort task API

func (*AuthAPIClient) UniverseYBAVersionCheck 

func (a *AuthAPIClient) UniverseYBAVersionCheck() (bool, string, error)

UniverseYBAVersionCheck checks if the new API request body can be used for the Create Provider API

func (*AuthAPIClient) UpgradeGFlags 

func (a *AuthAPIClient) UpgradeGFlags(uUUID string) ybaclient.UniverseUpgradesManagementApiApiUpgradeGFlagsRequest

UpgradeGFlags upgrades the universe gflags

func (*AuthAPIClient) UpgradeSoftware 

func (a *AuthAPIClient) UpgradeSoftware(uUUID string) ybaclient.UniverseUpgradesManagementApiApiUpgradeSoftwareRequest

UpgradeSoftware upgrades the universe YugabyteDB version

func (*AuthAPIClient) WaitForTask 

func (a *AuthAPIClient) WaitForTask(taskUUID, message string) error

WaitForTask waits for state changes for a YugabyteDB Anywhere task

func (*AuthAPIClient) WaitForTaskCI 

func (a *AuthAPIClient) WaitForTaskCI(taskUUID, message string) error

WaitForTaskCI waits for State change for a YugabyteDB Anywhere task for CI

func (*AuthAPIClient) WaitForTaskProgressBar 

func (a *AuthAPIClient) WaitForTaskProgressBar(taskUUID, message string) error

WaitForTaskProgressBar waits for State change for a YugabyteDB Anywhere task

type YBAMinimumVersion 

type YBAMinimumVersion struct {
	Stable  string
	Preview string
}

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.