client

package
v0.0.0-...-43a4f46 Latest Latest
Warning

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

 Go to latest Published: Nov 19, 2024 License: Apache-2.0 Imports: 22 Imported by: 2

Documentation

Overview

Package client provides a client for the Spectro Cloud API.

Index

Constants

View Source 
const (

	// OverlordUID is an annotation key used to link a cloud accounts with a private cloud gateway.
	OverlordUID = "overlordUid"

	// Scope is the key for the scope in the Palette authorization context
	// One of: "project", "system", "tenant"
	Scope = "scope"
)

Variables

This section is empty.

Functions

func ContextForScope 

func ContextForScope(scope, projectUID string) context.Context

ContextForScope returns a context with the given scope and optional project UID.

func GetEdgeFilter 

func GetEdgeFilter(extraFilters []*models.V1SearchFilterItem, tags map[string]string) *models.V1SearchFilterSpec

GetEdgeFilter returns a filter spec for listing edge hosts by tags and extra filters.

func GetMacroID 

func GetMacroID(uid, name string) string

GetMacroID returns the hash of the macro name and project UID. Provide an empty string for project UID to get the hash for tenant macros.

func IsProfileAttachedByName 

func IsProfileAttachedByName(cluster *models.V1SpectroCluster, newProfile *models.V1ClusterProfile) (bool, string)

IsProfileAttachedByName checks if a profile is already attached to a cluster.

func WithAPIKey 

func WithAPIKey(apiKey string) func(*V1Client)

WithAPIKey sets the API key for the client.

func WithInsecureSkipVerify 

func WithInsecureSkipVerify(insecureSkipVerify bool) func(*V1Client)

WithInsecureSkipVerify sets insecureSkipVerify for the client.

func WithJWT 

func WithJWT(jwt string) func(*V1Client)

WithJWT sets the JWT for the client.

func WithPaletteURI 

func WithPaletteURI(paletteURI string) func(*V1Client)

WithPaletteURI sets the Palette URI for the client.

func WithPassword 

func WithPassword(password string) func(*V1Client)

WithPassword sets the password for the client.

func WithRetries 

func WithRetries(retries int) func(*V1Client)

WithRetries sets the number of retries for the client.

func WithSchemes 

func WithSchemes(schemes []string) func(*V1Client)

WithSchemes sets the schemes for the client.

func WithScopeProject 

func WithScopeProject(projectUID string) func(*V1Client)

WithScopeProject sets the project UID for the client.

func WithScopeTenant 

func WithScopeTenant() func(*V1Client)

WithScopeTenant sets the tenant scope for the client.

func WithTransportDebug 

func WithTransportDebug() func(*V1Client)

WithTransportDebug sets the client's HTTP transport debug flag.

func WithUsername 

func WithUsername(username string) func(*V1Client)

WithUsername sets the username for the client.

Types

type GetMaintenanceStatus 

type GetMaintenanceStatus func(string, string, string) (*models.V1MachineMaintenanceStatus, error)

GetMaintenanceStatus defines a function type that retrieves the maintenance status of a machine.

type PermissionScope 

type PermissionScope string

PermissionScope defines the scope of a permission. 

const (
	// PermissionScopeProject represents a project-level scope.
	PermissionScopeProject PermissionScope = "project"

	// PermissionScopeTenant represents a tenant-level scope.
	PermissionScopeTenant PermissionScope = "tenant"

	// PermissionScopeResource represents a resource-level scope.
	PermissionScopeResource PermissionScope = "resource"
)

type V1Client 

type V1Client struct {
	Client clientv1.ClientService
	// contains filtered or unexported fields
}

V1Client is a client for the Spectro Cloud API.

func New 

func New(options ...func(*V1Client)) *V1Client

New creates a new V1Client.

func (*V1Client) ApplyApplicationUpdate 

func (h *V1Client) ApplyApplicationUpdate(uid, notificationUID string) error

ApplyApplicationUpdate applies an update to an existing application deployment.

func (*V1Client) ApplyClusterBackupConfig 

func (h *V1Client) ApplyClusterBackupConfig(uid string, config *models.V1ClusterBackupConfig) error

ApplyClusterBackupConfig creates a new scheduled backup configuration for a cluster or updates its scheduled backup configuration if one exists.

func (*V1Client) ApplyClusterHostConfig 

func (h *V1Client) ApplyClusterHostConfig(uid string, config *models.V1HostClusterConfigEntity) error

ApplyClusterHostConfig applies the specified host configuration to the cluster identified by the given UID.

func (*V1Client) ApplyClusterLocationConfig 

func (h *V1Client) ApplyClusterLocationConfig(uid string, config *models.V1SpectroClusterLocationInputEntity) error

ApplyClusterLocationConfig creates a new cluster location config or updates an existing one.

func (*V1Client) ApplyClusterNamespaceConfig 

func (h *V1Client) ApplyClusterNamespaceConfig(uid string, config []*models.V1ClusterNamespaceResourceInputEntity) error

ApplyClusterNamespaceConfig creates a new namespaced resource configuration for a cluster or updates its namespaced resource configuration if one exists.

func (*V1Client) ApplyClusterRbacConfig 

func (h *V1Client) ApplyClusterRbacConfig(uid string, config []*models.V1ClusterRbacInputEntity) error

ApplyClusterRbacConfig creates a new RBAC configuration for a cluster or updates its RBAC configuration if one exists.

func (*V1Client) ApplyClusterScanConfig 

func (h *V1Client) ApplyClusterScanConfig(uid string, config *models.V1ClusterComplianceScheduleConfig) error

ApplyClusterScanConfig creates a new cluster scan configuration for a cluster or updates its cluster scan configuration if one exists.

func (*V1Client) ApproveClusterRepave 

func (h *V1Client) ApproveClusterRepave(clusterUID string) error

ApproveClusterRepave approves a cluster repave.

func (*V1Client) AssociateTeamProjectRole 

func (h *V1Client) AssociateTeamProjectRole(uid string, body *models.V1ProjectRolesPatch) error

AssociateTeamProjectRole updates a team's project-role associations.

func (*V1Client) AssociateTeamResourceRole 

func (h *V1Client) AssociateTeamResourceRole(uid string, body *models.V1ResourceRolesUpdateEntity) error

AssociateTeamResourceRole updates a team's resource-role associations.

func (*V1Client) AssociateTeamTenantRole 

func (h *V1Client) AssociateTeamTenantRole(uid string, body *models.V1TeamTenantRolesUpdate) error

AssociateTeamTenantRole updates a team's tenant-role associations.

func (*V1Client) AssociateTeamWorkspaceRole 

func (h *V1Client) AssociateTeamWorkspaceRole(uid string, body *models.V1WorkspacesRolesPatch) error

AssociateTeamWorkspaceRole updates a team's workspace-role associations.

func (*V1Client) AssociateUserProjectRole 

func (h *V1Client) AssociateUserProjectRole(userUID string, body *models.V1ProjectRolesPatch) error

AssociateUserProjectRole associate project role for the user.

func (*V1Client) AssociateUserTenantRole 

func (h *V1Client) AssociateUserTenantRole(userUID string, body *models.V1UserRoleUIDs) error

AssociateUserTenantRole associate tenant role to the user.

func (*V1Client) AssociateUserWorkspaceRole 

func (h *V1Client) AssociateUserWorkspaceRole(userUID string, body *models.V1WorkspacesRolesPatch) error

AssociateUserWorkspaceRole associate workspace role to the user.

func (*V1Client) AttachAddonsToCluster 

func (h *V1Client) AttachAddonsToCluster(clusterUID string, profileUIDs []string) error

AttachAddonsToCluster attaches one or more addon profiles to a cluster.

func (*V1Client) AuthRefreshToken 

func (h *V1Client) AuthRefreshToken(token string) (*models.V1UserToken, error)

AuthRefreshToken refreshes jwt token.

func (*V1Client) Authenticate 

func (h *V1Client) Authenticate(body *models.V1AuthLogin) (*models.V1UserToken, error)

Authenticate authenticates a user. Returns a JWT token.

func (*V1Client) BulkDeleteClusterProfiles 

func (h *V1Client) BulkDeleteClusterProfiles(uids []string) (*models.V1BulkDeleteResponse, error)

BulkDeleteClusterProfiles deletes multiple cluster profiles.

func (*V1Client) CheckPCG 

func (h *V1Client) CheckPCG(pcgID string) error

CheckPCG checks if a Private Cloud Gateway is running. Returns an error if the PCG is not found or is not running.

func (*V1Client) Clone 

func (h *V1Client) Clone() *V1Client

Clone creates a new V1Client with the same configuration as the original.

func (*V1Client) CloneVirtualMachine 

func (h *V1Client) CloneVirtualMachine(clusterUID, sourceVMName, cloneVMName, namespace string) error

CloneVirtualMachine clones a virtual machine.

func (*V1Client) ClusterProfileExport 

func (h *V1Client) ClusterProfileExport(uid string) (*models.V1ClusterProfile, error)

ClusterProfileExport retrieves and exports a cluster profile by its unique identifier.

func (*V1Client) ClustersPatchProfiles 

func (h *V1Client) ClustersPatchProfiles(params *clientv1.V1SpectroClustersPatchProfilesParams) error

ClustersPatchProfiles patches a cluster's profiles.

func (*V1Client) CreateAPIKey 

func (h *V1Client) CreateAPIKey(name string, annotations map[string]string, expiry time.Duration) (string, error)

CreateAPIKey creates a new API key for the tenant

func (*V1Client) CreateAccountCustomCloud 

func (h *V1Client) CreateAccountCustomCloud(account *models.V1CustomAccountEntity, cloudType string) (string, error)

CreateAccountCustomCloud creates a custom cloud account.

func (*V1Client) CreateAddonDeployment 

func (h *V1Client) CreateAddonDeployment(cluster *models.V1SpectroCluster, body *models.V1SpectroClusterProfiles) error

CreateAddonDeployment creates an addon deployment for a cluster.

func (*V1Client) CreateAlert 

func (h *V1Client) CreateAlert(body *models.V1Channel, projectUID, component string) (string, error)

CreateAlert creates a new alert.

func (*V1Client) CreateAppliance 

func (h *V1Client) CreateAppliance(createHostDevice *models.V1EdgeHostDeviceEntity) (string, error)

CreateAppliance creates a new edge host.

func (*V1Client) CreateApplicationProfile 

func (h *V1Client) CreateApplicationProfile(appProfile *models.V1AppProfileEntity) (string, error)

CreateApplicationProfile creates a new application profile.

func (*V1Client) CreateApplicationProfileTiers 

func (h *V1Client) CreateApplicationProfileTiers(appProfileUID string, appTiers []*models.V1AppTierEntity) error

CreateApplicationProfileTiers creates tiers for an application profile.

func (*V1Client) CreateApplicationWithExistingSandboxCluster 

func (h *V1Client) CreateApplicationWithExistingSandboxCluster(body *models.V1AppDeploymentVirtualClusterEntity) (string, error)

CreateApplicationWithExistingSandboxCluster creates a new application deployment within an existing virtual cluster.

func (*V1Client) CreateApplicationWithNewSandboxCluster 

func (h *V1Client) CreateApplicationWithNewSandboxCluster(body *models.V1AppDeploymentClusterGroupEntity) (string, error)

CreateApplicationWithNewSandboxCluster creates a new application deployment inside a new virtual cluster.

func (*V1Client) CreateAzureBackupStorageLocation 

func (h *V1Client) CreateAzureBackupStorageLocation(bsl *models.V1UserAssetsLocationAzure) (string, error)

CreateAzureBackupStorageLocation creates a new Azure backup storage location.

func (*V1Client) CreateCloudAccountAws 

func (h *V1Client) CreateCloudAccountAws(account *models.V1AwsAccount) (string, error)

CreateCloudAccountAws creates a new AWS cloud account.

func (*V1Client) CreateCloudAccountAzure 

func (h *V1Client) CreateCloudAccountAzure(account *models.V1AzureAccount) (string, error)

CreateCloudAccountAzure creates a new Azure cloud account.

func (*V1Client) CreateCloudAccountGcp 

func (h *V1Client) CreateCloudAccountGcp(account *models.V1GcpAccountEntity) (string, error)

CreateCloudAccountGcp creates a new GCP cloud account.

func (*V1Client) CreateCloudAccountMaas 

func (h *V1Client) CreateCloudAccountMaas(account *models.V1MaasAccount) (string, error)

CreateCloudAccountMaas creates a new MAAS cloud account.

func (*V1Client) CreateCloudAccountOpenStack 

func (h *V1Client) CreateCloudAccountOpenStack(account *models.V1OpenStackAccount) (string, error)

CreateCloudAccountOpenStack creates a new OpenStack cloud account.

func (*V1Client) CreateCloudAccountTke 

func (h *V1Client) CreateCloudAccountTke(account *models.V1TencentAccount) (string, error)

CreateCloudAccountTke creates a new TKE cloud account.

func (*V1Client) CreateCloudAccountVsphere 

func (h *V1Client) CreateCloudAccountVsphere(account *models.V1VsphereAccount) (string, error)

CreateCloudAccountVsphere creates a new vSphere cloud account.

func (*V1Client) CreateClusterAks 

func (h *V1Client) CreateClusterAks(cluster *models.V1SpectroAzureClusterEntity) (string, error)

CreateClusterAks creates a new AKS cluster.

func (*V1Client) CreateClusterAws 

func (h *V1Client) CreateClusterAws(cluster *models.V1SpectroAwsClusterEntity) (string, error)

CreateClusterAws creates a new AWS IaaS cluster.

func (*V1Client) CreateClusterAzure 

