util

package
v0.0.0-...-b4184db Latest Latest
Warning

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

 Go to latest Published: Jan 4, 2025 License: Apache-2.0 Imports: 20 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// GCPCredentialsEnv env variable name for gcp provider/storage config/releases
	GCPCredentialsEnv = "GOOGLE_APPLICATION_CREDENTIALS"
	// GCSCredentialsJSON field name to denote in Json request
	GCSCredentialsJSON = "GCS_CREDENTIALS_JSON"
	// UseGCPIAM field name to denote in Json request
	UseGCPIAM = "USE_GCP_IAM"
	// GCPConfigField field name to denote in Json request
	GCPConfigField = "GCP_CONFIG"
	// GCPLocationIDField field name to denote in Json request
	GCPLocationIDField = "LOCATION_ID"
	// GCPProtectionLevelField field name to denote in Json request
	GCPProtectionLevelField = "PROTECTION_LEVEL"
	// GCPKmsEndpointField field name to denote in Json request
	GCPKmsEndpointField = "GCP_KMS_ENDPOINT"
	// GCPKeyRingIDField field name to denote in Json request
	GCPKeyRingIDField = "KEY_RING_ID"
	// GCPCryptoKeyIDField field name to denote in Json request
	GCPCryptoKeyIDField = "CRYPTO_KEY_ID"

	// AWSAccessKeyEnv env variable name for aws provider/storage config/releases
	AWSAccessKeyEnv = "AWS_ACCESS_KEY_ID"
	// AWSSecretAccessKeyEnv env variable name for aws provider/storage config/releases
	AWSSecretAccessKeyEnv = "AWS_SECRET_ACCESS_KEY"
	// IAMInstanceProfile field name to denote in Json request
	IAMInstanceProfile = "IAM_INSTANCE_PROFILE"
	// AWSRegionEnv env variable name for aws kmsc config
	AWSRegionEnv = "AWS_REGION"
	// AWSCMKIDField field name to denote in Json request
	AWSCMKIDField = "cmk_id"
	// AWSCMKPolicyField field name to denote in Json request
	AWSCMKPolicyField = "cmk_policy"
	// AWSEndpointEnv field name to denote in Json request
	AWSEndpointEnv = "AWS_KMS_ENDPOINT"

	// AzureSubscriptionIDEnv env variable name for azure provider
	AzureSubscriptionIDEnv = "AZURE_SUBSCRIPTION_ID"
	// AzureRGEnv env variable name for azure provider
	AzureRGEnv = "AZURE_RG"
	// AzureTenantIDEnv env variable name for azure provider
	AzureTenantIDEnv = "AZURE_TENANT_ID"
	// AzureClientIDEnv env variable name for azure provider
	AzureClientIDEnv = "AZURE_CLIENT_ID"
	// AzureClientSecretEnv env variable name for azure provider
	AzureClientSecretEnv = "AZURE_CLIENT_SECRET"

	// AzureStorageSasTokenEnv env variable name azure storage config
	AzureStorageSasTokenEnv = "AZURE_STORAGE_SAS_TOKEN"

	// AzureClientIDField field name to denote in Json request
	AzureClientIDField = "CLIENT_ID"
	// AzureClientSecretField field name to denote in Json request
	AzureClientSecretField = "CLIENT_SECRET"
	// AzureTenantIDField field name to denote in Json request
	AzureTenantIDField = "TENANT_ID"
	// AzureVaultURLField field name to denote in Json request
	AzureVaultURLField = "AZU_VAULT_URL"
	// AzureKeyNameField field name to denote in Json request
	AzureKeyNameField = "AZU_KEY_NAME"
	// AzureKeyAlgorithmField field name to denote in Json request
	AzureKeyAlgorithmField = "AZU_KEY_ALGORITHM"
	// AzureKeySizeField field name to denote in Json request
	AzureKeySizeField = "AZU_KEY_SIZE"

	// HashicorpVaultTokenEnv env variable name for hashicorp vault
	HashicorpVaultTokenEnv = "VAULT_TOKEN"
	// HashicorpVaultAddressEnv env variable name for hashicorp vault
	HashicorpVaultAddressEnv = "VAULT_ADDR"
	// HashicorpVaulNamespaceEnv env variable name for hashicorp vault
	HashicorpVaultNamespaceEnv = "VAULT_NAMESPACE"

	// HashicorpVaultAddressField variable name for hashicorp vault
	HashicorpVaultAddressField = "HC_VAULT_ADDRESS"
	// HashicorpVaultTokenField variable name for hashicorp vault
	HashicorpVaultTokenField = "HC_VAULT_TOKEN"
	// HashicorpVaultNamespaceField variable name for hashicorp vault
	HashicorpVaultNamespaceField = "HC_VAULT_NAMESPACE"
	// HashicorpVaultEngineField variable name for hashicorp vault
	HashicorpVaultEngineField = "HC_VAULT_ENGINE"
	// HashicorpVaultMountPathField variable name for hashicorp vault
	HashicorpVaultMountPathField = "HC_VAULT_MOUNT_PATH"
	// HashicorpVaultKeyNameField variable name for hashicorp vault
	HashicorpVaultKeyNameField = "HC_VAULT_KEY_NAME"
	// HashicorpVaultRoleIDField variable name for hashicorp vault
	HashicorpVaultRoleIDField = "HC_VAULT_ROLE_ID"
	// HashicorpVaultSecretIDField variable name for hashicorp vault
	HashicorpVaultSecretIDField = "HC_VAULT_SECRET_ID"
	// HashicorpVaultAuthNamespaceField variable name for hashicorp vault
	HashicorpVaultAuthNamespaceField = "HC_VAULT_AUTH_NAMESPACE"
)

Environment variable fields

View Source 
const (

	// YBAAllowUniverseMinVersion specifies minimum version
	// required to use Universe resource via YBA CLI
	YBAAllowUniverseMinVersion = "2.17.1.0-b371"

	// YBAAllowBackupMinVersion specifies minimum version
	// required to use Scheduled Backup resource via YBA CLI
	YBAAllowBackupMinVersion = "2.18.1.0-b20"

	// YBAAllowEditProviderMinVersion specifies minimum version
	// required to Edit a Provider (onprem or cloud) resource
	// via YBA CLI
	YBAAllowNewProviderMinVersion = "2.18.0.0-b65"

	// YBAAllowFailureSubTaskListMinVersion specifies minimum version
	// required to fetch failed subtask message from YugabyteDB Anywhere
	YBAAllowFailureSubTaskListMinVersion = "2.19.0.0-b68"

	// YBAAllowNewReleaseMinStableVersion specifies minimum version
	// required to use New Release via YBA CLI
	YBAAllowNewReleaseMinStableVersion = "2024.2.0.0-b1"

	// YBAAllowNewReleaseMinPreviewVersion specifies minimum version
	// required to use New Release via YBA CLI
	YBAAllowNewReleaseMinPreviewVersion = "2.23.1.0-b27"

	MinCLIStableVersion  = "2024.1.0.0-b4"
	MinCLIPreviewVersion = "2.21.0.0-b545"
)

