client

package
v0.0.0-...-8abd549 Latest Latest
Warning

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

 Go to latest Published: Jan 18, 2025 License: Apache-2.0 Imports: 21 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 {
	RestClient   *RestAPIClient
	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) ApiToken 

func (a *AuthAPIClient) ApiToken() ybaclient.SessionManagementApiApiApiTokenRequest

ApiToken regenerates and fetches unmasked API token

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

CreateBackupSchedule creates a backup schedule

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) CreateKMSConfig 

func (a *AuthAPIClient) CreateKMSConfig(providerType string) ybaclient.EncryptionAtRestApiApiCreateKMSConfigRequest

CreateKMSConfig creates kms config

func (*AuthAPIClient) CreateNewRelease 

func (a *AuthAPIClient) CreateNewRelease() ybaclient.NewReleaseManagementApiApiCreateNewReleaseRequest

CreateNewRelease API to create new release

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) CreateRole 

func (a *AuthAPIClient) CreateRole() ybaclient.RBACManagementApiApiCreateRoleRequest

CreateRole creates role

func (*AuthAPIClient) CreateUser 

func (a *AuthAPIClient) CreateUser() ybaclient.UserManagementApiApiCreateUserRequest

CreateUser creates a new user

func (*AuthAPIClient) CreateXClusterConfig 

func (a *AuthAPIClient) CreateXClusterConfig() ybaclient.AsynchronousReplicationApiApiCreateXClusterConfigRequest

CreateXClusterConfig create xCluster config

func (*AuthAPIClient) DeleteBackupSchedule 

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

DeleteBackupSchedule deletes the backup schedule

func (*AuthAPIClient) DeleteBackups 

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

DeleteBackups deletes the backups

func (*AuthAPIClient) DeleteCertificate 

func (a *AuthAPIClient) DeleteCertificate(certUUID string) ybaclient.CertificateInfoApiApiDeleteCertificateRequest

DeleteCertificate - delete certificate

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) DeleteKMSConfig 

func (a *AuthAPIClient) DeleteKMSConfig(configUUID string) ybaclient.EncryptionAtRestApiApiDeleteKMSConfigRequest

DeleteKMSConfig deletes kms config

func (*AuthAPIClient) DeleteKey 

func (a *AuthAPIClient) DeleteKey(scope, key string) ybaclient.RuntimeConfigurationApiApiDeleteKeyRequest

DeleteKey deletes runtime configuration key

func (*AuthAPIClient) DeleteNewRelease 

func (a *AuthAPIClient) DeleteNewRelease(rUUID string) ybaclient.NewReleaseManagementApiApiDeleteNewReleaseRequest

DeleteNewRelease API to delete new release

func (*AuthAPIClient) DeleteProvider 

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

DeleteProvider deletes provider associated with the providerUUID

func (*AuthAPIClient) DeleteRole 

func (a *AuthAPIClient) DeleteRole(rUUID string) ybaclient.RBACManagementApiApiDeleteRoleRequest

DeleteRole deletes role

func (*AuthAPIClient) DeleteUniverse 

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

DeleteUniverse deletes universe associated with the universeUUID

func (*AuthAPIClient) DeleteUser 

func (a *AuthAPIClient) DeleteUser(uUUID string) ybaclient.UserManagementApiApiDeleteUserRequest

DeleteUser deletes a user

func (*AuthAPIClient) DeleteXClusterConfig 

func (a *AuthAPIClient) DeleteXClusterConfig(xclusterUUID string) ybaclient.AsynchronousReplicationApiApiDeleteXClusterConfigRequest

DeleteXClusterConfig delete xCluster config

func (*AuthAPIClient) DescribeTable 

func (a *AuthAPIClient) DescribeTable(uUUID, tUUID string) ybaclient.TableManagementApiApiDescribeTableRequest

DescribeTable for the description of a table in the universe

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

EditBackup edits a backup

func (*AuthAPIClient) EditBackupSchedule 

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

EditBackupSchedule edits a backup schedule

func (*AuthAPIClient) EditCertificate 

func (a *AuthAPIClient) EditCertificate(certUUID string) ybaclient.CertificateInfoApiApiEditCertificateRequest