func (h *V1Client) CreateClusterAzure(cluster *models.V1SpectroAzureClusterEntity) (string, error)

CreateClusterAzure creates a new Azure IaaS cluster.

func (*V1Client) CreateClusterBackupConfig 

func (h *V1Client) CreateClusterBackupConfig(uid string, config *models.V1ClusterBackupConfig) error

CreateClusterBackupConfig creates a new scheduled backup configuration for a cluster.

func (*V1Client) CreateClusterBackupConfigOnDemand 

func (h *V1Client) CreateClusterBackupConfigOnDemand(uid string, config *models.V1ClusterBackupConfig) (*models.V1UID, error)

CreateClusterBackupConfigOnDemand creates a new on-demand backup configuration for a cluster.

func (*V1Client) CreateClusterCustomCloud 

func (h *V1Client) CreateClusterCustomCloud(cluster *models.V1SpectroCustomClusterEntity, cloudType string) (string, error)

CreateClusterCustomCloud creates a custom cloud cluster.

func (*V1Client) CreateClusterEdgeNative 

func (h *V1Client) CreateClusterEdgeNative(cluster *models.V1SpectroEdgeNativeClusterEntity) (string, error)

CreateClusterEdgeNative creates a new edge native cluster.

func (*V1Client) CreateClusterEdgeVsphere 

func (h *V1Client) CreateClusterEdgeVsphere(cluster *models.V1SpectroVsphereClusterEntity) (string, error)

CreateClusterEdgeVsphere creates a vSphere edge cluster.

func (*V1Client) CreateClusterEks 

func (h *V1Client) CreateClusterEks(cluster *models.V1SpectroEksClusterEntity) (string, error)

CreateClusterEks creates a new EKS cluster.

func (*V1Client) CreateClusterGcp 

func (h *V1Client) CreateClusterGcp(cluster *models.V1SpectroGcpClusterEntity) (string, error)

CreateClusterGcp creates a new GCP IaaS cluster.

func (*V1Client) CreateClusterGke 

func (h *V1Client) CreateClusterGke(cluster *models.V1SpectroGcpClusterEntity) (string, error)

CreateClusterGke creates a GKE cluster.

func (*V1Client) CreateClusterGroup 

func (h *V1Client) CreateClusterGroup(cluster *models.V1ClusterGroupEntity) (string, error)

CreateClusterGroup creates a new cluster group.

func (*V1Client) CreateClusterMaas 

func (h *V1Client) CreateClusterMaas(cluster *models.V1SpectroMaasClusterEntity) (string, error)

CreateClusterMaas creates a new MAAS cluster.

func (*V1Client) CreateClusterOpenStack 

func (h *V1Client) CreateClusterOpenStack(cluster *models.V1SpectroOpenStackClusterEntity) (string, error)

CreateClusterOpenStack creates a new OpenStack cluster.

func (*V1Client) CreateClusterProfile 

func (h *V1Client) CreateClusterProfile(clusterProfile *models.V1ClusterProfileEntity) (string, error)

CreateClusterProfile creates a new cluster profile.

func (*V1Client) CreateClusterProfileImport 

func (h *V1Client) CreateClusterProfileImport(importFile runtime.NamedReadCloser) (string, error)

CreateClusterProfileImport creates a new cluster profile from a cluster profile import file.

func (*V1Client) CreateClusterRbacConfig 

func (h *V1Client) CreateClusterRbacConfig(uid string, config *models.V1ClusterRbac) error

CreateClusterRbacConfig creates a new RBAC configuration for a cluster.

func (*V1Client) CreateClusterRestoreConfigOnDemand 

func (h *V1Client) CreateClusterRestoreConfigOnDemand(uid string, config *models.V1ClusterRestoreConfig) (*models.V1UID, error)

CreateClusterRestoreConfigOnDemand creates a new on-demand restore configuration for a cluster.

func (*V1Client) CreateClusterScanConfig 

func (h *V1Client) CreateClusterScanConfig(uid string, config *models.V1ClusterComplianceScheduleConfig) error

CreateClusterScanConfig creates a new cluster scan configuration for a cluster.

func (*V1Client) CreateClusterTke 

func (h *V1Client) CreateClusterTke(cluster *models.V1SpectroTencentClusterEntity) (string, error)

CreateClusterTke creates a new TKE cluster.

func (*V1Client) CreateClusterVirtual 

func (h *V1Client) CreateClusterVirtual(cluster *models.V1SpectroVirtualClusterEntity) (string, error)

CreateClusterVirtual creates a new virtual cluster.

func (*V1Client) CreateClusterVsphere 

func (h *V1Client) CreateClusterVsphere(cluster *models.V1SpectroVsphereClusterEntity) (string, error)

CreateClusterVsphere creates a new vSphere cluster.

func (*V1Client) CreateComplianceScanOnDemandCreateClusterScanConfig 

func (h *V1Client) CreateComplianceScanOnDemandCreateClusterScanConfig(uid string, config *models.V1ClusterComplianceOnDemandConfig) error

CreateComplianceScanOnDemandCreateClusterScanConfig creates a new on-demand scan configuration for a cluster.

func (*V1Client) CreateDDNSSearchDomainVsphere 

func (h *V1Client) CreateDDNSSearchDomainVsphere(vsphereDNSMapping *models.V1VsphereDNSMapping) error

CreateDDNSSearchDomainVsphere creates a new vSphere DDNS search domain.

func (*V1Client) CreateDataVolume 

func (h *V1Client) CreateDataVolume(uid, name string, body *models.V1VMAddVolumeEntity) (string, error)

CreateDataVolume creates a new data volume.

func (*V1Client) CreateGcpBackupStorageLocation 

func (h *V1Client) CreateGcpBackupStorageLocation(bsl *models.V1UserAssetsLocationGcp) (string, error)

CreateGcpBackupStorageLocation creates a new GCP backup storage location.

func (*V1Client) CreateHelmRegistry 

func (h *V1Client) CreateHelmRegistry(registry *models.V1HelmRegistryEntity) (string, error)

CreateHelmRegistry creates a new Helm registry.

func (*V1Client) CreateIPPool 

func (h *V1Client) CreateIPPool(pcgUID string, pool *models.V1IPPoolInputEntity) (string, error)

CreateIPPool creates a new IP pool for a Private Cloud Gateway.

func (*V1Client) CreateMachinePoolAks 

func (h *V1Client) CreateMachinePoolAks(cloudConfigUID string, machinePool *models.V1AzureMachinePoolConfigEntity) error

CreateMachinePoolAks creates a new AKS machine pool.

func (*V1Client) CreateMachinePoolAws 

func (h *V1Client) CreateMachinePoolAws(cloudConfigUID string, machinePool *models.V1AwsMachinePoolConfigEntity) error

CreateMachinePoolAws creates a new AWS IaaS machine pool.

func (*V1Client) CreateMachinePoolAzure 

func (h *V1Client) CreateMachinePoolAzure(cloudConfigUID string, machinePool *models.V1AzureMachinePoolConfigEntity) error

CreateMachinePoolAzure creates a new Azure IaaS machine pool.

func (*V1Client) CreateMachinePoolCustomCloud 

func (h *V1Client) CreateMachinePoolCustomCloud(mpEntity *models.V1CustomMachinePoolConfigEntity, configUID, cloudType string) error

CreateMachinePoolCustomCloud creates a new custom cloud machine pool.

func (*V1Client) CreateMachinePoolEdgeNative 

func (h *V1Client) CreateMachinePoolEdgeNative(cloudConfigUID string, machinePool *models.V1EdgeNativeMachinePoolConfigEntity) error

CreateMachinePoolEdgeNative creates a new edge native machine pool.

func (*V1Client) CreateMachinePoolEdgeVsphere 

func (h *V1Client) CreateMachinePoolEdgeVsphere(cloudConfigUID string, machinePool *models.V1VsphereMachinePoolConfigEntity) error

CreateMachinePoolEdgeVsphere creates a new vSphere edge machine pool.

func (*V1Client) CreateMachinePoolEks 

func (h *V1Client) CreateMachinePoolEks(cloudConfigUID string, machinePool *models.V1EksMachinePoolConfigEntity) error

CreateMachinePoolEks creates a new EKS machine pool.

func (*V1Client) CreateMachinePoolGcp 

func (h *V1Client) CreateMachinePoolGcp(cloudConfigUID string, machinePool *models.V1GcpMachinePoolConfigEntity) error

CreateMachinePoolGcp creates a new GCP IaaS machine pool.

func (*V1Client) CreateMachinePoolGke 

func (h *V1Client) CreateMachinePoolGke(cloudConfigID string, machinePool *models.V1GcpMachinePoolConfigEntity) error

CreateMachinePoolGke creates a new GKE machine pool.

func (*V1Client) CreateMachinePoolMaas 

func (h *V1Client) CreateMachinePoolMaas(cloudConfigUID string, machinePool *models.V1MaasMachinePoolConfigEntity) error

CreateMachinePoolMaas creates a new MAAS machine pool.

func (*V1Client) CreateMachinePoolOpenStack 

func (h *V1Client) CreateMachinePoolOpenStack(cloudConfigUID string, machinePool *models.V1OpenStackMachinePoolConfigEntity) error

CreateMachinePoolOpenStack creates a new OpenStack machine pool.

func (*V1Client) CreateMachinePoolTke 

func (h *V1Client) CreateMachinePoolTke(cloudConfigUID string, machinePool *models.V1TencentMachinePoolConfigEntity) error

CreateMachinePoolTke creates a new TKE machine pool.

func (*V1Client) CreateMachinePoolVirtual 

func (h *V1Client) CreateMachinePoolVirtual(cloudConfigUID string, machinePool *models.V1VirtualMachinePoolConfigEntity) error

CreateMachinePoolVirtual creates a new virtual machine pool. TODO: deprecate unused virtual cluster functions

func (*V1Client) CreateMachinePoolVsphere 

func (h *V1Client) CreateMachinePoolVsphere(cloudConfigUID string, machinePool *models.V1VsphereMachinePoolConfigEntity) error

CreateMachinePoolVsphere creates a new vSphere machine pool.

func (*V1Client) CreateMacro 

func (h *V1Client) CreateMacro(uid string, macros *models.V1Macros) error

CreateMacro creates a new macro.

func (*V1Client) CreateMacros 

func (h *V1Client) CreateMacros(uid string, macros *models.V1Macros) (string, error)

CreateMacros creates a new macro.

func (*V1Client) CreateMinioBackupStorageLocation 

func (h *V1Client) CreateMinioBackupStorageLocation(bsl *models.V1UserAssetsLocationS3) (string, error)

CreateMinioBackupStorageLocation creates a new Minio backup storage location.

func (*V1Client) CreateOciBasicRegistry 

func (h *V1Client) CreateOciBasicRegistry(registry *models.V1BasicOciRegistry) (string, error)

CreateOciBasicRegistry creates a new standard/basic OCI registry.

func (*V1Client) CreateOciEcrRegistry 

func (h *V1Client) CreateOciEcrRegistry(registry *models.V1EcrRegistry) (string, error)

CreateOciEcrRegistry creates a new ECR OCI registry.

func (*V1Client) CreatePCGCloudAccountMaas 

func (h *V1Client) CreatePCGCloudAccountMaas(overlordUID string, account *models.V1OverlordMaasAccountCreate) (string, error)

CreatePCGCloudAccountMaas creates a new MAAS PCG cloud account.

func (*V1Client) CreatePCGCloudAccountOpenStack 

func (h *V1Client) CreatePCGCloudAccountOpenStack(overlordUID string, account *models.V1OverlordOpenStackAccountCreate) (string, error)

CreatePCGCloudAccountOpenStack creates a new OpenStack PCG cloud account.

func (*V1Client) CreatePCGCloudAccountVsphere 

func (h *V1Client) CreatePCGCloudAccountVsphere(uid string, account *models.V1OverlordVsphereAccountCreate) (string, error)

CreatePCGCloudAccountVsphere creates a new vSphere PCG cloud account.

func (*V1Client) CreatePCGMaas 

func (h *V1Client) CreatePCGMaas(overlordUID string, cloudConfig *models.V1OverlordMaasCloudConfig) (string, error)

CreatePCGMaas creates a new MAAS Private Cloud Gateway.

func (*V1Client) CreatePCGOpenStack 

func (h *V1Client) CreatePCGOpenStack(overlordUID string, cloudConfig *models.V1OverlordOpenStackCloudConfig) (string, error)

CreatePCGOpenStack creates a new OpenStack Private Cloud Gateway.

func (*V1Client) CreatePCGVsphere 

func (h *V1Client) CreatePCGVsphere(uid string, cloudConfig *models.V1OverlordVsphereCloudConfig) (string, error)

CreatePCGVsphere creates a new vSphere Private Cloud Gateway.

func (*V1Client) CreateProject 

func (h *V1Client) CreateProject(body *models.V1ProjectEntity) (string, error)

CreateProject creates a new project.

func (*V1Client) CreateRegistrationToken 

func (h *V1Client) CreateRegistrationToken(tokenName string, body *models.V1EdgeTokenEntity) (string, string, error)

CreateRegistrationToken creates a new registration token.

func (*V1Client) CreateRole 

func (h *V1Client) CreateRole(role *models.V1Role) (string, error)

CreateRole create new role.

func (*V1Client) CreateS3BackupStorageLocation 

func (h *V1Client) CreateS3BackupStorageLocation(bsl *models.V1UserAssetsLocationS3) (string, error)

CreateS3BackupStorageLocation creates a new S3 backup storage location.

func (*V1Client) CreateSSHKey 