Minimum YugabyteDB Anywhere versions to support operation

View Source 
const (
	// ReadyUniverseState state
	ReadyUniverseState = "Ready"
	// PausedUniverseState state
	PausedUniverseState = "Paused"
	// PendingUniverseState state
	PendingUniverseState = "Pending"
	// WarningUniverseState state
	WarningUniverseState = "Warning"
	// BadUniverseState state
	BadUniverseState = "Error"
	// UnknownUniverseState state
	UnknownUniverseState = "Loading"
)

UniverseStates

View Source 
const (
	// ReadyProviderState state
	ReadyProviderState = "READY"
	// UpdatingProviderState state
	UpdatingProviderState = "UPDATING"
	// ErrorroviderState state
	ErrorProviderState = "ERROR"
	// DeletingProviderState state
	DeletingProviderState = "DELETING"
)

ProviderStates

View Source 
const (
	// InProgressBackupState state
	InProgressBackupState = "InProgress"
	// CompletedBackupState state
	CompletedBackupState = "Completed"
	// FailedBackupState state
	FailedBackupState = "Failed"
	// SkippedBackupState state
	SkippedBackupState = "Skipped"
	// FailedToDeleteBackupState state
	FailedToDeleteBackupState = "FailedToDelete"
	// StoppingBackupState state
	StoppingBackupState = "Stopping"
	// StoppedBackupState state
	StoppedBackupState = "Stopped"
	// QueuedForDeletionBackupState state
	QueuedForDeletionBackupState = "QueuedForDeletion"
	// QueuedForForcedDeletionBackupState state
	QueuedForForcedDeletionBackupState = "QueuedForForcedDeletion"
	// DeleteInProgressBackupState state
	DeleteInProgressBackupState = "DeleteInProgress"
)

BackupStates

View Source 
const (
	// DeletingScheduleBackupState state
	DeletingScheduleBackupState = "Deleting"
	// ErrorScheduleBackupState state
	ErrorScheduleBackupState = "Error"
	// ActiveScheduleBackupState state
	ActiveScheduleBackupState = "Active"
	// CreatingScheduleBackupState state
	CreatingScheduleBackupState = "Creating"
	// PausedScheduleBackupState state
	PausedScheduleBackupState = "Paused"
	// StoppedScheduleBackupState state
	StoppedScheduleBackupState = "Stopped"
	// EditingScheduleBackupState state
	EditingScheduleBackupState = "Editing"
)

ScheduleBackupStates

View Source 
const (
	// WaitingReleaseResponseState state
	WaitingReleaseResponseState = "waiting"
	// RunningReleaseResponseState state
	RunningReleaseResponseState = "running"
	// SuccessReleaseResponseState state
	SuccessReleaseResponseState = "success"
	// FailureReleaseResponseState state
	FailureReleaseResponseState = "failure"
)

ReleaseResponseStates

View Source 
const (
	// InProgressRestoreState state
	InProgressRestoreState = "InProgress"
	// CompletedRestoreState state
	CompletedRestoreState = "Completed"
	// FailedRestoreState state
	FailedRestoreState = "Failed"
	// AbortedRestoreState state
	AbortedRestoreState = "Aborted"
	// CreatedRestoreState state
	CreatedRestoreState = "Created"
)

RestoreStates

View Source 
const (
	// CreateTaskStatus task status
	CreatedTaskStatus = "Created"
	// InitializingTaskStatus task status
	InitializingTaskStatus = "Initializing"
	// RunningTaskStatus task status
	RunningTaskStatus = "Running"
	// SuccessTaskStatus task status
	SuccessTaskStatus = "Success"
	// FailureTaskStatus task status
	FailureTaskStatus = "Failure"
	// UnknownTaskStatus task status
	UnknownTaskStatus = "Unknown"
	// AbortTaskStatus task status
	AbortTaskStatus = "Abort"
	// AbortedTaskStatus task status
	AbortedTaskStatus = "Aborted"
)

Allowed states for YugabyteDB Anywhere Tasks

View Source 
const (
	// AddNode operation
	AddNode = "ADD"
	// StartNode operation
	StartNode = "START"
	// RebootNode operation
	RebootNode = "REBOOT"
	// StopNode operation
	StopNode = "STOP"
	// RemoveNode operation
	RemoveNode = "REMOVE"
	// ReprovisionNode operation
	ReprovisionNode = "REPROVISION"
	// ReleaseNode operation
	ReleaseNode = "RELEASE"
)

Node operations allowed on universe

View Source 
const (
	// MasterServerType for master processes
	MasterServerType = "MASTER"
	// TserverServerType for tserver processes
	TserverServerType = "TSERVER"
	// ControllerServerType for YBC processes
	ControllerServerType = "CONTROLLER"
)

Server Type values

View Source 
const (
	// UpgradeOperation type
	UpgradeOperation = "Upgrade"
	// EditOperation type
	EditOperation = "Edit"
	// SecurityOperation type
	SecurityOperation = "Security"
)

Operation Type

View Source 
const (
	// UniverseType resource
	UniverseType = "universe"
	// ProviderType resource
	ProviderType = "provider"
	// StorageConfigurationType resource
	StorageConfigurationType = "storage configuration"
)

Different resource types that are supported in CLI

View Source 
const (
	// util.AWSProviderType type
	AWSProviderType = "aws"
	// AzureProviderType type
	AzureProviderType = "azu"
	// GCPProviderType type
	GCPProviderType = "gcp"
	// K8sProviderType type
	K8sProviderType = "kubernetes"
	// OnpremProviderType type
	OnpremProviderType = "onprem"
)

Different cloud provider types

View Source 
const (
	// util.AWSEARType type
	AWSEARType = "AWS"
	// AzureEARType type
	AzureEARType = "AZU"
	// GCPEARType type
	GCPEARType = "GCP"
	// HashicorpVaultEARType type
	HashicorpVaultEARType = "HASHICORP"
)

Different kms types

View Source 
const (
	// S3StorageConfigType type
	S3StorageConfigType = "S3"
	// AzureStorageConfigType type
	AzureStorageConfigType = "AZ"
	// GCSStorageConfigType type
	GCSStorageConfigType = "GCS"
	// NFSStorageConfigType type
	NFSStorageConfigType = "NFS"
)

Different storage configuration types