EditCertificate - edit certificate

func (*AuthAPIClient) EditCustomerConfig 

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

EditCustomerConfig edits configs associated with the customer

func (*AuthAPIClient) EditKMSConfig 

func (a *AuthAPIClient) EditKMSConfig(configUUID string) ybaclient.EncryptionAtRestApiApiEditKMSConfigRequest

EditKMSConfig edits kms config

func (*AuthAPIClient) EditProvider 

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

EditProvider edits the provider associated with the providerUUIS

func (*AuthAPIClient) EditRole 

func (a *AuthAPIClient) EditRole(rUUID string) ybaclient.RBACManagementApiApiEditRoleRequest

EditRole edits role

func (*AuthAPIClient) EditXClusterConfig 

func (a *AuthAPIClient) EditXClusterConfig(xclusterUUID string) ybaclient.AsynchronousReplicationApiApiEditXClusterConfigRequest

EditXClusterConfig edit xCluster config

func (*AuthAPIClient) ExtractMetadata 

func (a *AuthAPIClient) ExtractMetadata() ybaclient.ExtractMetadataFromRemoteTarballApiApiExtractMetadataRequest

ExtractMetadata API to extract metadata from tarball

func (*AuthAPIClient) GetAllNamespaces 

func (a *AuthAPIClient) GetAllNamespaces(uUUID string) ybaclient.TableManagementApiApiGetAllNamespacesRequest

GetAllNamespaces for the listing of all namespaces in the universe

func (*AuthAPIClient) GetAllTableSpaces 

func (a *AuthAPIClient) GetAllTableSpaces(uUUID string) ybaclient.TableManagementApiApiGetAllTableSpacesRequest

GetAllTableSpaces for the listing of all table spaces in the universe

func (*AuthAPIClient) GetAllTables 

func (a *AuthAPIClient) GetAllTables(uUUID string) ybaclient.TableManagementApiApiGetAllTablesRequest

GetAllTables for the listing of all tables in the universe

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

GetBackupByTaskUUID fetches backups by the universe and task UUID

func (*AuthAPIClient) GetBackupSchedule 

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

GetBackupSchedule fetches backups by the universe and task UUID

func (*AuthAPIClient) GetClientCert 

func (a *AuthAPIClient) GetClientCert(certUUID string) ybaclient.CertificateInfoApiApiGetClientCertRequest

GetClientCert - get client certificate

func (*AuthAPIClient) GetConfig 

func (a *AuthAPIClient) GetConfig(scope string) ybaclient.RuntimeConfigurationApiApiGetConfigRequest

GetConfig fetches runtime configuration

func (*AuthAPIClient) GetConfigurationKey 

func (a *AuthAPIClient) GetConfigurationKey(scope, key string) ybaclient.RuntimeConfigurationApiApiGetConfigurationKeyRequest

GetConfigurationKey fetches runtime configuration key

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) GetExtractMetadata 

func (a *AuthAPIClient) GetExtractMetadata(fileUUID string) ybaclient.ExtractMetadataFromRemoteTarballApiApiExtractMetadata_0Request

GetExtractMetadata API to get extract metadata

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) GetNewRelease 

func (a *AuthAPIClient) GetNewRelease(rUUID string) ybaclient.NewReleaseManagementApiApiGetNewReleaseRequest

GetNewRelease API to fetch list of new 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

GetRestore fetches restores of the customer

func (*AuthAPIClient) GetRole 

func (a *AuthAPIClient) GetRole(rUUID string) ybaclient.RBACManagementApiApiGetRoleRequest

GetRole fetches role

func (*AuthAPIClient) GetRoleBindings 

func (a *AuthAPIClient) GetRoleBindings() ybaclient.RBACManagementApiApiGetRoleBindingsRequest

GetRoleBindings fetches role bindings

func (*AuthAPIClient) GetRootCert 

func (a *AuthAPIClient) GetRootCert(certUUID string) ybaclient.CertificateInfoApiApiGetRootCertRequest

GetRootCert - get root certificate

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) GetUploadRelease 

func (a *AuthAPIClient) GetUploadRelease(fileUUID string) ybaclient.UploadReleasePackagesApiApiGetUploadReleaseRequest