func (h *V1Client) CreateSSHKey(body *models.V1UserAssetSSH) (string, error)

CreateSSHKey creates a new SSH key.

func (*V1Client) CreateTagFilter 

func (h *V1Client) CreateTagFilter(body *models.V1TagFilter) (*models.V1UID, error)

CreateTagFilter creates a new tag filter.

func (*V1Client) CreateTeam 

func (h *V1Client) CreateTeam(team *models.V1Team) (string, error)

CreateTeam creates a new team.

func (*V1Client) CreateUser 

func (h *V1Client) CreateUser(user *models.V1UserEntity) (string, error)

CreateUser creates a new user.

func (*V1Client) CreateUserResourceRole 

func (h *V1Client) CreateUserResourceRole(userUID string, body *models.V1ResourceRolesUpdateEntity) error

CreateUserResourceRole associate resource role for the user.

func (*V1Client) CreateVirtualMachine 

func (h *V1Client) CreateVirtualMachine(uid string, body *models.V1ClusterVirtualMachine) (*models.V1ClusterVirtualMachine, error)

CreateVirtualMachine creates a new virtual machine.

func (*V1Client) CreateVsphereDNSMap 

func (h *V1Client) CreateVsphereDNSMap(dnsMapBody *models.V1VsphereDNSMapping) (string, error)

CreateVsphereDNSMap creates a new DNS Mapping for a Private Cloud Gateway.

func (*V1Client) CreateWorkspace 

func (h *V1Client) CreateWorkspace(workspace *models.V1WorkspaceEntity) (string, error)

CreateWorkspace creates a new workspace.

func (*V1Client) DeleteAPIKey 

func (h *V1Client) DeleteAPIKey(uid string) error

DeleteAPIKey deletes an existing API Key by UID.

func (*V1Client) DeleteAPIKeyByName 

func (h *V1Client) DeleteAPIKeyByName(name string) error

DeleteAPIKeyByName deletes an existing API Key by name.

func (*V1Client) DeleteAddonDeployment 

func (h *V1Client) DeleteAddonDeployment(uid string, body *models.V1SpectroClusterProfilesDeleteEntity) error

DeleteAddonDeployment deletes an addon deployment for a cluster.

func (*V1Client) DeleteAlert 

func (h *V1Client) DeleteAlert(projectUID, component, alertUID string) error

DeleteAlert deletes an existing alert.

func (*V1Client) DeleteAppliance 

func (h *V1Client) DeleteAppliance(uid string) error

DeleteAppliance deletes an existing edge host.

func (*V1Client) DeleteApplication 

func (h *V1Client) DeleteApplication(uid string) error

DeleteApplication deletes an existing application deployment.

func (*V1Client) DeleteApplicationProfile 

func (h *V1Client) DeleteApplicationProfile(uid string) error

DeleteApplicationProfile deletes an existing application profile.

func (*V1Client) DeleteApplicationProfileTiers 

func (h *V1Client) DeleteApplicationProfileTiers(appProfileUID string, appTiers []string) error

DeleteApplicationProfileTiers deletes tiers from an application profile.

func (*V1Client) DeleteCloudAccountAws 

func (h *V1Client) DeleteCloudAccountAws(uid string) error

DeleteCloudAccountAws deletes an existing AWS cloud account.

func (*V1Client) DeleteCloudAccountAzure 

func (h *V1Client) DeleteCloudAccountAzure(uid string) error

DeleteCloudAccountAzure deletes an existing Azure cloud account.

func (*V1Client) DeleteCloudAccountCustomCloud 

func (h *V1Client) DeleteCloudAccountCustomCloud(uid, cloudType string) error

DeleteCloudAccountCustomCloud deletes an existing custom cloud account.

func (*V1Client) DeleteCloudAccountGcp 

func (h *V1Client) DeleteCloudAccountGcp(uid string) error

DeleteCloudAccountGcp deletes an existing GCP cloud account.

func (*V1Client) DeleteCloudAccountMaas 

func (h *V1Client) DeleteCloudAccountMaas(uid string) error

DeleteCloudAccountMaas deletes an existing MAAS cloud account.

func (*V1Client) DeleteCloudAccountOpenStack 

func (h *V1Client) DeleteCloudAccountOpenStack(uid string) error

DeleteCloudAccountOpenStack deletes an existing OpenStack cloud account.

func (*V1Client) DeleteCloudAccountTke 

func (h *V1Client) DeleteCloudAccountTke(uid string) error

DeleteCloudAccountTke deletes an existing TKE cloud account.

func (*V1Client) DeleteCloudAccountVsphere 

func (h *V1Client) DeleteCloudAccountVsphere(uid string) error

DeleteCloudAccountVsphere deletes an existing vSphere cloud account.

func (*V1Client) DeleteCluster 

func (h *V1Client) DeleteCluster(uid string) error

DeleteCluster deletes a cluster.

func (*V1Client) DeleteClusterBackupConfigOnDemand 

func (h *V1Client) DeleteClusterBackupConfigOnDemand(uid string, config *models.V1ClusterBackupConfig) error

DeleteClusterBackupConfigOnDemand deletes an existing on-demand backup configuration for a cluster.

func (*V1Client) DeleteClusterGroup 

func (h *V1Client) DeleteClusterGroup(uid string) error

DeleteClusterGroup deletes an existing cluster group.

func (*V1Client) DeleteClusterProfile 

func (h *V1Client) DeleteClusterProfile(uid string) error

DeleteClusterProfile deletes an existing cluster profile.

func (*V1Client) DeleteDataVolume 

func (h *V1Client) DeleteDataVolume(uid, namespace, name string, body *models.V1VMRemoveVolumeEntity) error

DeleteDataVolume deletes an existing data volume.

func (*V1Client) DeleteHelmRegistry 

func (h *V1Client) DeleteHelmRegistry(uid string) error

DeleteHelmRegistry deletes an existing Helm registry.

func (*V1Client) DeleteIPPool 

func (h *V1Client) DeleteIPPool(pcgUID, poolUID string) error

DeleteIPPool deletes an existing Private Cloud Gateway IP pool.

func (*V1Client) DeleteMachineEdgeNative 

func (h *V1Client) DeleteMachineEdgeNative(edgeHostUID, machinePool, cloudConfigUID string) error

DeleteMachineEdgeNative deletes an existing edge native machine.

func (*V1Client) DeleteMachinePoolAks 