View Source 
const (
	// PrimaryClusterType for primary cluster
	PrimaryClusterType = "PRIMARY"
	// ReadReplicaClusterType for rrs
	ReadReplicaClusterType = "ASYNC"
)

ClusterTypes for universe

View Source 
const (
	// PgSqlTableType table type
	PgSqlTableType = "PGSQL_TABLE_TYPE"

	// YqlTableType table type
	YqlTableType = "YQL_TABLE_TYPE"

	// RedisTableType table type
	RedisTableType = "REDIS_TABLE_TYPE"
)
View Source 
const (
	// X86_64 architecture
	X86_64 = "x86_64"

	// AARCH64 architecture
	AARCH64 = "aarch64"
)
View Source 
const (
	// SelfSignedCertificateType type
	SelfSignedCertificateType = "SelfSigned"
	// HashicorpVaultCertificateType type
	HashicorpVaultCertificateType = "HashicorpVault"
	// K8sCertManagerCertificateType type
	K8sCertManagerCertificateType = "K8SCertManager"
	// CustomCertHostPathCertificateType type
	CustomCertHostPathCertificateType = "CustomCertHostPath"
	// CustomServerCertCertificateType type
	CustomServerCertCertificateType = "CustomServerCert"
)

Certificate Types

View Source 
const (
	// EnableKMSOpType type
	EnableKMSOpType = "ENABLE"
	// DisableKMSOpType type
	DisableKMSOpType = "DISABLE"
	// RotateKMSConfigKMSOpType type
	RotateKMSConfigKMSOpType = "ROTATE-KMS-CONFIG"
	// RotateUniverseKeyKMSOpType type
	RotateUniverseKeyKMSOpType = "ROTATE-UNIVERSE-KEY"
)

KMSOpType

View Source 
const (
	// UniverseResourceType type
	UniverseResourceType = "UNIVERSE"
	// RoleResourceType type
	RoleResourceType = "ROLE"
	// UserResourceType type
	UserResourceType = "USER"
	// OtherResourceType type
	OtherResourceType = "OTHER"
)

ResourceType

View Source 
const (
	// SystemRoleType type
	SystemRoleType = "System"
	// CustomRoleType type
	CustomRoleType = "Custom"
)

RoleType

View Source 
const (
	// ExposedServiceState type
	ExposedServiceState = "EXPOSED"
	// UnexposedServiceState type
	UnexposedServiceState = "UNEXPOSED"
	// NoneServiceState type
	NoneServiceState = "NONE"
)

ExposingServiceState

View Source 
const (
	// Separator variable for strings that are in key value format
	Separator = "::"

	// KeyValueSeparator variable for strings that are in key value format
	KeyValueSeparator = "="
)
View Source 
const (
	// StorageCustomerConfigType field name to denote in request bodies
	StorageCustomerConfigType = "STORAGE"
)

Variables

This section is empty.

Functions

func AWSRegionFromEnv 

func AWSRegionFromEnv() (string, error)

AWSRegionFromEnv retrives value of "AWS_REGION" from env variables

func AddCommandIfFeatureFlag 

func AddCommandIfFeatureFlag(rootCmd *cobra.Command, cmd *cobra.Command, featureFlag FeatureFlag)

AddCommandIfFeatureFlag adds the command to root if feature flag is enabled

func AwsCredentialsFromEnv 

func AwsCredentialsFromEnv() (awsCreds.Value, error)

AwsCredentialsFromEnv retrives values of "AWS_ACCESS_KEY_ID" and "AWS_SECRET_ACCESS_KEY" from env variables

func AwsInstanceTypesWithEphemeralStorageOnly 

func AwsInstanceTypesWithEphemeralStorageOnly(instanceType string) bool

AwsInstanceTypesWithEphemeralStorageOnly returns true if the instance type has only ephemeral storage

func AzureCheckKeySizeForAlgo 

func AzureCheckKeySizeForAlgo(keySize int, algo string) bool

AzureCheckKeySizeForAlgo check key size for algorithm

func AzureClientIDFromEnv 

func AzureClientIDFromEnv() (string, bool, error)

AzureClientIDFromEnv retrives value of "AZURE_CLIENT_ID" from env variables

func AzureClientSecretFromEnv 

func AzureClientSecretFromEnv() (string, bool, error)

AzureClientSecretFromEnv retrives value of "AZURE_CLIENT_SECRET" from env variables

func AzureGetDefaultKeySizeForAlgo 

func AzureGetDefaultKeySizeForAlgo(algo string) int

AzureGetDefaultKeySizeForAlgo get key size for algorithm

func AzureStorageCredentialsFromEnv 

func AzureStorageCredentialsFromEnv() (string, error)

AzureStorageCredentialsFromEnv retrives value of "AZURE_STORAGE_SAS_TOKEN" from env variables

func AzureTenantIDFromEnv 

func AzureTenantIDFromEnv() (string, bool, error)

AzureTenantIDFromEnv retrives value of "AZURE_TENANT_ID" from env variables

func CompareYbVersions 

func CompareYbVersions(v1 string, v2 string) (int, error)

CompareYbVersions returns -1 if version1 < version2, 0 if version1 = version2, 1 if version1 > version2

func CompletedReleaseReponseStates 

func CompletedReleaseReponseStates() []string

CompletedReleaseReponseStates returns set of states that mark the response as completed

func CompletedTaskStates 

func CompletedTaskStates() []string

CompletedTaskStates returns set of states that mark the task as completed

func ConfirmCommand 

func ConfirmCommand(message string, bypass bool) error

ConfirmCommand function will add an interactive comfirmation with the message provided

func ConvertMsToUnit 

func ConvertMsToUnit(value int64, unit string) float64

ConvertMsToUnit converts time from milliseconds to unit

func CreateSingletonList 

func CreateSingletonList(in interface{}) []interface{}

CreateSingletonList returns a list of single entry from an interface

func ErrorFromHTTPResponse 

func ErrorFromHTTPResponse(resp *http.Response, apiError error, entityName,
	operation string) error

ErrorFromHTTPResponse extracts the error message from the HTTP response of the API

func ErrorFromResponseBody 

func ErrorFromResponseBody(errorBlock YbaStructuredError) string

ErrorFromResponseBody is a function to extract error interfaces into string

func ErrorReleaseResponseStates 

func ErrorReleaseResponseStates() []string

ErrorReleaseResponseStates return set of states that mark state as failure

func ErrorTaskStates 

func ErrorTaskStates() []string

ErrorTaskStates return set of states that mark state as failure

func Float64Slice 

func Float64Slice(in []interface{}) *[]float64

Float64Slice accepts array of interface and returns a pointer to slice of float64

func FromEpochMilli 

func FromEpochMilli(millis int64) time.Time

FromEpochMilli converts epoch in milliseconds to time.Time