GetUploadRelease API to get URL

func (*AuthAPIClient) GetUserDetails 

func (a *AuthAPIClient) GetUserDetails(
	uUUID string,
) ybaclient.UserManagementApiApiGetUserDetailsRequest

GetUserDetails fetches user details

func (*AuthAPIClient) GetXClusterConfig 

func (a *AuthAPIClient) GetXClusterConfig(xclusterUUID string) ybaclient.AsynchronousReplicationApiApiGetXClusterConfigRequest

GetXClusterConfig get xCluster config

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()

IsCLISupported checks if the CLI version is supported

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

ListBackupSchedules associated with the customer

func (*AuthAPIClient) ListBackupSchedulesRest 

func (a *AuthAPIClient) ListBackupSchedulesRest(
	reqBody ybaclient.SchedulePagedApiQuery,
	operation string,
) (
	util.SchedulePagedResponse, error,
)

ListBackupSchedulesRest uses REST API to call list schedule functionality

func (*AuthAPIClient) ListBackups 

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

ListBackups associated with the customer

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

ListIncrementalBackups lists the incremental backups

func (*AuthAPIClient) ListKMSConfigs 

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

ListKMSConfigs fetches list of kms configs associated with the customer

func (*AuthAPIClient) ListKeyInfo 

func (a *AuthAPIClient) ListKeyInfo() ybaclient.RuntimeConfigurationApiApiListKeyInfoRequest

ListKeyInfo fetches list of mutable runtime configuration keys

func (*AuthAPIClient) ListKeys 

func (a *AuthAPIClient) ListKeys() ybaclient.RuntimeConfigurationApiApiListKeysRequest

ListKeys fetches list of mutable runtime configuration keys

func (*AuthAPIClient) ListNewReleases 

func (a *AuthAPIClient) ListNewReleases() ybaclient.NewReleaseManagementApiApiListNewReleasesRequest

ListNewReleases API to fetch list of new releases

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) ListPermissions 

func (a *AuthAPIClient) ListPermissions() ybaclient.RBACManagementApiApiListPermissionsRequest

ListPermissions fetches list of permissions

func (*AuthAPIClient) ListRestores 

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

ListRestores associated with the customer

func (*AuthAPIClient) ListRoleBindingRest 

func (a *AuthAPIClient) ListRoleBindingRest(
	userUUID, operation string,
) (
	map[string]([]ybaclient.RoleBinding), error,
)

ListRoleBindingRest uses REST API to call list role binding functionality

func (*AuthAPIClient) ListRoles 

func (a *AuthAPIClient) ListRoles() ybaclient.RBACManagementApiApiListRolesRequest

ListRoles fetches list of roles

func (*AuthAPIClient) ListScopes 

func (a *AuthAPIClient) ListScopes() ybaclient.RuntimeConfigurationApiApiListScopesRequest

ListScopes fetches list of mutable runtime configuration scopes

func (*AuthAPIClient) ListUniverses 

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

ListUniverses fetches list of universes associated with the customer

func (*AuthAPIClient) ListUsers 

func (a *AuthAPIClient) ListUsers() ybaclient.UserManagementApiApiListUsersRequest

ListUsers fetches list of users associated with the customer

func (*AuthAPIClient) NeedBootstrapTable 

func (a *AuthAPIClient) NeedBootstrapTable(universeUUID string) ybaclient.AsynchronousReplicationApiApiNeedBootstrapTableRequest

NeedBootstrapTable need bootstrap table

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) NewReleaseYBAVersionCheck 

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

NewReleaseYBAVersionCheck checks if the new release management API can be used

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) ResetUserPassword 

func (a *AuthAPIClient) ResetUserPassword() ybaclient.UserManagementApiApiResetUserPasswordRequest

ResetUserPassword resets the password of the user

func (*AuthAPIClient) RestartUniverse 

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

RestartUniverse for restart operation

func (*AuthAPIClient) RestartXClusterConfig 

func (a *AuthAPIClient) RestartXClusterConfig(xclusterUUID string) ybaclient.AsynchronousReplicationApiApiRestartXClusterConfigRequest