func (h *V1Client) DeleteMachinePoolAks(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolAks deletes an existing AKS machine pool.

func (*V1Client) DeleteMachinePoolAws 

func (h *V1Client) DeleteMachinePoolAws(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolAws deletes an existing AWS IaaS machine pool.

func (*V1Client) DeleteMachinePoolAzure 

func (h *V1Client) DeleteMachinePoolAzure(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolAzure deletes an existing Azure IaaS machine pool.

func (*V1Client) DeleteMachinePoolCustomCloud 

func (h *V1Client) DeleteMachinePoolCustomCloud(mpName string, configUID, cloudType string) error

DeleteMachinePoolCustomCloud deletes an existing custom cloud machine pool.

func (*V1Client) DeleteMachinePoolEdgeNative 

func (h *V1Client) DeleteMachinePoolEdgeNative(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolEdgeNative deletes an existing edge native machine pool.

func (*V1Client) DeleteMachinePoolEdgeVsphere 

func (h *V1Client) DeleteMachinePoolEdgeVsphere(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolEdgeVsphere deletes an existing vSphere edge machine pool.

func (*V1Client) DeleteMachinePoolEks 

func (h *V1Client) DeleteMachinePoolEks(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolEks deletes an existing EKS machine pool.

func (*V1Client) DeleteMachinePoolGcp 

func (h *V1Client) DeleteMachinePoolGcp(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolGcp deletes an existing GCP IaaS machine pool.

func (*V1Client) DeleteMachinePoolGke 

func (h *V1Client) DeleteMachinePoolGke(cloudConfigID string, machinePoolName string) error

DeleteMachinePoolGke deletes an existing GKE machine pool.

func (*V1Client) DeleteMachinePoolMaas 

func (h *V1Client) DeleteMachinePoolMaas(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolMaas deletes an existing MAAS machine pool.

func (*V1Client) DeleteMachinePoolOpenStack 

func (h *V1Client) DeleteMachinePoolOpenStack(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolOpenStack deletes an existing OpenStack machine pool.

func (*V1Client) DeleteMachinePoolTke 

func (h *V1Client) DeleteMachinePoolTke(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolTke deletes an existing TKE machine pool.

func (*V1Client) DeleteMachinePoolVirtual 

func (h *V1Client) DeleteMachinePoolVirtual(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolVirtual deletes an existing virtual machine pool. TODO: deprecate unused virtual cluster functions

func (*V1Client) DeleteMachinePoolVsphere 

func (h *V1Client) DeleteMachinePoolVsphere(cloudConfigUID, machinePoolName string) error

DeleteMachinePoolVsphere deletes an existing vSphere machine pool.

func (*V1Client) DeleteMacro 

func (h *V1Client) DeleteMacro(uid string, body *models.V1Macros) error

DeleteMacro deletes an existing macro.

func (*V1Client) DeleteMacros 

func (h *V1Client) DeleteMacros(uid string, body *models.V1Macros) error

DeleteMacros deletes an existing macro.

func (*V1Client) DeleteNodeInEdgeNativeMachinePool 

func (h *V1Client) DeleteNodeInEdgeNativeMachinePool(configUID, machinePoolName, machineID string) error

DeleteNodeInEdgeNativeMachinePool delete the specific node in the edge-native machine pool

func (*V1Client) DeleteOciBasicRegistry 

func (h *V1Client) DeleteOciBasicRegistry(uid string) error

DeleteOciBasicRegistry deletes an existing standard/basic OCI registry.

func (*V1Client) DeleteOciEcrRegistry 

func (h *V1Client) DeleteOciEcrRegistry(uid string) error

DeleteOciEcrRegistry deletes an existing ECR OCI registry.

func (*V1Client) DeleteProject 

func (h *V1Client) DeleteProject(uid string) error

DeleteProject deletes an existing project.

func (*V1Client) DeleteRegistrationToken 

func (h *V1Client) DeleteRegistrationToken(tokenUID string) error

DeleteRegistrationToken deletes a registration token by name.

func (*V1Client) DeleteRole 

func (h *V1Client) DeleteRole(roleUID string) error

DeleteRole Delete existing role with ID

func (*V1Client) DeleteS3BackupStorageLocation 

func (h *V1Client) DeleteS3BackupStorageLocation(uid string) error

DeleteS3BackupStorageLocation deletes an existing S3 backup storage location.

func (*V1Client) DeleteSSHKey 

func (h *V1Client) DeleteSSHKey(uid string) error

DeleteSSHKey deletes an existing SSH key.

func (*V1Client) DeleteTagFilter 

func (h *V1Client) DeleteTagFilter(uid string) error

DeleteTagFilter deletes an existing tag filter.

func (*V1Client) DeleteTeam 

func (h *V1Client) DeleteTeam(uid string) error

DeleteTeam deletes an existing team by UID.

func (*V1Client) DeleteUser 

func (h *V1Client) DeleteUser(uid string) error

DeleteUser deletes an existing user by UID.

func (*V1Client) DeleteUserByName 

func (h *V1Client) DeleteUserByName(name string) error

DeleteUserByName deletes an existing user by name.

func (*V1Client) DeleteUserResourceRoles 

func (h *V1Client) DeleteUserResourceRoles(userUID string, roleUID string) error

DeleteUserResourceRoles delete resource role for the user.

func (*V1Client) DeleteVirtualMachine 

func (h *V1Client) DeleteVirtualMachine(uid, namespace, name string) error

DeleteVirtualMachine deletes an existing virtual machine.

func (*V1Client) DeleteVsphereDNSMap 

func (h *V1Client) DeleteVsphereDNSMap(dnsMapID string) error

DeleteVsphereDNSMap delete an existing DNS Mapping for a Private Cloud Gateway

func (*V1Client) DeleteWorkspace 

func (h *V1Client) DeleteWorkspace(uid string) error

DeleteWorkspace deletes an existing workspace.

func (*V1Client) DownloadLogs 

func (h *V1Client) DownloadLogs(uid string, logFetcherUID string) (io.Writer, error)

DownloadLogs downloads a cluster's logs, given a cluster uid and a log fetcher uid generated via InitiateDownloadOfClusterLogs.

func (*V1Client) ExportClusterProfile 

func (h *V1Client) ExportClusterProfile(uid, format string) (bytes.Buffer, error)

ExportClusterProfile exports a cluster profile in the specified format. Supported formats are yaml and json.

func (*V1Client) ForceDeleteCluster 

func (h *V1Client) ForceDeleteCluster(uid string, forceDelete bool) error

ForceDeleteCluster force-deletes a cluster, which may orphan cloud resources.

func (*V1Client) GetAPIKeys 

func (h *V1Client) GetAPIKeys() (*models.V1APIKeys, error)

GetAPIKeys retrieves all API Keys.

func (*V1Client) GetAlert 

func (h *V1Client) GetAlert(projectUID, component, alertUID string) (*models.V1Channel, error)

GetAlert retrieves an existing alert.

func (*V1Client) GetAppliance 

func (h *V1Client) GetAppliance(uid string) (*models.V1EdgeHostDevice, error)

GetAppliance retrieves an existing edge host by UID.

func (*V1Client) GetApplianceByName 

func (h *V1Client) GetApplianceByName(name string, tags map[string]string, status, health, architecture string) (*models.V1EdgeHostDevice, error)

GetApplianceByName retrieves an existing edge host by name.

func (*V1Client) GetAppliances 

func (h *V1Client) GetAppliances(tags map[string]string, status, health, architecture string) ([]*models.V1EdgeHostsMetadata, error)

GetAppliances returns a list of edge host metadata, filtered by the provided tags, status, health, and architecture.

func (*V1Client) GetApplication 

func (h *V1Client) GetApplication(uid string) (*models.V1AppDeployment, error)

GetApplication retrieves an existing application deployment.

func (*V1Client) GetApplicationProfile 

func (h *V1Client) GetApplicationProfile(uid string) (*models.V1AppProfile, error)

GetApplicationProfile retrieves an existing application profile by UID.

func (*V1Client) GetApplicationProfileByNameAndVersion 

func (h *V1Client) GetApplicationProfileByNameAndVersion(profileName, version string) (*models.V1AppProfileSummary, string, string, error)

GetApplicationProfileByNameAndVersion retrieves an application profile by name and version.

func (*V1Client) GetApplicationProfileTierManifestContent 

func (h *V1Client) GetApplicationProfileTierManifestContent(applicationProfileUID, tierUID, manifestUID string) (string, error)

GetApplicationProfileTierManifestContent retrieves the content of a manifest in a tier of an application profile.

func (*V1Client) GetApplicationProfileTiers 

func (h *V1Client) GetApplicationProfileTiers(applicationProfileUID string) ([]*models.V1AppTier, error)

GetApplicationProfileTiers retrieves the tiers of an application profile.

func (*V1Client) GetAzureBackupStorageLocation 

func (h *V1Client) GetAzureBackupStorageLocation(uid string) (*models.V1UserAssetsLocationAzure, error)

GetAzureBackupStorageLocation retrieves an existing Azure backup storage location.

func (*V1Client) GetBackupStorageLocation 

func (h *V1Client) GetBackupStorageLocation(uid string) (*models.V1UserAssetsLocation, error)

GetBackupStorageLocation retrieves an existing backup storage location.

func (*V1Client) GetCloudAccount 

func (h *V1Client) GetCloudAccount(uid string) (*models.V1CloudAccountSummary, error)

GetCloudAccount retrieves an existing cloud account summary.

func (*V1Client) GetCloudAccountAws 

func (h *V1Client) GetCloudAccountAws(uid string) (*models.V1AwsAccount, error)

GetCloudAccountAws retrieves an existing AWS cloud account.

func (*V1Client) GetCloudAccountAzure 

func (h *V1Client) GetCloudAccountAzure(uid string) (*models.V1AzureAccount, error)

GetCloudAccountAzure retrieves an existing Azure cloud account.

func (*V1Client) GetCloudAccountGcp 

func (h *V1Client) GetCloudAccountGcp(uid string) (*models.V1GcpAccount, error)

GetCloudAccountGcp retrieves an existing GCP cloud account.

func (*V1Client) GetCloudAccountMaas 

func (h *V1Client) GetCloudAccountMaas(uid string) (*models.V1MaasAccount, error)

GetCloudAccountMaas retrieves an existing MAAS cloud account.

func (*V1Client) GetCloudAccountOpenStack 

func (h *V1Client) GetCloudAccountOpenStack(uid string) (*models.V1OpenStackAccount, error)

GetCloudAccountOpenStack retrieves an existing OpenStack cloud account.

func (*V1Client) GetCloudAccountTke 

func (h *V1Client) GetCloudAccountTke(uid string) (*models.V1TencentAccount, error)

GetCloudAccountTke retrieves an existing TKE cloud account.

func (*V1Client) GetCloudAccountVsphere 

func (h *V1Client) GetCloudAccountVsphere(uid string) (*models.V1VsphereAccount, error)

GetCloudAccountVsphere retrieves an existing vSphere cloud account.

func (*V1Client) GetCloudAccountsAws 

func (h *V1Client) GetCloudAccountsAws() ([]*models.V1AwsAccount, error)

GetCloudAccountsAws retrieves all AWS cloud accounts.

func (*V1Client) GetCloudAccountsAzure 

func (h *V1Client) GetCloudAccountsAzure() ([]*models.V1AzureAccount, error)

GetCloudAccountsAzure retrieves all Azure cloud accounts.

func (*V1Client) GetCloudAccountsGcp 

func (h *V1Client) GetCloudAccountsGcp() ([]*models.V1GcpAccount, error)

GetCloudAccountsGcp retrieves all GCP cloud accounts.

func (*V1Client) GetCloudAccountsMaas 

func (h *V1Client) GetCloudAccountsMaas() ([]*models.V1MaasAccount, error)

GetCloudAccountsMaas retrieves all MAAS cloud accounts.

func (*V1Client) GetCloudAccountsOpenStack 

func (h *V1Client) GetCloudAccountsOpenStack() ([]*models.V1OpenStackAccount, error)

GetCloudAccountsOpenStack retrieves all OpenStack cloud accounts.

func (*V1Client) GetCloudAccountsTke 

func (h *V1Client) GetCloudAccountsTke() ([]*models.V1TencentAccount, error)

GetCloudAccountsTke retrieves all TKE cloud accounts.

func (*V1Client) GetCloudAccountsVsphere 

func (h *V1Client) GetCloudAccountsVsphere() ([]*models.V1VsphereAccount, error)

GetCloudAccountsVsphere retrieves all vSphere cloud accounts.

func (*V1Client) GetCloudConfigAks 

func (h *V1Client) GetCloudConfigAks(configUID string) (*models.V1AzureCloudConfig, error)

GetCloudConfigAks retrieves an existing AKS cluster's cloud config.

func (*V1Client) GetCloudConfigAws 

func (h *V1Client) GetCloudConfigAws(configUID string) (*models.V1AwsCloudConfig, error)

GetCloudConfigAws retrieves an existing AWS IaaS cluster's cloud config.

func (*V1Client) GetCloudConfigAzure 

func (h *V1Client) GetCloudConfigAzure(configUID string) (*models.V1AzureCloudConfig, error)

GetCloudConfigAzure retrieves an existing Azure IaaS cluster's cloud config.

func (*V1Client) GetCloudConfigCustomCloud 

func (h *V1Client) GetCloudConfigCustomCloud(configUID, cloudType string) (*models.V1CustomCloudConfig, error)

GetCloudConfigCustomCloud retrieves an existing custom cloud cluster's cloud config.

func (*V1Client) GetCloudConfigEdgeNative 

func (h *V1Client) GetCloudConfigEdgeNative(configUID string) (*models.V1EdgeNativeCloudConfig, error)

GetCloudConfigEdgeNative retrieves an existing edge native cluster's cloud config.

func (*V1Client) GetCloudConfigEdgeVsphere 

func (h *V1Client) GetCloudConfigEdgeVsphere(configUID string) (*models.V1VsphereCloudConfig, error)

GetCloudConfigEdgeVsphere retrieves an existing vSphere edge cluster's cloud config.

func (*V1Client) GetCloudConfigEks 

func (h *V1Client) GetCloudConfigEks(configUID string) (*models.V1EksCloudConfig, error)

GetCloudConfigEks retrieves an existing EKS cluster's cloud config.

func (*V1Client) GetCloudConfigGcp 

func (h *V1Client) GetCloudConfigGcp(configUID string) (*models.V1GcpCloudConfig, error)

GetCloudConfigGcp retrieves an existing GCP IaaS cluster's cloud config.

func (*V1Client) GetCloudConfigGke 

func (h *V1Client) GetCloudConfigGke(configUID string) (*models.V1GcpCloudConfig, error)

GetCloudConfigGke retrieves an existing GKE cluster's cloud config.

func (*V1Client) GetCloudConfigMaas 

func (h *V1Client) GetCloudConfigMaas(configUID string) (*models.V1MaasCloudConfig, error)

GetCloudConfigMaas retrieves an existing MAAS cluster's cloud config.

func (*V1Client) GetCloudConfigOpenStack 

func (h *V1Client) GetCloudConfigOpenStack(configUID string) (*models.V1OpenStackCloudConfig, error)

GetCloudConfigOpenStack retrieves an existing OpenStack cluster's cloud config.

func (*V1Client) GetCloudConfigTke 

func (h *V1Client) GetCloudConfigTke(configUID string) (*models.V1TencentCloudConfig, error)

GetCloudConfigTke retrieves an existing TKE cluster's cloud config.

func (*V1Client) GetCloudConfigVirtual 

func (h *V1Client) GetCloudConfigVirtual(configUID string) (*models.V1VirtualCloudConfig, error)

GetCloudConfigVirtual retrieves an existing virtual cluster's cloud config.

func (*V1Client) GetCloudConfigVsphere 

func (h *V1Client) GetCloudConfigVsphere(uid string) (*models.V1VsphereCloudConfig, error)

GetCloudConfigVsphere retrieves an existing vSphere cluster's cloud config.

func (*V1Client) GetCluster 

func (h *V1Client) GetCluster(uid string) (*models.V1SpectroCluster, error)

GetCluster retrieves an existing cluster. Returns nil if the cluster's status is nil or the cluster has been deleted.

func (*V1Client) GetClusterAdminKubeConfig 

func (h *V1Client) GetClusterAdminKubeConfig(uid string) (string, error)

GetClusterAdminKubeConfig retrieves a cluster's admin kubeconfig.

func (*V1Client) GetClusterBackupConfig 

func (h *V1Client) GetClusterBackupConfig(uid string) (*models.V1ClusterBackup, error)

GetClusterBackupConfig gets the scheduled backup configuration for a cluster.

func (*V1Client) GetClusterByName 

func (h *V1Client) GetClusterByName(name string, virtual bool) (*models.V1SpectroCluster, error)

GetClusterByName retrieves an existing cluster by name. Returns nil if the cluster's status is nil or the cluster has been deleted.

func (*V1Client) GetClusterGroup 

func (h *V1Client) GetClusterGroup(uid string) (*models.V1ClusterGroup, error)

GetClusterGroup retrieves an existing cluster group whose status is active.

func (*V1Client) GetClusterGroupScopeMetadata 

func (h *V1Client) GetClusterGroupScopeMetadata() ([]*models.V1ObjectScopeEntity, error)

GetClusterGroupScopeMetadata retrieves scope metadata for all cluster groups.

func (*V1Client) GetClusterGroupScopeMetadataByName 

func (h *V1Client) GetClusterGroupScopeMetadataByName(name string) (*models.V1ObjectScopeEntity, error)

GetClusterGroupScopeMetadataByName retrieves scope metadata for an existing cluster group by name.

func (*V1Client) GetClusterGroupSummaries 

func (h *V1Client) GetClusterGroupSummaries() ([]*models.V1ClusterGroupSummary, error)

GetClusterGroupSummaries retrieves summaries for all cluster groups.

func (*V1Client) GetClusterGroupSummaryByName 

func (h *V1Client) GetClusterGroupSummaryByName(name string) (*models.V1ClusterGroupSummary, error)

GetClusterGroupSummaryByName retrieves a summary for an existing cluster group by name.

func (*V1Client) GetClusterGroupWithoutStatus 

func (h *V1Client) GetClusterGroupWithoutStatus(uid string) (*models.V1ClusterGroup, error)

GetClusterGroupWithoutStatus retrieves an existing cluster group, regardless of status.

func (*V1Client) GetClusterImportManifest 

func (h *V1Client) GetClusterImportManifest(uid string) (string, error)

GetClusterImportManifest retrieves a cluster's import manifest.

func (*V1Client) GetClusterKubeConfig 

func (h *V1Client) GetClusterKubeConfig(uid string) (string, error)

GetClusterKubeConfig retrieves a cluster's kubeconfig.

func (*V1Client) GetClusterLocationConfig 

func (h *V1Client) GetClusterLocationConfig(uid string) (*models.V1ClusterLocation, error)

GetClusterLocationConfig returns a cluster's location config.

func (*V1Client) GetClusterNamespaceConfig 

func (h *V1Client) GetClusterNamespaceConfig(uid string) (*models.V1ClusterNamespaceResources, error)

GetClusterNamespaceConfig gets the namespaced resource configuration for a cluster.

func (*V1Client) GetClusterProfile 

func (h *V1Client) GetClusterProfile(uid string) (*models.V1ClusterProfile, error)

GetClusterProfile retrieves an existing cluster profile by UID.

func (*V1Client) GetClusterProfileManifestPack 

func (h *V1Client) GetClusterProfileManifestPack(clusterProfileUID, packName string) ([]*models.V1ManifestEntity, error)

GetClusterProfileManifestPack retrieves all manifests for a pack in a cluster profile.

func (*V1Client) GetClusterProfileSummary 

func (h *V1Client) GetClusterProfileSummary(uid string) (*models.V1ClusterProfileSummary, error)

GetClusterProfileSummary returns a summary for an existing cluster profile.

func (*V1Client) GetClusterProfileUID 

func (h *V1Client) GetClusterProfileUID(profileName, profileVersion string) (string, error)

GetClusterProfileUID returns the UID of a cluster profile based on the profile name and version.

func (*V1Client) GetClusterProfiles 

func (h *V1Client) GetClusterProfiles() ([]*models.V1ClusterProfileMetadata, error)

GetClusterProfiles retrieves all cluster profiles.

func (*V1Client) GetClusterRbacConfig 

func (h *V1Client) GetClusterRbacConfig(uid string) (*models.V1ClusterRbacs, error)

GetClusterRbacConfig retrieves the RBAC configuration for a cluster.

func (*V1Client) GetClusterRestoreConfigOnDemand 

func (h *V1Client) GetClusterRestoreConfigOnDemand(uid string) (*models.V1ClusterRestore, error)

GetClusterRestoreConfigOnDemand retrieces an existing on-demand restore configuration for a cluster.

func (*V1Client) GetClusterScanConfig 

func (h *V1Client) GetClusterScanConfig(uid string) (*models.V1ClusterComplianceScan, error)

GetClusterScanConfig retrieves the cluster scan configuration for a cluster.

func (*V1Client) GetClusterSummary 

func (h *V1Client) GetClusterSummary(clusterID string) (*models.V1SpectroClusterUIDSummary, error)

GetClusterSummary retrieves an existing cluster's summary.

func (*V1Client) GetClusterWithoutStatus 

func (h *V1Client) GetClusterWithoutStatus(uid string) (*models.V1SpectroCluster, error)

GetClusterWithoutStatus retrieves an existing cluster regardless of its status.

func (*V1Client) GetComplianceScanOnDemandScanLogs 

func (h *V1Client) GetComplianceScanOnDemandScanLogs(uid string) (*models.V1ClusterComplianceScanLogs, error)

GetComplianceScanOnDemandScanLogs retrieves the on-demand scan logs for a cluster.

func (*V1Client) GetCustomCloudAccount 

func (h *V1Client) GetCustomCloudAccount(uid, cloudType string) (*models.V1CustomAccount, error)

GetCustomCloudAccount retrieves an existing custom cloud account.

func (*V1Client) GetCustomCloudAccountList 

func (h *V1Client) GetCustomCloudAccountList(cloudType string) ([]*models.V1CustomAccount, error)

GetCustomCloudAccountList retrieves all custom cloud accounts.

func (*V1Client) GetEdgeHost 

func (h *V1Client) GetEdgeHost(edgeHostID string) (*models.V1EdgeHostDevice, error)

GetEdgeHost retrieves an existing edge host by UID.

func (*V1Client) GetEdgeHostsByTags 

func (h *V1Client) GetEdgeHostsByTags(tags map[string]string) ([]*models.V1EdgeHostsMetadata, error)

GetEdgeHostsByTags returns a list of edge hosts filtered by the provided tags. TODO: expose pagination params

func (*V1Client) GetEvents 

func (h *V1Client) GetEvents(kind, uid string, continueVar, fields, filters, orderBy *string, limit, offset *int64, timeout *time.Duration) ([]*models.V1Event, error)

GetEvents retrieves events for a given object. TODO: which kinds are supported?

func (*V1Client) GetExistMacros 

func (h *V1Client) GetExistMacros(tfMacrosMap map[string]any, projectUID string) ([]*models.V1Macro, error)

GetExistMacros retrieves all macros in a project or tenant, filtered by the given map. Macros whose names are not in the map are returned.

func (*V1Client) GetGCPBackupStorageLocation 

func (h *V1Client) GetGCPBackupStorageLocation(uid string) (*models.V1UserAssetsLocationGcp, error)

GetGCPBackupStorageLocation retrieves an existing GCP backup storage location.

func (*V1Client) GetHelmRegistry 

func (h *V1Client) GetHelmRegistry(uid string) (*models.V1HelmRegistry, error)

GetHelmRegistry retrieves an existing Helm registry by UID.

func (*V1Client) GetHelmRegistryByName 

func (h *V1Client) GetHelmRegistryByName(registryName string) (*models.V1HelmRegistry, error)

GetHelmRegistryByName retrieves an existing Helm registry by name.

func (*V1Client) GetIPPool 

func (h *V1Client) GetIPPool(pcgUID, poolUID string) (*models.V1IPPoolEntity, error)

GetIPPool retrieves a PCG's IP pool by pool UID.

func (*V1Client) GetIPPoolByName 

func (h *V1Client) GetIPPoolByName(pcgUID, poolName string) (*models.V1IPPoolEntity, error)

GetIPPoolByName retrieves a PCG's IP pool by pool name.

func (*V1Client) GetIPPools 

func (h *V1Client) GetIPPools(pcgUID string) ([]*models.V1IPPoolEntity, error)

GetIPPools retrieves all IP pools for a Private Cloud Gateway.

func (*V1Client) GetLogFetcherStatus 

func (h *V1Client) GetLogFetcherStatus(uid string, logFetcherUID *string) (*models.V1ClusterLogFetcher, error)

GetLogFetcherStatus retrieves a cluster's log fetcher status.

func (*V1Client) GetMachineEdgeNative 

func (h *V1Client) GetMachineEdgeNative(machineUID, machinePoolName, cloudConfigUID string) (*models.V1EdgeNativeMachine, error)

GetMachineEdgeNative retrieves an existing edge native machine by UID.

func (*V1Client) GetMacro 

func (h *V1Client) GetMacro(name, projectUID string) (*models.V1Macro, error)

GetMacro retrieves an existing macro by name and project UID.

func (*V1Client) GetMacros 

func (h *V1Client) GetMacros(projectUID string) ([]*models.V1Macro, error)

GetMacros retrieves all macros in a project or tenant. If projectUID is empty, tenant macros are returned.

func (*V1Client) GetMacrosID 

func (h *V1Client) GetMacrosID(uid string) (string, error)

GetMacrosID returns the hash ID for a macro, given a project UID. If the project UID is empty, the tenant UID is used.

func (*V1Client) GetMacrosV2 

func (h *V1Client) GetMacrosV2(projectUID string) ([]*models.V1Macro, error)

GetMacrosV2 retrieves all existing macros at either project or tenant scope.

func (*V1Client) GetMinioBackupStorageLocation 

func (h *V1Client) GetMinioBackupStorageLocation(uid string) (*models.V1UserAssetsLocationS3, error)

GetMinioBackupStorageLocation retrieves an existing Minio backup storage location.

func (*V1Client) GetNodeInEdgeNativeMachinePool 

func (h *V1Client) GetNodeInEdgeNativeMachinePool(configUID, machinePoolName, machineID string) (*models.V1EdgeNativeMachine, error)

GetNodeInEdgeNativeMachinePool retrieves specific machine in the edge-native machine pool.

func (*V1Client) GetNodeListInEdgeNativeMachinePool 

func (h *V1Client) GetNodeListInEdgeNativeMachinePool(configUID, machinePoolName string) (*models.V1EdgeNativeMachines, error)

GetNodeListInEdgeNativeMachinePool retrieves machine in the edge-native machine pool

func (*V1Client) GetNodeMaintenanceStatus 

func (h *V1Client) GetNodeMaintenanceStatus(fn GetMaintenanceStatus, ConfigUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatus retrieves the maintenance status of a specific node.

func (*V1Client) GetNodeMaintenanceStatusAks 

func (h *V1Client) GetNodeMaintenanceStatusAks(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusAks retrieves maintenance status for an AKS node.

func (*V1Client) GetNodeMaintenanceStatusAws 

func (h *V1Client) GetNodeMaintenanceStatusAws(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusAws retrieves maintenance status for an AWS IaaS node.

func (*V1Client) GetNodeMaintenanceStatusAzure 

func (h *V1Client) GetNodeMaintenanceStatusAzure(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusAzure retrieves maintenance status for an Azure IaaS node.

func (*V1Client) GetNodeMaintenanceStatusEdgeNative 

func (h *V1Client) GetNodeMaintenanceStatusEdgeNative(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusEdgeNative retrieves maintenance status for an edge native node.

func (*V1Client) GetNodeMaintenanceStatusEdgeVsphere 

func (h *V1Client) GetNodeMaintenanceStatusEdgeVsphere(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusEdgeVsphere retrieves maintenance status for a vSphere edge node. TODO: edgev1 deprecation

func (*V1Client) GetNodeMaintenanceStatusEks 

func (h *V1Client) GetNodeMaintenanceStatusEks(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusEks retrieves maintenance status for an EKS node.

func (*V1Client) GetNodeMaintenanceStatusGcp 

func (h *V1Client) GetNodeMaintenanceStatusGcp(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusGcp retrieves maintenance status for a GCP IaaS node.

func (*V1Client) GetNodeMaintenanceStatusGeneric 

func (h *V1Client) GetNodeMaintenanceStatusGeneric(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusGeneric retrieves maintenance status for a generic node.

func (*V1Client) GetNodeMaintenanceStatusGke 

func (h *V1Client) GetNodeMaintenanceStatusGke(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusGke retrieves maintenance status for a GKE node.

func (*V1Client) GetNodeMaintenanceStatusMaas 

func (h *V1Client) GetNodeMaintenanceStatusMaas(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusMaas retrieves maintenance status for a MAAS node.

func (*V1Client) GetNodeMaintenanceStatusOpenStack 

func (h *V1Client) GetNodeMaintenanceStatusOpenStack(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusOpenStack retrieves maintenance status for an OpenStack node.

func (*V1Client) GetNodeMaintenanceStatusTke 

func (h *V1Client) GetNodeMaintenanceStatusTke(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusTke retrieves maintenance status for a TKE node.

func (*V1Client) GetNodeMaintenanceStatusVsphere 

func (h *V1Client) GetNodeMaintenanceStatusVsphere(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeMaintenanceStatusVsphere retrieves maintenance status for a vSphere node.

func (*V1Client) GetNodeStatusMapAks 

func (h *V1Client) GetNodeStatusMapAks(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapAks retrieves the status of all nodes in an AKS machine pool.

func (*V1Client) GetNodeStatusMapAws 

func (h *V1Client) GetNodeStatusMapAws(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapAws retrieves the status of all nodes in an AWS IaaS machine pool.

func (*V1Client) GetNodeStatusMapAzure 

func (h *V1Client) GetNodeStatusMapAzure(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapAzure retrieves the status of all nodes in an Azure IaaS machine pool.

func (*V1Client) GetNodeStatusMapEdgeNative 

func (h *V1Client) GetNodeStatusMapEdgeNative(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapEdgeNative retrieves the status of all nodes in an edge native machine pool.

func (*V1Client) GetNodeStatusMapEdgeVsphere 

func (h *V1Client) GetNodeStatusMapEdgeVsphere(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapEdgeVsphere retrieves the status of all nodes in a vSphere edge machine pool.

func (*V1Client) GetNodeStatusMapEks 

func (h *V1Client) GetNodeStatusMapEks(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapEks retrieves the status of all nodes in an EKS machine pool.

func (*V1Client) GetNodeStatusMapGcp 

func (h *V1Client) GetNodeStatusMapGcp(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapGcp retrieves the status of all nodes in a GCP IaaS machine pool.

func (*V1Client) GetNodeStatusMapGke 

func (h *V1Client) GetNodeStatusMapGke(configUID string, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapGke retrieves the status of all nodes in a GKE machine pool.

func (*V1Client) GetNodeStatusMapMaas 

func (h *V1Client) GetNodeStatusMapMaas(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapMaas retrieves the status of all nodes in a MAAS machine pool.

func (*V1Client) GetNodeStatusMapOpenStack 

func (h *V1Client) GetNodeStatusMapOpenStack(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapOpenStack retrieves the status of all nodes in an OpenStack machine pool.

func (*V1Client) GetNodeStatusMapTke 

func (h *V1Client) GetNodeStatusMapTke(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapTke retrieves the status of all nodes in a TKE machine pool.

func (*V1Client) GetNodeStatusMapVirtual 

func (h *V1Client) GetNodeStatusMapVirtual(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapVirtual retrieves the status of all nodes in a virtual machine pool.

func (*V1Client) GetNodeStatusMapVsphere 

func (h *V1Client) GetNodeStatusMapVsphere(configUID, machinePoolName string) (map[string]models.V1CloudMachineStatus, error)

GetNodeStatusMapVsphere retrieves the status of all nodes in a vSphere machine pool.

func (*V1Client) GetNodeVirtualMaintenanceStatusVirtual 

func (h *V1Client) GetNodeVirtualMaintenanceStatusVirtual(configUID, machineName, nodeID string) (*models.V1MachineMaintenanceStatus, error)

GetNodeVirtualMaintenanceStatusVirtual retrieves maintenance status for a virtual node. TODO: deprecate unused virtual cluster functions

func (*V1Client) GetNotifications 

func (h *V1Client) GetNotifications(kind, uid string, continueVar, fields, filters, isDone, orderBy *string, limit, offset *int64, timeout *time.Duration) ([]*models.V1Notification, error)

GetNotifications retrieves notifications for a given object. TODO: which kinds are supported?

func (*V1Client) GetOciBasicRegistry 

func (h *V1Client) GetOciBasicRegistry(uid string) (*models.V1BasicOciRegistry, error)

GetOciBasicRegistry retrieves an existing standard/basic OCI registry by UID.

func (*V1Client) GetOciEcrRegistry 

func (h *V1Client) GetOciEcrRegistry(uid string) (*models.V1EcrRegistry, error)

GetOciEcrRegistry retrieves an existing ECR OCI registry by UID.

func (*V1Client) GetOciRegistryByName 

func (h *V1Client) GetOciRegistryByName(registryName string) (*models.V1OciRegistry, error)

GetOciRegistryByName retrieves an existing OCI registry by name.

func (*V1Client) GetOrganizationByName 

func (h *V1Client) GetOrganizationByName(name string) (*models.V1LoginResponse, error)

GetOrganizationByName retrieves an organization by name.

func (*V1Client) GetPCGByID 

func (h *V1Client) GetPCGByID(uid string) (*models.V1Overlord, error)

GetPCGByID retrieves a Private Cloud Gateway by UID.

func (*V1Client) GetPCGByName 

func (h *V1Client) GetPCGByName(name string) (*models.V1Overlord, error)

GetPCGByName retrieves a Private Cloud Gateway by name.

func (*V1Client) GetPCGClusterProfileMaas 

func (h *V1Client) GetPCGClusterProfileMaas(uid string) (*models.V1ClusterProfile, error)

GetPCGClusterProfileMaas retrieves a MAAS PCG cluster profile by PCG UID.

func (*V1Client) GetPCGClusterProfileOpenStack 

func (h *V1Client) GetPCGClusterProfileOpenStack(uid string) (*models.V1ClusterProfile, error)

GetPCGClusterProfileOpenStack retrieves an OpenStack PCG cluster profile by PCG UID.

func (*V1Client) GetPCGClusterProfileVsphere 

func (h *V1Client) GetPCGClusterProfileVsphere(uid string) (*models.V1ClusterProfile, error)

GetPCGClusterProfileVsphere retrieves a vSphere PCG cluster profile by PCG UID.

func (*V1Client) GetPCGId 

func (h *V1Client) GetPCGId(name *string) (string, error)

GetPCGId retrieves the UID of a Private Cloud Gateway by name.

func (*V1Client) GetPCGManifestMaas 

func (h *V1Client) GetPCGManifestMaas(pairingCode string) (string, error)

GetPCGManifestMaas retrieves a MAAS PCG manifest by pairing code.

func (*V1Client) GetPCGManifestOpenStack 

func (h *V1Client) GetPCGManifestOpenStack(pairingCode string) (string, error)

GetPCGManifestOpenStack retrieves an OpenStack PCG manifest by pairing code.

func (*V1Client) GetPCGManifestVsphere 

func (h *V1Client) GetPCGManifestVsphere(pairingCode string) (string, error)

GetPCGManifestVsphere retrieves a vSphere PCG manifest by pairing code.

func (*V1Client) GetPack 

func (h *V1Client) GetPack(uid string) (*models.V1PackTagEntity, error)

GetPack retrieves a pack by UID.

func (*V1Client) GetPackRegistry 

func (h *V1Client) GetPackRegistry(packUID, packType string) string

GetPackRegistry retrieves a pack registry by UID and pack type. If packUID is "uid" or packType is "manifest", it returns Spectro Cloud's 'Public Repo' registry.

func (*V1Client) GetPackRegistryByName 

func (h *V1Client) GetPackRegistryByName(registryName string) (*models.V1PackRegistry, error)

GetPackRegistryByName retrieves an existing Pack registry by name.

func (*V1Client) GetPackRegistryCommonByName 

func (h *V1Client) GetPackRegistryCommonByName(registryName string) (*models.V1RegistryMetadata, error)

GetPackRegistryCommonByName retrieves any type of registry by name.

func (*V1Client) GetPacks 

func (h *V1Client) GetPacks(filters []string, registryUID string) ([]*models.V1PackSummary, error)

GetPacks retrieves a list of pack summaries based on the provided registry UID and filter criteria.

func (*V1Client) GetPacksByNameAndRegistry 

func (h *V1Client) GetPacksByNameAndRegistry(name, registryUID string) (*models.V1PackTagEntity, error)

GetPacksByNameAndRegistry retrieves a pack by name and registry UID.

func (*V1Client) GetPacksByProfile 

func (h *V1Client) GetPacksByProfile(profileUID string) ([]*models.V1ClusterProfilePacksEntity, error)

GetPacksByProfile retrieves all packs for a cluster profile.

func (*V1Client) GetPairingCode 

func (h *V1Client) GetPairingCode(cloudType string) (string, error)

GetPairingCode retrieves a pairing code for a Private Cloud Gateway by cloud type.

func (*V1Client) GetPermissionByName 

func (h *V1Client) GetPermissionByName(permissionName string, permissionScope PermissionScope) (*models.V1Permission, error)

GetPermissionByName retrieves an existing permission by name and permissionScope(project, tenant & resource).

func (*V1Client) GetProfileVariables 

func (h *V1Client) GetProfileVariables(uid string) ([]*models.V1Variable, error)

GetProfileVariables retrieves all variables for a cluster profile.

func (*V1Client) GetProject 

func (h *V1Client) GetProject(uid string) (*models.V1Project, error)

GetProject retrieves an existing project by UID.

func (*V1Client) GetProjectUID 

func (h *V1Client) GetProjectUID(projectName string) (string, error)

GetProjectUID retrieves an existing project's UID by name.

func (*V1Client) GetProjects 

func (h *V1Client) GetProjects() (*models.V1ProjectsMetadata, error)

GetProjects retrieves all projects' metadata.

func (*V1Client) GetRegistrationToken 

func (h *V1Client) GetRegistrationToken(tokenName string) (string, error)

GetRegistrationToken retrieves an existing registration token by name.

func (*V1Client) GetRepaveReasons 

func (h *V1Client) GetRepaveReasons(clusterUID string) ([]string, error)

GetRepaveReasons retrieves a cluster's repave reasons.

func (*V1Client) GetRole 

func (h *V1Client) GetRole(roleName string) (*models.V1Role, error)

GetRole retrieves an existing role by name.

func (*V1Client) GetRoleByID 

func (h *V1Client) GetRoleByID(roleUID string) (*models.V1Role, error)

GetRoleByID retrieves an existing role by ID.

func (*V1Client) GetS3BackupStorageLocation 

func (h *V1Client) GetS3BackupStorageLocation(uid string) (*models.V1UserAssetsLocationS3, error)

GetS3BackupStorageLocation retrieves an existing S3 backup storage location.

func (*V1Client) GetSSHKey 

func (h *V1Client) GetSSHKey(uid string) (*models.V1UserAssetSSH, error)

GetSSHKey retrieves an existing SSH key by UID.

func (*V1Client) GetSSHKeyByName 

func (h *V1Client) GetSSHKeyByName(name string) (*models.V1UserAssetSSH, error)

GetSSHKeyByName retrieves an existing SSH key by name.

func (*V1Client) GetTFMacrosV2 

func (h *V1Client) GetTFMacrosV2(tfMacrosMap map[string]any, projectUID string) ([]*models.V1Macro, error)

GetTFMacrosV2 retrieves all macros in a project or tenant, filtered by the given map. Macros whose names are in the map and values are non-nil are returned.

func (*V1Client) GetTagFilter 

func (h *V1Client) GetTagFilter(uid string) (*models.V1TagFilterSummary, error)

GetTagFilter retrieves an existing tag filter by UID.

func (*V1Client) GetTagFilterByName 

func (h *V1Client) GetTagFilterByName(name string) (*models.V1FilterSummary, error)

GetTagFilterByName retrieves an existing tag filter by name.

func (*V1Client) GetTeam 

func (h *V1Client) GetTeam(uid string) (*models.V1Team, error)

GetTeam retrieves an existing team by UID.

func (*V1Client) GetTeamProjectRoleAssociation 

func (h *V1Client) GetTeamProjectRoleAssociation(uid string) (*models.V1ProjectRolesEntity, error)

GetTeamProjectRoleAssociation retrieves a team's project-role associations.

func (*V1Client) GetTeamResourceRole 

func (h *V1Client) GetTeamResourceRole(uid, name string) (*models.V1UIDSummary, error)

GetTeamResourceRole retrieves a resource-role by team UID and role name.

func (*V1Client) GetTeamTenantRoleAssociation 

func (h *V1Client) GetTeamTenantRoleAssociation(uid string) (*models.V1TeamTenantRolesEntity, error)

GetTeamTenantRoleAssociation retrieves a team's tenant-role associations.

func (*V1Client) GetTeamWithName 

func (h *V1Client) GetTeamWithName(teamName string) (*models.V1Team, error)

GetTeamWithName retrieves an existing team by Team name.

func (*V1Client) GetTeamWorkspaceRoleAssociation 

func (h *V1Client) GetTeamWorkspaceRoleAssociation(uid string) (*models.V1WorkspaceScopeRoles, error)

GetTeamWorkspaceRoleAssociation retrieves a team's workspace-role associations.

func (*V1Client) GetTenantUID 

func (h *V1Client) GetTenantUID() (string, error)

GetTenantUID retrieves the tenant UID of the authenticated user.

func (*V1Client) GetTheKubernetesCerts 

func (h *V1Client) GetTheKubernetesCerts(clusterUID string) (*models.V1MachineCertificates, error)

GetTheKubernetesCerts retrieves the Kubernetes certificates for the specified cluster.

func (*V1Client) GetUserByEmail 

func (h *V1Client) GetUserByEmail(email string) (*models.V1User, error)

GetUserByEmail retrieves an existing user by email.

func (*V1Client) GetUserByID 

func (h *V1Client) GetUserByID(userUID string) (*models.V1User, error)

GetUserByID retrieves an existing user by ID.

func (*V1Client) GetUserByName 

func (h *V1Client) GetUserByName(name string) (*models.V1User, error)

GetUserByName retrieves an existing user by name.

func (*V1Client) GetUserProjectRole 

func (h *V1Client) GetUserProjectRole(userUID string) (*models.V1ProjectRolesEntity, error)

GetUserProjectRole get project role to the user.

func (*V1Client) GetUserResourceRoles 

func (h *V1Client) GetUserResourceRoles(userUID string) ([]*models.V1ResourceRolesEntity, error)

GetUserResourceRoles get resource role for the user.

func (*V1Client) GetUserSummaryByEmail 

func (h *V1Client) GetUserSummaryByEmail(userEmail string) (*models.V1UserSummary, error)

GetUserSummaryByEmail retrieves user by email.

func (*V1Client) GetUserTenantRole 

func (h *V1Client) GetUserTenantRole(userUID string) (*models.V1UserRolesEntity, error)

GetUserTenantRole get tenant roles for the user.

func (*V1Client) GetUserWorkspaceRole 

func (h *V1Client) GetUserWorkspaceRole(userUID string) (*models.V1WorkspaceScopeRoles, error)

GetUserWorkspaceRole get workspace role for the user.

func (*V1Client) GetUsers 

func (h *V1Client) GetUsers() (*models.V1Users, error)

GetUsers retrieves all users.

func (*V1Client) GetUsersInfo 

func (h *V1Client) GetUsersInfo() (*models.V1UserInfo, error)

GetUsersInfo retrieves the authenticated user info.

func (*V1Client) GetVirtualMachine 

func (h *V1Client) GetVirtualMachine(uid, namespace, name string) (*models.V1ClusterVirtualMachine, error)

GetVirtualMachine gets an existing virtual machine, regardless of its status.

func (*V1Client) GetVirtualMachineWithoutStatus 

func (h *V1Client) GetVirtualMachineWithoutStatus(uid, name, namespace string) (*models.V1ClusterVirtualMachine, error)

GetVirtualMachineWithoutStatus retrieves a virtual machine, regardless of its status.

func (*V1Client) GetVirtualMachines 

func (h *V1Client) GetVirtualMachines(cluster *models.V1SpectroCluster) ([]*models.V1ClusterVirtualMachine, error)

GetVirtualMachines retrieves a list of virtual machines for a given cluster.

func (*V1Client) GetVsphereDNSMap 

func (h *V1Client) GetVsphereDNSMap(dnsMapID string) (*models.V1VsphereDNSMapping, error)

GetVsphereDNSMap get an existing DNS Mapping for a Private Cloud Gateway

func (*V1Client) GetVsphereDNSMappingsByPCGId 

func (h *V1Client) GetVsphereDNSMappingsByPCGId(PCGId string) (*models.V1VsphereDNSMappings, error)

GetVsphereDNSMappingsByPCGId get an existing DNS Mappings for a Private Cloud Gateway with PCG-ID

func (*V1Client) GetWorkspace 

func (h *V1Client) GetWorkspace(uid string) (*models.V1Workspace, error)

GetWorkspace retrieves an existing workspace by UID.

func (*V1Client) GetWorkspaceBackup 

func (h *V1Client) GetWorkspaceBackup(uid string) (*models.V1WorkspaceBackup, error)

GetWorkspaceBackup retrieves an existing workspace backup by UID.

func (*V1Client) GetWorkspaceByName 

func (h *V1Client) GetWorkspaceByName(name string) (*models.V1DashboardWorkspace, error)

GetWorkspaceByName retrieves an existing workspace by name.

func (*V1Client) ImportClusterAws 

func (h *V1Client) ImportClusterAws(meta *models.V1ObjectMetaInputEntity) (string, error)

ImportClusterAws imports an existing AWS IaaS cluster.

func (*V1Client) ImportClusterAzure 

func (h *V1Client) ImportClusterAzure(meta *models.V1ObjectMetaInputEntity) (string, error)

ImportClusterAzure imports an existing Azure IaaS cluster.

func (*V1Client) ImportClusterEdgeVsphere 

func (h *V1Client) ImportClusterEdgeVsphere(meta *models.V1ObjectMetaInputEntity) (string, error)

ImportClusterEdgeVsphere imports an existing vSphere edge cluster.

func (*V1Client) ImportClusterGcp 

func (h *V1Client) ImportClusterGcp(meta *models.V1ObjectMetaInputEntity) (string, error)

ImportClusterGcp imports an existing GCP IaaS cluster.

func (*V1Client) ImportClusterGeneric 

func (h *V1Client) ImportClusterGeneric(meta *models.V1ObjectMetaInputEntity) (string, error)

ImportClusterGeneric imports a cluster using a generic import manifest.

func (*V1Client) ImportClusterMaas 

func (h *V1Client) ImportClusterMaas(meta *models.V1ObjectMetaInputEntity) (string, error)

ImportClusterMaas imports an existing MAAS cluster.

func (*V1Client) ImportClusterOpenStack 

func (h *V1Client) ImportClusterOpenStack(meta *models.V1ObjectMetaInputEntity) (string, error)

ImportClusterOpenStack imports an existing OpenStack cluster.

func (*V1Client) ImportClusterProfile 

func (h *V1Client) ImportClusterProfile(profileContent string) (string, error)

ImportClusterProfile imports a cluster profile given the profile content as a string.

func (*V1Client) ImportClusterVsphere 

func (h *V1Client) ImportClusterVsphere(meta *models.V1ObjectMetaInputEntity) (string, error)

ImportClusterVsphere imports an existing vSphere cluster.

func (*V1Client) InitiateDownloadOfClusterLogs 

func (h *V1Client) InitiateDownloadOfClusterLogs(uid string, req *models.V1ClusterLogFetcherRequest) (*string, error)

InitiateDownloadOfClusterLogs initiates the download of a cluster's logs. Returns a log fetcher uid which is required to perform the log download. Before downloading logs, the log fetcher's status should be checked.

func (*V1Client) InitiateTheCertRenewal 

func (h *V1Client) InitiateTheCertRenewal(clusterUID string) error

InitiateTheCertRenewal initiates the certificate renewal process for the specified cluster.

func (*V1Client) IsVMExists 

func (h *V1Client) IsVMExists(clusterUID, name, namespace string) (bool, error)

IsVMExists checks if a virtual machine exists.

func (*V1Client) ListBackupStorageLocation 

func (h *V1Client) ListBackupStorageLocation() ([]*models.V1UserAssetsLocation, error)

ListBackupStorageLocation returns a list of all backup storage locations.

func (*V1Client) ListCloudAccounts 

func (h *V1Client) ListCloudAccounts() ([]*models.V1CloudAccountSummary, error)

ListCloudAccounts returns a list of all cloud account summaries.

func (*V1Client) ListEdgeHosts 

func (h *V1Client) ListEdgeHosts() ([]*models.V1EdgeHostsMetadata, error)

ListEdgeHosts returns a list of all edge hosts. TODO: expose pagination params

func (*V1Client) ListHelmRegistries 

func (h *V1Client) ListHelmRegistries(scope string) ([]*models.V1HelmRegistrySummary, error)

ListHelmRegistries retrieves a list of all Helm registries, filtered by scope.

func (*V1Client) ListMachinesInPoolEdgeNative 

func (h *V1Client) ListMachinesInPoolEdgeNative(machinePoolName, cloudConfigUID string) ([]*models.V1EdgeNativeMachine, error)

ListMachinesInPoolEdgeNative returns a list of machines in an edge native machine pool.

func (*V1Client) ListOCIRegistries 

func (h *V1Client) ListOCIRegistries() ([]*models.V1OciRegistry, error)

ListOCIRegistries retrieves a list of all OCI registries.

func (*V1Client) ListOrganizations 

func (h *V1Client) ListOrganizations() ([]*models.V1Organization, error)

ListOrganizations retrieves all organizations.

func (*V1Client) ListTagFilters 

func (h *V1Client) ListTagFilters() (*models.V1FiltersSummary, error)

ListTagFilters retrieves all tag filters.

func (*V1Client) MigrateVirtualMachineNodeToNode 

func (h *V1Client) MigrateVirtualMachineNodeToNode(clusterUID, vmName, vmNamespace string) error

MigrateVirtualMachineNodeToNode migrates a virtual machine from one node to another.

func (*V1Client) PatchApplicationProfile 

func (h *V1Client) PatchApplicationProfile(appProfileUID string, metadata *models.V1AppProfileMetaEntity) error

PatchApplicationProfile patches an existing application profile.

func (*V1Client) PatchClusterProfile 

func (h *V1Client) PatchClusterProfile(clusterProfile *models.V1ClusterProfileUpdateEntity, metadata *models.V1ProfileMetaEntity) error

PatchClusterProfile patches an existing cluster profile's metadata.

func (*V1Client) PatchWithRetry 

func (h *V1Client) PatchWithRetry(params *clientv1.V1SpectroClustersPatchProfilesParams) error

PatchWithRetry patches cluster's profiles with with retry logic.

func (*V1Client) PauseVirtualMachine 

func (h *V1Client) PauseVirtualMachine(clusterUID, vmName, vmNamespace string) error

PauseVirtualMachine pauses a virtual machine.

func (*V1Client) PublishClusterProfile 

func (h *V1Client) PublishClusterProfile(uid string) error

PublishClusterProfile publishes an existing cluster profile. TODO: what does it mean to publish a cluster profile?

func (*V1Client) RemoveAddonsFromCluster 

func (h *V1Client) RemoveAddonsFromCluster(clusterUID string, profileUIDs []string) error

RemoveAddonsFromCluster removes one or more addon profiles from the cluster.

func (*V1Client) ResizeClusterVirtual 

func (h *V1Client) ResizeClusterVirtual(configUID string, body *models.V1VirtualClusterResize) error

ResizeClusterVirtual resizes a virtual cluster's CPU, RAM, and storage configuration.

func (*V1Client) RestartVirtualMachine 

func (h *V1Client) RestartVirtualMachine(clusterUID, vmName, vmNamespace string) error

RestartVirtualMachine restarts a virtual machine.

func (*V1Client) ResumeVirtualMachine 

func (h *V1Client) ResumeVirtualMachine(clusterUID, vmName, vmNamespace string) error

ResumeVirtualMachine resumes a virtual machine.

func (*V1Client) SearchAppDeploymentSummaries 

func (h *V1Client) SearchAppDeploymentSummaries(filter *models.V1AppDeploymentFilterSpec, sortBy []*models.V1AppDeploymentSortSpec) ([]*models.V1AppDeploymentSummary, error)

SearchAppDeploymentSummaries retrieves a list of application deployment summaries based on the filter and sort criteria.

func (*V1Client) SearchAppProfileSummaries 

func (h *V1Client) SearchAppProfileSummaries(filter *models.V1AppProfileFilterSpec, sortBy []*models.V1AppProfileSortSpec) ([]*models.V1AppProfileSummary, error)

SearchAppProfileSummaries retrieves a list of application profile summaries based on the provided filter and sort criteria.

func (*V1Client) SearchApplianceSummaries 

func (h *V1Client) SearchApplianceSummaries(filter *models.V1SearchFilterSpec, sort []*models.V1SearchFilterSortSpec) ([]*models.V1EdgeHostsMetadata, error)

SearchApplianceSummaries retrieves a list of edge host summaries based on the provided filter and sort criteria.

func (*V1Client) SearchClusterSummaries 

func (h *V1Client) SearchClusterSummaries(filter *models.V1SearchFilterSpec, sort []*models.V1SearchFilterSortSpec) ([]*models.V1SpectroClusterSummary, error)

SearchClusterSummaries retrieves a list of cluster summaries based on the provided filter and sort criteria.

func (*V1Client) SearchPackRegistryCommon 

func (h *V1Client) SearchPackRegistryCommon() ([]*models.V1RegistryMetadata, error)

SearchPackRegistryCommon retrieves a list of all registries.

func (*V1Client) SearchPacks 

func (h *V1Client) SearchPacks(filter *models.V1PackFilterSpec, sortBy []*models.V1PackSortSpec) ([]*models.V1PackMetadata, error)

SearchPacks retrieves a list of pack metadata based on the filter and sort criteria.

func (*V1Client) StartVirtualMachine 

func (h *V1Client) StartVirtualMachine(clusterUID, vmName, vmNamespace string) error

StartVirtualMachine starts a virtual machine.

func (*V1Client) StopVirtualMachine 

func (h *V1Client) StopVirtualMachine(clusterUID, vmName, vmNamespace string) error

StopVirtualMachine stops a virtual machine.

func (*V1Client) ToggleMaintenanceOnNode 

func (h *V1Client) ToggleMaintenanceOnNode(nodeMaintenance *models.V1MachineMaintenance, cloudType, configUID, machineName, nodeID string) error

ToggleMaintenanceOnNode updates maintenance configuration for a node.

func (*V1Client) UpdateAccountCustomCloud 

func (h *V1Client) UpdateAccountCustomCloud(uid string, account *models.V1CustomAccountEntity, cloudType string) error

UpdateAccountCustomCloud updates an existing custom cloud account.

func (*V1Client) UpdateAdditionalClusterMetadata 

func (h *V1Client) UpdateAdditionalClusterMetadata(uid string, additionalMeta *models.V1ClusterMetaAttributeEntity) error

UpdateAdditionalClusterMetadata updates an existing cluster's additional metadata attributes. TODO: what are additional metadata attributes?

func (*V1Client) UpdateAddonDeployment 

func (h *V1Client) UpdateAddonDeployment(cluster *models.V1SpectroCluster, body *models.V1SpectroClusterProfiles, newProfile *models.V1ClusterProfile) error

UpdateAddonDeployment updates the addon deployment for a cluster.

func (*V1Client) UpdateAlert 

func (h *V1Client) UpdateAlert(body *models.V1Channel, projectUID, component, alertUID string) (string, error)

UpdateAlert updates an existing alert.

func (*V1Client) UpdateAppliance 

func (h *V1Client) UpdateAppliance(uid string, appliance *models.V1EdgeHostDevice) error

UpdateAppliance updates an existing edge host.

func (*V1Client) UpdateApplianceMeta 

func (h *V1Client) UpdateApplianceMeta(uid string, appliance *models.V1EdgeHostDeviceMetaUpdateEntity) error

UpdateApplianceMeta updates the metadata of an existing edge host.

func (*V1Client) UpdateApplicationProfileTiers 

func (h *V1Client) UpdateApplicationProfileTiers(appProfileUID, tierUID string, appTier *models.V1AppTierUpdateEntity) error

UpdateApplicationProfileTiers updates tiers for an application profile.

func (*V1Client) UpdateAzureBackupStorageLocation 

func (h *V1Client) UpdateAzureBackupStorageLocation(uid string, bsl *models.V1UserAssetsLocationAzure) error

UpdateAzureBackupStorageLocation updates an existing Azure backup storage location.

func (*V1Client) UpdateCloudAccountAws 

func (h *V1Client) UpdateCloudAccountAws(account *models.V1AwsAccount) error

UpdateCloudAccountAws updates an existing AWS cloud account.

func (*V1Client) UpdateCloudAccountAzure 

func (h *V1Client) UpdateCloudAccountAzure(account *models.V1AzureAccount) error

UpdateCloudAccountAzure updates an existing Azure cloud account.

func (*V1Client) UpdateCloudAccountGcp 

func (h *V1Client) UpdateCloudAccountGcp(account *models.V1GcpAccountEntity) error

UpdateCloudAccountGcp updates an existing GCP cloud account.

func (*V1Client) UpdateCloudAccountMaas 

func (h *V1Client) UpdateCloudAccountMaas(account *models.V1MaasAccount) error

UpdateCloudAccountMaas updates an existing MAAS cloud account.

func (*V1Client) UpdateCloudAccountOpenStack 

func (h *V1Client) UpdateCloudAccountOpenStack(account *models.V1OpenStackAccount) error

UpdateCloudAccountOpenStack updates an existing OpenStack cloud account.

func (*V1Client) UpdateCloudAccountTke 

func (h *V1Client) UpdateCloudAccountTke(account *models.V1TencentAccount) error

UpdateCloudAccountTke updates an existing TKE cloud account.

func (*V1Client) UpdateCloudAccountVsphere 

func (h *V1Client) UpdateCloudAccountVsphere(account *models.V1VsphereAccount) error

UpdateCloudAccountVsphere updates an existing vSphere cloud account.

func (*V1Client) UpdateCloudConfigCustomCloud 

func (h *V1Client) UpdateCloudConfigCustomCloud(updatedConfig *models.V1CustomCloudClusterConfigEntity, configUID, cloudType string) error

UpdateCloudConfigCustomCloud updates an existing custom cloud cluster's cloud config.

func (*V1Client) UpdateCloudConfigVsphere 

func (h *V1Client) UpdateCloudConfigVsphere(uid string, cloudConfig *models.V1VsphereCloudClusterConfigEntity) error

UpdateCloudConfigVsphere updates an existing vSphere cluster's cloud config.

func (*V1Client) UpdateClusterBackupConfig 

func (h *V1Client) UpdateClusterBackupConfig(uid string, config *models.V1ClusterBackupConfig) error

UpdateClusterBackupConfig updates an existing scheduled backup configuration for a cluster.

func (*V1Client) UpdateClusterGroup 

func (h *V1Client) UpdateClusterGroup(uid string, clusterGroup *models.V1ClusterGroupHostClusterEntity) error

UpdateClusterGroup updates an existing cluster group.

func (*V1Client) UpdateClusterGroupMeta 

func (h *V1Client) UpdateClusterGroupMeta(clusterGroup *models.V1ClusterGroupEntity) error

UpdateClusterGroupMeta updates an existing cluster group's metadata.

func (*V1Client) UpdateClusterHostConfig 

func (h *V1Client) UpdateClusterHostConfig(uid string, config *models.V1HostClusterConfigEntity) error

UpdateClusterHostConfig updates an existing cluster's virtual cluster hosting config.

func (*V1Client) UpdateClusterLocationConfig 

func (h *V1Client) UpdateClusterLocationConfig(uid string, config *models.V1SpectroClusterLocationInputEntity) error

UpdateClusterLocationConfig updates a cluster's location config.

func (*V1Client) UpdateClusterMetadata 

func (h *V1Client) UpdateClusterMetadata(uid string, config *models.V1ObjectMetaInputEntitySchema) error

UpdateClusterMetadata updates an existing cluster's metadata: annotations, labels, and name.

func (*V1Client) UpdateClusterNamespaceConfig 

func (h *V1Client) UpdateClusterNamespaceConfig(uid string, config *models.V1ClusterNamespaceResourcesUpdateEntity) error

UpdateClusterNamespaceConfig updates an existing namespaced resource configuration for a cluster. Create is not supported for namespaced resources.

func (*V1Client) UpdateClusterOsPatchConfig 

func (h *V1Client) UpdateClusterOsPatchConfig(uid string, config *models.V1OsPatchEntity) error

UpdateClusterOsPatchConfig updates an existing cluster's OS patching configuration.

func (*V1Client) UpdateClusterProfile 

func (h *V1Client) UpdateClusterProfile(clusterProfile *models.V1ClusterProfileUpdateEntity) error

UpdateClusterProfile updates an existing cluster profile.

func (*V1Client) UpdateClusterProfileInClusterGroup 

func (h *V1Client) UpdateClusterProfileInClusterGroup(clusterGroupUID string, clusterProfiles *models.V1SpectroClusterProfiles) error

UpdateClusterProfileInClusterGroup updates an existing cluster group's default cluster profiles.

func (*V1Client) UpdateClusterProfileValues 

func (h *V1Client) UpdateClusterProfileValues(uid string, profiles *models.V1SpectroClusterProfiles) error

UpdateClusterProfileValues updates a cluster's profile values.

func (*V1Client) UpdateClusterRbacConfig 

func (h *V1Client) UpdateClusterRbacConfig(uid string, config *models.V1ClusterRbacResourcesUpdateEntity) error

UpdateClusterRbacConfig updates an existing RBAC configuration for a cluster.

func (*V1Client) UpdateClusterScanConfig 

func (h *V1Client) UpdateClusterScanConfig(uid string, config *models.V1ClusterComplianceScheduleConfig) error

UpdateClusterScanConfig updates an existing cluster scan configuration for a cluster.

func (*V1Client) UpdateFargateProfilesEks 

func (h *V1Client) UpdateFargateProfilesEks(cloudConfigUID string, fargateProfiles *models.V1EksFargateProfiles) error

UpdateFargateProfilesEks updates an existing EKS cluster's fargate profiles.

func (*V1Client) UpdateGcpBackupStorageLocation 

func (h *V1Client) UpdateGcpBackupStorageLocation(uid string, bsl *models.V1UserAssetsLocationGcp) error

UpdateGcpBackupStorageLocation updates an existing Gcp backup storage location.

func (*V1Client) UpdateHelmRegistry 

func (h *V1Client) UpdateHelmRegistry(uid string, registry *models.V1HelmRegistry) error

UpdateHelmRegistry updates an existing Helm registry.

func (*V1Client) UpdateIPPool 

func (h *V1Client) UpdateIPPool(pcgUID, poolUID string, pool *models.V1IPPoolInputEntity) error

UpdateIPPool updates an existing Private Cloud Gateway IP pool.

func (*V1Client) UpdateMachinePoolAks 

func (h *V1Client) UpdateMachinePoolAks(cloudConfigUID string, machinePool *models.V1AzureMachinePoolConfigEntity) error

UpdateMachinePoolAks updates an existing AKS machine pool.

func (*V1Client) UpdateMachinePoolAws 

func (h *V1Client) UpdateMachinePoolAws(cloudConfigUID string, machinePool *models.V1AwsMachinePoolConfigEntity) error

UpdateMachinePoolAws updates an existing AWS IaaS machine pool.

func (*V1Client) UpdateMachinePoolAzure 

func (h *V1Client) UpdateMachinePoolAzure(cloudConfigUID string, machinePool *models.V1AzureMachinePoolConfigEntity) error

UpdateMachinePoolAzure updates an existing Azure IaaS machine pool.

func (*V1Client) UpdateMachinePoolCustomCloud 

func (h *V1Client) UpdateMachinePoolCustomCloud(mpEntity *models.V1CustomMachinePoolConfigEntity, machinePoolName, configUID, cloudType string) error

UpdateMachinePoolCustomCloud updates an existing custom cloud machine pool.

func (*V1Client) UpdateMachinePoolEdgeNative 

func (h *V1Client) UpdateMachinePoolEdgeNative(cloudConfigUID string, machinePool *models.V1EdgeNativeMachinePoolConfigEntity) error

UpdateMachinePoolEdgeNative updates an existing edge native machine pool.

func (*V1Client) UpdateMachinePoolEdgeVsphere 

func (h *V1Client) UpdateMachinePoolEdgeVsphere(cloudConfigUID string, machinePool *models.V1VsphereMachinePoolConfigEntity) error

UpdateMachinePoolEdgeVsphere updates an existing vSphere edge machine pool.

func (*V1Client) UpdateMachinePoolEks 

func (h *V1Client) UpdateMachinePoolEks(cloudConfigUID string, machinePool *models.V1EksMachinePoolConfigEntity) error

UpdateMachinePoolEks updates an existing EKS machine pool.

func (*V1Client) UpdateMachinePoolGcp 

func (h *V1Client) UpdateMachinePoolGcp(cloudConfigUID string, machinePool *models.V1GcpMachinePoolConfigEntity) error

UpdateMachinePoolGcp updates an existing GCP IaaS machine pool.

func (*V1Client) UpdateMachinePoolGke 

func (h *V1Client) UpdateMachinePoolGke(cloudConfigID string, machinePool *models.V1GcpMachinePoolConfigEntity) error

UpdateMachinePoolGke updates an existing GKE machine pool.

func (*V1Client) UpdateMachinePoolMaas 

func (h *V1Client) UpdateMachinePoolMaas(cloudConfigUID string, machinePool *models.V1MaasMachinePoolConfigEntity) error

UpdateMachinePoolMaas updates an existing MAAS machine pool.

func (*V1Client) UpdateMachinePoolOpenStack 

func (h *V1Client) UpdateMachinePoolOpenStack(cloudConfigUID string, machinePool *models.V1OpenStackMachinePoolConfigEntity) error

UpdateMachinePoolOpenStack updates an existing OpenStack machine pool.

func (*V1Client) UpdateMachinePoolTke 

func (h *V1Client) UpdateMachinePoolTke(cloudConfigUID string, machinePool *models.V1TencentMachinePoolConfigEntity) error

UpdateMachinePoolTke updates an existing TKE machine pool.

func (*V1Client) UpdateMachinePoolVirtual 

func (h *V1Client) UpdateMachinePoolVirtual(cloudConfigUID string, machinePool *models.V1VirtualMachinePoolConfigEntity) error

UpdateMachinePoolVirtual updates an existing virtual machine pool. TODO: deprecate unused virtual cluster functions

func (*V1Client) UpdateMachinePoolVsphere 

func (h *V1Client) UpdateMachinePoolVsphere(cloudConfigUID string, machinePool *models.V1VsphereMachinePoolConfigEntity) error

UpdateMachinePoolVsphere updates an existing vSphere machine pool.

func (*V1Client) UpdateMacro 

func (h *V1Client) UpdateMacro(uid string, macros *models.V1Macros) error

UpdateMacro updates an existing macro.

func (*V1Client) UpdateMacros 

func (h *V1Client) UpdateMacros(uid string, macros *models.V1Macros) error

UpdateMacros updates an existing macro.

func (*V1Client) UpdateMinioBackupStorageLocation 

func (h *V1Client) UpdateMinioBackupStorageLocation(uid string, bsl *models.V1UserAssetsLocationS3) error

UpdateMinioBackupStorageLocation updates an existing Minio backup storage location.

func (*V1Client) UpdateOciBasicRegistry 

func (h *V1Client) UpdateOciBasicRegistry(uid string, registry *models.V1BasicOciRegistry) error

UpdateOciBasicRegistry updates an existing standard/basic OCI registry.

func (*V1Client) UpdateOciEcrRegistry 

func (h *V1Client) UpdateOciEcrRegistry(uid string, registry *models.V1EcrRegistry) error

UpdateOciEcrRegistry updates an existing ECR OCI registry.

func (*V1Client) UpdatePCGVsphere 

func (h *V1Client) UpdatePCGVsphere(uid string, cloudConfig *models.V1OverlordVsphereCloudConfig) error

UpdatePCGVsphere updates a vSphere Private Cloud Gateway VsphereCloudConfig.

func (*V1Client) UpdatePauseAgentUpgradeSettingCluster 

func (h *V1Client) UpdatePauseAgentUpgradeSettingCluster(upgradeSetting *models.V1ClusterUpgradeSettingsEntity, clusterUID string) error

UpdatePauseAgentUpgradeSettingCluster updates the upgrade settings of a specific cluster to pause the agent upgrade process.

func (*V1Client) UpdateProfileVariables 

func (h *V1Client) UpdateProfileVariables(variables *models.V1Variables, uid string) error

UpdateProfileVariables updates variables for a cluster profile.

func (*V1Client) UpdateProject 

func (h *V1Client) UpdateProject(uid string, body *models.V1ProjectEntity) error

UpdateProject updates an existing project.

func (*V1Client) UpdateRole 

func (h *V1Client) UpdateRole(role *models.V1Role, roleUID string) error

UpdateRole Update existing role with ID

func (*V1Client) UpdateS3BackupStorageLocation 

func (h *V1Client) UpdateS3BackupStorageLocation(uid string, bsl *models.V1UserAssetsLocationS3) error

UpdateS3BackupStorageLocation updates an existing S3 backup storage location.

func (*V1Client) UpdateSSHKey 

func (h *V1Client) UpdateSSHKey(uid string, body *models.V1UserAssetSSH) error

UpdateSSHKey updates an existing SSH key.

func (*V1Client) UpdateTagFilter 

func (h *V1Client) UpdateTagFilter(uid string, body *models.V1TagFilter) error

UpdateTagFilter updates an existing tag filter.

func (*V1Client) UpdateTeam 

func (h *V1Client) UpdateTeam(uid string, team *models.V1Team) error

UpdateTeam updates an existing team.

func (*V1Client) UpdateTeamResourceRole 

func (h *V1Client) UpdateTeamResourceRole(uid string, body *models.V1ResourceRolesUpdateEntity) error

UpdateTeamResourceRole updates a team's resource-role associations.

func (*V1Client) UpdateUser 

func (h *V1Client) UpdateUser(uid string, user *models.V1UserUpdateEntity) error

UpdateUser update existing user.

func (*V1Client) UpdateVirtualMachine 

func (h *V1Client) UpdateVirtualMachine(cluster *models.V1SpectroCluster, vmName string, body *models.V1ClusterVirtualMachine) (*models.V1ClusterVirtualMachine, error)

UpdateVirtualMachine updates an existing virtual machine.

func (*V1Client) UpdateVsphereDNSMap 

func (h *V1Client) UpdateVsphereDNSMap(dnsMapID string, dnsMapBody *models.V1VsphereDNSMapping) error

UpdateVsphereDNSMap update an existing DNS Mapping for a Private Cloud Gateway

func (*V1Client) UpdateWorkspaceBackupConfig 

func (h *V1Client) UpdateWorkspaceBackupConfig(uid string, config *models.V1WorkspaceBackupConfigEntity) error

UpdateWorkspaceBackupConfig updates an existing workspace's backup configuration.

func (*V1Client) UpdateWorkspaceRBACS 

func (h *V1Client) UpdateWorkspaceRBACS(uid, rbacUID string, r *models.V1ClusterRbac) error

UpdateWorkspaceRBACS updates an existing workspace's RBAC configuration.

func (*V1Client) UpdateWorkspaceResourceAllocation 

func (h *V1Client) UpdateWorkspaceResourceAllocation(uid string, we *models.V1WorkspaceClusterNamespacesEntity) error

UpdateWorkspaceResourceAllocation updates an existing workspace's resource allocation.

func (*V1Client) UpgradeClusterProfile 

func (h *V1Client) UpgradeClusterProfile(clusterUID string, body *models.V1SpectroClusterProfiles) error

UpgradeClusterProfile upgrades a cluster profile with the given profile content.

func (*V1Client) Validate 

func (h *V1Client) Validate() error

Validate validates the configuration for a project-scoped client.

func (*V1Client) ValidateAzureBackupStorageLocation 

func (h *V1Client) ValidateAzureBackupStorageLocation(azureCred *models.V1AzureCloudAccount) error

ValidateAzureBackupStorageLocation validate an azure credential for backup storage location.

func (*V1Client) ValidateCustomCloudType 

func (h *V1Client) ValidateCustomCloudType(cloudType string) error

ValidateCustomCloudType validates a custom cloud type.

func (*V1Client) ValidateGcpBackupStorageLocation 

func (h *V1Client) ValidateGcpBackupStorageLocation(gcpCred *models.V1GcpAccountNameValidateSpec) error

ValidateGcpBackupStorageLocation validate a gcp credential for backup storage location.

func (*V1Client) ValidateS3BackupStorageLocation 

func (h *V1Client) ValidateS3BackupStorageLocation(awsCred *models.V1AwsS3BucketCredentials) error

ValidateS3BackupStorageLocation validate a S3 credential for backup storage location.

func (*V1Client) ValidateTenantAdmin 

func (h *V1Client) ValidateTenantAdmin() error

ValidateTenantAdmin validates the configuration for a tenant-scoped client.

func (*V1Client) VirtualClusterLifecycleConfigChange 

func (h *V1Client) VirtualClusterLifecycleConfigChange(uid string, body *models.V1LifecycleConfigEntity) (string, error)

VirtualClusterLifecycleConfigChange pauses or unpauses an existing virtual cluster.

Source Files

View all Source files

Directories

Path Synopsis
Package apiutil provides utilities for the Spectro Cloud API client.
 Package apiutil provides utilities for the Spectro Cloud API client.
Package herr provides error handling utilities for the Spectro Cloud API client.
 Package herr provides error handling utilities for the Spectro Cloud API client.

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.