func GcpGetCredentialsAsMap 

func GcpGetCredentialsAsMap() (map[string]interface{}, error)

GcpGetCredentialsAsMap returns the GCE JSON file contents as a map

func GcpGetCredentialsAsMapFromFilePath 

func GcpGetCredentialsAsMapFromFilePath(filePath string) (map[string]interface{}, error)

GcpGetCredentialsAsMapFromFilePath returns the GCE JSON file contents as a map from the file path

func GcpGetCredentialsAsString 

func GcpGetCredentialsAsString() (string, error)

GcpGetCredentialsAsString returns the GCE JSON file contents as a string

func GcpGetCredentialsAsStringFromFilePath 

func GcpGetCredentialsAsStringFromFilePath(filePath string) (string, error)

GcpGetCredentialsAsStringFromFilePath returns the GCE JSON file contents as a string

func GetArrayPointer 

func GetArrayPointer(in []interface{}) *[]interface{}

GetArrayPointer returns the pointer to a string array

func GetBoolPointer 

func GetBoolPointer(in bool) *bool

GetBoolPointer returns a pointer to bool value

func GetFloat64Pointer 

func GetFloat64Pointer(in float64) *float64

GetFloat64Pointer returns a pointer to float64 type

func GetFloat64SliceFromString 

func GetFloat64SliceFromString(in string) ([]float64, error)

GetFloat64SliceFromString returns a slice of float64 from a string

func GetInt32Pointer 

func GetInt32Pointer(in int32) *int32

GetInt32Pointer returns a pointer to int32 value

func GetInt64Pointer 

func GetInt64Pointer(in int64) *int64

GetInt64Pointer returns a pointer to int64 value

func GetMsFromDurationString 

func GetMsFromDurationString(duration string) (int64, string, bool, error)

GetMsFromDurationString retrieves the ms notation of the duration mentioned in the input string return value string holds the unit calculated from time.Duration Throws error on improper duration format

func GetStringPointer 

func GetStringPointer(in string) *string

GetStringPointer returns a pointer to string value

func GetUnitOfTimeFromDuration 

func GetUnitOfTimeFromDuration(duration time.Duration) string

GetUnitOfTimeFromDuration takes time.Duration as input and caluclates the unit specified in that duration

func HashicorpVaultAddressFromEnv 

func HashicorpVaultAddressFromEnv() (string, error)

HashicorpVaultAddressFromEnv retrives value of "HASHICORP_VAULT_ADDR" from env variables

func HashicorpVaultTokenFromEnv 

func HashicorpVaultTokenFromEnv() (string, error)

HashicorpVaultTokenFromEnv retrives value of "HASHICORP_VAULT_TOKEN" from env variables

func IncompleteReleaseResponseStates 

func IncompleteReleaseResponseStates() []string

IncompleteReleaseResponseStates return set of states for ongoing tasks

func IncompleteTaskStates 

func IncompleteTaskStates() []string

IncompleteTaskStates return set of states for ongoing tasks

func IsCloudBasedProvider 

func IsCloudBasedProvider(providerType string) bool

IsCloudBasedProvider returns true if the provider is AWS, Azure or GCP

func IsFeatureFlagEnabled 

func IsFeatureFlagEnabled(featureFlag FeatureFlag) bool

IsFeatureFlagEnabled checks if feature flag is set in the env variable

func IsOutputType 

func IsOutputType(t string) bool

IsOutputType check if the output type is t

func IsVersionStable 

func IsVersionStable(version string) bool

IsVersionStable returns true if the version string is stable A stable version is a version with an even minor number or a version with a 4 digit major version

func IsYBVersion 

func IsYBVersion(v string) (bool, error)

IsYBVersion checks if the given string is a valid YB version string

func MapFromSingletonList 

func MapFromSingletonList(in []interface{}) map[string]interface{}

MapFromSingletonList returns a map of string -> interface from a slice of interface

func MapListFromInterfaceList 

func MapListFromInterfaceList(in []interface{}) []map[string]interface{}

MapListFromInterfaceList returns a map of string -> interface from a slice of interface

func ReadFileToString 

func ReadFileToString(filePath string) (*string, error)

ReadFileToString retrieves file content from given file path

func RemoveComponentFromSlice 

func RemoveComponentFromSlice(sliceInterface interface{}, index int) interface{}

RemoveComponentFromSlice removes the component from the slice

func StringMap 

func StringMap(in map[string]interface{}) *map[string]string

StringMap accepts a string -> interface map and returns pointer to string -> string map

func StringSlice 

func StringSlice(in []interface{}) *[]string

StringSlice accepts array of interface and returns a pointer to slice of string

func StringSliceFromString 

func StringSliceFromString(in []string) *[]string

StringSliceFromString accepts slice of string and returns a pointer to slice of string

func StringtoStringMap 

func StringtoStringMap(in map[string]string) *map[string]string

StringtoStringMap accepts a string -> string map and returns pointer to string -> string map

func ValidExposingServiceStates 

func ValidExposingServiceStates() []string

ValidExposingServiceStates returns set of valid exposing service states

func YAMLtoString 

func YAMLtoString(filePath string) string

YAMLtoString reads yaml file and converts the data into a string

func YBARestrictBackupVersions 

func YBARestrictBackupVersions() []string

YBARestrictBackupVersions are certain YugabyteDB Anywhere versions >= min version for backups that would not support the operation

func YBARestrictFailedSubtasksVersions 

func YBARestrictFailedSubtasksVersions() []string

YBARestrictFailedSubtasksVersions are certain YugabyteDB Anywhere versions >= min version for of fetching failed subtask lists that would not support the operation

Types

type AwsKmsAuthConfigField 

type AwsKmsAuthConfigField struct {
	AccessKeyID     string `json:"AWS_ACCESS_KEY_ID"`
	SecretAccessKey string `json:"AWS_SECRET_ACCESS_KEY"`
	EndPoint        string `json:"AWS_KMS_ENDPOINT"`
	Region          string `json:"AWS_REGION"`
	CMKPolicy       string `json:"cmk_policy"`
	CMKID           string `json:"cmk_id"`
}

AwsKmsAuthConfigField is a struct to hold values retrieved by parsing the AWS KMS config map

type AzuKmsAuthConfigField 

type AzuKmsAuthConfigField struct {
	ClientID        string `json:"CLIENT_ID"`
	ClientSecret    string `json:"CLIENT_SECRET"`
	TenantID        string `json:"TENANT_ID"`
	AzuVaultURL     string `json:"AZU_VAULT_URL"`
	AzuKeyName      string `json:"AZU_KEY_NAME"`
	AzuKeyAlgorithm string `json:"AZU_KEY_ALGORITHM"`
	AzuKeySize      int    `json:"AZU_KEY_SIZE"`
}