RestartXClusterConfig restart xCluster

func (*AuthAPIClient) RestoreBackup 

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

RestoreBackup restores a backup

func (*AuthAPIClient) RetrieveOIDCAuthToken 

func (a *AuthAPIClient) RetrieveOIDCAuthToken(
	uUUID string,
) ybaclient.UserManagementApiApiRetrieveOIDCAuthTokenRequest

RetrieveOIDCAuthToken fetches the OIDC JWT auth token

func (*AuthAPIClient) RetryTask 

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

RetryTask triggers retry universe/provider API

func (*AuthAPIClient) SetKey 

func (a *AuthAPIClient) SetKey(scope, key string) ybaclient.RuntimeConfigurationApiApiSetKeyRequest

SetKey sets runtime configuration key

func (*AuthAPIClient) SetRoleBinding 

func (a *AuthAPIClient) SetRoleBinding(userUUID string) ybaclient.RBACManagementApiApiSetRoleBindingRequest

SetRoleBinding sets role binding

func (*AuthAPIClient) SetUniverseKey 

func (a *AuthAPIClient) SetUniverseKey(uUUID string) ybaclient.UniverseManagementApiApiSetUniverseKeyRequest

SetUniverseKey to change universe EAR settings

func (*AuthAPIClient) SyncXClusterConfig 

func (a *AuthAPIClient) SyncXClusterConfig(xclusterUUID string) ybaclient.AsynchronousReplicationApiApiSyncXClusterConfigV2Request

SyncXClusterConfig sync xCluster

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) UpdateNewRelease 

func (a *AuthAPIClient) UpdateNewRelease(rUUID string) ybaclient.NewReleaseManagementApiApiUpdateNewReleaseRequest

UpdateNewRelease API to update new release

func (*AuthAPIClient) UpdateUserProfile 

func (a *AuthAPIClient) UpdateUserProfile(
	uUUID string,
) ybaclient.UserManagementApiApiUpdateUserProfileRequest

UpdateUserProfile updates the user profile

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) UpgradeVMImage 

func (a *AuthAPIClient) UpgradeVMImage(uUUID string) ybaclient.UniverseUpgradesManagementApiApiUpgradeVMImageRequest

UpgradeVMImage upgrades the VM image of the universe

func (*AuthAPIClient) Upload 

func (a *AuthAPIClient) Upload() ybaclient.CertificateInfoApiApiUploadRequest

Upload - upload certificate

func (*AuthAPIClient) UploadRelease 

func (a *AuthAPIClient) UploadRelease() ybaclient.UploadReleasePackagesApiApiUploadReleaseRequest

UploadRelease API to upload URL

func (*AuthAPIClient) UploadReleaseRest 

func (a *AuthAPIClient) UploadReleaseRest(
	filePath string,
) (
	ybaclient.YBPCreateSuccess, error,
)

UploadReleaseRest uses REST API to call list schedule functionality

func (*AuthAPIClient) WaitForExtractMetadata 

func (a *AuthAPIClient) WaitForExtractMetadata(resourceUUID, message, operation string) (
	ybaclient.ResponseExtractMetadata,
	error,
)

WaitForExtractMetadata waits for state changes for a YugabyteDB Anywhere task

func (*AuthAPIClient) WaitForExtractMetadataCI 

func (a *AuthAPIClient) WaitForExtractMetadataCI(resourceUUID, message, operation string) (
	ybaclient.ResponseExtractMetadata,
	error,
)

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

func (*AuthAPIClient) WaitForExtractMetadataProgressBar 

func (a *AuthAPIClient) WaitForExtractMetadataProgressBar(resourceUUID, message, operation string) (
	ybaclient.ResponseExtractMetadata,
	error,
)

WaitForExtractMetadataProgressBar waits for State change for a YugabyteDB Anywhere task

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 RestAPIClient 

type RestAPIClient struct {
	Client *http.Client
	Host   string
	Scheme string
}

RestAPIClient contains http client

type YBAMinimumVersion 

type YBAMinimumVersion struct {
	Stable  string
	Preview string
}

YBAMinimumVersion contains the minimum YBA version for stable and preview releases for a feature

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.