AzuKmsAuthConfigField is a struct to hold values retrieved by parsing the Azure KMS config map

type AzureAlgorithm 

type AzureAlgorithm struct {
	KeyType        string
	KeySize        []int
	DefaultKeySize int
}

AzureAlgorithm type

type AzureCredentials 

type AzureCredentials struct {
	TenantID       string `json:"tenant_id"`
	SubscriptionID string `json:"subscription_id"`
	ClientSecret   string `json:"client_secret"`
	ClientID       string `json:"client_id"`
	ResourceGroup  string `json:"resource_group"`
}

AzureCredentials required for cloud provider

func AzureCredentialsFromEnv 

func AzureCredentialsFromEnv() (AzureCredentials, error)

AzureCredentialsFromEnv retrives azure credentials from env variables

type CustomTime 

type CustomTime struct {
	time.Time
}

CustomTime struct for marshaling/unmarshaling time.Time

func (*CustomTime) UnmarshalJSON 

func (ct *CustomTime) UnmarshalJSON(b []byte) error

UnmarshalJSON implements the Unmarshaler interface.

type FeatureFlag 

type FeatureFlag string

FeatureFlag string holds the defined feature flags that can be set 

const (
	// TOOLS is a feature flag enabling doc generation
	TOOLS FeatureFlag = "TOOLS"

	// PREVIEW is a feature flag enabling preview features
	PREVIEW FeatureFlag = "PREVIEW"
)

func (FeatureFlag) String 

func (f FeatureFlag) String() string

type GCPCredentials 

type GCPCredentials struct {
	AuthProviderX509CertURL string `json:"auth_provider_x509_cert_url,omitempty"`
	AuthURI                 string `json:"auth_uri,omitempty"`
	ClientEmail             string `json:"client_email"`
	ClientID                string `json:"client_id"`
	ClientX509CertURL       string `json:"client_x509_cert_url"`
	PrivateKey              string `json:"private_key"`
	PrivateKeyID            string `json:"private_key_id"`
	ProjectID               string `json:"project_id"`
	TokenURI                string `json:"token_uri,omitempty"`
	Type                    string `json:"type"`
}

GCPCredentials is a struct to hold values retrieved by parsing the GCE credentials json file

type GcpKmsAuthConfigField 

type GcpKmsAuthConfigField struct {
	GCPConfig       map[string]interface{} `json:"GCP_CONFIG"`
	LocationID      string                 `json:"LOCATION_ID"`
	ProtectionLevel string                 `json:"PROTECTION_LEVEL"`
	GcpKmsEndpoint  string                 `json:"GCP_KMS_ENDPOINT"`
	KeyRingID       string                 `json:"KEY_RING_ID"`
	CryptoKeyID     string                 `json:"CRYPTO_KEY_ID"`
}

GcpKmsAuthConfigField is a struct to hold values retrieved by parsing the GCP KMS config map

type HashicorpCredentials 

type HashicorpCredentials struct {
	Token     string `json:"HC_VAULT_TOKEN"`
	Address   string `json:"HC_VAULT_ADDRESS"`
	Namespace string `json:"HC_VAULT_AUTH_NAMESPACE"`
}

HashicorpCredentials required for kms configs

type HcVaultAuthConfigField 

type HcVaultAuthConfigField struct {
	HcVaultToken     string `json:"HC_VAULT_TOKEN"`
	HcVaultAddress   string `json:"HC_VAULT_ADDRESS"`
	HcVaultEngine    string `json:"HC_VAULT_ENGINE"`
	HcVaultMountPath string `json:"HC_VAULT_MOUNT_PATH"`
	HcVaultKeyName   string `json:"HC_VAULT_KEY_NAME"`

	HcVaultRoleID        string `json:"HC_VAULT_ROLE_ID"`
	HcVaultSecretID      string `json:"HC_VAULT_SECRET_ID"`
	HcVaultAuthNamespace string `json:"HC_VAULT_AUTH_NAMESPACE"`

	HcVaultPkiRole string `json:"HC_VAULT_PKI_ROLE"`

	HcVaultTTL       int64 `json:"HC_VAULT_TTL"`
	HcVaultTTLExpiry int64 `json:"HC_VAULT_TTL_EXPIRY"`
}

HcVaultAuthConfigField is a struct to hold values related to Hashicorp Vault configuration.

type KMSConfig 

type KMSConfig struct {
	ConfigUUID   string                  `json:"config_uuid"`
	Name         string                  `json:"name"`
	CustomerUUID string                  `json:"customer_uuid,omitempty"`
	KeyProvider  string                  `json:"provider"`
	InUse        bool                    `json:"in_use"`
	Version      int                     `json:"version,omitempty"`
	AWS          *AwsKmsAuthConfigField  `json:"aws,omitempty"`
	GCP          *GcpKmsAuthConfigField  `json:"gcp,omitempty"`
	Azure        *AzuKmsAuthConfigField  `json:"azure,omitempty"`
	Hashicorp    *HcVaultAuthConfigField `json:"hashicorp,omitempty"`
}

KMSConfig is a struct to hold values retrieved by parsing the KMS config map

func ConvertToKMSConfig 

func ConvertToKMSConfig(r map[string]interface{}) (KMSConfig, error)

ConvertToKMSConfig converts the kms config map to KMSConfig struct

type KuberenetesMetadata 

type KuberenetesMetadata struct {
	Name string `yaml:"name"`
}

KuberenetesMetadata to extract image pull secret name

type KubernetesPullSecretYAML 

type KubernetesPullSecretYAML struct {
	Metadata *KuberenetesMetadata `yaml:"metadata"`
}

KubernetesPullSecretYAML to extract image pull secret name

type NullableSchedule 

type NullableSchedule struct {
	// contains filtered or unexported fields
}

NullableSchedule handles when a null is used for Schedule

func NewNullableSchedule 

func NewNullableSchedule(val *Schedule) *NullableSchedule

NewNullableSchedule handles when a null is used for Schedule

func (NullableSchedule) Get 

func (v NullableSchedule) Get() *Schedule

Get handles when a null is used for Schedule

func (NullableSchedule) IsSet 

func (v NullableSchedule) IsSet() bool

IsSet returns true if the Schedule property is set

func (NullableSchedule) MarshalJSON 

func (v NullableSchedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*NullableSchedule) Set 

func (v *NullableSchedule) Set(val *Schedule)

Set handles when a null is used for Schedule

func (*NullableSchedule) UnmarshalJSON 

func (v *NullableSchedule) UnmarshalJSON(src []byte) error

UnmarshalJSON implements the Unmarshaler interface.

func (*NullableSchedule) Unset 

func (v *NullableSchedule) Unset()

Unset removes the Schedule property

type NullableSchedulePagedResponse 

type NullableSchedulePagedResponse struct {
	// contains filtered or unexported fields
}

NullableSchedulePagedResponse handles when a null is used

func NewNullableSchedulePagedResponse 

func NewNullableSchedulePagedResponse(val *SchedulePagedResponse) *NullableSchedulePagedResponse

NewNullableSchedulePagedResponse returns a pointer to a new instance of NullableSchedulePagedResponse

func (NullableSchedulePagedResponse) Get 

func (v NullableSchedulePagedResponse) Get() *SchedulePagedResponse

Get returns the value if set, or zero value otherwise

func (NullableSchedulePagedResponse) IsSet 

func (v NullableSchedulePagedResponse) IsSet() bool

IsSet returns true if Set has been called

func (NullableSchedulePagedResponse) MarshalJSON 

func (v NullableSchedulePagedResponse) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON representation for the model.

func (*NullableSchedulePagedResponse) Set 

func (v *NullableSchedulePagedResponse) Set(val *SchedulePagedResponse)

Set modifies the value

func (*NullableSchedulePagedResponse) UnmarshalJSON 

func (v *NullableSchedulePagedResponse) UnmarshalJSON(src []byte) error

UnmarshalJSON implements the Unmarshaler interface.

func (*NullableSchedulePagedResponse) Unset 

func (v *NullableSchedulePagedResponse) Unset()

Unset removes the value

type PerProcessFlags 

type PerProcessFlags map[string]map[string]string

PerProcessFlags represents the gflags per process

type Schedule 

type Schedule struct {
	// Backlog status of schedule arose due to conflicts
	BacklogStatus    *bool                      `json:"backlogStatus,omitempty"`
	CommonBackupInfo ybaclient.CommonBackupInfo `json:"backupInfo"`
	// Cron expression for the schedule
	CronExpression *string `json:"cronExpression,omitempty"`
	// Number of failed backup attempts
	FailureCount *int32 `json:"failureCount,omitempty"`
	// Frequency of the schedule, in milli seconds
	Frequency *int64 `json:"frequency,omitempty"`
	// Time unit of frequency
	FrequencyTimeUnit *string `json:"frequencyTimeUnit,omitempty"`
	// Backlog status of schedule of incremental backups arose due to conflicts
	IncrementBacklogStatus *bool `json:"incrementBacklogStatus,omitempty"`
	// Time on which schedule is expected to run for incremental backups
	NextIncrementScheduleTaskTime *CustomTime `json:"nextIncrementScheduleTaskTime,omitempty"`
	// Time on which schedule is expected to run
	NextScheduleTaskTime *CustomTime `json:"nextExpectedTask,omitempty"`
	// Owner UUID for the schedule
	OwnerUUID *string `json:"ownerUUID,omitempty"`
	// Running state of the schedule
	RunningState *bool `json:"runningState,omitempty"`
	// Name of the schedule
	ScheduleName *string `json:"scheduleName,omitempty"`
	// Schedule UUID
	ScheduleUUID *string `json:"scheduleUUID,omitempty"`
	// Status of the task. Possible values are _Active_, _Paused_, or _Stopped_.
	Status *string `json:"status,omitempty"`
	// Type of task to be scheduled.
	TaskType *string `json:"taskType,omitempty"`
	// Whether to use local timezone with cron expression for the schedule
	UseLocalTimezone *bool `json:"useLocalTimezone,omitempty"`
	// User who created the schedule policy
	UserEmail *string `json:"userEmail,omitempty"`
}

Schedule type

func (*Schedule) GetBacklogStatus 

func (o *Schedule) GetBacklogStatus() bool

GetBacklogStatus returns the BacklogStatus field value if set, zero value otherwise.

func (*Schedule) GetBacklogStatusOk 

func (o *Schedule) GetBacklogStatusOk() (*bool, bool)

GetBacklogStatusOk returns a tuple with the BacklogStatus field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetCommonBackupInfo 

func (o *Schedule) GetCommonBackupInfo() ybaclient.CommonBackupInfo

GetCommonBackupInfo returns the CommonBackupInfo field value

func (*Schedule) GetCommonBackupInfoOk 

func (o *Schedule) GetCommonBackupInfoOk() (*ybaclient.CommonBackupInfo, bool)

GetCommonBackupInfoOk returns a tuple with the CommonBackupInfo field value and a boolean to check if the value has been set.

func (*Schedule) GetCronExpression 

func (o *Schedule) GetCronExpression() string

GetCronExpression returns the CronExpression field value if set, zero value otherwise.

func (*Schedule) GetCronExpressionOk 

func (o *Schedule) GetCronExpressionOk() (*string, bool)

GetCronExpressionOk returns a tuple with the CronExpression field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetFailureCount 

func (o *Schedule) GetFailureCount() int32

GetFailureCount returns the FailureCount field value if set, zero value otherwise.

func (*Schedule) GetFailureCountOk 

func (o *Schedule) GetFailureCountOk() (*int32, bool)

GetFailureCountOk returns a tuple with the FailureCount field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetFrequency 

func (o *Schedule) GetFrequency() int64

GetFrequency returns the Frequency field value if set, zero value otherwise.

func (*Schedule) GetFrequencyOk 

func (o *Schedule) GetFrequencyOk() (*int64, bool)

GetFrequencyOk returns a tuple with the Frequency field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetFrequencyTimeUnit 

func (o *Schedule) GetFrequencyTimeUnit() string

GetFrequencyTimeUnit returns the FrequencyTimeUnit field value if set, zero value otherwise.

func (*Schedule) GetFrequencyTimeUnitOk 

func (o *Schedule) GetFrequencyTimeUnitOk() (*string, bool)

GetFrequencyTimeUnitOk returns a tuple with the FrequencyTimeUnit field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetIncrementBacklogStatus 

func (o *Schedule) GetIncrementBacklogStatus() bool

GetIncrementBacklogStatus returns the IncrementBacklogStatus field value if set, zero value otherwise.

func (*Schedule) GetIncrementBacklogStatusOk 

func (o *Schedule) GetIncrementBacklogStatusOk() (*bool, bool)

GetIncrementBacklogStatusOk returns a tuple with the IncrementBacklogStatus field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetNextIncrementScheduleTaskTime 

func (o *Schedule) GetNextIncrementScheduleTaskTime() *CustomTime

GetNextIncrementScheduleTaskTime returns the NextIncrementScheduleTaskTime field value if set, zero value otherwise.

func (*Schedule) GetNextIncrementScheduleTaskTimeOk 

func (o *Schedule) GetNextIncrementScheduleTaskTimeOk() (*CustomTime, bool)

GetNextIncrementScheduleTaskTimeOk returns a tuple with the NextIncrementScheduleTaskTime field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetNextScheduleTaskTime 

func (o *Schedule) GetNextScheduleTaskTime() CustomTime

GetNextScheduleTaskTime returns the NextScheduleTaskTime field value if set, zero value otherwise.

func (*Schedule) GetNextScheduleTaskTimeOk 

func (o *Schedule) GetNextScheduleTaskTimeOk() (*CustomTime, bool)

GetNextScheduleTaskTimeOk returns a tuple with the NextScheduleTaskTime field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetOwnerUUID 

func (o *Schedule) GetOwnerUUID() string

GetOwnerUUID returns the OwnerUUID field value if set, zero value otherwise.

func (*Schedule) GetOwnerUUIDOk 

func (o *Schedule) GetOwnerUUIDOk() (*string, bool)

GetOwnerUUIDOk returns a tuple with the OwnerUUID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetRunningState 

func (o *Schedule) GetRunningState() bool

GetRunningState returns the RunningState field value if set, zero value otherwise.

func (*Schedule) GetRunningStateOk 

func (o *Schedule) GetRunningStateOk() (*bool, bool)

GetRunningStateOk returns a tuple with the RunningState field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetScheduleName 

func (o *Schedule) GetScheduleName() string

GetScheduleName returns the ScheduleName field value if set, zero value otherwise.

func (*Schedule) GetScheduleNameOk 

func (o *Schedule) GetScheduleNameOk() (*string, bool)

GetScheduleNameOk returns a tuple with the ScheduleName field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetScheduleUUID 

func (o *Schedule) GetScheduleUUID() string

GetScheduleUUID returns the ScheduleUUID field value if set, zero value otherwise.

func (*Schedule) GetScheduleUUIDOk 

func (o *Schedule) GetScheduleUUIDOk() (*string, bool)

GetScheduleUUIDOk returns a tuple with the ScheduleUUID field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetStatus 

func (o *Schedule) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*Schedule) GetStatusOk 

func (o *Schedule) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetTaskType 

func (o *Schedule) GetTaskType() string

GetTaskType returns the TaskType field value if set, zero value otherwise.

func (*Schedule) GetTaskTypeOk 

func (o *Schedule) GetTaskTypeOk() (*string, bool)

GetTaskTypeOk returns a tuple with the TaskType field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetUseLocalTimezone 

func (o *Schedule) GetUseLocalTimezone() bool

GetUseLocalTimezone returns the UseLocalTimezone field value if set, zero value otherwise.

func (*Schedule) GetUseLocalTimezoneOk 

func (o *Schedule) GetUseLocalTimezoneOk() (*bool, bool)

GetUseLocalTimezoneOk returns a tuple with the UseLocalTimezone field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) GetUserEmail 

func (o *Schedule) GetUserEmail() string

GetUserEmail returns the UserEmail field value if set, zero value otherwise.

func (*Schedule) GetUserEmailOk 

func (o *Schedule) GetUserEmailOk() (*string, bool)

GetUserEmailOk returns a tuple with the UserEmail field value if set, nil otherwise and a boolean to check if the value has been set.

func (*Schedule) HasBacklogStatus 

func (o *Schedule) HasBacklogStatus() bool

HasBacklogStatus returns a boolean if a field has been set.

func (*Schedule) HasCronExpression 

func (o *Schedule) HasCronExpression() bool

HasCronExpression returns a boolean if a field has been set.

func (*Schedule) HasFailureCount 

func (o *Schedule) HasFailureCount() bool

HasFailureCount returns a boolean if a field has been set.

func (*Schedule) HasFrequency 

func (o *Schedule) HasFrequency() bool

HasFrequency returns a boolean if a field has been set.

func (*Schedule) HasFrequencyTimeUnit 

func (o *Schedule) HasFrequencyTimeUnit() bool

HasFrequencyTimeUnit returns a boolean if a field has been set.

func (*Schedule) HasIncrementBacklogStatus 

func (o *Schedule) HasIncrementBacklogStatus() bool

HasIncrementBacklogStatus returns a boolean if a field has been set.

func (*Schedule) HasNextIncrementScheduleTaskTime 

func (o *Schedule) HasNextIncrementScheduleTaskTime() bool

HasNextIncrementScheduleTaskTime returns a boolean if a field has been set.

func (*Schedule) HasNextScheduleTaskTime 

func (o *Schedule) HasNextScheduleTaskTime() bool

HasNextScheduleTaskTime returns a boolean if a field has been set.

func (*Schedule) HasOwnerUUID 

func (o *Schedule) HasOwnerUUID() bool

HasOwnerUUID returns a boolean if a field has been set.

func (*Schedule) HasRunningState 

func (o *Schedule) HasRunningState() bool

HasRunningState returns a boolean if a field has been set.

func (*Schedule) HasScheduleName 

func (o *Schedule) HasScheduleName() bool

HasScheduleName returns a boolean if a field has been set.

func (*Schedule) HasScheduleUUID 

func (o *Schedule) HasScheduleUUID() bool

HasScheduleUUID returns a boolean if a field has been set.

func (*Schedule) HasStatus 

func (o *Schedule) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*Schedule) HasTaskType 

func (o *Schedule) HasTaskType() bool

HasTaskType returns a boolean if a field has been set.

func (*Schedule) HasUseLocalTimezone 

func (o *Schedule) HasUseLocalTimezone() bool

HasUseLocalTimezone returns a boolean if a field has been set.

func (*Schedule) HasUserEmail 

func (o *Schedule) HasUserEmail() bool

HasUserEmail returns a boolean if a field has been set.

func (Schedule) MarshalJSON 

func (o Schedule) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface.

func (*Schedule) SetBacklogStatus 

func (o *Schedule) SetBacklogStatus(v bool)

SetBacklogStatus gets a reference to the given bool and assigns it to the BacklogStatus field.

func (*Schedule) SetCommonBackupInfo 

func (o *Schedule) SetCommonBackupInfo(v ybaclient.CommonBackupInfo)

SetCommonBackupInfo sets field value

func (*Schedule) SetCronExpression 

func (o *Schedule) SetCronExpression(v string)

SetCronExpression gets a reference to the given string and assigns it to the CronExpression field.

func (*Schedule) SetFailureCount 

func (o *Schedule) SetFailureCount(v int32)

SetFailureCount gets a reference to the given int32 and assigns it to the FailureCount field.

func (*Schedule) SetFrequency 

func (o *Schedule) SetFrequency(v int64)

SetFrequency gets a reference to the given int64 and assigns it to the Frequency field.

func (*Schedule) SetFrequencyTimeUnit 

func (o *Schedule) SetFrequencyTimeUnit(v string)

SetFrequencyTimeUnit gets a reference to the given string and assigns it to the FrequencyTimeUnit field.

func (*Schedule) SetIncrementBacklogStatus 

func (o *Schedule) SetIncrementBacklogStatus(v bool)

SetIncrementBacklogStatus gets a reference to the given bool and assigns it to the IncrementBacklogStatus field.

func (*Schedule) SetNextIncrementScheduleTaskTime 

func (o *Schedule) SetNextIncrementScheduleTaskTime(v CustomTime)

SetNextIncrementScheduleTaskTime gets a reference to the given time.Time and assigns it to the NextIncrementScheduleTaskTime field.

func (*Schedule) SetNextScheduleTaskTime 

func (o *Schedule) SetNextScheduleTaskTime(v CustomTime)

SetNextScheduleTaskTime gets a reference to the given time.Time and assigns it to the NextScheduleTaskTime field.

func (*Schedule) SetOwnerUUID 

func (o *Schedule) SetOwnerUUID(v string)

SetOwnerUUID gets a reference to the given string and assigns it to the OwnerUUID field.

func (*Schedule) SetRunningState 

func (o *Schedule) SetRunningState(v bool)

SetRunningState gets a reference to the given bool and assigns it to the RunningState field.

func (*Schedule) SetScheduleName 

func (o *Schedule) SetScheduleName(v string)

SetScheduleName gets a reference to the given string and assigns it to the ScheduleName field.

func (*Schedule) SetScheduleUUID 

func (o *Schedule) SetScheduleUUID(v string)

SetScheduleUUID gets a reference to the given string and assigns it to the ScheduleUUID field.

func (*Schedule) SetStatus 

func (o *Schedule) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*Schedule) SetTaskType 

func (o *Schedule) SetTaskType(v string)

SetTaskType gets a reference to the given string and assigns it to the TaskType field.

func (*Schedule) SetUseLocalTimezone 

func (o *Schedule) SetUseLocalTimezone(v bool)

SetUseLocalTimezone gets a reference to the given bool and assigns it to the UseLocalTimezone field.

func (*Schedule) SetUserEmail 

func (o *Schedule) SetUserEmail(v string)

SetUserEmail gets a reference to the given string and assigns it to the UserEmail field.

type SchedulePagedResponse 

type SchedulePagedResponse struct {
	Entities   []Schedule `json:"entities"`
	HasNext    bool       `json:"hasNext"`
	HasPrev    bool       `json:"hasPrev"`
	TotalCount int32      `json:"totalCount"`
}

SchedulePagedResponse type

func (*SchedulePagedResponse) GetEntities 

func (o *SchedulePagedResponse) GetEntities() []Schedule

GetEntities returns the Entities field value

func (*SchedulePagedResponse) GetEntitiesOk 

func (o *SchedulePagedResponse) GetEntitiesOk() (*[]Schedule, bool)

GetEntitiesOk returns a tuple with the Entities field value and a boolean to check if the value has been set.

func (*SchedulePagedResponse) GetHasNext 

func (o *SchedulePagedResponse) GetHasNext() bool

GetHasNext returns the HasNext field value

func (*SchedulePagedResponse) GetHasNextOk 

func (o *SchedulePagedResponse) GetHasNextOk() (*bool, bool)

GetHasNextOk returns a tuple with the HasNext field value and a boolean to check if the value has been set.

func (*SchedulePagedResponse) GetHasPrev 

func (o *SchedulePagedResponse) GetHasPrev() bool

GetHasPrev returns the HasPrev field value

func (*SchedulePagedResponse) GetHasPrevOk 

func (o *SchedulePagedResponse) GetHasPrevOk() (*bool, bool)

GetHasPrevOk returns a tuple with the HasPrev field value and a boolean to check if the value has been set.

func (*SchedulePagedResponse) GetTotalCount 

func (o *SchedulePagedResponse) GetTotalCount() int32

GetTotalCount returns the TotalCount field value

func (*SchedulePagedResponse) GetTotalCountOk 

func (o *SchedulePagedResponse) GetTotalCountOk() (*int32, bool)

GetTotalCountOk returns a tuple with the TotalCount field value and a boolean to check if the value has been set.

func (SchedulePagedResponse) MarshalJSON 

func (o SchedulePagedResponse) MarshalJSON() ([]byte, error)

MarshalJSON returns the JSON representation for the model.

func (*SchedulePagedResponse) SetEntities 

func (o *SchedulePagedResponse) SetEntities(v []Schedule)

SetEntities sets field value

func (*SchedulePagedResponse) SetHasNext 

func (o *SchedulePagedResponse) SetHasNext(v bool)

SetHasNext sets field value

func (*SchedulePagedResponse) SetHasPrev 

func (o *SchedulePagedResponse) SetHasPrev(v bool)

SetHasPrev sets field value

func (*SchedulePagedResponse) SetTotalCount 

func (o *SchedulePagedResponse) SetTotalCount(v int32)

SetTotalCount sets field value

type SpecificGFlagsCLI 

type SpecificGFlagsCLI struct {
	InheritFromPrimary *bool `json:"inheritFromPrimary,omitempty"`
	// Overrides for gflags per availability zone
	PerAZ           *map[string]PerProcessFlags `json:"perAZ,omitempty"`
	PerProcessFlags *PerProcessFlags            `json:"perProcessFlags,omitempty"`
}

SpecificGFlagsCLI represents the CLI input for specific gflags

type SpecificGFlagsCLIOutput 

type SpecificGFlagsCLIOutput struct {
	SpecificGFlags SpecificGFlagsCLI
	ClusterType    string
	ClusterUUID    string
}

SpecificGFlagsCLIOutput represents the CLI output for specific gflags

type StringListListFlag 

type StringListListFlag [][]string

StringListListFlag describes a list of list of strings

func (*StringListListFlag) Set 

func (s *StringListListFlag) Set(value string) error

Set value adds the value string to a list of list of string

func (*StringListListFlag) String 

func (s *StringListListFlag) String() string

String returns a string version of the JSON list of lists

func (*StringListListFlag) Type 

func (s *StringListListFlag) Type() string

Type function describes the custom defined type

type YbaStructuredError 

type YbaStructuredError struct {
	// User-visible unstructured error message
	Error *interface{} `json:"error,omitempty"`
	// Method for HTTP call that resulted in this error
	HTTPMethod *string `json:"httpMethod,omitempty"`
	// URI for HTTP request that resulted in this error
	RequestURI *string `json:"requestUri,omitempty"`
	// Mostly set to false to indicate failure
	Success *bool `json:"success,omitempty"`
}

YbaStructuredError is a structure mimicking YBPError, with error being an interface{} to accomodate errors thrown as YBPStructuredError

Source Files

View all Source files

Jump to

Keyboard shortcuts

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