delphix

package module
v0.0.0-...-a1473ec Latest Latest
Warning

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

 Go to latest Published: Mar 13, 2019 License: Apache-2.0 Imports: 8 Imported by: 0

README

delphix-go-sdk

Please, do not use this to build anything. This is experimental and only published in support of other Delphix experiments.

This is a golang sdk prototype with the object model automatically generated from the delphix.json

The object model is automatically generated by https://gitlab.delphix.com/cto-office/delphix-go-generator

Currently only generates the model. APIs are on the TODO.

Some "level 1" functions and tests have been written (see finders and helpers)

This project will mature into a more swagger-like implementation in the near future.

There are no support, issues, or requests honored on this repository.

Contribute

All contributors are required to sign the Delphix Contributor Agreement prior to contributing code to an open source repository. This process is handled automatically by cla-assistant. Simply open a pull request and a bot will automatically check to see if you have signed the latest agreement. If not, you will be prompted to do so as part of the pull request process.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Statement of Support

This software is provided as-is, without warranty of any kind or commercial support through Delphix. See the associated license for additional details. Questions, issues, feature requests, and contributions should be directed to the community as outlined in the Delphix Community Guidelines.

License

This is code is licensed under the Apache License 2.0. Full license is available here.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CreateSystemInitializationParameters 

func CreateSystemInitializationParameters(c *Client, d string, p string) (string, error)

CreateSystemInitializationParameters assembles the object necessary to feed the InitializeSystem function

func GrabObjectNameAndReference 

func GrabObjectNameAndReference(o interface{}) (string, string, error)

GrabObjectNameAndReference parses a results object(o) and returns the name and reference of that object in Delphix

Types

type APIErrorStruct 

type APIErrorStruct struct {
	// Action to be taken by the user, if any, to fix the underlying
	// problem.
	Action string `json:"action,omitempty"`
	// Extra output, often from a script or other external process, that
	// may give more insight into the cause of this error.
	CommandOutput string `json:"commandOutput,omitempty"`
	// For validation errors, a map of fields to APIError objects. For
	// all other errors, a string with further details of the error.
	Details string `json:"details,omitempty"`
	// Results of diagnostic checks run, if any, if the job failed.
	Diagnoses []*DiagnosisResultStruct `json:"diagnoses,omitempty"`
	// A stable identifier for the class of error encountered.
	Id string `json:"id,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

APIErrorStruct - Description of an error encountered during an API call. extends TypedObject

func APIErrorFactory 

func APIErrorFactory(
	Action string,
	CommandOutput string,
	Details string,
	Diagnoses []*DiagnosisResultStruct,
	Id string,
) APIErrorStruct

APIErrorFactory is just a simple function to instantiate the APIErrorStruct

type APISessionStruct 

type APISessionStruct struct {
	// Client software identification token.
	// required = false
	// maxLength = 64
	Client string `json:"client,omitempty"`
	// Locale as an IETF BCP 47 language tag, defaults to 'en-US'.
	// format = locale
	// required = false
	Locale string `json:"locale,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of the API to use.
	// required = true
	Version *APIVersionStruct `json:"version,omitempty"`
}

APISessionStruct - Describes a Delphix web service session and is the result of an initial handshake. extends TypedObject

func APISessionFactory 

func APISessionFactory(
	Client string,
	Locale string,
	Version *APIVersionStruct,
) APISessionStruct

APISessionFactory is just a simple function to instantiate the APISessionStruct

func CreateAPISession 

func CreateAPISession(v APIVersionStruct, l string, c string) (APISessionStruct, error)

CreateAPISession returns an APISession object v = APIVersion Struct l = Locale as an IETF BCP 47 language tag, defaults to 'en-US'. c = Client software identification token.

type APIVersionStruct 

type APIVersionStruct struct {
	// Major API version number.
	// minimum = 0
	// required = true
	Major *int `json:"major,omitempty"`
	// Micro API version number.
	// minimum = 0
	// required = true
	Micro *int `json:"micro,omitempty"`
	// Minor API version number.
	// minimum = 0
	// required = true
	Minor *int `json:"minor,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

APIVersionStruct - Describes an API version. extends TypedObject

func APIVersionFactory 

func APIVersionFactory(
	Major *int,
	Micro *int,
	Minor *int,
) APIVersionStruct

APIVersionFactory is just a simple function to instantiate the APIVersionStruct

func CreateAPIVersion 

func CreateAPIVersion(major int, minor int, micro int) (APIVersionStruct, error)

CreateAPIVersion returns an APISession object

type ASEAttachDataStruct 

type ASEAttachDataStruct struct {
	// Reference to the configuration for the source.
	// referenceTo = /delphix-ase-db-config.json
	// required = true
	// format = objectReference
	Config string `json:"config,omitempty"`
	// The credentials of the database user.
	// required = true
	// properties = map[type:map[type:string description:Object type. required:true format:type default:PasswordCredential]]
	DbCredentials Credential `json:"dbCredentials,omitempty"`
	// The user name for the source DB user.
	// create = optional
	DbUser string `json:"dbUser,omitempty"`
	// The credential for the source DB user.
	// create = optional
	DumpCredentials string `json:"dumpCredentials,omitempty"`
	// External file path.
	// maxLength = 1024
	// create = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Source database backup location.
	// maxLength = 1024
	// required = true
	LoadBackupPath string `json:"loadBackupPath,omitempty"`
	// Backup location to use for loading backups from the source.
	// create = optional
	LoadLocation string `json:"loadLocation,omitempty"`
	// The base mount point to use for the NFS mounts.
	// maxLength = 87
	// create = optional
	MountBase string `json:"mountBase,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// Information about the host OS user on the source to use for
	// linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	SourceHostUser string `json:"sourceHostUser,omitempty"`
	// Information about the host OS user on the staging environment to
	// use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	StagingHostUser string `json:"stagingHostUser,omitempty"`
	// A user-provided shell script or executable to run after restoring
	// from a backup during validated sync.
	// maxLength = 1024
	// create = optional
	StagingPostScript string `json:"stagingPostScript,omitempty"`
	// A user-provided shell script or executable to run prior to
	// restoring from a backup during validated sync.
	// maxLength = 1024
	// create = optional
	StagingPreScript string `json:"stagingPreScript,omitempty"`
	// The SAP ASE instance on the staging environment that we want to
	// use for validated sync.
	// format = objectReference
	// referenceTo = /delphix-ase-instance.json
	// required = true
	StagingRepository string `json:"stagingRepository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Specifies the validated sync mode to synchronize the dSource with
	// the source database.
	// enum = [ENABLED DISABLED]
	// default = ENABLED
	// create = optional
	ValidatedSyncMode string `json:"validatedSyncMode,omitempty"`
}

ASEAttachDataStruct - Represents the SAP ASE specific parameters of an attach request. extends AttachData

func ASEAttachDataFactory 

func ASEAttachDataFactory(
	Config string,
	DbCredentials Credential,
	DbUser string,
	DumpCredentials string,
	ExternalFilePath string,
	LoadBackupPath string,
	LoadLocation string,
	MountBase string,
	Operations *LinkedSourceOperationsStruct,
	SourceHostUser string,
	StagingHostUser string,
	StagingPostScript string,
	StagingPreScript string,
	StagingRepository string,
	ValidatedSyncMode string,
) ASEAttachDataStruct

ASEAttachDataFactory is just a simple function to instantiate the ASEAttachDataStruct

type ASEBackupLocationStruct 

type ASEBackupLocationStruct struct {
	// Host environment where the backup server is located.
	// format = objectReference
	// referenceTo = /delphix-host-environment.json
	// create = required
	// update = optional
	BackupHost string `json:"backupHost,omitempty"`
	// OS user for the host where the backup server is located.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = required
	// update = optional
	BackupHostUser string `json:"backupHostUser,omitempty"`
	// Name of the backup server instance.
	// update = optional
	// create = required
	BackupServerName string `json:"backupServerName,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASEBackupLocationStruct - SAP ASE backup location. extends TypedObject

func ASEBackupLocationFactory 

func ASEBackupLocationFactory(
	BackupHost string,
	BackupHostUser string,
	BackupServerName string,
) ASEBackupLocationStruct

ASEBackupLocationFactory is just a simple function to instantiate the ASEBackupLocationStruct

type ASECompatibilityCriteriaStruct 

type ASECompatibilityCriteriaStruct struct {
	// Selected repositories are installed on a host with this
	// architecture (32-bit or 64-bit).
	Architecture *int `json:"architecture,omitempty"`
	// Selected repositories are installed on this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// Selected repositories are installed on a host with this OS.
	// enum = [Linux AIX HPUX SunOS Windows]
	Os string `json:"os,omitempty"`
	// Selected repositories are installed on a host with this type of
	// processor.
	// enum = [x86 ia64 powerpc sparc]
	Processor string `json:"processor,omitempty"`
	// If true, selected repositories have staging enabled.
	StagingEnabled *bool `json:"stagingEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASECompatibilityCriteriaStruct - The compatibility criteria to use for filtering the list of available SAP ASE repositories. extends CompatibilityCriteria

func ASECompatibilityCriteriaFactory 

func ASECompatibilityCriteriaFactory(
	Architecture *int,
	Environment string,
	Os string,
	Processor string,
	StagingEnabled *bool,
) ASECompatibilityCriteriaStruct

ASECompatibilityCriteriaFactory is just a simple function to instantiate the ASECompatibilityCriteriaStruct

type ASECreateTransformationParametersStruct 

type ASECreateTransformationParametersStruct struct {
	// The container that will contain the transformed data associated
	// with the newly created transformation; the "transformation
	// container".
	// create = required
	Container *ASEDBContainerStruct `json:"container,omitempty"`
	// Reference to the user used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Operations to perform when this transformation is applied.
	// create = required
	Operations []SourceOperation `json:"operations,omitempty"`
	// Reference to the repository used during application of the
	// transformation.
	// referenceTo = /delphix-source-repository.json
	// create = required
	// format = objectReference
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASECreateTransformationParametersStruct - Represents the parameters of a createTransformation request for an ASE container. extends CreateTransformationParameters

func ASECreateTransformationParametersFactory 

func ASECreateTransformationParametersFactory(
	Container *ASEDBContainerStruct,
	EnvironmentUser string,
	Operations []SourceOperation,
	Repository string,
) ASECreateTransformationParametersStruct

ASECreateTransformationParametersFactory is just a simple function to instantiate the ASECreateTransformationParametersStruct

type ASEDBConfig 

type ASEDBConfig interface{}

ASEDBConfig is an empty interface designed to function as the ASEDBConfig API namespace

type ASEDBContainerRuntimeStruct 

type ASEDBContainerRuntimeStruct struct {
	// The source database backupset that was last restored in this
	// container.
	// format = date
	LastRestoredBackupDate string `json:"lastRestoredBackupDate,omitempty"`
	// The timezone for the last restored source database backupset in
	// this container.
	LastRestoredBackupTimeZone string `json:"lastRestoredBackupTimeZone,omitempty"`
	// True if the LogSync is enabled and running for this container.
	LogSyncActive *bool `json:"logSyncActive,omitempty"`
	// The pre-provisioning runtime for the container.
	PreProvisioningStatus *PreProvisioningRuntimeStruct `json:"preProvisioningStatus,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASEDBContainerRuntimeStruct - Runtime properties of an SAP ASE database container. extends DBContainerRuntime

func ASEDBContainerRuntimeFactory 

func ASEDBContainerRuntimeFactory(
	LastRestoredBackupDate string,
	LastRestoredBackupTimeZone string,
	LogSyncActive *bool,
	PreProvisioningStatus *PreProvisioningRuntimeStruct,
) ASEDBContainerRuntimeStruct

ASEDBContainerRuntimeFactory is just a simple function to instantiate the ASEDBContainerRuntimeStruct

type ASEDBContainerStruct 

type ASEDBContainerStruct struct {
	// The date this container was created.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// A reference to the currently active TimeFlow for this container.
	// referenceTo = /delphix-timeflow.json
	// format = objectReference
	CurrentTimeflow string `json:"currentTimeflow,omitempty"`
	// Optional user-provided description for the container.
	// maxLength = 1024
	// create = optional
	// update = optional
	Description string `json:"description,omitempty"`
	// A reference to the group containing this container.
	// create = required
	// format = objectReference
	// referenceTo = /delphix-group.json
	Group string `json:"group,omitempty"`
	// True if this container is a masked container.
	Masked *bool `json:"masked,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The operating system for the source database.
	Os string `json:"os,omitempty"`
	// Whether to enable high performance mode.
	// create = readonly
	// update = readonly
	// enum = [TEMPORARILY_ENABLED ENABLED DISABLED]
	// default = DISABLED
	PerformanceMode string `json:"performanceMode,omitempty"`
	// A reference to the previous TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	PreviousTimeflow string `json:"previousTimeflow,omitempty"`
	// The processor type for the source database.
	Processor string `json:"processor,omitempty"`
	// A reference to the container this container was provisioned from.
	// format = objectReference
	// referenceTo = /delphix-container.json
	ProvisionContainer string `json:"provisionContainer,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this container.
	Runtime *ASEDBContainerRuntimeStruct `json:"runtime,omitempty"`
	// Policies for managing LogSync and SnapSync across sources for an
	// SAP ASE container.
	// create = optional
	// update = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// True if this container is a transformation container.
	Transformation *bool `json:"transformation,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASEDBContainerStruct - An SAP ASE Database Container. extends DatabaseContainer

func ASEDBContainerFactory 

func ASEDBContainerFactory(
	CreationTime string,
	CurrentTimeflow string,
	Description string,
	Group string,
	Masked *bool,
	Name string,
	Namespace string,
	Os string,
	PreviousTimeflow string,
	Processor string,
	ProvisionContainer string,
	Reference string,
	Runtime *ASEDBContainerRuntimeStruct,
	SourcingPolicy *SourcingPolicyStruct,
	Transformation *bool,
) ASEDBContainerStruct

ASEDBContainerFactory is just a simple function to instantiate the ASEDBContainerStruct

type ASEExportParametersStruct 

type ASEExportParametersStruct struct {
	// Database-specific configuration parameters.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// If specified, then take the exported database through recovery
	// procedures, if necessary, to reach a consistent point.
	// create = optional
	// default = true
	RecoverDatabase *bool `json:"recoverDatabase,omitempty"`
	// The source config to use when creating the exported DB.
	// required = true
	SourceConfig ASEDBConfig `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base export
	// on.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

ASEExportParametersStruct - The parameters to use as input to export SAP ASE databases. extends DbExportParameters

func ASEExportParametersFactory 

func ASEExportParametersFactory(
	ConfigParams map[string]string,
	FileMappingRules string,
	RecoverDatabase *bool,
	SourceConfig ASEDBConfig,
	TimeflowPointParameters TimeflowPointParameters,
) ASEExportParametersStruct

ASEExportParametersFactory is just a simple function to instantiate the ASEExportParametersStruct

type ASEHostEnvironmentParametersStruct 

type ASEHostEnvironmentParametersStruct struct {
	// The credentials of the database user.
	// update = optional
	// properties = map[type:map[type:string description:Object type. required:true format:type default:PasswordCredential]]
	// create = required
	Credentials Credential `json:"credentials,omitempty"`
	// The username of the database user.
	// create = optional
	// update = optional
	// maxLength = 256
	DbUser string `json:"dbUser,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASEHostEnvironmentParametersStruct - SAP ASE host environment parameters. extends TypedObject

func ASEHostEnvironmentParametersFactory 

func ASEHostEnvironmentParametersFactory(
	Credentials Credential,
	DbUser string,
) ASEHostEnvironmentParametersStruct

ASEHostEnvironmentParametersFactory is just a simple function to instantiate the ASEHostEnvironmentParametersStruct

type ASEInstanceStruct 

type ASEInstanceStruct struct {
	// The credentials of the database user.
	// create = optional
	// update = optional
	// properties = map[type:map[type:string description:Object type. required:true format:type default:PasswordCredential]]
	Credentials Credential `json:"credentials,omitempty"`
	// The username of the database user.
	// update = optional
	// maxLength = 256
	// create = optional
	DbUser string `json:"dbUser,omitempty"`
	// True if the SAP ASE instance was automatically discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// Reference to the environment containing this repository.
	// create = required
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// The SAP ASE instance home.
	// create = required
	// update = optional
	InstallationPath string `json:"installationPath,omitempty"`
	// The name of the SAP ASE instance.
	// create = required
	InstanceName string `json:"instanceName,omitempty"`
	// The username of the account the SAP ASE instance is running as.
	// create = required
	// update = optional
	InstanceOwner string `json:"instanceOwner,omitempty"`
	// The gid of the account the SAP ASE instance is running as.
	// create = readonly
	// update = readonly
	InstanceOwnerGid *int `json:"instanceOwnerGid,omitempty"`
	// The uid of the account the SAP ASE instance is running as.
	// update = readonly
	// create = readonly
	InstanceOwnerUid *int `json:"instanceOwnerUid,omitempty"`
	// The path to the isql binary to use for this SAP ASE instance.
	// create = optional
	// update = optional
	IsqlPath string `json:"isqlPath,omitempty"`
	// Flag indicating whether the repository should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Database page size for the SAP ASE instance.
	PageSize *int `json:"pageSize,omitempty"`
	// The network ports for connecting to the SAP ASE instance.
	// create = required
	// update = optional
	Ports []*int `json:"ports,omitempty"`
	// Flag indicating whether the repository should be used for
	// provisioning.
	// default = true
	// create = optional
	// update = optional
	ProvisioningEnabled *bool `json:"provisioningEnabled,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The Kerberos SPN of the database.
	// create = optional
	// update = optional
	ServicePrincipalName string `json:"servicePrincipalName,omitempty"`
	// Flag indicating whether this repository can be used by the Delphix
	// Engine for internal processing.
	// create = optional
	// update = optional
	// default = false
	Staging *bool `json:"staging,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// Version of the repository.
	// create = optional
	// update = optional
	Version string `json:"version,omitempty"`
}

ASEInstanceStruct - The SAP ASE source repository. extends SourceRepository

func ASEInstanceFactory 

func ASEInstanceFactory(
	Credentials Credential,
	DbUser string,
	Discovered *bool,
	Environment string,
	InstallationPath string,
	InstanceName string,
	InstanceOwner string,
	IsqlPath string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	PageSize *int,
	Ports []*int,
	ProvisioningEnabled *bool,
	Reference string,
	ServicePrincipalName string,
	Staging *bool,
	Version string,
) ASEInstanceStruct

ASEInstanceFactory is just a simple function to instantiate the ASEInstanceStruct

type ASELatestBackupSyncParametersStruct 

type ASELatestBackupSyncParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASELatestBackupSyncParametersStruct - The parameters to use as input to sync a SAP ASE database using the latest backup. extends ASESyncParameters

func ASELatestBackupSyncParametersFactory 

func ASELatestBackupSyncParametersFactory() ASELatestBackupSyncParametersStruct

ASELatestBackupSyncParametersFactory is just a simple function to instantiate the ASELatestBackupSyncParametersStruct

type ASELinkDataStruct 

type ASELinkDataStruct struct {
	// Reference to the configuration for the source.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-ase-db-config.json
	Config string `json:"config,omitempty"`
	// The credentials of the database user.
	// required = true
	// properties = map[type:map[type:string description:Object type. required:true format:type default:PasswordCredential]]
	DbCredentials Credential `json:"dbCredentials,omitempty"`
	// The user name for the source DB user.
	// create = optional
	DbUser string `json:"dbUser,omitempty"`
	// The credential for the source DB user.
	// create = optional
	DumpCredentials string `json:"dumpCredentials,omitempty"`
	// External file path.
	// maxLength = 1024
	// create = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Source database backup location.
	// maxLength = 1024
	// required = true
	LoadBackupPath string `json:"loadBackupPath,omitempty"`
	// Backup location to use for loading backups from the source.
	// create = optional
	LoadLocation string `json:"loadLocation,omitempty"`
	// The base mount point to use for the NFS mounts.
	// maxLength = 87
	// create = optional
	MountBase string `json:"mountBase,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// Information about the host OS user on the source to use for
	// linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	SourceHostUser string `json:"sourceHostUser,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// Information about the host OS user on the staging environment to
	// use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	StagingHostUser string `json:"stagingHostUser,omitempty"`
	// A user-provided shell script or executable to run after restoring
	// from a backup during validated sync.
	// maxLength = 1024
	// create = optional
	StagingPostScript string `json:"stagingPostScript,omitempty"`
	// A user-provided shell script or executable to run prior to
	// restoring from a backup during validated sync.
	// maxLength = 1024
	// create = optional
	StagingPreScript string `json:"stagingPreScript,omitempty"`
	// The SAP ASE instance on the staging environment that we want to
	// use for validated sync.
	// format = objectReference
	// referenceTo = /delphix-ase-instance.json
	// required = true
	StagingRepository string `json:"stagingRepository,omitempty"`
	// Sync parameters for the container.
	// required = true
	// properties = map[type:map[type:string description:Object type. required:true format:type default:ASELatestBackupSyncParameters]]
	SyncParameters ASESyncParameters `json:"syncParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Specifies the validated sync mode to synchronize the dSource with
	// the source database.
	// enum = [ENABLED DISABLED]
	// default = ENABLED
	// create = optional
	ValidatedSyncMode string `json:"validatedSyncMode,omitempty"`
}

ASELinkDataStruct - SAP ASE specific parameters for a link request. extends LinkData

func ASELinkDataFactory 

func ASELinkDataFactory(
	Config string,
	DbCredentials Credential,
	DbUser string,
	DumpCredentials string,
	ExternalFilePath string,
	LoadBackupPath string,
	LoadLocation string,
	MountBase string,
	Operations *LinkedSourceOperationsStruct,
	SourceHostUser string,
	SourcingPolicy *SourcingPolicyStruct,
	StagingHostUser string,
	StagingPostScript string,
	StagingPreScript string,
	StagingRepository string,
	SyncParameters ASESyncParameters,
	ValidatedSyncMode string,
) ASELinkDataStruct

ASELinkDataFactory is just a simple function to instantiate the ASELinkDataStruct

type ASELinkedSourceStruct 

type ASELinkedSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-ase-db-config.json
	// create = required
	// update = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// referenceTo = /delphix-container.json
	// format = objectReference
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// The credential for the source DB user.
	// create = optional
	// update = optional
	DumpCredentials string `json:"dumpCredentials,omitempty"`
	// External file path.
	// create = optional
	// update = optional
	// maxLength = 1024
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Source database backup location.
	// create = required
	// update = optional
	// maxLength = 1024
	LoadBackupPath string `json:"loadBackupPath,omitempty"`
	// Backup location to use for loading backups from the source.
	// create = optional
	// update = optional
	LoadLocation string `json:"loadLocation,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// update = optional
	// default = false
	// create = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *ASESourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// The staging source for validated sync of the database.
	// referenceTo = /delphix-ase-staging-source.json
	// format = objectReference
	StagingSource string `json:"stagingSource,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Specifies the validated sync mode to synchronize the dSource with
	// the source database.
	// default = ENABLED
	// create = optional
	// update = optional
	// enum = [ENABLED DISABLED]
	ValidatedSyncMode string `json:"validatedSyncMode,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

ASELinkedSourceStruct - A linked SAP ASE source. extends ASESource

func ASELinkedSourceFactory 

func ASELinkedSourceFactory(
	Config string,
	Container string,
	Description string,
	DumpCredentials string,
	ExternalFilePath string,
	Hosts []string,
	Linked *bool,
	LoadBackupPath string,
	LoadLocation string,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	Operations *LinkedSourceOperationsStruct,
	Reference string,
	Runtime *ASESourceRuntimeStruct,
	Staging *bool,
	StagingSource string,
	Status string,
	ValidatedSyncMode string,
	Virtual *bool,
) ASELinkedSourceStruct

ASELinkedSourceFactory is just a simple function to instantiate the ASELinkedSourceStruct

type ASENewBackupSyncParametersStruct 

type ASENewBackupSyncParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASENewBackupSyncParametersStruct - The parameters to use as input to sync a SAP ASE database by taking a new full backup. extends ASESyncParameters

func ASENewBackupSyncParametersFactory 

func ASENewBackupSyncParametersFactory() ASENewBackupSyncParametersStruct

ASENewBackupSyncParametersFactory is just a simple function to instantiate the ASENewBackupSyncParametersStruct

type ASEPlatformParametersStruct 

type ASEPlatformParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASEPlatformParametersStruct - ASE platform-specific parameters that are stored on a transformation. extends BasePlatformParameters

func ASEPlatformParametersFactory 

func ASEPlatformParametersFactory() ASEPlatformParametersStruct

ASEPlatformParametersFactory is just a simple function to instantiate the ASEPlatformParametersStruct

type ASEProvisionParametersStruct 

type ASEProvisionParametersStruct struct {
	// The new container for the provisioned database.
	// required = true
	Container *ASEDBContainerStruct `json:"container,omitempty"`
	// Whether or not to mark this VDB as a masked VDB. It will be marked
	// as masked if this flag or the masking job are set.
	// create = optional
	// update = readonly
	Masked *bool `json:"masked,omitempty"`
	// The Masking Job to be run when this dataset is provisioned or
	// refreshed.
	// format = objectReference
	// referenceTo = /delphix-masking-job.json
	// create = optional
	// update = readonly
	MaskingJob string `json:"maskingJob,omitempty"`
	// The source that describes an external database instance.
	// required = true
	Source *ASEVirtualSourceStruct `json:"source,omitempty"`
	// The source config including dynamically discovered attributes of
	// the source.
	// required = true
	SourceConfig ASEDBConfig `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base
	// provisioning on.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Set the "trunc log on chkpt" database option.
	// default = true
	// create = required
	TruncateLogOnCheckpoint *bool `json:"truncateLogOnCheckpoint,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASEProvisionParametersStruct - The parameters to use as input to provision SAP ASE databases. extends ProvisionParameters

func ASEProvisionParametersFactory 

func ASEProvisionParametersFactory(
	Container *ASEDBContainerStruct,
	Masked *bool,
	MaskingJob string,
	Source *ASEVirtualSourceStruct,
	SourceConfig ASEDBConfig,
	TimeflowPointParameters TimeflowPointParameters,
	TruncateLogOnCheckpoint *bool,
) ASEProvisionParametersStruct

ASEProvisionParametersFactory is just a simple function to instantiate the ASEProvisionParametersStruct

type ASESIConfigStruct 

type ASESIConfigStruct struct {
	// The password of the database user.
	// update = optional
	Credentials Credential `json:"credentials,omitempty"`
	// The name of the database.
	// maxLength = 30
	// create = required
	// update = optional
	// pattern = ^[a-zA-Z0-9_]+$
	DatabaseName string `json:"databaseName,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// format = objectReference
	// referenceTo = /delphix-ase-instance.json
	// create = required
	// update = optional
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the database user.
	// update = optional
	// maxLength = 256
	User string `json:"user,omitempty"`
}

ASESIConfigStruct - A SAP ASE single instance database config. extends ASEDBConfig

func ASESIConfigFactory 

func ASESIConfigFactory(
	Credentials Credential,
	DatabaseName string,
	Discovered *bool,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	Reference string,
	Repository string,
	User string,
) ASESIConfigStruct

ASESIConfigFactory is just a simple function to instantiate the ASESIConfigStruct

type ASESnapshotRuntimeStruct 

type ASESnapshotRuntimeStruct struct {
	// True if this snapshot can be used as the basis for provisioning a
	// new TimeFlow.
	Provisionable *bool `json:"provisionable,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

ASESnapshotRuntimeStruct - Runtime (non-persistent) properties of a SAP ASE TimeFlow snapshot. extends SnapshotRuntime

func ASESnapshotRuntimeFactory 

func ASESnapshotRuntimeFactory(
	Provisionable *bool,
) ASESnapshotRuntimeStruct

ASESnapshotRuntimeFactory is just a simple function to instantiate the ASESnapshotRuntimeStruct

type ASESnapshotStruct 

type ASESnapshotStruct struct {
	// A value in the set {CONSISTENT, INCONSISTENT, CRASH_CONSISTENT}
	// indicating what type of recovery strategies must be invoked when
	// provisioning from this snapshot.
	Consistency string `json:"consistency,omitempty"`
	// Reference to the database of which this TimeFlow is a part.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Point in time at which this snapshot was created. This may be
	// different from the time corresponding to the TimeFlow.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// The location within the parent TimeFlow at which this snapshot was
	// initiated.
	FirstChangePoint *ASETimeflowPointStruct `json:"firstChangePoint,omitempty"`
	// The location of the snapshot within the parent TimeFlow
	// represented by this snapshot.
	LatestChangePoint *ASETimeflowPointStruct `json:"latestChangePoint,omitempty"`
	// Boolean value indicating if a virtual database provisioned from
	// this snapshot will be missing nologging changes.
	MissingNonLoggedData *bool `json:"missingNonLoggedData,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Retention policy, in days. A value of -1 indicates the snapshot
	// should be kept forever.
	// update = optional
	Retention *int `json:"retention,omitempty"`
	// Runtime properties of the snapshot.
	Runtime *ASESnapshotRuntimeStruct `json:"runtime,omitempty"`
	// Boolean value indicating that this snapshot is in a transient
	// state and should not be user visible.
	Temporary *bool `json:"temporary,omitempty"`
	// TimeFlow of which this snapshot is a part.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Time zone of the source database at the time the snapshot was
	// taken.
	Timezone string `json:"timezone,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of database source repository at the time the snapshot was
	// taken.
	Version string `json:"version,omitempty"`
}

ASESnapshotStruct - Provisionable snapshot of a SAP ASE TimeFlow. extends TimeflowSnapshot

func ASESnapshotFactory 

func ASESnapshotFactory(
	Consistency string,
	Container string,
	CreationTime string,
	FirstChangePoint *ASETimeflowPointStruct,
	LatestChangePoint *ASETimeflowPointStruct,
	MissingNonLoggedData *bool,
	Name string,
	Namespace string,
	Reference string,
	Retention *int,
	Runtime *ASESnapshotRuntimeStruct,
	Temporary *bool,
	Timeflow string,
	Timezone string,
	Version string,
) ASESnapshotStruct

ASESnapshotFactory is just a simple function to instantiate the ASESnapshotStruct

type ASESource 

type ASESource interface{}

ASESource is an empty interface designed to function as the ASESource API namespace

type ASESourceConnectionInfoStruct 

type ASESourceConnectionInfoStruct struct {
	// The database name of the source.
	DatabaseName string `json:"databaseName,omitempty"`
	// Host to use for connecting to the source.
	Host string `json:"host,omitempty"`
	// The JDBC string used to connect to the source.
	JdbcString string `json:"jdbcString,omitempty"`
	// Port to use for connecting to the source.
	Port *int `json:"port,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// User to use for connecting to the source.
	User string `json:"user,omitempty"`
	// The database version string.
	Version string `json:"version,omitempty"`
}

ASESourceConnectionInfoStruct - Contains information that can be used to connect to an SAP ASE source. extends SourceConnectionInfo

func ASESourceConnectionInfoFactory 

func ASESourceConnectionInfoFactory(
	DatabaseName string,
	Host string,
	JdbcString string,
	Port *int,
	User string,
	Version string,
) ASESourceConnectionInfoStruct

ASESourceConnectionInfoFactory is just a simple function to instantiate the ASESourceConnectionInfoStruct

type ASESourceRuntimeStruct 

type ASESourceRuntimeStruct struct {
	// True if the source is JDBC accessible. If false then no properties
	// can be retrieved.
	Accessible *bool `json:"accessible,omitempty"`
	// The time that the 'accessible' propery was last checked.
	// format = date
	AccessibleTimestamp string `json:"accessibleTimestamp,omitempty"`
	// Size of the database in bytes.
	// units = B
	// base = 1024
	DatabaseSize float64 `json:"databaseSize,omitempty"`
	// SAP ASE database durability level.
	// enum = [FULL AT_SHUTDOWN NO_RECOVERY]
	DurabilityLevel string `json:"durabilityLevel,omitempty"`
	// Status indicating whether the source is enabled. A source has a
	// 'PARTIAL' status if its sub-sources are not all enabled.
	// enum = [ENABLED PARTIAL DISABLED]
	Enabled string `json:"enabled,omitempty"`
	// The reason why the source is not JDBC accessible.
	NotAccessibleReason string `json:"notAccessibleReason,omitempty"`
	// Status of the source. 'Unknown' if all attempts to connect to the
	// source failed.
	// enum = [RUNNING INACTIVE PENDING CANCELED FAILED CHECKING UNKNOWN]
	Status string `json:"status,omitempty"`
	// True if configured to truncate log on checkpoint.
	TruncateLogOnCheckpoint *bool `json:"truncateLogOnCheckpoint,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

ASESourceRuntimeStruct - Runtime (non-persistent) properties of a SAP ASE source. extends SourceRuntime

func ASESourceRuntimeFactory 

func ASESourceRuntimeFactory(
	Accessible *bool,
	AccessibleTimestamp string,
	DatabaseSize float64,
	DurabilityLevel string,
	Enabled string,
	NotAccessibleReason string,
	Status string,
	TruncateLogOnCheckpoint *bool,
) ASESourceRuntimeStruct

ASESourceRuntimeFactory is just a simple function to instantiate the ASESourceRuntimeStruct

type ASESpecificBackupSyncParametersStruct 

type ASESpecificBackupSyncParametersStruct struct {
	// The location of the full backup of the source database to restore
	// from. The backup should be present in the shared backup location
	// for the source database.
	// create = required
	// uniqueItems = true
	// minItems = 1
	BackupFiles []string `json:"backupFiles,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASESpecificBackupSyncParametersStruct - The parameters to use as input to sync a SAP ASE database using a specific existing backup. extends ASESyncParameters

func ASESpecificBackupSyncParametersFactory 

func ASESpecificBackupSyncParametersFactory(
	BackupFiles []string,
) ASESpecificBackupSyncParametersStruct

ASESpecificBackupSyncParametersFactory is just a simple function to instantiate the ASESpecificBackupSyncParametersStruct

type ASEStagingSourceStruct 

type ASEStagingSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point for the NFS mounts.
	// update = optional
	// maxLength = 87
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The path to a user-provided shell script or executable to run on
	// the staging host after restoring from a backup during validated
	// sync.
	// create = optional
	// update = optional
	// maxLength = 1024
	PostScript string `json:"postScript,omitempty"`
	// The path to a user-provided script or executable to run on the
	// staging host prior to restoring from a backup during validated
	// sync.
	// maxLength = 1024
	// create = optional
	// update = optional
	PreScript string `json:"preScript,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *ASESourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

ASEStagingSourceStruct - An SAP ASE staging source used for validated sync.. extends ASESource

func ASEStagingSourceFactory 

func ASEStagingSourceFactory(
	Config string,
	Container string,
	Description string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	PostScript string,
	PreScript string,
	Reference string,
	Runtime *ASESourceRuntimeStruct,
	Staging *bool,
	Status string,
	Virtual *bool,
) ASEStagingSourceStruct

ASEStagingSourceFactory is just a simple function to instantiate the ASEStagingSourceStruct

type ASESyncParameters 

type ASESyncParameters interface{}

ASESyncParameters is an empty interface designed to function as the ASESyncParameters API namespace

type ASETimeflowPointStruct 

type ASETimeflowPointStruct struct {
	// The TimeFlow location.
	// create = optional
	Location string `json:"location,omitempty"`
	// Reference to TimeFlow containing this point.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-ase-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// The logical time corresponding to the TimeFlow location.
	// format = date
	// create = optional
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASETimeflowPointStruct - A unique point within a SAP ASE database TimeFlow. extends TimeflowPoint

func ASETimeflowPointFactory 

func ASETimeflowPointFactory(
	Location string,
	Timeflow string,
	Timestamp string,
) ASETimeflowPointStruct

ASETimeflowPointFactory is just a simple function to instantiate the ASETimeflowPointStruct

type ASETimeflowStruct 

type ASETimeflowStruct struct {
	// Reference to the data container (database) for this TimeFlow.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// The source action that created the TimeFlow.
	// enum = [INITIAL INDETERMINATE REFRESH ROLLBACK TEMPORARY TRANSFORMATION V2P PDB_PLUG WAREHOUSE ORACLE_LIVE_SOURCE_RESYNC SOURCE_CONTINUITY]
	CreationType string `json:"creationType,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The origin point on the parent TimeFlow from which this TimeFlow
	// was provisioned. This will not be present for TimeFlows derived
	// from linked sources.
	ParentPoint *ASETimeflowPointStruct `json:"parentPoint,omitempty"`
	// Reference to the parent snapshot that serves as the provisioning
	// base for this object. This may be different from the snapshot
	// within the parent point, and is only present for virtual
	// TimeFlows.
	// referenceTo = /delphix-timeflow-snapshot.json
	// format = objectReference
	ParentSnapshot string `json:"parentSnapshot,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ASETimeflowStruct - TimeFlow representing historical data for a particular timeline within a SAP ASE data container. extends Timeflow

func ASETimeflowFactory 

func ASETimeflowFactory(
	Container string,
	CreationType string,
	Name string,
	Namespace string,
	ParentPoint *ASETimeflowPointStruct,
	ParentSnapshot string,
	Reference string,
) ASETimeflowStruct

ASETimeflowFactory is just a simple function to instantiate the ASETimeflowStruct

type ASEVirtualSourceStruct 

type ASEVirtualSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// create = required
	// update = optional
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// SAP ASE database configuration parameter overrides.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules.
	// create = optional
	// maxLength = 4096
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point for the NFS mounts.
	// maxLength = 87
	// create = optional
	// update = optional
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *ASESourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

ASEVirtualSourceStruct - A virtual SAP ASE source. extends ASESource

func ASEVirtualSourceFactory 

func ASEVirtualSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	Config string,
	ConfigParams map[string]string,
	Container string,
	Description string,
	FileMappingRules string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	Operations *VirtualSourceOperationsStruct,
	Reference string,
	Runtime *ASESourceRuntimeStruct,
	Staging *bool,
	Status string,
	Virtual *bool,
) ASEVirtualSourceStruct

ASEVirtualSourceFactory is just a simple function to instantiate the ASEVirtualSourceStruct

type AbstractSourceConfigConnectivity 

type AbstractSourceConfigConnectivity interface{}

AbstractSourceConfigConnectivity is an empty interface designed to function as the AbstractSourceConfigConnectivity API namespace

type ActionStruct 

type ActionStruct struct {
	// Action type.
	ActionType string `json:"actionType,omitempty"`
	// Plain text description of the action.
	Details string `json:"details,omitempty"`
	// The time the action completed.
	// format = date
	EndTime string `json:"endTime,omitempty"`
	// Action to be taken to resolve the failure.
	FailureAction string `json:"failureAction,omitempty"`
	// Details of the action failure.
	FailureDescription string `json:"failureDescription,omitempty"`
	// Message ID associated with the event.
	FailureMessageCode string `json:"failureMessageCode,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Network address used to initiate the action.
	OriginIp string `json:"originIp,omitempty"`
	// The parent action of this action.
	// format = objectReference
	// referenceTo = /delphix-action.json
	ParentAction string `json:"parentAction,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Report of progress and warnings for some actions.
	Report string `json:"report,omitempty"`
	// The time the action occurred. For long running processes, this
	// represents the starting time.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// State of the action.
	// enum = [EXECUTING WAITING COMPLETED FAILED CANCELED]
	State string `json:"state,omitempty"`
	// Action title.
	Title string `json:"title,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// User who initiated the action.
	// format = objectReference
	// referenceTo = /delphix-user.json
	User string `json:"user,omitempty"`
	// Name of client software used to initiate the action.
	UserAgent string `json:"userAgent,omitempty"`
	// Origin of the work that caused the action.
	// enum = [WEBSERVICE POLICY SYSTEM]
	WorkSource string `json:"workSource,omitempty"`
	// Name of user or policy that initiated the action.
	WorkSourceName string `json:"workSourceName,omitempty"`
}

ActionStruct - Represents an action, a permanent record of activity on the server. extends PersistentObject cliVisibility = [SYSTEM DOMAIN]

func ActionFactory 

func ActionFactory(
	ActionType string,
	Details string,
	EndTime string,
	FailureAction string,
	FailureDescription string,
	FailureMessageCode string,
	Namespace string,
	OriginIp string,
	ParentAction string,
	Reference string,
	Report string,
	StartTime string,
	State string,
	Title string,
	User string,
	UserAgent string,
	WorkSource string,
	WorkSourceName string,
) ActionStruct

ActionFactory is just a simple function to instantiate the ActionStruct

type AddLiveSourceParameters 

type AddLiveSourceParameters interface{}

AddLiveSourceParameters is an empty interface designed to function as the AddLiveSourceParameters API namespace

type AggregateCapacityData 

type AggregateCapacityData interface{}

AggregateCapacityData is an empty interface designed to function as the AggregateCapacityData API namespace

type AlertAction 

type AlertAction interface{}

AlertAction is an empty interface designed to function as the AlertAction API namespace

type AlertActionEmail 

type AlertActionEmail interface{}

AlertActionEmail is an empty interface designed to function as the AlertActionEmail API namespace

type AlertActionEmailListStruct 

type AlertActionEmailListStruct struct {
	// List of email addresses to send mail to.
	// required = true
	Addresses []string `json:"addresses,omitempty"`
	// Email format to use. The HTML format will generate a multipart
	// message containing both HTML and plain text. The TEXT format will
	// explicitly generate text-only mail. The JSON format will generate
	// a JSON object identical to the $Alert format returned through the
	// web services API.
	// create = optional
	// update = optional
	// enum = [HTML TEXT JSON]
	// default = HTML
	Format string `json:"format,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AlertActionEmailListStruct - Alert action to email a list of users in response to an alert. extends AlertActionEmail

func AlertActionEmailListFactory 

func AlertActionEmailListFactory(
	Addresses []string,
	Format string,
) AlertActionEmailListStruct

AlertActionEmailListFactory is just a simple function to instantiate the AlertActionEmailListStruct

type AlertActionEmailUserStruct 

type AlertActionEmailUserStruct struct {
	// Email format to use. The HTML format will generate a multipart
	// message containing both HTML and plain text. The TEXT format will
	// explicitly generate text-only mail. The JSON format will generate
	// a JSON object identical to the $Alert format returned through the
	// web services API.
	// create = optional
	// update = optional
	// enum = [HTML TEXT JSON]
	// default = HTML
	Format string `json:"format,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AlertActionEmailUserStruct - Alert action that sends email to the email address associated with the user. extends AlertActionEmail

func AlertActionEmailUserFactory 

func AlertActionEmailUserFactory(
	Format string,
) AlertActionEmailUserStruct

AlertActionEmailUserFactory is just a simple function to instantiate the AlertActionEmailUserStruct

type AlertFilter 

type AlertFilter interface{}

AlertFilter is an empty interface designed to function as the AlertFilter API namespace

type AlertProfileStruct 

type AlertProfileStruct struct {
	// List of actions to take. Only alerts visible to the user and
	// matching the optional filters are included. If there are multiple
	// actions with the same result (such as emailing a user), only one
	// result is acted upon.
	// create = required
	// update = optional
	Actions []AlertAction `json:"actions,omitempty"`
	// Specifies which alerts should be matched by this profile.
	// create = optional
	// update = optional
	// properties = map[type:map[default:SeverityFilter]]
	FilterSpec AlertFilter `json:"filterSpec,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

AlertProfileStruct - A profile that describes a set of actions to take in response to an alert being generated. extends PersistentObject

func AlertProfileFactory 

func AlertProfileFactory(
	Actions []AlertAction,
	FilterSpec AlertFilter,
	Namespace string,
	Reference string,
) AlertProfileStruct

AlertProfileFactory is just a simple function to instantiate the AlertProfileStruct

type AlertStruct 

type AlertStruct struct {
	// Event class.
	Event string `json:"event,omitempty"`
	// Event recommended action.
	EventAction string `json:"eventAction,omitempty"`
	// Additional text associated with the event. This text is not
	// localized and is only provided for certain alerts. For example, if
	// an alert is caused by a post script failure, the output of the
	// post script may be included here to assist with debugging the
	// failure.
	EventCommandOutput string `json:"eventCommandOutput,omitempty"`
	// Event description.
	EventDescription string `json:"eventDescription,omitempty"`
	// Event response.
	EventResponse string `json:"eventResponse,omitempty"`
	// Event severity.
	// enum = [INFORMATIONAL WARNING CRITICAL AUDIT]
	EventSeverity string `json:"eventSeverity,omitempty"`
	// Event title.
	EventTitle string `json:"eventTitle,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Reference to target object.
	// referenceTo = /delphix-user-object.json
	// format = objectReference
	Target string `json:"target,omitempty"`
	// Name of target object.
	TargetName string `json:"targetName,omitempty"`
	// Type of target object.
	// format = type
	TargetObjectType string `json:"targetObjectType,omitempty"`
	// Time at which event occurred.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AlertStruct - An alert describing an event for a given object. extends PersistentObject

func AlertFactory 

func AlertFactory(
	Event string,
	EventAction string,
	EventCommandOutput string,
	EventDescription string,
	EventResponse string,
	EventSeverity string,
	EventTitle string,
	Namespace string,
	Reference string,
	Target string,
	TargetName string,
	TargetObjectType string,
	Timestamp string,
) AlertStruct

AlertFactory is just a simple function to instantiate the AlertStruct

type AndFilterStruct 

type AndFilterStruct struct {
	// Filters which are combined together using AND logic.
	// create = required
	// update = optional
	// minItems = 2
	SubFilters []AlertFilter `json:"subFilters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AndFilterStruct - A container filter that combines other filters together using AND logic. extends AlertFilter

func AndFilterFactory 

func AndFilterFactory(
	SubFilters []AlertFilter,
) AndFilterStruct

AndFilterFactory is just a simple function to instantiate the AndFilterStruct

type AppDataAdditionalMountPointStruct 

type AppDataAdditionalMountPointStruct struct {
	// Reference to the environment on which the file system will be
	// mounted.
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-host-environment.json
	// create = required
	Environment string `json:"environment,omitempty"`
	// Absolute path on the target environment were the filesystem should
	// be mounted.
	// update = optional
	// format = unixpath
	// create = required
	MountPath string `json:"mountPath,omitempty"`
	// Relative path within the container of the directory that should be
	// mounted.
	// create = optional
	// update = optional
	// format = unixpath
	SharedPath string `json:"sharedPath,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataAdditionalMountPointStruct - Specifies an additional location on which to mount a subdirectory of an AppData container. extends TypedObject

func AppDataAdditionalMountPointFactory 

func AppDataAdditionalMountPointFactory(
	Environment string,
	MountPath string,
	SharedPath string,
) AppDataAdditionalMountPointStruct

AppDataAdditionalMountPointFactory is just a simple function to instantiate the AppDataAdditionalMountPointStruct

type AppDataBaseTimeflow 

type AppDataBaseTimeflow interface{}

AppDataBaseTimeflow is an empty interface designed to function as the AppDataBaseTimeflow API namespace

type AppDataCachedMountPointStruct 

type AppDataCachedMountPointStruct struct {
	// Reference to the environment on which the file system is mounted.
	// create = required
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-host-environment.json
	Environment string `json:"environment,omitempty"`
	// Absolute path on the target environment were the filesystem is
	// mounted.
	// format = unixpath
	// create = required
	// update = optional
	MountPath string `json:"mountPath,omitempty"`
	// Order in mount sequence.
	// create = required
	// update = optional
	Ordinal *int `json:"ordinal,omitempty"`
	// Relative path within the container of the directory that is
	// mounted.
	// format = unixpath
	// create = optional
	// update = optional
	SharedPath string `json:"sharedPath,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataCachedMountPointStruct - Specified information about an active mount of an AppData container. extends TypedObject

func AppDataCachedMountPointFactory 

func AppDataCachedMountPointFactory(
	Environment string,
	MountPath string,
	Ordinal *int,
	SharedPath string,
) AppDataCachedMountPointStruct

AppDataCachedMountPointFactory is just a simple function to instantiate the AppDataCachedMountPointStruct

type AppDataContainerRuntimeStruct 

type AppDataContainerRuntimeStruct struct {
	// True if the LogSync is enabled and running for this container.
	LogSyncActive *bool `json:"logSyncActive,omitempty"`
	// The pre-provisioning runtime for the container.
	PreProvisioningStatus *PreProvisioningRuntimeStruct `json:"preProvisioningStatus,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataContainerRuntimeStruct - Runtime properties of an AppData container. extends DBContainerRuntime

func AppDataContainerRuntimeFactory 

func AppDataContainerRuntimeFactory(
	LogSyncActive *bool,
	PreProvisioningStatus *PreProvisioningRuntimeStruct,
) AppDataContainerRuntimeStruct

AppDataContainerRuntimeFactory is just a simple function to instantiate the AppDataContainerRuntimeStruct

type AppDataContainerStruct 

type AppDataContainerStruct struct {
	// The date this container was created.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// A reference to the currently active TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	CurrentTimeflow string `json:"currentTimeflow,omitempty"`
	// Optional user-provided description for the container.
	// maxLength = 1024
	// create = optional
	// update = optional
	Description string `json:"description,omitempty"`
	// A reference to the group containing this container.
	// format = objectReference
	// referenceTo = /delphix-group.json
	// create = required
	Group string `json:"group,omitempty"`
	// A global identifier for this container, including across Delphix
	// Engines.
	Guid string `json:"guid,omitempty"`
	// True if this container is a masked container.
	Masked *bool `json:"masked,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Native operating system of the original database source system.
	Os string `json:"os,omitempty"`
	// Whether to enable high performance mode.
	// enum = [TEMPORARILY_ENABLED ENABLED DISABLED]
	// default = DISABLED
	// create = readonly
	// update = readonly
	PerformanceMode string `json:"performanceMode,omitempty"`
	// A reference to the previous TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	PreviousTimeflow string `json:"previousTimeflow,omitempty"`
	// Native processor type of the original database source system.
	Processor string `json:"processor,omitempty"`
	// A reference to the container this container was provisioned from.
	// format = objectReference
	// referenceTo = /delphix-container.json
	ProvisionContainer string `json:"provisionContainer,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this container.
	Runtime *AppDataContainerRuntimeStruct `json:"runtime,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	// update = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// The toolkit managing the data in the container.
	// referenceTo = /delphix-toolkit.json
	Toolkit string `json:"toolkit,omitempty"`
	// True if this container is a transformation container.
	Transformation *bool `json:"transformation,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataContainerStruct - Data container for AppData. extends DatabaseContainer

func AppDataContainerFactory 

func AppDataContainerFactory(
	CreationTime string,
	CurrentTimeflow string,
	Description string,
	Group string,
	Guid string,
	Masked *bool,
	Name string,
	Namespace string,
	Os string,
	PreviousTimeflow string,
	Processor string,
	ProvisionContainer string,
	Reference string,
	Runtime *AppDataContainerRuntimeStruct,
	SourcingPolicy *SourcingPolicyStruct,
	Toolkit string,
	Transformation *bool,
) AppDataContainerStruct

AppDataContainerFactory is just a simple function to instantiate the AppDataContainerStruct

type AppDataCreateTransformationParametersStruct 

type AppDataCreateTransformationParametersStruct struct {
	// The container that will contain the transformed data associated
	// with the newly created transformation; the "transformation
	// container".
	// create = required
	Container *AppDataContainerStruct `json:"container,omitempty"`
	// Reference to the user used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Operations to perform when this transformation is applied.
	// create = required
	Operations []SourceOperation `json:"operations,omitempty"`
	// The JSON payload conforming to the DraftV4 schema based on the
	// type of application data being manipulated.
	// create = required
	Payload *JsonStruct `json:"payload,omitempty"`
	// Reference to the repository used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	// create = required
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataCreateTransformationParametersStruct - Represents the parameters of a createTransformation request for an AppData container. extends CreateTransformationParameters

func AppDataCreateTransformationParametersFactory 

func AppDataCreateTransformationParametersFactory(
	Container *AppDataContainerStruct,
	EnvironmentUser string,
	Operations []SourceOperation,
	Payload *JsonStruct,
	Repository string,
) AppDataCreateTransformationParametersStruct

AppDataCreateTransformationParametersFactory is just a simple function to instantiate the AppDataCreateTransformationParametersStruct

type AppDataDirectLinkDataStruct 

type AppDataDirectLinkDataStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-appdata-direct-source-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The OS user to use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// List of subdirectories in the source to exclude when syncing data.
	// These paths are relative to the root of the source directory.
	// create = optional
	Excludes []string `json:"excludes,omitempty"`
	// List of symlinks in the source to follow when syncing data. These
	// paths are relative to the root of the source directory. All other
	// symlinks are preserved.
	// create = optional
	FollowSymlinks []string `json:"followSymlinks,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The JSON payload conforming to the DraftV4 schema based on the
	// type of application data being manipulated.
	// required = true
	Parameters *JsonStruct `json:"parameters,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataDirectLinkDataStruct - Represents the AppData specific parameters of a link request for a source directly replicated into the Delphix Engine. extends AppDataLinkData

func AppDataDirectLinkDataFactory 

func AppDataDirectLinkDataFactory(
	Config string,
	EnvironmentUser string,
	Excludes []string,
	FollowSymlinks []string,
	Operations *LinkedSourceOperationsStruct,
	Parameters *JsonStruct,
	SourcingPolicy *SourcingPolicyStruct,
) AppDataDirectLinkDataStruct

AppDataDirectLinkDataFactory is just a simple function to instantiate the AppDataDirectLinkDataStruct

type AppDataDirectSourceConfigStruct 

type AppDataDirectSourceConfigStruct struct {
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// create = optional
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// The name of the config.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The list of parameters specified by the source config schema in
	// the toolkit. If no schema is specified, this list is empty.
	// create = optional
	// update = optional
	Parameters *JsonStruct `json:"parameters,omitempty"`
	// The path to the data to be synced.
	// create = optional
	// update = optional
	// maxLength = 1024
	Path string `json:"path,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-appdata-source-repository.json
	// create = required
	Repository string `json:"repository,omitempty"`
	// The toolkit associated with this source config.
	// format = objectReference
	// referenceTo = /delphix-toolkit.json
	Toolkit string `json:"toolkit,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

AppDataDirectSourceConfigStruct - Source config for directly linked AppData sources. extends AppDataSourceConfig

func AppDataDirectSourceConfigFactory 

func AppDataDirectSourceConfigFactory(
	Discovered *bool,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	Parameters *JsonStruct,
	Path string,
	Reference string,
	Repository string,
	Toolkit string,
) AppDataDirectSourceConfigStruct

AppDataDirectSourceConfigFactory is just a simple function to instantiate the AppDataDirectSourceConfigStruct

type AppDataEmptyVFilesCreationParametersStruct 

type AppDataEmptyVFilesCreationParametersStruct struct {
	// The new container for the created dataset.
	// required = true
	Container *AppDataContainerStruct `json:"container,omitempty"`
	// The source that describes an external dataset instance.
	// required = true
	Source *AppDataVirtualSourceStruct `json:"source,omitempty"`
	// The source config including dynamically discovered attributes of
	// the source.
	// required = true
	SourceConfig AppDataSourceConfig `json:"sourceConfig,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

AppDataEmptyVFilesCreationParametersStruct - The parameters to use as input when creating a new empty vFiles dataset. extends EmptyDatasetCreationParameters

func AppDataEmptyVFilesCreationParametersFactory 

func AppDataEmptyVFilesCreationParametersFactory(
	Container *AppDataContainerStruct,
	Source *AppDataVirtualSourceStruct,
	SourceConfig AppDataSourceConfig,
) AppDataEmptyVFilesCreationParametersStruct

AppDataEmptyVFilesCreationParametersFactory is just a simple function to instantiate the AppDataEmptyVFilesCreationParametersStruct

type AppDataExportParametersStruct 

type AppDataExportParametersStruct struct {
	// The filesystem configuration of the exported database.
	// create = optional
	FilesystemLayout *AppDataFilesystemLayoutStruct `json:"filesystemLayout,omitempty"`
	// The source config to use when creating the exported DB.
	// required = true
	SourceConfig AppDataSourceConfig `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base export
	// on.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataExportParametersStruct - The parameters to use as input to export AppData. extends ExportParameters

func AppDataExportParametersFactory 

func AppDataExportParametersFactory(
	FilesystemLayout *AppDataFilesystemLayoutStruct,
	SourceConfig AppDataSourceConfig,
	TimeflowPointParameters TimeflowPointParameters,
) AppDataExportParametersStruct

AppDataExportParametersFactory is just a simple function to instantiate the AppDataExportParametersStruct

type AppDataFilesystemLayoutStruct 

type AppDataFilesystemLayoutStruct struct {
	// The base directory to use for the exported database.
	// required = true
	TargetDirectory string `json:"targetDirectory,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataFilesystemLayoutStruct - A filesystem layout that matches the filesystem of a Delphix TimeFlow. extends FilesystemLayout

func AppDataFilesystemLayoutFactory 

func AppDataFilesystemLayoutFactory(
	TargetDirectory string,
) AppDataFilesystemLayoutStruct

AppDataFilesystemLayoutFactory is just a simple function to instantiate the AppDataFilesystemLayoutStruct

type AppDataLinkData 

type AppDataLinkData interface{}

AppDataLinkData is an empty interface designed to function as the AppDataLinkData API namespace

type AppDataLinkedDirectSourceStruct 

type AppDataLinkedDirectSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-appdata-source-config.json
	// create = required
	// update = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// referenceTo = /delphix-container.json
	// format = objectReference
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// List of subdirectories in the source to exclude when syncing data.
	// These paths are relative to the root of the source directory.
	// update = optional
	// create = optional
	Excludes []string `json:"excludes,omitempty"`
	// List of symlinks in the source to follow when syncing data. These
	// paths are relative to the root of the source directory. All other
	// symlinks are preserved.
	// create = optional
	// update = optional
	FollowSymlinks []string `json:"followSymlinks,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The JSON payload conforming to the DraftV4 schema based on the
	// type of application data being manipulated.
	// create = required
	// update = optional
	Parameters *JsonStruct `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *AppDataSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// The toolkit associated with this source.
	// format = objectReference
	// referenceTo = /delphix-toolkit.json
	Toolkit string `json:"toolkit,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

AppDataLinkedDirectSourceStruct - An AppData linked source directly replicated into the Delphix Engine. extends AppDataLinkedSource

func AppDataLinkedDirectSourceFactory 

func AppDataLinkedDirectSourceFactory(
	Config string,
	Container string,
	Description string,
	Excludes []string,
	FollowSymlinks []string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	Operations *LinkedSourceOperationsStruct,
	Parameters *JsonStruct,
	Reference string,
	Runtime *AppDataSourceRuntimeStruct,
	Staging *bool,
	Status string,
	Toolkit string,
	Virtual *bool,
) AppDataLinkedDirectSourceStruct

AppDataLinkedDirectSourceFactory is just a simple function to instantiate the AppDataLinkedDirectSourceStruct

type AppDataLinkedSource 

type AppDataLinkedSource interface{}

AppDataLinkedSource is an empty interface designed to function as the AppDataLinkedSource API namespace

type AppDataLinkedStagedSourceStruct 

type AppDataLinkedStagedSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-appdata-source-config.json
	// create = required
	// update = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The JSON payload conforming to the DraftV4 schema based on the
	// type of application data being manipulated.
	// create = required
	// update = optional
	Parameters *JsonStruct `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *AppDataSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// The environment used as an intermediate stage to pull data into
	// Delphix.
	// referenceTo = /delphix-source-environment.json
	// create = required
	// update = optional
	// format = objectReference
	StagingEnvironment string `json:"stagingEnvironment,omitempty"`
	// The environment user used to access the staging environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = required
	// update = optional
	StagingEnvironmentUser string `json:"stagingEnvironmentUser,omitempty"`
	// The base mount point for the NFS mount on the staging environment.
	// maxLength = 256
	// create = required
	// update = optional
	StagingMountBase string `json:"stagingMountBase,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// The toolkit associated with this source.
	// referenceTo = /delphix-toolkit.json
	// format = objectReference
	Toolkit string `json:"toolkit,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

AppDataLinkedStagedSourceStruct - An AppData linked source with a staging source. extends AppDataLinkedSource

func AppDataLinkedStagedSourceFactory 

func AppDataLinkedStagedSourceFactory(
	Config string,
	Container string,
	Description string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	Operations *LinkedSourceOperationsStruct,
	Parameters *JsonStruct,
	Reference string,
	Runtime *AppDataSourceRuntimeStruct,
	Staging *bool,
	StagingEnvironment string,
	StagingEnvironmentUser string,
	StagingMountBase string,
	Status string,
	Toolkit string,
	Virtual *bool,
) AppDataLinkedStagedSourceStruct

AppDataLinkedStagedSourceFactory is just a simple function to instantiate the AppDataLinkedStagedSourceStruct

type AppDataManagedSource 

type AppDataManagedSource interface{}

AppDataManagedSource is an empty interface designed to function as the AppDataManagedSource API namespace

type AppDataPlatformParametersStruct 

type AppDataPlatformParametersStruct struct {
	// The JSON payload conforming to the DraftV4 schema based on the
	// type of application data being manipulated.
	// create = required
	Payload *JsonStruct `json:"payload,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

AppDataPlatformParametersStruct - AppData platform-specific parameters that are stored on a transformation. extends BasePlatformParameters

func AppDataPlatformParametersFactory 

func AppDataPlatformParametersFactory(
	Payload *JsonStruct,
) AppDataPlatformParametersStruct

AppDataPlatformParametersFactory is just a simple function to instantiate the AppDataPlatformParametersStruct

type AppDataProvisionParametersStruct 

type AppDataProvisionParametersStruct struct {
	// The new container for the provisioned database.
	// required = true
	Container *AppDataContainerStruct `json:"container,omitempty"`
	// Whether or not to mark this VDB as a masked VDB. It will be marked
	// as masked if this flag or the masking job are set.
	// create = optional
	// update = readonly
	Masked *bool `json:"masked,omitempty"`
	// The Masking Job to be run when this dataset is provisioned or
	// refreshed.
	// update = readonly
	// format = objectReference
	// referenceTo = /delphix-masking-job.json
	// create = optional
	MaskingJob string `json:"maskingJob,omitempty"`
	// The source that describes an external database instance.
	// required = true
	Source *AppDataVirtualSourceStruct `json:"source,omitempty"`
	// The source config including dynamically discovered attributes of
	// the source.
	// required = true
	SourceConfig AppDataSourceConfig `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base
	// provisioning on.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataProvisionParametersStruct - The parameters to use as input to provision AppData. extends ProvisionParameters

func AppDataProvisionParametersFactory 

func AppDataProvisionParametersFactory(
	Container *AppDataContainerStruct,
	Masked *bool,
	MaskingJob string,
	Source *AppDataVirtualSourceStruct,
	SourceConfig AppDataSourceConfig,
	TimeflowPointParameters TimeflowPointParameters,
) AppDataProvisionParametersStruct

AppDataProvisionParametersFactory is just a simple function to instantiate the AppDataProvisionParametersStruct

type AppDataRepositoryStruct 

type AppDataRepositoryStruct struct {
	// Reference to the environment containing this repository.
	// referenceTo = /delphix-source-environment.json
	// create = required
	// format = objectReference
	Environment string `json:"environment,omitempty"`
	// Flag indicating whether the repository should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The list of parameters specified by the repository schema in the
	// toolkit. If no schema is specified, this list is empty.
	// create = required
	Parameters *JsonStruct `json:"parameters,omitempty"`
	// Flag indicating whether the repository should be used for
	// provisioning.
	// default = true
	// create = optional
	// update = optional
	ProvisioningEnabled *bool `json:"provisioningEnabled,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Flag indicating whether this repository can be used by the Delphix
	// Engine for internal processing.
	// update = optional
	// default = false
	// create = optional
	Staging *bool `json:"staging,omitempty"`
	// The toolkit associated with this repository.
	// format = objectReference
	// referenceTo = /delphix-toolkit.json
	// create = required
	// update = optional
	Toolkit string `json:"toolkit,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// Version of the repository.
	// create = optional
	// update = optional
	Version string `json:"version,omitempty"`
}

AppDataRepositoryStruct - An AppData repository. extends SourceRepository

func AppDataRepositoryFactory 

func AppDataRepositoryFactory(
	Environment string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	Parameters *JsonStruct,
	ProvisioningEnabled *bool,
	Reference string,
	Staging *bool,
	Toolkit string,
	Version string,
) AppDataRepositoryStruct

AppDataRepositoryFactory is just a simple function to instantiate the AppDataRepositoryStruct

type AppDataSnapshotRuntimeStruct 

type AppDataSnapshotRuntimeStruct struct {
	// True if this snapshot can be used as the basis for provisioning a
	// new TimeFlow.
	Provisionable *bool `json:"provisionable,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataSnapshotRuntimeStruct - Runtime (non-persistent) properties of AppData TimeFlow snapshots. extends SnapshotRuntime

func AppDataSnapshotRuntimeFactory 

func AppDataSnapshotRuntimeFactory(
	Provisionable *bool,
) AppDataSnapshotRuntimeStruct

AppDataSnapshotRuntimeFactory is just a simple function to instantiate the AppDataSnapshotRuntimeStruct

type AppDataSnapshotStruct 

type AppDataSnapshotStruct struct {
	// A value in the set {CONSISTENT, INCONSISTENT, CRASH_CONSISTENT}
	// indicating what type of recovery strategies must be invoked when
	// provisioning from this snapshot.
	Consistency string `json:"consistency,omitempty"`
	// Reference to the database of which this TimeFlow is a part.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Point in time at which this snapshot was created. This may be
	// different from the time corresponding to the TimeFlow.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// The location within the parent TimeFlow at which this snapshot was
	// initiated.
	FirstChangePoint *AppDataTimeflowPointStruct `json:"firstChangePoint,omitempty"`
	// The location of the snapshot within the parent TimeFlow
	// represented by this snapshot.
	LatestChangePoint *AppDataTimeflowPointStruct `json:"latestChangePoint,omitempty"`
	// The JSON payload conforming to the DraftV4 schema based on the
	// type of application data being manipulated.
	Metadata *JsonStruct `json:"metadata,omitempty"`
	// Boolean value indicating if a virtual database provisioned from
	// this snapshot will be missing nologging changes.
	MissingNonLoggedData *bool `json:"missingNonLoggedData,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Retention policy, in days. A value of -1 indicates the snapshot
	// should be kept forever.
	// update = optional
	Retention *int `json:"retention,omitempty"`
	// Runtime properties of the snapshot.
	Runtime *AppDataSnapshotRuntimeStruct `json:"runtime,omitempty"`
	// Boolean value indicating that this snapshot is in a transient
	// state and should not be user visible.
	Temporary *bool `json:"temporary,omitempty"`
	// TimeFlow of which this snapshot is a part.
	// referenceTo = /delphix-timeflow.json
	// format = objectReference
	Timeflow string `json:"timeflow,omitempty"`
	// Time zone of the source database at the time the snapshot was
	// taken.
	Timezone string `json:"timezone,omitempty"`
	// The toolkit associated with this snapshot.
	// format = objectReference
	// referenceTo = /delphix-toolkit.json
	Toolkit string `json:"toolkit,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of database source repository at the time the snapshot was
	// taken.
	Version string `json:"version,omitempty"`
}

AppDataSnapshotStruct - Snapshot of an AppData TimeFlow. extends TimeflowSnapshot

func AppDataSnapshotFactory 

func AppDataSnapshotFactory(
	Consistency string,
	Container string,
	CreationTime string,
	FirstChangePoint *AppDataTimeflowPointStruct,
	LatestChangePoint *AppDataTimeflowPointStruct,
	Metadata *JsonStruct,
	MissingNonLoggedData *bool,
	Name string,
	Namespace string,
	Reference string,
	Retention *int,
	Runtime *AppDataSnapshotRuntimeStruct,
	Temporary *bool,
	Timeflow string,
	Timezone string,
	Toolkit string,
	Version string,
) AppDataSnapshotStruct

AppDataSnapshotFactory is just a simple function to instantiate the AppDataSnapshotStruct

type AppDataSource 

type AppDataSource interface{}

AppDataSource is an empty interface designed to function as the AppDataSource API namespace

type AppDataSourceConfig 

type AppDataSourceConfig interface{}

AppDataSourceConfig is an empty interface designed to function as the AppDataSourceConfig API namespace

type AppDataSourceConnectionInfoStruct 

type AppDataSourceConnectionInfoStruct struct {
	// The hostname or IP address of the host where the source resides.
	Host string `json:"host,omitempty"`
	// The path where the application data is located on the host.
	Path string `json:"path,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The database version string.
	Version string `json:"version,omitempty"`
}

AppDataSourceConnectionInfoStruct - Contains information that can be used to connect to the application source. extends SourceConnectionInfo

func AppDataSourceConnectionInfoFactory 

func AppDataSourceConnectionInfoFactory(
	Host string,
	Path string,
	Version string,
) AppDataSourceConnectionInfoStruct

AppDataSourceConnectionInfoFactory is just a simple function to instantiate the AppDataSourceConnectionInfoStruct

type AppDataSourceRuntimeStruct 

type AppDataSourceRuntimeStruct struct {
	// True if the source is JDBC accessible. If false then no properties
	// can be retrieved.
	Accessible *bool `json:"accessible,omitempty"`
	// The time that the 'accessible' propery was last checked.
	// format = date
	AccessibleTimestamp string `json:"accessibleTimestamp,omitempty"`
	// Size of the database in bytes.
	// base = 1024
	// units = B
	DatabaseSize float64 `json:"databaseSize,omitempty"`
	// Status indicating whether the source is enabled. A source has a
	// 'PARTIAL' status if its sub-sources are not all enabled.
	// enum = [ENABLED PARTIAL DISABLED]
	Enabled string `json:"enabled,omitempty"`
	// The reason why the source is not JDBC accessible.
	NotAccessibleReason string `json:"notAccessibleReason,omitempty"`
	// Status of the source. 'Unknown' if all attempts to connect to the
	// source failed.
	// enum = [RUNNING INACTIVE PENDING CANCELED FAILED CHECKING UNKNOWN]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataSourceRuntimeStruct - Runtime (non-persistent) properties of an AppData source. extends SourceRuntime

func AppDataSourceRuntimeFactory 

func AppDataSourceRuntimeFactory(
	Accessible *bool,
	AccessibleTimestamp string,
	DatabaseSize float64,
	Enabled string,
	NotAccessibleReason string,
	Status string,
) AppDataSourceRuntimeStruct

AppDataSourceRuntimeFactory is just a simple function to instantiate the AppDataSourceRuntimeStruct

type AppDataStagedLinkDataStruct 

type AppDataStagedLinkDataStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-appdata-staged-source-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The OS user to use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The JSON payload conforming to the DraftV4 schema based on the
	// type of application data being manipulated.
	// required = true
	Parameters *JsonStruct `json:"parameters,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// The environment used as an intermediate stage to pull data into
	// Delphix.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// required = true
	StagingEnvironment string `json:"stagingEnvironment,omitempty"`
	// The environment user used to access the staging environment.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	StagingEnvironmentUser string `json:"stagingEnvironmentUser,omitempty"`
	// The base mount point for the NFS mount on the staging environment.
	// maxLength = 256
	// create = optional
	StagingMountBase string `json:"stagingMountBase,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataStagedLinkDataStruct - Represents the AppData specific parameters of a link request for a source with a staging source. extends AppDataLinkData

func AppDataStagedLinkDataFactory 

func AppDataStagedLinkDataFactory(
	Config string,
	EnvironmentUser string,
	Operations *LinkedSourceOperationsStruct,
	Parameters *JsonStruct,
	SourcingPolicy *SourcingPolicyStruct,
	StagingEnvironment string,
	StagingEnvironmentUser string,
	StagingMountBase string,
) AppDataStagedLinkDataStruct

AppDataStagedLinkDataFactory is just a simple function to instantiate the AppDataStagedLinkDataStruct

type AppDataStagedSourceConfigStruct 

type AppDataStagedSourceConfigStruct struct {
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// The name of the config.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The list of parameters specified by the source config schema in
	// the toolkit. If no schema is specified, this list is empty.
	// create = optional
	// update = optional
	Parameters *JsonStruct `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// format = objectReference
	// referenceTo = /delphix-appdata-source-repository.json
	// create = required
	// update = optional
	Repository string `json:"repository,omitempty"`
	// The toolkit associated with this source config.
	// format = objectReference
	// referenceTo = /delphix-toolkit.json
	Toolkit string `json:"toolkit,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataStagedSourceConfigStruct - An AppData source config with a staging source. extends AppDataSourceConfig

func AppDataStagedSourceConfigFactory 

func AppDataStagedSourceConfigFactory(
	Discovered *bool,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	Parameters *JsonStruct,
	Reference string,
	Repository string,
	Toolkit string,
) AppDataStagedSourceConfigStruct

AppDataStagedSourceConfigFactory is just a simple function to instantiate the AppDataStagedSourceConfigStruct

type AppDataSyncParametersStruct 

type AppDataSyncParametersStruct struct {
	// Whether or not to force a non-incremental load of data prior to
	// taking a snapshot.
	// default = false
	Resync *bool `json:"resync,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataSyncParametersStruct - The parameters to use as input to sync an AppData source. extends SyncParameters

func AppDataSyncParametersFactory 

func AppDataSyncParametersFactory(
	Resync *bool,
) AppDataSyncParametersStruct

AppDataSyncParametersFactory is just a simple function to instantiate the AppDataSyncParametersStruct

type AppDataTimeflowPointStruct 

type AppDataTimeflowPointStruct struct {
	// The TimeFlow location.
	// create = optional
	Location string `json:"location,omitempty"`
	// Reference to TimeFlow containing this point.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// The logical time corresponding to the TimeFlow location.
	// format = date
	// create = optional
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataTimeflowPointStruct - A unique point within an AppData TimeFlow. extends TimeflowPoint

func AppDataTimeflowPointFactory 

func AppDataTimeflowPointFactory(
	Location string,
	Timeflow string,
	Timestamp string,
) AppDataTimeflowPointStruct

AppDataTimeflowPointFactory is just a simple function to instantiate the AppDataTimeflowPointStruct

type AppDataTimeflowStruct 

type AppDataTimeflowStruct struct {
	// Reference to the data container (database) for this TimeFlow.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// The source action that created the TimeFlow.
	// enum = [INITIAL INDETERMINATE REFRESH ROLLBACK TEMPORARY TRANSFORMATION V2P PDB_PLUG WAREHOUSE ORACLE_LIVE_SOURCE_RESYNC SOURCE_CONTINUITY]
	CreationType string `json:"creationType,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The origin point on the parent TimeFlow from which this TimeFlow
	// was provisioned. This will not be present for TimeFlows derived
	// from linked sources.
	ParentPoint *AppDataTimeflowPointStruct `json:"parentPoint,omitempty"`
	// Reference to the parent snapshot that serves as the provisioning
	// base for this object. This may be different from the snapshot
	// within the parent point, and is only present for virtual
	// TimeFlows.
	// format = objectReference
	// referenceTo = /delphix-timeflow-snapshot.json
	ParentSnapshot string `json:"parentSnapshot,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AppDataTimeflowStruct - TimeFlow representing historical data for a particular timeline within a data container. extends AppDataBaseTimeflow

func AppDataTimeflowFactory 

func AppDataTimeflowFactory(
	Container string,
	CreationType string,
	Name string,
	Namespace string,
	ParentPoint *AppDataTimeflowPointStruct,
	ParentSnapshot string,
	Reference string,
) AppDataTimeflowStruct

AppDataTimeflowFactory is just a simple function to instantiate the AppDataTimeflowStruct

type AppDataVirtualSourceStruct 

type AppDataVirtualSourceStruct struct {
	// Locations to mount subdirectories of the AppData in addition to
	// the normal target mount point. These paths will be mounted and
	// unmounted as part of enabling and disabling this source.
	// create = optional
	// update = optional
	AdditionalMountPoints []*AppDataAdditionalMountPointStruct `json:"additionalMountPoints,omitempty"`
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// update = optional
	// create = required
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// update = optional
	// create = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// The JSON payload conforming to the DraftV4 schema based on the
	// type of application data being manipulated.
	// create = required
	// update = optional
	Parameters *JsonStruct `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *AppDataSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// The toolkit associated with this source.
	// format = objectReference
	// referenceTo = /delphix-toolkit.json
	Toolkit string `json:"toolkit,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

AppDataVirtualSourceStruct - A virtual AppData source. extends AppDataManagedSource

func AppDataVirtualSourceFactory 

func AppDataVirtualSourceFactory(
	AdditionalMountPoints []*AppDataAdditionalMountPointStruct,
	AllowAutoVDBRestartOnHostReboot *bool,
	Config string,
	Container string,
	Description string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	Operations *VirtualSourceOperationsStruct,
	Parameters *JsonStruct,
	Reference string,
	Runtime *AppDataSourceRuntimeStruct,
	Staging *bool,
	Status string,
	Toolkit string,
	Virtual *bool,
) AppDataVirtualSourceStruct

AppDataVirtualSourceFactory is just a simple function to instantiate the AppDataVirtualSourceStruct

type AppDataWindowsTimeflowStruct 

type AppDataWindowsTimeflowStruct struct {
	// Reference to the data container (database) for this TimeFlow.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// The source action that created the TimeFlow.
	// enum = [INITIAL INDETERMINATE REFRESH ROLLBACK TEMPORARY TRANSFORMATION V2P PDB_PLUG WAREHOUSE ORACLE_LIVE_SOURCE_RESYNC SOURCE_CONTINUITY]
	CreationType string `json:"creationType,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The origin point on the parent TimeFlow from which this TimeFlow
	// was provisioned. This will not be present for TimeFlows derived
	// from linked sources.
	ParentPoint *AppDataTimeflowPointStruct `json:"parentPoint,omitempty"`
	// Reference to the parent snapshot that serves as the provisioning
	// base for this object. This may be different from the snapshot
	// within the parent point, and is only present for virtual
	// TimeFlows.
	// format = objectReference
	// referenceTo = /delphix-timeflow-snapshot.json
	ParentSnapshot string `json:"parentSnapshot,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

AppDataWindowsTimeflowStruct - TimeFlow representing historical data for a particular timeline within a data container. extends AppDataBaseTimeflow

func AppDataWindowsTimeflowFactory 

func AppDataWindowsTimeflowFactory(
	Container string,
	CreationType string,
	Name string,
	Namespace string,
	ParentPoint *AppDataTimeflowPointStruct,
	ParentSnapshot string,
	Reference string,
) AppDataWindowsTimeflowStruct

AppDataWindowsTimeflowFactory is just a simple function to instantiate the AppDataWindowsTimeflowStruct

type ApplyVersionParametersStruct 

type ApplyVersionParametersStruct struct {
	// If true, the Delphix Engine is upgraded without updating the OS
	// software. The operation will fail gracefully if the upgrade
	// version requires a version of the OS that is newer than what is
	// currently running. The OS software can subsequently be upgraded by
	// applying any version and setting defer to false. It is possible to
	// catch up to the current OS version on a previously deferred
	// upgrade by re-applying the running version with a defer setting of
	// false.
	// create = optional
	// default = false
	Defer *bool `json:"defer,omitempty"`
	// This property governs whether or not data sources are re-enabled
	// or left disabled in the event that upgrade fails before the
	// Delphix Engine is restarted.
	// default = true
	// create = optional
	EnableSourcesOnFailure *bool `json:"enableSourcesOnFailure,omitempty"`
	// If true, a failure to quiesce sources will not block the upgrade.
	// create = optional
	// default = false
	IgnoreQuiesceSourcesFailures *bool `json:"ignoreQuiesceSourcesFailures,omitempty"`
	// If true, all data sources (VDBs and dSources) are automatically
	// disabled prior to upgrade, and re-enabled after upgrade. If any
	// source cannot be disabled, the recovery semantics are governed by
	// the "ignoreQuiesceSourcesFailures" and "enableSourcesOnFailure"
	// properties.
	// create = optional
	// default = true
	QuiesceSources *bool `json:"quiesceSources,omitempty"`
	// If true, the system reboots immediately after upgrade. If false,
	// the system is shutdown.
	// create = optional
	// default = true
	Reboot *bool `json:"reboot,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// If set to false, disables verification before applying the
	// upgrade. This will only disable verification if a successful
	// verification has been run in the past hour.
	// create = optional
	// default = true
	Verify *bool `json:"verify,omitempty"`
}

ApplyVersionParametersStruct - The parameters to use as input to upgrade. extends TypedObject

func ApplyVersionParametersFactory 

func ApplyVersionParametersFactory(
	Defer *bool,
	EnableSourcesOnFailure *bool,
	IgnoreQuiesceSourcesFailures *bool,
	QuiesceSources *bool,
	Reboot *bool,
	Verify *bool,
) ApplyVersionParametersStruct

ApplyVersionParametersFactory is just a simple function to instantiate the ApplyVersionParametersStruct

type AttachData 

type AttachData interface{}

AttachData is an empty interface designed to function as the AttachData API namespace

type AttachSourceParametersStruct 

type AttachSourceParametersStruct struct {
	// The database-specific parameters of an attach request.
	// required = true
	AttachData AttachData `json:"attachData,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AttachSourceParametersStruct - Represents the parameters of an attach request. extends TypedObject

func AttachSourceParametersFactory 

func AttachSourceParametersFactory(
	AttachData AttachData,
) AttachSourceParametersStruct

AttachSourceParametersFactory is just a simple function to instantiate the AttachSourceParametersStruct

type AuthFilterParametersStruct 

type AuthFilterParametersStruct struct {
	// The object type on which to perform filtering. This option is
	// mutually exclusive with the "objects" field.
	// format = type
	ObjectType string `json:"objectType,omitempty"`
	// The list of objects to filter. This option is mutually exclusive
	// with the "objectType" field.
	Objects []string `json:"objects,omitempty"`
	// The permission to filter by.
	// format = objectReference
	// referenceTo = /delphix-permission.json
	Permission string `json:"permission,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AuthFilterParametersStruct - The parameters to use as input to filter a list of objects or object type by a permission. extends TypedObject

func AuthFilterParametersFactory 

func AuthFilterParametersFactory(
	ObjectType string,
	Objects []string,
	Permission string,
) AuthFilterParametersStruct

AuthFilterParametersFactory is just a simple function to instantiate the AuthFilterParametersStruct

type AuthFilterResultStruct 

type AuthFilterResultStruct struct {
	// The list of objects that have been filtered.
	Objects []string `json:"objects,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AuthFilterResultStruct - Result of an auth filter request. extends TypedObject

func AuthFilterResultFactory 

func AuthFilterResultFactory(
	Objects []string,
) AuthFilterResultStruct

AuthFilterResultFactory is just a simple function to instantiate the AuthFilterResultStruct

type AuthGetByPropertiesParametersStruct 

type AuthGetByPropertiesParametersStruct struct {
	// The role type authorizations are applied to.
	// format = objectReference
	// required = true
	// referenceTo = /delphix-role.json
	Role string `json:"role,omitempty"`
	// The target authorizations are applied to.
	// format = objectReference
	// required = true
	// referenceTo = /delphix-user-object.json
	Target string `json:"target,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The user authorizations are applied to.
	// required = true
	// referenceTo = /delphix-user.json
	// format = objectReference
	User string `json:"user,omitempty"`
}

AuthGetByPropertiesParametersStruct - The parameters to use as input to get an authorization with given user, target, and role. extends TypedObject

func AuthGetByPropertiesParametersFactory 

func AuthGetByPropertiesParametersFactory(
	Role string,
	Target string,
	User string,
) AuthGetByPropertiesParametersStruct

AuthGetByPropertiesParametersFactory is just a simple function to instantiate the AuthGetByPropertiesParametersStruct

type AuthSuccess 

type AuthSuccess struct {
	ID, Message string
}

AuthSuccess holds the resty response success message

type AuthorizationConfigStruct 

type AuthorizationConfigStruct struct {
	// Whether authorization checks are enabled for all environment and
	// host operations.
	// update = optional
	// default = false
	EnvironmentAndHostAuth *bool `json:"environmentAndHostAuth,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

AuthorizationConfigStruct - Configuration of the Authorization System. extends TypedObject cliVisibility = [DOMAIN]

func AuthorizationConfigFactory 

func AuthorizationConfigFactory(
	EnvironmentAndHostAuth *bool,
) AuthorizationConfigStruct

AuthorizationConfigFactory is just a simple function to instantiate the AuthorizationConfigStruct

type AuthorizationStruct 

type AuthorizationStruct struct {
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Applied role.
	// format = objectReference
	// create = required
	// referenceTo = /delphix-role.json
	Role string `json:"role,omitempty"`
	// Reference to the object that the authorization applies to.
	// format = objectReference
	// referenceTo = /delphix-user-object.json
	// create = required
	Target string `json:"target,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Reference to the user that the authorization applies to.
	// format = objectReference
	// create = required
	// referenceTo = /delphix-user.json
	User string `json:"user,omitempty"`
}

AuthorizationStruct - Describes a role as applied to a user on an object. extends ReadonlyNamedUserObject

func AuthorizationFactory 

func AuthorizationFactory(
	Name string,
	Namespace string,
	Reference string,
	Role string,
	Target string,
	User string,
) AuthorizationStruct

AuthorizationFactory is just a simple function to instantiate the AuthorizationStruct

type AxisConstraint 

type AxisConstraint interface{}

AxisConstraint is an empty interface designed to function as the AxisConstraint API namespace

type BaseConsumerCapacityData 

type BaseConsumerCapacityData interface{}

BaseConsumerCapacityData is an empty interface designed to function as the BaseConsumerCapacityData API namespace

type BaseGroupCapacityData 

type BaseGroupCapacityData interface{}

BaseGroupCapacityData is an empty interface designed to function as the BaseGroupCapacityData API namespace

type BasePlatformParameters 

type BasePlatformParameters interface{}

BasePlatformParameters is an empty interface designed to function as the BasePlatformParameters API namespace

type BaseSupportBundleParameters 

type BaseSupportBundleParameters interface{}

BaseSupportBundleParameters is an empty interface designed to function as the BaseSupportBundleParameters API namespace

type BaseSystemCapacityData 

type BaseSystemCapacityData interface{}

BaseSystemCapacityData is an empty interface designed to function as the BaseSystemCapacityData API namespace

type BatchContainerDeleteParametersStruct 

type BatchContainerDeleteParametersStruct struct {
	// Containers to delete.
	// minItems = 1
	// required = true
	Containers []string `json:"containers,omitempty"`
	// Optional parameters to the delete operations.
	// required = false
	DeleteParameters *DeleteParametersStruct `json:"deleteParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

BatchContainerDeleteParametersStruct - The parameters to use as input to batch container delete requests. extends TypedObject

func BatchContainerDeleteParametersFactory 

func BatchContainerDeleteParametersFactory(
	Containers []string,
	DeleteParameters *DeleteParametersStruct,
) BatchContainerDeleteParametersStruct

BatchContainerDeleteParametersFactory is just a simple function to instantiate the BatchContainerDeleteParametersStruct

type BatchContainerRefreshParametersStruct 

type BatchContainerRefreshParametersStruct struct {
	// Containers to refresh.
	// minItems = 1
	// required = true
	Containers []string `json:"containers,omitempty"`
	// A semantic description of a TimeFlow location.
	// default = LATEST_POINT
	// required = false
	// enum = [LATEST_POINT LATEST_SNAPSHOT]
	Location string `json:"location,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

BatchContainerRefreshParametersStruct - The parameters to use as input to batch container refresh requests. extends TypedObject

func BatchContainerRefreshParametersFactory 

func BatchContainerRefreshParametersFactory(
	Containers []string,
	Location string,
) BatchContainerRefreshParametersStruct

BatchContainerRefreshParametersFactory is just a simple function to instantiate the BatchContainerRefreshParametersStruct

type BatchSnapshotDeleteParametersStruct 

type BatchSnapshotDeleteParametersStruct struct {
	// TimeFlow snapshots to delete.
	// minItems = 1
	// required = true
	Snapshots []string `json:"snapshots,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

BatchSnapshotDeleteParametersStruct - The parameters to use as input to TimeFlow snapshots batch delete requests. extends TypedObject

func BatchSnapshotDeleteParametersFactory 

func BatchSnapshotDeleteParametersFactory(
	Snapshots []string,
) BatchSnapshotDeleteParametersStruct

BatchSnapshotDeleteParametersFactory is just a simple function to instantiate the BatchSnapshotDeleteParametersStruct

type BooleanConstraint 

type BooleanConstraint interface{}

BooleanConstraint is an empty interface designed to function as the BooleanConstraint API namespace

type BooleanEqualConstraintStruct 

type BooleanEqualConstraintStruct struct {
	// The name of the axis being constrained.
	// create = required
	AxisName string `json:"axisName,omitempty"`
	// The axis values must be equal to the boolean argument.
	// create = required
	Equals *bool `json:"equals,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

BooleanEqualConstraintStruct - Constraints placed on a boolean axis of a particular analytics slice. extends BooleanConstraint

func BooleanEqualConstraintFactory 

func BooleanEqualConstraintFactory(
	AxisName string,
	Equals *bool,
) BooleanEqualConstraintStruct

BooleanEqualConstraintFactory is just a simple function to instantiate the BooleanEqualConstraintStruct

type CPUInfoStruct 

type CPUInfoStruct struct {
	// Number of cores in the processor.
	Cores *int `json:"cores,omitempty"`
	// Speed of the processor, in hertz.
	// units = Hz
	// base = 1000
	Speed float64 `json:"speed,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CPUInfoStruct - Describes a processor available to the system. extends TypedObject

func CPUInfoFactory 

func CPUInfoFactory(
	Cores *int,
	Speed float64,
) CPUInfoStruct

CPUInfoFactory is just a simple function to instantiate the CPUInfoStruct

type CaCertificateStruct 

type CaCertificateStruct struct {
	// Delphix trusts this certificate .
	Accepted *bool `json:"accepted,omitempty"`
	// Issuer of this certificate.
	IssuedByDN string `json:"issuedByDN,omitempty"`
	// A reference to the certificate that issued this certificate. Null
	// if this is a root CA.
	// format = objectReference
	// referenceTo = /delphix-ca-certificate.json
	Issuer string `json:"issuer,omitempty"`
	// MD5 fingerprint.
	Md5Fingerprint string `json:"md5Fingerprint,omitempty"`
	// The Distinguished Name of this certificate.
	// format = objectName
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// End of validity.
	// format = date
	NotAfter string `json:"notAfter,omitempty"`
	// Start of validity.
	// format = date
	NotBefore string `json:"notBefore,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Certificate serial number.
	SerialNumber string `json:"serialNumber,omitempty"`
	// SHA-1 fingerprint.
	Sha1Fingerprint string `json:"sha1Fingerprint,omitempty"`
	// The subject alternative names associated with this certificate.
	SubjectAlternativeNames []string `json:"subjectAlternativeNames,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CaCertificateStruct - Public Key Certificate that is a Certificate Authority. extends Certificate cliVisibility = [SYSTEM DOMAIN]

func CaCertificateFactory 

func CaCertificateFactory(
	Accepted *bool,
	IssuedByDN string,
	Issuer string,
	Md5Fingerprint string,
	Name string,
	Namespace string,
	NotAfter string,
	NotBefore string,
	Reference string,
	SerialNumber string,
	Sha1Fingerprint string,
	SubjectAlternativeNames []string,
) CaCertificateStruct

CaCertificateFactory is just a simple function to instantiate the CaCertificateStruct

type CallResult 

type CallResult interface{}

CallResult is an empty interface designed to function as the CallResult API namespace

type CapacityBreakdownStruct 

type CapacityBreakdownStruct struct {
	// Amount of space used for the active copy of the container.
	// units = B
	// base = 1024
	ActiveSpace float64 `json:"activeSpace,omitempty"`
	// Actual space used by the container.
	// units = B
	// base = 1024
	ActualSpace float64 `json:"actualSpace,omitempty"`
	// Amount of space used for snapshots from which VDBs have been
	// provisioned.
	// units = B
	// base = 1024
	DescendantSpace float64 `json:"descendantSpace,omitempty"`
	// Amount of space used by logs.
	// units = B
	// base = 1024
	LogSpace float64 `json:"logSpace,omitempty"`
	// Amount of space used for snapshots held by manual retention
	// settings.
	// units = B
	// base = 1024
	ManualSpace float64 `json:"manualSpace,omitempty"`
	// Amount of space used for snapshots held by policy settings.
	// base = 1024
	// units = B
	PolicySpace float64 `json:"policySpace,omitempty"`
	// Amount of space used by snapshots.
	// base = 1024
	// units = B
	SyncSpace float64 `json:"syncSpace,omitempty"`
	// Unvirtualized space used by the TimeFlow.
	// units = B
	// base = 1024
	TimeflowUnvirtualizedSpace float64 `json:"timeflowUnvirtualizedSpace,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Amount of space used for snapshots part of held space.
	// base = 1024
	// units = B
	UnownedSnapshotSpace float64 `json:"unownedSnapshotSpace,omitempty"`
	// Unvirtualized space used by the container.
	// units = B
	// base = 1024
	UnvirtualizedSpace float64 `json:"unvirtualizedSpace,omitempty"`
}

CapacityBreakdownStruct - Storage stats breakdown. extends TypedObject

func CapacityBreakdownFactory 

func CapacityBreakdownFactory(
	ActiveSpace float64,
	ActualSpace float64,
	DescendantSpace float64,
	LogSpace float64,
	ManualSpace float64,
	PolicySpace float64,
	SyncSpace float64,
	TimeflowUnvirtualizedSpace float64,
	UnownedSnapshotSpace float64,
	UnvirtualizedSpace float64,
) CapacityBreakdownStruct

CapacityBreakdownFactory is just a simple function to instantiate the CapacityBreakdownStruct

type Certificate 

type Certificate interface{}

Certificate is an empty interface designed to function as the Certificate API namespace

type CertificateConfigStruct 

type CertificateConfigStruct struct {
	// A critical fault will be thrown if any end entity certificates
	// will expire within this duration (in days). Must be less than the
	// warning threshold.
	// minimum = 1
	// update = optional
	CertificateExpirationCriticalThreshold *int `json:"certificateExpirationCriticalThreshold,omitempty"`
	// A warning fault will be thrown if any end entity certificates will
	// expire within this duration (in days). Must be greater than the
	// critical threshold.
	// minimum = 2
	// update = optional
	CertificateExpirationWarningThreshold *int `json:"certificateExpirationWarningThreshold,omitempty"`
	// Whether or not the engine will use the user managed DSP key for
	// client authentication for engine to host apps. This will use the
	// user managed DSP key on the host environment. Requires server auth
	// to be enabled, and a stack restart to take effect.
	// update = optional
	EnableUserManagedClientAuthForEngineToHostDsp *bool `json:"enableUserManagedClientAuthForEngineToHostDsp,omitempty"`
	// Whether or not the engine will use the user managed DSP key for
	// client authentication during network throughput tests. This will
	// use the user managed DSP key on the host environment or source
	// Delphix Engine, depending on if an engine to host, or engine to
	// engine test is executed, respectively. Requires server auth to be
	// enabled, and a stack restart to take effect. Note that if doing an
	// engine to engine test, this flag will need to be true for the
	// other Delphix Engine too.
	// update = optional
	EnableUserManagedClientAuthForNetworkThroughputTests *bool `json:"enableUserManagedClientAuthForNetworkThroughputTests,omitempty"`
	// Whether or not the engine will use the user managed DSP key for
	// client authentication during replication. This will use the user
	// managed DSP key on the source Delphix Engine. Requires server auth
	// to be enabled, and a stack restart to take effect. Note that this
	// flag will need to be true for the other Delphix Engine too.
	// update = optional
	EnableUserManagedClientAuthForReplication *bool `json:"enableUserManagedClientAuthForReplication,omitempty"`
	// Whether or not the engine will use the user managed DSP key for
	// server authentication for engine to host apps. Requires a stack
	// restart to take effect.
	// update = optional
	EnableUserManagedServerAuthForEngineToHostDsp *bool `json:"enableUserManagedServerAuthForEngineToHostDsp,omitempty"`
	// Whether or not the engine will use the user managed DSP key for
	// server authentication during network throughput tests. Requires a
	// stack restart to take effect. Note that if doing an engine to
	// engine test, this flag will need to be true for the other Delphix
	// Engine too.
	// update = optional
	EnableUserManagedServerAuthForNetworkThroughputTests *bool `json:"enableUserManagedServerAuthForNetworkThroughputTests,omitempty"`
	// Whether or not the engine will use the user managed DSP key for
	// server authentication during replication. Requires a stack restart
	// to take effect. Note that this flag will need to be true for the
	// other engine too.
	// update = optional
	EnableUserManagedServerAuthForReplication *bool `json:"enableUserManagedServerAuthForReplication,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Whether or not the engine will validate custom Windows Connector
	// certificates.
	// update = optional
	ValidateWindowsConnectorCertificate *bool `json:"validateWindowsConnectorCertificate,omitempty"`
}

CertificateConfigStruct - Configuration for the use of custom CA signed certificates. extends TypedObject cliVisibility = [SYSTEM DOMAIN]

func CertificateConfigFactory 

func CertificateConfigFactory(
	CertificateExpirationCriticalThreshold *int,
	CertificateExpirationWarningThreshold *int,
	EnableUserManagedClientAuthForEngineToHostDsp *bool,
	EnableUserManagedClientAuthForNetworkThroughputTests *bool,
	EnableUserManagedClientAuthForReplication *bool,
	EnableUserManagedServerAuthForEngineToHostDsp *bool,
	EnableUserManagedServerAuthForNetworkThroughputTests *bool,
	EnableUserManagedServerAuthForReplication *bool,
	ValidateWindowsConnectorCertificate *bool,
) CertificateConfigStruct

CertificateConfigFactory is just a simple function to instantiate the CertificateConfigStruct

type CertificateFetchParametersStruct 

type CertificateFetchParametersStruct struct {
	// Hostname or IP address.
	// format = host
	// required = true
	Host string `json:"host,omitempty"`
	// Port number.
	// minimum = 1
	// maximum = 65535
	// required = true
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CertificateFetchParametersStruct - Parameters for fetching a certificate. extends TypedObject

func CertificateFetchParametersFactory 

func CertificateFetchParametersFactory(
	Host string,
	Port *int,
) CertificateFetchParametersStruct

CertificateFetchParametersFactory is just a simple function to instantiate the CertificateFetchParametersStruct

type CertificateSigningRequestCreateParametersStruct 

type CertificateSigningRequestCreateParametersStruct struct {
	// The Distinguished Name to use.
	// create = required
	Dname X500DistinguishedName `json:"dname,omitempty"`
	// The specific TLS service to generate the CSR for.
	// create = required
	// properties = map[type:map[default:EndEntityHttps]]
	EndEntity EndEntity `json:"endEntity,omitempty"`
	// Force replace the active keypair and certificate with this newly
	// generated one.
	// default = false
	// create = required
	ForceReplace *bool `json:"forceReplace,omitempty"`
	// The backing key pair and signature algorithm it will use.
	// create = required
	// properties = map[type:map[default:RsaKeyPair]]
	KeyPair KeyPair `json:"keyPair,omitempty"`
	// The subject alternative names associated with this certificate.
	// create = optional
	SubjectAlternativeNames []string `json:"subjectAlternativeNames,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

CertificateSigningRequestCreateParametersStruct - The parameters used to create a certificate signing request (CSR). extends TypedObject

func CertificateSigningRequestCreateParametersFactory 

func CertificateSigningRequestCreateParametersFactory(
	Dname X500DistinguishedName,
	EndEntity EndEntity,
	ForceReplace *bool,
	KeyPair KeyPair,
	SubjectAlternativeNames []string,
) CertificateSigningRequestCreateParametersStruct

CertificateSigningRequestCreateParametersFactory is just a simple function to instantiate the CertificateSigningRequestCreateParametersStruct

type CertificateSigningRequestStruct 

type CertificateSigningRequestStruct struct {
	// The specific TLS service this CSR was generated for.
	EndEntity EndEntity `json:"endEntity,omitempty"`
	// The backing key pair and signature algorithm it will use.
	KeyPair KeyPair `json:"keyPair,omitempty"`
	// The Distinguished Name.
	// format = objectName
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// The CSR in PEM format.
	RequestInPem string `json:"requestInPem,omitempty"`
	// The subject alternative names associated with this certificate.
	SubjectAlternativeNames []string `json:"subjectAlternativeNames,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CertificateSigningRequestStruct - Certificate signing request (CSR). extends UserObject cliVisibility = [SYSTEM DOMAIN]

func CertificateSigningRequestFactory 

func CertificateSigningRequestFactory(
	EndEntity EndEntity,
	KeyPair KeyPair,
	Name string,
	Namespace string,
	Reference string,
	RequestInPem string,
	SubjectAlternativeNames []string,
) CertificateSigningRequestStruct

CertificateSigningRequestFactory is just a simple function to instantiate the CertificateSigningRequestStruct

type CertificateUploadParametersStruct 

type CertificateUploadParametersStruct struct {
	// The lowercase alias for the certificate and key pair to use.
	// required = true
	Alias string `json:"alias,omitempty"`
	// The password for the key pair. If not provided, then the storepass
	// is used.
	// format = password
	Keypass string `json:"keypass,omitempty"`
	// The format of the keystore.
	// enum = [JKS PKCS12]
	// default = JKS
	// required = true
	KeystoreType string `json:"keystoreType,omitempty"`
	// The password for the keystore.
	// format = password
	// required = true
	Storepass string `json:"storepass,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

CertificateUploadParametersStruct - The parameters for uploading a keystore which include the credentials needed to access it. extends TypedObject

func CertificateUploadParametersFactory 

func CertificateUploadParametersFactory(
	Alias string,
	Keypass string,
	KeystoreType string,
	Storepass string,
) CertificateUploadParametersStruct

CertificateUploadParametersFactory is just a simple function to instantiate the CertificateUploadParametersStruct

type ChangeCurrentPasswordPolicyParametersStruct 

type ChangeCurrentPasswordPolicyParametersStruct struct {
	// Password policy reference.
	// format = objectReference
	// referenceTo = /delphix-password-policy.json
	// required = true
	CurrentPasswordPolicy string `json:"currentPasswordPolicy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Type of user.
	// required = true
	// enum = [SYSTEM DOMAIN]
	UserType string `json:"userType,omitempty"`
}

ChangeCurrentPasswordPolicyParametersStruct - The parameters to use as input when changing the currently active password policy. extends TypedObject

func ChangeCurrentPasswordPolicyParametersFactory 

func ChangeCurrentPasswordPolicyParametersFactory(
	CurrentPasswordPolicy string,
	UserType string,
) ChangeCurrentPasswordPolicyParametersStruct

ChangeCurrentPasswordPolicyParametersFactory is just a simple function to instantiate the ChangeCurrentPasswordPolicyParametersStruct

type ChecklistItemDetailStruct 

type ChecklistItemDetailStruct struct {
	// Description of this status item.
	Description string `json:"description,omitempty"`
	// Status message, if applicable.
	Message string `json:"message,omitempty"`
	// The status item name.
	Name string `json:"name,omitempty"`
	// Status of this item.
	// enum = [SUCCESS WARNING ERROR]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ChecklistItemDetailStruct - Fields to indicate detailed status for a specific checklist item. extends ChecklistItem

func ChecklistItemDetailFactory 

func ChecklistItemDetailFactory(
	Description string,
	Message string,
	Name string,
	Status string,
) ChecklistItemDetailStruct

ChecklistItemDetailFactory is just a simple function to instantiate the ChecklistItemDetailStruct

type ChecklistItemStruct 

type ChecklistItemStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ChecklistItemStruct - Generic checklist item. extends TypedObject

func ChecklistItemFactory 

func ChecklistItemFactory() ChecklistItemStruct

ChecklistItemFactory is just a simple function to instantiate the ChecklistItemStruct

type ChecklistStruct 

type ChecklistStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ChecklistStruct - Generic checklist object. extends TypedObject

func ChecklistFactory 

func ChecklistFactory() ChecklistStruct

ChecklistFactory is just a simple function to instantiate the ChecklistStruct

type Client 

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

Client the structure of a client request

func NewClient 

func NewClient(username, password, url string) *Client

NewClient creates a new client object

func (*Client) APISessionCreate 

func (c *Client) APISessionCreate(payload *APISessionStruct) (*APISessionStruct, error)

APISessionCreate - Create a new APISession object.

payload *APISessionStruct object return *APISessionStruct

func (*Client) APISessionRead 

func (c *Client) APISessionRead(r string) (*APISessionStruct, error)

APISessionRead - Returns the settings of the current session, if one has been started.

r - APISession Object Reference return *APISessionStruct

func (*Client) ActionList 

func (c *Client) ActionList(searchText string, fromDate string, toDate string, pageSize *int, user string, ascending *bool, sortBy string, pageOffset *int, state string, ignoreActionTypes []string, parentAction string, rootActionOnly *bool) ([]*ActionStruct, error)

ActionList - Retrieve an historical log of actions.

searchText ==> 

description: Limit search results to only include alerts that have searchText string in reference, state, title, details, failureDescription, parentAction, workSource or workSourceName.
type: string

fromDate ==> 

description: Start date for the search. Only actions on or after this date are included.
type: string
format: date

toDate ==> 

description: End date for the search. Only actions on or before this date are included.
type: string
format: date

pageSize ==> 

description: Limit the number of events returned.
type: integer
default: 25

user ==> 

referenceTo: /delphix-user.json
mapsTo: user
description: Limit actions to those initiated by this user.
type: string
format: objectReference

ascending ==> 

description: True if results are to be returned in ascending order.
type: boolean

sortBy ==> 

description: Search results are sorted by the field provided.
type: string
enum: [reference state title details startTime endTime failureDescription parentAction workSource workSourceName]

pageOffset ==> 

description: Offset within event list, in units of pageSize chunks.
type: integer

state ==> 

description: Limit actions to those in the specified state.
type: string
enum: [EXECUTING WAITING COMPLETED FAILED CANCELED]
mapsTo: state

ignoreActionTypes ==> 

type: array
items: map[type:string]
description: Ignore actions with an action type in this list.

parentAction ==> 

referenceTo: /delphix-action.json
mapsTo: parentAction
description: Limit actions to those with this parent action.
type: string
format: objectReference

rootActionOnly ==> 

description: Limit actions to those without a parent action.
type: boolean

return []*ActionStruct

func (*Client) ActionRead 

func (c *Client) ActionRead(r string) (*ActionStruct, error)

ActionRead - Retrieve the specified Action object.

r - Action Object Reference return *ActionStruct

func (*Client) AlertList 

func (c *Client) AlertList(sortBy string, fromDate string, toDate string, pageSize *int, maxTotal *int, target string, pageOffset *int, searchText string, ascending *bool) ([]*AlertStruct, error)

AlertList - Returns a list of alerts on the system.

sortBy ==> 

description: Search results are sorted by the field provided.
type: string
enum: [event eventTitle eventDescription eventResponse eventAction eventCommandOutput eventSeverity target targetName timestamp]

fromDate ==> 

format: date
mapsTo: timestamp
inequalityType: NON-STRICT
description: Start date to use for the search.
type: string

toDate ==> 

type: string
format: date
mapsTo: timestamp
inequalityType: STRICT
description: End date to use for the search.

pageSize ==> 

description: Limit the number of alerts returned.
type: integer
default: 25
minimum: 0

maxTotal ==> 

description: The upper bound for calculation of total alert count.
type: integer

target ==> 

referenceTo: /delphix-user-object.json
mapsTo: target
description: Limit alerts to those affecting a particular object on the system.
type: string
format: objectReference

pageOffset ==> 

description: Offset within alert list, in units of pageSize chunks.
type: integer

searchText ==> 

description: Limit search results to only include alerts that have searchText string in eventTitle, eventDescription, eventResponse, eventAction, or severity.
type: string

ascending ==> 

description: True if results are to be returned in ascending order.
type: boolean

return []*AlertStruct

func (*Client) AlertProfileCreate 

func (c *Client) AlertProfileCreate(payload *AlertProfileStruct) (string, error)

AlertProfileCreate - Create a new AlertProfile object.

payload *AlertProfileStruct object return string

func (*Client) AlertProfileDelete 

func (c *Client) AlertProfileDelete(r string) error

AlertProfileDelete - Delete the specified AlertProfile object.

r - AlertProfile Object Reference

func (*Client) AlertProfileList 

func (c *Client) AlertProfileList() ([]*AlertProfileStruct, error)

AlertProfileList - List AlertProfile objects on the system.

return []*AlertProfileStruct

func (*Client) AlertProfileRead 

func (c *Client) AlertProfileRead(r string) (*AlertProfileStruct, error)

AlertProfileRead - Retrieve the specified AlertProfile object.

r - AlertProfile Object Reference return *AlertProfileStruct

func (*Client) AlertProfileUpdate 

func (c *Client) AlertProfileUpdate(r string, payload *AlertProfileStruct) error

AlertProfileUpdate - Update the specified AlertProfile object.

r - AlertProfile Object Reference payload *AlertProfileStruct object

func (*Client) AlertRead 

func (c *Client) AlertRead(r string) (*AlertStruct, error)

AlertRead - Retrieve the specified Alert object.

r - Alert Object Reference return *AlertStruct

func (*Client) AuthorizationConfigRead 

func (c *Client) AuthorizationConfigRead(r string) (*AuthorizationConfigStruct, error)

AuthorizationConfigRead - Retrieve the specified AuthorizationConfig object.

r - AuthorizationConfig Object Reference return *AuthorizationConfigStruct

func (*Client) AuthorizationConfigUpdate 

func (c *Client) AuthorizationConfigUpdate(r string, payload *AuthorizationConfigStruct) error

AuthorizationConfigUpdate - Update the specified AuthorizationConfig object.

r - AuthorizationConfig Object Reference payload *AuthorizationConfigStruct object

func (*Client) AuthorizationCreate 

func (c *Client) AuthorizationCreate(payload *AuthorizationStruct) (string, error)

AuthorizationCreate - Create a new Authorization object.

payload *AuthorizationStruct object return string

func (*Client) AuthorizationDelete 

func (c *Client) AuthorizationDelete(r string) error

AuthorizationDelete - Delete the specified Authorization object.

r - Authorization Object Reference

func (*Client) AuthorizationList 

func (c *Client) AuthorizationList(user string, target string, effective string) ([]*AuthorizationStruct, error)

AuthorizationList - Lists authorizations granted in the system.

user ==> 

mapsTo: user
description: Lists permissions granted to the specified user.
type: string
format: objectReference
referenceTo: /delphix-user.json
required: false

target ==> 

mapsTo: target
description: Lists the permissions granted on the specified object.
type: string
format: objectReference
referenceTo: /delphix-user-object.json
required: false

effective ==> 

description: Also return inherited authorizations.
type: string
required: false

return []*AuthorizationStruct

func (*Client) AuthorizationRead 

func (c *Client) AuthorizationRead(r string) (*AuthorizationStruct, error)

AuthorizationRead - Retrieve the specified Authorization object.

r - Authorization Object Reference return *AuthorizationStruct

func (*Client) CaCertificateCreate 

func (c *Client) CaCertificateCreate(payload *PemCertificateStruct) (string, error)

CaCertificateCreate - Import a CA certificate in PEM format.

payload *PemCertificateStruct object return string

func (*Client) CaCertificateDelete 

func (c *Client) CaCertificateDelete(r string) error

CaCertificateDelete - Delete the specified CaCertificate object.

r - CaCertificate Object Reference

func (*Client) CaCertificateList 

func (c *Client) CaCertificateList(delphixCa *bool) ([]*CaCertificateStruct, error)

CaCertificateList - List CaCertificate objects on the system.

delphixCa ==> 

description: List the Delphix CA only. If false, display everything except the Delphix CA.
type: boolean

return []*CaCertificateStruct

func (*Client) CaCertificateRead 

func (c *Client) CaCertificateRead(r string) (*CaCertificateStruct, error)

CaCertificateRead - Retrieve the specified CaCertificate object.

r - CaCertificate Object Reference return *CaCertificateStruct

func (*Client) CertificateConfigRead 

func (c *Client) CertificateConfigRead(r string) (*CertificateConfigStruct, error)

CertificateConfigRead - Retrieve the specified CertificateConfig object.

r - CertificateConfig Object Reference return *CertificateConfigStruct

func (*Client) CertificateConfigUpdate 

func (c *Client) CertificateConfigUpdate(r string, payload *CertificateConfigStruct) error

CertificateConfigUpdate - Update the specified CertificateConfig object.

r - CertificateConfig Object Reference payload *CertificateConfigStruct object

func (*Client) CertificateSigningRequestCreate 

func (c *Client) CertificateSigningRequestCreate(payload *CertificateSigningRequestCreateParametersStruct) (string, error)

CertificateSigningRequestCreate - Create a new CertificateSigningRequest object.

payload *CertificateSigningRequestCreateParametersStruct object return string

func (*Client) CertificateSigningRequestDelete 

func (c *Client) CertificateSigningRequestDelete(r string) error

CertificateSigningRequestDelete - Delete the specified CertificateSigningRequest object.

r - CertificateSigningRequest Object Reference

func (*Client) CertificateSigningRequestList 

func (c *Client) CertificateSigningRequestList() ([]*CertificateSigningRequestStruct, error)

CertificateSigningRequestList - List CertificateSigningRequest objects on the system.

return []*CertificateSigningRequestStruct

func (*Client) CertificateSigningRequestRead 

func (c *Client) CertificateSigningRequestRead(r string) (*CertificateSigningRequestStruct, error)

CertificateSigningRequestRead - Retrieve the specified CertificateSigningRequest object.

r - CertificateSigningRequest Object Reference return *CertificateSigningRequestStruct

func (*Client) CheckStoragePool 

func (c *Client) CheckStoragePool() (interface{}, error)

CheckStoragePool checks whether the storage domain has been created

func (*Client) ContainerDelete 

func (c *Client) ContainerDelete(r string, payload *DeleteParametersStruct) error

ContainerDelete - Delete the specified Container object.

r - Container Object Reference payload *DeleteParametersStruct object

func (*Client) ContainerList 

func (c *Client) ContainerList(noJSDataSource *bool, noJSContainerDataSource *bool, validForSecureReplication *bool, provisionContainer string, group string) ([]Container, error)

ContainerList - Returns a list of databases on the system or within a group.

noJSDataSource ==> 

description: Restrict databases to those which are not part of a Self-Service data layout (data template or data container). This option is mutually exclusive with the "noJSContainerDataSource" option.
type: boolean

noJSContainerDataSource ==> 

description: Restrict databases to those which are not part of a Self-Service data container. This option is mutually exclusive with the "noJSDataSource" option.
type: boolean

validForSecureReplication ==> 

description: Restrict listing to include only datasets that can be securely replicated.
type: boolean

provisionContainer ==> 

description: Restrict databases to those provisioned from the specified container. This option is mutually exclusive with the "group" option.
type: string
format: objectReference
referenceTo: /delphix-container.json
mapsTo: provisionContainer

group ==> 

description: Restrict databases to those within the specified group. This option is mutually exclusive with the "provisionContainer" option.
type: string
format: objectReference
referenceTo: /delphix-group.json
mapsTo: group

return []Container

func (*Client) ContainerRead 

func (c *Client) ContainerRead(r string) (Container, error)

ContainerRead - Retrieve the specified Container object.

r - Container Object Reference return Container

func (*Client) ContainerUpdate 

func (c *Client) ContainerUpdate(r string, payload Container) error

ContainerUpdate - Update the specified Container object.

r - Container Object Reference payload Container object

func (*Client) ContainerUtilizationList 

func (c *Client) ContainerUtilizationList(fromDate string, toDate string, samplingInterval float64) ([]*ContainerUtilizationStruct, error)

ContainerUtilizationList - Reports the utilization of all containers during a particular period of time.

fromDate ==> 

description: The earliest date for which container utilization statistics will be reported.
type: string
format: date
required: true

toDate ==> 

description: The latest date for which container utilization statistics will be reported.
type: string
format: date
required: true

samplingInterval ==> 

type: number
required: true
description: The interval at which data is to be sampled, measured in seconds.

return []*ContainerUtilizationStruct

func (*Client) CreateDSource 

func (c *Client) CreateDSource(l *LinkParametersStruct) (
	interface{}, error)

CreateDSource creates a dSource in Delphix

func (*Client) CreateDatabase 

func (c *Client) CreateDatabase(o *OracleProvisionParametersStruct) (
	interface{}, error)

CreateDatabase provisions an Oracle virtual database

func (*Client) CreateEnvironment 

func (c *Client) CreateEnvironment(h *HostEnvironmentCreateParametersStruct) (
	interface{}, error)

CreateEnvironment creates a new environment in Delphix

func (*Client) CurrentConsumerCapacityDataList 

func (c *Client) CurrentConsumerCapacityDataList() ([]*CurrentConsumerCapacityDataStruct, error)

CurrentConsumerCapacityDataList - Lists consumers in the system.

return []*CurrentConsumerCapacityDataStruct

func (*Client) CurrentGroupCapacityDataList 

func (c *Client) CurrentGroupCapacityDataList() ([]*CurrentGroupCapacityDataStruct, error)

CurrentGroupCapacityDataList - Lists capacity data for groups in the system.

return []*CurrentGroupCapacityDataStruct

func (*Client) CurrentSystemCapacityDataRead 

func (c *Client) CurrentSystemCapacityDataRead(r string) (*CurrentSystemCapacityDataStruct, error)

CurrentSystemCapacityDataRead - Retrieve the specified CurrentSystemCapacityData object.

r - CurrentSystemCapacityData Object Reference return *CurrentSystemCapacityDataStruct

func (*Client) DNSConfigRead 

func (c *Client) DNSConfigRead(r string) (*DNSConfigStruct, error)

DNSConfigRead - Retrieve the specified DNSConfig object.

r - DNSConfig Object Reference return *DNSConfigStruct

func (*Client) DNSConfigUpdate 

func (c *Client) DNSConfigUpdate(r string, payload *DNSConfigStruct) error

DNSConfigUpdate - Update the specified DNSConfig object.

r - DNSConfig Object Reference payload *DNSConfigStruct object

func (*Client) DatabaseTemplateCreate 

func (c *Client) DatabaseTemplateCreate(payload *DatabaseTemplateStruct) (string, error)

DatabaseTemplateCreate - Create a new DatabaseTemplate object.

payload *DatabaseTemplateStruct object return string

func (*Client) DatabaseTemplateDelete 

func (c *Client) DatabaseTemplateDelete(r string) error

DatabaseTemplateDelete - Delete the specified DatabaseTemplate object.

r - DatabaseTemplate Object Reference

func (*Client) DatabaseTemplateList 

func (c *Client) DatabaseTemplateList() ([]*DatabaseTemplateStruct, error)

DatabaseTemplateList - List DatabaseTemplate objects on the system.

return []*DatabaseTemplateStruct

func (*Client) DatabaseTemplateRead 

func (c *Client) DatabaseTemplateRead(r string) (*DatabaseTemplateStruct, error)

DatabaseTemplateRead - Retrieve the specified DatabaseTemplate object.

r - DatabaseTemplate Object Reference return *DatabaseTemplateStruct

func (*Client) DatabaseTemplateUpdate 

func (c *Client) DatabaseTemplateUpdate(r string, payload *DatabaseTemplateStruct) error

DatabaseTemplateUpdate - Update the specified DatabaseTemplate object.

r - DatabaseTemplate Object Reference payload *DatabaseTemplateStruct object

func (*Client) DeleteDSource 

func (c *Client) DeleteDSource(v string) error

DeleteDSource is a convenience function, as it just invokes DeleteDatabase()

func (*Client) DeleteDatabase 

func (c *Client) DeleteDatabase(v string) error

DeleteDatabase deletes a virtual database

func (*Client) DeleteEnvironment 

func (c *Client) DeleteEnvironment(r string) error

DeleteEnvironment deletes an environment in Delphix

func (*Client) DomainRead 

func (c *Client) DomainRead(r string) (*DomainStruct, error)

DomainRead - Retrieve the specified Domain object.

r - Domain Object Reference return *DomainStruct

func (*Client) EndEntityCertificateList 

func (c *Client) EndEntityCertificateList() ([]*EndEntityCertificateStruct, error)

EndEntityCertificateList - List EndEntityCertificate objects on the system.

return []*EndEntityCertificateStruct

func (*Client) EndEntityCertificateRead 

func (c *Client) EndEntityCertificateRead(r string) (*EndEntityCertificateStruct, error)

EndEntityCertificateRead - Retrieve the specified EndEntityCertificate object.

r - EndEntityCertificate Object Reference return *EndEntityCertificateStruct

func (*Client) EnvironmentUserCreate 

func (c *Client) EnvironmentUserCreate(payload *EnvironmentUserStruct) (string, error)

EnvironmentUserCreate - Create a new EnvironmentUser object.

payload *EnvironmentUserStruct object return string

func (*Client) EnvironmentUserDelete 

func (c *Client) EnvironmentUserDelete(r string, payload *DeleteParametersStruct) error

EnvironmentUserDelete - Delete the specified EnvironmentUser object.

r - EnvironmentUser Object Reference payload *DeleteParametersStruct object

func (*Client) EnvironmentUserList 

func (c *Client) EnvironmentUserList(environment string) ([]*EnvironmentUserStruct, error)

EnvironmentUserList - Returns the list of all environment users in the system.

environment ==> 

type: string
description: Limit results to users within the given environment.
format: objectReference
referenceTo: /delphix-source-environment.json
mapsTo: environment

return []*EnvironmentUserStruct

func (*Client) EnvironmentUserRead 

func (c *Client) EnvironmentUserRead(r string) (*EnvironmentUserStruct, error)

EnvironmentUserRead - Retrieve the specified EnvironmentUser object.

r - EnvironmentUser Object Reference return *EnvironmentUserStruct

func (*Client) EnvironmentUserUpdate 

func (c *Client) EnvironmentUserUpdate(r string, payload *EnvironmentUserStruct) error

EnvironmentUserUpdate - Update the specified EnvironmentUser object.

r - EnvironmentUser Object Reference payload *EnvironmentUserStruct object

func (*Client) FactoryReset 

func (c *Client) FactoryReset() error

FactoryReset performs a factory reset on the Delphix engine

func (*Client) FaultEffectList 

func (c *Client) FaultEffectList(severity string, target string, rootCause string, bundleID string) ([]*FaultEffectStruct, error)

FaultEffectList - Returns the list of all the fault effects that match the given criteria.

severity ==> 

description: The impact of the fault effect on the system: CRITICAL or WARNING.
type: string
enum: [CRITICAL WARNING]
mapsTo: severity

target ==> 

description: The reference to the Delphix user-visible object associated with the fault effect.
type: string
format: objectReference
referenceTo: /delphix-user-object.json
mapsTo: target

rootCause ==> 

description: The reference to the fault which is the root cause of the fault effect.
type: string
format: objectReference
referenceTo: /delphix-fault.json
mapsTo: rootCause

bundleID ==> 

description: A unique dot delimited identifier associated with the fault effect.
type: string
mapsTo: bundleID

return []*FaultEffectStruct

func (*Client) FaultEffectRead 

func (c *Client) FaultEffectRead(r string) (*FaultEffectStruct, error)

FaultEffectRead - Retrieve the specified FaultEffect object.

r - FaultEffect Object Reference return *FaultEffectStruct

func (*Client) FaultList 

func (c *Client) FaultList(maxTotal *int, target string, severity string, status string, fromDate string, toDate string, pageSize *int, pageOffset *int, sortBy string, ascending *bool, searchText string) ([]*FaultStruct, error)

FaultList - Returns the list of all the faults that match the given criteria.

maxTotal ==> 

description: The upper bound for calculation of total fault count.
type: integer

target ==> 

type: string
format: objectReference
referenceTo: /delphix-user-object.json
mapsTo: target
description: The reference to the Delphix user-visible object associated with the fault.

severity ==> 

description: The impact of the fault on the system: CRITICAL or WARNING.
type: string
enum: [CRITICAL WARNING]
mapsTo: severity

status ==> 

enum: [ACTIVE RESOLVED IGNORED]
mapsTo: status
description: The status of the fault: ACTIVE, RESOLVED or IGNORED.
type: string

fromDate ==> 

description: Start date to use for the search.
type: string
format: date
mapsTo: dateDiagnosed
inequalityType: NON-STRICT

toDate ==> 

description: End date to use for the search.
type: string
format: date
mapsTo: dateDiagnosed
inequalityType: STRICT

pageSize ==> 

description: Limit the number of faults returned.
type: integer
default: 25
minimum: 0

pageOffset ==> 

description: Offset within fault list, in units of pageSize chunks.
type: integer

sortBy ==> 

description: Search results are sorted by the field provided.
type: string
enum: [severity dateDiagnosed title targetName]

ascending ==> 

description: True if results are to be returned in ascending order.
type: boolean

searchText ==> 

description: Limit search results to only include faults that have searchText string in severity, title, targetName.
type: string

return []*FaultStruct

func (*Client) FaultRead 

func (c *Client) FaultRead(r string) (*FaultStruct, error)

FaultRead - Retrieve the specified Fault object.

r - Fault Object Reference return *FaultStruct

func (*Client) FindDatabaseByName 

func (c *Client) FindDatabaseByName(n string) (interface{}, error)

FindDatabaseByName returns the database object (interface) of the named (n) database

func (*Client) FindDatabaseByReference 

func (c *Client) FindDatabaseByReference(r string) (interface{}, error)

FindDatabaseByReference returns the database object (interface) of the reference (r) database

func (*Client) FindEnvironmentByName 

func (c *Client) FindEnvironmentByName(n string) (interface{}, error)

FindEnvironmentByName returns the environment object (interface) of the named (n) environment

func (*Client) FindEnvironmentByReference 

func (c *Client) FindEnvironmentByReference(r string) (interface{}, error)

FindEnvironmentByReference returns the environment object (interface) of the referenced (r) environment

func (*Client) FindEnvironmentUserRefByNameAndEnvironmentReference 

func (c *Client) FindEnvironmentUserRefByNameAndEnvironmentReference(n string, r string) (string, error)

FindEnvironmentUserByNameAndEnvironmentReference returns the reference of the environment user by environment user name (n) and environment reference (r)

func (*Client) FindGroupByName 

func (c *Client) FindGroupByName(n string) (interface{}, error)

FindGroupByName returns the group object (interface) of the named (n) group

func (*Client) FindGroupRefByName 

func (c *Client) FindGroupRefByName(n string) (string, error)

FindGroupRefByName returns the group reference (string) of the named (n) group

func (*Client) FindObjectByName 

func (c *Client) FindObjectByName(u string, n string) (interface{}, error)

FindObjectByName returns the named (n) object type (u)

func (*Client) FindObjectByReference 

func (c *Client) FindObjectByReference(u string, r string) (interface{}, error)

FindObjectByReference returns the referenced (r) object type (u)

func (*Client) FindRepoReferenceByEnvironmentRefAndOracleHome 

func (c *Client) FindRepoReferenceByEnvironmentRefAndOracleHome(e string, oh string) (string, error)

FindRepoReferenceByEnvironmentRefAndOracleHome returns the reference of the Repository by environment reference (e) and oracle home (oh) path

func (*Client) FindSourceByName 

func (c *Client) FindSourceByName(n string) (interface{}, error)

FindSourceByName returns the reference of the named source(n)

func (*Client) FindSourceConfigReferenceByNameAndRepoReference 

func (c *Client) FindSourceConfigReferenceByNameAndRepoReference(n string, r string) (string, error)

FindSourceConfigReferenceByNameAndRepoReference returns the sourceconfig reference (string) of the named (n) sourceconfig for the specified repo reference (r)

func (*Client) FindUserByName 

func (c *Client) FindUserByName(n string) (interface{}, error)

FindUserByName returns the user object (interface) of the named (n) user

func (*Client) GetStorageDevices 

func (c *Client) GetStorageDevices() ([]string, error)

GetStorageDevices returns the list of unassigned storage devices on the Delphix engine

func (*Client) GlobalLinkingSettingsRead 

func (c *Client) GlobalLinkingSettingsRead(r string) (*GlobalLinkingSettingsStruct, error)

GlobalLinkingSettingsRead - Retrieve the specified GlobalLinkingSettings object.

r - GlobalLinkingSettings Object Reference return *GlobalLinkingSettingsStruct

func (*Client) GlobalLinkingSettingsUpdate 

func (c *Client) GlobalLinkingSettingsUpdate(r string, payload *GlobalLinkingSettingsStruct) error

GlobalLinkingSettingsUpdate - Update the specified GlobalLinkingSettings object.

r - GlobalLinkingSettings Object Reference payload *GlobalLinkingSettingsStruct object

func (*Client) GroupCreate 

func (c *Client) GroupCreate(payload *GroupStruct) (string, error)

GroupCreate - Create a new Group object.

payload *GroupStruct object return string

func (*Client) GroupDelete 

func (c *Client) GroupDelete(r string) error

GroupDelete - Delete the specified Group object.

r - Group Object Reference

func (*Client) GroupList 

func (c *Client) GroupList() ([]*GroupStruct, error)

GroupList - List Group objects on the system.

return []*GroupStruct

func (*Client) GroupRead 

func (c *Client) GroupRead(r string) (*GroupStruct, error)

GroupRead - Retrieve the specified Group object.

r - Group Object Reference return *GroupStruct

func (*Client) GroupUpdate 

func (c *Client) GroupUpdate(r string, payload *GroupStruct) error

GroupUpdate - Update the specified Group object.

r - Group Object Reference payload *GroupStruct object

func (*Client) HistoricalConsumerCapacityDataList 

func (c *Client) HistoricalConsumerCapacityDataList(container string, startDate string, endDate string, resolution *int) ([]*HistoricalConsumerCapacityDataStruct, error)

HistoricalConsumerCapacityDataList - Lists consumers in the system.

container ==> 

type: string
format: objectReference
referenceTo: /delphix-container.json
description: The container for which to list data.

startDate ==> 

type: string
format: date
description: Earliest date for which to list data.
mapsTo: timestamp
inequalityType: NON-STRICT

endDate ==> 

inequalityType: NON-STRICT
type: string
format: date
description: Latest date for which to list data.
mapsTo: timestamp

resolution ==> 

type: integer
minimum: 0
description: The time range each datapoint should represent, measured in seconds. This parameter is only meaningful if a container is specified.

return []*HistoricalConsumerCapacityDataStruct

func (*Client) HistoricalGroupCapacityDataList 

func (c *Client) HistoricalGroupCapacityDataList(group string, startDate string, endDate string, resolution *int) ([]*HistoricalGroupCapacityDataStruct, error)

HistoricalGroupCapacityDataList - Lists historical capacity data for a particular group.

group ==> 

description: The group to list data for.
type: string
format: objectReference
referenceTo: /delphix-group.json

startDate ==> 

type: string
format: date
description: Earliest date for which to list data.
mapsTo: timestamp
inequalityType: NON-STRICT

endDate ==> 

description: Latest date for which to list data.
mapsTo: timestamp
inequalityType: NON-STRICT
type: string
format: date

resolution ==> 

type: integer
minimum: 0
description: The time range each datapoint should represent, measured in seconds. This parameter is only meaningful if a group is specified.

return []*HistoricalGroupCapacityDataStruct

func (*Client) HistoricalSystemCapacityDataList 

func (c *Client) HistoricalSystemCapacityDataList(startDate string, endDate string, resolution *int) ([]*HistoricalSystemCapacityDataStruct, error)

HistoricalSystemCapacityDataList - Lists historical system capacity data.

startDate ==> 

format: date
description: Earliest date for which to list data.
mapsTo: timestamp
inequalityType: NON-STRICT
type: string

endDate ==> 

type: string
format: date
description: Latest date for which to list data.
mapsTo: timestamp
inequalityType: NON-STRICT

resolution ==> 

type: integer
minimum: 0
description: The time range each datapoint should represent, measured in seconds.

return []*HistoricalSystemCapacityDataStruct

func (*Client) HostList 

func (c *Client) HostList(environment string) ([]Host, error)

HostList - Returns the list of all hosts in the system.

environment ==> 

type: string
description: Include only hosts belonging to the given environment.
format: objectReference
referenceTo: /delphix-source-environment.json

return []Host

func (*Client) HostPrivilegeElevationProfileCreate 

func (c *Client) HostPrivilegeElevationProfileCreate(payload *HostPrivilegeElevationProfileStruct) (string, error)

HostPrivilegeElevationProfileCreate - Create a new HostPrivilegeElevationProfile object.

payload *HostPrivilegeElevationProfileStruct object return string

func (*Client) HostPrivilegeElevationProfileDelete 

func (c *Client) HostPrivilegeElevationProfileDelete(r string) error

HostPrivilegeElevationProfileDelete - Delete the specified HostPrivilegeElevationProfile object.

r - HostPrivilegeElevationProfile Object Reference

func (*Client) HostPrivilegeElevationProfileList 

func (c *Client) HostPrivilegeElevationProfileList() ([]*HostPrivilegeElevationProfileStruct, error)

HostPrivilegeElevationProfileList - List HostPrivilegeElevationProfile objects on the system.

return []*HostPrivilegeElevationProfileStruct

func (*Client) HostPrivilegeElevationProfileRead 

func (c *Client) HostPrivilegeElevationProfileRead(r string) (*HostPrivilegeElevationProfileStruct, error)

HostPrivilegeElevationProfileRead - Retrieve the specified HostPrivilegeElevationProfile object.

r - HostPrivilegeElevationProfile Object Reference return *HostPrivilegeElevationProfileStruct

func (*Client) HostPrivilegeElevationProfileScriptCreate 

func (c *Client) HostPrivilegeElevationProfileScriptCreate(payload *HostPrivilegeElevationProfileScriptStruct) (string, error)

HostPrivilegeElevationProfileScriptCreate - Create a new HostPrivilegeElevationProfileScript object.

payload *HostPrivilegeElevationProfileScriptStruct object return string

func (*Client) HostPrivilegeElevationProfileScriptDelete 

func (c *Client) HostPrivilegeElevationProfileScriptDelete(r string) error

HostPrivilegeElevationProfileScriptDelete - Delete the specified HostPrivilegeElevationProfileScript object.

r - HostPrivilegeElevationProfileScript Object Reference

func (*Client) HostPrivilegeElevationProfileScriptList 

func (c *Client) HostPrivilegeElevationProfileScriptList() ([]*HostPrivilegeElevationProfileScriptStruct, error)

HostPrivilegeElevationProfileScriptList - List HostPrivilegeElevationProfileScript objects on the system.

return []*HostPrivilegeElevationProfileScriptStruct

func (*Client) HostPrivilegeElevationProfileScriptRead 

func (c *Client) HostPrivilegeElevationProfileScriptRead(r string) (*HostPrivilegeElevationProfileScriptStruct, error)

HostPrivilegeElevationProfileScriptRead - Retrieve the specified HostPrivilegeElevationProfileScript object.

r - HostPrivilegeElevationProfileScript Object Reference return *HostPrivilegeElevationProfileScriptStruct

func (*Client) HostPrivilegeElevationProfileScriptUpdate 

func (c *Client) HostPrivilegeElevationProfileScriptUpdate(r string, payload *HostPrivilegeElevationProfileScriptStruct) error

HostPrivilegeElevationProfileScriptUpdate - Update the specified HostPrivilegeElevationProfileScript object.

r - HostPrivilegeElevationProfileScript Object Reference payload *HostPrivilegeElevationProfileScriptStruct object

func (*Client) HostPrivilegeElevationProfileUpdate 

func (c *Client) HostPrivilegeElevationProfileUpdate(r string, payload *HostPrivilegeElevationProfileStruct) error

HostPrivilegeElevationProfileUpdate - Update the specified HostPrivilegeElevationProfile object.

r - HostPrivilegeElevationProfile Object Reference payload *HostPrivilegeElevationProfileStruct object

func (*Client) HostPrivilegeElevationSettingsRead 

func (c *Client) HostPrivilegeElevationSettingsRead(r string) (*HostPrivilegeElevationSettingsStruct, error)

HostPrivilegeElevationSettingsRead - Retrieve the specified HostPrivilegeElevationSettings object.

r - HostPrivilegeElevationSettings Object Reference return *HostPrivilegeElevationSettingsStruct

func (*Client) HostPrivilegeElevationSettingsUpdate 

func (c *Client) HostPrivilegeElevationSettingsUpdate(r string, payload *HostPrivilegeElevationSettingsStruct) error

HostPrivilegeElevationSettingsUpdate - Update the specified HostPrivilegeElevationSettings object.

r - HostPrivilegeElevationSettings Object Reference payload *HostPrivilegeElevationSettingsStruct object

func (*Client) HostRead 

func (c *Client) HostRead(r string) (Host, error)

HostRead - Retrieve the specified Host object.

r - Host Object Reference return Host

func (*Client) HostUpdate 

func (c *Client) HostUpdate(r string, payload Host) error

HostUpdate - Update the specified Host object.

r - Host Object Reference payload Host object

func (*Client) HttpConnectorConfigRead 

func (c *Client) HttpConnectorConfigRead(r string) (*HttpConnectorConfigStruct, error)

HttpConnectorConfigRead - Retrieve the specified HttpConnectorConfig object.

r - HttpConnectorConfig Object Reference return *HttpConnectorConfigStruct

func (*Client) HttpConnectorConfigUpdate 

func (c *Client) HttpConnectorConfigUpdate(r string, payload *HttpConnectorConfigStruct) error

HttpConnectorConfigUpdate - Update the specified HttpConnectorConfig object.

r - HttpConnectorConfig Object Reference payload *HttpConnectorConfigStruct object

func (*Client) InitializeSystem 

func (c *Client) InitializeSystem(d string, p string) (interface{}, error)

InitializeSystem completes the initial setup wizard

func (*Client) JSBookmarkCreate 

func (c *Client) JSBookmarkCreate(payload *JSBookmarkCreateParametersStruct) (string, error)

JSBookmarkCreate - Create a new JSBookmark object.

payload *JSBookmarkCreateParametersStruct object return string

func (*Client) JSBookmarkDelete 

func (c *Client) JSBookmarkDelete(r string) error

JSBookmarkDelete - Delete the specified JSBookmark object.

r - JSBookmark Object Reference

func (*Client) JSBookmarkList 

func (c *Client) JSBookmarkList(container string, template string) ([]*JSBookmarkStruct, error)

JSBookmarkList - Lists the Self-Service bookmarks in the system.

container ==> 

description: List all usable bookmarks accessible to the specified data container. This option is mutually exclusive with all other options.
type: string
format: objectReference
referenceTo: /delphix-js-data-container.json
mapsTo: container

template ==> 

description: List all usable bookmarks created in the specified data template. This option is mutually exclusive with all other options.
type: string
format: objectReference
referenceTo: /delphix-js-data-template.json
mapsTo: template

return []*JSBookmarkStruct

func (*Client) JSBookmarkRead 

func (c *Client) JSBookmarkRead(r string) (*JSBookmarkStruct, error)

JSBookmarkRead - Retrieve the specified JSBookmark object.

r - JSBookmark Object Reference return *JSBookmarkStruct

func (*Client) JSBookmarkUpdate 

func (c *Client) JSBookmarkUpdate(r string, payload *JSBookmarkStruct) error

JSBookmarkUpdate - Update the specified JSBookmark object.

r - JSBookmark Object Reference payload *JSBookmarkStruct object

func (*Client) JSBranchCreate 

func (c *Client) JSBranchCreate(payload *JSBranchCreateParametersStruct) (string, error)

JSBranchCreate - Create a new JSBranch object.

payload *JSBranchCreateParametersStruct object return string

func (*Client) JSBranchDelete 

func (c *Client) JSBranchDelete(r string) error

JSBranchDelete - Delete the specified JSBranch object.

r - JSBranch Object Reference

func (*Client) JSBranchList 

func (c *Client) JSBranchList(dataLayout string) ([]*JSBranchStruct, error)

JSBranchList - Lists the Self-Service branches in the system.

dataLayout ==> 

format: objectReference
referenceTo: /delphix-js-data-layout.json
mapsTo: dataLayout
description: List branches belonging to the given data layout.
type: string

return []*JSBranchStruct

func (*Client) JSBranchRead 

func (c *Client) JSBranchRead(r string) (*JSBranchStruct, error)

JSBranchRead - Retrieve the specified JSBranch object.

r - JSBranch Object Reference return *JSBranchStruct

func (*Client) JSBranchUpdate 

func (c *Client) JSBranchUpdate(r string, payload *JSBranchStruct) error

JSBranchUpdate - Update the specified JSBranch object.

r - JSBranch Object Reference payload *JSBranchStruct object

func (*Client) JSConfigRead 

func (c *Client) JSConfigRead(r string) (*JSConfigStruct, error)

JSConfigRead - Retrieve the specified JSConfig object.

r - JSConfig Object Reference return *JSConfigStruct

func (*Client) JSConfigUpdate 

func (c *Client) JSConfigUpdate(r string, payload *JSConfigStruct) error

JSConfigUpdate - Update the specified JSConfig object.

r - JSConfig Object Reference payload *JSConfigStruct object

func (*Client) JSDailyOperationDurationList 

func (c *Client) JSDailyOperationDurationList(usageObject string) ([]*JSDailyOperationDurationStruct, error)

JSDailyOperationDurationList - List the operation durations in the system, optionally restricted to those operations related to a single object.

usageObject ==> 

description: Restrict usage data to that related to a specific object.
type: string
format: objectReference
referenceTo: /delphix-named-user-object.json
mapsTo: usageObject

return []*JSDailyOperationDurationStruct

func (*Client) JSDailyOperationDurationRead 

func (c *Client) JSDailyOperationDurationRead(r string) (*JSDailyOperationDurationStruct, error)

JSDailyOperationDurationRead - Retrieve the specified JSDailyOperationDuration object.

r - JSDailyOperationDuration Object Reference return *JSDailyOperationDurationStruct

func (*Client) JSDataContainerCreate 

func (c *Client) JSDataContainerCreate(payload JSDataContainerCreateParameters) (string, error)

JSDataContainerCreate - Create a new JSDataContainer object.

payload JSDataContainerCreateParameters object return string

func (*Client) JSDataContainerDelete 

func (c *Client) JSDataContainerDelete(r string, payload *JSDataContainerDeleteParametersStruct) error

JSDataContainerDelete - Delete this data container.

r - JSDataContainer Object Reference payload *JSDataContainerDeleteParametersStruct object

func (*Client) JSDataContainerList 

func (c *Client) JSDataContainerList(owner string, template string, independentOnly *bool) ([]*JSDataContainerStruct, error)

JSDataContainerList - List the data containers defined in the system.

owner ==> 

description: Restrict data containers to those belonging to the specified user.This option is mutually exclusive with the "template" and "independentOnly" options.
type: string
format: objectReference
referenceTo: /delphix-user.json
mapsTo: owner

template ==> 

description: Restrict data containers to those provisioned from the specified template. This option is mutually exclusive with the "owner" and "independentOnly" options.
type: string
format: objectReference
referenceTo: /delphix-js-data-template.json
mapsTo: template

independentOnly ==> 

description: Restrict data containers to independent data containers that do not have templates. This option is mutually exclusive with the "template" and "owner" options.
type: boolean

return []*JSDataContainerStruct

func (*Client) JSDataContainerRead 

func (c *Client) JSDataContainerRead(r string) (*JSDataContainerStruct, error)

JSDataContainerRead - Retrieve the specified JSDataContainer object.

r - JSDataContainer Object Reference return *JSDataContainerStruct

func (*Client) JSDataContainerUpdate 

func (c *Client) JSDataContainerUpdate(r string, payload *JSDataContainerStruct) error

JSDataContainerUpdate - Update the specified JSDataContainer object.

r - JSDataContainer Object Reference payload *JSDataContainerStruct object

func (*Client) JSDataSourceList 

func (c *Client) JSDataSourceList(dataLayout string, container string) ([]*JSDataSourceStruct, error)

JSDataSourceList - Lists the Self-Service data sources in the system.

dataLayout ==> 

type: string
format: objectReference
referenceTo: /delphix-js-data-layout.json
mapsTo: dataLayout
description: List the sources associated with the given data layout reference.

container ==> 

description: List the source associated with the given container reference.
type: string
format: objectReference
referenceTo: /delphix-container.json
mapsTo: container

return []*JSDataSourceStruct

func (*Client) JSDataSourceRead 

func (c *Client) JSDataSourceRead(r string) (*JSDataSourceStruct, error)

JSDataSourceRead - Retrieve the specified JSDataSource object.

r - JSDataSource Object Reference return *JSDataSourceStruct

func (*Client) JSDataSourceUpdate 

func (c *Client) JSDataSourceUpdate(r string, payload *JSDataSourceStruct) error

JSDataSourceUpdate - Update the specified JSDataSource object.

r - JSDataSource Object Reference payload *JSDataSourceStruct object

func (*Client) JSDataTemplateCreate 

func (c *Client) JSDataTemplateCreate(payload *JSDataTemplateCreateParametersStruct) (string, error)

JSDataTemplateCreate - Create a new JSDataTemplate object.

payload *JSDataTemplateCreateParametersStruct object return string

func (*Client) JSDataTemplateDelete 

func (c *Client) JSDataTemplateDelete(r string) error

JSDataTemplateDelete - Delete the specified JSDataTemplate object.

r - JSDataTemplate Object Reference

func (*Client) JSDataTemplateList 

func (c *Client) JSDataTemplateList() ([]*JSDataTemplateStruct, error)

JSDataTemplateList - List the data templates defined in the system.

return []*JSDataTemplateStruct

func (*Client) JSDataTemplateRead 

func (c *Client) JSDataTemplateRead(r string) (*JSDataTemplateStruct, error)

JSDataTemplateRead - Retrieve the specified JSDataTemplate object.

r - JSDataTemplate Object Reference return *JSDataTemplateStruct

func (*Client) JSDataTemplateUpdate 

func (c *Client) JSDataTemplateUpdate(r string, payload *JSDataTemplateStruct) error

JSDataTemplateUpdate - Update the specified JSDataTemplate object.

r - JSDataTemplate Object Reference payload *JSDataTemplateStruct object

func (*Client) JSOperationList 

func (c *Client) JSOperationList(dataLayout string, branch string, dataTime string, beforeCount *int, afterCount *int, dataStartTime string, dataEndTime string) ([]*JSOperationStruct, error)

JSOperationList - Lists the Self-Service action history for a data layout.

dataLayout ==> 

description: Limit operations to the specific data layout. This option is mutually exclusive with the "branch" option.
type: string
format: objectReference
referenceTo: /delphix-js-data-layout.json
mapsTo: dataLayout

branch ==> 

referenceTo: /delphix-js-branch.json
mapsTo: branch
description: Limit operations to the specified branch. This option is mutually exclusive with the "dataLayout" option.
type: string
format: objectReference

dataTime ==> 

description: Limit operations that occurred around the specified "dataTime". "beforeCount" and "afterCount" should specify the number of events to be returned.
type: string
format: date
mapsTo: dataTime

beforeCount ==> 

description: The suggested maximum number of visible operations prior to "dataTime" that should be returned. If there are not sufficient events before additional events after may be returned.
type: integer
default: 0

afterCount ==> 

description: The suggested maximum number of visible operations after "dataTime" that should be returned. If there are not sufficient events after additional events before may be returned.
type: integer
default: 0

dataStartTime ==> 

format: date
description: Operations with "dataTime" after this value will be returned. Used with "dataEndTime" to return a set of operations between two dates.
type: string

dataEndTime ==> 

description: Operations with "dataTime" before this value will be returned. Used with "dataStartTime" to return a set of operations between two dates.
type: string
format: date

return []*JSOperationStruct

func (*Client) JSOperationRead 

func (c *Client) JSOperationRead(r string) (*JSOperationStruct, error)

JSOperationRead - Retrieve the specified JSOperation object.

r - JSOperation Object Reference return *JSOperationStruct

func (*Client) JSWeeklyOperationCountList 

func (c *Client) JSWeeklyOperationCountList(usageObject string) ([]*JSWeeklyOperationCountStruct, error)

JSWeeklyOperationCountList - List the operation counts in the system, optionally restricted to those operations related to a single object.

usageObject ==> 

description: Restrict usage data to that related to a specific object.
type: string
format: objectReference
referenceTo: /delphix-named-user-object.json
mapsTo: usageObject

return []*JSWeeklyOperationCountStruct

func (*Client) JSWeeklyOperationCountRead 

func (c *Client) JSWeeklyOperationCountRead(r string) (*JSWeeklyOperationCountStruct, error)

JSWeeklyOperationCountRead - Retrieve the specified JSWeeklyOperationCount object.

r - JSWeeklyOperationCount Object Reference return *JSWeeklyOperationCountStruct

func (*Client) JobList 

func (c *Client) JobList(searchText string, jobType string, pageOffset *int, addEvents *bool, toDate string, pageSize *int, maxTotal *int, jobState string, target string, fromDate string) ([]*JobStruct, error)

JobList - Returns a list of jobs in the system. Jobs are listed in start time order.

searchText ==> 

type: string
description: Limit search results to only include jobs that contain the searchText.

jobType ==> 

description: Limit jobs to those with the specified job type.
type: string
mapsTo: actionType

pageOffset ==> 

type: integer
description: Page offset within job list.

addEvents ==> 

description: Whether to include the job events in each job.
type: boolean
default: false

toDate ==> 

inequalityType: NON-STRICT
description: Filters out jobs newer than this date.
format: date
type: string
mapsTo: startTime

pageSize ==> 

description: Limit the number of jobs returned.
type: integer
default: 25
minimum: 0

maxTotal ==> 

description: The upper bound for calculation of total job count.
type: integer

jobState ==> 

mapsTo: jobState
description: Limit jobs to those in the specified job state.
type: string
enum: [RUNNING SUSPENDED CANCELED COMPLETED FAILED]

target ==> 

format: objectReference
referenceTo: /delphix-user-object.json
mapsTo: target
description: Limit jobs to those affecting a particular object on the system. The target is the object reference for the target in question.
type: string

fromDate ==> 

mapsTo: updateTime
inequalityType: NON-STRICT
description: Filters out jobs older than this date.
format: date
type: string

return []*JobStruct

func (*Client) JobRead 

func (c *Client) JobRead(r string) (*JobStruct, error)

JobRead - Retrieve the specified Job object.

r - Job Object Reference return *JobStruct

func (*Client) JobUpdate 

func (c *Client) JobUpdate(r string, payload *JobStruct) error

JobUpdate - Update the specified Job object.

r - Job Object Reference payload *JobStruct object

func (*Client) KerberosConfigRead 

func (c *Client) KerberosConfigRead(r string) (*KerberosConfigStruct, error)

KerberosConfigRead - Retrieve the specified KerberosConfig object.

r - KerberosConfig Object Reference return *KerberosConfigStruct

func (*Client) KerberosConfigUpdate 

func (c *Client) KerberosConfigUpdate(r string, payload *KerberosConfigStruct) error

KerberosConfigUpdate - Update the specified KerberosConfig object.

r - KerberosConfig Object Reference payload *KerberosConfigStruct object

func (*Client) LdapInfoRead 

func (c *Client) LdapInfoRead(r string) (*LdapInfoStruct, error)

LdapInfoRead - Retrieve the specified LdapInfo object.

r - LdapInfo Object Reference return *LdapInfoStruct

func (*Client) LdapServerCreate 

func (c *Client) LdapServerCreate(payload *LdapServerStruct) (string, error)

LdapServerCreate - Create a new LdapServer object.

payload *LdapServerStruct object return string

func (*Client) LdapServerDelete 

func (c *Client) LdapServerDelete(r string) error

LdapServerDelete - Delete the specified LdapServer object.

r - LdapServer Object Reference

func (*Client) LdapServerList 

func (c *Client) LdapServerList() ([]*LdapServerStruct, error)

LdapServerList - List LdapServer objects on the system.

return []*LdapServerStruct

func (*Client) LdapServerRead 

func (c *Client) LdapServerRead(r string) (*LdapServerStruct, error)

LdapServerRead - Retrieve the specified LdapServer object.

r - LdapServer Object Reference return *LdapServerStruct

func (*Client) LdapServerUpdate 

func (c *Client) LdapServerUpdate(r string, payload *LdapServerStruct) error

LdapServerUpdate - Update the specified LdapServer object.

r - LdapServer Object Reference payload *LdapServerStruct object

func (*Client) LoadAndValidate 

func (c *Client) LoadAndValidate() error

LoadAndValidate establishes a new client connection

func (*Client) LocaleSettingsRead 

func (c *Client) LocaleSettingsRead(r string) (*LocaleSettingsStruct, error)

LocaleSettingsRead - Retrieve the specified LocaleSettings object.

r - LocaleSettings Object Reference return *LocaleSettingsStruct

func (*Client) LocaleSettingsUpdate 

func (c *Client) LocaleSettingsUpdate(r string, payload *LocaleSettingsStruct) error

LocaleSettingsUpdate - Update the specified LocaleSettings object.

r - LocaleSettings Object Reference payload *LocaleSettingsStruct object

func (*Client) MSSqlAvailabilityGroupListenerList 

func (c *Client) MSSqlAvailabilityGroupListenerList(availabilitygroup string) ([]*MSSqlAvailabilityGroupListenerStruct, error)

MSSqlAvailabilityGroupListenerList - Returns a list of listeners filtered by SQL Server Availability Group.

availabilitygroup ==> 

description: A reference to the SQL Server Availability Group this listener belongs to.
type: string
format: objectReference
referenceTo: /delphix-mssql-availability-group.json

return []*MSSqlAvailabilityGroupListenerStruct

func (*Client) MSSqlClusterInstanceList 

func (c *Client) MSSqlClusterInstanceList(availabilitygroup string) ([]*MSSqlClusterInstanceStruct, error)

MSSqlClusterInstanceList - Returns a list of instances filtered by SQL Server Availability Group.

availabilitygroup ==> 

type: string
format: objectReference
referenceTo: /delphix-mssql-availability-group.json
description: A reference to the SQL Server Availability Group this instance belongs to.

return []*MSSqlClusterInstanceStruct

func (*Client) MSSqlFailoverClusterInstanceList 

func (c *Client) MSSqlFailoverClusterInstanceList(repository string) ([]*MSSqlFailoverClusterInstanceStruct, error)

MSSqlFailoverClusterInstanceList - Returns a list of instances filtered by SQL Server Failover Cluster.

repository ==> 

type: string
format: objectReference
referenceTo: /delphix-mssql-failover-cluster-repository.json
description: A reference to the SQL Server Failover Cluster repository this instance belongs to.

return []*MSSqlFailoverClusterInstanceStruct

func (*Client) MSSqlFailoverClusterListenerList 

func (c *Client) MSSqlFailoverClusterListenerList(repository string) ([]*MSSqlFailoverClusterListenerStruct, error)

MSSqlFailoverClusterListenerList - Returns a list of listeners filtered by SQL Server Failover Cluster.

repository ==> 

type: string
format: objectReference
referenceTo: /delphix-mssql-failover-cluster-repository.json
description: A reference to the SQL Server Failover Cluster repository this listener belongs to.

return []*MSSqlFailoverClusterListenerStruct

func (*Client) MaskingJobDelete 

func (c *Client) MaskingJobDelete(r string) error

MaskingJobDelete - Delete the specified MaskingJob object.

r - MaskingJob Object Reference

func (*Client) MaskingJobList 

func (c *Client) MaskingJobList(container string) ([]*MaskingJobStruct, error)

MaskingJobList - Returns a list of all Masking Jobs on the system.

container ==> 

required: false
description: List only the Masking Jobs that are associated with the provided container.
type: string
format: objectReference
referenceTo: /delphix-container.json

return []*MaskingJobStruct

func (*Client) MaskingJobRead 

func (c *Client) MaskingJobRead(r string) (*MaskingJobStruct, error)

MaskingJobRead - Retrieve the specified MaskingJob object.

r - MaskingJob Object Reference return *MaskingJobStruct

func (*Client) MaskingJobUpdate 

func (c *Client) MaskingJobUpdate(r string, payload *MaskingJobStruct) error

MaskingJobUpdate - Update the specified MaskingJob object.

r - MaskingJob Object Reference payload *MaskingJobStruct object

func (*Client) MaskingServiceConfigList 

func (c *Client) MaskingServiceConfigList() ([]*MaskingServiceConfigStruct, error)

MaskingServiceConfigList - Returns a list of all Masking Jobs on the system.

return []*MaskingServiceConfigStruct

func (*Client) MaskingServiceConfigRead 

func (c *Client) MaskingServiceConfigRead(r string) (*MaskingServiceConfigStruct, error)

MaskingServiceConfigRead - Retrieve the specified MaskingServiceConfig object.

r - MaskingServiceConfig Object Reference return *MaskingServiceConfigStruct

func (*Client) MaskingServiceConfigUpdate 

func (c *Client) MaskingServiceConfigUpdate(r string, payload *MaskingServiceConfigStruct) error

MaskingServiceConfigUpdate - Update the specified MaskingServiceConfig object.

r - MaskingServiceConfig Object Reference payload *MaskingServiceConfigStruct object

func (*Client) NamespaceDelete 

func (c *Client) NamespaceDelete(r string) error

NamespaceDelete - Delete the specified Namespace object.

r - Namespace Object Reference

func (*Client) NamespaceList 

func (c *Client) NamespaceList() ([]*NamespaceStruct, error)

NamespaceList - List Namespace objects on the system.

return []*NamespaceStruct

func (*Client) NamespaceRead 

func (c *Client) NamespaceRead(r string) (*NamespaceStruct, error)

NamespaceRead - Retrieve the specified Namespace object.

r - Namespace Object Reference return *NamespaceStruct

func (*Client) NamespaceUpdate 

func (c *Client) NamespaceUpdate(r string, payload *NamespaceStruct) error

NamespaceUpdate - Update the specified Namespace object.

r - Namespace Object Reference payload *NamespaceStruct object

func (*Client) NetworkDSPTestCreate 

func (c *Client) NetworkDSPTestCreate(payload *NetworkDSPTestParametersStruct) (string, error)

NetworkDSPTestCreate - Create a new NetworkDSPTest object.

payload *NetworkDSPTestParametersStruct object return string

func (*Client) NetworkDSPTestDelete 

func (c *Client) NetworkDSPTestDelete(r string) error

NetworkDSPTestDelete - Delete the specified NetworkDSPTest object.

r - NetworkDSPTest Object Reference

func (*Client) NetworkDSPTestList 

func (c *Client) NetworkDSPTestList() ([]*NetworkDSPTestStruct, error)

NetworkDSPTestList - Returns the list of previously executed tests.

return []*NetworkDSPTestStruct

func (*Client) NetworkDSPTestRead 

func (c *Client) NetworkDSPTestRead(r string) (*NetworkDSPTestStruct, error)

NetworkDSPTestRead - Retrieve the specified NetworkDSPTest object.

r - NetworkDSPTest Object Reference return *NetworkDSPTestStruct

func (*Client) NetworkInterfaceList 

func (c *Client) NetworkInterfaceList() ([]*NetworkInterfaceStruct, error)

NetworkInterfaceList - List NetworkInterface objects on the system.

return []*NetworkInterfaceStruct

func (*Client) NetworkInterfaceRead 

func (c *Client) NetworkInterfaceRead(r string) (*NetworkInterfaceStruct, error)

NetworkInterfaceRead - Retrieve the specified NetworkInterface object.

r - NetworkInterface Object Reference return *NetworkInterfaceStruct

func (*Client) NetworkInterfaceUpdate 

func (c *Client) NetworkInterfaceUpdate(r string, payload *NetworkInterfaceStruct) error

NetworkInterfaceUpdate - Update the specified NetworkInterface object.

r - NetworkInterface Object Reference payload *NetworkInterfaceStruct object

func (*Client) NetworkLatencyTestCreate 

func (c *Client) NetworkLatencyTestCreate(payload *NetworkLatencyTestParametersStruct) (string, error)

NetworkLatencyTestCreate - Create a new NetworkLatencyTest object.

payload *NetworkLatencyTestParametersStruct object return string

func (*Client) NetworkLatencyTestDelete 

func (c *Client) NetworkLatencyTestDelete(r string) error

NetworkLatencyTestDelete - Delete the specified NetworkLatencyTest object.

r - NetworkLatencyTest Object Reference

func (*Client) NetworkLatencyTestList 

func (c *Client) NetworkLatencyTestList() ([]*NetworkLatencyTestStruct, error)

NetworkLatencyTestList - Returns the list of previously executed tests.

return []*NetworkLatencyTestStruct

func (*Client) NetworkLatencyTestRead 

func (c *Client) NetworkLatencyTestRead(r string) (*NetworkLatencyTestStruct, error)

NetworkLatencyTestRead - Retrieve the specified NetworkLatencyTest object.

r - NetworkLatencyTest Object Reference return *NetworkLatencyTestStruct

func (*Client) NetworkRouteList 

func (c *Client) NetworkRouteList() ([]*NetworkRouteStruct, error)

NetworkRouteList - Lists entries in the routing table.

return []*NetworkRouteStruct

func (*Client) NetworkThroughputTestCreate 

func (c *Client) NetworkThroughputTestCreate(payload *NetworkThroughputTestParametersStruct) (string, error)

NetworkThroughputTestCreate - Create a new NetworkThroughputTest object.

payload *NetworkThroughputTestParametersStruct object return string

func (*Client) NetworkThroughputTestDelete 

func (c *Client) NetworkThroughputTestDelete(r string) error

NetworkThroughputTestDelete - Delete the specified NetworkThroughputTest object.

r - NetworkThroughputTest Object Reference

func (*Client) NetworkThroughputTestList 

func (c *Client) NetworkThroughputTestList() ([]*NetworkThroughputTestStruct, error)

NetworkThroughputTestList - Returns the list of previously executed tests.

return []*NetworkThroughputTestStruct

func (*Client) NetworkThroughputTestRead 

func (c *Client) NetworkThroughputTestRead(r string) (*NetworkThroughputTestStruct, error)

NetworkThroughputTestRead - Retrieve the specified NetworkThroughputTest object.

r - NetworkThroughputTest Object Reference return *NetworkThroughputTestStruct

func (*Client) NotificationList 

func (c *Client) NotificationList(timeout string, max string, channel string) ([]Notification, error)

NotificationList - Returns a list of pending notifications for the current session.

timeout ==> 

type: string
description: Timeout, in milliseconds, to wait for one or more responses.

max ==> 

description: Maximum number of entries to return at once.
type: string

channel ==> 

type: string
description: Client-specific ID to specify an independent channel.

return []Notification

func (*Client) OperationTemplateCreate 

func (c *Client) OperationTemplateCreate(payload *OperationTemplateStruct) (string, error)

OperationTemplateCreate - Create a new OperationTemplate object.

payload *OperationTemplateStruct object return string

func (*Client) OperationTemplateDelete 

func (c *Client) OperationTemplateDelete(r string) error

OperationTemplateDelete - Delete the specified OperationTemplate object.

r - OperationTemplate Object Reference

func (*Client) OperationTemplateList 

func (c *Client) OperationTemplateList() ([]*OperationTemplateStruct, error)

OperationTemplateList - Lists templates available in the Delphix Engine.

return []*OperationTemplateStruct

func (*Client) OperationTemplateRead 

func (c *Client) OperationTemplateRead(r string) (*OperationTemplateStruct, error)

OperationTemplateRead - Retrieve the specified OperationTemplate object.

r - OperationTemplate Object Reference return *OperationTemplateStruct

func (*Client) OperationTemplateUpdate 

func (c *Client) OperationTemplateUpdate(r string, payload *OperationTemplateStruct) error

OperationTemplateUpdate - Update the specified OperationTemplate object.

r - OperationTemplate Object Reference payload *OperationTemplateStruct object

func (*Client) OracleClusterNodeCreate 

func (c *Client) OracleClusterNodeCreate(payload *OracleClusterNodeCreateParametersStruct) (string, error)

OracleClusterNodeCreate - Create a new OracleClusterNode object.

payload *OracleClusterNodeCreateParametersStruct object return string

func (*Client) OracleClusterNodeDelete 

func (c *Client) OracleClusterNodeDelete(r string) error

OracleClusterNodeDelete - Delete the specified OracleClusterNode object.

r - OracleClusterNode Object Reference

func (*Client) OracleClusterNodeList 

func (c *Client) OracleClusterNodeList(cluster string) ([]*OracleClusterNodeStruct, error)

OracleClusterNodeList - Returns a list of host nodes filtered by cluster.

cluster ==> 

type: string
format: objectReference
description: The cluster to filter by.
referenceTo: /delphix-oracle-cluster.json
mapsTo: cluster

return []*OracleClusterNodeStruct

func (*Client) OracleClusterNodeRead 

func (c *Client) OracleClusterNodeRead(r string) (*OracleClusterNodeStruct, error)

OracleClusterNodeRead - Retrieve the specified OracleClusterNode object.

r - OracleClusterNode Object Reference return *OracleClusterNodeStruct

func (*Client) OracleClusterNodeUpdate 

func (c *Client) OracleClusterNodeUpdate(r string, payload *OracleClusterNodeStruct) error

OracleClusterNodeUpdate - Update the specified OracleClusterNode object.

r - OracleClusterNode Object Reference payload *OracleClusterNodeStruct object

func (*Client) OracleListenerCreate 

func (c *Client) OracleListenerCreate(payload OracleListener) (string, error)

OracleListenerCreate - Create a new OracleListener object.

payload OracleListener object return string

func (*Client) OracleListenerDelete 

func (c *Client) OracleListenerDelete(r string) error

OracleListenerDelete - Delete the specified OracleListener object.

r - OracleListener Object Reference

func (*Client) OracleListenerList 

func (c *Client) OracleListenerList(typeOracleListener string, environment string) ([]OracleListener, error)

OracleListenerList - Returns a list of listeners within the environment or the system.

typeOracleListener ==> 

description: Restrict listeners to type.
type: string
enum: [OracleNodeListener OracleScanListener]
required: false
mapsTo: type

environment ==> 

description: Restrict listeners belonging to the specified environment.
type: string
format: objectReference
referenceTo: /delphix-source-environment.json
required: false
mapsTo: environment

return []OracleListener

func (*Client) OracleListenerRead 

func (c *Client) OracleListenerRead(r string) (OracleListener, error)

OracleListenerRead - Retrieve the specified OracleListener object.

r - OracleListener Object Reference return OracleListener

func (*Client) OracleListenerUpdate 

func (c *Client) OracleListenerUpdate(r string, payload OracleListener) error

OracleListenerUpdate - Update the specified OracleListener object.

r - OracleListener Object Reference payload OracleListener object

func (*Client) OracleTimeflowLogList 

func (c *Client) OracleTimeflowLogList(timeflow string, snapshot string, fromDate string, toDate string, toScn string, missing *bool, database string, fromScn string, pageSize *int, pageOffset *int) ([]OracleTimeflowLog, error)

OracleTimeflowLogList - Returns a list of fetched or missing Oracle logs for a database, TimeFlow or snapshot. The logs are returned in ascending order by TimeFlow, SCN.

timeflow ==> 

type: string
description: Return logs in the specified TimeFlow. This option is mutually exclusive with the "snapshot" and "database" options.
format: objectReference
referenceTo: /delphix-oracle-timeflow.json
mapsTo: timeflow

snapshot ==> 

referenceTo: /delphix-oracle-snapshot.json
type: string
description: Return logs for the specified snapshot up to the next snapshot. This option is mutually exclusive with the "TimeFlow" and "database" options.
format: objectReference

fromDate ==> 

description: Return logs created after this date.
format: date
type: string

toDate ==> 

description: Return logs created before than this date.
format: date
type: string

toScn ==> 

description: Return logs with SCNs less than or equal to this value.
type: string

missing ==> 

type: boolean
description: Only return the missing logs.

database ==> 

type: string
description: Return logs on all TimeFlows associated with the container. This option is mutually exclusive with the "TimeFlow" and "snapshot" options.
format: objectReference
referenceTo: /delphix-oracle-db-container.json

fromScn ==> 

type: string
description: Return logs with SCNs greater than or equal to this value.

pageSize ==> 

type: integer
default: 25
minimum: 0
description: Limit the number of logs returned.

pageOffset ==> 

description: Page offset within log list, in units of pageSize chunks.
type: integer

return []OracleTimeflowLog

func (*Client) PasswordPolicyCreate 

func (c *Client) PasswordPolicyCreate(payload *PasswordPolicyStruct) (string, error)

PasswordPolicyCreate - Create a new PasswordPolicy object.

payload *PasswordPolicyStruct object return string

func (*Client) PasswordPolicyDelete 

func (c *Client) PasswordPolicyDelete(r string) error

PasswordPolicyDelete - Delete the specified PasswordPolicy object.

r - PasswordPolicy Object Reference

func (*Client) PasswordPolicyList 

func (c *Client) PasswordPolicyList() ([]*PasswordPolicyStruct, error)

PasswordPolicyList - Lists password policies in the system.

return []*PasswordPolicyStruct

func (*Client) PasswordPolicyRead 

func (c *Client) PasswordPolicyRead(r string) (*PasswordPolicyStruct, error)

PasswordPolicyRead - Retrieve the specified PasswordPolicy object.

r - PasswordPolicy Object Reference return *PasswordPolicyStruct

func (*Client) PasswordPolicyUpdate 

func (c *Client) PasswordPolicyUpdate(r string, payload *PasswordPolicyStruct) error

PasswordPolicyUpdate - Update the specified PasswordPolicy object.

r - PasswordPolicy Object Reference payload *PasswordPolicyStruct object

func (*Client) PermissionList 

func (c *Client) PermissionList() ([]*PermissionStruct, error)

PermissionList - Lists permissions available in the system.

return []*PermissionStruct

func (*Client) PermissionRead 

func (c *Client) PermissionRead(r string) (*PermissionStruct, error)

PermissionRead - Retrieve the specified Permission object.

r - Permission Object Reference return *PermissionStruct

func (*Client) PhoneHomeServiceRead 

func (c *Client) PhoneHomeServiceRead(r string) (*PhoneHomeServiceStruct, error)

PhoneHomeServiceRead - Retrieve the specified PhoneHomeService object.

r - PhoneHomeService Object Reference return *PhoneHomeServiceStruct

func (*Client) PhoneHomeServiceUpdate 

func (c *Client) PhoneHomeServiceUpdate(r string, payload *PhoneHomeServiceStruct) error

PhoneHomeServiceUpdate - Update the specified PhoneHomeService object.

r - PhoneHomeService Object Reference payload *PhoneHomeServiceStruct object

func (*Client) PolicyCreate 

func (c *Client) PolicyCreate(payload Policy) (string, error)

PolicyCreate - Create a new Policy object.

payload Policy object return string

func (*Client) PolicyDelete 

func (c *Client) PolicyDelete(r string) error

PolicyDelete - Delete the specified Policy object.

r - Policy Object Reference

func (*Client) PolicyList 

func (c *Client) PolicyList(typePolicy string, target string, effective string) ([]Policy, error)

PolicyList - Returns a list of policies in the domain.

typePolicy ==> 

type: string
description: Limit policies to those of the given type.

target ==> 

type: string
format: objectReference
referenceTo: /delphix-user-object.json
description: Limit policies to those affecting a particular object on the system.

effective ==> 

description: Whether to include effective policies for the target.
type: string

return []Policy

func (*Client) PolicyRead 

func (c *Client) PolicyRead(r string) (Policy, error)

PolicyRead - Retrieve the specified Policy object.

r - Policy Object Reference return Policy

func (*Client) PolicyUpdate 

func (c *Client) PolicyUpdate(r string, payload Policy) error

PolicyUpdate - Update the specified Policy object.

r - Policy Object Reference payload Policy object

func (*Client) ProxyServiceRead 

func (c *Client) ProxyServiceRead(r string) (*ProxyServiceStruct, error)

ProxyServiceRead - Retrieve the specified ProxyService object.

r - ProxyService Object Reference return *ProxyServiceStruct

func (*Client) ProxyServiceUpdate 

func (c *Client) ProxyServiceUpdate(r string, payload *ProxyServiceStruct) error

ProxyServiceUpdate - Update the specified ProxyService object.

r - ProxyService Object Reference payload *ProxyServiceStruct object

func (*Client) PublicSystemInfoRead 

func (c *Client) PublicSystemInfoRead(r string) (*PublicSystemInfoStruct, error)

PublicSystemInfoRead - Retrieve the specified PublicSystemInfo object.

r - PublicSystemInfo Object Reference return *PublicSystemInfoStruct

func (*Client) RegistrationInfoRead 

func (c *Client) RegistrationInfoRead(r string) (*RegistrationInfoStruct, error)

RegistrationInfoRead - Retrieve the specified RegistrationInfo object.

r - RegistrationInfo Object Reference return *RegistrationInfoStruct

func (*Client) RegistrationStatusRead 

func (c *Client) RegistrationStatusRead(r string) (*RegistrationStatusStruct, error)

RegistrationStatusRead - Retrieve the specified RegistrationStatus object.

r - RegistrationStatus Object Reference return *RegistrationStatusStruct

func (*Client) RegistrationStatusUpdate 

func (c *Client) RegistrationStatusUpdate(r string, payload *RegistrationStatusStruct) error

RegistrationStatusUpdate - Update the specified RegistrationStatus object.

r - RegistrationStatus Object Reference payload *RegistrationStatusStruct object

func (*Client) ReplicationSourceStateList 

func (c *Client) ReplicationSourceStateList() ([]*ReplicationSourceStateStruct, error)

ReplicationSourceStateList - List ReplicationSourceState objects on the system.

return []*ReplicationSourceStateStruct

func (*Client) ReplicationSourceStateRead 

func (c *Client) ReplicationSourceStateRead(r string) (*ReplicationSourceStateStruct, error)

ReplicationSourceStateRead - Retrieve the specified ReplicationSourceState object.

r - ReplicationSourceState Object Reference return *ReplicationSourceStateStruct

func (*Client) ReplicationSpecCreate 

func (c *Client) ReplicationSpecCreate(payload *ReplicationSpecStruct) (string, error)

ReplicationSpecCreate - Create a new ReplicationSpec object.

payload *ReplicationSpecStruct object return string

func (*Client) ReplicationSpecDelete 

func (c *Client) ReplicationSpecDelete(r string) error

ReplicationSpecDelete - Delete the specified ReplicationSpec object.

r - ReplicationSpec Object Reference

func (*Client) ReplicationSpecList 

func (c *Client) ReplicationSpecList() ([]*ReplicationSpecStruct, error)

ReplicationSpecList - List ReplicationSpec objects on the system.

return []*ReplicationSpecStruct

func (*Client) ReplicationSpecRead 

func (c *Client) ReplicationSpecRead(r string) (*ReplicationSpecStruct, error)

ReplicationSpecRead - Retrieve the specified ReplicationSpec object.

r - ReplicationSpec Object Reference return *ReplicationSpecStruct

func (*Client) ReplicationSpecUpdate 

func (c *Client) ReplicationSpecUpdate(r string, payload *ReplicationSpecStruct) error

ReplicationSpecUpdate - Update the specified ReplicationSpec object.

r - ReplicationSpec Object Reference payload *ReplicationSpecStruct object

func (*Client) ReplicationTargetStateList 

func (c *Client) ReplicationTargetStateList() ([]*ReplicationTargetStateStruct, error)

ReplicationTargetStateList - List ReplicationTargetState objects on the system.

return []*ReplicationTargetStateStruct

func (*Client) ReplicationTargetStateRead 

func (c *Client) ReplicationTargetStateRead(r string) (*ReplicationTargetStateStruct, error)

ReplicationTargetStateRead - Retrieve the specified ReplicationTargetState object.

r - ReplicationTargetState Object Reference return *ReplicationTargetStateStruct

func (*Client) ReturnSshPublicKey 

func (c *Client) ReturnSshPublicKey() (string, error)

ReturnSshPublicKey returns the SSH Public Key of the Delphix Engine

func (*Client) RoleCreate 

func (c *Client) RoleCreate(payload *RoleStruct) (string, error)

RoleCreate - Create a new Role object.

payload *RoleStruct object return string

func (*Client) RoleDelete 

func (c *Client) RoleDelete(r string) error

RoleDelete - Delete the specified Role object.

r - Role Object Reference

func (*Client) RoleList 

func (c *Client) RoleList() ([]*RoleStruct, error)

RoleList - Lists roles available in the system.

return []*RoleStruct

func (*Client) RoleRead 

func (c *Client) RoleRead(r string) (*RoleStruct, error)

RoleRead - Retrieve the specified Role object.

r - Role Object Reference return *RoleStruct

func (*Client) RoleUpdate 

func (c *Client) RoleUpdate(r string, payload *RoleStruct) error

RoleUpdate - Update the specified Role object.

r - Role Object Reference payload *RoleStruct object

func (*Client) SMTPConfigRead 

func (c *Client) SMTPConfigRead(r string) (*SMTPConfigStruct, error)

SMTPConfigRead - Retrieve the specified SMTPConfig object.

r - SMTPConfig Object Reference return *SMTPConfigStruct

func (*Client) SMTPConfigUpdate 

func (c *Client) SMTPConfigUpdate(r string, payload *SMTPConfigStruct) error

SMTPConfigUpdate - Update the specified SMTPConfig object.

r - SMTPConfig Object Reference payload *SMTPConfigStruct object

func (*Client) SNMPConfigRead 

func (c *Client) SNMPConfigRead(r string) (*SNMPConfigStruct, error)

SNMPConfigRead - Retrieve the specified SNMPConfig object.

r - SNMPConfig Object Reference return *SNMPConfigStruct

func (*Client) SNMPConfigUpdate 

func (c *Client) SNMPConfigUpdate(r string, payload *SNMPConfigStruct) error

SNMPConfigUpdate - Update the specified SNMPConfig object.

r - SNMPConfig Object Reference payload *SNMPConfigStruct object

func (*Client) SNMPManagerCreate 

func (c *Client) SNMPManagerCreate(payload *SNMPManagerStruct) (string, error)

SNMPManagerCreate - Create a new SNMPManager object.

payload *SNMPManagerStruct object return string

func (*Client) SNMPManagerDelete 

func (c *Client) SNMPManagerDelete(r string) error

SNMPManagerDelete - Delete the specified SNMPManager object.

r - SNMPManager Object Reference

func (*Client) SNMPManagerList 

func (c *Client) SNMPManagerList() ([]*SNMPManagerStruct, error)

SNMPManagerList - Lists SNMP managers in the system.

return []*SNMPManagerStruct

func (*Client) SNMPManagerRead 

func (c *Client) SNMPManagerRead(r string) (*SNMPManagerStruct, error)

SNMPManagerRead - Retrieve the specified SNMPManager object.

r - SNMPManager Object Reference return *SNMPManagerStruct

func (*Client) SNMPManagerUpdate 

func (c *Client) SNMPManagerUpdate(r string, payload *SNMPManagerStruct) error

SNMPManagerUpdate - Update the specified SNMPManager object.

r - SNMPManager Object Reference payload *SNMPManagerStruct object

func (*Client) SamlInfoRead 

func (c *Client) SamlInfoRead(r string) (*SamlInfoStruct, error)

SamlInfoRead - Retrieve the specified SamlInfo object.

r - SamlInfo Object Reference return *SamlInfoStruct

func (*Client) SamlServiceProviderCreate 

func (c *Client) SamlServiceProviderCreate(payload *SamlServiceProviderStruct) (string, error)

SamlServiceProviderCreate - Create a new SamlServiceProvider object.

payload *SamlServiceProviderStruct object return string

func (*Client) SamlServiceProviderDelete 

func (c *Client) SamlServiceProviderDelete(r string) error

SamlServiceProviderDelete - Delete the specified SamlServiceProvider object.

r - SamlServiceProvider Object Reference

func (*Client) SamlServiceProviderList 

func (c *Client) SamlServiceProviderList() ([]*SamlServiceProviderStruct, error)

SamlServiceProviderList - List SamlServiceProvider objects on the system.

return []*SamlServiceProviderStruct

func (*Client) SamlServiceProviderRead 

func (c *Client) SamlServiceProviderRead(r string) (*SamlServiceProviderStruct, error)

SamlServiceProviderRead - Retrieve the specified SamlServiceProvider object.

r - SamlServiceProvider Object Reference return *SamlServiceProviderStruct

func (*Client) SamlServiceProviderUpdate 

func (c *Client) SamlServiceProviderUpdate(r string, payload *SamlServiceProviderStruct) error

SamlServiceProviderUpdate - Update the specified SamlServiceProvider object.

r - SamlServiceProvider Object Reference payload *SamlServiceProviderStruct object

func (*Client) SchemaRead 

func (c *Client) SchemaRead(r string) (*SchemaStruct, error)

SchemaRead - Retrieve the specified Schema object.

r - Schema Object Reference return *SchemaStruct

func (*Client) ScrubStatusRead 

func (c *Client) ScrubStatusRead(r string) (*ScrubStatusStruct, error)

ScrubStatusRead - Retrieve the specified ScrubStatus object.

r - ScrubStatus Object Reference return *ScrubStatusStruct

func (*Client) SecurityConfigRead 

func (c *Client) SecurityConfigRead(r string) (*SecurityConfigStruct, error)

SecurityConfigRead - Retrieve the specified SecurityConfig object.

r - SecurityConfig Object Reference return *SecurityConfigStruct

func (*Client) SecurityConfigUpdate 

func (c *Client) SecurityConfigUpdate(r string, payload *SecurityConfigStruct) error

SecurityConfigUpdate - Update the specified SecurityConfig object.

r - SecurityConfig Object Reference payload *SecurityConfigStruct object

func (*Client) SerializationPointList 

func (c *Client) SerializationPointList() ([]*SerializationPointStruct, error)

SerializationPointList - List SerializationPoint objects on the system.

return []*SerializationPointStruct

func (*Client) SerializationPointRead 

func (c *Client) SerializationPointRead(r string) (*SerializationPointStruct, error)

SerializationPointRead - Retrieve the specified SerializationPoint object.

r - SerializationPoint Object Reference return *SerializationPointStruct

func (*Client) SnapshotCapacityDataList 

func (c *Client) SnapshotCapacityDataList(container string, pageSize *int, pageOffset *int) ([]*SnapshotCapacityDataStruct, error)

SnapshotCapacityDataList - Lists capacity metrics for all snapshots in the syste sorted by snapshot space usage decreasing.

container ==> 

description: The container to list snapshot data for.
mapsTo: container
type: string
format: objectReference
referenceTo: /delphix-container.json

pageSize ==> 

description: Limit the number of entries returned.
type: integer
minimum: 0

pageOffset ==> 

description: Offset within list, in units of pageSize chunks.
type: integer
minimum: 0

return []*SnapshotCapacityDataStruct

func (*Client) SourceConfigCreate 

func (c *Client) SourceConfigCreate(payload SourceConfig) (string, error)

SourceConfigCreate - Create a new SourceConfig object.

payload SourceConfig object return string

func (*Client) SourceConfigDelete 

func (c *Client) SourceConfigDelete(r string) error

SourceConfigDelete - Delete the specified SourceConfig object.

r - SourceConfig Object Reference

func (*Client) SourceConfigList 

func (c *Client) SourceConfigList(repository string, environment string, cdbConfig string, pdbConfigOnly *bool) ([]SourceConfig, error)

SourceConfigList - Returns a list of source configs within the repository or the environment.

repository ==> 

referenceTo: /delphix-source-repository.json
mapsTo: repository
type: string
description: Restrict source configs to those belonging to the specified repository. This option is mutually exclusive with all other options.
format: objectReference

environment ==> 

format: objectReference
referenceTo: /delphix-source-environment.json
mapsTo: repository.environment.reference
type: string
description: Restrict source configs to those belonging to the specified environment. This option is mutually exclusive with all other options.

cdbConfig ==> 

format: objectReference
referenceTo: /delphix-oracle-db-config.json
type: string
description: Restrict PDB configs to those belonging to the specified CDB source config.

pdbConfigOnly ==> 

description: Restrict source configs to be Oracle PDB configs only.
type: boolean

return []SourceConfig

func (*Client) SourceConfigRead 

func (c *Client) SourceConfigRead(r string) (SourceConfig, error)

SourceConfigRead - Retrieve the specified SourceConfig object.

r - SourceConfig Object Reference return SourceConfig

func (*Client) SourceConfigUpdate 

func (c *Client) SourceConfigUpdate(r string, payload SourceConfig) error

SourceConfigUpdate - Update the specified SourceConfig object.

r - SourceConfig Object Reference payload SourceConfig object

func (*Client) SourceEnvironmentCreate 

func (c *Client) SourceEnvironmentCreate(payload SourceEnvironmentCreateParameters) (string, error)

SourceEnvironmentCreate - Create a new SourceEnvironment object.

payload SourceEnvironmentCreateParameters object return string

func (*Client) SourceEnvironmentDelete 

func (c *Client) SourceEnvironmentDelete(r string) error

SourceEnvironmentDelete - Delete the specified SourceEnvironment object.

r - SourceEnvironment Object Reference

func (*Client) SourceEnvironmentList 

func (c *Client) SourceEnvironmentList(typeSourceEnvironment string) ([]SourceEnvironment, error)

SourceEnvironmentList - Returns the list of all source environments.

typeSourceEnvironment ==> 

type: string
description: Filter the results based on the type of environment.
enum: [WindowsHostEnvironment UnixHostEnvironment ASEUnixHostEnvironment OracleCluster]

return []SourceEnvironment

func (*Client) SourceEnvironmentListTest 

func (c *Client) SourceEnvironmentListTest(typeSourceEnvironment string) ([]SourceEnvironment, error)

func (*Client) SourceEnvironmentRead 

func (c *Client) SourceEnvironmentRead(r string) (SourceEnvironment, error)

SourceEnvironmentRead - Retrieve the specified SourceEnvironment object.

r - SourceEnvironment Object Reference return SourceEnvironment

func (*Client) SourceEnvironmentUpdate 

func (c *Client) SourceEnvironmentUpdate(r string, payload SourceEnvironment) error

SourceEnvironmentUpdate - Update the specified SourceEnvironment object.

r - SourceEnvironment Object Reference payload SourceEnvironment object

func (*Client) SourceList 

func (c *Client) SourceList(config string, allSources *bool, repository string, environment string, includeHosts *bool, database string) ([]Source, error)

SourceList - Lists sources on the system.

config ==> 

mapsTo: config
description: List visible sources associated with the given sourceconfig reference. Visible sources are of type LINKED or VIRTUAL.
type: string
format: objectReference
referenceTo: /delphix-source-config.json

allSources ==> 

description: List all sources associated with the given source container reference.
type: boolean

repository ==> 

mapsTo: config.repository.reference
description: List sources associated with the given source repository reference.
type: string
format: objectReference
referenceTo: /delphix-source-repository.json

environment ==> 

format: objectReference
referenceTo: /delphix-source-environment.json
mapsTo: config.repository.environment.reference
description: List sources associated with the given source environment reference.
type: string

includeHosts ==> 

description: Whether to include the list of hosts for each source in the response.
type: boolean

database ==> 

description: List visible sources associated with the given container reference. Visible sources are of type LINKED or VIRTUAL.
type: string
format: objectReference
referenceTo: /delphix-container.json
mapsTo: container

return []Source

func (*Client) SourceRead 

func (c *Client) SourceRead(r string) (Source, error)

SourceRead - Retrieve the specified Source object.

r - Source Object Reference return Source

func (*Client) SourceRepositoryCreate 

func (c *Client) SourceRepositoryCreate(payload SourceRepository) (string, error)

SourceRepositoryCreate - Create a new SourceRepository object.

payload SourceRepository object return string

func (*Client) SourceRepositoryDelete 

func (c *Client) SourceRepositoryDelete(r string) error

SourceRepositoryDelete - Delete the specified SourceRepository object.

r - SourceRepository Object Reference

func (*Client) SourceRepositoryList 

func (c *Client) SourceRepositoryList(environment string) ([]SourceRepository, error)

SourceRepositoryList - Returns a list of source repositories within the environment or the system.

environment ==> 

type: string
format: objectReference
description: Restrict source repositories belong to the specified environment.
referenceTo: /delphix-source-environment.json
mapsTo: environment

return []SourceRepository

func (*Client) SourceRepositoryRead 

func (c *Client) SourceRepositoryRead(r string) (SourceRepository, error)

SourceRepositoryRead - Retrieve the specified SourceRepository object.

r - SourceRepository Object Reference return SourceRepository

func (*Client) SourceRepositoryTemplateCreate 

func (c *Client) SourceRepositoryTemplateCreate(payload *SourceRepositoryTemplateStruct) (string, error)

SourceRepositoryTemplateCreate - Create a new SourceRepositoryTemplate object.

payload *SourceRepositoryTemplateStruct object return string

func (*Client) SourceRepositoryTemplateDelete 

func (c *Client) SourceRepositoryTemplateDelete(r string) error

SourceRepositoryTemplateDelete - Delete the specified SourceRepositoryTemplate object.

r - SourceRepositoryTemplate Object Reference

func (*Client) SourceRepositoryTemplateList 

func (c *Client) SourceRepositoryTemplateList() ([]*SourceRepositoryTemplateStruct, error)

SourceRepositoryTemplateList - Returns the list of repository templates.

return []*SourceRepositoryTemplateStruct

func (*Client) SourceRepositoryTemplateRead 

func (c *Client) SourceRepositoryTemplateRead(r string) (*SourceRepositoryTemplateStruct, error)

SourceRepositoryTemplateRead - Retrieve the specified SourceRepositoryTemplate object.

r - SourceRepositoryTemplate Object Reference return *SourceRepositoryTemplateStruct

func (*Client) SourceRepositoryTemplateUpdate 

func (c *Client) SourceRepositoryTemplateUpdate(r string, payload *SourceRepositoryTemplateStruct) error

SourceRepositoryTemplateUpdate - Update the specified SourceRepositoryTemplate object.

r - SourceRepositoryTemplate Object Reference payload *SourceRepositoryTemplateStruct object

func (*Client) SourceRepositoryUpdate 

func (c *Client) SourceRepositoryUpdate(r string, payload SourceRepository) error

SourceRepositoryUpdate - Update the specified SourceRepository object.

r - SourceRepository Object Reference payload SourceRepository object

func (*Client) SourceUpdate 

func (c *Client) SourceUpdate(r string, payload Source) error

SourceUpdate - Update the specified Source object.

r - Source Object Reference payload Source object

func (*Client) SplunkHecConfigCreate 

func (c *Client) SplunkHecConfigCreate(payload *SplunkHecConfigStruct) (string, error)

SplunkHecConfigCreate - Create a new SplunkHecConfig object.

payload *SplunkHecConfigStruct object return string

func (*Client) SplunkHecConfigDelete 

func (c *Client) SplunkHecConfigDelete(r string) error

SplunkHecConfigDelete - Delete the specified SplunkHecConfig object.

r - SplunkHecConfig Object Reference

func (*Client) SplunkHecConfigList 

func (c *Client) SplunkHecConfigList() ([]*SplunkHecConfigStruct, error)

SplunkHecConfigList - List SplunkHecConfig objects on the system.

return []*SplunkHecConfigStruct

func (*Client) SplunkHecConfigRead 

func (c *Client) SplunkHecConfigRead(r string) (*SplunkHecConfigStruct, error)

SplunkHecConfigRead - Retrieve the specified SplunkHecConfig object.

r - SplunkHecConfig Object Reference return *SplunkHecConfigStruct

func (*Client) SplunkHecConfigUpdate 

func (c *Client) SplunkHecConfigUpdate(r string, payload *SplunkHecConfigStruct) error

SplunkHecConfigUpdate - Update the specified SplunkHecConfig object.

r - SplunkHecConfig Object Reference payload *SplunkHecConfigStruct object

func (*Client) StatisticList 

func (c *Client) StatisticList() ([]*StatisticStruct, error)

StatisticList - Returns a list of statistics in the system.

return []*StatisticStruct

func (*Client) StatisticRead 

func (c *Client) StatisticRead(r string) (*StatisticStruct, error)

StatisticRead - Retrieve the specified Statistic object.

r - Statistic Object Reference return *StatisticStruct

func (*Client) StatisticSliceCreate 

func (c *Client) StatisticSliceCreate(payload *StatisticSliceStruct) (string, error)

StatisticSliceCreate - Create a new StatisticSlice object.

payload *StatisticSliceStruct object return string

func (*Client) StatisticSliceDelete 

func (c *Client) StatisticSliceDelete(r string) error

StatisticSliceDelete - Delete the specified StatisticSlice object.

r - StatisticSlice Object Reference

func (*Client) StatisticSliceList 

func (c *Client) StatisticSliceList() ([]*StatisticSliceStruct, error)

StatisticSliceList - Returns a list of statistics in the system.

return []*StatisticSliceStruct

func (*Client) StatisticSliceRead 

func (c *Client) StatisticSliceRead(r string) (*StatisticSliceStruct, error)

StatisticSliceRead - Retrieve the specified StatisticSlice object.

r - StatisticSlice Object Reference return *StatisticSliceStruct

func (*Client) StorageDeviceList 

func (c *Client) StorageDeviceList() ([]*StorageDeviceStruct, error)

StorageDeviceList - List StorageDevice objects on the system.

return []*StorageDeviceStruct

func (*Client) StorageDeviceRead 

func (c *Client) StorageDeviceRead(r string) (*StorageDeviceStruct, error)

StorageDeviceRead - Retrieve the specified StorageDevice object.

r - StorageDevice Object Reference return *StorageDeviceStruct

func (*Client) StorageDeviceRemovalStatusRead 

func (c *Client) StorageDeviceRemovalStatusRead(r string) (*StorageDeviceRemovalStatusStruct, error)

StorageDeviceRemovalStatusRead - Retrieve the specified StorageDeviceRemovalStatus object.

r - StorageDeviceRemovalStatus Object Reference return *StorageDeviceRemovalStatusStruct

func (*Client) StorageTestCreate 

func (c *Client) StorageTestCreate(payload *StorageTestParametersStruct) (string, error)

StorageTestCreate - Create a new StorageTest object.

payload *StorageTestParametersStruct object return string

func (*Client) StorageTestDelete 

func (c *Client) StorageTestDelete(r string) error

StorageTestDelete - Delete the specified StorageTest object.

r - StorageTest Object Reference

func (*Client) StorageTestList 

func (c *Client) StorageTestList() ([]*StorageTestStruct, error)

StorageTestList - Returns the list of previously executed tests.

return []*StorageTestStruct

func (*Client) StorageTestRead 

func (c *Client) StorageTestRead(r string) (*StorageTestStruct, error)

StorageTestRead - Retrieve the specified StorageTest object.

r - StorageTest Object Reference return *StorageTestStruct

func (*Client) SupportAccessStateRead 

func (c *Client) SupportAccessStateRead(r string) (*SupportAccessStateStruct, error)

SupportAccessStateRead - Retrieve the specified SupportAccessState object.

r - SupportAccessState Object Reference return *SupportAccessStateStruct

func (*Client) SupportAccessStateUpdate 

func (c *Client) SupportAccessStateUpdate(r string, payload *SupportAccessStateStruct) error

SupportAccessStateUpdate - Update the specified SupportAccessState object.

r - SupportAccessState Object Reference payload *SupportAccessStateStruct object

func (*Client) SyncDatabase 

func (c *Client) SyncDatabase(r string) error

SyncDatabase performs a snapsync on a database

func (*Client) SyslogConfigRead 

func (c *Client) SyslogConfigRead(r string) (*SyslogConfigStruct, error)

SyslogConfigRead - Retrieve the specified SyslogConfig object.

r - SyslogConfig Object Reference return *SyslogConfigStruct

func (*Client) SyslogConfigUpdate 

func (c *Client) SyslogConfigUpdate(r string, payload *SyslogConfigStruct) error

SyslogConfigUpdate - Update the specified SyslogConfig object.

r - SyslogConfig Object Reference payload *SyslogConfigStruct object

func (*Client) SystemInfoRead 

func (c *Client) SystemInfoRead(r string) (*SystemInfoStruct, error)

SystemInfoRead - Retrieve the specified SystemInfo object.

r - SystemInfo Object Reference return *SystemInfoStruct

func (*Client) SystemInfoUpdate 

func (c *Client) SystemInfoUpdate(r string, payload *SystemInfoStruct) error

SystemInfoUpdate - Update the specified SystemInfo object.

r - SystemInfo Object Reference payload *SystemInfoStruct object

func (*Client) SystemPackageList 

func (c *Client) SystemPackageList() ([]*SystemPackageStruct, error)

SystemPackageList - List the packages that can be changed via the web services.

return []*SystemPackageStruct

func (*Client) SystemPackageRead 

func (c *Client) SystemPackageRead(r string) (*SystemPackageStruct, error)

SystemPackageRead - Retrieve the specified SystemPackage object.

r - SystemPackage Object Reference return *SystemPackageStruct

func (*Client) SystemPackageUpdate 

func (c *Client) SystemPackageUpdate(r string, payload *SystemPackageStruct) error

SystemPackageUpdate - Update the specified SystemPackage object.

r - SystemPackage Object Reference payload *SystemPackageStruct object

func (*Client) SystemVersionDelete 

func (c *Client) SystemVersionDelete(r string) error

SystemVersionDelete - Delete the specified SystemVersion object.

r - SystemVersion Object Reference

func (*Client) SystemVersionList 

func (c *Client) SystemVersionList() ([]*SystemVersionStruct, error)

SystemVersionList - List SystemVersion objects on the system.

return []*SystemVersionStruct

func (*Client) SystemVersionRead 

func (c *Client) SystemVersionRead(r string) (*SystemVersionStruct, error)

SystemVersionRead - Retrieve the specified SystemVersion object.

r - SystemVersion Object Reference return *SystemVersionStruct

func (*Client) TimeConfigRead 

func (c *Client) TimeConfigRead(r string) (*TimeConfigStruct, error)

TimeConfigRead - Retrieve the specified TimeConfig object.

r - TimeConfig Object Reference return *TimeConfigStruct

func (*Client) TimeConfigUpdate 

func (c *Client) TimeConfigUpdate(r string, payload *TimeConfigStruct) error

TimeConfigUpdate - Update the specified TimeConfig object.

r - TimeConfig Object Reference payload *TimeConfigStruct object

func (*Client) TimeZoneList 

func (c *Client) TimeZoneList(date string) ([]*TimeZoneStruct, error)

TimeZoneList - Lists all of the supported time zones.

date ==> 

description: The offset of this time zone from UTC is calculated at this date. If Daylight Saving Time is in effect at the specified date, the offset value is adjusted with the amount of daylight saving. If no date is specified then a default time of now is used.
type: string
format: date

return []*TimeZoneStruct

func (*Client) TimeflowBookmarkCreate 

func (c *Client) TimeflowBookmarkCreate(payload *TimeflowBookmarkCreateParametersStruct) (string, error)

TimeflowBookmarkCreate - Create a new TimeflowBookmark object.

payload *TimeflowBookmarkCreateParametersStruct object return string

func (*Client) TimeflowBookmarkDelete 

func (c *Client) TimeflowBookmarkDelete(r string) error

TimeflowBookmarkDelete - Delete the specified TimeflowBookmark object.

r - TimeflowBookmark Object Reference

func (*Client) TimeflowBookmarkList 

func (c *Client) TimeflowBookmarkList(database string) ([]*TimeflowBookmarkStruct, error)

TimeflowBookmarkList - Returns a list of all TimeFlow bookmarks.

database ==> 

mapsTo: timeflow.container
type: string
description: Filter results based on specified database.
format: objectReference
referenceTo: /delphix-container.json

return []*TimeflowBookmarkStruct

func (*Client) TimeflowBookmarkRead 

func (c *Client) TimeflowBookmarkRead(r string) (*TimeflowBookmarkStruct, error)

TimeflowBookmarkRead - Retrieve the specified TimeflowBookmark object.

r - TimeflowBookmark Object Reference return *TimeflowBookmarkStruct

func (*Client) TimeflowList 

func (c *Client) TimeflowList(database string) ([]Timeflow, error)

TimeflowList - List Timeflow objects on the system.

database ==> 

type: string
description: List only TimeFlows within this database.
format: objectReference
referenceTo: /delphix-container.json
mapsTo: container

return []Timeflow

func (*Client) TimeflowRead 

func (c *Client) TimeflowRead(r string) (Timeflow, error)

TimeflowRead - Retrieve the specified Timeflow object.

r - Timeflow Object Reference return Timeflow

func (*Client) TimeflowSnapshotDelete 

func (c *Client) TimeflowSnapshotDelete(r string) error

TimeflowSnapshotDelete - Delete the specified TimeflowSnapshot object.

r - TimeflowSnapshot Object Reference

func (*Client) TimeflowSnapshotList 

func (c *Client) TimeflowSnapshotList(fromDate string, pageSize *int, pageOffset *int, toDate string, traverseTimeflows *bool, missingNonLoggedDataOnly *bool, database string, timeflow string) ([]TimeflowSnapshot, error)

TimeflowSnapshotList - Returns a list of snapshots on the system or within a particular object. By default, all snapshots within the domain are listed.

fromDate ==> 

description: Start date to use for filtering out results.
format: date
type: string
mapsTo: latestChangePoint.timestamp
inequalityType: NON-STRICT

pageSize ==> 

type: integer
minimum: 0
description: Limit the number of snapshots returned.

pageOffset ==> 

description: Offset within TimeFlow snapshots, in units of pageSize chunks. The pageOffset query parameter is only supported when either a 'TimeFlow' or 'database' query parameter is also set.
type: integer

toDate ==> 

type: string
mapsTo: latestChangePoint.timestamp
inequalityType: STRICT
description: End date to use for filtering out results.
format: date

traverseTimeflows ==> 

description: Whether to restrict snapshots to those in the current TimeFlow and in parent TimeFlows older than the branch point. This option is only used with the "database" option. The default behavior is false, i.e. show all snapshots.
type: boolean

missingNonLoggedDataOnly ==> 

description: Whether to restrict snapshots to those missing nologging changes. The defaultbehavior is salse.
type: boolean

database ==> 

type: string
format: objectReference
referenceTo: /delphix-container.json
mapsTo: container
description: Restrict snapshots to those within a TimeFlow of the specified database. This option is mutually exclusive with the "TimeFlow" option.

timeflow ==> 

description: Restrict snapshots to those within the specified TimeFlow. This option is mutually exclusive with the "database" option.
type: string
format: objectReference
referenceTo: /delphix-timeflow.json
mapsTo: timeflow

return []TimeflowSnapshot

func (*Client) TimeflowSnapshotRead 

func (c *Client) TimeflowSnapshotRead(r string) (TimeflowSnapshot, error)

TimeflowSnapshotRead - Retrieve the specified TimeflowSnapshot object.

r - TimeflowSnapshot Object Reference return TimeflowSnapshot

func (*Client) TimeflowSnapshotUpdate 

func (c *Client) TimeflowSnapshotUpdate(r string, payload TimeflowSnapshot) error

TimeflowSnapshotUpdate - Update the specified TimeflowSnapshot object.

r - TimeflowSnapshot Object Reference payload TimeflowSnapshot object

func (*Client) TimeflowUpdate 

func (c *Client) TimeflowUpdate(r string, payload Timeflow) error

TimeflowUpdate - Update the specified Timeflow object.

r - Timeflow Object Reference payload Timeflow object

func (*Client) ToolkitDelete 

func (c *Client) ToolkitDelete(r string) error

ToolkitDelete - Delete the specified Toolkit object.

r - Toolkit Object Reference

func (*Client) ToolkitList 

func (c *Client) ToolkitList(sourceEnvironment string) ([]*ToolkitStruct, error)

ToolkitList - Lists installed toolkits.

sourceEnvironment ==> 

referenceTo: /delphix-source-environment.json
description: Restricts list to include only toolkits that are valid for the given source environment.
type: string
format: objectReference

return []*ToolkitStruct

func (*Client) ToolkitRead 

func (c *Client) ToolkitRead(r string) (*ToolkitStruct, error)

ToolkitRead - Retrieve the specified Toolkit object.

r - Toolkit Object Reference return *ToolkitStruct

func (*Client) TransformationList 

func (c *Client) TransformationList(container string, parentContainer string) ([]*TransformationStruct, error)

TransformationList - Returns a list of all transformations on the system.

container ==> 

referenceTo: /delphix-container.json
mapsTo: container
description: Return the transformation responsible for the given container reference.
type: string
format: objectReference

parentContainer ==> 

description: List the transformations that have been created against the provided container.
type: string
format: objectReference
referenceTo: /delphix-container.json
mapsTo: container

return []*TransformationStruct

func (*Client) TransformationRead 

func (c *Client) TransformationRead(r string) (*TransformationStruct, error)

TransformationRead - Retrieve the specified Transformation object.

r - Transformation Object Reference return *TransformationStruct

func (*Client) TransformationUpdate 

func (c *Client) TransformationUpdate(r string, payload *TransformationStruct) error

TransformationUpdate - Update the specified Transformation object.

r - Transformation Object Reference payload *TransformationStruct object

func (*Client) UpdateDSource 

func (c *Client) UpdateDSource(r string, o *OracleDatabaseContainerStruct) error

UpdateDSource is a convenience function, as it just invokes UpdateDatabase()

func (*Client) UpdateDatabase 

func (c *Client) UpdateDatabase(r string, o *OracleDatabaseContainerStruct) error

UpdateDatabase updates an Oracle virtual database object

func (*Client) UpdateEnvironment 

func (c *Client) UpdateEnvironment(r string, h *UnixHostEnvironmentStruct) error

UpdateEnvironment updates an environment in Delphix

func (*Client) UpdateUserPasswordByName 

func (c *Client) UpdateUserPasswordByName(u string, p string) error

UpdateUserPasswordByName updates the specified username's(u) password(p)

func (*Client) UpgradeCheckResultList 

func (c *Client) UpgradeCheckResultList() ([]*UpgradeCheckResultStruct, error)

UpgradeCheckResultList - List UpgradeCheckResult objects on the system.

return []*UpgradeCheckResultStruct

func (*Client) UpgradeCheckResultRead 

func (c *Client) UpgradeCheckResultRead(r string) (*UpgradeCheckResultStruct, error)

UpgradeCheckResultRead - Retrieve the specified UpgradeCheckResult object.

r - UpgradeCheckResult Object Reference return *UpgradeCheckResultStruct

func (*Client) UserCreate 

func (c *Client) UserCreate(payload *UserStruct) (string, error)

UserCreate - Create a new User object.

payload *UserStruct object return string

func (*Client) UserDelete 

func (c *Client) UserDelete(r string) error

UserDelete - Delete the specified User object.

r - User Object Reference

func (*Client) UserInterfaceConfigRead 

func (c *Client) UserInterfaceConfigRead(r string) (*UserInterfaceConfigStruct, error)

UserInterfaceConfigRead - Retrieve the specified UserInterfaceConfig object.

r - UserInterfaceConfig Object Reference return *UserInterfaceConfigStruct

func (*Client) UserInterfaceConfigUpdate 

func (c *Client) UserInterfaceConfigUpdate(r string, payload *UserInterfaceConfigStruct) error

UserInterfaceConfigUpdate - Update the specified UserInterfaceConfig object.

r - UserInterfaceConfig Object Reference payload *UserInterfaceConfigStruct object

func (*Client) UserList 

func (c *Client) UserList(typeUser string, domainUserType string) ([]*UserStruct, error)

UserList - Lists users in the system.

typeUser ==> 

description: User type SYSTEM or DOMAIN.
type: string
default: DOMAIN
enum: [SYSTEM DOMAIN]
mapsTo: userType

domainUserType ==> 

type: string
enum: [DELPHIX_ADMIN STANDARD_USER SELFSERVICE_ONLY]
required: false
description: DOMAIN user type: DELPHIX_ADMIN, STANDARD_USER, or SELFSERVICE_ONLY.

return []*UserStruct

func (*Client) UserRead 

func (c *Client) UserRead(r string) (*UserStruct, error)

UserRead - Retrieve the specified User object.

r - User Object Reference return *UserStruct

func (*Client) UserUpdate 

func (c *Client) UserUpdate(r string, payload *UserStruct) error

UserUpdate - Update the specified User object.

r - User Object Reference payload *UserStruct object

func (*Client) WaitForEngineReady 

func (c *Client) WaitForEngineReady(p int, t int) error

WaitForEngineReady loops until the Client connection is successful or time (t) expires

func (*Client) WaitforDelphixJob 

func (c *Client) WaitforDelphixJob(j string) error

WaitforDelphixJob waits for a job to complete

func (*Client) WindowsClusterNodeList 

func (c *Client) WindowsClusterNodeList(cluster string) ([]*WindowsClusterNodeStruct, error)

WindowsClusterNodeList - Returns a list of nodes filtered by cluster.

cluster ==> 

format: objectReference
referenceTo: /delphix-windows-cluster.json
description: A reference to the Windows cluster environment this node belongs to.
mapsTo: cluster
type: string

return []*WindowsClusterNodeStruct

func (*Client) WindowsClusterNodeRead 

func (c *Client) WindowsClusterNodeRead(r string) (*WindowsClusterNodeStruct, error)

WindowsClusterNodeRead - Retrieve the specified WindowsClusterNode object.

r - WindowsClusterNode Object Reference return *WindowsClusterNodeStruct

func (*Client) X509CertificateDelete 

func (c *Client) X509CertificateDelete(r string) error

X509CertificateDelete - Delete the specified X509Certificate object.

r - X509Certificate Object Reference

func (*Client) X509CertificateList 

func (c *Client) X509CertificateList() ([]*X509CertificateStruct, error)

X509CertificateList - List X509Certificate objects on the system.

return []*X509CertificateStruct

func (*Client) X509CertificateRead 

func (c *Client) X509CertificateRead(r string) (*X509CertificateStruct, error)

X509CertificateRead - Retrieve the specified X509Certificate object.

r - X509Certificate Object Reference return *X509CertificateStruct

type CompatibilityCriteriaStruct 

type CompatibilityCriteriaStruct struct {
	// Selected repositories are installed on a host with this
	// architecture (32-bit or 64-bit).
	Architecture *int `json:"architecture,omitempty"`
	// Selected repositories are installed on this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// Selected repositories are installed on a host with this OS.
	// enum = [Linux AIX HPUX SunOS Windows]
	Os string `json:"os,omitempty"`
	// Selected repositories are installed on a host with this type of
	// processor.
	// enum = [x86 ia64 powerpc sparc]
	Processor string `json:"processor,omitempty"`
	// If true, selected repositories have staging enabled.
	StagingEnabled *bool `json:"stagingEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CompatibilityCriteriaStruct - The compatibility criteria to use for selecting compatible repositories. Parameters with a value of null are not considered when selecting compatible repositories. extends TypedObject

func CompatibilityCriteriaFactory 

func CompatibilityCriteriaFactory(
	Architecture *int,
	Environment string,
	Os string,
	Processor string,
	StagingEnabled *bool,
) CompatibilityCriteriaStruct

CompatibilityCriteriaFactory is just a simple function to instantiate the CompatibilityCriteriaStruct

type CompatibleRepositoriesParameters 

type CompatibleRepositoriesParameters interface{}

CompatibleRepositoriesParameters is an empty interface designed to function as the CompatibleRepositoriesParameters API namespace

type CompatibleRepositoriesResultStruct 

type CompatibleRepositoriesResultStruct struct {
	// The criteria matched to select compatible repositories.
	// required = true
	Criteria *CompatibilityCriteriaStruct `json:"criteria,omitempty"`
	// The list of compatible repositories.
	// required = true
	Repositories []SourceRepository `json:"repositories,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CompatibleRepositoriesResultStruct - Result of a compatible repositories request. extends TypedObject

func CompatibleRepositoriesResultFactory 

func CompatibleRepositoriesResultFactory(
	Criteria *CompatibilityCriteriaStruct,
	Repositories []SourceRepository,
) CompatibleRepositoriesResultStruct

CompatibleRepositoriesResultFactory is just a simple function to instantiate the CompatibleRepositoriesResultStruct

type ConfiguredStorageDeviceStruct 

type ConfiguredStorageDeviceStruct struct {
	// Boolean value indicating if this is a boot device.
	BootDevice *bool `json:"bootDevice,omitempty"`
	// True if the device is currently configured in the system.
	Configured *bool `json:"configured,omitempty"`
	// Amount of additional space that would be made available, if the
	// device is expanded.
	// base = 1024
	// units = B
	ExpandableSize float64 `json:"expandableSize,omitempty"`
	// Model ID of the device.
	Model string `json:"model,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Serial number of the device.
	Serial string `json:"serial,omitempty"`
	// Physical size of the device, in bytes.
	// base = 1024
	// units = B
	Size float64 `json:"size,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// Size of allocated space on the device.
	// base = 1024
	// units = B
	UsedSize float64 `json:"usedSize,omitempty"`
	// Vendor ID of the device.
	Vendor string `json:"vendor,omitempty"`
}

ConfiguredStorageDeviceStruct - A storage device configured as usable storage. extends StorageDevice

func ConfiguredStorageDeviceFactory 

func ConfiguredStorageDeviceFactory(
	BootDevice *bool,
	Configured *bool,
	ExpandableSize float64,
	Model string,
	Name string,
	Namespace string,
	Reference string,
	Serial string,
	Size float64,
	UsedSize float64,
	Vendor string,
) ConfiguredStorageDeviceStruct

ConfiguredStorageDeviceFactory is just a simple function to instantiate the ConfiguredStorageDeviceStruct

type ConnectorConnectivityStruct 

type ConnectorConnectivityStruct struct {
	// Target host name or IP address.
	// format = host
	// required = true
	Address string `json:"address,omitempty"`
	// User credentials.
	// required = true
	Credentials *PasswordCredentialStruct `json:"credentials,omitempty"`
	// Connector port on remote server.
	// default = 9100
	// minimum = 1
	// maximum = 65535
	Port *int `json:"port,omitempty"`
	// Host to use as a proxy for credential validation.
	// format = objectReference
	// referenceTo = /delphix-host.json
	// create = optional
	Proxy string `json:"proxy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// User name.
	// required = true
	Username string `json:"username,omitempty"`
}

ConnectorConnectivityStruct - Mechanism to test Connector connectivity of arbitrary hosts. extends TypedObject

func ConnectorConnectivityFactory 

func ConnectorConnectivityFactory(
	Address string,
	Credentials *PasswordCredentialStruct,
	Port *int,
	Proxy string,
	Username string,
) ConnectorConnectivityStruct

ConnectorConnectivityFactory is just a simple function to instantiate the ConnectorConnectivityStruct

type Container 

type Container interface{}

Container is an empty interface designed to function as the Container API namespace

type ContainerUtilizationIntervalStruct 

type ContainerUtilizationIntervalStruct struct {
	// The average throughput for the container throughout the duration
	// of the sampling interval, measured in kilobits per second.
	AverageThroughput float64 `json:"averageThroughput,omitempty"`
	// The start time of the interval.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ContainerUtilizationIntervalStruct - Represents a represents an interval of time with which container utilization statistics are associated. extends TypedObject

func ContainerUtilizationIntervalFactory 

func ContainerUtilizationIntervalFactory(
	AverageThroughput float64,
	Timestamp string,
) ContainerUtilizationIntervalStruct

ContainerUtilizationIntervalFactory is just a simple function to instantiate the ContainerUtilizationIntervalStruct

type ContainerUtilizationStruct 

type ContainerUtilizationStruct struct {
	// Reference to the container whose utilization we are describing.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// True if this container has been deleted.
	Deleted *bool `json:"deleted,omitempty"`
	// True if the current user does not have access to this container.
	Hidden *bool `json:"hidden,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// A list of container utilization statistics corresponding to this
	// period of time, one for each sampling interval.
	Utilization []*ContainerUtilizationIntervalStruct `json:"utilization,omitempty"`
}

ContainerUtilizationStruct - Represents the utilization of all containers during a particular period of time. extends TypedObject cliVisibility = []

func ContainerUtilizationFactory 

func ContainerUtilizationFactory(
	Container string,
	Deleted *bool,
	Hidden *bool,
	Utilization []*ContainerUtilizationIntervalStruct,
) ContainerUtilizationStruct

ContainerUtilizationFactory is just a simple function to instantiate the ContainerUtilizationStruct

type CpuUtilDatapointStreamStruct 

type CpuUtilDatapointStreamStruct struct {
	// Which CPU was utilized.
	Cpu *int `json:"cpu,omitempty"`
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CpuUtilDatapointStreamStruct - A stream of datapoints from a CPU_UTIL analytics slice. extends DatapointStream

func CpuUtilDatapointStreamFactory 

func CpuUtilDatapointStreamFactory(
	Cpu *int,
	Datapoints []Datapoint,
) CpuUtilDatapointStreamStruct

CpuUtilDatapointStreamFactory is just a simple function to instantiate the CpuUtilDatapointStreamStruct

type CpuUtilDatapointStruct 

type CpuUtilDatapointStruct struct {
	// DTrace time in milliseconds (subset of time in kernel).
	Dtrace *int `json:"dtrace,omitempty"`
	// Idle time in milliseconds.
	Idle *int `json:"idle,omitempty"`
	// Kernel time in milliseconds.
	Kernel *int `json:"kernel,omitempty"`
	// The time this datapoint was collected.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// User time in milliseconds.
	User *int `json:"user,omitempty"`
}

CpuUtilDatapointStruct - An analytics datapoint generated by the CPU_UTIL statistic type. extends Datapoint

func CpuUtilDatapointFactory 

func CpuUtilDatapointFactory(
	Dtrace *int,
	Idle *int,
	Kernel *int,
	Timestamp string,
	User *int,
) CpuUtilDatapointStruct

CpuUtilDatapointFactory is just a simple function to instantiate the CpuUtilDatapointStruct

type CreateMaskingJobTransformationParametersStruct 

type CreateMaskingJobTransformationParametersStruct struct {
	// The container that will contain the masked data associated with
	// the newly created transformation; the "transformation container".
	// create = required
	Container Container `json:"container,omitempty"`
	// Reference to the user used during application of the
	// transformation.
	// create = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Reference to the repository used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	// create = required
	Repository string `json:"repository,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

CreateMaskingJobTransformationParametersStruct - Represents the parameters to create a transformation for a provided Masking Job. extends TypedObject

func CreateMaskingJobTransformationParametersFactory 

func CreateMaskingJobTransformationParametersFactory(
	Container Container,
	EnvironmentUser string,
	Repository string,
) CreateMaskingJobTransformationParametersStruct

CreateMaskingJobTransformationParametersFactory is just a simple function to instantiate the CreateMaskingJobTransformationParametersStruct

type CreateTransformationParameters 

type CreateTransformationParameters interface{}

CreateTransformationParameters is an empty interface designed to function as the CreateTransformationParameters API namespace

type Credential 

type Credential interface{}

Credential is an empty interface designed to function as the Credential API namespace

type CredentialUpdateParametersStruct 

type CredentialUpdateParametersStruct struct {
	// The new credentials.
	// create = required
	NewCredential *PasswordCredentialStruct `json:"newCredential,omitempty"`
	// The old credentials.
	// create = optional
	OldCredential *PasswordCredentialStruct `json:"oldCredential,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CredentialUpdateParametersStruct - Parameters to update a Delphix user's password. extends TypedObject

func CredentialUpdateParametersFactory 

func CredentialUpdateParametersFactory(
	NewCredential *PasswordCredentialStruct,
	OldCredential *PasswordCredentialStruct,
) CredentialUpdateParametersStruct

CredentialUpdateParametersFactory is just a simple function to instantiate the CredentialUpdateParametersStruct

type CurrentConsumerCapacityDataStruct 

type CurrentConsumerCapacityDataStruct struct {
	// Statistics for this consumer.
	Breakdown *CapacityBreakdownStruct `json:"breakdown,omitempty"`
	// Reference to the container.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Reference to this container's group.
	// format = objectReference
	// referenceTo = /delphix-group.json
	Group string `json:"group,omitempty"`
	// Name of this container's group.
	GroupName string `json:"groupName,omitempty"`
	// Name of the container.
	Name string `json:"name,omitempty"`
	// Container from which this TimeFlow was provisioned.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Parent string `json:"parent,omitempty"`
	// Internal unique identifier for this consumer.
	StorageContainer string `json:"storageContainer,omitempty"`
	// Time at which this information was sampled.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

CurrentConsumerCapacityDataStruct - Current data about a particular capacity consumer. extends BaseConsumerCapacityData cliVisibility = [DOMAIN]

func CurrentConsumerCapacityDataFactory 

func CurrentConsumerCapacityDataFactory(
	Breakdown *CapacityBreakdownStruct,
	Container string,
	Group string,
	GroupName string,
	Name string,
	Parent string,
	StorageContainer string,
	Timestamp string,
) CurrentConsumerCapacityDataStruct

CurrentConsumerCapacityDataFactory is just a simple function to instantiate the CurrentConsumerCapacityDataStruct

type CurrentGroupCapacityDataStruct 

type CurrentGroupCapacityDataStruct struct {
	// Which group these stats represent.
	// format = objectReference
	// referenceTo = /delphix-group.json
	Group string `json:"group,omitempty"`
	// Statistics for dSources in this aggregation.
	Source *CapacityBreakdownStruct `json:"source,omitempty"`
	// Time at which this information was sampled.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Statistics for VDBs in this aggregation.
	Virtual *CapacityBreakdownStruct `json:"virtual,omitempty"`
}

CurrentGroupCapacityDataStruct - Capacity data aggregated over a group. extends BaseGroupCapacityData cliVisibility = [DOMAIN]

func CurrentGroupCapacityDataFactory 

func CurrentGroupCapacityDataFactory(
	Group string,
	Source *CapacityBreakdownStruct,
	Timestamp string,
	Virtual *CapacityBreakdownStruct,
) CurrentGroupCapacityDataStruct

CurrentGroupCapacityDataFactory is just a simple function to instantiate the CurrentGroupCapacityDataStruct

type CurrentSystemCapacityDataStruct 

type CurrentSystemCapacityDataStruct struct {
	// Statistics for dSources in this aggregation.
	Source *CapacityBreakdownStruct `json:"source,omitempty"`
	// Time at which this information was sampled.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Total storage space (used and unused).
	// units = B
	// base = 1024
	TotalSpace float64 `json:"totalSpace,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Statistics for VDBs in this aggregation.
	Virtual *CapacityBreakdownStruct `json:"virtual,omitempty"`
}

CurrentSystemCapacityDataStruct - Capacity data for the entire system. extends BaseSystemCapacityData cliVisibility = [DOMAIN]

func CurrentSystemCapacityDataFactory 

func CurrentSystemCapacityDataFactory(
	Source *CapacityBreakdownStruct,
	Timestamp string,
	TotalSpace float64,
	Virtual *CapacityBreakdownStruct,
) CurrentSystemCapacityDataStruct

CurrentSystemCapacityDataFactory is just a simple function to instantiate the CurrentSystemCapacityDataStruct

type DBContainerRuntime 

type DBContainerRuntime interface{}

DBContainerRuntime is an empty interface designed to function as the DBContainerRuntime API namespace

type DNSConfigStruct 

type DNSConfigStruct struct {
	// One of more DNS domain names.
	// update = optional
	Domain []string `json:"domain,omitempty"`
	// List of DNS servers.
	// update = optional
	Servers []string `json:"servers,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DNSConfigStruct - DNS Client Configuration. extends TypedObject cliVisibility = [SYSTEM]

func DNSConfigFactory 

func DNSConfigFactory(
	Domain []string,
	Servers []string,
) DNSConfigStruct

DNSConfigFactory is just a simple function to instantiate the DNSConfigStruct

type DSPAutotunerParametersStruct 

type DSPAutotunerParametersStruct struct {
	// Whether the test is testing connectivity to a Delphix Engine or a
	// remote host.
	// enum = [REMOTE_HOST DELPHIX_ENGINE]
	// create = required
	DestinationType string `json:"destinationType,omitempty"`
	// Whether the test is a transmit or receive test.
	// enum = [TRANSMIT RECEIVE]
	// default = TRANSMIT
	// create = optional
	Direction string `json:"direction,omitempty"`
	// Address, username and password used when running a test to another
	// Delphix Engine.
	// create = optional
	RemoteDelphixEngineInfo *RemoteDelphixEngineInfoStruct `json:"remoteDelphixEngineInfo,omitempty"`
	// The remote host for the test. The host must be part of an existing
	// environment.
	// format = objectReference
	// referenceTo = /delphix-host.json
	// create = optional
	RemoteHost string `json:"remoteHost,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DSPAutotunerParametersStruct - Network information required by the DSP autotuner. extends TypedObject

func DSPAutotunerParametersFactory 

func DSPAutotunerParametersFactory(
	DestinationType string,
	Direction string,
	RemoteDelphixEngineInfo *RemoteDelphixEngineInfoStruct,
	RemoteHost string,
) DSPAutotunerParametersStruct

DSPAutotunerParametersFactory is just a simple function to instantiate the DSPAutotunerParametersStruct

type DSPBestParametersStruct 

type DSPBestParametersStruct struct {
	// The size of the send and receive socket buffers in bytes used to
	// achieve maximum throughput.
	// base = 1024
	// units = B
	BufferSize *int `json:"bufferSize,omitempty"`
	// Whether the test is testing connectivity to a Delphix Engine or
	// remote host.
	// enum = [REMOTE_HOST DELPHIX_ENGINE]
	DestinationType string `json:"destinationType,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The number of connections used to achieve maximum throughput.
	NumConnections *int `json:"numConnections,omitempty"`
	// The queue depth used to achieve maximum throughput.
	QueueDepth *int `json:"queueDepth,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Information used when running a test to another Delphix Engine.
	RemoteDelphixEngineInfo *RemoteDelphixEngineInfoStruct `json:"remoteDelphixEngineInfo,omitempty"`
	// The remote host for the test. The host must be part of an existing
	// environment.
	// format = objectReference
	// referenceTo = /delphix-host.json
	RemoteHost string `json:"remoteHost,omitempty"`
	// The average throughput measured.
	// base = 1024
	// units = bps
	Throughput float64 `json:"throughput,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DSPBestParametersStruct - DSP parameters, found by autotuner, that give the highest throughput for a certain target. extends PersistentObject

func DSPBestParametersFactory 

func DSPBestParametersFactory(
	BufferSize *int,
	DestinationType string,
	Namespace string,
	NumConnections *int,
	QueueDepth *int,
	Reference string,
	RemoteDelphixEngineInfo *RemoteDelphixEngineInfoStruct,
	RemoteHost string,
	Throughput float64,
) DSPBestParametersStruct

DSPBestParametersFactory is just a simple function to instantiate the DSPBestParametersStruct

type DSPOptionsStruct 

type DSPOptionsStruct struct {
	// Bandwidth limit (MB/s) for network traffic. A value of 0 means no
	// limit.
	// create = optional
	// default = 0
	// minimum = 0
	BandwidthLimit *int `json:"bandwidthLimit,omitempty"`
	// Compress the data stream over the network.
	// create = optional
	// default = false
	Compression *bool `json:"compression,omitempty"`
	// Encrypt the data stream over the network.
	// create = optional
	// default = false
	Encryption *bool `json:"encryption,omitempty"`
	// Total number of transport connections to use.
	// create = optional
	// default = 1
	// minimum = 1
	// maximum = 16
	NumConnections *int `json:"numConnections,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

DSPOptionsStruct - Options commonly used by apps that use DSP. extends TypedObject

func DSPOptionsFactory 

func DSPOptionsFactory(
	BandwidthLimit *int,
	Compression *bool,
	Encryption *bool,
	NumConnections *int,
) DSPOptionsStruct

DSPOptionsFactory is just a simple function to instantiate the DSPOptionsStruct

type DataResultStruct 

type DataResultStruct struct {
	// Reference to the action associated with the operation, if any.
	// format = objectReference
	// referenceTo = /delphix-action.json
	Action string `json:"action,omitempty"`
	// Reference to the job started by the operation, if any.
	// format = objectReference
	// referenceTo = /delphix-job.json
	Job string `json:"job,omitempty"`
	// Result of the operation. This will be specific to the API being
	// invoked.
	Result string `json:"result,omitempty"`
	// Indicates whether an error occurred during the call.
	// enum = [OK ERROR]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DataResultStruct - Result of a successful API call containing a reference to a downloadable resource. extends OKResult

func DataResultFactory 

func DataResultFactory(
	Action string,
	Job string,
	Result string,
	Status string,
) DataResultStruct

DataResultFactory is just a simple function to instantiate the DataResultStruct

type DatabaseContainer 

type DatabaseContainer interface{}

DatabaseContainer is an empty interface designed to function as the DatabaseContainer API namespace

type DatabaseTemplateConfigStruct 

type DatabaseTemplateConfigStruct struct {
	// A list of reserved parameters names that cannot be used in the
	// template.
	Reserved []string `json:"reserved,omitempty"`
	// The object type for sources to which this template is applicable.
	// format = type
	SourceType string `json:"sourceType,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DatabaseTemplateConfigStruct - Static template configuration information for a given source type. extends TypedObject

func DatabaseTemplateConfigFactory 

func DatabaseTemplateConfigFactory(
	Reserved []string,
	SourceType string,
) DatabaseTemplateConfigStruct

DatabaseTemplateConfigFactory is just a simple function to instantiate the DatabaseTemplateConfigStruct

type DatabaseTemplateStruct 

type DatabaseTemplateStruct struct {
	// User provided description for this template.
	// create = optional
	// update = optional
	Description string `json:"description,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A name/value map of string configuration parameters.
	// create = required
	// update = optional
	Parameters map[string]string `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The type of the source associated with the template.
	// create = required
	// update = optional
	// enum = [MySQLVirtualSource OracleVirtualSource MSSqlVirtualSource MSSqlLinkedSource PgSQLVirtualSource]
	// format = type
	SourceType string `json:"sourceType,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DatabaseTemplateStruct - Parameter configuration for virtual databases. extends NamedUserObject

func DatabaseTemplateFactory 

func DatabaseTemplateFactory(
	Description string,
	Name string,
	Namespace string,
	Parameters map[string]string,
	Reference string,
	SourceType string,
) DatabaseTemplateStruct

DatabaseTemplateFactory is just a simple function to instantiate the DatabaseTemplateStruct

type Datapoint 

type Datapoint interface{}

Datapoint is an empty interface designed to function as the Datapoint API namespace

type DatapointSetStruct 

type DatapointSetStruct struct {
	// The set of datapoint streams in the result.
	DatapointStreams []DatapointStream `json:"datapointStreams,omitempty"`
	// True if the number of datapoints to be included exceeded the
	// maximum allowable for a single datapoint set. As a result, not all
	// datapoints could be included in the datapointStreams array.
	Overflow *bool `json:"overflow,omitempty"`
	// The amount of time each datapoint spans.
	// units = sec
	Resolution *int `json:"resolution,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

DatapointSetStruct - A set of datapoints from a particular analytics slice. extends TypedObject

func DatapointSetFactory 

func DatapointSetFactory(
	DatapointStreams []DatapointStream,
	Overflow *bool,
	Resolution *int,
) DatapointSetStruct

DatapointSetFactory is just a simple function to instantiate the DatapointSetStruct

type DatapointStream 

type DatapointStream interface{}

DatapointStream is an empty interface designed to function as the DatapointStream API namespace

type DbExportParameters 

type DbExportParameters interface{}

DbExportParameters is an empty interface designed to function as the DbExportParameters API namespace

type DeleteParametersStruct 

type DeleteParametersStruct struct {
	// Flag indicating whether to continue the operation upon failures.
	Force *bool `json:"force,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DeleteParametersStruct - The parameters to use as input to delete requests for MSSQL, PostgreSQL, AppData, ASE or MySQL. extends TypedObject

func DeleteParametersFactory 

func DeleteParametersFactory(
	Force *bool,
) DeleteParametersStruct

DeleteParametersFactory is just a simple function to instantiate the DeleteParametersStruct

type DelphixManagedBackupIngestionStrategyStruct 

type DelphixManagedBackupIngestionStrategyStruct struct {
	// Specify whether the backups taken should be compressed or
	// uncompressed.
	// update = optional
	// default = false
	// create = optional
	CompressionEnabled *bool `json:"compressionEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DelphixManagedBackupIngestionStrategyStruct - This link source has a Delphix managed backup ingestion strategy that will create copy-only full backups based on a policy and ingest that backup. extends IngestionStrategy

func DelphixManagedBackupIngestionStrategyFactory 

func DelphixManagedBackupIngestionStrategyFactory(
	CompressionEnabled *bool,
) DelphixManagedBackupIngestionStrategyStruct

DelphixManagedBackupIngestionStrategyFactory is just a simple function to instantiate the DelphixManagedBackupIngestionStrategyStruct

type DetachSourceParametersStruct 

type DetachSourceParametersStruct struct {
	// Reference to the source to be removed. This must be a linked
	// source attached to the target database.
	// format = objectReference
	// referenceTo = /delphix-source.json
	// required = true
	Source string `json:"source,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DetachSourceParametersStruct - The parameters passed in for a database detach source operation. extends TypedObject

func DetachSourceParametersFactory 

func DetachSourceParametersFactory(
	Source string,
) DetachSourceParametersStruct

DetachSourceParametersFactory is just a simple function to instantiate the DetachSourceParametersStruct

type DiagnosisResultStruct 

type DiagnosisResultStruct struct {
	// True if this was a check that did not pass.
	Failure *bool `json:"failure,omitempty"`
	// Localized message.
	Message string `json:"message,omitempty"`
	// Message code associated with the event.
	MessageCode string `json:"messageCode,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DiagnosisResultStruct - Details from a diagnosis check that was run due to a failed operation. extends TypedObject

func DiagnosisResultFactory 

func DiagnosisResultFactory(
	Failure *bool,
	Message string,
	MessageCode string,
) DiagnosisResultStruct

DiagnosisResultFactory is just a simple function to instantiate the DiagnosisResultStruct

type DiskOpsDatapointStreamStruct 

type DiskOpsDatapointStreamStruct struct {
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// Device the I/Os were issued to.
	Device string `json:"device,omitempty"`
	// Whether the I/Os resulted in errors.
	Error *bool `json:"error,omitempty"`
	// I/O operation type.
	// enum = [read write]
	Op string `json:"op,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DiskOpsDatapointStreamStruct - A stream of datapoints from a DISK_OPS analytics slice. extends DatapointStream

func DiskOpsDatapointStreamFactory 

func DiskOpsDatapointStreamFactory(
	Datapoints []Datapoint,
	Device string,
	Error *bool,
	Op string,
) DiskOpsDatapointStreamStruct

DiskOpsDatapointStreamFactory is just a simple function to instantiate the DiskOpsDatapointStreamStruct

type DomainStruct 

type DomainStruct struct {
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DomainStruct - Represents the root container of all objects on the system. extends ReadonlyNamedUserObject cliVisibility = [SYSTEM]

func DomainFactory 

func DomainFactory(
	Name string,
	Namespace string,
	Reference string,
) DomainStruct

DomainFactory is just a simple function to instantiate the DomainStruct

type DxFsIoQueueOpsDatapointStreamStruct 

type DxFsIoQueueOpsDatapointStreamStruct struct {
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// I/O operation type.
	// enum = [read write claim free ioctl null]
	Op string `json:"op,omitempty"`
	// Priority of the I/O.
	// enum = [sync cache/agg asyncw asyncr resilver scrub ddt_prefetch]
	Priority string `json:"priority,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

DxFsIoQueueOpsDatapointStreamStruct - A stream of datapoints from a DxFS_IO_QUEUE_OPS analytics slice. extends DatapointStream

func DxFsIoQueueOpsDatapointStreamFactory 

func DxFsIoQueueOpsDatapointStreamFactory(
	Datapoints []Datapoint,
	Op string,
	Priority string,
) DxFsIoQueueOpsDatapointStreamStruct

DxFsIoQueueOpsDatapointStreamFactory is just a simple function to instantiate the DxFsIoQueueOpsDatapointStreamStruct

type DxFsOpsDatapointStreamStruct 

type DxFsOpsDatapointStreamStruct struct {
	// Whether reads were cached.
	Cached *bool `json:"cached,omitempty"`
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// I/O operation type.
	// enum = [read write]
	Op string `json:"op,omitempty"`
	// Path of the affected file.
	// format = unixpath
	Path string `json:"path,omitempty"`
	// Whether writes were synchronous.
	Sync *bool `json:"sync,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

DxFsOpsDatapointStreamStruct - A stream of datapoints from a DxFS_OPS analytics slice. extends DatapointStream

func DxFsOpsDatapointStreamFactory 

func DxFsOpsDatapointStreamFactory(
	Cached *bool,
	Datapoints []Datapoint,
	Op string,
	Path string,
	Sync *bool,
) DxFsOpsDatapointStreamStruct

DxFsOpsDatapointStreamFactory is just a simple function to instantiate the DxFsOpsDatapointStreamStruct

type EcdsaKeyPairStruct 

type EcdsaKeyPairStruct struct {
	// The size of each key to be generated.
	// create = optional
	// minimum = 256
	// maximum = 571
	// default = 256
	KeySize *int `json:"keySize,omitempty"`
	// The signature algorithm this key pair will use to sign
	// certificates and CSRs.
	// create = optional
	// enum = [SHA256withECDSA SHA384withECDSA SHA512withECDSA]
	// default = SHA256withECDSA
	SignatureAlgorithm string `json:"signatureAlgorithm,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

EcdsaKeyPairStruct - A key pair generated using the ECDSA algorithm. extends KeyPair

func EcdsaKeyPairFactory 

func EcdsaKeyPairFactory(
	KeySize *int,
	SignatureAlgorithm string,
) EcdsaKeyPairStruct

EcdsaKeyPairFactory is just a simple function to instantiate the EcdsaKeyPairStruct

type EmptyDatasetCreationParameters 

type EmptyDatasetCreationParameters interface{}

EmptyDatasetCreationParameters is an empty interface designed to function as the EmptyDatasetCreationParameters API namespace

type EndEntity 

type EndEntity interface{}

EndEntity is an empty interface designed to function as the EndEntity API namespace

type EndEntityCertificateReplaceChainParametersStruct 

type EndEntityCertificateReplaceChainParametersStruct struct {
	// The PEM certificate chain.
	// required = true
	Chain *PemCertificateChainStruct `json:"chain,omitempty"`
	// The specific TLS service and system this certificate is used for.
	// required = true
	// properties = map[type:map[default:EndEntityHttps]]
	EndEntity EndEntity `json:"endEntity,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

EndEntityCertificateReplaceChainParametersStruct - The parameters for replacing an end-entity certificate with a PEM certificate chain. extends EndEntityCertificateReplaceParameters

func EndEntityCertificateReplaceChainParametersFactory 

func EndEntityCertificateReplaceChainParametersFactory(
	Chain *PemCertificateChainStruct,
	EndEntity EndEntity,
) EndEntityCertificateReplaceChainParametersStruct

EndEntityCertificateReplaceChainParametersFactory is just a simple function to instantiate the EndEntityCertificateReplaceChainParametersStruct

type EndEntityCertificateReplaceKeystoreParametersStruct 

type EndEntityCertificateReplaceKeystoreParametersStruct struct {
	// The specific TLS service and system this certificate is used for.
	// required = true
	// properties = map[type:map[default:EndEntityHttps]]
	EndEntity EndEntity `json:"endEntity,omitempty"`
	// The token in the FileUploadResult after uploading the keystore.
	// required = true
	Token string `json:"token,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

EndEntityCertificateReplaceKeystoreParametersStruct - The parameters for replacing an end-entity certificate with a certificate and key pair from a keystore. extends EndEntityCertificateReplaceParameters

func EndEntityCertificateReplaceKeystoreParametersFactory 

func EndEntityCertificateReplaceKeystoreParametersFactory(
	EndEntity EndEntity,
	Token string,
) EndEntityCertificateReplaceKeystoreParametersStruct

EndEntityCertificateReplaceKeystoreParametersFactory is just a simple function to instantiate the EndEntityCertificateReplaceKeystoreParametersStruct

type EndEntityCertificateReplaceParameters 

type EndEntityCertificateReplaceParameters interface{}

EndEntityCertificateReplaceParameters is an empty interface designed to function as the EndEntityCertificateReplaceParameters API namespace

type EndEntityCertificateStruct 

type EndEntityCertificateStruct struct {
	// The specific TLS service this certificate is used for.
	EndEntity EndEntity `json:"endEntity,omitempty"`
	// Issuer of this certificate.
	IssuedByDN string `json:"issuedByDN,omitempty"`
	// A reference to the certificate that issued this certificate. Null
	// if this is a root CA.
	// format = objectReference
	// referenceTo = /delphix-ca-certificate.json
	Issuer string `json:"issuer,omitempty"`
	// MD5 fingerprint.
	Md5Fingerprint string `json:"md5Fingerprint,omitempty"`
	// The Distinguished Name of this certificate.
	// format = objectName
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// End of validity.
	// format = date
	NotAfter string `json:"notAfter,omitempty"`
	// Start of validity.
	// format = date
	NotBefore string `json:"notBefore,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Certificate serial number.
	SerialNumber string `json:"serialNumber,omitempty"`
	// SHA-1 fingerprint.
	Sha1Fingerprint string `json:"sha1Fingerprint,omitempty"`
	// The subject alternative names associated with this certificate.
	SubjectAlternativeNames []string `json:"subjectAlternativeNames,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

EndEntityCertificateStruct - An End-Entity Public Key Certificate. extends Certificate cliVisibility = [SYSTEM DOMAIN]

func EndEntityCertificateFactory 

func EndEntityCertificateFactory(
	EndEntity EndEntity,
	IssuedByDN string,
	Issuer string,
	Md5Fingerprint string,
	Name string,
	Namespace string,
	NotAfter string,
	NotBefore string,
	Reference string,
	SerialNumber string,
	Sha1Fingerprint string,
	SubjectAlternativeNames []string,
) EndEntityCertificateStruct

EndEntityCertificateFactory is just a simple function to instantiate the EndEntityCertificateStruct

type EndEntityDspStruct 

type EndEntityDspStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

EndEntityDspStruct - The end-entity certificate used for DSP by the Delphix Engine. extends EndEntity

func EndEntityDspFactory 

func EndEntityDspFactory() EndEntityDspStruct

EndEntityDspFactory is just a simple function to instantiate the EndEntityDspStruct

type EndEntityHttpsStruct 

type EndEntityHttpsStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

EndEntityHttpsStruct - The end-entity certificate used for HTTPS by the Delphix Engine. extends EndEntity

func EndEntityHttpsFactory 

func EndEntityHttpsFactory() EndEntityHttpsStruct

EndEntityHttpsFactory is just a simple function to instantiate the EndEntityHttpsStruct

type EnumConstraint 

type EnumConstraint interface{}

EnumConstraint is an empty interface designed to function as the EnumConstraint API namespace

type EnumEqualConstraintStruct 

type EnumEqualConstraintStruct struct {
	// The name of the axis being constrained.
	// create = required
	AxisName string `json:"axisName,omitempty"`
	// The axis values must be equal to the specified value.
	// create = required
	Equals string `json:"equals,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

EnumEqualConstraintStruct - Constraints placed on an enumeration axis of a particular analytics slice. extends EnumConstraint

func EnumEqualConstraintFactory 

func EnumEqualConstraintFactory(
	AxisName string,
	Equals string,
) EnumEqualConstraintStruct

EnumEqualConstraintFactory is just a simple function to instantiate the EnumEqualConstraintStruct

type EnvironmentUserStruct 

type EnvironmentUserStruct struct {
	// The credential for the environment user.
	// properties = map[type:map[type:string description:Object type. required:true format:type default:PasswordCredential]]
	// create = required
	// update = optional
	Credential Credential `json:"credential,omitempty"`
	// A reference to the associated environment.
	// create = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// Group ID of the user.
	// create = optional
	// update = optional
	// minimum = 0
	// maximum = 4.294967295e+09
	GroupId *int `json:"groupId,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// User ID of the user.
	// create = optional
	// update = optional
	// minimum = 0
	// maximum = 4.294967295e+09
	UserId *int `json:"userId,omitempty"`
}

EnvironmentUserStruct - The representation of an environment user object. extends UserObject

func EnvironmentUserFactory 

func EnvironmentUserFactory(
	Credential Credential,
	Environment string,
	GroupId *int,
	Name string,
	Namespace string,
	Reference string,
	UserId *int,
) EnvironmentUserStruct

EnvironmentUserFactory is just a simple function to instantiate the EnvironmentUserStruct

type ErrorResultStruct 

type ErrorResultStruct struct {
	// Specifics of the error that occurred during API call execution.
	Error *APIErrorStruct `json:"error,omitempty"`
	// Indicates whether an error occurred during the call.
	// enum = [OK ERROR]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ErrorResultStruct - Result of a failed API call. extends CallResult

func ErrorResultFactory 

func ErrorResultFactory(
	Error *APIErrorStruct,
	Status string,
) ErrorResultStruct

ErrorResultFactory is just a simple function to instantiate the ErrorResultStruct

type ErrorStruct 

type ErrorStruct struct {
	Type          string `json:"type,omitempty"`
	Details       string `json:"details,omitempty"`
	ID            string `json:"id,omitempty"`
	CommandOutput string `json:"commandOutput,omitempty"`
	Diagnosis     string `json:"diagnosis,omitempty"`
}

ErrorStruct is the struct of a resty error

type EventFilterStruct 

type EventFilterStruct struct {
	// List of event types. Only alerts of the given event type are
	// included. Each event type is a string representing the event class
	// of the corresponding alerts. Wildcards are supported to include
	// classes of events.
	// update = optional
	// minItems = 1
	// create = optional
	EventTypes []string `json:"eventTypes,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

EventFilterStruct - An event filter that specifies which event types to match against. extends AlertFilter

func EventFilterFactory 

func EventFilterFactory(
	EventTypes []string,
) EventFilterStruct

EventFilterFactory is just a simple function to instantiate the EventFilterStruct

type ExportParameters 

type ExportParameters interface{}

ExportParameters is an empty interface designed to function as the ExportParameters API namespace

type ExternalBackupIngestionStrategyStruct 

type ExternalBackupIngestionStrategyStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Specifies the backup types ValidatedSync will use to synchronize
	// the dSource with the source database.
	// create = required
	// update = optional
	// enum = [TRANSACTION_LOG FULL_OR_DIFFERENTIAL FULL]
	// default = TRANSACTION_LOG
	ValidatedSyncMode string `json:"validatedSyncMode,omitempty"`
}

ExternalBackupIngestionStrategyStruct - This link source has an external ingestion strategy that will pull in backups via ValidatedSync depending on the mode selected. extends IngestionStrategy

func ExternalBackupIngestionStrategyFactory 

func ExternalBackupIngestionStrategyFactory(
	ValidatedSyncMode string,
) ExternalBackupIngestionStrategyStruct

ExternalBackupIngestionStrategyFactory is just a simple function to instantiate the ExternalBackupIngestionStrategyStruct

type FaultEffectStruct 

type FaultEffectStruct struct {
	// A suggested user action.
	Action string `json:"action,omitempty"`
	// A unique dot delimited identifier associated with the fault
	// effect.
	BundleID string `json:"bundleID,omitempty"`
	// The cause of the fault effect, in case there is a chain of fault
	// effects originating from the root cause which resulted in this
	// effect.
	// format = objectReference
	// referenceTo = /delphix-fault-effect.json
	CausedBy string `json:"causedBy,omitempty"`
	// The date when the root cause fault was diagnosed.
	// format = date
	DateDiagnosed string `json:"dateDiagnosed,omitempty"`
	// Full description of the fault effect.
	Description string `json:"description,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The automated response taken by the system.
	Response string `json:"response,omitempty"`
	// The root cause of this fault effect. Resolving the fault effect
	// can only occur by resolving its root cause.
	// format = objectReference
	// referenceTo = /delphix-fault.json
	RootCause string `json:"rootCause,omitempty"`
	// The severity of the fault effect. This can either be CRITICAL or
	// WARNING.
	// enum = [CRITICAL WARNING]
	Severity string `json:"severity,omitempty"`
	// The user-visible Delphix object that has a fault effect.
	// format = objectReference
	// referenceTo = /delphix-user-object.json
	Target string `json:"target,omitempty"`
	// The name of the user-visible Delphix object that has a fault
	// effect.
	TargetName string `json:"targetName,omitempty"`
	// Summary of the fault effect.
	Title string `json:"title,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

FaultEffectStruct - An error affecting a user object whose root cause is a fault. A fault effect can only be resolved by resolving the fault which is its root cause. extends PersistentObject

func FaultEffectFactory 

func FaultEffectFactory(
	Action string,
	BundleID string,
	CausedBy string,
	DateDiagnosed string,
	Description string,
	Namespace string,
	Reference string,
	Response string,
	RootCause string,
	Severity string,
	Target string,
	TargetName string,
	Title string,
) FaultEffectStruct

FaultEffectFactory is just a simple function to instantiate the FaultEffectStruct

type FaultResolveParametersStruct 

type FaultResolveParametersStruct struct {
	// The comments describing the steps taken to resolve a fault.
	// create = optional
	// default =
	Comments string `json:"comments,omitempty"`
	// Flag indicating whether to ignore this fault if it is detected on
	// the same object in the future.
	// create = optional
	// default = false
	Ignore *bool `json:"ignore,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

FaultResolveParametersStruct - The parameters to use as input when marking a fault as resolved. extends TypedObject

func FaultResolveParametersFactory 

func FaultResolveParametersFactory(
	Comments string,
	Ignore *bool,
) FaultResolveParametersStruct

FaultResolveParametersFactory is just a simple function to instantiate the FaultResolveParametersStruct

type FaultStruct 

type FaultStruct struct {
	// A suggested user action.
	Action string `json:"action,omitempty"`
	// A unique dot delimited identifier associated with the fault.
	BundleID string `json:"bundleID,omitempty"`
	// The date when the fault was diagnosed.
	// format = date
	DateDiagnosed string `json:"dateDiagnosed,omitempty"`
	// The date when the fault was resolved.
	// format = date
	DateResolved string `json:"dateResolved,omitempty"`
	// Full description of the fault.
	Description string `json:"description,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// A comment that describes the fault resolution.
	ResolutionComments string `json:"resolutionComments,omitempty"`
	// The automated response taken by the system.
	Response string `json:"response,omitempty"`
	// The severity of the fault event. This can either be CRITICAL or
	// WARNING.
	// enum = [CRITICAL WARNING]
	Severity string `json:"severity,omitempty"`
	// The status of the fault. This can be ACTIVE, RESOLVED or IGNORED.
	// enum = [ACTIVE RESOLVED IGNORED]
	Status string `json:"status,omitempty"`
	// The user-visible Delphix object that is faulted.
	// format = objectReference
	// referenceTo = /delphix-user-object.json
	Target string `json:"target,omitempty"`
	// The name of the faulted object at the time the fault was
	// diagnosed.
	TargetName string `json:"targetName,omitempty"`
	// The user-visible Delphix object that is faulted.
	// format = type
	TargetObjectType string `json:"targetObjectType,omitempty"`
	// Summary of the fault.
	Title string `json:"title,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

FaultStruct - A representation of a fault, with associated user object. extends PersistentObject

func FaultFactory 

func FaultFactory(
	Action string,
	BundleID string,
	DateDiagnosed string,
	DateResolved string,
	Description string,
	Namespace string,
	Reference string,
	ResolutionComments string,
	Response string,
	Severity string,
	Status string,
	Target string,
	TargetName string,
	TargetObjectType string,
	Title string,
) FaultStruct

FaultFactory is just a simple function to instantiate the FaultStruct

type FeatureFlagParametersStruct 

type FeatureFlagParametersStruct struct {
	// Name of the feature flag.
	// required = true
	Name string `json:"name,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

FeatureFlagParametersStruct - Feature Flags for the Delphix Engine. extends TypedObject

func FeatureFlagParametersFactory 

func FeatureFlagParametersFactory(
	Name string,
) FeatureFlagParametersStruct

FeatureFlagParametersFactory is just a simple function to instantiate the FeatureFlagParametersStruct

type FileDownloadResultStruct 

type FileDownloadResultStruct struct {
	// Token to pass as parameter to identify the file.
	Token string `json:"token,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// URL to download from or upload to.
	Url string `json:"url,omitempty"`
}

FileDownloadResultStruct - Result of a file download request. extends FileProcessingResult

func FileDownloadResultFactory 

func FileDownloadResultFactory(
	Token string,
	Url string,
) FileDownloadResultStruct

FileDownloadResultFactory is just a simple function to instantiate the FileDownloadResultStruct

type FileMappingParametersStruct 

type FileMappingParametersStruct struct {
	// Database file mapping rules.
	// required = true
	MappingRules string `json:"mappingRules,omitempty"`
	// The list of TimeFlow point, bookmark, or semantic location to use
	// for source files to be mapped.
	// required = true
	// minItems = 1
	TimeflowPointParameters []TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

FileMappingParametersStruct - Input parameters to test file mapping rules. extends TypedObject

func FileMappingParametersFactory 

func FileMappingParametersFactory(
	MappingRules string,
	TimeflowPointParameters []TimeflowPointParameters,
) FileMappingParametersStruct

FileMappingParametersFactory is just a simple function to instantiate the FileMappingParametersStruct

type FileMappingResultStruct 

type FileMappingResultStruct struct {
	// Mapped files.
	MappedFiles map[string]string `json:"mappedFiles,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

FileMappingResultStruct - Result of a file mapping request. extends TypedObject

func FileMappingResultFactory 

func FileMappingResultFactory(
	MappedFiles map[string]string,
) FileMappingResultStruct

FileMappingResultFactory is just a simple function to instantiate the FileMappingResultStruct

type FileProcessingResult 

type FileProcessingResult interface{}

FileProcessingResult is an empty interface designed to function as the FileProcessingResult API namespace

type FileUploadResultStruct 

type FileUploadResultStruct struct {
	// Token to pass as parameter to identify the file.
	Token string `json:"token,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// URL to download from or upload to.
	Url string `json:"url,omitempty"`
}

FileUploadResultStruct - Result of a file upload request. extends FileProcessingResult

func FileUploadResultFactory 

func FileUploadResultFactory(
	Token string,
	Url string,
) FileUploadResultStruct

FileUploadResultFactory is just a simple function to instantiate the FileUploadResultStruct

type FilesystemLayout 

type FilesystemLayout interface{}

FilesystemLayout is an empty interface designed to function as the FilesystemLayout API namespace

type FractionPlugParametersStruct 

type FractionPlugParametersStruct struct {
	// Optional prefix to add to schemas being moved into warehouse.
	// update = optional
	// pattern = ^([A-Za-z][A-Za-z0-9_]+)|("[A-Za-z][A-Za-z0-9_]+")$
	// maxLength = 28
	// create = optional
	SchemasPrefix string `json:"schemasPrefix,omitempty"`
	// Optional prefix to add to tablespaces being moved into warehouse.
	// create = optional
	// update = optional
	// pattern = ^([A-Za-z][A-Za-z0-9_]+)|("[A-Za-z][A-Za-z0-9_]+")$
	// maxLength = 28
	TablespacesPrefix string `json:"tablespacesPrefix,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base
	// provisioning on.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

FractionPlugParametersStruct - The parameters to use as input when transporting a transportable tablespace. extends TypedObject

func FractionPlugParametersFactory 

func FractionPlugParametersFactory(
	SchemasPrefix string,
	TablespacesPrefix string,
	TimeflowPointParameters TimeflowPointParameters,
) FractionPlugParametersStruct

FractionPlugParametersFactory is just a simple function to instantiate the FractionPlugParametersStruct

type GetCurrentPasswordPolicyParametersStruct 

type GetCurrentPasswordPolicyParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Type of user.
	// required = true
	// enum = [SYSTEM DOMAIN]
	UserType string `json:"userType,omitempty"`
}

GetCurrentPasswordPolicyParametersStruct - The parameters to use as input when getting the currently active password policy. extends TypedObject

func GetCurrentPasswordPolicyParametersFactory 

func GetCurrentPasswordPolicyParametersFactory(
	UserType string,
) GetCurrentPasswordPolicyParametersStruct

GetCurrentPasswordPolicyParametersFactory is just a simple function to instantiate the GetCurrentPasswordPolicyParametersStruct

type GlobalLinkingSettingsStruct 

type GlobalLinkingSettingsStruct struct {
	// True if encrypted linking should be enabled by default on new
	// dSources.
	// update = optional
	EncryptedLinkingEnabledByDefault *bool `json:"encryptedLinkingEnabledByDefault,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

GlobalLinkingSettingsStruct - System-wide linking settings. extends TypedObject

func GlobalLinkingSettingsFactory 

func GlobalLinkingSettingsFactory(
	EncryptedLinkingEnabledByDefault *bool,
) GlobalLinkingSettingsStruct

GlobalLinkingSettingsFactory is just a simple function to instantiate the GlobalLinkingSettingsStruct

type GroupStruct 

type GroupStruct struct {
	// Optional description for the group.
	// create = optional
	// update = optional
	// maxLength = 1024
	Description string `json:"description,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

GroupStruct - Database group. extends NamedUserObject

func GroupFactory 

func GroupFactory(
	Description string,
	Name string,
	Namespace string,
	Reference string,
) GroupStruct

GroupFactory is just a simple function to instantiate the GroupStruct

type HistoricalConsumerCapacityDataStruct 

type HistoricalConsumerCapacityDataStruct struct {
	// Statistics for this consumer.
	Breakdown *CapacityBreakdownStruct `json:"breakdown,omitempty"`
	// Reference to the container.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Reference to this container's group.
	// format = objectReference
	// referenceTo = /delphix-group.json
	Group string `json:"group,omitempty"`
	// Name of this container's group.
	GroupName string `json:"groupName,omitempty"`
	// Name of the container.
	Name string `json:"name,omitempty"`
	// Container from which this TimeFlow was provisioned.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Parent string `json:"parent,omitempty"`
	// Time at which this information was sampled.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

HistoricalConsumerCapacityDataStruct - Historical data about a particular capacity consumer. extends BaseConsumerCapacityData cliVisibility = [DOMAIN]

func HistoricalConsumerCapacityDataFactory 

func HistoricalConsumerCapacityDataFactory(
	Breakdown *CapacityBreakdownStruct,
	Container string,
	Group string,
	GroupName string,
	Name string,
	Parent string,
	Timestamp string,
) HistoricalConsumerCapacityDataStruct

HistoricalConsumerCapacityDataFactory is just a simple function to instantiate the HistoricalConsumerCapacityDataStruct

type HistoricalGroupCapacityDataStruct 

type HistoricalGroupCapacityDataStruct struct {
	// Which group these stats represent.
	// format = objectReference
	// referenceTo = /delphix-group.json
	Group string `json:"group,omitempty"`
	// Statistics for dSources in this aggregation.
	Source *CapacityBreakdownStruct `json:"source,omitempty"`
	// Time at which this information was sampled.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Statistics for VDBs in this aggregation.
	Virtual *CapacityBreakdownStruct `json:"virtual,omitempty"`
}

HistoricalGroupCapacityDataStruct - Historical capacity data aggregated over a group. extends BaseGroupCapacityData cliVisibility = [DOMAIN]

func HistoricalGroupCapacityDataFactory 

func HistoricalGroupCapacityDataFactory(
	Group string,
	Source *CapacityBreakdownStruct,
	Timestamp string,
	Virtual *CapacityBreakdownStruct,
) HistoricalGroupCapacityDataStruct

HistoricalGroupCapacityDataFactory is just a simple function to instantiate the HistoricalGroupCapacityDataStruct

type HistoricalSystemCapacityDataStruct 

type HistoricalSystemCapacityDataStruct struct {
	// Statistics for dSources in this aggregation.
	Source *CapacityBreakdownStruct `json:"source,omitempty"`
	// Time at which this information was sampled.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Total storage space (used and unused).
	// units = B
	// base = 1024
	TotalSpace float64 `json:"totalSpace,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Statistics for VDBs in this aggregation.
	Virtual *CapacityBreakdownStruct `json:"virtual,omitempty"`
}

HistoricalSystemCapacityDataStruct - Capacity data for the entire system. extends BaseSystemCapacityData cliVisibility = [DOMAIN]

func HistoricalSystemCapacityDataFactory 

func HistoricalSystemCapacityDataFactory(
	Source *CapacityBreakdownStruct,
	Timestamp string,
	TotalSpace float64,
	Virtual *CapacityBreakdownStruct,
) HistoricalSystemCapacityDataStruct

HistoricalSystemCapacityDataFactory is just a simple function to instantiate the HistoricalSystemCapacityDataStruct

type Host 

type Host interface{}

Host is an empty interface designed to function as the Host API namespace

type HostConfigurationStruct 

type HostConfigurationStruct struct {
	// Indicates whether the host configuration properties were
	// discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The timestamp when the host was last refreshed.
	LastRefreshed string `json:"lastRefreshed,omitempty"`
	// The timestamp when the host was last updated.
	LastUpdated string `json:"lastUpdated,omitempty"`
	// The host machine information.
	Machine *HostMachineStruct `json:"machine,omitempty"`
	// The host operating system information.
	OperatingSystem *HostOSStruct `json:"operatingSystem,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

HostConfigurationStruct - The representation of the host configuration properties. extends TypedObject

func HostConfigurationFactory 

func HostConfigurationFactory(
	Discovered *bool,
	LastRefreshed string,
	LastUpdated string,
	Machine *HostMachineStruct,
	OperatingSystem *HostOSStruct,
) HostConfigurationStruct

HostConfigurationFactory is just a simple function to instantiate the HostConfigurationStruct

type HostCreateParameters 

type HostCreateParameters interface{}

HostCreateParameters is an empty interface designed to function as the HostCreateParameters API namespace

type HostEnvironment 

type HostEnvironment interface{}

HostEnvironment is an empty interface designed to function as the HostEnvironment API namespace

type HostEnvironmentCreateParametersStruct 

type HostEnvironmentCreateParametersStruct struct {
	// The host environment.
	// create = required
	HostEnvironment HostEnvironment `json:"hostEnvironment,omitempty"`
	// The host parameters used to add a host.
	// create = required
	HostParameters HostCreateParameters `json:"hostParameters,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to the created source
	// environment.
	// create = optional
	// update = optional
	// default = false
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The primary user associated with the environment.
	// create = required
	PrimaryUser *EnvironmentUserStruct `json:"primaryUser,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

HostEnvironmentCreateParametersStruct - The parameters used for the host environment create operation. extends SourceEnvironmentCreateParameters

func HostEnvironmentCreateParametersFactory 

func HostEnvironmentCreateParametersFactory(
	HostEnvironment HostEnvironment,
	HostParameters HostCreateParameters,
	LogCollectionEnabled *bool,
	PrimaryUser *EnvironmentUserStruct,
) HostEnvironmentCreateParametersStruct

HostEnvironmentCreateParametersFactory is just a simple function to instantiate the HostEnvironmentCreateParametersStruct

type HostMachineStruct 

type HostMachineStruct struct {
	// The amount of RAM on the host machine.
	// units = B
	// base = 1024
	MemorySize float64 `json:"memorySize,omitempty"`
	// The platform for the host machine.
	Platform string `json:"platform,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

HostMachineStruct - The representation of the host machine. extends TypedObject

func HostMachineFactory 

func HostMachineFactory(
	MemorySize float64,
	Platform string,
) HostMachineStruct

HostMachineFactory is just a simple function to instantiate the HostMachineStruct

type HostOSStruct 

type HostOSStruct struct {
	// The OS distribution.
	Distribution string `json:"distribution,omitempty"`
	// The OS kernel.
	Kernel string `json:"kernel,omitempty"`
	// The OS name.
	Name string `json:"name,omitempty"`
	// The OS release.
	Release string `json:"release,omitempty"`
	// The OS timezone.
	Timezone string `json:"timezone,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The OS version.
	Version string `json:"version,omitempty"`
}

HostOSStruct - The operating system information for the host. extends TypedObject

func HostOSFactory 

func HostOSFactory(
	Distribution string,
	Kernel string,
	Name string,
	Release string,
	Timezone string,
	Version string,
) HostOSStruct

HostOSFactory is just a simple function to instantiate the HostOSStruct

type HostPrivilegeElevationProfileScriptStruct 

type HostPrivilegeElevationProfileScriptStruct struct {
	// The contents of the privilege elevation profile script.
	// update = optional
	// create = required
	Contents string `json:"contents,omitempty"`
	// The privilege elevation profile script name.
	// create = required
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The privilege elevation profile to which this script belongs.
	// format = objectReference
	// referenceTo = /delphix-host-privilege-elevation-profile.json
	// create = required
	// update = optional
	Profile string `json:"profile,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

HostPrivilegeElevationProfileScriptStruct - A script that is part of a profile for elevating user privileges on a host. extends PersistentObject cliVisibility = [DOMAIN]

func HostPrivilegeElevationProfileScriptFactory 

func HostPrivilegeElevationProfileScriptFactory(
	Contents string,
	Name string,
	Namespace string,
	Profile string,
	Reference string,
) HostPrivilegeElevationProfileScriptStruct

HostPrivilegeElevationProfileScriptFactory is just a simple function to instantiate the HostPrivilegeElevationProfileScriptStruct

type HostPrivilegeElevationProfileStruct 

type HostPrivilegeElevationProfileStruct struct {
	// True if this is the default privilege elevation profile for new
	// environments.
	// default = false
	// update = readonly
	IsDefault *bool `json:"isDefault,omitempty"`
	// The privilege elevation profile name.
	// update = optional
	// create = required
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Privilege elevation profile version.
	// create = required
	// update = optional
	Version string `json:"version,omitempty"`
}

HostPrivilegeElevationProfileStruct - Profile for elevating user privileges on a host. extends PersistentObject cliVisibility = [DOMAIN]

func HostPrivilegeElevationProfileFactory 

func HostPrivilegeElevationProfileFactory(
	IsDefault *bool,
	Name string,
	Namespace string,
	Reference string,
	Version string,
) HostPrivilegeElevationProfileStruct

HostPrivilegeElevationProfileFactory is just a simple function to instantiate the HostPrivilegeElevationProfileStruct

type HostPrivilegeElevationSettingsStruct 

type HostPrivilegeElevationSettingsStruct struct {
	// The default privilege elevation profile for new environments.
	// format = objectReference
	// referenceTo = /delphix-host-privilege-elevation-profile.json
	// update = required
	DefaultProfile string `json:"defaultProfile,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

HostPrivilegeElevationSettingsStruct - Settings for elevating user privileges on a host. extends TypedObject cliVisibility = [DOMAIN]

func HostPrivilegeElevationSettingsFactory 

func HostPrivilegeElevationSettingsFactory(
	DefaultProfile string,
) HostPrivilegeElevationSettingsStruct

HostPrivilegeElevationSettingsFactory is just a simple function to instantiate the HostPrivilegeElevationSettingsStruct

type HostRuntimeStruct 

type HostRuntimeStruct struct {
	// True if the host is up and a connection can be established.
	Available *bool `json:"available,omitempty"`
	// The time that the 'available' propery was last checked.
	// format = date
	AvailableTimestamp string `json:"availableTimestamp,omitempty"`
	// The reason why the host is not available.
	NotAvailableReason string `json:"notAvailableReason,omitempty"`
	// Traceroute network hops from host to Delphix Engine.
	TraceRouteInfo *TracerouteInfoStruct `json:"traceRouteInfo,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

HostRuntimeStruct - Runtime, non-persistent properties for a host machine. extends TypedObject

func HostRuntimeFactory 

func HostRuntimeFactory(
	Available *bool,
	AvailableTimestamp string,
	NotAvailableReason string,
	TraceRouteInfo *TracerouteInfoStruct,
) HostRuntimeStruct

HostRuntimeFactory is just a simple function to instantiate the HostRuntimeStruct

type HttpConnectorConfigStruct 

type HttpConnectorConfigStruct struct {
	// Controls the HTTP(s) protocol configuration of this appliance.
	// default = BOTH
	// update = optional
	// enum = [HTTP_ONLY HTTPS_ONLY HTTP_REDIRECT BOTH]
	HttpMode string `json:"httpMode,omitempty"`
	// The HTTP port for the Delphix web UI.
	// update = optional
	// create = optional
	// default = 80
	// minimum = 1
	// maximum = 65535
	HttpPort *int `json:"httpPort,omitempty"`
	// The HTTPS port for the Delphix web UI.
	// update = optional
	// create = optional
	// default = 443
	// minimum = 1
	// maximum = 65535
	HttpsPort *int `json:"httpsPort,omitempty"`
	// Version of TLS (transport layer security) enabled on this
	// appliance.
	// minItems = 1
	// update = optional
	TlsVersions []string `json:"tlsVersions,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

HttpConnectorConfigStruct - Configuration for the HTTP and HTTPS connector of this application. extends TypedObject cliVisibility = [SYSTEM]

func HttpConnectorConfigFactory 

func HttpConnectorConfigFactory(
	HttpMode string,
	HttpPort *int,
	HttpsPort *int,
	TlsVersions []string,
) HttpConnectorConfigStruct

HttpConnectorConfigFactory is just a simple function to instantiate the HttpConnectorConfigStruct

type IScsiOpsDatapointStreamStruct 

type IScsiOpsDatapointStreamStruct struct {
	// Address of the client.
	// format = host
	Client string `json:"client,omitempty"`
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// I/O operation type.
	// enum = [read write]
	Op string `json:"op,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

IScsiOpsDatapointStreamStruct - A stream of datapoints from a iSCSI_OPS analytics slice. extends DatapointStream

func IScsiOpsDatapointStreamFactory 

func IScsiOpsDatapointStreamFactory(
	Client string,
	Datapoints []Datapoint,
	Op string,
) IScsiOpsDatapointStreamStruct

IScsiOpsDatapointStreamFactory is just a simple function to instantiate the IScsiOpsDatapointStreamStruct

type IngestionStrategy 

type IngestionStrategy interface{}

IngestionStrategy is an empty interface designed to function as the IngestionStrategy API namespace

type IntegerConstraint 

type IntegerConstraint interface{}

IntegerConstraint is an empty interface designed to function as the IntegerConstraint API namespace

type IntegerEqualConstraintStruct 

type IntegerEqualConstraintStruct struct {
	// The name of the axis being constrained.
	// create = required
	AxisName string `json:"axisName,omitempty"`
	// The axis values must equal this value.
	// create = required
	Equals *int `json:"equals,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

IntegerEqualConstraintStruct - Constraint placed on a numerical axis of a particular analytics slice. extends IntegerConstraint

func IntegerEqualConstraintFactory 

func IntegerEqualConstraintFactory(
	AxisName string,
	Equals *int,
) IntegerEqualConstraintStruct

IntegerEqualConstraintFactory is just a simple function to instantiate the IntegerEqualConstraintStruct

type IntegerGreaterThanConstraintStruct 

type IntegerGreaterThanConstraintStruct struct {
	// The name of the axis being constrained.
	// create = required
	AxisName string `json:"axisName,omitempty"`
	// The axis values must be greater than this value.
	// create = required
	GreaterThan *int `json:"greaterThan,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

IntegerGreaterThanConstraintStruct - Constraint placed on a numerical axis of a particular analytics slice. extends IntegerConstraint

func IntegerGreaterThanConstraintFactory 

func IntegerGreaterThanConstraintFactory(
	AxisName string,
	GreaterThan *int,
) IntegerGreaterThanConstraintStruct

IntegerGreaterThanConstraintFactory is just a simple function to instantiate the IntegerGreaterThanConstraintStruct

type IntegerLessThanConstraintStruct 

type IntegerLessThanConstraintStruct struct {
	// The name of the axis being constrained.
	// create = required
	AxisName string `json:"axisName,omitempty"`
	// The axis values must be less than than this value.
	// create = required
	LessThan *int `json:"lessThan,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

IntegerLessThanConstraintStruct - Constraint placed on a numerical axis of a particular analytics slice. extends IntegerConstraint

func IntegerLessThanConstraintFactory 

func IntegerLessThanConstraintFactory(
	AxisName string,
	LessThan *int,
) IntegerLessThanConstraintStruct

IntegerLessThanConstraintFactory is just a simple function to instantiate the IntegerLessThanConstraintStruct

type InterfaceAddressStruct 

type InterfaceAddressStruct struct {
	// The address in Classless Inter-Domain Routing (CIDR) notation.
	// update = optional
	// format = cidrAddress
	// create = optional
	Address string `json:"address,omitempty"`
	// The type of address (STATIC or DHCP).
	// enum = [STATIC DHCP]
	// default = STATIC
	// create = required
	// update = optional
	AddressType string `json:"addressType,omitempty"`
	// True if this address should accept incoming SSH connections.
	// default = true
	// create = optional
	// update = optional
	EnableSSH *bool `json:"enableSSH,omitempty"`
	// True if the API session is established over this address. This
	// property helps a client make informative decisions about which
	// address should not be modified without affecting the session over
	// which it is connected.
	SessionInUse *bool `json:"sessionInUse,omitempty"`
	// The state of the address.
	// enum = [OK TENTATIVE DUPLICATE INACCESSIBLE]
	State string `json:"state,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

InterfaceAddressStruct - IP address assigned to a network interface. extends TypedObject

func InterfaceAddressFactory 

func InterfaceAddressFactory(
	Address string,
	AddressType string,
	EnableSSH *bool,
	SessionInUse *bool,
	State string,
) InterfaceAddressStruct

InterfaceAddressFactory is just a simple function to instantiate the InterfaceAddressStruct

type IoOpsDatapointStruct 

type IoOpsDatapointStruct struct {
	// Average I/O latency in nanoseconds.
	AvgLatency *int `json:"avgLatency,omitempty"`
	// Number of I/O operations.
	Count *int `json:"count,omitempty"`
	// I/O latencies in nanoseconds.
	Latency map[string]string `json:"latency,omitempty"`
	// I/O sizes in bytes.
	Size map[string]string `json:"size,omitempty"`
	// I/O throughput in bytes.
	// units = B
	// base = 1024
	Throughput *int `json:"throughput,omitempty"`
	// The time this datapoint was collected.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

IoOpsDatapointStruct - An analytics datapoint generated by the DISK_OPS, DxFS_OPS, DxFS_IO_QUEUE_OPS, iSCSI_OPS, NFS_OPS, or VFS_OPS statistic types. extends Datapoint

func IoOpsDatapointFactory 

func IoOpsDatapointFactory(
	AvgLatency *int,
	Count *int,
	Latency map[string]string,
	Size map[string]string,
	Throughput *int,
	Timestamp string,
) IoOpsDatapointStruct

IoOpsDatapointFactory is just a simple function to instantiate the IoOpsDatapointStruct

type JDBCConnectivityStruct 

type JDBCConnectivityStruct struct {
	// Database password.
	// format = password
	// required = true
	Password string `json:"password,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// JDBC connection URL.
	// format = oracleJDBCConnectionString
	// required = true
	Url string `json:"url,omitempty"`
	// Database username.
	// required = true
	User string `json:"user,omitempty"`
}

JDBCConnectivityStruct - Mechanism to test JDBC connectivity of arbitrary databases. extends TypedObject

func JDBCConnectivityFactory 

func JDBCConnectivityFactory(
	Password string,
	Url string,
	User string,
) JDBCConnectivityStruct

JDBCConnectivityFactory is just a simple function to instantiate the JDBCConnectivityStruct

type JSBookmarkCheckoutCountStruct 

type JSBookmarkCheckoutCountStruct struct {
	// The bookmark that this checkout count is associated with.
	// referenceTo = /delphix-js-bookmark.json
	// format = objectReference
	Bookmark string `json:"bookmark,omitempty"`
	// The number of times the bookmark has been checked out. This means
	// it was used as input to a RESTORE, CREATE_BRANCH, or RESET
	// operation. This should not be replicated.
	CheckoutCount *int `json:"checkoutCount,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSBookmarkCheckoutCountStruct - The number of times a bookmark has been checked out. This means it was used as input to a RESTORE, CREATE_BRANCH, or RESET operation. The bookmark checkout count is kept separately on replicated templates. extends PersistentObject

func JSBookmarkCheckoutCountFactory 

func JSBookmarkCheckoutCountFactory(
	Bookmark string,
	CheckoutCount *int,
	Namespace string,
	Reference string,
) JSBookmarkCheckoutCountStruct

JSBookmarkCheckoutCountFactory is just a simple function to instantiate the JSBookmarkCheckoutCountStruct

type JSBookmarkCreateParametersStruct 

type JSBookmarkCreateParametersStruct struct {
	// The Self-Service bookmark object.
	// required = true
	Bookmark *JSBookmarkStruct `json:"bookmark,omitempty"`
	// The Self-Service data timeline point at which the bookmark will be
	// created.
	// required = true
	TimelinePointParameters JSTimelinePointTimeParameters `json:"timelinePointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSBookmarkCreateParametersStruct - The parameters used to create a Self-Service bookmark. extends TypedObject

func JSBookmarkCreateParametersFactory 

func JSBookmarkCreateParametersFactory(
	Bookmark *JSBookmarkStruct,
	TimelinePointParameters JSTimelinePointTimeParameters,
) JSBookmarkCreateParametersStruct

JSBookmarkCreateParametersFactory is just a simple function to instantiate the JSBookmarkCreateParametersStruct

type JSBookmarkDataParentStruct 

type JSBookmarkDataParentStruct struct {
	// The bookmark that this operation's data came from. This will be
	// null if the bookmark has been deleted.
	// referenceTo = /delphix-js-bookmark.json
	// format = objectReference
	Bookmark string `json:"bookmark,omitempty"`
	// This will always contain the name of the bookmark, even if it has
	// been deleted.
	// maxLength = 256
	BookmarkName string `json:"bookmarkName,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSBookmarkDataParentStruct - The bookmark data parent of a RESTORE or CREATE_BRANCH operation. extends JSDataParent

func JSBookmarkDataParentFactory 

func JSBookmarkDataParentFactory(
	Bookmark string,
	BookmarkName string,
) JSBookmarkDataParentStruct

JSBookmarkDataParentFactory is just a simple function to instantiate the JSBookmarkDataParentStruct

type JSBookmarkStruct 

type JSBookmarkStruct struct {
	// Denotes whether or not this bookmark was created on a data
	// container or a data template.
	// enum = [DATA_CONTAINER DATA_TEMPLATE]
	BookmarkType string `json:"bookmarkType,omitempty"`
	// A reference to the branch this bookmark applies to.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	// create = required
	Branch string `json:"branch,omitempty"`
	// The number of times this bookmark has been checked out. This means
	// it was used as input to a RESTORE, CREATE_BRANCH, or RESET
	// operation.
	CheckoutCount *int `json:"checkoutCount,omitempty"`
	// The data container this bookmark was created on. This will be null
	// if the bookmark was created on a data template.
	// format = objectReference
	// referenceTo = /delphix-js-data-container.json
	Container string `json:"container,omitempty"`
	// The name of the data container this bookmark was created on. This
	// will be null if the bookmark was created on a data template.
	ContainerName string `json:"containerName,omitempty"`
	// The time at which the bookmark was created.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// Description of this bookmark.
	// create = optional
	// update = optional
	// maxLength = 4096
	Description string `json:"description,omitempty"`
	// A policy will automatically delete this bookmark at this time. If
	// the value is null, then the bookmark will be kept until manually
	// deleted.
	// format = date
	// create = optional
	// update = optional
	Expiration string `json:"expiration,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// True if this bookmark is shared.
	// create = optional
	Shared *bool `json:"shared,omitempty"`
	// A set of user-defined labels for this bookmark.
	// create = optional
	// update = optional
	Tags []string `json:"tags,omitempty"`
	// The data template this bookmark was created on or the template of
	// the data container this bookmark was created on.
	// format = objectReference
	// referenceTo = /delphix-js-data-template.json
	Template string `json:"template,omitempty"`
	// The name of the data template this bookmark was created on or the
	// template of the data container this bookmark was created on.
	TemplateName string `json:"templateName,omitempty"`
	// The timestamp for the data that the bookmark refers to.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// True if this bookmark is usable as input to a data operation
	// (e.g., CREATE_BRANCH or RESTORE).
	Usable *bool `json:"usable,omitempty"`
}

JSBookmarkStruct - A named entity that represents a point in time for all of the data sources in a data layout. extends NamedUserObject

func JSBookmarkFactory 

func JSBookmarkFactory(
	BookmarkType string,
	Branch string,
	CheckoutCount *int,
	Container string,
	ContainerName string,
	CreationTime string,
	Description string,
	Expiration string,
	Name string,
	Namespace string,
	Reference string,
	Shared *bool,
	Tags []string,
	Template string,
	TemplateName string,
	Timestamp string,
	Usable *bool,
) JSBookmarkStruct

JSBookmarkFactory is just a simple function to instantiate the JSBookmarkStruct

type JSBookmarkTagUsageDataStruct 

type JSBookmarkTagUsageDataStruct struct {
	// The amount of space that will be freed if bookmarks with this tag
	// are deleted.
	BookmarkTag string `json:"bookmarkTag,omitempty"`
	// The total amount of space referenced by bookmarks with this tag.
	// This is the sum of the bookmarks' unique, shared, and
	// externallyReferenced space.
	// base = 1024
	// units = B
	Referenced float64 `json:"referenced,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The space that is being consumed by the set of bookmarks with the
	// given tag. This represents the minimum amount of space that will
	// be freed if all of the bookmarks are deleted.
	// base = 1024
	// units = B
	Unique float64 `json:"unique,omitempty"`
}

JSBookmarkTagUsageDataStruct - The space usage information for a Self-Service bookmark tag. extends TypedObject

func JSBookmarkTagUsageDataFactory 

func JSBookmarkTagUsageDataFactory(
	BookmarkTag string,
	Referenced float64,
	Unique float64,
) JSBookmarkTagUsageDataStruct

JSBookmarkTagUsageDataFactory is just a simple function to instantiate the JSBookmarkTagUsageDataStruct

type JSBookmarkUsageDataStruct 

type JSBookmarkUsageDataStruct struct {
	// The Self-Service bookmark that this usage information is for.
	// format = objectReference
	// referenceTo = /delphix-js-bookmark.json
	Bookmark string `json:"bookmark,omitempty"`
	// The data layout that this bookmark belongs to.
	DataLayout string `json:"dataLayout,omitempty"`
	// The amount of space referenced by this bookmark that cannot be
	// freed up by deleting this bookmark because it is also being
	// referenced outside of Self-Service (e.g. by retention policy).
	// base = 1024
	// units = B
	ExternallyReferenced float64 `json:"externallyReferenced,omitempty"`
	// The amount of space referenced by this bookmark that cannot be
	// freed up by deleting this bookmark because it is also referenced
	// by neighboring bookmarks or branches that have been created or
	// restored from this bookmark.
	// base = 1024
	// units = B
	Shared float64 `json:"shared,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The amount of space that will be freed if this bookmark is
	// deleted.
	// base = 1024
	// units = B
	Unique float64 `json:"unique,omitempty"`
}

JSBookmarkUsageDataStruct - The space usage information for a Self-Service bookmark. extends TypedObject

func JSBookmarkUsageDataFactory 

func JSBookmarkUsageDataFactory(
	Bookmark string,
	DataLayout string,
	ExternallyReferenced float64,
	Shared float64,
	Unique float64,
) JSBookmarkUsageDataStruct

JSBookmarkUsageDataFactory is just a simple function to instantiate the JSBookmarkUsageDataStruct

type JSBranchCreateParametersStruct 

type JSBranchCreateParametersStruct struct {
	// A reference to the data container to create this branch on.
	// format = objectReference
	// referenceTo = /delphix-js-data-container.json
	// required = true
	DataContainer string `json:"dataContainer,omitempty"`
	// The name of the branch.
	// maxLength = 256
	// required = true
	Name string `json:"name,omitempty"`
	// The Self-Service data timeline point from which the branch will be
	// created.
	// required = true
	TimelinePointParameters JSTimelinePointParameters `json:"timelinePointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSBranchCreateParametersStruct - The parameters used to create a Self-Service branch. extends TypedObject

func JSBranchCreateParametersFactory 

func JSBranchCreateParametersFactory(
	DataContainer string,
	Name string,
	TimelinePointParameters JSTimelinePointParameters,
) JSBranchCreateParametersStruct

JSBranchCreateParametersFactory is just a simple function to instantiate the JSBranchCreateParametersStruct

type JSBranchStruct 

type JSBranchStruct struct {
	// A reference to the data layout this branch was created on.
	// format = objectReference
	// referenceTo = /delphix-js-data-layout.json
	DataLayout string `json:"dataLayout,omitempty"`
	// The first JSOperation on this branch by data time.
	// format = objectReference
	// referenceTo = /delphix-js-operation.json
	FirstOperation string `json:"firstOperation,omitempty"`
	// The last JSOperation on this branch by data time.
	// format = objectReference
	// referenceTo = /delphix-js-operation.json
	LastOperation string `json:"lastOperation,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

JSBranchStruct - A branch represents a distinct timeline for data sources in a data layout. extends NamedUserObject

func JSBranchFactory 

func JSBranchFactory(
	DataLayout string,
	FirstOperation string,
	LastOperation string,
	Name string,
	Namespace string,
	Reference string,
) JSBranchStruct

JSBranchFactory is just a simple function to instantiate the JSBranchStruct

type JSBranchUsageDataStruct 

type JSBranchUsageDataStruct struct {
	// The Self-Service branch that this usage information is for.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	Branch string `json:"branch,omitempty"`
	// The name of the data container that this branch resides on.
	DataContainer string `json:"dataContainer,omitempty"`
	// The amount of space that cannot be freed on the parent data
	// template (or sibling data containers) because it is also being
	// referenced by this branch due to restore or create branch
	// operations.
	// base = 1024
	// units = B
	SharedOthers float64 `json:"sharedOthers,omitempty"`
	// The amount of space that cannot be freed up on this branch because
	// it is also being referenced by sibling data containers due to
	// restore or create branch operations.
	// base = 1024
	// units = B
	SharedSelf float64 `json:"sharedSelf,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The amount of space that will be freed if this branch is deleted.
	// base = 1024
	// units = B
	Unique float64 `json:"unique,omitempty"`
}

JSBranchUsageDataStruct - The space usage information for a Self-Service branch. extends TypedObject

func JSBranchUsageDataFactory 

func JSBranchUsageDataFactory(
	Branch string,
	DataContainer string,
	SharedOthers float64,
	SharedSelf float64,
	Unique float64,
) JSBranchUsageDataStruct

JSBranchUsageDataFactory is just a simple function to instantiate the JSBranchUsageDataStruct

type JSConfigStruct 

type JSConfigStruct struct {
	// Default expiration for bookmarks created through the GUI, in days.
	// If value is 0, bookmarks will default to no expiration.
	// update = optional
	// minimum = 0
	DefaultBookmarkExpiration *int `json:"defaultBookmarkExpiration,omitempty"`
	// The number of times to retry failed sources during Self-Service
	// data operations.
	// update = optional
	// minimum = 0
	RetryAttempts *int `json:"retryAttempts,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSConfigStruct - Self-Service configuration. extends TypedObject

func JSConfigFactory 

func JSConfigFactory(
	DefaultBookmarkExpiration *int,
	RetryAttempts *int,
) JSConfigStruct

JSConfigFactory is just a simple function to instantiate the JSConfigStruct

type JSContainerUsageDataStruct 

type JSContainerUsageDataStruct struct {
	// The data container that this usage information is for.
	// format = objectReference
	// referenceTo = /delphix-js-data-container.json
	DataContainer string `json:"dataContainer,omitempty"`
	// The amount of space that cannot be freed on the parent data
	// template (or sibling data containers) because it is also being
	// referenced by this data container due to restore or create branch
	// operations.
	// base = 1024
	// units = B
	SharedOthers float64 `json:"sharedOthers,omitempty"`
	// The amount of space that cannot be freed on this data container
	// because it is also being referenced by sibling data containers due
	// to restore or create branch operations.
	// base = 1024
	// units = B
	SharedSelf float64 `json:"sharedSelf,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The amount of space that will be freed if this data container is
	// deleted or purged. This assumes that the data container is deleted
	// along with underlying data sources.
	// base = 1024
	// units = B
	Unique float64 `json:"unique,omitempty"`
	// The amount of space that would be consumed by the data in this
	// container without Delphix.
	// units = B
	// base = 1024
	Unvirtualized float64 `json:"unvirtualized,omitempty"`
}

JSContainerUsageDataStruct - The space usage information for a data container. extends TypedObject

func JSContainerUsageDataFactory 

func JSContainerUsageDataFactory(
	DataContainer string,
	SharedOthers float64,
	SharedSelf float64,
	Unique float64,
	Unvirtualized float64,
) JSContainerUsageDataStruct

JSContainerUsageDataFactory is just a simple function to instantiate the JSContainerUsageDataStruct

type JSDailyOperationDurationStruct 

type JSDailyOperationDurationStruct struct {
	// The average duration in seconds of running the specified operation
	// in the past day.
	// units = sec
	DailyAverageDuration *int `json:"dailyAverageDuration,omitempty"`
	// The number of times the specified operation was run in the past
	// day.
	DailyCount *int `json:"dailyCount,omitempty"`
	// The maximum duration in seconds of running the specified operation
	// in the past day.
	// units = sec
	DailyMaxDuration *int `json:"dailyMaxDuration,omitempty"`
	// The minimum duration in seconds of running the specified operation
	// in the past day.
	// units = sec
	DailyMinDuration *int `json:"dailyMinDuration,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The operation performed.
	// enum = [REFRESH RESET CREATE_BRANCH RESTORE UNDO]
	Operation string `json:"operation,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The date at the beginning of the time period this datapoint
	// corresponds to. The time period itself varies between datapoint
	// types.
	// format = date
	StartDate string `json:"startDate,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The object the usage data is centered around.
	// format = objectReference
	// referenceTo = /delphix-named-user-object.json
	UsageObject string `json:"usageObject,omitempty"`
}

JSDailyOperationDurationStruct - Information about the durations of a specific operation type for a data container over the past week. extends JSUsageData

func JSDailyOperationDurationFactory 

func JSDailyOperationDurationFactory(
	DailyAverageDuration *int,
	DailyCount *int,
	DailyMaxDuration *int,
	DailyMinDuration *int,
	Namespace string,
	Operation string,
	Reference string,
	StartDate string,
	UsageObject string,
) JSDailyOperationDurationStruct

JSDailyOperationDurationFactory is just a simple function to instantiate the JSDailyOperationDurationStruct

type JSDataChildStruct 

type JSDataChildStruct struct {
	// Reference to the branch. This will be null if the user does not
	// have permission to see it.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	Branch string `json:"branch,omitempty"`
	// The name of the branch.
	// maxLength = 256
	BranchName string `json:"branchName,omitempty"`
	// The name of the container.
	// maxLength = 256
	ContainerName string `json:"containerName,omitempty"`
	// The operation performed.
	// enum = [REFRESH RESTORE CREATE_BRANCH RESET]
	Operation string `json:"operation,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the owner of the branch. This will be null if
	// there is no owner.
	// maxLength = 256
	UserName string `json:"userName,omitempty"`
}

JSDataChildStruct - A branch with data from a specific bookmark or PIT (point in time). extends TypedObject

func JSDataChildFactory 

func JSDataChildFactory(
	Branch string,
	BranchName string,
	ContainerName string,
	Operation string,
	UserName string,
) JSDataChildStruct

JSDataChildFactory is just a simple function to instantiate the JSDataChildStruct

type JSDataContainerActiveBranchParametersStruct 

type JSDataContainerActiveBranchParametersStruct struct {
	// The time that will be used to find which branch was active in the
	// data layout.
	// format = date
	// required = true
	Time string `json:"time,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerActiveBranchParametersStruct - Input parameters for the API that given a point in time, returns the active branch of the data container. extends TypedObject

func JSDataContainerActiveBranchParametersFactory 

func JSDataContainerActiveBranchParametersFactory(
	Time string,
) JSDataContainerActiveBranchParametersStruct

JSDataContainerActiveBranchParametersFactory is just a simple function to instantiate the JSDataContainerActiveBranchParametersStruct

type JSDataContainerCreateParameters 

type JSDataContainerCreateParameters interface{}

JSDataContainerCreateParameters is an empty interface designed to function as the JSDataContainerCreateParameters API namespace

type JSDataContainerCreateWithRefreshParametersStruct 

type JSDataContainerCreateWithRefreshParametersStruct struct {
	// The set of data sources that belong to this data layout.
	// required = true
	DataSources []*JSDataSourceCreateParametersStruct `json:"dataSources,omitempty"`
	// The name of the data layout.
	// maxLength = 256
	// required = true
	Name string `json:"name,omitempty"`
	// A description of this data layout to define what it is used for.
	// create = optional
	// maxLength = 4096
	Notes string `json:"notes,omitempty"`
	// A reference to the list of users that own this data container.
	// create = optional
	Owners []string `json:"owners,omitempty"`
	// Key/value pairs used to specify attributes for this data layout.
	// create = optional
	Properties map[string]string `json:"properties,omitempty"`
	// A reference to the template that this data container is
	// provisioned from.
	// format = objectReference
	// referenceTo = /delphix-js-data-template.json
	// required = true
	Template string `json:"template,omitempty"`
	// Create the data container with initial data specified by this
	// Self-Service timeline point.
	// required = true
	TimelinePointParameters JSTimelinePointParameters `json:"timelinePointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerCreateWithRefreshParametersStruct - The parameters used to create a data container when refreshing data sources. extends JSDataContainerCreateParameters

func JSDataContainerCreateWithRefreshParametersFactory 

func JSDataContainerCreateWithRefreshParametersFactory(
	DataSources []*JSDataSourceCreateParametersStruct,
	Name string,
	Notes string,
	Owners []string,
	Properties map[string]string,
	Template string,
	TimelinePointParameters JSTimelinePointParameters,
) JSDataContainerCreateWithRefreshParametersStruct

JSDataContainerCreateWithRefreshParametersFactory is just a simple function to instantiate the JSDataContainerCreateWithRefreshParametersStruct

type JSDataContainerCreateWithoutRefreshParametersStruct 

type JSDataContainerCreateWithoutRefreshParametersStruct struct {
	// The set of data sources that belong to this data layout.
	// required = true
	DataSources []*JSDataSourceCreateParametersStruct `json:"dataSources,omitempty"`
	// The name of the data layout.
	// maxLength = 256
	// required = true
	Name string `json:"name,omitempty"`
	// A description of this data layout to define what it is used for.
	// create = optional
	// maxLength = 4096
	Notes string `json:"notes,omitempty"`
	// A reference to the list of users that own this data container.
	// create = optional
	Owners []string `json:"owners,omitempty"`
	// Key/value pairs used to specify attributes for this data layout.
	// create = optional
	Properties map[string]string `json:"properties,omitempty"`
	// A reference to the template that this data container is
	// provisioned from.
	// format = objectReference
	// referenceTo = /delphix-js-data-template.json
	// required = true
	Template string `json:"template,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerCreateWithoutRefreshParametersStruct - The parameters used to create a data container when not refreshing data sources. extends JSDataContainerCreateParameters

func JSDataContainerCreateWithoutRefreshParametersFactory 

func JSDataContainerCreateWithoutRefreshParametersFactory(
	DataSources []*JSDataSourceCreateParametersStruct,
	Name string,
	Notes string,
	Owners []string,
	Properties map[string]string,
	Template string,
) JSDataContainerCreateWithoutRefreshParametersStruct

JSDataContainerCreateWithoutRefreshParametersFactory is just a simple function to instantiate the JSDataContainerCreateWithoutRefreshParametersStruct

type JSDataContainerDeleteParametersStruct 

type JSDataContainerDeleteParametersStruct struct {
	// If this value is true, then delete the underlying data from all
	// data sources.
	// required = true
	// default = true
	DeleteDataSources *bool `json:"deleteDataSources,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

JSDataContainerDeleteParametersStruct - The parameters used to delete a data container. extends TypedObject

func JSDataContainerDeleteParametersFactory 

func JSDataContainerDeleteParametersFactory(
	DeleteDataSources *bool,
) JSDataContainerDeleteParametersStruct

JSDataContainerDeleteParametersFactory is just a simple function to instantiate the JSDataContainerDeleteParametersStruct

type JSDataContainerLockParametersStruct 

type JSDataContainerLockParametersStruct struct {
	// A reference to the user object who locks the container.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-user.json
	LockUser string `json:"lockUser,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerLockParametersStruct - The parameters used to lock a data container. extends TypedObject

func JSDataContainerLockParametersFactory 

func JSDataContainerLockParametersFactory(
	LockUser string,
) JSDataContainerLockParametersStruct

JSDataContainerLockParametersFactory is just a simple function to instantiate the JSDataContainerLockParametersStruct

type JSDataContainerModifyOwnerParametersStruct 

type JSDataContainerModifyOwnerParametersStruct struct {
	// A reference to the user object for whom to add or remove
	// authorizations.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-user.json
	Owner string `json:"owner,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerModifyOwnerParametersStruct - Input parameters for addOwner or removeOwner for a data container. extends TypedObject

func JSDataContainerModifyOwnerParametersFactory 

func JSDataContainerModifyOwnerParametersFactory(
	Owner string,
) JSDataContainerModifyOwnerParametersStruct

JSDataContainerModifyOwnerParametersFactory is just a simple function to instantiate the JSDataContainerModifyOwnerParametersStruct

type JSDataContainerRefreshParametersStruct 

type JSDataContainerRefreshParametersStruct struct {
	// If this value is true, then do the operation without taking a
	// snapshot.
	// required = true
	// default = false
	ForceOption *bool `json:"forceOption,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerRefreshParametersStruct - The parameters used to refresh a data container. extends TypedObject

func JSDataContainerRefreshParametersFactory 

func JSDataContainerRefreshParametersFactory(
	ForceOption *bool,
) JSDataContainerRefreshParametersStruct

JSDataContainerRefreshParametersFactory is just a simple function to instantiate the JSDataContainerRefreshParametersStruct

type JSDataContainerResetParametersStruct 

type JSDataContainerResetParametersStruct struct {
	// If this value is true, then do the operation without taking a
	// snapshot.
	// required = true
	// default = false
	ForceOption *bool `json:"forceOption,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerResetParametersStruct - The parameters used to reset a data container.. extends TypedObject

func JSDataContainerResetParametersFactory 

func JSDataContainerResetParametersFactory(
	ForceOption *bool,
) JSDataContainerResetParametersStruct

JSDataContainerResetParametersFactory is just a simple function to instantiate the JSDataContainerResetParametersStruct

type JSDataContainerRestoreParametersStruct 

type JSDataContainerRestoreParametersStruct struct {
	// If this value is true, then do the operation without taking a
	// snapshot.
	// required = true
	// default = false
	ForceOption *bool `json:"forceOption,omitempty"`
	// The Self-Service data timeline point to restore from.
	// required = true
	TimelinePointParameters JSTimelinePointParameters `json:"timelinePointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerRestoreParametersStruct - The parameters used to restore a data container. extends TypedObject

func JSDataContainerRestoreParametersFactory 

func JSDataContainerRestoreParametersFactory(
	ForceOption *bool,
	TimelinePointParameters JSTimelinePointParameters,
) JSDataContainerRestoreParametersStruct

JSDataContainerRestoreParametersFactory is just a simple function to instantiate the JSDataContainerRestoreParametersStruct

type JSDataContainerStruct 

type JSDataContainerStruct struct {
	// The active branch of the data layout.
	// referenceTo = /delphix-js-branch.json
	// format = objectReference
	ActiveBranch string `json:"activeBranch,omitempty"`
	// The first JSOperation on this data layout by data time.
	// format = objectReference
	// referenceTo = /delphix-js-operation.json
	FirstOperation string `json:"firstOperation,omitempty"`
	// The last JSOperation on this data layout by data time.
	// format = objectReference
	// referenceTo = /delphix-js-operation.json
	LastOperation string `json:"lastOperation,omitempty"`
	// Timestamp of the last update to the application.
	// format = date
	LastUpdated string `json:"lastUpdated,omitempty"`
	// Name of the user who locked this data container.
	// update = readonly
	LockUserName string `json:"lockUserName,omitempty"`
	// The reference to the user who locked this data container.
	// format = objectReference
	// referenceTo = /delphix-user.json
	// update = readonly
	LockUserReference string `json:"lockUserReference,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Notes for this data layout.
	// update = optional
	// maxLength = 4096
	Notes string `json:"notes,omitempty"`
	// The number of operations performed on this data container.
	OperationCount *int `json:"operationCount,omitempty"`
	// For backward compatibility. The owner of the data container.
	// format = objectReference
	// referenceTo = /delphix-user.json
	// update = optional
	// internal = true
	Owner string `json:"owner,omitempty"`
	// Key/value pairs used to specify attributes for this data layout.
	// update = optional
	Properties map[string]string `json:"properties,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The state of the data container.
	// enum = [ONLINE OFFLINE INCONSISTENT]
	State string `json:"state,omitempty"`
	// The data template that this data container was provisioned from.
	// referenceTo = /delphix-js-data-template.json
	// format = objectReference
	Template string `json:"template,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerStruct - A container represents a data template provisioned for a specific user. extends JSDataLayout

func JSDataContainerFactory 

func JSDataContainerFactory(
	ActiveBranch string,
	FirstOperation string,
	LastOperation string,
	LastUpdated string,
	LockUserName string,
	LockUserReference string,
	Name string,
	Namespace string,
	Notes string,
	OperationCount *int,
	Owner string,
	Properties map[string]string,
	Reference string,
	State string,
	Template string,
) JSDataContainerStruct

JSDataContainerFactory is just a simple function to instantiate the JSDataContainerStruct

type JSDataContainerUndoParametersStruct 

type JSDataContainerUndoParametersStruct struct {
	// The operation to undo. This is only valid for RESET, RESTORE,
	// UNDO, and REFRESH operations.
	// format = objectReference
	// referenceTo = /delphix-js-operation.json
	// required = true
	Operation string `json:"operation,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataContainerUndoParametersStruct - The parameters used to undo an operation on a data container. extends TypedObject

func JSDataContainerUndoParametersFactory 

func JSDataContainerUndoParametersFactory(
	Operation string,
) JSDataContainerUndoParametersStruct

JSDataContainerUndoParametersFactory is just a simple function to instantiate the JSDataContainerUndoParametersStruct

type JSDataLayout 

type JSDataLayout interface{}

JSDataLayout is an empty interface designed to function as the JSDataLayout API namespace

type JSDataLayoutCreateParameters 

type JSDataLayoutCreateParameters interface{}

JSDataLayoutCreateParameters is an empty interface designed to function as the JSDataLayoutCreateParameters API namespace

type JSDataParent 

type JSDataParent interface{}

JSDataParent is an empty interface designed to function as the JSDataParent API namespace

type JSDataSourceCreateParametersStruct 

type JSDataSourceCreateParametersStruct struct {
	// A reference to the underlying container object.
	// format = objectReference
	// referenceTo = /delphix-container.json
	// required = true
	Container string `json:"container,omitempty"`
	// Key/value pairs used to specify attributes for this data source.
	// create = optional
	Properties map[string]string `json:"properties,omitempty"`
	// The Self-Service data source object.
	// required = true
	Source *JSDataSourceStruct `json:"source,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataSourceCreateParametersStruct - The parameters used to create the Self-Service data sources. extends TypedObject

func JSDataSourceCreateParametersFactory 

func JSDataSourceCreateParametersFactory(
	Container string,
	Properties map[string]string,
	Source *JSDataSourceStruct,
) JSDataSourceCreateParametersStruct

JSDataSourceCreateParametersFactory is just a simple function to instantiate the JSDataSourceCreateParametersStruct

type JSDataSourceStruct 

type JSDataSourceStruct struct {
	// A reference to the underlying container.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A reference to the Self-Service data layout to which this source
	// belongs.
	// format = objectReference
	// referenceTo = /delphix-js-data-layout.json
	DataLayout string `json:"dataLayout,omitempty"`
	// A description of this data source.
	// maxLength = 4096
	// create = optional
	// update = optional
	Description string `json:"description,omitempty"`
	// Flag indicating whether the source is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// Flag indicating whether the source is masked.
	Masked *bool `json:"masked,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Dictates order of operations on data sources. Operations can be
	// performed in parallel for all sources or sequentially. Below are
	// possible valid and invalid orderings given an example data
	// template with 3 sources (A, B, and C).<br>Valid:<br>A B C<br>1 1 1
	// (parallel)<br>1 2 3 (sequential)<br>Invalid:<br>A B C<br>2 2
	// 2<br>0 1 2<br>2 3 4<br>1 2 2<br>In the sequential case the data
	// source with priority 1 is the first to be started and the last to
	// be stopped. This value is set on creation of the template's data
	// sources and copied to the data container's data sources.
	// create = optional
	// minimum = 1
	// default = 1
	Priority *int `json:"priority,omitempty"`
	// Key/value pairs used to specify attributes for this data source.
	// create = optional
	// update = optional
	Properties map[string]string `json:"properties,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this data source.
	Runtime SourceConnectionInfo `json:"runtime,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataSourceStruct - The data source used for Self-Service data layouts. extends NamedUserObject

func JSDataSourceFactory 

func JSDataSourceFactory(
	Container string,
	DataLayout string,
	Description string,
	Enabled *bool,
	Masked *bool,
	Name string,
	Namespace string,
	Priority *int,
	Properties map[string]string,
	Reference string,
	Runtime SourceConnectionInfo,
) JSDataSourceStruct

JSDataSourceFactory is just a simple function to instantiate the JSDataSourceStruct

type JSDataTemplateCreateParametersStruct 

type JSDataTemplateCreateParametersStruct struct {
	// The set of data sources that belong to this data layout.
	// required = true
	DataSources []*JSDataSourceCreateParametersStruct `json:"dataSources,omitempty"`
	// The name of the data layout.
	// maxLength = 256
	// required = true
	Name string `json:"name,omitempty"`
	// A description of this data layout to define what it is used for.
	// create = optional
	// maxLength = 4096
	Notes string `json:"notes,omitempty"`
	// Key/value pairs used to specify attributes for this data layout.
	// create = optional
	Properties map[string]string `json:"properties,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataTemplateCreateParametersStruct - The parameters used to create a data template. extends JSDataLayoutCreateParameters

func JSDataTemplateCreateParametersFactory 

func JSDataTemplateCreateParametersFactory(
	DataSources []*JSDataSourceCreateParametersStruct,
	Name string,
	Notes string,
	Properties map[string]string,
) JSDataTemplateCreateParametersStruct

JSDataTemplateCreateParametersFactory is just a simple function to instantiate the JSDataTemplateCreateParametersStruct

type JSDataTemplateStruct 

type JSDataTemplateStruct struct {
	// The active branch of the data layout.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	ActiveBranch string `json:"activeBranch,omitempty"`
	// A client should consider warning the user before performing an
	// operation which may take a long time, if this is true.
	// default = true
	// create = optional
	// update = optional
	ConfirmTimeConsumingOperations *bool `json:"confirmTimeConsumingOperations,omitempty"`
	// The first JSOperation on this data layout by data time.
	// format = objectReference
	// referenceTo = /delphix-js-operation.json
	FirstOperation string `json:"firstOperation,omitempty"`
	// The last JSOperation on this data layout by data time.
	// format = objectReference
	// referenceTo = /delphix-js-operation.json
	LastOperation string `json:"lastOperation,omitempty"`
	// Timestamp of the last update to the application.
	// format = date
	LastUpdated string `json:"lastUpdated,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Notes for this data layout.
	// update = optional
	// maxLength = 4096
	Notes string `json:"notes,omitempty"`
	// Key/value pairs used to specify attributes for this data layout.
	// update = optional
	Properties map[string]string `json:"properties,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSDataTemplateStruct - A data template is a collection of data sources and configuration representing a data layout that can be provisioned to Self-Service users. extends JSDataLayout

func JSDataTemplateFactory 

func JSDataTemplateFactory(
	ActiveBranch string,
	ConfirmTimeConsumingOperations *bool,
	FirstOperation string,
	LastOperation string,
	LastUpdated string,
	Name string,
	Namespace string,
	Notes string,
	Properties map[string]string,
	Reference string,
) JSDataTemplateStruct

JSDataTemplateFactory is just a simple function to instantiate the JSDataTemplateStruct

type JSOperationEndpointBranchParametersStruct 

type JSOperationEndpointBranchParametersStruct struct {
	// The branch to search.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	// create = required
	Branch string `json:"branch,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

JSOperationEndpointBranchParametersStruct - The branch to fetch the first and last event from. extends JSOperationEndpointParameters

func JSOperationEndpointBranchParametersFactory 

func JSOperationEndpointBranchParametersFactory(
	Branch string,
) JSOperationEndpointBranchParametersStruct

JSOperationEndpointBranchParametersFactory is just a simple function to instantiate the JSOperationEndpointBranchParametersStruct

type JSOperationEndpointDataLayoutParametersStruct 

type JSOperationEndpointDataLayoutParametersStruct struct {
	// The data layout to search.
	// format = objectReference
	// referenceTo = /delphix-js-data-layout.json
	// create = required
	DataLayout string `json:"dataLayout,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSOperationEndpointDataLayoutParametersStruct - The data layout to fetch the first and last events from. extends JSOperationEndpointParameters

func JSOperationEndpointDataLayoutParametersFactory 

func JSOperationEndpointDataLayoutParametersFactory(
	DataLayout string,
) JSOperationEndpointDataLayoutParametersStruct

JSOperationEndpointDataLayoutParametersFactory is just a simple function to instantiate the JSOperationEndpointDataLayoutParametersStruct

type JSOperationEndpointParameters 

type JSOperationEndpointParameters interface{}

JSOperationEndpointParameters is an empty interface designed to function as the JSOperationEndpointParameters API namespace

type JSOperationEndpointStruct 

type JSOperationEndpointStruct struct {
	// The first JSOperation.
	// referenceTo = /delphix-js-operation.json
	// format = objectReference
	First string `json:"first,omitempty"`
	// The last JSOperation.
	// format = objectReference
	// referenceTo = /delphix-js-operation.json
	Last string `json:"last,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSOperationEndpointStruct - The first and last JSOperation for a given data layout or branch. extends TypedObject

func JSOperationEndpointFactory 

func JSOperationEndpointFactory(
	First string,
	Last string,
) JSOperationEndpointStruct

JSOperationEndpointFactory is just a simple function to instantiate the JSOperationEndpointStruct

type JSOperationStruct 

type JSOperationStruct struct {
	// The bookmark that was created.
	// format = objectReference
	// referenceTo = /delphix-js-bookmark.json
	Bookmark string `json:"bookmark,omitempty"`
	// The branch that this operation was performed on.
	// referenceTo = /delphix-js-branch.json
	// format = objectReference
	Branch string `json:"branch,omitempty"`
	// The data layout that this operation was performed on.
	// format = objectReference
	// referenceTo = /delphix-js-data-layout.json
	DataLayout string `json:"dataLayout,omitempty"`
	// The data parent of the operation.
	DataParent JSDataParent `json:"dataParent,omitempty"`
	// The time that the data represented by this operation was active.
	// It will be null if the operation is in progress.
	// format = date
	DataTime string `json:"dataTime,omitempty"`
	// Plain text description of the operation.
	Description string `json:"description,omitempty"`
	// The time the operation finished. It will be null if the operation
	// is in progress.
	// format = date
	EndTime string `json:"endTime,omitempty"`
	// Was this operation perfomed with the force option, which means no
	// pre-operation snapshot was taken.
	ForceOption *bool `json:"forceOption,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The operation performed.
	// enum = [REFRESH RESET CREATE_BRANCH DELETE_BRANCH CREATE_BOOKMARK DELETE_BOOKMARK ENABLE DISABLE ACTIVATE DEACTIVATE RECOVER RESTORE UNDO LOCK UNLOCK HISTORY]
	Operation string `json:"operation,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The root action that spawned this operation.
	// format = objectReference
	// referenceTo = /delphix-action.json
	RootAction string `json:"rootAction,omitempty"`
	// The time the operation started.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The user who performed the operation.
	// format = objectReference
	// referenceTo = /delphix-user.json
	User string `json:"user,omitempty"`
}

JSOperationStruct - An operation that occurred on a Self-Service data layout. extends NamedUserObject

func JSOperationFactory 

func JSOperationFactory(
	Bookmark string,
	Branch string,
	DataLayout string,
	DataParent JSDataParent,
	DataTime string,
	Description string,
	EndTime string,
	ForceOption *bool,
	Name string,
	Namespace string,
	Operation string,
	Reference string,
	RootAction string,
	StartTime string,
	User string,
) JSOperationStruct

JSOperationFactory is just a simple function to instantiate the JSOperationStruct

type JSSourceDataTimestampParametersStruct 

type JSSourceDataTimestampParametersStruct struct {
	// A reference to the Self-Service branch.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	// required = true
	Branch string `json:"branch,omitempty"`
	// The time that will be used to find provisionable timestamps for
	// the sources in the branch's data layout.
	// format = date
	// required = true
	Time string `json:"time,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSSourceDataTimestampParametersStruct - Input parameters for the API that given a point in time, returns the timestamps of the latest provisionable points, before the specified time and from the given branch, for each data source in the branch's data layout. extends TypedObject

func JSSourceDataTimestampParametersFactory 

func JSSourceDataTimestampParametersFactory(
	Branch string,
	Time string,
) JSSourceDataTimestampParametersStruct

JSSourceDataTimestampParametersFactory is just a simple function to instantiate the JSSourceDataTimestampParametersStruct

type JSSourceDataTimestampStruct 

type JSSourceDataTimestampStruct struct {
	// A reference to the Self-Service branch.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	Branch string `json:"branch,omitempty"`
	// The name of the Self-Service data source.
	Name string `json:"name,omitempty"`
	// The priority of the Self-Service data source.
	Priority *int `json:"priority,omitempty"`
	// A reference to the Self-Service data source.
	// referenceTo = /delphix-js-data-source.json
	// format = objectReference
	Source string `json:"source,omitempty"`
	// The point in the source's dataset time which is provisionable.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSSourceDataTimestampStruct - The association between a Self-Service data source and a point in time that's provisionable. extends TypedObject

func JSSourceDataTimestampFactory 

func JSSourceDataTimestampFactory(
	Branch string,
	Name string,
	Priority *int,
	Source string,
	Timestamp string,
) JSSourceDataTimestampStruct

JSSourceDataTimestampFactory is just a simple function to instantiate the JSSourceDataTimestampStruct

type JSTemplateUsageDataStruct 

type JSTemplateUsageDataStruct struct {
	// The amount of space consumed by the bookmarks on this data
	// template. This is the space that will be freed up if all bookmarks
	// on the template were deleted. This presumes that all of child data
	// containers are purged first.
	// units = B
	// base = 1024
	Bookmarks float64 `json:"bookmarks,omitempty"`
	// The amount of space consumed by data containers that were
	// provisioned from this data template. This is the space that will
	// be freed up if all of those data containers are deleted or purged.
	// This assumes that the data containers are deleted along with
	// underlying data sources.
	// units = B
	// base = 1024
	Containers float64 `json:"containers,omitempty"`
	// The data template that this usage information is for.
	// referenceTo = /delphix-js-data-template.json
	// format = objectReference
	Template string `json:"template,omitempty"`
	// The space that will be freed up if this template (and all of its
	// child data containers are deleted).
	// base = 1024
	// units = B
	Total float64 `json:"total,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The amount of space that would be consumed by the data in this
	// template (and child containers) without Delphix.
	// base = 1024
	// units = B
	Unvirtualized float64 `json:"unvirtualized,omitempty"`
}

JSTemplateUsageDataStruct - The space usage information for a data template. extends TypedObject

func JSTemplateUsageDataFactory 

func JSTemplateUsageDataFactory(
	Bookmarks float64,
	Containers float64,
	Template string,
	Total float64,
	Unvirtualized float64,
) JSTemplateUsageDataStruct

JSTemplateUsageDataFactory is just a simple function to instantiate the JSTemplateUsageDataStruct

type JSTimelinePointBookmarkInputStruct 

type JSTimelinePointBookmarkInputStruct struct {
	// The Self-Service bookmark.
	// referenceTo = /delphix-js-bookmark.json
	// required = true
	// format = objectReference
	Bookmark string `json:"bookmark,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

JSTimelinePointBookmarkInputStruct - Specifies the Self-Service timeline point using a reference to the Self-Service bookmark. extends JSTimelinePointParameters

func JSTimelinePointBookmarkInputFactory 

func JSTimelinePointBookmarkInputFactory(
	Bookmark string,
) JSTimelinePointBookmarkInputStruct

JSTimelinePointBookmarkInputFactory is just a simple function to instantiate the JSTimelinePointBookmarkInputStruct

type JSTimelinePointLatestTimeInputStruct 

type JSTimelinePointLatestTimeInputStruct struct {
	// The reference to the data layout used for this operation.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-js-data-layout.json
	SourceDataLayout string `json:"sourceDataLayout,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSTimelinePointLatestTimeInputStruct - Specifies the use of the latest available data from the given data layout. extends JSTimelinePointTimeParameters

func JSTimelinePointLatestTimeInputFactory 

func JSTimelinePointLatestTimeInputFactory(
	SourceDataLayout string,
) JSTimelinePointLatestTimeInputStruct

JSTimelinePointLatestTimeInputFactory is just a simple function to instantiate the JSTimelinePointLatestTimeInputStruct

type JSTimelinePointParameters 

type JSTimelinePointParameters interface{}

JSTimelinePointParameters is an empty interface designed to function as the JSTimelinePointParameters API namespace

type JSTimelinePointTimeInputStruct 

type JSTimelinePointTimeInputStruct struct {
	// The reference to the branch used for this operation.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	// required = true
	Branch string `json:"branch,omitempty"`
	// A point in time on the given branch.
	// format = date
	// required = true
	Time string `json:"time,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSTimelinePointTimeInputStruct - Specifies a point in time on the Self-Service timeline for a specific branch. Latest provisionable points before the specified time will be used. extends JSTimelinePointTimeParameters

func JSTimelinePointTimeInputFactory 

func JSTimelinePointTimeInputFactory(
	Branch string,
	Time string,
) JSTimelinePointTimeInputStruct

JSTimelinePointTimeInputFactory is just a simple function to instantiate the JSTimelinePointTimeInputStruct

type JSTimelinePointTimeParameters 

type JSTimelinePointTimeParameters interface{}

JSTimelinePointTimeParameters is an empty interface designed to function as the JSTimelinePointTimeParameters API namespace

type JSTimestampDataParentStruct 

type JSTimestampDataParentStruct struct {
	// The branch this operation's data came from. This will be null if
	// the branch has been deleted.
	// format = objectReference
	// referenceTo = /delphix-js-branch.json
	Branch string `json:"branch,omitempty"`
	// This will always contain the name of the branch, even if it has
	// been deleted.
	// maxLength = 256
	BranchName string `json:"branchName,omitempty"`
	// The data time on the branch that this operation's data came from.
	// format = date
	Time string `json:"time,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JSTimestampDataParentStruct - The timestamp data parent of a REFRESH, RESTORE, UNDO or CREATE_BRANCH operation. extends JSDataParent

func JSTimestampDataParentFactory 

func JSTimestampDataParentFactory(
	Branch string,
	BranchName string,
	Time string,
) JSTimestampDataParentStruct

JSTimestampDataParentFactory is just a simple function to instantiate the JSTimestampDataParentStruct

type JSUsageData 

type JSUsageData interface{}

JSUsageData is an empty interface designed to function as the JSUsageData API namespace

type JSUserUsageDataStruct 

type JSUserUsageDataStruct struct {
	// The number of containers owned by this user.
	NumContainers *int `json:"numContainers,omitempty"`
	// The amount of space referenced by the data containers owned by
	// this user.
	// base = 1024
	// units = B
	Total float64 `json:"total,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The user.
	// format = objectReference
	// referenceTo = /delphix-user.json
	User string `json:"user,omitempty"`
}

JSUserUsageDataStruct - The space usage information for a Self-Service user. extends TypedObject

func JSUserUsageDataFactory 

func JSUserUsageDataFactory(
	NumContainers *int,
	Total float64,
	User string,
) JSUserUsageDataStruct

JSUserUsageDataFactory is just a simple function to instantiate the JSUserUsageDataStruct

type JSWeeklyOperationCountStruct 

type JSWeeklyOperationCountStruct struct {
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The date at the beginning of the time period this datapoint
	// corresponds to. The time period itself varies between datapoint
	// types.
	// format = date
	StartDate string `json:"startDate,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The object the usage data is centered around.
	// format = objectReference
	// referenceTo = /delphix-named-user-object.json
	UsageObject string `json:"usageObject,omitempty"`
	// The number of operations run against a data container in the
	// specified week.
	WeeklyCount *int `json:"weeklyCount,omitempty"`
	// The total time spent in seconds running all operations during the
	// specified week.
	// units = sec
	WeeklyDuration *int `json:"weeklyDuration,omitempty"`
}

JSWeeklyOperationCountStruct - Information about the number of operations on a data container each week for up to 30 weeks. extends JSUsageData

func JSWeeklyOperationCountFactory 

func JSWeeklyOperationCountFactory(
	Namespace string,
	Reference string,
	StartDate string,
	UsageObject string,
	WeeklyCount *int,
	WeeklyDuration *int,
) JSWeeklyOperationCountStruct

JSWeeklyOperationCountFactory is just a simple function to instantiate the JSWeeklyOperationCountStruct

type JobEventStruct 

type JobEventStruct struct {
	// Results of diagnostic checks run, if any, if the job failed.
	Diagnoses []*DiagnosisResultStruct `json:"diagnoses,omitempty"`
	// Type of event.
	// enum = [INFO WARNING ERROR]
	EventType string `json:"eventType,omitempty"`
	// Localized message action.
	MessageAction string `json:"messageAction,omitempty"`
	// Message ID associated with the event.
	MessageCode string `json:"messageCode,omitempty"`
	// Command output associated with the event, if applicable.
	MessageCommandOutput string `json:"messageCommandOutput,omitempty"`
	// Localized message details.
	MessageDetails string `json:"messageDetails,omitempty"`
	// Completion percentage.
	// units = %
	PercentComplete float64 `json:"percentComplete,omitempty"`
	// New state of the job.
	// enum = [INITIAL RUNNING SUSPENDED CANCELED COMPLETED FAILED RETRYABLE]
	State string `json:"state,omitempty"`
	// Time the event occurred.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

JobEventStruct - Represents a job event object. This can either be a state change or a progress update. extends TypedObject

func JobEventFactory 

func JobEventFactory(
	Diagnoses []*DiagnosisResultStruct,
	EventType string,
	MessageAction string,
	MessageCode string,
	MessageCommandOutput string,
	MessageDetails string,
	PercentComplete float64,
	State string,
	Timestamp string,
) JobEventStruct

JobEventFactory is just a simple function to instantiate the JobEventStruct

type JobStruct 

type JobStruct struct {
	// Action type of the Job.
	ActionType string `json:"actionType,omitempty"`
	// A description of why the job was canceled.
	CancelReason string `json:"cancelReason,omitempty"`
	// Whether this job can be canceled.
	Cancelable *bool `json:"cancelable,omitempty"`
	// Email addresses to be notified on job notification alerts.
	// update = required
	EmailAddresses []string `json:"emailAddresses,omitempty"`
	// A list of time-sorted past JobEvent objects associated with this
	// job.
	Events []*JobEventStruct `json:"events,omitempty"`
	// State of the job.
	// enum = [RUNNING SUSPENDED CANCELED COMPLETED FAILED]
	JobState string `json:"jobState,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// This job's parent action.
	// format = objectReference
	// referenceTo = /delphix-action.json
	ParentAction string `json:"parentAction,omitempty"`
	// State of this job's parent action. This value is populated only if
	// the job is fetched via the plain get API call.
	// enum = [EXECUTING WAITING COMPLETED FAILED CANCELED]
	ParentActionState string `json:"parentActionState,omitempty"`
	// Completion percentage. This value is a copy of the last event's
	// percentComplete. It will be 0 if there are no job events or if the
	// events field is not populated while fetching the job.
	// units = %
	PercentComplete float64 `json:"percentComplete,omitempty"`
	// Whether this job is waiting for resources to be available for its
	// execution.
	Queued *bool `json:"queued,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Time the job was created. Note that this is not the time when the
	// job started executing.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// Whether this job can be suspended.
	Suspendable *bool `json:"suspendable,omitempty"`
	// Object reference of the target.
	// referenceTo = /delphix-user-object.json
	// format = objectReference
	Target string `json:"target,omitempty"`
	// A cached copy of the target object name.
	TargetName string `json:"targetName,omitempty"`
	// Object type of the target.
	// format = type
	TargetObjectType string `json:"targetObjectType,omitempty"`
	// Title of the job.
	Title string `json:"title,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Time the job was last updated.
	// format = date
	UpdateTime string `json:"updateTime,omitempty"`
	// User that initiated the action.
	// format = objectReference
	// referenceTo = /delphix-user.json
	User string `json:"user,omitempty"`
}

JobStruct - Represents a job object. extends NamedUserObject cliVisibility = [SYSTEM DOMAIN]

func JobFactory 

func JobFactory(
	ActionType string,
	CancelReason string,
	Cancelable *bool,
	EmailAddresses []string,
	Events []*JobEventStruct,
	JobState string,
	Name string,
	Namespace string,
	ParentAction string,
	ParentActionState string,
	PercentComplete float64,
	Queued *bool,
	Reference string,
	StartTime string,
	Suspendable *bool,
	Target string,
	TargetName string,
	TargetObjectType string,
	Title string,
	UpdateTime string,
	User string,
) JobStruct

JobFactory is just a simple function to instantiate the JobStruct

type JsonStruct 

type JsonStruct struct {
}

JsonStruct - A dummy schema that is used to represent JSON.

type KerberosConfigStruct 

type KerberosConfigStruct struct {
	// Indicates whether kerberos has been configured or not.
	Enabled *bool `json:"enabled,omitempty"`
	// One of more KDC servers.
	// create = required
	// update = optional
	// minItems = 1
	Kdcs []*KerberosKDCStruct `json:"kdcs,omitempty"`
	// Kerberos keytab file data in base64 encoding.
	// format = password
	// create = required
	// update = optional
	Keytab string `json:"keytab,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Kerberos principal name.
	// create = required
	// update = optional
	Principal string `json:"principal,omitempty"`
	// Kerberos Realm name.
	// update = optional
	// create = required
	Realm string `json:"realm,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

KerberosConfigStruct - Kerberos Client Configuration. extends UserObject cliVisibility = [DOMAIN SYSTEM]

func KerberosConfigFactory 

func KerberosConfigFactory(
	Enabled *bool,
	Kdcs []*KerberosKDCStruct,
	Keytab string,
	Name string,
	Namespace string,
	Principal string,
	Realm string,
	Reference string,
) KerberosConfigStruct

KerberosConfigFactory is just a simple function to instantiate the KerberosConfigStruct

type KerberosCredentialStruct 

type KerberosCredentialStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

KerberosCredentialStruct - Kerberos based security credential. extends Credential

func KerberosCredentialFactory 

func KerberosCredentialFactory() KerberosCredentialStruct

KerberosCredentialFactory is just a simple function to instantiate the KerberosCredentialStruct

type KerberosKDCStruct 

type KerberosKDCStruct struct {
	// KDC Server hostname.
	// format = host
	// create = required
	// update = optional
	Hostname string `json:"hostname,omitempty"`
	// KDC Server port number.
	// create = required
	// update = optional
	// minimum = 0
	// maximum = 65535
	// default = 88
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

KerberosKDCStruct - Kerberos Client Configuration. extends TypedObject

func KerberosKDCFactory 

func KerberosKDCFactory(
	Hostname string,
	Port *int,
) KerberosKDCStruct

KerberosKDCFactory is just a simple function to instantiate the KerberosKDCStruct

type KeyPair 

type KeyPair interface{}

KeyPair is an empty interface designed to function as the KeyPair API namespace

type KeyPairCredentialStruct 

type KeyPairCredentialStruct struct {
	// The private key in the key pair.
	// format = password
	// required = true
	PrivateKey string `json:"privateKey,omitempty"`
	// The public key in the key pair.
	// format = password
	// required = true
	PublicKey string `json:"publicKey,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

KeyPairCredentialStruct - The public key based security credential consisting of a user specified key pair. extends PublicKeyCredential

func KeyPairCredentialFactory 

func KeyPairCredentialFactory(
	PrivateKey string,
	PublicKey string,
) KeyPairCredentialStruct

KeyPairCredentialFactory is just a simple function to instantiate the KeyPairCredentialStruct

type LdapInfoStruct 

type LdapInfoStruct struct {
	// Whether LDAP authentication is configured and enabled or not for
	// this Delphix Engine.
	Enabled *bool `json:"enabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

LdapInfoStruct - Global LDAP information. extends TypedObject cliVisibility = [SYSTEM DOMAIN]

func LdapInfoFactory 

func LdapInfoFactory(
	Enabled *bool,
) LdapInfoStruct

LdapInfoFactory is just a simple function to instantiate the LdapInfoStruct

type LdapServerStruct 

type LdapServerStruct struct {
	// LDAP authentication method.
	// enum = [SIMPLE DIGEST_MD5]
	// required = true
	AuthMethod string `json:"authMethod,omitempty"`
	// LDAP server host name.
	// format = host
	// required = true
	Host string `json:"host,omitempty"`
	// Object name.
	// update = readonly
	// create = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// LDAP server port.
	// maximum = 65535
	// required = true
	// minimum = 1
	Port *int `json:"port,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Authenticate using SSL.
	// required = true
	UseSSL *bool `json:"useSSL,omitempty"`
}

LdapServerStruct - LDAP Server Configuration. extends ReadonlyNamedUserObject cliVisibility = [SYSTEM]

func LdapServerFactory 

func LdapServerFactory(
	AuthMethod string,
	Host string,
	Name string,
	Namespace string,
	Port *int,
	Reference string,
	UseSSL *bool,
) LdapServerStruct

LdapServerFactory is just a simple function to instantiate the LdapServerStruct

type LinkData 

type LinkData interface{}

LinkData is an empty interface designed to function as the LinkData API namespace

type LinkParametersStruct 

type LinkParametersStruct struct {
	// Optional user-provided description for the container.
	// create = optional
	// maxLength = 1024
	Description string `json:"description,omitempty"`
	// A reference to the group containing this container.
	// format = objectReference
	// referenceTo = /delphix-group.json
	// required = true
	Group string `json:"group,omitempty"`
	// Database specific data required for linking.
	// create = required
	// required = true
	LinkData LinkData `json:"linkData,omitempty"`
	// DSource name.
	// format = objectName
	// required = true
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

LinkParametersStruct - Represents the parameters of a link request. extends TypedObject

func LinkParametersFactory 

func LinkParametersFactory(
	Description string,
	Group string,
	LinkData LinkData,
	Name string,
) LinkParametersStruct

LinkParametersFactory is just a simple function to instantiate the LinkParametersStruct

type LinkedSourceOperationsStruct 

type LinkedSourceOperationsStruct struct {
	// Operations to perform after syncing a linked source.
	// create = optional
	// update = optional
	PostSync []SourceOperation `json:"postSync,omitempty"`
	// Operations to perform before syncing from a linked source. These
	// operations can quiesce any data prior to syncing.
	// create = optional
	// update = optional
	PreSync []SourceOperation `json:"preSync,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

LinkedSourceOperationsStruct - Describes operations which are performed on linked sources at various times. extends TypedObject

func LinkedSourceOperationsFactory 

func LinkedSourceOperationsFactory(
	PostSync []SourceOperation,
	PreSync []SourceOperation,
) LinkedSourceOperationsStruct

LinkedSourceOperationsFactory is just a simple function to instantiate the LinkedSourceOperationsStruct

type ListResultStruct 

type ListResultStruct struct {
	// Reference to the action associated with the operation, if any.
	// referenceTo = /delphix-action.json
	// format = objectReference
	Action string `json:"action,omitempty"`
	// Reference to the job started by the operation, if any.
	// format = objectReference
	// referenceTo = /delphix-job.json
	Job string `json:"job,omitempty"`
	// True if the total number of matching items is too large to be
	// calculated.
	Overflow *bool `json:"overflow,omitempty"`
	// Result of the operation. This will be specific to the API being
	// invoked.
	Result interface{} `json:"result,omitempty"`
	// Indicates whether an error occurred during the call.
	// enum = [OK ERROR]
	Status string `json:"status,omitempty"`
	// The number of items in the entire result set, regardless of the
	// requested page size. For some operations, this value is null.
	Total *int `json:"total,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ListResultStruct - Result of a successful API call returning a list. extends OKResult

func ListResultFactory 

func ListResultFactory(
	Action string,
	Job string,
	Overflow *bool,
	Result interface{},
	Status string,
	Total *int,
) ListResultStruct

ListResultFactory is just a simple function to instantiate the ListResultStruct

type LocaleSettingsStruct 

type LocaleSettingsStruct struct {
	// System default locale as an IETF BCP 47 language tag, defaults to
	// 'en-US'.
	// create = required
	// update = optional
	// format = locale
	// default = en-US
	Locale string `json:"locale,omitempty"`
	// Object name.
	// create = optional
	// update = optional
	// maxLength = 256
	// format = objectName
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

LocaleSettingsStruct - Global locale settings. extends UserObject cliVisibility = [SYSTEM]

func LocaleSettingsFactory 

func LocaleSettingsFactory(
	Locale string,
	Name string,
	Namespace string,
	Reference string,
) LocaleSettingsStruct

LocaleSettingsFactory is just a simple function to instantiate the LocaleSettingsStruct

type LogFetchSSH 

type LogFetchSSH interface{}

LogFetchSSH is an empty interface designed to function as the LogFetchSSH API namespace

type LoginRequestStruct 

type LoginRequestStruct struct {
	// Whether to keep session alive for all requests or only via
	// 'KeepSessionAlive' request headers. Defaults to ALL_REQUESTS if
	// omitted.
	// enum = [ALL_REQUESTS KEEP_ALIVE_HEADER_ONLY]
	// default = ALL_REQUESTS
	KeepAliveMode string `json:"keepAliveMode,omitempty"`
	// The password of the user to authenticate.
	// format = password
	// required = true
	Password string `json:"password,omitempty"`
	// The authentication domain.
	// enum = [DOMAIN SYSTEM]
	Target string `json:"target,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the user to authenticate.
	// required = true
	Username string `json:"username,omitempty"`
}

LoginRequestStruct - Represents a Delphix user authentication request. extends TypedObject

func LoginRequestFactory 

func LoginRequestFactory(
	KeepAliveMode string,
	Password string,
	Target string,
	Username string,
) LoginRequestStruct

LoginRequestFactory is just a simple function to instantiate the LoginRequestStruct

type MSSqlAttachDataStruct 

type MSSqlAttachDataStruct struct {
	// The password for accessing the shared backup location.
	// create = optional
	BackupLocationCredentials *PasswordCredentialStruct `json:"backupLocationCredentials,omitempty"`
	// The user for accessing the shared backup location.
	// create = optional
	// maxLength = 256
	BackupLocationUser string `json:"backupLocationUser,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-mssql-db-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The SQL Server login password for the source DB user.
	// required = true
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The SQL Server login username for the source DB user.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// The encryption key to use when restoring encrypted backups.
	// create = optional
	EncryptionKey string `json:"encryptionKey,omitempty"`
	// External file path.
	// create = optional
	// maxLength = 1024
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Configuration that determines what ingestion strategy the source
	// will use.
	// create = required
	IngestionStrategy IngestionStrategy `json:"ingestionStrategy,omitempty"`
	// Configuration for source that allows ingesting NetBackup backups
	// for SQL Server.
	// create = optional
	MssqlNetbackupConfig string `json:"mssqlNetbackupConfig,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// OS user on the PPT host to use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	PptHostUser string `json:"pptHostUser,omitempty"`
	// The SQL Server instance on the staging environment to use for
	// pre-provisioning.
	// format = objectReference
	// referenceTo = /delphix-mssql-instance.json
	// required = true
	PptRepository string `json:"pptRepository,omitempty"`
	// Shared source database backup locations.
	// create = required
	// maxItems = 1000
	SharedBackupLocations []string `json:"sharedBackupLocations,omitempty"`
	// OS user on the source to use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	SourceHostUser string `json:"sourceHostUser,omitempty"`
	// The path to a user-provided PowerShell script or executable to run
	// after restoring from a backup during pre-provisioning.
	// create = optional
	// maxLength = 1024
	StagingPostScript string `json:"stagingPostScript,omitempty"`
	// The path to a user-provided PowerShell script or executable to run
	// prior to restoring from a backup during pre-provisioning.
	// create = optional
	// maxLength = 1024
	StagingPreScript string `json:"stagingPreScript,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlAttachDataStruct - Represents the MSSQL specific parameters of an attach request. extends AttachData

func MSSqlAttachDataFactory 

func MSSqlAttachDataFactory(
	BackupLocationCredentials *PasswordCredentialStruct,
	BackupLocationUser string,
	Config string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	EncryptionKey string,
	ExternalFilePath string,
	IngestionStrategy IngestionStrategy,
	MssqlNetbackupConfig string,
	Operations *LinkedSourceOperationsStruct,
	PptHostUser string,
	PptRepository string,
	SharedBackupLocations []string,
	SourceHostUser string,
	StagingPostScript string,
	StagingPreScript string,
) MSSqlAttachDataStruct

MSSqlAttachDataFactory is just a simple function to instantiate the MSSqlAttachDataStruct

type MSSqlAvailabilityGroupDBConfigStruct 

type MSSqlAvailabilityGroupDBConfigStruct struct {
	// The password of the database user.
	// update = optional
	Credentials Credential `json:"credentials,omitempty"`
	// The name of the database.
	// maxLength = 128
	// create = required
	// update = optional
	DatabaseName string `json:"databaseName,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Specifies the current recovery model of the source database.
	// default = SIMPLE
	// create = optional
	// update = readonly
	// enum = [FULL SIMPLE BULK_LOGGED]
	RecoveryModel string `json:"recoveryModel,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// format = objectReference
	// referenceTo = /delphix-mssql-repository.json
	// create = required
	// update = optional
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the database user.
	// update = optional
	// maxLength = 256
	User string `json:"user,omitempty"`
}

MSSqlAvailabilityGroupDBConfigStruct - Database for a SQL Server Availability Group. extends MSSqlDBConfig

func MSSqlAvailabilityGroupDBConfigFactory 

func MSSqlAvailabilityGroupDBConfigFactory(
	Credentials Credential,
	DatabaseName string,
	Discovered *bool,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	RecoveryModel string,
	Reference string,
	Repository string,
	User string,
) MSSqlAvailabilityGroupDBConfigStruct

MSSqlAvailabilityGroupDBConfigFactory is just a simple function to instantiate the MSSqlAvailabilityGroupDBConfigStruct

type MSSqlAvailabilityGroupListenerStruct 

type MSSqlAvailabilityGroupListenerStruct struct {
	// The address of the listener.
	Address string `json:"address,omitempty"`
	// The name of the listener.
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// The port for the listener.
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlAvailabilityGroupListenerStruct - The representation of a SQL Server Availability Group Listener. extends MSSqlBaseClusterListener

func MSSqlAvailabilityGroupListenerFactory 

func MSSqlAvailabilityGroupListenerFactory(
	Address string,
	Name string,
	Port *int,
) MSSqlAvailabilityGroupListenerStruct

MSSqlAvailabilityGroupListenerFactory is just a simple function to instantiate the MSSqlAvailabilityGroupListenerStruct

type MSSqlAvailabilityGroupStruct 

type MSSqlAvailabilityGroupStruct struct {
	// Reference to the environment containing this repository.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = required
	Environment string `json:"environment,omitempty"`
	// Represents Full-text search and semantic search feature.
	// create = required
	// update = optional
	FulltextInstalled *bool `json:"fulltextInstalled,omitempty"`
	// The list of MSSQL Cluster instances belonging to this repository.
	Instances []MSSqlBaseClusterInstance `json:"instances,omitempty"`
	// Internal version of the SQL Server instance.
	// minimum = 1
	// create = required
	// update = optional
	InternalVersion *int `json:"internalVersion,omitempty"`
	// Flag indicating whether the repository should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// The list of listeners belonging to this repository.
	Listeners []MSSqlBaseClusterListener `json:"listeners,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Flag indicating whether the repository should be used for
	// provisioning.
	// default = true
	// create = optional
	// update = optional
	ProvisioningEnabled *bool `json:"provisioningEnabled,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Flag indicating whether this repository can be used by the Delphix
	// Engine for internal processing.
	// create = optional
	// update = optional
	// default = false
	Staging *bool `json:"staging,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// Version of the repository.
	// create = optional
	// update = optional
	Version string `json:"version,omitempty"`
}

MSSqlAvailabilityGroupStruct - The representation of a SQL Server Availability Group. extends MSSqlBaseClusterRepository

func MSSqlAvailabilityGroupFactory 

func MSSqlAvailabilityGroupFactory(
	Environment string,
	FulltextInstalled *bool,
	Instances []MSSqlBaseClusterInstance,
	InternalVersion *int,
	LinkingEnabled *bool,
	Listeners []MSSqlBaseClusterListener,
	Name string,
	Namespace string,
	ProvisioningEnabled *bool,
	Reference string,
	Staging *bool,
	Version string,
) MSSqlAvailabilityGroupStruct

MSSqlAvailabilityGroupFactory is just a simple function to instantiate the MSSqlAvailabilityGroupStruct

type MSSqlBaseClusterInstance 

type MSSqlBaseClusterInstance interface{}

MSSqlBaseClusterInstance is an empty interface designed to function as the MSSqlBaseClusterInstance API namespace

type MSSqlBaseClusterListener 

type MSSqlBaseClusterListener interface{}

MSSqlBaseClusterListener is an empty interface designed to function as the MSSqlBaseClusterListener API namespace

type MSSqlBaseClusterRepository 

type MSSqlBaseClusterRepository interface{}

MSSqlBaseClusterRepository is an empty interface designed to function as the MSSqlBaseClusterRepository API namespace

type MSSqlClusterInstanceStruct 

type MSSqlClusterInstanceStruct struct {
	// The owner of the SQL Server Instance.
	InstanceOwner string `json:"instanceOwner,omitempty"`
	// The name of the SQL Server Instance.
	// maxLength = 16
	Name string `json:"name,omitempty"`
	// A reference to the Windows Cluster Node for this instance.
	// referenceTo = /delphix-windows-cluster-node.json
	// format = objectReference
	Node string `json:"node,omitempty"`
	// The port to connect to the SQL Server Instance.
	Port *int `json:"port,omitempty"`
	// The Servername of the SQL Server Instance.
	ServerName string `json:"serverName,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The version of the SQL Server Instance.
	Version string `json:"version,omitempty"`
}

MSSqlClusterInstanceStruct - The representation of a SQL Server Instance on a clustered node for Availability Groups. extends MSSqlBaseClusterInstance

func MSSqlClusterInstanceFactory 

func MSSqlClusterInstanceFactory(
	InstanceOwner string,
	Name string,
	Node string,
	Port *int,
	ServerName string,
	Version string,
) MSSqlClusterInstanceStruct

MSSqlClusterInstanceFactory is just a simple function to instantiate the MSSqlClusterInstanceStruct

type MSSqlCompatibilityCriteriaStruct 

type MSSqlCompatibilityCriteriaStruct struct {
	// Selected repositories are installed on a host with this
	// architecture (32-bit or 64-bit).
	Architecture *int `json:"architecture,omitempty"`
	// Selected repositories are installed on this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// Selected repositories are installed on a host with this OS.
	// enum = [Linux AIX HPUX SunOS Windows]
	Os string `json:"os,omitempty"`
	// Selected repositories are installed on a host with this type of
	// processor.
	// enum = [x86 ia64 powerpc sparc]
	Processor string `json:"processor,omitempty"`
	// If true, selected repositories have staging enabled.
	StagingEnabled *bool `json:"stagingEnabled,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// Selected repositories are this database version. In case of
	// upgrade, selected repositories are strictly greater than this
	// database version.
	Version string `json:"version,omitempty"`
}

MSSqlCompatibilityCriteriaStruct - The compatibility criteria to use for selecting compatible MSSql repositories. extends CompatibilityCriteria

func MSSqlCompatibilityCriteriaFactory 

func MSSqlCompatibilityCriteriaFactory(
	Architecture *int,
	Environment string,
	Os string,
	Processor string,
	StagingEnabled *bool,
	Version string,
) MSSqlCompatibilityCriteriaStruct

MSSqlCompatibilityCriteriaFactory is just a simple function to instantiate the MSSqlCompatibilityCriteriaStruct

type MSSqlCreateTransformationParametersStruct 

type MSSqlCreateTransformationParametersStruct struct {
	// The container that will contain the transformed data associated
	// with the newly created transformation; the "transformation
	// container".
	// create = required
	Container *MSSqlDatabaseContainerStruct `json:"container,omitempty"`
	// Reference to the user used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Operations to perform when this transformation is applied.
	// create = required
	Operations []SourceOperation `json:"operations,omitempty"`
	// Reference to the repository used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	// create = required
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlCreateTransformationParametersStruct - Represents the parameters of a createTransformation request for a MSSql container. extends CreateTransformationParameters

func MSSqlCreateTransformationParametersFactory 

func MSSqlCreateTransformationParametersFactory(
	Container *MSSqlDatabaseContainerStruct,
	EnvironmentUser string,
	Operations []SourceOperation,
	Repository string,
) MSSqlCreateTransformationParametersStruct

MSSqlCreateTransformationParametersFactory is just a simple function to instantiate the MSSqlCreateTransformationParametersStruct

type MSSqlDBConfig 

type MSSqlDBConfig interface{}

MSSqlDBConfig is an empty interface designed to function as the MSSqlDBConfig API namespace

type MSSqlDBContainerRuntimeStruct 

type MSSqlDBContainerRuntimeStruct struct {
	// The UUID of the source database backupset that was last restored
	// in this container.
	LastRestoredBackupSetUUID string `json:"lastRestoredBackupSetUUID,omitempty"`
	// True if the LogSync is enabled and running for this container.
	LogSyncActive *bool `json:"logSyncActive,omitempty"`
	// The pre-provisioning runtime for the container.
	PreProvisioningStatus *PreProvisioningRuntimeStruct `json:"preProvisioningStatus,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlDBContainerRuntimeStruct - Runtime properties of a MSSQL database container. extends DBContainerRuntime

func MSSqlDBContainerRuntimeFactory 

func MSSqlDBContainerRuntimeFactory(
	LastRestoredBackupSetUUID string,
	LogSyncActive *bool,
	PreProvisioningStatus *PreProvisioningRuntimeStruct,
) MSSqlDBContainerRuntimeStruct

MSSqlDBContainerRuntimeFactory is just a simple function to instantiate the MSSqlDBContainerRuntimeStruct

type MSSqlDatabaseContainerStruct 

type MSSqlDatabaseContainerStruct struct {
	// The date this container was created.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// A reference to the currently active TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	CurrentTimeflow string `json:"currentTimeflow,omitempty"`
	// Optional user-provided description for the container.
	// maxLength = 1024
	// create = optional
	// update = optional
	Description string `json:"description,omitempty"`
	// A reference to the group containing this container.
	// format = objectReference
	// referenceTo = /delphix-group.json
	// create = required
	Group string `json:"group,omitempty"`
	// True if this container is a masked container.
	Masked *bool `json:"masked,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Native operating system of the original database source system.
	Os string `json:"os,omitempty"`
	// Whether to enable high performance mode.
	// create = readonly
	// update = readonly
	// enum = [TEMPORARILY_ENABLED ENABLED DISABLED]
	// default = DISABLED
	PerformanceMode string `json:"performanceMode,omitempty"`
	// A reference to the previous TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	PreviousTimeflow string `json:"previousTimeflow,omitempty"`
	// Native processor type of the original database source system.
	Processor string `json:"processor,omitempty"`
	// A reference to the container this container was provisioned from.
	// referenceTo = /delphix-container.json
	// format = objectReference
	ProvisionContainer string `json:"provisionContainer,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this container.
	Runtime *MSSqlDBContainerRuntimeStruct `json:"runtime,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	// update = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// True if this container is a transformation container.
	Transformation *bool `json:"transformation,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlDatabaseContainerStruct - A MSSQL Database Container. extends DatabaseContainer

func MSSqlDatabaseContainerFactory 

func MSSqlDatabaseContainerFactory(
	CreationTime string,
	CurrentTimeflow string,
	Description string,
	Group string,
	Masked *bool,
	Name string,
	Namespace string,
	Os string,
	PreviousTimeflow string,
	Processor string,
	ProvisionContainer string,
	Reference string,
	Runtime *MSSqlDBContainerRuntimeStruct,
	SourcingPolicy *SourcingPolicyStruct,
	Transformation *bool,
) MSSqlDatabaseContainerStruct

MSSqlDatabaseContainerFactory is just a simple function to instantiate the MSSqlDatabaseContainerStruct

type MSSqlExistingBackupSyncParameters 

type MSSqlExistingBackupSyncParameters interface{}

MSSqlExistingBackupSyncParameters is an empty interface designed to function as the MSSqlExistingBackupSyncParameters API namespace

type MSSqlExistingMostRecentBackupSyncParametersStruct 

type MSSqlExistingMostRecentBackupSyncParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlExistingMostRecentBackupSyncParametersStruct - The parameters to use as input to sync MSSQL databases using an existing most recent full or differential backup. extends MSSqlExistingBackupSyncParameters

func MSSqlExistingMostRecentBackupSyncParametersFactory 

func MSSqlExistingMostRecentBackupSyncParametersFactory() MSSqlExistingMostRecentBackupSyncParametersStruct

MSSqlExistingMostRecentBackupSyncParametersFactory is just a simple function to instantiate the MSSqlExistingMostRecentBackupSyncParametersStruct

type MSSqlExistingSpecificBackupSyncParametersStruct 

type MSSqlExistingSpecificBackupSyncParametersStruct struct {
	// The UUID of the full or differential backup of the source database
	// to restore from. The backup should be present in the shared backup
	// location for the source database.
	// required = true
	BackupUUID string `json:"backupUUID,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlExistingSpecificBackupSyncParametersStruct - The parameters to use as input to sync MSSQL databases using an existing specific full or differential backup. extends MSSqlExistingBackupSyncParameters

func MSSqlExistingSpecificBackupSyncParametersFactory 

func MSSqlExistingSpecificBackupSyncParametersFactory(
	BackupUUID string,
) MSSqlExistingSpecificBackupSyncParametersStruct

MSSqlExistingSpecificBackupSyncParametersFactory is just a simple function to instantiate the MSSqlExistingSpecificBackupSyncParametersStruct

type MSSqlExportParametersStruct 

type MSSqlExportParametersStruct struct {
	// Database-specific configuration parameters.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// The filesystem configuration of the exported database.
	// required = true
	FilesystemLayout *TimeflowFilesystemLayoutStruct `json:"filesystemLayout,omitempty"`
	// If specified, then take the exported database through recovery
	// procedures, if necessary, to reach a consistent point.
	// default = true
	// create = optional
	RecoverDatabase *bool `json:"recoverDatabase,omitempty"`
	// Recovery model of the database.
	// default = FULL
	// create = optional
	// enum = [SIMPLE BULK_LOGGED FULL]
	RecoveryModel string `json:"recoveryModel,omitempty"`
	// The source config to use when creating the exported DB.
	// required = true
	SourceConfig MSSqlDBConfig `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base export
	// on.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlExportParametersStruct - The parameters to use as input to export MSSQL databases. extends DbExportParameters

func MSSqlExportParametersFactory 

func MSSqlExportParametersFactory(
	ConfigParams map[string]string,
	FileMappingRules string,
	FilesystemLayout *TimeflowFilesystemLayoutStruct,
	RecoverDatabase *bool,
	RecoveryModel string,
	SourceConfig MSSqlDBConfig,
	TimeflowPointParameters TimeflowPointParameters,
) MSSqlExportParametersStruct

MSSqlExportParametersFactory is just a simple function to instantiate the MSSqlExportParametersStruct

type MSSqlFailoverClusterDBConfigStruct 

type MSSqlFailoverClusterDBConfigStruct struct {
	// The password of the database user.
	// update = optional
	Credentials Credential `json:"credentials,omitempty"`
	// The name of the database.
	// maxLength = 128
	// create = required
	// update = optional
	DatabaseName string `json:"databaseName,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// Base drive letter location for mount points.
	// minLength = 1
	// maxLength = 1
	// create = required
	DriveLetter string `json:"driveLetter,omitempty"`
	// The user used to create and manage the configuration.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// create = readonly
	// update = readonly
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Specifies the current recovery model of the source database.
	// enum = [FULL SIMPLE BULK_LOGGED]
	// default = SIMPLE
	// create = optional
	// update = readonly
	RecoveryModel string `json:"recoveryModel,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-mssql-repository.json
	// create = required
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the database user.
	// update = optional
	// maxLength = 256
	User string `json:"user,omitempty"`
}

MSSqlFailoverClusterDBConfigStruct - Database for a SQL Server Failover Cluster. extends MSSqlDBConfig

func MSSqlFailoverClusterDBConfigFactory 

func MSSqlFailoverClusterDBConfigFactory(
	Credentials Credential,
	DatabaseName string,
	Discovered *bool,
	DriveLetter string,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	RecoveryModel string,
	Reference string,
	Repository string,
	User string,
) MSSqlFailoverClusterDBConfigStruct

MSSqlFailoverClusterDBConfigFactory is just a simple function to instantiate the MSSqlFailoverClusterDBConfigStruct

type MSSqlFailoverClusterDriveLetterStruct 

type MSSqlFailoverClusterDriveLetterStruct struct {
	// The drive letter.
	// minLength = 1
	// maxLength = 1
	DriveLetter string `json:"driveLetter,omitempty"`
	// The drive letter label.
	// maxLength = 32
	Label string `json:"label,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlFailoverClusterDriveLetterStruct - This represents a logical volume with a drive letter that resides on a Physical Disk cluster resource that is part of a SQL Server Failover Cluster Instance. extends TypedObject

func MSSqlFailoverClusterDriveLetterFactory 

func MSSqlFailoverClusterDriveLetterFactory(
	DriveLetter string,
	Label string,
) MSSqlFailoverClusterDriveLetterStruct

MSSqlFailoverClusterDriveLetterFactory is just a simple function to instantiate the MSSqlFailoverClusterDriveLetterStruct

type MSSqlFailoverClusterInstanceStruct 

type MSSqlFailoverClusterInstanceStruct struct {
	// The owner of the SQL Server Instance.
	InstanceOwner string `json:"instanceOwner,omitempty"`
	// The name of the SQL Server Instance.
	// maxLength = 16
	Name string `json:"name,omitempty"`
	// A reference to the Windows Cluster Node for this instance.
	// referenceTo = /delphix-windows-cluster-node.json
	// format = objectReference
	Node string `json:"node,omitempty"`
	// The port to connect to the SQL Server Instance.
	Port *int `json:"port,omitempty"`
	// The Servername of the SQL Server Instance.
	ServerName string `json:"serverName,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The version of the SQL Server Instance.
	Version string `json:"version,omitempty"`
}

MSSqlFailoverClusterInstanceStruct - The representation of a SQL Server Instance on a clustered node for Failover Clusters. extends MSSqlBaseClusterInstance

func MSSqlFailoverClusterInstanceFactory 

func MSSqlFailoverClusterInstanceFactory(
	InstanceOwner string,
	Name string,
	Node string,
	Port *int,
	ServerName string,
	Version string,
) MSSqlFailoverClusterInstanceStruct

MSSqlFailoverClusterInstanceFactory is just a simple function to instantiate the MSSqlFailoverClusterInstanceStruct

type MSSqlFailoverClusterListenerStruct 

type MSSqlFailoverClusterListenerStruct struct {
	// The address of the listener.
	Address string `json:"address,omitempty"`
	// The name of the listener.
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// The port for the listener.
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlFailoverClusterListenerStruct - The representation of a SQL Server Failover Cluster Listener. extends MSSqlBaseClusterListener

func MSSqlFailoverClusterListenerFactory 

func MSSqlFailoverClusterListenerFactory(
	Address string,
	Name string,
	Port *int,
) MSSqlFailoverClusterListenerStruct

MSSqlFailoverClusterListenerFactory is just a simple function to instantiate the MSSqlFailoverClusterListenerStruct

type MSSqlFailoverClusterRepositoryStruct 

type MSSqlFailoverClusterRepositoryStruct struct {
	// The list of drive letters belonging to this Failover Cluster
	// repository.
	Drives []*MSSqlFailoverClusterDriveLetterStruct `json:"drives,omitempty"`
	// Reference to the environment containing this repository.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = required
	Environment string `json:"environment,omitempty"`
	// Represents Full-text search and semantic search feature.
	// create = required
	// update = optional
	FulltextInstalled *bool `json:"fulltextInstalled,omitempty"`
	// The list of MSSQL Cluster instances belonging to this repository.
	Instances []MSSqlBaseClusterInstance `json:"instances,omitempty"`
	// Internal version of the SQL Server instance.
	// minimum = 1
	// create = required
	// update = optional
	InternalVersion *int `json:"internalVersion,omitempty"`
	// Flag indicating whether the repository should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// The list of listeners belonging to this repository.
	Listeners []MSSqlBaseClusterListener `json:"listeners,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Flag indicating whether the repository should be used for
	// provisioning.
	// create = optional
	// update = optional
	// default = true
	ProvisioningEnabled *bool `json:"provisioningEnabled,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Flag indicating whether this repository can be used by the Delphix
	// Engine for internal processing.
	// default = false
	// create = optional
	// update = optional
	Staging *bool `json:"staging,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of the repository.
	// create = optional
	// update = optional
	Version string `json:"version,omitempty"`
}

MSSqlFailoverClusterRepositoryStruct - The representation of a SQL Server Failover Cluster repository. extends MSSqlBaseClusterRepository

func MSSqlFailoverClusterRepositoryFactory 

func MSSqlFailoverClusterRepositoryFactory(
	Drives []*MSSqlFailoverClusterDriveLetterStruct,
	Environment string,
	FulltextInstalled *bool,
	Instances []MSSqlBaseClusterInstance,
	InternalVersion *int,
	LinkingEnabled *bool,
	Listeners []MSSqlBaseClusterListener,
	Name string,
	Namespace string,
	ProvisioningEnabled *bool,
	Reference string,
	Staging *bool,
	Version string,
) MSSqlFailoverClusterRepositoryStruct

MSSqlFailoverClusterRepositoryFactory is just a simple function to instantiate the MSSqlFailoverClusterRepositoryStruct

type MSSqlInstanceStruct 

type MSSqlInstanceStruct struct {
	// True if the MSSQL instance was automatically discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// Reference to the environment containing this repository.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = required
	Environment string `json:"environment,omitempty"`
	// Represents Full-text search and semantic search feature.
	// create = required
	// update = optional
	FulltextInstalled *bool `json:"fulltextInstalled,omitempty"`
	// The SQL Server instance home.
	// minLength = 1
	// maxLength = 300
	// create = required
	// update = optional
	InstallationPath string `json:"installationPath,omitempty"`
	// The name of the SQL Server instance.
	// minLength = 1
	// maxLength = 256
	// create = required
	InstanceName string `json:"instanceName,omitempty"`
	// Account the SQL Server instance is running as.
	// minLength = 1
	// maxLength = 255
	// create = required
	// update = optional
	InstanceOwner string `json:"instanceOwner,omitempty"`
	// Internal version of the SQL Server instance.
	// create = required
	// update = optional
	// minimum = 1
	InternalVersion *int `json:"internalVersion,omitempty"`
	// Flag indicating whether the repository should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The network port for connecting to the SQL Server instance.
	// minimum = 1
	// maximum = 65535
	// create = required
	// update = optional
	Port *int `json:"port,omitempty"`
	// Flag indicating whether the repository should be used for
	// provisioning.
	// default = true
	// create = optional
	// update = optional
	ProvisioningEnabled *bool `json:"provisioningEnabled,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The Server Name of the SQL Server instance.
	// maxLength = 128
	// create = optional
	// update = optional
	ServerName string `json:"serverName,omitempty"`
	// Flag indicating whether this repository can be used by the Delphix
	// Engine for internal processing.
	// default = false
	// create = optional
	// update = optional
	Staging *bool `json:"staging,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The version of the SQL Server instance.
	// create = required
	// update = optional
	// minLength = 1
	// maxLength = 256
	Version string `json:"version,omitempty"`
}

MSSqlInstanceStruct - A SQL Server Instance. extends MSSqlRepository

func MSSqlInstanceFactory 

func MSSqlInstanceFactory(
	Discovered *bool,
	Environment string,
	FulltextInstalled *bool,
	InstallationPath string,
	InstanceName string,
	InstanceOwner string,
	InternalVersion *int,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	Port *int,
	ProvisioningEnabled *bool,
	Reference string,
	ServerName string,
	Staging *bool,
	Version string,
) MSSqlInstanceStruct

MSSqlInstanceFactory is just a simple function to instantiate the MSSqlInstanceStruct

type MSSqlLinkDataStruct 

type MSSqlLinkDataStruct struct {
	// The password for accessing the shared backup location.
	// create = optional
	BackupLocationCredentials *PasswordCredentialStruct `json:"backupLocationCredentials,omitempty"`
	// The user for accessing the shared backup location.
	// create = optional
	// maxLength = 256
	BackupLocationUser string `json:"backupLocationUser,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-mssql-db-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The credential for the source DB user.
	// required = true
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The user name for the source DB user.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// The encryption key to use when restoring encrypted backups.
	// create = optional
	EncryptionKey string `json:"encryptionKey,omitempty"`
	// External file path.
	// create = optional
	// maxLength = 1024
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Configuration that determines what ingestion strategy the source
	// will use.
	// create = required
	IngestionStrategy IngestionStrategy `json:"ingestionStrategy,omitempty"`
	// Configuration for source that allows ingesting NetBackup backups
	// for SQL Server.
	// create = optional
	MssqlNetbackupConfig string `json:"mssqlNetbackupConfig,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// Information about the host OS user on the PPT host to use for
	// linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	PptHostUser string `json:"pptHostUser,omitempty"`
	// The SQL instance on the PPT environment that we want to use for
	// pre-provisioning.
	// format = objectReference
	// referenceTo = /delphix-mssql-instance.json
	// required = true
	PptRepository string `json:"pptRepository,omitempty"`
	// Shared source database backup locations.
	// create = required
	// maxItems = 1000
	SharedBackupLocations []string `json:"sharedBackupLocations,omitempty"`
	// Information about the host OS user on the source to use for
	// linking.
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// format = objectReference
	SourceHostUser string `json:"sourceHostUser,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// A user-provided PowerShell script or executable to run after
	// restoring from a backup during pre-provisioning.
	// create = optional
	// maxLength = 1024
	StagingPostScript string `json:"stagingPostScript,omitempty"`
	// A user-provided PowerShell script or executable to run prior to
	// restoring from a backup during pre-provisioning.
	// create = optional
	// maxLength = 1024
	StagingPreScript string `json:"stagingPreScript,omitempty"`
	// Sync parameters for the container.
	// required = true
	SyncParameters MSSqlSyncParameters `json:"syncParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlLinkDataStruct - MSSQL specific parameters for a link request. extends LinkData

func MSSqlLinkDataFactory 

func MSSqlLinkDataFactory(
	BackupLocationCredentials *PasswordCredentialStruct,
	BackupLocationUser string,
	Config string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	EncryptionKey string,
	ExternalFilePath string,
	IngestionStrategy IngestionStrategy,
	MssqlNetbackupConfig string,
	Operations *LinkedSourceOperationsStruct,
	PptHostUser string,
	PptRepository string,
	SharedBackupLocations []string,
	SourceHostUser string,
	SourcingPolicy *SourcingPolicyStruct,
	StagingPostScript string,
	StagingPreScript string,
	SyncParameters MSSqlSyncParameters,
) MSSqlLinkDataStruct

MSSqlLinkDataFactory is just a simple function to instantiate the MSSqlLinkDataStruct

type MSSqlLinkedSourceStruct 

type MSSqlLinkedSourceStruct struct {
	// The password for accessing the shared backup location.
	// create = optional
	// update = optional
	BackupLocationCredentials *PasswordCredentialStruct `json:"backupLocationCredentials,omitempty"`
	// The user for accessing the shared backup location.
	// create = optional
	// update = optional
	// maxLength = 256
	BackupLocationUser string `json:"backupLocationUser,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-mssql-db-config.json
	// create = required
	// update = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// The encryption key to use when restoring encrypted backups.
	// create = optional
	// update = optional
	EncryptionKey string `json:"encryptionKey,omitempty"`
	// External file path.
	// create = optional
	// update = optional
	// maxLength = 1024
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Configuration that determines what ingestion strategy the source
	// will use.
	// create = required
	// update = optional
	IngestionStrategy IngestionStrategy `json:"ingestionStrategy,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// create = optional
	// update = optional
	// default = false
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Configuration for source that allows ingesting NetBackup backups
	// for SQL Server.
	// create = optional
	// update = optional
	MssqlNetbackupConfig string `json:"mssqlNetbackupConfig,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *MSSqlSourceRuntimeStruct `json:"runtime,omitempty"`
	// Shared source database backup locations.
	// create = required
	// update = optional
	// maxItems = 1000
	SharedBackupLocations []string `json:"sharedBackupLocations,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// The staging source for pre-provisioning of the database.
	// format = objectReference
	// referenceTo = /delphix-mssql-staging-source.json
	StagingSource string `json:"stagingSource,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

MSSqlLinkedSourceStruct - A linked MSSQL source. extends MSSqlSource

func MSSqlLinkedSourceFactory 

func MSSqlLinkedSourceFactory(
	BackupLocationCredentials *PasswordCredentialStruct,
	BackupLocationUser string,
	Config string,
	Container string,
	Description string,
	EncryptionKey string,
	ExternalFilePath string,
	Hosts []string,
	IngestionStrategy IngestionStrategy,
	Linked *bool,
	LogCollectionEnabled *bool,
	MssqlNetbackupConfig string,
	Name string,
	Namespace string,
	Operations *LinkedSourceOperationsStruct,
	Reference string,
	Runtime *MSSqlSourceRuntimeStruct,
	SharedBackupLocations []string,
	Staging *bool,
	StagingSource string,
	Status string,
	Virtual *bool,
) MSSqlLinkedSourceStruct

MSSqlLinkedSourceFactory is just a simple function to instantiate the MSSqlLinkedSourceStruct

type MSSqlLinkedSourceUpgradeParametersStruct 

type MSSqlLinkedSourceUpgradeParametersStruct struct {
	// The SQL instance on the PPT environment that we want to use for
	// pre-provisioning.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-mssql-instance.json
	PptRepository string `json:"pptRepository,omitempty"`
	// The source config that the source database upgrades to.
	// required = true
	SourceConfig MSSqlDBConfig `json:"sourceConfig,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

MSSqlLinkedSourceUpgradeParametersStruct - The parameters to use as input to upgrade an MSSQL linked source. extends SourceUpgradeParameters

func MSSqlLinkedSourceUpgradeParametersFactory 

func MSSqlLinkedSourceUpgradeParametersFactory(
	PptRepository string,
	SourceConfig MSSqlDBConfig,
) MSSqlLinkedSourceUpgradeParametersStruct

MSSqlLinkedSourceUpgradeParametersFactory is just a simple function to instantiate the MSSqlLinkedSourceUpgradeParametersStruct

type MSSqlNetbackupConfigStruct 

type MSSqlNetbackupConfigStruct struct {
	// NetBackup configuration parameter overrides.
	// create = optional
	// update = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Optional config template selection for NetBackup configurations.
	// If set, configParams will be ignored.
	// referenceTo = /delphix-database-template.json
	// create = optional
	// update = optional
	// format = objectReference
	ConfigTemplate string `json:"configTemplate,omitempty"`
	// The master server name of this NetBackup configuration.
	// create = required
	// update = optional
	// maxLength = 256
	MasterName string `json:"masterName,omitempty"`
	// The source's client server name of this NetBackup configuration.
	// create = required
	// update = optional
	// maxLength = 256
	SourceClientName string `json:"sourceClientName,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlNetbackupConfigStruct - MSSql NetBackup configuration. extends TypedObject

func MSSqlNetbackupConfigFactory 

func MSSqlNetbackupConfigFactory(
	ConfigParams map[string]string,
	ConfigTemplate string,
	MasterName string,
	SourceClientName string,
) MSSqlNetbackupConfigStruct

MSSqlNetbackupConfigFactory is just a simple function to instantiate the MSSqlNetbackupConfigStruct

type MSSqlNewCopyOnlyFullBackupSyncParametersStruct 

type MSSqlNewCopyOnlyFullBackupSyncParametersStruct struct {
	// If this parameter is set to true, Delphix will take a compressed
	// copy only full backup of the source database. When set to false,
	// Delphix will use the SQL Server instance's compression default.
	// default = false
	// required = true
	CompressionEnabled *bool `json:"compressionEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlNewCopyOnlyFullBackupSyncParametersStruct - The parameters to use as input to sync MSSQL databases using a new copy-only full backup taken by Delphix. extends MSSqlSyncParameters

func MSSqlNewCopyOnlyFullBackupSyncParametersFactory 

func MSSqlNewCopyOnlyFullBackupSyncParametersFactory(
	CompressionEnabled *bool,
) MSSqlNewCopyOnlyFullBackupSyncParametersStruct

MSSqlNewCopyOnlyFullBackupSyncParametersFactory is just a simple function to instantiate the MSSqlNewCopyOnlyFullBackupSyncParametersStruct

type MSSqlPlatformParametersStruct 

type MSSqlPlatformParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlPlatformParametersStruct - MSSql platform-specific parameters that are stored on a transformation. extends BasePlatformParameters

func MSSqlPlatformParametersFactory 

func MSSqlPlatformParametersFactory() MSSqlPlatformParametersStruct

MSSqlPlatformParametersFactory is just a simple function to instantiate the MSSqlPlatformParametersStruct

type MSSqlProvisionParametersStruct 

type MSSqlProvisionParametersStruct struct {
	// The new container for the provisioned database.
	// required = true
	Container *MSSqlDatabaseContainerStruct `json:"container,omitempty"`
	// Whether or not to mark this VDB as a masked VDB. It will be marked
	// as masked if this flag or the masking job are set.
	// create = optional
	// update = readonly
	Masked *bool `json:"masked,omitempty"`
	// The Masking Job to be run when this dataset is provisioned or
	// refreshed.
	// update = readonly
	// format = objectReference
	// referenceTo = /delphix-masking-job.json
	// create = optional
	MaskingJob string `json:"maskingJob,omitempty"`
	// The source that describes an external database instance.
	// required = true
	Source *MSSqlVirtualSourceStruct `json:"source,omitempty"`
	// The source config including dynamically discovered attributes of
	// the source.
	// required = true
	SourceConfig MSSqlDBConfig `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base
	// provisioning on.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlProvisionParametersStruct - The parameters to use as input to provision MSSQL databases. extends ProvisionParameters

func MSSqlProvisionParametersFactory 

func MSSqlProvisionParametersFactory(
	Container *MSSqlDatabaseContainerStruct,
	Masked *bool,
	MaskingJob string,
	Source *MSSqlVirtualSourceStruct,
	SourceConfig MSSqlDBConfig,
	TimeflowPointParameters TimeflowPointParameters,
) MSSqlProvisionParametersStruct

MSSqlProvisionParametersFactory is just a simple function to instantiate the MSSqlProvisionParametersStruct

type MSSqlRepository 

type MSSqlRepository interface{}

MSSqlRepository is an empty interface designed to function as the MSSqlRepository API namespace

type MSSqlSIConfigStruct 

type MSSqlSIConfigStruct struct {
	// The password of the database user.
	// update = optional
	Credentials Credential `json:"credentials,omitempty"`
	// The name of the database.
	// create = required
	// update = optional
	// maxLength = 128
	DatabaseName string `json:"databaseName,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// create = optional
	// update = optional
	// default = true
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Specifies the current recovery model of the source database.
	// enum = [FULL SIMPLE BULK_LOGGED]
	// default = SIMPLE
	// create = optional
	// update = readonly
	RecoveryModel string `json:"recoveryModel,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// format = objectReference
	// referenceTo = /delphix-mssql-repository.json
	// create = required
	// update = optional
	Repository string `json:"repository,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The username of the database user.
	// maxLength = 256
	// update = optional
	User string `json:"user,omitempty"`
}

MSSqlSIConfigStruct - Configuration information for a single instance MSSQL Source. extends MSSqlDBConfig

func MSSqlSIConfigFactory 

func MSSqlSIConfigFactory(
	Credentials Credential,
	DatabaseName string,
	Discovered *bool,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	RecoveryModel string,
	Reference string,
	Repository string,
	User string,
) MSSqlSIConfigStruct

MSSqlSIConfigFactory is just a simple function to instantiate the MSSqlSIConfigStruct

type MSSqlSnapshotRuntimeStruct 

type MSSqlSnapshotRuntimeStruct struct {
	// True if this snapshot can be used as the basis for provisioning a
	// new TimeFlow.
	Provisionable *bool `json:"provisionable,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlSnapshotRuntimeStruct - Runtime (non-persistent) properties of a MSSQL TimeFlow snapshot. extends SnapshotRuntime

func MSSqlSnapshotRuntimeFactory 

func MSSqlSnapshotRuntimeFactory(
	Provisionable *bool,
) MSSqlSnapshotRuntimeStruct

MSSqlSnapshotRuntimeFactory is just a simple function to instantiate the MSSqlSnapshotRuntimeStruct

type MSSqlSnapshotStruct 

type MSSqlSnapshotStruct struct {
	// UUID of the source database backup that was restored for this
	// snapshot.
	BackupSetUUID string `json:"backupSetUUID,omitempty"`
	// A value in the set {CONSISTENT, INCONSISTENT, CRASH_CONSISTENT}
	// indicating what type of recovery strategies must be invoked when
	// provisioning from this snapshot.
	Consistency string `json:"consistency,omitempty"`
	// Reference to the database of which this TimeFlow is a part.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Point in time at which this snapshot was created. This may be
	// different from the time corresponding to the TimeFlow.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// The location within the parent TimeFlow at which this snapshot was
	// initiated.
	FirstChangePoint *MSSqlTimeflowPointStruct `json:"firstChangePoint,omitempty"`
	// Internal version of the source database at the time the snapshot
	// was taken.
	InternalVersion *int `json:"internalVersion,omitempty"`
	// The location of the snapshot within the parent TimeFlow
	// represented by this snapshot.
	LatestChangePoint *MSSqlTimeflowPointStruct `json:"latestChangePoint,omitempty"`
	// Boolean value indicating if a virtual database provisioned from
	// this snapshot will be missing nologging changes.
	MissingNonLoggedData *bool `json:"missingNonLoggedData,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// Retention policy, in days. A value of -1 indicates the snapshot
	// should be kept forever.
	// update = optional
	Retention *int `json:"retention,omitempty"`
	// Runtime properties of the snapshot.
	Runtime *MSSqlSnapshotRuntimeStruct `json:"runtime,omitempty"`
	// Boolean value indicating that this snapshot is in a transient
	// state and should not be user visible.
	Temporary *bool `json:"temporary,omitempty"`
	// TimeFlow of which this snapshot is a part.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Time zone of the source database at the time the snapshot was
	// taken.
	Timezone string `json:"timezone,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of database source repository at the time the snapshot was
	// taken.
	Version string `json:"version,omitempty"`
}

MSSqlSnapshotStruct - Provisionable snapshot of a MSSQL TimeFlow. extends TimeflowSnapshot

func MSSqlSnapshotFactory 

func MSSqlSnapshotFactory(
	BackupSetUUID string,
	Consistency string,
	Container string,
	CreationTime string,
	FirstChangePoint *MSSqlTimeflowPointStruct,
	InternalVersion *int,
	LatestChangePoint *MSSqlTimeflowPointStruct,
	MissingNonLoggedData *bool,
	Name string,
	Namespace string,
	Reference string,
	Retention *int,
	Runtime *MSSqlSnapshotRuntimeStruct,
	Temporary *bool,
	Timeflow string,
	Timezone string,
	Version string,
) MSSqlSnapshotStruct

MSSqlSnapshotFactory is just a simple function to instantiate the MSSqlSnapshotStruct

type MSSqlSource 

type MSSqlSource interface{}

MSSqlSource is an empty interface designed to function as the MSSqlSource API namespace

type MSSqlSourceConnectionInfoStruct 

type MSSqlSourceConnectionInfoStruct struct {
	// The name of the database.
	DatabaseName string `json:"databaseName,omitempty"`
	// The hostname or IP address of the host where the source resides.
	Host string `json:"host,omitempty"`
	// The JDBC string used to connect to the SQL server instance.
	InstanceJDBCString string `json:"instanceJDBCString,omitempty"`
	// The name of the instance.
	InstanceName string `json:"instanceName,omitempty"`
	// The port number used to connect to the source.
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The database version string.
	Version string `json:"version,omitempty"`
}

MSSqlSourceConnectionInfoStruct - Contains information that can be used to connect to a SQL server source. extends SourceConnectionInfo

func MSSqlSourceConnectionInfoFactory 

func MSSqlSourceConnectionInfoFactory(
	DatabaseName string,
	Host string,
	InstanceJDBCString string,
	InstanceName string,
	Port *int,
	Version string,
) MSSqlSourceConnectionInfoStruct

MSSqlSourceConnectionInfoFactory is just a simple function to instantiate the MSSqlSourceConnectionInfoStruct

type MSSqlSourceRuntimeStruct 

type MSSqlSourceRuntimeStruct struct {
	// True if the source is JDBC accessible. If false then no properties
	// can be retrieved.
	Accessible *bool `json:"accessible,omitempty"`
	// The time that the 'accessible' propery was last checked.
	// format = date
	AccessibleTimestamp string `json:"accessibleTimestamp,omitempty"`
	// Size of the database in bytes.
	// units = B
	// base = 1024
	DatabaseSize float64 `json:"databaseSize,omitempty"`
	// Status indicating whether the source is enabled. A source has a
	// 'PARTIAL' status if its sub-sources are not all enabled.
	// enum = [ENABLED PARTIAL DISABLED]
	Enabled string `json:"enabled,omitempty"`
	// The reason why the source is not JDBC accessible.
	NotAccessibleReason string `json:"notAccessibleReason,omitempty"`
	// Status of the source. 'Unknown' if all attempts to connect to the
	// source failed.
	// enum = [RUNNING INACTIVE PENDING CANCELED FAILED CHECKING UNKNOWN]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlSourceRuntimeStruct - Runtime (non-persistent) properties of a MSSQL source. extends SourceRuntime

func MSSqlSourceRuntimeFactory 

func MSSqlSourceRuntimeFactory(
	Accessible *bool,
	AccessibleTimestamp string,
	DatabaseSize float64,
	Enabled string,
	NotAccessibleReason string,
	Status string,
) MSSqlSourceRuntimeStruct

MSSqlSourceRuntimeFactory is just a simple function to instantiate the MSSqlSourceRuntimeStruct

type MSSqlStagingSourceStruct 

type MSSqlStagingSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// update = optional
	// default = false
	// create = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point for the iSCSI LUN mounts.
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A user-provided PowerShell script or executable to run after
	// restoring from a backup during pre-provisioning.
	// maxLength = 1024
	// create = optional
	// update = optional
	PostScript string `json:"postScript,omitempty"`
	// A user-provided PowerShell script or executable to run prior to
	// restoring from a backup during pre-provisioning.
	// create = optional
	// update = optional
	// maxLength = 1024
	PreScript string `json:"preScript,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *MSSqlSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

MSSqlStagingSourceStruct - An MSSQL staging source used for pre-provisioning. extends MSSqlSource

func MSSqlStagingSourceFactory 

func MSSqlStagingSourceFactory(
	Config string,
	Container string,
	Description string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	PostScript string,
	PreScript string,
	Reference string,
	Runtime *MSSqlSourceRuntimeStruct,
	Staging *bool,
	Status string,
	Virtual *bool,
) MSSqlStagingSourceStruct

MSSqlStagingSourceFactory is just a simple function to instantiate the MSSqlStagingSourceStruct

type MSSqlSyncParameters 

type MSSqlSyncParameters interface{}

MSSqlSyncParameters is an empty interface designed to function as the MSSqlSyncParameters API namespace

type MSSqlTimeflowPointStruct 

type MSSqlTimeflowPointStruct struct {
	// The TimeFlow location.
	// create = optional
	Location string `json:"location,omitempty"`
	// Reference to TimeFlow containing this point.
	// referenceTo = /delphix-mssql-timeflow.json
	// required = true
	// format = objectReference
	Timeflow string `json:"timeflow,omitempty"`
	// The logical time corresponding to the TimeFlow location.
	// create = optional
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlTimeflowPointStruct - A unique point within an MSSql database TimeFlow. extends TimeflowPoint

func MSSqlTimeflowPointFactory 

func MSSqlTimeflowPointFactory(
	Location string,
	Timeflow string,
	Timestamp string,
) MSSqlTimeflowPointStruct

MSSqlTimeflowPointFactory is just a simple function to instantiate the MSSqlTimeflowPointStruct

type MSSqlTimeflowStruct 

type MSSqlTimeflowStruct struct {
	// Reference to the data container (database) for this TimeFlow.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// The source action that created the TimeFlow.
	// enum = [INITIAL INDETERMINATE REFRESH ROLLBACK TEMPORARY TRANSFORMATION V2P PDB_PLUG WAREHOUSE ORACLE_LIVE_SOURCE_RESYNC SOURCE_CONTINUITY]
	CreationType string `json:"creationType,omitempty"`
	// MSSQL-specific recovery branch identifier for this TimeFlow.
	DatabaseGuid string `json:"databaseGuid,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The origin point on the parent TimeFlow from which this TimeFlow
	// was provisioned. This will not be present for TimeFlows derived
	// from linked sources.
	ParentPoint *MSSqlTimeflowPointStruct `json:"parentPoint,omitempty"`
	// Reference to the parent snapshot that serves as the provisioning
	// base for this object. This may be different from the snapshot
	// within the parent point, and is only present for virtual
	// TimeFlows.
	// format = objectReference
	// referenceTo = /delphix-timeflow-snapshot.json
	ParentSnapshot string `json:"parentSnapshot,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MSSqlTimeflowStruct - TimeFlow representing historical data for a particular timeline within a data container. extends Timeflow

func MSSqlTimeflowFactory 

func MSSqlTimeflowFactory(
	Container string,
	CreationType string,
	DatabaseGuid string,
	Name string,
	Namespace string,
	ParentPoint *MSSqlTimeflowPointStruct,
	ParentSnapshot string,
	Reference string,
) MSSqlTimeflowStruct

MSSqlTimeflowFactory is just a simple function to instantiate the MSSqlTimeflowStruct

type MSSqlVirtualSourceStruct 

type MSSqlVirtualSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// create = required
	// update = optional
	// default = true
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// MSSQL database configuration parameter overrides.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point for the iSCSI LUN mounts.
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// A user-provided PowerShell script or executable to run after
	// provisioning.
	// update = optional
	// maxLength = 256
	// create = optional
	PostScript string `json:"postScript,omitempty"`
	// A user-provided PowerShell script or executable to run prior to
	// provisioning.
	// update = optional
	// maxLength = 256
	// create = optional
	PreScript string `json:"preScript,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *MSSqlSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

MSSqlVirtualSourceStruct - A virtual MSSQL source. extends MSSqlSource

func MSSqlVirtualSourceFactory 

func MSSqlVirtualSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	Config string,
	ConfigParams map[string]string,
	Container string,
	Description string,
	FileMappingRules string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	Operations *VirtualSourceOperationsStruct,
	PostScript string,
	PreScript string,
	Reference string,
	Runtime *MSSqlSourceRuntimeStruct,
	Staging *bool,
	Status string,
	Virtual *bool,
) MSSqlVirtualSourceStruct

MSSqlVirtualSourceFactory is just a simple function to instantiate the MSSqlVirtualSourceStruct

type MaskingJobStruct 

type MaskingJobStruct struct {
	// A reference to the container that the Masking Job is intended to
	// operate on.
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-container.json
	// create = optional
	AssociatedContainer string `json:"associatedContainer,omitempty"`
	// The masking job id from the Delphix Masking Engine instance that
	// specifies the desired Masking Job.
	// create = required
	// update = readonly
	MaskingJobId string `json:"maskingJobId,omitempty"`
	// Object name.
	// format = objectName
	// create = required
	// update = readonly
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MaskingJobStruct - The Delphix Engine record of an existing Masking Job. extends UserObject

func MaskingJobFactory 

func MaskingJobFactory(
	AssociatedContainer string,
	MaskingJobId string,
	Name string,
	Namespace string,
	Reference string,
) MaskingJobStruct

MaskingJobFactory is just a simple function to instantiate the MaskingJobStruct

type MaskingServiceConfigStruct 

type MaskingServiceConfigStruct struct {
	// Password to use when authenticating to the server.
	// update = optional
	Credentials Credential `json:"credentials,omitempty"`
	// Object name.
	// update = readonly
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Port number to use.
	// minimum = 1
	// maximum = 65535
	// update = optional
	Port *int `json:"port,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// Protocol scheme for use when communicating with server.
	// enum = [HTTP HTTPS]
	// update = optional
	Scheme string `json:"scheme,omitempty"`
	// IP address or hostname of server hosting Masking Service.
	// format = host
	// update = optional
	Server string `json:"server,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Username to use when authenticating to the server.
	// update = optional
	Username string `json:"username,omitempty"`
}

MaskingServiceConfigStruct - Configuration for the Masking Service this Engine communicates with. extends UserObject

func MaskingServiceConfigFactory 

func MaskingServiceConfigFactory(
	Credentials Credential,
	Name string,
	Namespace string,
	Port *int,
	Reference string,
	Scheme string,
	Server string,
	Username string,
) MaskingServiceConfigStruct

MaskingServiceConfigFactory is just a simple function to instantiate the MaskingServiceConfigStruct

type MigrateCompatibilityParametersStruct 

type MigrateCompatibilityParametersStruct struct {
	// Restrict returned repositories to this environment.
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = optional
	Environment string `json:"environment,omitempty"`
	// The repository to use as a source of compatibility information.
	// referenceTo = /delphix-source-repository.json
	// required = true
	// format = objectReference
	SourceRepository string `json:"sourceRepository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MigrateCompatibilityParametersStruct - The criteria necessary to select valid repositories for migration. extends CompatibleRepositoriesParameters

func MigrateCompatibilityParametersFactory 

func MigrateCompatibilityParametersFactory(
	Environment string,
	SourceRepository string,
) MigrateCompatibilityParametersStruct

MigrateCompatibilityParametersFactory is just a simple function to instantiate the MigrateCompatibilityParametersStruct

type MySQLAttachDataStruct 

type MySQLAttachDataStruct struct {
	// Reference to the configuration for the source. Must be an existing
	// linked source config.
	// format = objectReference
	// referenceTo = /delphix-mysql-server-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// MySQL database configuration parameter overrides.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// The credentials for the database user.
	// required = true
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The database username.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// OS user on the staging host to use for attaching.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	StagingHostUser string `json:"stagingHostUser,omitempty"`
	// The port on which the MySQL staging instance will listen.
	// required = true
	// minimum = 1
	// maximum = 65535
	StagingPort *int `json:"stagingPort,omitempty"`
	// The MySQL installation on the staging environment to use for
	// validated sync.
	// format = objectReference
	// referenceTo = /delphix-mysql-install.json
	// required = true
	StagingRepository string `json:"stagingRepository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLAttachDataStruct - Represents the MySQL parameters of an attach request. extends AttachData

func MySQLAttachDataFactory 

func MySQLAttachDataFactory(
	Config string,
	ConfigParams map[string]string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	Operations *LinkedSourceOperationsStruct,
	StagingHostUser string,
	StagingPort *int,
	StagingRepository string,
) MySQLAttachDataStruct

MySQLAttachDataFactory is just a simple function to instantiate the MySQLAttachDataStruct

type MySQLBinlogCoordinatesStruct 

type MySQLBinlogCoordinatesStruct struct {
	// Name of the master log file to start replication from.
	// required = true
	MasterLogName string `json:"masterLogName,omitempty"`
	// Position within the master log file to start replication from.
	// required = true
	MasterLogPos *int `json:"masterLogPos,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLBinlogCoordinatesStruct - The current position in the master binary logs when a MySQL backup was taken. extends MySQLReplicationCoordinates

func MySQLBinlogCoordinatesFactory 

func MySQLBinlogCoordinatesFactory(
	MasterLogName string,
	MasterLogPos *int,
) MySQLBinlogCoordinatesStruct

MySQLBinlogCoordinatesFactory is just a simple function to instantiate the MySQLBinlogCoordinatesStruct

type MySQLCompatibilityCriteriaStruct 

type MySQLCompatibilityCriteriaStruct struct {
	// Selected repositories are installed on a host with this
	// architecture (32-bit or 64-bit).
	Architecture *int `json:"architecture,omitempty"`
	// Selected repositories are installed on this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// Selected repositories are installed on a host with this OS.
	// enum = [Linux AIX HPUX SunOS Windows]
	Os string `json:"os,omitempty"`
	// Selected repositories are installed on a host with this type of
	// processor.
	// enum = [x86 ia64 powerpc sparc]
	Processor string `json:"processor,omitempty"`
	// If true, selected repositories have staging enabled.
	StagingEnabled *bool `json:"stagingEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of the MySQL installation.
	Version *MySQLVersionStruct `json:"version,omitempty"`
}

MySQLCompatibilityCriteriaStruct - The compatibility criteria to use for selecting compatible MySQL repositories. extends CompatibilityCriteria

func MySQLCompatibilityCriteriaFactory 

func MySQLCompatibilityCriteriaFactory(
	Architecture *int,
	Environment string,
	Os string,
	Processor string,
	StagingEnabled *bool,
	Version *MySQLVersionStruct,
) MySQLCompatibilityCriteriaStruct

MySQLCompatibilityCriteriaFactory is just a simple function to instantiate the MySQLCompatibilityCriteriaStruct

type MySQLCreateTransformationParametersStruct 

type MySQLCreateTransformationParametersStruct struct {
	// The container that will contain the transformed data associated
	// with the newly created transformation; the "transformation
	// container".
	// create = required
	Container *MySQLDatabaseContainerStruct `json:"container,omitempty"`
	// Reference to the user used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Operations to perform when this transformation is applied.
	// create = required
	Operations []SourceOperation `json:"operations,omitempty"`
	// The port number used for provisioning a MySQL container during
	// transformation application.
	// maximum = 65535
	// create = required
	// minimum = 1
	Port *int `json:"port,omitempty"`
	// Reference to the repository used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	// create = required
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLCreateTransformationParametersStruct - Represents the parameters of a createTransformation request for a MySQL container. extends CreateTransformationParameters

func MySQLCreateTransformationParametersFactory 

func MySQLCreateTransformationParametersFactory(
	Container *MySQLDatabaseContainerStruct,
	EnvironmentUser string,
	Operations []SourceOperation,
	Port *int,
	Repository string,
) MySQLCreateTransformationParametersStruct

MySQLCreateTransformationParametersFactory is just a simple function to instantiate the MySQLCreateTransformationParametersStruct

type MySQLDBContainerRuntimeStruct 

type MySQLDBContainerRuntimeStruct struct {
	// True if the LogSync is enabled and running for this container.
	LogSyncActive *bool `json:"logSyncActive,omitempty"`
	// The pre-provisioning runtime for the container.
	PreProvisioningStatus *PreProvisioningRuntimeStruct `json:"preProvisioningStatus,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

MySQLDBContainerRuntimeStruct - Runtime properties of a MySQL database container. extends DBContainerRuntime

func MySQLDBContainerRuntimeFactory 

func MySQLDBContainerRuntimeFactory(
	LogSyncActive *bool,
	PreProvisioningStatus *PreProvisioningRuntimeStruct,
) MySQLDBContainerRuntimeStruct

MySQLDBContainerRuntimeFactory is just a simple function to instantiate the MySQLDBContainerRuntimeStruct

type MySQLDatabaseContainerStruct 

type MySQLDatabaseContainerStruct struct {
	// The date this container was created.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// A reference to the currently active TimeFlow for this container.
	// referenceTo = /delphix-timeflow.json
	// format = objectReference
	CurrentTimeflow string `json:"currentTimeflow,omitempty"`
	// Optional user-provided description for the container.
	// maxLength = 1024
	// create = optional
	// update = optional
	Description string `json:"description,omitempty"`
	// A reference to the group containing this container.
	// format = objectReference
	// referenceTo = /delphix-group.json
	// create = required
	Group string `json:"group,omitempty"`
	// True if this container is a masked container.
	Masked *bool `json:"masked,omitempty"`
	// Object name.
	// maxLength = 256
	// create = required
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Native operating system of the original database source system.
	Os string `json:"os,omitempty"`
	// Whether to enable high performance mode.
	// enum = [TEMPORARILY_ENABLED ENABLED DISABLED]
	// default = DISABLED
	// create = readonly
	// update = readonly
	PerformanceMode string `json:"performanceMode,omitempty"`
	// A reference to the previous TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	PreviousTimeflow string `json:"previousTimeflow,omitempty"`
	// Native processor type of the original database source system.
	Processor string `json:"processor,omitempty"`
	// A reference to the container this container was provisioned from.
	// format = objectReference
	// referenceTo = /delphix-container.json
	ProvisionContainer string `json:"provisionContainer,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this container.
	Runtime *MySQLDBContainerRuntimeStruct `json:"runtime,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	// update = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// True if this container is a transformation container.
	Transformation *bool `json:"transformation,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Variant of the MySQL installation.
	// enum = [CommunityServer MariaDB]
	Variant string `json:"variant,omitempty"`
}

MySQLDatabaseContainerStruct - A MySQL Database Container. extends DatabaseContainer

func MySQLDatabaseContainerFactory 

func MySQLDatabaseContainerFactory(
	CreationTime string,
	CurrentTimeflow string,
	Description string,
	Group string,
	Masked *bool,
	Name string,
	Namespace string,
	Os string,
	PreviousTimeflow string,
	Processor string,
	ProvisionContainer string,
	Reference string,
	Runtime *MySQLDBContainerRuntimeStruct,
	SourcingPolicy *SourcingPolicyStruct,
	Transformation *bool,
	Variant string,
) MySQLDatabaseContainerStruct

MySQLDatabaseContainerFactory is just a simple function to instantiate the MySQLDatabaseContainerStruct

type MySQLExistingBackupSyncParameters 

type MySQLExistingBackupSyncParameters interface{}

MySQLExistingBackupSyncParameters is an empty interface designed to function as the MySQLExistingBackupSyncParameters API namespace

type MySQLExistingMySQLDumpSyncParametersStruct 

type MySQLExistingMySQLDumpSyncParametersStruct struct {
	// Path to the existing backup to be loaded.
	// required = true
	BackupLocation string `json:"backupLocation,omitempty"`
	// The coordinates corresponding to the MySQL backup to start
	// replication from.
	// create = optional
	ReplicationCoordinates MySQLReplicationCoordinates `json:"replicationCoordinates,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLExistingMySQLDumpSyncParametersStruct - The parameters to use as input to sync requests for MySQL databases using an existing MySQL dump. extends MySQLExistingBackupSyncParameters

func MySQLExistingMySQLDumpSyncParametersFactory 

func MySQLExistingMySQLDumpSyncParametersFactory(
	BackupLocation string,
	ReplicationCoordinates MySQLReplicationCoordinates,
) MySQLExistingMySQLDumpSyncParametersStruct

MySQLExistingMySQLDumpSyncParametersFactory is just a simple function to instantiate the MySQLExistingMySQLDumpSyncParametersStruct

type MySQLExportParametersStruct 

type MySQLExportParametersStruct struct {
	// Database-specific configuration parameters.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// The filesystem configuration of the exported database.
	// required = true
	FilesystemLayout *TimeflowFilesystemLayoutStruct `json:"filesystemLayout,omitempty"`
	// If specified, then take the exported database through recovery
	// procedures, if necessary, to reach a consistent point.
	// default = true
	// create = optional
	RecoverDatabase *bool `json:"recoverDatabase,omitempty"`
	// The source config to use when creating the exported database.
	// required = true
	SourceConfig *MySQLServerConfigStruct `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base export
	// on.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLExportParametersStruct - The parameters to use as input to export MySQL databases. extends DbExportParameters

func MySQLExportParametersFactory 

func MySQLExportParametersFactory(
	ConfigParams map[string]string,
	FileMappingRules string,
	FilesystemLayout *TimeflowFilesystemLayoutStruct,
	RecoverDatabase *bool,
	SourceConfig *MySQLServerConfigStruct,
	TimeflowPointParameters TimeflowPointParameters,
) MySQLExportParametersStruct

MySQLExportParametersFactory is just a simple function to instantiate the MySQLExportParametersStruct

type MySQLGtidCoordinatesStruct 

type MySQLGtidCoordinatesStruct struct {
	// The GTID coordinates on the master to start replication from.
	// minItems = 1
	// required = true
	Gtids []string `json:"gtids,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLGtidCoordinatesStruct - The GTID coordinates on the master when a MySQL backup was taken. extends MySQLReplicationCoordinates

func MySQLGtidCoordinatesFactory 

func MySQLGtidCoordinatesFactory(
	Gtids []string,
) MySQLGtidCoordinatesStruct

MySQLGtidCoordinatesFactory is just a simple function to instantiate the MySQLGtidCoordinatesStruct

type MySQLInstallStruct 

type MySQLInstallStruct struct {
	// Flag indicating whether the MySQL installation was discovered or
	// manually entered.
	Discovered *bool `json:"discovered,omitempty"`
	// Reference to the environment containing this repository.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = required
	Environment string `json:"environment,omitempty"`
	// Directory path where the MySQL installation is located.
	// create = required
	InstallationPath string `json:"installationPath,omitempty"`
	// Version of the MySQL installation.
	InternalVersion *MySQLVersionStruct `json:"internalVersion,omitempty"`
	// Flag indicating whether the repository should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Flag indicating whether the repository should be used for
	// provisioning.
	// default = true
	// create = optional
	// update = optional
	ProvisioningEnabled *bool `json:"provisioningEnabled,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Flag indicating whether this repository can be used by the Delphix
	// Engine for internal processing.
	// default = false
	// create = optional
	// update = optional
	Staging *bool `json:"staging,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version string for the repository.
	// create = readonly
	// update = readonly
	Version string `json:"version,omitempty"`
}

MySQLInstallStruct - A MySQL installation. extends SourceRepository

func MySQLInstallFactory 

func MySQLInstallFactory(
	Discovered *bool,
	Environment string,
	InstallationPath string,
	InternalVersion *MySQLVersionStruct,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	ProvisioningEnabled *bool,
	Reference string,
	Staging *bool,
	Version string,
) MySQLInstallStruct

MySQLInstallFactory is just a simple function to instantiate the MySQLInstallStruct

type MySQLLinkDataStruct 

type MySQLLinkDataStruct struct {
	// Reference to the configuration for the source.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-mysql-server-config.json
	Config string `json:"config,omitempty"`
	// MySQL database configuration parameter overrides.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// The credentials for the database user.
	// required = true
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The database username.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// OS user on the staging host to use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	StagingHostUser string `json:"stagingHostUser,omitempty"`
	// The port on the staging host that the MySQL staging server can
	// listen on for TCP/IP connections.
	// minimum = 1
	// maximum = 65535
	// required = true
	StagingPort *int `json:"stagingPort,omitempty"`
	// The MySQL installation on the staging environment that will be
	// used for validated sync.
	// format = objectReference
	// referenceTo = /delphix-mysql-install.json
	// required = true
	StagingRepository string `json:"stagingRepository,omitempty"`
	// Sync parameters for the container.
	// required = true
	SyncParameters MySQLSyncParameters `json:"syncParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLLinkDataStruct - MySQL specific parameters for a link request. extends LinkData

func MySQLLinkDataFactory 

func MySQLLinkDataFactory(
	Config string,
	ConfigParams map[string]string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	Operations *LinkedSourceOperationsStruct,
	SourcingPolicy *SourcingPolicyStruct,
	StagingHostUser string,
	StagingPort *int,
	StagingRepository string,
	SyncParameters MySQLSyncParameters,
) MySQLLinkDataStruct

MySQLLinkDataFactory is just a simple function to instantiate the MySQLLinkDataStruct

type MySQLLinkedSourceStruct 

type MySQLLinkedSourceStruct struct {
	// Reference to the configuration for the source.
	// referenceTo = /delphix-mysql-server-config.json
	// create = required
	// update = optional
	// format = objectReference
	Config string `json:"config,omitempty"`
	// MySQL database configuration parameter overrides.
	// create = optional
	// update = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *MySQLSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// The staging source for validated sync of the database.
	// format = objectReference
	// referenceTo = /delphix-mysql-staging-source.json
	StagingSource string `json:"stagingSource,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

MySQLLinkedSourceStruct - A linked MySQL source. extends MySQLSource

func MySQLLinkedSourceFactory 

func MySQLLinkedSourceFactory(
	Config string,
	ConfigParams map[string]string,
	Container string,
	Description string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	Operations *LinkedSourceOperationsStruct,
	Reference string,
	Runtime *MySQLSourceRuntimeStruct,
	Staging *bool,
	StagingSource string,
	Status string,
	Virtual *bool,
) MySQLLinkedSourceStruct

MySQLLinkedSourceFactory is just a simple function to instantiate the MySQLLinkedSourceStruct

type MySQLNewMySQLDumpSyncParametersStruct 

type MySQLNewMySQLDumpSyncParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLNewMySQLDumpSyncParametersStruct - The parameters to use as input to sync requests for MySQL databases using a new MySQL dump taken by Delphix. extends MySQLSyncParameters

func MySQLNewMySQLDumpSyncParametersFactory 

func MySQLNewMySQLDumpSyncParametersFactory() MySQLNewMySQLDumpSyncParametersStruct

MySQLNewMySQLDumpSyncParametersFactory is just a simple function to instantiate the MySQLNewMySQLDumpSyncParametersStruct

type MySQLPlatformParametersStruct 

type MySQLPlatformParametersStruct struct {
	// The port number used for provisioning a MySQL container during
	// transformation application. This port must be available when the
	// transformation is applied so that the temporary VDB created during
	// the transformation process can start and listen to this port.
	// minimum = 1
	// maximum = 65535
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLPlatformParametersStruct - MySQL platform-specific parameters that are stored on a transformation. extends BasePlatformParameters

func MySQLPlatformParametersFactory 

func MySQLPlatformParametersFactory(
	Port *int,
) MySQLPlatformParametersStruct

MySQLPlatformParametersFactory is just a simple function to instantiate the MySQLPlatformParametersStruct

type MySQLProvisionParametersStruct 

type MySQLProvisionParametersStruct struct {
	// The new container for the provisioned database.
	// required = true
	Container *MySQLDatabaseContainerStruct `json:"container,omitempty"`
	// Whether or not to mark this VDB as a masked VDB. It will be marked
	// as masked if this flag or the masking job are set.
	// create = optional
	// update = readonly
	Masked *bool `json:"masked,omitempty"`
	// The Masking Job to be run when this dataset is provisioned or
	// refreshed.
	// format = objectReference
	// referenceTo = /delphix-masking-job.json
	// create = optional
	// update = readonly
	MaskingJob string `json:"maskingJob,omitempty"`
	// The source that describes an external database instance.
	// required = true
	Source *MySQLVirtualSourceStruct `json:"source,omitempty"`
	// The source config for the source.
	// required = true
	SourceConfig *MySQLServerConfigStruct `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base
	// provisioning on.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLProvisionParametersStruct - The parameters to use as input to provision requests for MySQL databases. extends ProvisionParameters

func MySQLProvisionParametersFactory 

func MySQLProvisionParametersFactory(
	Container *MySQLDatabaseContainerStruct,
	Masked *bool,
	MaskingJob string,
	Source *MySQLVirtualSourceStruct,
	SourceConfig *MySQLServerConfigStruct,
	TimeflowPointParameters TimeflowPointParameters,
) MySQLProvisionParametersStruct

MySQLProvisionParametersFactory is just a simple function to instantiate the MySQLProvisionParametersStruct

type MySQLReplicationCoordinates 

type MySQLReplicationCoordinates interface{}

MySQLReplicationCoordinates is an empty interface designed to function as the MySQLReplicationCoordinates API namespace

type MySQLServerConfigStruct 

type MySQLServerConfigStruct struct {
	// The password of the server instance user.
	// create = optional
	// update = optional
	Credentials *PasswordCredentialStruct `json:"credentials,omitempty"`
	// The data directory for the MySQL server instance.
	// create = optional
	DataDirectory string `json:"dataDirectory,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	// format = objectReference
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The port on which the MySQL server instance is listening.
	// create = required
	// update = optional
	// minimum = 1
	// maximum = 65535
	Port *int `json:"port,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// format = objectReference
	// referenceTo = /delphix-mysql-install.json
	// create = required
	// update = optional
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the server instance user.
	// maxLength = 256
	// update = optional
	User string `json:"user,omitempty"`
}

MySQLServerConfigStruct - Configuration information for a MySQL server instance. extends SourceConfig

func MySQLServerConfigFactory 

func MySQLServerConfigFactory(
	Credentials *PasswordCredentialStruct,
	DataDirectory string,
	Discovered *bool,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	Port *int,
	Reference string,
	Repository string,
	User string,
) MySQLServerConfigStruct

MySQLServerConfigFactory is just a simple function to instantiate the MySQLServerConfigStruct

type MySQLSnapshotRuntimeStruct 

type MySQLSnapshotRuntimeStruct struct {
	// True if this snapshot can be used as the basis for provisioning a
	// new TimeFlow.
	Provisionable *bool `json:"provisionable,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLSnapshotRuntimeStruct - Runtime (non-persistent) properties of a MySQL TimeFlow snapshot. extends SnapshotRuntime

func MySQLSnapshotRuntimeFactory 

func MySQLSnapshotRuntimeFactory(
	Provisionable *bool,
) MySQLSnapshotRuntimeStruct

MySQLSnapshotRuntimeFactory is just a simple function to instantiate the MySQLSnapshotRuntimeStruct

type MySQLSnapshotStruct 

type MySQLSnapshotStruct struct {
	// A value in the set {CONSISTENT, INCONSISTENT, CRASH_CONSISTENT}
	// indicating what type of recovery strategies must be invoked when
	// provisioning from this snapshot.
	Consistency string `json:"consistency,omitempty"`
	// Reference to the database of which this TimeFlow is a part.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Point in time at which this snapshot was created. This may be
	// different from the time corresponding to the TimeFlow.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// The location within the parent TimeFlow at which this snapshot was
	// initiated.
	FirstChangePoint *MySQLTimeflowPointStruct `json:"firstChangePoint,omitempty"`
	// Version of the source database at the time the snapshot was taken.
	InternalVersion *MySQLVersionStruct `json:"internalVersion,omitempty"`
	// The location of the snapshot within the parent TimeFlow
	// represented by this snapshot.
	LatestChangePoint *MySQLTimeflowPointStruct `json:"latestChangePoint,omitempty"`
	// Boolean value indicating if a virtual database provisioned from
	// this snapshot will be missing nologging changes.
	MissingNonLoggedData *bool `json:"missingNonLoggedData,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Retention policy, in days. A value of -1 indicates the snapshot
	// should be kept forever.
	// update = optional
	Retention *int `json:"retention,omitempty"`
	// Runtime properties of the snapshot.
	Runtime *MySQLSnapshotRuntimeStruct `json:"runtime,omitempty"`
	// Boolean value indicating that this snapshot is in a transient
	// state and should not be user visible.
	Temporary *bool `json:"temporary,omitempty"`
	// TimeFlow of which this snapshot is a part.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Time zone of the source database at the time the snapshot was
	// taken.
	Timezone string `json:"timezone,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of database source repository at the time the snapshot was
	// taken.
	Version string `json:"version,omitempty"`
}

MySQLSnapshotStruct - Provisionable snapshot of a MySQL TimeFlow. extends TimeflowSnapshot

func MySQLSnapshotFactory 

func MySQLSnapshotFactory(
	Consistency string,
	Container string,
	CreationTime string,
	FirstChangePoint *MySQLTimeflowPointStruct,
	InternalVersion *MySQLVersionStruct,
	LatestChangePoint *MySQLTimeflowPointStruct,
	MissingNonLoggedData *bool,
	Name string,
	Namespace string,
	Reference string,
	Retention *int,
	Runtime *MySQLSnapshotRuntimeStruct,
	Temporary *bool,
	Timeflow string,
	Timezone string,
	Version string,
) MySQLSnapshotStruct

MySQLSnapshotFactory is just a simple function to instantiate the MySQLSnapshotStruct

type MySQLSource 

type MySQLSource interface{}

MySQLSource is an empty interface designed to function as the MySQLSource API namespace

type MySQLSourceConnectionInfoStruct 

type MySQLSourceConnectionInfoStruct struct {
	// The data directory for the MySQL server.
	DataDirectory string `json:"dataDirectory,omitempty"`
	// The hostname or IP address of the host where the source resides.
	Host string `json:"host,omitempty"`
	// The JDBC string used to connect to the MySQL server instance.
	JdbcString string `json:"jdbcString,omitempty"`
	// The port on which the MySQL server for the data directory is
	// listening.
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the database user.
	User string `json:"user,omitempty"`
	// The database version string.
	Version string `json:"version,omitempty"`
}

MySQLSourceConnectionInfoStruct - Contains information that can be used to connect to a MySQL source. extends SourceConnectionInfo

func MySQLSourceConnectionInfoFactory 

func MySQLSourceConnectionInfoFactory(
	DataDirectory string,
	Host string,
	JdbcString string,
	Port *int,
	User string,
	Version string,
) MySQLSourceConnectionInfoStruct

MySQLSourceConnectionInfoFactory is just a simple function to instantiate the MySQLSourceConnectionInfoStruct

type MySQLSourceRuntimeStruct 

type MySQLSourceRuntimeStruct struct {
	// True if the source is JDBC accessible. If false then no properties
	// can be retrieved.
	Accessible *bool `json:"accessible,omitempty"`
	// The time that the 'accessible' propery was last checked.
	// format = date
	AccessibleTimestamp string `json:"accessibleTimestamp,omitempty"`
	// Size of the database in bytes.
	// units = B
	// base = 1024
	DatabaseSize float64 `json:"databaseSize,omitempty"`
	// Status indicating whether the source is enabled. A source has a
	// 'PARTIAL' status if its sub-sources are not all enabled.
	// enum = [ENABLED PARTIAL DISABLED]
	Enabled string `json:"enabled,omitempty"`
	// The reason why the source is not JDBC accessible.
	NotAccessibleReason string `json:"notAccessibleReason,omitempty"`
	// Status of the source. 'Unknown' if all attempts to connect to the
	// source failed.
	// enum = [RUNNING INACTIVE PENDING CANCELED FAILED CHECKING UNKNOWN]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLSourceRuntimeStruct - Non-persistent runtime properties of a MySQL source. extends SourceRuntime

func MySQLSourceRuntimeFactory 

func MySQLSourceRuntimeFactory(
	Accessible *bool,
	AccessibleTimestamp string,
	DatabaseSize float64,
	Enabled string,
	NotAccessibleReason string,
	Status string,
) MySQLSourceRuntimeStruct

MySQLSourceRuntimeFactory is just a simple function to instantiate the MySQLSourceRuntimeStruct

type MySQLStagingSourceStruct 

type MySQLStagingSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point for the NFS mounts on the staging host.
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A user-provided script to run after taking a snapshot.
	// create = optional
	// update = optional
	PostScript string `json:"postScript,omitempty"`
	// A user-provided script to run prior to taking a snapshot.
	// create = optional
	// update = optional
	PreScript string `json:"preScript,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *MySQLSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

MySQLStagingSourceStruct - A MySQL staging source used for validated sync. extends MySQLSource

func MySQLStagingSourceFactory 

func MySQLStagingSourceFactory(
	Config string,
	Container string,
	Description string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	PostScript string,
	PreScript string,
	Reference string,
	Runtime *MySQLSourceRuntimeStruct,
	Staging *bool,
	Status string,
	Virtual *bool,
) MySQLStagingSourceStruct

MySQLStagingSourceFactory is just a simple function to instantiate the MySQLStagingSourceStruct

type MySQLSyncParameters 

type MySQLSyncParameters interface{}

MySQLSyncParameters is an empty interface designed to function as the MySQLSyncParameters API namespace

type MySQLTimeflowPointStruct 

type MySQLTimeflowPointStruct struct {
	// The TimeFlow location.
	// create = optional
	Location string `json:"location,omitempty"`
	// Reference to TimeFlow containing this point.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-mysql-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// The logical time corresponding to the TimeFlow location.
	// create = optional
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLTimeflowPointStruct - A unique point within a MySQL database TimeFlow. extends TimeflowPoint

func MySQLTimeflowPointFactory 

func MySQLTimeflowPointFactory(
	Location string,
	Timeflow string,
	Timestamp string,
) MySQLTimeflowPointStruct

MySQLTimeflowPointFactory is just a simple function to instantiate the MySQLTimeflowPointStruct

type MySQLTimeflowStruct 

type MySQLTimeflowStruct struct {
	// Reference to the data container (database) for this TimeFlow.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// The source action that created the TimeFlow.
	// enum = [INITIAL INDETERMINATE REFRESH ROLLBACK TEMPORARY TRANSFORMATION V2P PDB_PLUG WAREHOUSE ORACLE_LIVE_SOURCE_RESYNC SOURCE_CONTINUITY]
	CreationType string `json:"creationType,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The origin point on the parent TimeFlow from which this TimeFlow
	// was provisioned. This will not be present for TimeFlows derived
	// from linked sources.
	ParentPoint *MySQLTimeflowPointStruct `json:"parentPoint,omitempty"`
	// Reference to the parent snapshot that serves as the provisioning
	// base for this object. This may be different from the snapshot
	// within the parent point, and is only present for virtual
	// TimeFlows.
	// format = objectReference
	// referenceTo = /delphix-timeflow-snapshot.json
	ParentSnapshot string `json:"parentSnapshot,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLTimeflowStruct - TimeFlow representing historical data for a particular timeline within a MySQL container. extends Timeflow

func MySQLTimeflowFactory 

func MySQLTimeflowFactory(
	Container string,
	CreationType string,
	Name string,
	Namespace string,
	ParentPoint *MySQLTimeflowPointStruct,
	ParentSnapshot string,
	Reference string,
) MySQLTimeflowStruct

MySQLTimeflowFactory is just a simple function to instantiate the MySQLTimeflowStruct

type MySQLVersionStruct 

type MySQLVersionStruct struct {
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// Variant of the MySQL installation.
	// enum = [CommunityServer MariaDB]
	Variant string `json:"variant,omitempty"`
	// Version of the MySQL installation.
	// format = mysqlVersion
	Version string `json:"version,omitempty"`
}

MySQLVersionStruct - Version of a MySQL installation. extends TypedObject

func MySQLVersionFactory 

func MySQLVersionFactory(
	Variant string,
	Version string,
) MySQLVersionStruct

MySQLVersionFactory is just a simple function to instantiate the MySQLVersionStruct

type MySQLVirtualSourceStruct 

type MySQLVirtualSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// create = required
	// update = optional
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// MySQL database configuration parameter overrides.
	// create = optional
	// update = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// create = optional
	// update = optional
	// default = false
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point for the NFS mounts.
	// maxLength = 256
	// create = required
	// update = optional
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *MySQLSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

MySQLVirtualSourceStruct - A virtual MySQL source. extends MySQLSource

func MySQLVirtualSourceFactory 

func MySQLVirtualSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	Config string,
	ConfigParams map[string]string,
	Container string,
	Description string,
	FileMappingRules string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	Operations *VirtualSourceOperationsStruct,
	Reference string,
	Runtime *MySQLSourceRuntimeStruct,
	Staging *bool,
	Status string,
	Virtual *bool,
) MySQLVirtualSourceStruct

MySQLVirtualSourceFactory is just a simple function to instantiate the MySQLVirtualSourceStruct

type MySQLXtraBackupSyncParametersStruct 

type MySQLXtraBackupSyncParametersStruct struct {
	// Path to the existing backup to be loaded.
	// required = true
	BackupLocation string `json:"backupLocation,omitempty"`
	// The coordinates corresponding to the MySQL backup to start
	// replication from.
	// create = optional
	ReplicationCoordinates MySQLReplicationCoordinates `json:"replicationCoordinates,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

MySQLXtraBackupSyncParametersStruct - The parameters to use as input to sync requests for MySQL databases using an existing XtraBackup backup. extends MySQLExistingBackupSyncParameters

func MySQLXtraBackupSyncParametersFactory 

func MySQLXtraBackupSyncParametersFactory(
	BackupLocation string,
	ReplicationCoordinates MySQLReplicationCoordinates,
) MySQLXtraBackupSyncParametersStruct

MySQLXtraBackupSyncParametersFactory is just a simple function to instantiate the MySQLXtraBackupSyncParametersStruct

type NTPConfigStruct 

type NTPConfigStruct struct {
	// If true, then time is synchronized with the configured NTP
	// servers. The management service is automatically restarted if this
	// value is changed.
	// update = optional
	// default = false
	Enabled *bool `json:"enabled,omitempty"`
	// Address to use for multicast NTP discovery. This is only valid
	// when 'useMulticast' is set.
	// default = 224.0.1.1
	// update = optional
	// format = ipv4Address
	MulticastAddress string `json:"multicastAddress,omitempty"`
	// A list of NTP servers to use for synchronization. At least one
	// server must be specified if multicast is not being used.
	// update = optional
	Servers []string `json:"servers,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// If true, discover NTP servers using multicast.
	// update = optional
	// default = false
	UseMulticast *bool `json:"useMulticast,omitempty"`
}

NTPConfigStruct - NTP (Network Time Protocol) configuration. extends TypedObject

func NTPConfigFactory 

func NTPConfigFactory(
	Enabled *bool,
	MulticastAddress string,
	Servers []string,
	UseMulticast *bool,
) NTPConfigStruct

NTPConfigFactory is just a simple function to instantiate the NTPConfigStruct

type NamedUserObject 

type NamedUserObject interface{}

NamedUserObject is an empty interface designed to function as the NamedUserObject API namespace

type NamespaceFailoverParametersStruct 

type NamespaceFailoverParametersStruct struct {
	// Enable automatic conflict resolution during failover.
	// create = optional
	// default = false
	SmartFailover *bool `json:"smartFailover,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NamespaceFailoverParametersStruct - The parameters to use as input to Namespace.failover. extends TypedObject

func NamespaceFailoverParametersFactory 

func NamespaceFailoverParametersFactory(
	SmartFailover *bool,
) NamespaceFailoverParametersStruct

NamespaceFailoverParametersFactory is just a simple function to instantiate the NamespaceFailoverParametersStruct

type NamespaceStruct 

type NamespaceStruct struct {
	// Description of this namespace.
	// update = optional
	// maxLength = 4096
	Description string `json:"description,omitempty"`
	// Indicates the namespace has been failed over into the live
	// environment.
	// default = false
	FailedOver *bool `json:"failedOver,omitempty"`
	// If failedOver is true, contains a report concern objects affected
	// during failover.
	FailoverReport string `json:"failoverReport,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Type of object namespace.
	// enum = [REPLICATION]
	NamespaceType string `json:"namespaceType,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// True if the source data stream was generated from a secure
	// replication spec.
	SecureNamespace *bool `json:"secureNamespace,omitempty"`
	// For replication, the source host IP address.
	Source string `json:"source,omitempty"`
	// A unique identifier for the source data stream.
	Tag string `json:"tag,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

NamespaceStruct - Object namespace for target-side replication. extends NamedUserObject

func NamespaceFactory 

func NamespaceFactory(
	Description string,
	FailedOver *bool,
	FailoverReport string,
	Name string,
	Namespace string,
	NamespaceType string,
	Reference string,
	SecureNamespace *bool,
	Source string,
	Tag string,
) NamespaceStruct

NamespaceFactory is just a simple function to instantiate the NamespaceStruct

type NetbackupConnectivityParametersStruct 

type NetbackupConnectivityParametersStruct struct {
	// Target environment to test NetBackup connectivity from.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// The environment user to use to connect to the environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// The name of the NetBackup master server to attempt to connect to.
	// required = true
	MasterServerName string `json:"masterServerName,omitempty"`
	// The name of the NetBackup client to attempt to connect with.
	// required = true
	SourceClientName string `json:"sourceClientName,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NetbackupConnectivityParametersStruct - Parameters needed to test NetBackup connectivity on an environment. extends TypedObject

func NetbackupConnectivityParametersFactory 

func NetbackupConnectivityParametersFactory(
	Environment string,
	EnvironmentUser string,
	MasterServerName string,
	SourceClientName string,
) NetbackupConnectivityParametersStruct

NetbackupConnectivityParametersFactory is just a simple function to instantiate the NetbackupConnectivityParametersStruct

type NetworkDSPTestParametersStruct 

type NetworkDSPTestParametersStruct struct {
	// The size of each transmit request in bytes.
	// maximum = 1.048576e+06
	// base = 1024
	// units = B
	// create = optional
	// default = 65536
	// minimum = 0
	BlockSize *int `json:"blockSize,omitempty"`
	// Whether or not compression is used for the test.
	// default = false
	// create = optional
	Compression *bool `json:"compression,omitempty"`
	// Whether the test is testing connectivity to a Delphix Engine or
	// remote host.
	// enum = [REMOTE_HOST DELPHIX_ENGINE]
	// default = REMOTE_HOST
	// create = optional
	DestinationType string `json:"destinationType,omitempty"`
	// Whether the test is a transmit or receive test.
	// enum = [TRANSMIT RECEIVE]
	// default = TRANSMIT
	// create = optional
	Direction string `json:"direction,omitempty"`
	// The duration of the test in seconds. Note that when numConnections
	// is 0, an initial period of time will be spent calculating the
	// optimal number of connections, and that time does not count toward
	// the duration of the test.
	// minimum = 1
	// maximum = 3600
	// default = 30
	// create = optional
	Duration *int `json:"duration,omitempty"`
	// Whether or not encryption is used for the test.
	// default = false
	// create = optional
	Encryption *bool `json:"encryption,omitempty"`
	// The number of connections to use for the test. The special value 0
	// (the default) causes the test to automatically discover and use
	// the optimal number of connections to use for maximum throughput.
	// create = optional
	// minimum = 0
	// maximum = 32
	// default = 0
	NumConnections *int `json:"numConnections,omitempty"`
	// The queue depth used for the DSP throughput test.
	// default = 32
	// minimum = 0
	// maximum = 4096
	// create = optional
	QueueDepth *int `json:"queueDepth,omitempty"`
	// The size of the receive socket buffer in bytes.
	// base = 1024
	// units = B
	// create = optional
	// default = 262144
	// minimum = 0
	// maximum = 1.6777216e+07
	ReceiveSocketBuffer *int `json:"receiveSocketBuffer,omitempty"`
	// Address, username and password used when running a test to another
	// Delphix Engine.
	// create = optional
	RemoteDelphixEngineInfo *RemoteDelphixEngineInfoStruct `json:"remoteDelphixEngineInfo,omitempty"`
	// The remote host for the test. The host must be part of an existing
	// environment.
	// format = objectReference
	// referenceTo = /delphix-host.json
	// create = optional
	RemoteHost string `json:"remoteHost,omitempty"`
	// The size of the send socket buffer in bytes.
	// default = 262144
	// minimum = 0
	// maximum = 1.6777216e+07
	// base = 1024
	// units = B
	// create = optional
	SendSocketBuffer *int `json:"sendSocketBuffer,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NetworkDSPTestParametersStruct - Parameters used to execute a network throughput test using the Delphix Session Protocol. extends NetworkThroughputTestBaseParameters

func NetworkDSPTestParametersFactory 

func NetworkDSPTestParametersFactory(
	BlockSize *int,
	Compression *bool,
	DestinationType string,
	Direction string,
	Duration *int,
	Encryption *bool,
	NumConnections *int,
	QueueDepth *int,
	ReceiveSocketBuffer *int,
	RemoteDelphixEngineInfo *RemoteDelphixEngineInfoStruct,
	RemoteHost string,
	SendSocketBuffer *int,
) NetworkDSPTestParametersStruct

NetworkDSPTestParametersFactory is just a simple function to instantiate the NetworkDSPTestParametersStruct

type NetworkDSPTestStruct 

type NetworkDSPTestStruct struct {
	// Time when the test ended.
	// format = date
	EndTime string `json:"endTime,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Number of connections used to achieve maximum sustained
	// throughput.
	NumConnections *int `json:"numConnections,omitempty"`
	// The parameters used to execute the test.
	Parameters *NetworkDSPTestParametersStruct `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The remote IP address used for the test.
	// format = ipAddress
	RemoteAddress string `json:"remoteAddress,omitempty"`
	// Time when the test was started.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// The state of the test.
	// enum = [RUNNING COMPLETED FAILED CANCELED]
	State string `json:"state,omitempty"`
	// Average throughput measured.
	// base = 1024
	// units = bps
	Throughput float64 `json:"throughput,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

NetworkDSPTestStruct - DSP throughput tests to a target system. extends NetworkThroughputTestBase cliVisibility = [DOMAIN SYSTEM]

func NetworkDSPTestFactory 

func NetworkDSPTestFactory(
	EndTime string,
	Name string,
	Namespace string,
	NumConnections *int,
	Parameters *NetworkDSPTestParametersStruct,
	Reference string,
	RemoteAddress string,
	StartTime string,
	State string,
	Throughput float64,
) NetworkDSPTestStruct

NetworkDSPTestFactory is just a simple function to instantiate the NetworkDSPTestStruct

type NetworkInterfaceStruct 

type NetworkInterfaceStruct struct {
	// List of IP addresses assigned to the interface.
	// update = optional
	Addresses []*InterfaceAddressStruct `json:"addresses,omitempty"`
	// The name of the device over which this interface is configured.
	Device string `json:"device,omitempty"`
	// The MAC address associated with this interface.
	// format = macAddress
	MacAddress string `json:"macAddress,omitempty"`
	// The maximum transmission unit for this interface.
	// update = optional
	Mtu *int `json:"mtu,omitempty"`
	// The range of possible values for the mtu property.
	MtuRange string `json:"mtuRange,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The state of the interface.
	// enum = [OK DOWN FAILED]
	State string `json:"state,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

NetworkInterfaceStruct - Configuration of an IP interface. extends UserObject cliVisibility = [DOMAIN SYSTEM]

func NetworkInterfaceFactory 

func NetworkInterfaceFactory(
	Addresses []*InterfaceAddressStruct,
	Device string,
	MacAddress string,
	Mtu *int,
	MtuRange string,
	Name string,
	Namespace string,
	Reference string,
	State string,
) NetworkInterfaceStruct

NetworkInterfaceFactory is just a simple function to instantiate the NetworkInterfaceStruct

type NetworkInterfaceUtilDatapointStreamStruct 

type NetworkInterfaceUtilDatapointStreamStruct struct {
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// Which network interface was utilized.
	NetworkInterface string `json:"networkInterface,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NetworkInterfaceUtilDatapointStreamStruct - A stream of datapoints from a NETWORK_INTERFACE_UTIL analytics slice. extends DatapointStream

func NetworkInterfaceUtilDatapointStreamFactory 

func NetworkInterfaceUtilDatapointStreamFactory(
	Datapoints []Datapoint,
	NetworkInterface string,
) NetworkInterfaceUtilDatapointStreamStruct

NetworkInterfaceUtilDatapointStreamFactory is just a simple function to instantiate the NetworkInterfaceUtilDatapointStreamStruct

type NetworkInterfaceUtilDatapointStruct 

type NetworkInterfaceUtilDatapointStruct struct {
	// Bytes received on the interface.
	InBytes *int `json:"inBytes,omitempty"`
	// Packets received on the interface.
	InPackets *int `json:"inPackets,omitempty"`
	// Bytes transmitted on the interface.
	OutBytes *int `json:"outBytes,omitempty"`
	// Packets transmitted on the interface.
	OutPackets *int `json:"outPackets,omitempty"`
	// The time this datapoint was collected.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NetworkInterfaceUtilDatapointStruct - An analytics datapoint generated by the NETWORK_INTERFACE_UTIL statistic type. extends Datapoint

func NetworkInterfaceUtilDatapointFactory 

func NetworkInterfaceUtilDatapointFactory(
	InBytes *int,
	InPackets *int,
	OutBytes *int,
	OutPackets *int,
	Timestamp string,
) NetworkInterfaceUtilDatapointStruct

NetworkInterfaceUtilDatapointFactory is just a simple function to instantiate the NetworkInterfaceUtilDatapointStruct

type NetworkLatencyTestParametersStruct 

type NetworkLatencyTestParametersStruct struct {
	// A hostname or literal IP address to test. Either remoteAddress or
	// remoteHost must be set, but not both.
	// format = host
	// create = optional
	RemoteAddress string `json:"remoteAddress,omitempty"`
	// The remote host for the test. The host must be part of an existing
	// environment.
	// format = objectReference
	// referenceTo = /delphix-host.json
	// create = optional
	RemoteHost string `json:"remoteHost,omitempty"`
	// Number of requests to send.
	// minimum = 1
	// maximum = 3600
	// default = 20
	// create = optional
	RequestCount *int `json:"requestCount,omitempty"`
	// The size of requests to send (bytes).
	// units = B
	// base = 1024
	// minimum = 8
	// maximum = 65507
	// default = 8
	// create = optional
	RequestSize *int `json:"requestSize,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

NetworkLatencyTestParametersStruct - Parameters used to execute a network latency test. extends NetworkTestParameters

func NetworkLatencyTestParametersFactory 

func NetworkLatencyTestParametersFactory(
	RemoteAddress string,
	RemoteHost string,
	RequestCount *int,
	RequestSize *int,
) NetworkLatencyTestParametersStruct

NetworkLatencyTestParametersFactory is just a simple function to instantiate the NetworkLatencyTestParametersStruct

type NetworkLatencyTestStruct 

type NetworkLatencyTestStruct struct {
	// Average measured round-trip time (usec).
	// units = usec
	Average *int `json:"average,omitempty"`
	// Time when the test ended.
	// format = date
	EndTime string `json:"endTime,omitempty"`
	// Percentage of requests or replies lost.
	Loss *int `json:"loss,omitempty"`
	// Maximum measured round-trip time (usec).
	// units = usec
	Maximum *int `json:"maximum,omitempty"`
	// Minimum measured round-trip time (usec).
	// units = usec
	Minimum *int `json:"minimum,omitempty"`
	// Object name.
	// update = readonly
	// create = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The parameters used to execute the test.
	Parameters *NetworkLatencyTestParametersStruct `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The remote IP address used for the test.
	// format = ipAddress
	RemoteAddress string `json:"remoteAddress,omitempty"`
	// Time when the test was started.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// The state of the test.
	// enum = [RUNNING COMPLETED FAILED CANCELED]
	State string `json:"state,omitempty"`
	// Standard deviation (usec).
	// units = usec
	Stddev *int `json:"stddev,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NetworkLatencyTestStruct - Round-trip latency tests to a target system. extends NetworkTest cliVisibility = [DOMAIN SYSTEM]

func NetworkLatencyTestFactory 

func NetworkLatencyTestFactory(
	Average *int,
	EndTime string,
	Loss *int,
	Maximum *int,
	Minimum *int,
	Name string,
	Namespace string,
	Parameters *NetworkLatencyTestParametersStruct,
	Reference string,
	RemoteAddress string,
	StartTime string,
	State string,
	Stddev *int,
) NetworkLatencyTestStruct

NetworkLatencyTestFactory is just a simple function to instantiate the NetworkLatencyTestStruct

type NetworkRouteLookupParametersStruct 

type NetworkRouteLookupParametersStruct struct {
	// Destination address or hostname.
	// format = host
	// create = required
	Destination string `json:"destination,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NetworkRouteLookupParametersStruct - Parameters used for a routing table lookup. extends TypedObject

func NetworkRouteLookupParametersFactory 

func NetworkRouteLookupParametersFactory(
	Destination string,
) NetworkRouteLookupParametersStruct

NetworkRouteLookupParametersFactory is just a simple function to instantiate the NetworkRouteLookupParametersStruct

type NetworkRouteStruct 

type NetworkRouteStruct struct {
	// Destination for the route in Classless Inter-Domain Routing (CIDR)
	// notation or the keyword 'default'.
	// create = required
	// format = routeDestination
	Destination string `json:"destination,omitempty"`
	// Next hop for the route.
	// format = ipAddress
	// create = required
	Gateway string `json:"gateway,omitempty"`
	// Output interface to use for the route.
	// format = objectReference
	// referenceTo = /delphix-network-interface.json
	// create = optional
	OutInterface string `json:"outInterface,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NetworkRouteStruct - IP routing table. extends TypedObject cliVisibility = [DOMAIN SYSTEM]

func NetworkRouteFactory 

func NetworkRouteFactory(
	Destination string,
	Gateway string,
	OutInterface string,
) NetworkRouteStruct

NetworkRouteFactory is just a simple function to instantiate the NetworkRouteStruct

type NetworkTest 

type NetworkTest interface{}

NetworkTest is an empty interface designed to function as the NetworkTest API namespace

type NetworkTestParameters 

type NetworkTestParameters interface{}

NetworkTestParameters is an empty interface designed to function as the NetworkTestParameters API namespace

type NetworkThroughputTestBase 

type NetworkThroughputTestBase interface{}

NetworkThroughputTestBase is an empty interface designed to function as the NetworkThroughputTestBase API namespace

type NetworkThroughputTestBaseParameters 

type NetworkThroughputTestBaseParameters interface{}

NetworkThroughputTestBaseParameters is an empty interface designed to function as the NetworkThroughputTestBaseParameters API namespace

type NetworkThroughputTestParametersStruct 

type NetworkThroughputTestParametersStruct struct {
	// The size of each transmit request in bytes.
	// maximum = 1.048576e+06
	// base = 1024
	// units = B
	// create = optional
	// default = 131072
	// minimum = 0
	BlockSize *int `json:"blockSize,omitempty"`
	// Whether the test is a transmit or receive test.
	// enum = [TRANSMIT RECEIVE]
	// default = TRANSMIT
	// create = optional
	Direction string `json:"direction,omitempty"`
	// The duration of the test in seconds. Note that when numConnections
	// is 0, an initial period of time will be spent calculating the
	// optimal number of connections, and that time does not count toward
	// the duration of the test.
	// default = 30
	// create = optional
	// minimum = 1
	// maximum = 3600
	Duration *int `json:"duration,omitempty"`
	// The number of connections to use for the test. The special value 0
	// (the default) causes the test to automatically discover and use
	// the optimal number of connections to use for maximum throughput.
	// minimum = 0
	// maximum = 32
	// default = 0
	// create = optional
	NumConnections *int `json:"numConnections,omitempty"`
	// The TCP port number that the server (the receiver) will be
	// listening on.
	// minimum = 1
	// maximum = 65535
	// create = optional
	Port *int `json:"port,omitempty"`
	// A hostname or literal IP address to test. This parameter is
	// optional and can be provided if the remoteHost has multiple
	// addresses.
	// format = host
	// create = optional
	RemoteAddress string `json:"remoteAddress,omitempty"`
	// The remote host for the test. The host must be part of an existing
	// environment. If the host has multiple addresses and remoteAddress
	// is not specified, then the default address used when adding the
	// host will be used.
	// create = required
	// format = objectReference
	// referenceTo = /delphix-host.json
	RemoteHost string `json:"remoteHost,omitempty"`
	// The size of the send socket buffer in bytes.
	// base = 1024
	// units = B
	// create = optional
	// default = 4.194304e+06
	// minimum = 0
	// maximum = 1.6777216e+07
	SendSocketBuffer *int `json:"sendSocketBuffer,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NetworkThroughputTestParametersStruct - Parameters used to execute a network throughput test. extends NetworkThroughputTestBaseParameters

func NetworkThroughputTestParametersFactory 

func NetworkThroughputTestParametersFactory(
	BlockSize *int,
	Direction string,
	Duration *int,
	NumConnections *int,
	Port *int,
	RemoteAddress string,
	RemoteHost string,
	SendSocketBuffer *int,
) NetworkThroughputTestParametersStruct

NetworkThroughputTestParametersFactory is just a simple function to instantiate the NetworkThroughputTestParametersStruct

type NetworkThroughputTestStruct 

type NetworkThroughputTestStruct struct {
	// Time when the test ended.
	// format = date
	EndTime string `json:"endTime,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Number of connections used to achieve maximum sustained
	// throughput.
	NumConnections *int `json:"numConnections,omitempty"`
	// The parameters used to execute the test.
	Parameters *NetworkThroughputTestParametersStruct `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The remote IP address used for the test.
	// format = ipAddress
	RemoteAddress string `json:"remoteAddress,omitempty"`
	// Time when the test was started.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// The state of the test.
	// enum = [RUNNING COMPLETED FAILED CANCELED]
	State string `json:"state,omitempty"`
	// Average throughput measured.
	// units = bps
	// base = 1024
	Throughput float64 `json:"throughput,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

NetworkThroughputTestStruct - Bi-directional throughput tests to a target system. extends NetworkThroughputTestBase cliVisibility = [DOMAIN SYSTEM]

func NetworkThroughputTestFactory 

func NetworkThroughputTestFactory(
	EndTime string,
	Name string,
	Namespace string,
	NumConnections *int,
	Parameters *NetworkThroughputTestParametersStruct,
	Reference string,
	RemoteAddress string,
	StartTime string,
	State string,
	Throughput float64,
) NetworkThroughputTestStruct

NetworkThroughputTestFactory is just a simple function to instantiate the NetworkThroughputTestStruct

type NfsOpsDatapointStreamStruct 

type NfsOpsDatapointStreamStruct struct {
	// Whether reads were cached.
	Cached *bool `json:"cached,omitempty"`
	// Address of the client.
	// format = host
	Client string `json:"client,omitempty"`
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// I/O operation type.
	// enum = [read write]
	Op string `json:"op,omitempty"`
	// Path of the affected file.
	// format = unixpath
	Path string `json:"path,omitempty"`
	// Whether writes were synchronous.
	Sync *bool `json:"sync,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

NfsOpsDatapointStreamStruct - A stream of datapoints from an NFS_OPS analytics slice. extends DatapointStream

func NfsOpsDatapointStreamFactory 

func NfsOpsDatapointStreamFactory(
	Cached *bool,
	Client string,
	Datapoints []Datapoint,
	Op string,
	Path string,
	Sync *bool,
) NfsOpsDatapointStreamStruct

NfsOpsDatapointStreamFactory is just a simple function to instantiate the NfsOpsDatapointStreamStruct

type NoBackupIngestionStrategyStruct 

type NoBackupIngestionStrategyStruct struct {
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

NoBackupIngestionStrategyStruct - This linked source has no ingestion strategy meaning ValidatedSync is disabled and it is not Delphix managed. extends IngestionStrategy

func NoBackupIngestionStrategyFactory 

func NoBackupIngestionStrategyFactory() NoBackupIngestionStrategyStruct

NoBackupIngestionStrategyFactory is just a simple function to instantiate the NoBackupIngestionStrategyStruct

type NotFilterStruct 

type NotFilterStruct struct {
	// Filter whose logic is to be inverted.
	// create = required
	// update = optional
	// properties = map[type:map[default:SeverityFilter]]
	SubFilter AlertFilter `json:"subFilter,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NotFilterStruct - A container filter that inverts the logic of another filter. extends AlertFilter

func NotFilterFactory 

func NotFilterFactory(
	SubFilter AlertFilter,
) NotFilterStruct

NotFilterFactory is just a simple function to instantiate the NotFilterStruct

type Notification 

type Notification interface{}

Notification is an empty interface designed to function as the Notification API namespace

type NotificationDropStruct 

type NotificationDropStruct struct {
	// The number of notifications which were dropped since the last
	// notifications were pulled. If this is greater than zero, you may
	// want to refresh your view of the data to ensure everything is up
	// to date.
	DropCount *int `json:"dropCount,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NotificationDropStruct - An object to track dropped notifications. extends Notification

func NotificationDropFactory 

func NotificationDropFactory(
	DropCount *int,
) NotificationDropStruct

NotificationDropFactory is just a simple function to instantiate the NotificationDropStruct

type NullConstraintStruct 

type NullConstraintStruct struct {
	// The name of the axis being constrained.
	// create = required
	AxisName string `json:"axisName,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

NullConstraintStruct - If an axis has this type of constraint, it means that no constraints can be placed on this axis. This constraint type does nothing and has no descendent types. extends AxisConstraint

func NullConstraintFactory 

func NullConstraintFactory(
	AxisName string,
) NullConstraintStruct

NullConstraintFactory is just a simple function to instantiate the NullConstraintStruct

type OKResultStruct 

type OKResultStruct struct {
	// Reference to the action associated with the operation, if any.
	// format = objectReference
	// referenceTo = /delphix-action.json
	Action string `json:"action,omitempty"`
	// Reference to the job started by the operation, if any.
	// referenceTo = /delphix-job.json
	// format = objectReference
	Job string `json:"job,omitempty"`
	// Result of the operation. This will be specific to the API being
	// invoked.
	Result interface{} `json:"result,omitempty"`
	// Indicates whether an error occurred during the call.
	// enum = [OK ERROR]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OKResultStruct - Result of a successful API call. extends CallResult

func OKResultFactory 

func OKResultFactory(
	Action string,
	Job string,
	Result interface{},
	Status string,
) OKResultStruct

OKResultFactory is just a simple function to instantiate the OKResultStruct

type ObjectNotificationStruct 

type ObjectNotificationStruct struct {
	// Type of operation on the object.
	// enum = [CREATE UPDATE DELETE]
	EventType string `json:"eventType,omitempty"`
	// Target object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Object string `json:"object,omitempty"`
	// Type of target object.
	// format = type
	ObjectType string `json:"objectType,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

ObjectNotificationStruct - An event indicating a change to an object on the system. extends Notification

func ObjectNotificationFactory 

func ObjectNotificationFactory(
	EventType string,
	Object string,
	ObjectType string,
) ObjectNotificationStruct

ObjectNotificationFactory is just a simple function to instantiate the ObjectNotificationStruct

type Operation 

type Operation interface{}

Operation is an empty interface designed to function as the Operation API namespace

type OperationTemplateStruct 

type OperationTemplateStruct struct {
	// User provided description for this template.
	// update = optional
	// create = optional
	Description string `json:"description,omitempty"`
	// Most recently modified time.
	// format = date
	LastUpdated string `json:"lastUpdated,omitempty"`
	// The name clients should use when setting the parameter's value.
	// create = required
	// update = optional
	// minLength = 1
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Template contents.
	// create = required
	// update = optional
	Operation SourceOperation `json:"operation,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OperationTemplateStruct - Template for commonly used operations. extends NamedUserObject

func OperationTemplateFactory 

func OperationTemplateFactory(
	Description string,
	LastUpdated string,
	Name string,
	Namespace string,
	Operation SourceOperation,
	Reference string,
) OperationTemplateStruct

OperationTemplateFactory is just a simple function to instantiate the OperationTemplateStruct

type OrFilterStruct 

type OrFilterStruct struct {
	// Filters which are combined together using OR logic.
	// create = required
	// update = optional
	// minItems = 2
	SubFilters []AlertFilter `json:"subFilters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OrFilterStruct - A container filter that combines other filters together using OR logic. extends AlertFilter

func OrFilterFactory 

func OrFilterFactory(
	SubFilters []AlertFilter,
) OrFilterStruct

OrFilterFactory is just a simple function to instantiate the OrFilterStruct

type OracleActiveInstanceStruct 

type OracleActiveInstanceStruct struct {
	// The name of the host the instance runs on.
	HostName string `json:"hostName,omitempty"`
	// The name of the Oracle instance.
	InstanceName string `json:"instanceName,omitempty"`
	// The number of the Oracle instance.
	InstanceNumber *int `json:"instanceNumber,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleActiveInstanceStruct - Active instance information for an Oracle database. extends TypedObject

func OracleActiveInstanceFactory 

func OracleActiveInstanceFactory(
	HostName string,
	InstanceName string,
	InstanceNumber *int,
) OracleActiveInstanceStruct

OracleActiveInstanceFactory is just a simple function to instantiate the OracleActiveInstanceStruct

type OracleAddLiveSourceParametersStruct 

type OracleAddLiveSourceParametersStruct struct {
	// The security credential of the privileged user to run the
	// LiveSource creation operation as.
	// create = optional
	Credential Credential `json:"credential,omitempty"`
	// The source that describes the LiveSource.
	// required = true
	Source *OracleLiveSourceStruct `json:"source,omitempty"`
	// The source config of the LiveSource.
	// required = true
	SourceConfig OracleDBConfig `json:"sourceConfig,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the LiveSource creation
	// operation as.
	// create = optional
	Username string `json:"username,omitempty"`
}

OracleAddLiveSourceParametersStruct - The parameters to use as input to convert an Oracle dSource to an Oracle LiveSource. extends AddLiveSourceParameters

func OracleAddLiveSourceParametersFactory 

func OracleAddLiveSourceParametersFactory(
	Credential Credential,
	Source *OracleLiveSourceStruct,
	SourceConfig OracleDBConfig,
	Username string,
) OracleAddLiveSourceParametersStruct

OracleAddLiveSourceParametersFactory is just a simple function to instantiate the OracleAddLiveSourceParametersStruct

type OracleAttachDataStruct 

type OracleAttachDataStruct struct {
	// Defines whether backup level is enabled.
	// create = optional
	BackupLevelEnabled *bool `json:"backupLevelEnabled,omitempty"`
	// Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A
	// value of 0 means no limit.
	// create = optional
	// minimum = 0
	// default = 0
	BandwidthLimit *int `json:"bandwidthLimit,omitempty"`
	// True if extended block checking should be used for this linked
	// database.
	// default = false
	// create = optional
	CheckLogical *bool `json:"checkLogical,omitempty"`
	// True if SnapSync data from the source should be compressed over
	// the network. Enabling this feature will reduce network bandwidth
	// consumption and may significantly improve throughput, especially
	// over slow network.
	// default = true
	// create = optional
	CompressedLinkingEnabled *bool `json:"compressedLinkingEnabled,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-oracle-db-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The password for the DB user.
	// required = true
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The name of the DB user.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// True if two SnapSyncs should be performed in immediate succession
	// to reduce the number of logs required to provision the snapshot.
	// This may significantly reduce the time necessary to provision from
	// a snapshot.
	// default = false
	// create = optional
	DoubleSync *bool `json:"doubleSync,omitempty"`
	// True if SnapSync data from the source should be retrieved through
	// an encrypted connection. Enabling this feature can decrease the
	// performance of SnapSync from the source but has no impact on the
	// performance of VDBs created from the retrieved data.
	// default = false
	// create = optional
	EncryptedLinkingEnabled *bool `json:"encryptedLinkingEnabled,omitempty"`
	// Information about the OS user to use for linking.
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	// format = objectReference
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// External file path.
	// maxLength = 1024
	// create = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Number of data files to include in each RMAN backup set.
	// minimum = 1
	// maximum = 64
	// default = 5
	// create = optional
	FilesPerSet *int `json:"filesPerSet,omitempty"`
	// True if attach should succeed even if the resetlogs of the
	// original database does not match the resetlogs of the new database
	// and the resetlogs information of the original database is not a
	// parent incarnation of the current resetlogs. This can happen when
	// the controlfile has been recreated and the incarnation table is
	// incomplete. Use this option with extreme caution. Attached
	// database must be the same database to avoid data corruption later
	// on.
	// default = false
	// create = optional
	Force *bool `json:"force,omitempty"`
	// True if initial load should be done immediately.
	// default = false
	// create = optional
	LinkNow *bool `json:"linkNow,omitempty"`
	// Total number of transport connections to use during SnapSync.
	// default = 1
	// minimum = 1
	// maximum = 16
	// create = optional
	NumberOfConnections *int `json:"numberOfConnections,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// Number of parallel channels to use.
	// minimum = 1
	// maximum = 32
	// default = 2
	// create = optional
	RmanChannels *int `json:"rmanChannels,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleAttachDataStruct - Represents parameters to attach non-pluggable Oracle databases. extends OracleBaseAttachData

func OracleAttachDataFactory 

func OracleAttachDataFactory(
	BackupLevelEnabled *bool,
	BandwidthLimit *int,
	CheckLogical *bool,
	CompressedLinkingEnabled *bool,
	Config string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	DoubleSync *bool,
	EncryptedLinkingEnabled *bool,
	EnvironmentUser string,
	ExternalFilePath string,
	FilesPerSet *int,
	Force *bool,
	LinkNow *bool,
	NumberOfConnections *int,
	Operations *LinkedSourceOperationsStruct,
	RmanChannels *int,
) OracleAttachDataStruct

OracleAttachDataFactory is just a simple function to instantiate the OracleAttachDataStruct

type OracleBaseAttachData 

type OracleBaseAttachData interface{}

OracleBaseAttachData is an empty interface designed to function as the OracleBaseAttachData API namespace

type OracleBaseDBConfig 

type OracleBaseDBConfig interface{}

OracleBaseDBConfig is an empty interface designed to function as the OracleBaseDBConfig API namespace

type OracleBaseLinkData 

type OracleBaseLinkData interface{}

OracleBaseLinkData is an empty interface designed to function as the OracleBaseLinkData API namespace

type OracleBaseProvisionParameters 

type OracleBaseProvisionParameters interface{}

OracleBaseProvisionParameters is an empty interface designed to function as the OracleBaseProvisionParameters API namespace

type OracleBaseSourceRuntime 

type OracleBaseSourceRuntime interface{}

OracleBaseSourceRuntime is an empty interface designed to function as the OracleBaseSourceRuntime API namespace

type OracleCharacterSetStruct 

type OracleCharacterSetStruct struct {
	// Name of character set.
	CharacterSet string `json:"characterSet,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleCharacterSetStruct - Represents an Oracle character set. extends TypedObject

func OracleCharacterSetFactory 

func OracleCharacterSetFactory(
	CharacterSet string,
) OracleCharacterSetStruct

OracleCharacterSetFactory is just a simple function to instantiate the OracleCharacterSetStruct

type OracleClusterCreateParametersStruct 

type OracleClusterCreateParametersStruct struct {
	// The representation of the cluster object.
	// create = required
	Cluster *OracleClusterStruct `json:"cluster,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to the created source
	// environment.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Only one node is allowed for the add cluster operation. Additional
	// nodes will be discovered automatically. Any nodes not discovered
	// by Delphix can be manually added after cluster creation.
	// create = required
	Node *OracleClusterNodeCreateParametersStruct `json:"node,omitempty"`
	// The primary user associated with the environment.
	// create = required
	PrimaryUser *EnvironmentUserStruct `json:"primaryUser,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleClusterCreateParametersStruct - The parameters used for the oracle cluster create operation. extends SourceEnvironmentCreateParameters

func OracleClusterCreateParametersFactory 

func OracleClusterCreateParametersFactory(
	Cluster *OracleClusterStruct,
	LogCollectionEnabled *bool,
	Node *OracleClusterNodeCreateParametersStruct,
	PrimaryUser *EnvironmentUserStruct,
) OracleClusterCreateParametersStruct

OracleClusterCreateParametersFactory is just a simple function to instantiate the OracleClusterCreateParametersStruct

type OracleClusterNodeCreateParametersStruct 

type OracleClusterNodeCreateParametersStruct struct {
	// The cluster to which the node belongs.
	// create = optional
	// format = objectReference
	// referenceTo = /delphix-oracle-cluster.json
	Cluster string `json:"cluster,omitempty"`
	// The host object associated with the cluster node.
	// create = required
	HostParameters HostCreateParameters `json:"hostParameters,omitempty"`
	// The name of the cluster node.
	// create = optional
	Name string `json:"name,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The list of virtual IPs belonging to this node.
	// create = optional
	VirtualIPs []*OracleVirtualIPStruct `json:"virtualIPs,omitempty"`
}

OracleClusterNodeCreateParametersStruct - The parameters used for oracle cluster node operations. extends TypedObject

func OracleClusterNodeCreateParametersFactory 

func OracleClusterNodeCreateParametersFactory(
	Cluster string,
	HostParameters HostCreateParameters,
	Name string,
	VirtualIPs []*OracleVirtualIPStruct,
) OracleClusterNodeCreateParametersStruct

OracleClusterNodeCreateParametersFactory is just a simple function to instantiate the OracleClusterNodeCreateParametersStruct

type OracleClusterNodeStruct 

type OracleClusterNodeStruct struct {
	// The reference to the parent cluster environment.
	// format = objectReference
	// referenceTo = /delphix-oracle-cluster.json
	Cluster string `json:"cluster,omitempty"`
	// Indicates whether the node is discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// Indicates whether the node is enabled.
	// update = optional
	Enabled *bool `json:"enabled,omitempty"`
	// The reference to the associated host object.
	// format = objectReference
	// referenceTo = /delphix-host.json
	Host string `json:"host,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The list of virtual IPs belonging to this node.
	// update = optional
	VirtualIPs []*OracleVirtualIPStruct `json:"virtualIPs,omitempty"`
}

OracleClusterNodeStruct - The representation of an oracle cluster node object. extends NamedUserObject

func OracleClusterNodeFactory 

func OracleClusterNodeFactory(
	Cluster string,
	Discovered *bool,
	Enabled *bool,
	Host string,
	Name string,
	Namespace string,
	Reference string,
	VirtualIPs []*OracleVirtualIPStruct,
) OracleClusterNodeStruct

OracleClusterNodeFactory is just a simple function to instantiate the OracleClusterNodeStruct

type OracleClusterStruct 

type OracleClusterStruct struct {
	// A reference to the cluster user.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// update = optional
	ClusterUser string `json:"clusterUser,omitempty"`
	// The location of the cluster installation.
	// create = required
	// update = optional
	// maxLength = 256
	CrsClusterHome string `json:"crsClusterHome,omitempty"`
	// The name of the cluster.
	// create = optional
	// maxLength = 15
	CrsClusterName string `json:"crsClusterName,omitempty"`
	// The environment description.
	// create = optional
	// update = optional
	// maxLength = 1024
	Description string `json:"description,omitempty"`
	// Indicates whether the source environment is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source
	// environment.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A reference to the primary user for this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// update = optional
	PrimaryUser string `json:"primaryUser,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The default remote_listener parameter to be used for databases on
	// the cluster.
	// create = optional
	// update = optional
	// maxLength = 256
	RemoteListener string `json:"remoteListener,omitempty"`
	// The Single Client Access Name of the cluster (11.2 and greater
	// clusters only).
	// update = optional
	// maxLength = 256
	Scan string `json:"scan,omitempty"`
	// Indicates whether the Single Client Access Name of the cluster is
	// manually configured.
	ScanManual *bool `json:"scanManual,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The version of the cluster.
	// create = optional
	// maxLength = 14
	Version string `json:"version,omitempty"`
}

OracleClusterStruct - The representation of an oracle cluster environment object. extends SourceEnvironment

func OracleClusterFactory 

func OracleClusterFactory(
	ClusterUser string,
	CrsClusterHome string,
	CrsClusterName string,
	Description string,
	Enabled *bool,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	PrimaryUser string,
	Reference string,
	RemoteListener string,
	Scan string,
	ScanManual *bool,
	Version string,
) OracleClusterStruct

OracleClusterFactory is just a simple function to instantiate the OracleClusterStruct

type OracleCompatibilityCriteriaStruct 

type OracleCompatibilityCriteriaStruct struct {
	// Selected repositories are installed on a host with this
	// architecture (32-bit or 64-bit).
	Architecture *int `json:"architecture,omitempty"`
	// Selected repositories are installed on this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// Selected repositories are installed on a host with this OS.
	// enum = [Linux AIX HPUX SunOS Windows]
	Os string `json:"os,omitempty"`
	// Selected repositories are installed on a host with this type of
	// processor.
	// enum = [x86 ia64 powerpc sparc]
	Processor string `json:"processor,omitempty"`
	// If true, selected repositories have staging enabled.
	StagingEnabled *bool `json:"stagingEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Selected repositories are this database version. In case of
	// upgrade, selected repositories are strictly greater than this
	// database version.
	Version string `json:"version,omitempty"`
}

OracleCompatibilityCriteriaStruct - The compatibility criteria to use for selecting compatible Oracle repositories. extends CompatibilityCriteria

func OracleCompatibilityCriteriaFactory 

func OracleCompatibilityCriteriaFactory(
	Architecture *int,
	Environment string,
	Os string,
	Processor string,
	StagingEnabled *bool,
	Version string,
) OracleCompatibilityCriteriaStruct

OracleCompatibilityCriteriaFactory is just a simple function to instantiate the OracleCompatibilityCriteriaStruct

type OracleCreateTransformationParametersStruct 

type OracleCreateTransformationParametersStruct struct {
	// The container that will contain the transformed data associated
	// with the newly created transformation; the "transformation
	// container".
	// create = required
	Container *OracleDatabaseContainerStruct `json:"container,omitempty"`
	// Reference to the user used during application of the
	// transformation.
	// create = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Operations to perform when this transformation is applied.
	// create = required
	Operations []SourceOperation `json:"operations,omitempty"`
	// Reference to the repository used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	// create = required
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleCreateTransformationParametersStruct - Represents the parameters of a createTransformation request for an Oracle container. extends CreateTransformationParameters

func OracleCreateTransformationParametersFactory 

func OracleCreateTransformationParametersFactory(
	Container *OracleDatabaseContainerStruct,
	EnvironmentUser string,
	Operations []SourceOperation,
	Repository string,
) OracleCreateTransformationParametersStruct

OracleCreateTransformationParametersFactory is just a simple function to instantiate the OracleCreateTransformationParametersStruct

type OracleCustomEnvVar 

type OracleCustomEnvVar interface{}

OracleCustomEnvVar is an empty interface designed to function as the OracleCustomEnvVar API namespace

type OracleCustomEnvVarFile 

type OracleCustomEnvVarFile interface{}

OracleCustomEnvVarFile is an empty interface designed to function as the OracleCustomEnvVarFile API namespace

type OracleCustomEnvVarPair 

type OracleCustomEnvVarPair interface{}

OracleCustomEnvVarPair is an empty interface designed to function as the OracleCustomEnvVarPair API namespace

type OracleCustomEnvVarRACFileStruct 

type OracleCustomEnvVarRACFileStruct struct {
	// The cluster node on which the target environment file exists.
	// referenceTo = /delphix-oracle-cluster-node.json
	// required = true
	// format = objectReference
	ClusterNode string `json:"clusterNode,omitempty"`
	// A string of whitespace-separated parameters to be passed to the
	// source command. The first parameter must be an absolute path to a
	// file that exists on the target environment. Every subsequent
	// parameter will be treated as an argument interpreted by the
	// environment file.
	// required = true
	PathParameters string `json:"pathParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleCustomEnvVarRACFileStruct - Dictates an environment file to be sourced when the Delphix Engine administers an Oracle virtual database. This environment file must be available on the target environment. This type also includes parameters which will be passed to the environment file when it is sourced. For a RAC environment, the cluster node where the target environment file exists must also be specified. extends OracleCustomEnvVarFile

func OracleCustomEnvVarRACFileFactory 

func OracleCustomEnvVarRACFileFactory(
	ClusterNode string,
	PathParameters string,
) OracleCustomEnvVarRACFileStruct

OracleCustomEnvVarRACFileFactory is just a simple function to instantiate the OracleCustomEnvVarRACFileStruct

type OracleCustomEnvVarRACPairStruct 

type OracleCustomEnvVarRACPairStruct struct {
	// The cluster node on which the environment variable is relevant.
	// format = objectReference
	// referenceTo = /delphix-oracle-cluster-node.json
	// required = true
	ClusterNode string `json:"clusterNode,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the environment variable.
	// format = envvarIdentifier
	// required = true
	VarName string `json:"varName,omitempty"`
	// The value of the environment variable.
	// required = true
	VarValue string `json:"varValue,omitempty"`
}

OracleCustomEnvVarRACPairStruct - Dictates a single environment variable name and value to be set when the Delphix Engine administers an Oracle virtual database. For a RAC environment, the cluster node where the target pair is valid must also be specified. extends OracleCustomEnvVarPair

func OracleCustomEnvVarRACPairFactory 

func OracleCustomEnvVarRACPairFactory(
	ClusterNode string,
	VarName string,
	VarValue string,
) OracleCustomEnvVarRACPairStruct

OracleCustomEnvVarRACPairFactory is just a simple function to instantiate the OracleCustomEnvVarRACPairStruct

type OracleCustomEnvVarSIFileStruct 

type OracleCustomEnvVarSIFileStruct struct {
	// A string of whitespace-separated parameters to be passed to the
	// source command. The first parameter must be an absolute path to a
	// file that exists on the target environment. Every subsequent
	// parameter will be treated as an argument interpreted by the
	// environment file.
	// required = true
	PathParameters string `json:"pathParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleCustomEnvVarSIFileStruct - Dictates an environment file to be sourced when the Delphix Engine administers an Oracle virtual database. This environment file must be available on the target environment. This type also includes parameters which will be passed to the environment file when it is sourced. extends OracleCustomEnvVarFile

func OracleCustomEnvVarSIFileFactory 

func OracleCustomEnvVarSIFileFactory(
	PathParameters string,
) OracleCustomEnvVarSIFileStruct

OracleCustomEnvVarSIFileFactory is just a simple function to instantiate the OracleCustomEnvVarSIFileStruct

type OracleCustomEnvVarSIPairStruct 

type OracleCustomEnvVarSIPairStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the environment variable.
	// required = true
	// format = envvarIdentifier
	VarName string `json:"varName,omitempty"`
	// The value of the environment variable.
	// required = true
	VarValue string `json:"varValue,omitempty"`
}

OracleCustomEnvVarSIPairStruct - Dictates a single environment variable name and value to be set when the Delphix Engine administers an Oracle virtual database. extends OracleCustomEnvVarPair

func OracleCustomEnvVarSIPairFactory 

func OracleCustomEnvVarSIPairFactory(
	VarName string,
	VarValue string,
) OracleCustomEnvVarSIPairStruct

OracleCustomEnvVarSIPairFactory is just a simple function to instantiate the OracleCustomEnvVarSIPairStruct

type OracleDBConfig 

type OracleDBConfig interface{}

OracleDBConfig is an empty interface designed to function as the OracleDBConfig API namespace

type OracleDBConfigConnectivityStruct 

type OracleDBConfigConnectivityStruct struct {
	// Database password.
	// format = password
	// create = optional
	// update = optional
	Password string `json:"password,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Database username.
	// update = optional
	// create = optional
	Username string `json:"username,omitempty"`
}

OracleDBConfigConnectivityStruct - Mechanism to test JDBC connectivity to Oracle source configs. extends AbstractSourceConfigConnectivity

func OracleDBConfigConnectivityFactory 

func OracleDBConfigConnectivityFactory(
	Password string,
	Username string,
) OracleDBConfigConnectivityStruct

OracleDBConfigConnectivityFactory is just a simple function to instantiate the OracleDBConfigConnectivityStruct

type OracleDBContainerRuntimeStruct 

type OracleDBContainerRuntimeStruct struct {
	// Indicates whether or not the given container is cross-platform
	// eligible or not.
	// default = false
	CrossPlatformEligible *bool `json:"crossPlatformEligible,omitempty"`
	// Indicates whether or not the given container has a cross-platform
	// user script uploaded.
	// default = false
	CrossPlatformScriptUploaded *bool `json:"crossPlatformScriptUploaded,omitempty"`
	// Indicates whether or not a LiveSource can be added to the given
	// container.
	// default = false
	LiveSourceEligible *bool `json:"liveSourceEligible,omitempty"`
	// True if the LogSync is enabled and running for this container.
	LogSyncActive *bool `json:"logSyncActive,omitempty"`
	// The pre-provisioning runtime for the container.
	PreProvisioningStatus *PreProvisioningRuntimeStruct `json:"preProvisioningStatus,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleDBContainerRuntimeStruct - Runtime properties of an Oracle database container. extends DBContainerRuntime

func OracleDBContainerRuntimeFactory 

func OracleDBContainerRuntimeFactory(
	CrossPlatformEligible *bool,
	CrossPlatformScriptUploaded *bool,
	LiveSourceEligible *bool,
	LogSyncActive *bool,
	PreProvisioningStatus *PreProvisioningRuntimeStruct,
) OracleDBContainerRuntimeStruct

OracleDBContainerRuntimeFactory is just a simple function to instantiate the OracleDBContainerRuntimeStruct

type OracleDatabaseContainerStruct 

type OracleDatabaseContainerStruct struct {
	// Indicates whether this container is for a PDB, CDB root, auxiliary
	// CDB, or non-CDB.
	// enum = [PDB ROOT_CDB AUX_CDB NON_CDB]
	ContentType string `json:"contentType,omitempty"`
	// The date this container was created.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// Indicates whether or not this container is ready for
	// cross-platform provisioning.
	// default = false
	CrossPlatformReady *bool `json:"crossPlatformReady,omitempty"`
	// A reference to the currently active TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	CurrentTimeflow string `json:"currentTimeflow,omitempty"`
	// Indicates whether or not the database in this container consists
	// only of transportable tablespaces.
	// featureFlag = CONSPRO
	// default = false
	DatabaseFraction *bool `json:"databaseFraction,omitempty"`
	// Optional user-provided description for the container.
	// create = optional
	// update = optional
	// maxLength = 1024
	Description string `json:"description,omitempty"`
	// If true, NOLOGGING operations on this container are treated as
	// faults and cannot be resolved manually. Otherwise, these
	// operations are ignored.
	// default = true
	// create = optional
	// update = optional
	DiagnoseNoLoggingFaults *bool `json:"diagnoseNoLoggingFaults,omitempty"`
	// A reference to the group containing this container.
	// referenceTo = /delphix-group.json
	// create = required
	// format = objectReference
	Group string `json:"group,omitempty"`
	// Indicates whether or not this container has an associated
	// LiveSource.
	// default = false
	LiveSource *bool `json:"liveSource,omitempty"`
	// True if this container is a masked container.
	Masked *bool `json:"masked,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Native operating system of the original database source system.
	Os string `json:"os,omitempty"`
	// Whether to enable high performance mode.
	// update = optional
	// enum = [TEMPORARILY_ENABLED ENABLED DISABLED]
	// default = DISABLED
	// create = optional
	PerformanceMode string `json:"performanceMode,omitempty"`
	// Indicates whether or not the database in this container is a
	// physical standby.
	// default = false
	PhysicalStandby *bool `json:"physicalStandby,omitempty"`
	// If true, pre-provisioning will be performed after every sync.
	// default = false
	// create = optional
	// update = optional
	PreProvisioningEnabled *bool `json:"preProvisioningEnabled,omitempty"`
	// A reference to the previous TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	PreviousTimeflow string `json:"previousTimeflow,omitempty"`
	// Native processor type of the original database source system.
	Processor string `json:"processor,omitempty"`
	// A reference to the container this container was provisioned from.
	// format = objectReference
	// referenceTo = /delphix-container.json
	ProvisionContainer string `json:"provisionContainer,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this container.
	Runtime *OracleDBContainerRuntimeStruct `json:"runtime,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	// update = optional
	SourcingPolicy *OracleSourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// True if this container is a transformation container.
	Transformation *bool `json:"transformation,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleDatabaseContainerStruct - Data container for Oracle databases, both linked and virtual. extends DatabaseContainer

func OracleDatabaseContainerFactory 

func OracleDatabaseContainerFactory(
	ContentType string,
	CreationTime string,
	CrossPlatformReady *bool,
	CurrentTimeflow string,
	DatabaseFraction *bool,
	Description string,
	DiagnoseNoLoggingFaults *bool,
	Group string,
	LiveSource *bool,
	Masked *bool,
	Name string,
	Namespace string,
	Os string,
	PerformanceMode string,
	PhysicalStandby *bool,
	PreProvisioningEnabled *bool,
	PreviousTimeflow string,
	Processor string,
	ProvisionContainer string,
	Reference string,
	Runtime *OracleDBContainerRuntimeStruct,
	SourcingPolicy *OracleSourcingPolicyStruct,
	Transformation *bool,
) OracleDatabaseContainerStruct

OracleDatabaseContainerFactory is just a simple function to instantiate the OracleDatabaseContainerStruct

type OracleDatabaseCreationParametersStruct 

type OracleDatabaseCreationParametersStruct struct {
	// The character set the database uses to store data.
	// default = AL32UTF8
	// create = optional
	// update = optional
	// pattern = ^UTF8|UTFE|[A-Z]+[0-9]+[A-Z0-9]+$
	CharacterSet string `json:"characterSet,omitempty"`
	// The new container for the created database.
	// required = true
	Container *OracleDatabaseContainerStruct `json:"container,omitempty"`
	// The password for the Delphix database user.
	// format = password
	// required = true
	DelphixPassword string `json:"delphixPassword,omitempty"`
	// The name of the Delphix database user.
	// required = true
	// pattern = ^[a-zA-Z][_a-zA-Z0-9]*$
	DelphixUsername string `json:"delphixUsername,omitempty"`
	// Puts the database into FORCE LOGGING mode. Oracle Database will
	// log all changes in the database except for changes in temporary
	// tablespaces and temporary segments.
	// create = optional
	// update = optional
	// default = false
	ForceLogging *bool `json:"forceLogging,omitempty"`
	// Grants the SELECT ANY DICTIONARY system privilege to the Delphix
	// database user. If disabled, the Delphix database user will only
	// have SELECT access to a limited set of views.
	// create = optional
	// update = optional
	// default = true
	GrantSelectAnyDictionary *bool `json:"grantSelectAnyDictionary,omitempty"`
	// The initial sizing of the data files section of the control file
	// at CREATE DATABASE or CREATE CONTROLFILE time.
	// update = optional
	// minimum = 2
	// default = 32
	// maximum = 65535
	// create = optional
	MaxDataFiles *int `json:"maxDataFiles,omitempty"`
	// The maximum number of instances that can simultaneously have this
	// database mounted and open.
	// maximum = 1055
	// create = optional
	// update = optional
	// minimum = 1
	// default = 32
	MaxInstances *int `json:"maxInstances,omitempty"`
	// The maximum number of redo log files that can ever be created for
	// the database.
	// default = 64
	// maximum = 255
	// create = optional
	// update = optional
	// minimum = 3
	MaxLogFiles *int `json:"maxLogFiles,omitempty"`
	// The maximum number of archived redo log files for automatic media
	// recovery of Oracle RAC.
	// maximum = 65535
	// create = optional
	// update = optional
	// minimum = 0
	// default = 100
	MaxLogHistory *int `json:"maxLogHistory,omitempty"`
	// The national character set used to store data in columns
	// specifically defined as NCHAR, NCLOB, or NVARCHAR2.
	// create = optional
	// update = optional
	// enum = [AL16UTF16 UTF8]
	// default = AL16UTF16
	NationalCharacterSet string `json:"nationalCharacterSet,omitempty"`
	// The redo log files. If no filename is provided, Oracle-managed
	// files will be used.
	// create = optional
	// update = optional
	// minItems = 3
	RedoLogs []*OracleRedoLogFileSpecificationStruct `json:"redoLogs,omitempty"`
	// The source that describes the created database instance.
	// required = true
	Source *OracleWarehouseSourceStruct `json:"source,omitempty"`
	// The source config including dynamically discovered attributes of
	// the source.
	// required = true
	SourceConfig OracleBaseDBConfig `json:"sourceConfig,omitempty"`
	// The datafile for the SYSTEM tablespace. If no filename is
	// provided, Oracle-managed files will be used.
	// create = optional
	// update = optional
	SysDatafile *OracleSystemDatafileSpecificationStruct `json:"sysDatafile,omitempty"`
	// The password for the SYS user.
	// format = password
	// required = true
	SysPassword string `json:"sysPassword,omitempty"`
	// The datafile for the SYSAUX tablespace. If no filename is
	// provided, Oracle-managed files will be used.
	// create = optional
	// update = optional
	SysauxDatafile *OracleSysauxDatafileSpecificationStruct `json:"sysauxDatafile,omitempty"`
	// The password for the SYSTEM user.
	// required = true
	// format = password
	SystemPassword string `json:"systemPassword,omitempty"`
	// The tempfile for the database. If no filename is provided,
	// Oracle-managed files will be used.
	// create = optional
	// update = optional
	TempTablespace *OracleTempfileSpecificationStruct `json:"tempTablespace,omitempty"`
	// Indicates the timezone file version that will be used to create
	// the database.
	// update = optional
	// minimum = 1
	// maximum = 22
	// create = optional
	TimezoneFileVersion *int `json:"timezoneFileVersion,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The datafile to be used for undo data. If no filename is provided,
	// Oracle-managed files will be used.
	// update = optional
	// create = optional
	UndoTablespace *OracleUndoDatafileSpecificationStruct `json:"undoTablespace,omitempty"`
}

OracleDatabaseCreationParametersStruct - The parameters to use as input when creating a new Oracle database. extends EmptyDatasetCreationParameters

func OracleDatabaseCreationParametersFactory 

func OracleDatabaseCreationParametersFactory(
	CharacterSet string,
	Container *OracleDatabaseContainerStruct,
	DelphixPassword string,
	DelphixUsername string,
	ForceLogging *bool,
	GrantSelectAnyDictionary *bool,
	MaxDataFiles *int,
	MaxInstances *int,
	MaxLogFiles *int,
	MaxLogHistory *int,
	NationalCharacterSet string,
	RedoLogs []*OracleRedoLogFileSpecificationStruct,
	Source *OracleWarehouseSourceStruct,
	SourceConfig OracleBaseDBConfig,
	SysDatafile *OracleSystemDatafileSpecificationStruct,
	SysPassword string,
	SysauxDatafile *OracleSysauxDatafileSpecificationStruct,
	SystemPassword string,
	TempTablespace *OracleTempfileSpecificationStruct,
	TimezoneFileVersion *int,
	UndoTablespace *OracleUndoDatafileSpecificationStruct,
) OracleDatabaseCreationParametersStruct

OracleDatabaseCreationParametersFactory is just a simple function to instantiate the OracleDatabaseCreationParametersStruct

type OracleDatabaseStatisticStruct 

type OracleDatabaseStatisticStruct struct {
	// A single performance statistic row.
	StatisticValues []string `json:"statisticValues,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleDatabaseStatisticStruct - A row in the database performance statistic table. extends TypedObject

func OracleDatabaseStatisticFactory 

func OracleDatabaseStatisticFactory(
	StatisticValues []string,
) OracleDatabaseStatisticStruct

OracleDatabaseStatisticFactory is just a simple function to instantiate the OracleDatabaseStatisticStruct

type OracleDatabaseStatsSectionStruct 

type OracleDatabaseStatsSectionStruct struct {
	// List of statistic column headers.
	ColumnHeaders []string `json:"columnHeaders,omitempty"`
	// List of statistic rows corresponding to column headers.
	RowValues []*OracleDatabaseStatisticStruct `json:"rowValues,omitempty"`
	// Database statistic section name.
	SectionName string `json:"sectionName,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleDatabaseStatsSectionStruct - Oracle database performance statistics for a specific section. extends TypedObject

func OracleDatabaseStatsSectionFactory 

func OracleDatabaseStatsSectionFactory(
	ColumnHeaders []string,
	RowValues []*OracleDatabaseStatisticStruct,
	SectionName string,
) OracleDatabaseStatsSectionStruct

OracleDatabaseStatsSectionFactory is just a simple function to instantiate the OracleDatabaseStatsSectionStruct

type OracleDatafileTempfileSpecification 

type OracleDatafileTempfileSpecification interface{}

OracleDatafileTempfileSpecification is an empty interface designed to function as the OracleDatafileTempfileSpecification API namespace

type OracleDeleteParametersStruct 

type OracleDeleteParametersStruct struct {
	// The security credential of the privileged user to run the delete
	// operation as.
	Credential Credential `json:"credential,omitempty"`
	// Flag indicating whether to continue the operation upon failures.
	Force *bool `json:"force,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the delete operation as.
	Username string `json:"username,omitempty"`
}

OracleDeleteParametersStruct - The parameters passed in for an Oracle database delete operation. extends DeleteParameters

func OracleDeleteParametersFactory 

func OracleDeleteParametersFactory(
	Credential Credential,
	Force *bool,
	Username string,
) OracleDeleteParametersStruct

OracleDeleteParametersFactory is just a simple function to instantiate the OracleDeleteParametersStruct

type OracleDisableParametersStruct 

type OracleDisableParametersStruct struct {
	// Whether to attempt a cleanup of the database from the environment
	// before the disable.
	// default = true
	AttemptCleanup *bool `json:"attemptCleanup,omitempty"`
	// The security credential of the privileged user to run the
	// provision operation as.
	Credential Credential `json:"credential,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the provision operation as.
	Username string `json:"username,omitempty"`
}

OracleDisableParametersStruct - The parameters to use as input to disable oracle sources. extends SourceDisableParameters

func OracleDisableParametersFactory 

func OracleDisableParametersFactory(
	AttemptCleanup *bool,
	Credential Credential,
	Username string,
) OracleDisableParametersStruct

OracleDisableParametersFactory is just a simple function to instantiate the OracleDisableParametersStruct

type OracleEnableParametersStruct 

type OracleEnableParametersStruct struct {
	// Whether to attempt a startup of the source after the enable.
	// default = true
	AttemptStart *bool `json:"attemptStart,omitempty"`
	// The security credential of the privileged user to run the
	// provision operation as.
	Credential Credential `json:"credential,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the provision operation as.
	Username string `json:"username,omitempty"`
}

OracleEnableParametersStruct - The parameters to use as input to enable Oracle sources. extends SourceEnableParameters

func OracleEnableParametersFactory 

func OracleEnableParametersFactory(
	AttemptStart *bool,
	Credential Credential,
	Username string,
) OracleEnableParametersStruct

OracleEnableParametersFactory is just a simple function to instantiate the OracleEnableParametersStruct

type OracleExportParametersStruct 

type OracleExportParametersStruct struct {
	// Database-specific configuration parameters.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// DSP options for export.
	// create = optional
	DspOptions *DSPOptionsStruct `json:"dspOptions,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Number of files to stream in parallel across the network.
	// maximum = 64
	// create = optional
	// default = 3
	// minimum = 1
	FileParallelism *int `json:"fileParallelism,omitempty"`
	// The filesystem configuration of the exported database.
	// required = true
	FilesystemLayout *TimeflowFilesystemLayoutStruct `json:"filesystemLayout,omitempty"`
	// Open the database after recovery. This can have a true value only
	// if 'recoverDatabase' is true.
	// create = optional
	// default = true
	OpenDatabase *bool `json:"openDatabase,omitempty"`
	// If specified, then take the exported database through recovery
	// procedures, if necessary, to reach a consistent point.
	// create = optional
	// default = true
	RecoverDatabase *bool `json:"recoverDatabase,omitempty"`
	// The source config to use when creating the exported DB.
	// required = true
	SourceConfig OracleDBConfig `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base export
	// on.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleExportParametersStruct - The parameters to use as input to export Oracle databases. extends DbExportParameters

func OracleExportParametersFactory 

func OracleExportParametersFactory(
	ConfigParams map[string]string,
	DspOptions *DSPOptionsStruct,
	FileMappingRules string,
	FileParallelism *int,
	FilesystemLayout *TimeflowFilesystemLayoutStruct,
	OpenDatabase *bool,
	RecoverDatabase *bool,
	SourceConfig OracleDBConfig,
	TimeflowPointParameters TimeflowPointParameters,
) OracleExportParametersStruct

OracleExportParametersFactory is just a simple function to instantiate the OracleExportParametersStruct

type OracleExportStruct 

type OracleExportStruct struct {
	// DSP options for export.
	DspOptions *DSPOptionsStruct `json:"dspOptions,omitempty"`
	// Number of files to stream in parallel across the network.
	// default = 3
	// minimum = 1
	FileParallelism *int `json:"fileParallelism,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleExportStruct - The mutable state of an Oracle database export. extends TypedObject

func OracleExportFactory 

func OracleExportFactory(
	DspOptions *DSPOptionsStruct,
	FileParallelism *int,
) OracleExportStruct

OracleExportFactory is just a simple function to instantiate the OracleExportStruct

type OracleFetchedLogStruct 

type OracleFetchedLogStruct struct {
	// Reference to the database to which this log belongs.
	// format = objectReference
	// referenceTo = /delphix-oracle-db-container.json
	Container string `json:"container,omitempty"`
	// End SCN for the log file.
	EndScn *int `json:"endScn,omitempty"`
	// End timestamp for the log file.
	// format = date
	EndTimestamp string `json:"endTimestamp,omitempty"`
	// Instance number associated with the log file.
	InstanceNum *int `json:"instanceNum,omitempty"`
	// Sequence number for the log file.
	Sequence *int `json:"sequence,omitempty"`
	// Start SCN for the log file.
	StartScn *int `json:"startScn,omitempty"`
	// Start timestamp for the log file.
	// format = date
	StartTimestamp string `json:"startTimestamp,omitempty"`
	// Reference to the TimeFlow of which this log is a part.
	// format = objectReference
	// referenceTo = /delphix-oracle-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleFetchedLogStruct - An Oracle log file fetched by LogSync. extends OracleTimeflowLog

func OracleFetchedLogFactory 

func OracleFetchedLogFactory(
	Container string,
	EndScn *int,
	EndTimestamp string,
	InstanceNum *int,
	Sequence *int,
	StartScn *int,
	StartTimestamp string,
	Timeflow string,
) OracleFetchedLogStruct

OracleFetchedLogFactory is just a simple function to instantiate the OracleFetchedLogStruct

type OracleFileSpecification 

type OracleFileSpecification interface{}

OracleFileSpecification is an empty interface designed to function as the OracleFileSpecification API namespace

type OracleInstallStruct 

type OracleInstallStruct struct {
	// List of Oracle patches that have been applied to this Oracle Home.
	// update = optional
	// create = optional
	AppliedPatches []*int `json:"appliedPatches,omitempty"`
	// 32 or 64 bits.
	// update = optional
	// enum = [32 64]
	// create = required
	Bits *int `json:"bits,omitempty"`
	// Flag indicating whether the install was discovered or manually
	// entered.
	Discovered *bool `json:"discovered,omitempty"`
	// Reference to the environment containing this repository.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = required
	Environment string `json:"environment,omitempty"`
	// Group ID of the user that owns the install.
	GroupId *int `json:"groupId,omitempty"`
	// Group name of the user that owns the install.
	GroupName string `json:"groupName,omitempty"`
	// The Oracle install home.
	// create = required
	// maxLength = 256
	InstallationHome string `json:"installationHome,omitempty"`
	// Flag indicating whether the repository should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Flag indicating whether this repository can use LogSync.
	LogsyncPossible *bool `json:"logsyncPossible,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The Oracle base where database binaries are located.
	// create = optional
	// update = optional
	// maxLength = 256
	OracleBase string `json:"oracleBase,omitempty"`
	// Flag indicating whether the repository should be used for
	// provisioning.
	// create = optional
	// update = optional
	// default = true
	ProvisioningEnabled *bool `json:"provisioningEnabled,omitempty"`
	// Flag indicating whether the install supports Oracle RAC.
	Rac *bool `json:"rac,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Flag indicating whether this repository can be used by the Delphix
	// Engine for internal processing.
	// default = false
	// create = optional
	// update = optional
	Staging *bool `json:"staging,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// User ID of the user that owns the install.
	UserId *int `json:"userId,omitempty"`
	// User name of the user that owns the install.
	UserName string `json:"userName,omitempty"`
	// Version of the repository.
	// format = oracleVersion
	// create = required
	// update = optional
	Version string `json:"version,omitempty"`
}

OracleInstallStruct - The Oracle source repository. extends SourceRepository

func OracleInstallFactory 

func OracleInstallFactory(
	AppliedPatches []*int,
	Bits *int,
	Discovered *bool,
	Environment string,
	GroupId *int,
	GroupName string,
	InstallationHome string,
	LinkingEnabled *bool,
	LogsyncPossible *bool,
	Name string,
	Namespace string,
	OracleBase string,
	ProvisioningEnabled *bool,
	Rac *bool,
	Reference string,
	Staging *bool,
	UserId *int,
	UserName string,
	Version string,
) OracleInstallStruct

OracleInstallFactory is just a simple function to instantiate the OracleInstallStruct

type OracleInstanceStruct 

type OracleInstanceStruct struct {
	// The name of the instance.
	// create = required
	// update = optional
	// pattern = ^[a-zA-Z0-9_]+$
	// maxLength = 15
	InstanceName string `json:"instanceName,omitempty"`
	// The number of the instance.
	// create = required
	// update = optional
	// minimum = 1
	InstanceNumber float64 `json:"instanceNumber,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleInstanceStruct - Representation of an Oracle instance configuration. extends TypedObject

func OracleInstanceFactory 

func OracleInstanceFactory(
	InstanceName string,
	InstanceNumber float64,
) OracleInstanceStruct

OracleInstanceFactory is just a simple function to instantiate the OracleInstanceStruct

type OracleLinkDataStruct 

type OracleLinkDataStruct struct {
	// Defines whether backup level is enabled.
	// create = optional
	BackupLevelEnabled *bool `json:"backupLevelEnabled,omitempty"`
	// Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A
	// value of 0 means no limit.
	// minimum = 0
	// default = 0
	// create = optional
	BandwidthLimit *int `json:"bandwidthLimit,omitempty"`
	// True if extended block checking should be used for this linked
	// database.
	// default = false
	// create = optional
	CheckLogical *bool `json:"checkLogical,omitempty"`
	// True if SnapSync data from the source should be compressed over
	// the network. Enabling this feature will reduce network bandwidth
	// consumption and may significantly improve throughput, especially
	// over slow network.
	// default = true
	// create = optional
	CompressedLinkingEnabled *bool `json:"compressedLinkingEnabled,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-oracle-db-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The password for the DB user.
	// required = true
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The name of the DB user.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// If true, NOLOGGING operations on this container are treated as
	// faults and cannot be resolved manually. Otherwise, these
	// operations are ignored.
	// create = optional
	// default = true
	DiagnoseNoLoggingFaults *bool `json:"diagnoseNoLoggingFaults,omitempty"`
	// True if two SnapSyncs should be performed in immediate succession
	// to reduce the number of logs required to provision the snapshot.
	// This may significantly reduce the time necessary to provision from
	// a snapshot.
	// default = false
	// create = optional
	DoubleSync *bool `json:"doubleSync,omitempty"`
	// True if SnapSync data from the source should be retrieved through
	// an encrypted connection. Enabling this feature can decrease the
	// performance of SnapSync from the source but has no impact on the
	// performance of VDBs created from the retrieved data.
	// default = false
	// create = optional
	EncryptedLinkingEnabled *bool `json:"encryptedLinkingEnabled,omitempty"`
	// Information about the OS user to use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// External file path.
	// maxLength = 1024
	// create = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Number of data files to include in each RMAN backup set.
	// minimum = 1
	// maximum = 64
	// default = 5
	// create = optional
	FilesPerSet *int `json:"filesPerSet,omitempty"`
	// True if initial load should be done immediately.
	// default = false
	// create = optional
	LinkNow *bool `json:"linkNow,omitempty"`
	// Non-SYS database credentials to access this database.
	// create = optional
	NonSysCredentials *PasswordCredentialStruct `json:"nonSysCredentials,omitempty"`
	// Non-SYS database user to access this database.
	// maxLength = 30
	// create = optional
	NonSysUser string `json:"nonSysUser,omitempty"`
	// Total number of transport connections to use during SnapSync.
	// default = 1
	// minimum = 1
	// maximum = 16
	// create = optional
	NumberOfConnections *int `json:"numberOfConnections,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// If true, pre-provisioning will be performed after every sync.
	// default = false
	// create = optional
	PreProvisioningEnabled *bool `json:"preProvisioningEnabled,omitempty"`
	// Number of parallel channels to use.
	// minimum = 1
	// maximum = 32
	// default = 2
	// create = optional
	RmanChannels *int `json:"rmanChannels,omitempty"`
	// Skip check that tests if there is enough space available to store
	// the database in the Delphix Engine. The Delphix Engine estimates
	// how much space a database will occupy after compression and
	// prevents SnapSync if insufficient space is available. This
	// safeguard can be overridden using this option. This may be useful
	// when linking highly compressible databases.
	// default = false
	// create = optional
	SkipSpaceCheck *bool `json:"skipSpaceCheck,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	SourcingPolicy *OracleSourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleLinkDataStruct - Represents parameters to link non-pluggable Oracle databases. extends OracleBaseLinkData

func OracleLinkDataFactory 

func OracleLinkDataFactory(
	BackupLevelEnabled *bool,
	BandwidthLimit *int,
	CheckLogical *bool,
	CompressedLinkingEnabled *bool,
	Config string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	DiagnoseNoLoggingFaults *bool,
	DoubleSync *bool,
	EncryptedLinkingEnabled *bool,
	EnvironmentUser string,
	ExternalFilePath string,
	FilesPerSet *int,
	LinkNow *bool,
	NonSysCredentials *PasswordCredentialStruct,
	NonSysUser string,
	NumberOfConnections *int,
	Operations *LinkedSourceOperationsStruct,
	PreProvisioningEnabled *bool,
	RmanChannels *int,
	SkipSpaceCheck *bool,
	SourcingPolicy *OracleSourcingPolicyStruct,
) OracleLinkDataStruct

OracleLinkDataFactory is just a simple function to instantiate the OracleLinkDataStruct

type OracleLinkedSourceStruct 

type OracleLinkedSourceStruct struct {
	// Defines whether backup level is enabled.
	// create = optional
	// update = optional
	BackupLevelEnabled *bool `json:"backupLevelEnabled,omitempty"`
	// Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A
	// value of 0 means no limit.
	// create = optional
	// update = optional
	// minimum = 0
	// default = 0
	BandwidthLimit *int `json:"bandwidthLimit,omitempty"`
	// True if extended block checking should be used for this linked
	// database.
	// create = optional
	// update = optional
	// default = false
	CheckLogical *bool `json:"checkLogical,omitempty"`
	// True if SnapSync data from the source should be compressed over
	// the network. Enabling this feature will reduce network bandwidth
	// consumption and may significantly improve throughput, especially
	// over slow network.
	// create = optional
	// update = optional
	// default = true
	CompressedLinkingEnabled *bool `json:"compressedLinkingEnabled,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-oracle-base-db-config.json
	// create = required
	// update = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// True if SnapSync data from the source should be retrieved through
	// an encrypted connection. Enabling this feature can decrease the
	// performance of SnapSync from the source but has no impact on the
	// performance of VDBs created from the retrieved data.
	// update = optional
	// default = false
	// create = optional
	EncryptedLinkingEnabled *bool `json:"encryptedLinkingEnabled,omitempty"`
	// External file path.
	// create = optional
	// update = optional
	// maxLength = 1024
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Number of data files to include in each RMAN backup set.
	// default = 5
	// create = optional
	// update = optional
	// minimum = 1
	// maximum = 64
	FilesPerSet *int `json:"filesPerSet,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// Total number of transport connections to use during SnapSync.
	// create = optional
	// update = optional
	// default = 1
	// minimum = 1
	// maximum = 16
	NumberOfConnections *int `json:"numberOfConnections,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Number of parallel channels to use.
	// minimum = 1
	// maximum = 32
	// default = 2
	// create = optional
	// update = optional
	RmanChannels *int `json:"rmanChannels,omitempty"`
	// Runtime properties for this Oracle source.
	Runtime OracleBaseSourceRuntime `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

OracleLinkedSourceStruct - A linked Oracle source. extends OracleSource

func OracleLinkedSourceFactory 

func OracleLinkedSourceFactory(
	BackupLevelEnabled *bool,
	BandwidthLimit *int,
	CheckLogical *bool,
	CompressedLinkingEnabled *bool,
	Config string,
	Container string,
	Description string,
	EncryptedLinkingEnabled *bool,
	ExternalFilePath string,
	FilesPerSet *int,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	NumberOfConnections *int,
	Operations *LinkedSourceOperationsStruct,
	Reference string,
	RmanChannels *int,
	Runtime OracleBaseSourceRuntime,
	Staging *bool,
	Status string,
	Virtual *bool,
) OracleLinkedSourceStruct

OracleLinkedSourceFactory is just a simple function to instantiate the OracleLinkedSourceStruct

type OracleListener 

type OracleListener interface{}

OracleListener is an empty interface designed to function as the OracleListener API namespace

type OracleLiveSourceRuntimeStruct 

type OracleLiveSourceRuntimeStruct struct {
	// True if the source is JDBC accessible. If false then no properties
	// can be retrieved.
	Accessible *bool `json:"accessible,omitempty"`
	// The time that the 'accessible' propery was last checked.
	// format = date
	AccessibleTimestamp string `json:"accessibleTimestamp,omitempty"`
	// List of active database instances for the source.
	ActiveInstances []*OracleActiveInstanceStruct `json:"activeInstances,omitempty"`
	// MRP apply status for the standby database associated with the
	// LiveSource.
	// enum = [UNKNOWN WORKING APPLY_FAILED APPLY_ON_WRONG_INCARNATION UNRESOLVABLE_GAP_DETECTED]
	ApplyStatus string `json:"applyStatus,omitempty"`
	// Current data lag between LiveSource and source database in
	// seconds.
	// units = sec
	CurrentDataAge *int `json:"currentDataAge,omitempty"`
	// Operating mode of the database.
	// default = UNKNOWN
	// enum = [READ_WRITE READ_ONLY STANDBY_READ_ONLY MOUNTED_ONLY UNKNOWN]
	DatabaseMode string `json:"databaseMode,omitempty"`
	// The current role of the database.
	// default = UNKNOWN
	// enum = [PHYSICAL_STANDBY LOGICAL_STANDBY SNAPSHOT_STANDBY FAR_SYNC PRIMARY UNKNOWN]
	DatabaseRole string `json:"databaseRole,omitempty"`
	// Size of the database in bytes.
	// units = B
	// base = 1024
	DatabaseSize float64 `json:"databaseSize,omitempty"`
	// Table of key database performance statistics.
	DatabaseStats []*OracleDatabaseStatsSectionStruct `json:"databaseStats,omitempty"`
	// Status indicating whether the source is enabled. A source has a
	// 'PARTIAL' status if its sub-sources are not all enabled.
	// enum = [ENABLED PARTIAL DISABLED]
	Enabled string `json:"enabled,omitempty"`
	// Has data age exceeded the user specified threshold.
	IsDataAgeWarningExceeded *bool `json:"isDataAgeWarningExceeded,omitempty"`
	// Highest SCN at which non-logged changes were generated.
	LastNonLoggedLocation string `json:"lastNonLoggedLocation,omitempty"`
	// The time at which this runtime data was updated.
	// format = date
	LastUpdateTime string `json:"lastUpdateTime,omitempty"`
	// Indicates whether there is non-logged data on the standby.
	NonLoggedDataDetected *bool `json:"nonLoggedDataDetected,omitempty"`
	// The reason why the source is not JDBC accessible.
	NotAccessibleReason string `json:"notAccessibleReason,omitempty"`
	// Time zone of the source database at the time the runtime data was
	// updated.
	SourceDatabaseTimezone string `json:"sourceDatabaseTimezone,omitempty"`
	// Indicates whether the incarnation ID changed on the primary
	// database.
	SourceResetlogsIDChangeDetected *bool `json:"sourceResetlogsIDChangeDetected,omitempty"`
	// Status of the source. 'Unknown' if all attempts to connect to the
	// source failed.
	// enum = [RUNNING INACTIVE PENDING CANCELED FAILED CHECKING UNKNOWN]
	Status string `json:"status,omitempty"`
	// Redo log transport status from the source database to the
	// LiveSource.
	// enum = [UNKNOWN WORKING NO_INITIAL_DATA NO_NEW_DATA]
	TransportStatus string `json:"transportStatus,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Indicates whether the LiveSource is not in standby mode.
	UnexpectedRoleChangeDetected *bool `json:"unexpectedRoleChangeDetected,omitempty"`
}

OracleLiveSourceRuntimeStruct - Runtime (non-persistent) properties of an Oracle LiveSource. extends OracleBaseSourceRuntime

func OracleLiveSourceRuntimeFactory 

func OracleLiveSourceRuntimeFactory(
	Accessible *bool,
	AccessibleTimestamp string,
	ActiveInstances []*OracleActiveInstanceStruct,
	ApplyStatus string,
	CurrentDataAge *int,
	DatabaseMode string,
	DatabaseRole string,
	DatabaseSize float64,
	DatabaseStats []*OracleDatabaseStatsSectionStruct,
	Enabled string,
	IsDataAgeWarningExceeded *bool,
	LastNonLoggedLocation string,
	LastUpdateTime string,
	NonLoggedDataDetected *bool,
	NotAccessibleReason string,
	SourceDatabaseTimezone string,
	SourceResetlogsIDChangeDetected *bool,
	Status string,
	TransportStatus string,
	UnexpectedRoleChangeDetected *bool,
) OracleLiveSourceRuntimeStruct

OracleLiveSourceRuntimeFactory is just a simple function to instantiate the OracleLiveSourceRuntimeStruct

type OracleLiveSourceStruct 

type OracleLiveSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// create = required
	// update = optional
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Archive Log Mode of the Oracle virtual database.
	// update = readonly
	// default = true
	// create = optional
	ArchivelogMode *bool `json:"archivelogMode,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Oracle database configuration parameter overrides.
	// create = optional
	// update = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Optional database template to use for provisioning and refresh. If
	// set, configParams will be ignored on provision or refresh.
	// format = objectReference
	// referenceTo = /delphix-database-template.json
	// create = optional
	// update = optional
	ConfigTemplate string `json:"configTemplate,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Custom environment variables for Oracle databases.
	// create = optional
	// update = optional
	CustomEnvVars []OracleCustomEnvVar `json:"customEnvVars,omitempty"`
	// Amount of tolerable delay for this Oracle LiveSource in seconds.
	// update = optional
	// default = 900
	// units = sec
	// create = optional
	DataAgeWarningThreshold *int `json:"dataAgeWarningThreshold,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point to use for the NFS mounts.
	// create = required
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// maxLength = 256
	// format = objectName
	// create = optional
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A list of object references to Oracle Node Listeners selected for
	// this Managed Database. Delphix picks one default listener from the
	// target environment if this list is empty at virtual database
	// provision time.
	// create = optional
	// update = optional
	NodeListeners []string `json:"nodeListeners,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// Number of Online Redo Log Groups.
	// minimum = 2
	// default = 3
	// create = optional
	// update = readonly
	RedoLogGroups *int `json:"redoLogGroups,omitempty"`
	// Online Redo Log size in MB.
	// minimum = 4
	// create = optional
	// update = readonly
	RedoLogSizeInMB *int `json:"redoLogSizeInMB,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Resync status for this Oracle LiveSource.
	// enum = [RESYNC_NOT_REQUIRED RESYNC_NEEDED RESYNC_IN_PROGRESS APPLY_READY APPLY_IN_PROGRESS APPLY_FAILED]
	ResyncStatus string `json:"resyncStatus,omitempty"`
	// Runtime properties for this Oracle source.
	Runtime OracleBaseSourceRuntime `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

OracleLiveSourceStruct - An Oracle LiveSource. extends OracleVirtualSource

func OracleLiveSourceFactory 

func OracleLiveSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	ArchivelogMode *bool,
	Config string,
	ConfigParams map[string]string,
	ConfigTemplate string,
	Container string,
	CustomEnvVars []OracleCustomEnvVar,
	DataAgeWarningThreshold *int,
	Description string,
	FileMappingRules string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	NodeListeners []string,
	Operations *VirtualSourceOperationsStruct,
	RedoLogGroups *int,
	RedoLogSizeInMB *int,
	Reference string,
	ResyncStatus string,
	Runtime OracleBaseSourceRuntime,
	Staging *bool,
	Status string,
	Virtual *bool,
) OracleLiveSourceStruct

OracleLiveSourceFactory is just a simple function to instantiate the OracleLiveSourceStruct

type OracleLogStruct 

type OracleLogStruct struct {
	// Instance number associated with the log file.
	InstanceNum *int `json:"instanceNum,omitempty"`
	// Sequence number for the log file.
	Sequence *int `json:"sequence,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleLogStruct - Oracle log file. extends TypedObject

func OracleLogFactory 

func OracleLogFactory(
	InstanceNum *int,
	Sequence *int,
) OracleLogStruct

OracleLogFactory is just a simple function to instantiate the OracleLogStruct

type OracleManagedSource 

type OracleManagedSource interface{}

OracleManagedSource is an empty interface designed to function as the OracleManagedSource API namespace

type OracleMissingLogStruct 

type OracleMissingLogStruct struct {
	// Reference to the database to which this log belongs.
	// format = objectReference
	// referenceTo = /delphix-oracle-db-container.json
	Container string `json:"container,omitempty"`
	// End SCN for the log file.
	EndScn *int `json:"endScn,omitempty"`
	// End timestamp for the log file.
	// format = date
	EndTimestamp string `json:"endTimestamp,omitempty"`
	// Instance number associated with the log file.
	InstanceNum *int `json:"instanceNum,omitempty"`
	// Sequence number for the log file.
	Sequence *int `json:"sequence,omitempty"`
	// Start SCN for the log file.
	StartScn *int `json:"startScn,omitempty"`
	// Start timestamp for the log file.
	// format = date
	StartTimestamp string `json:"startTimestamp,omitempty"`
	// Reference to the TimeFlow of which this log is a part.
	// format = objectReference
	// referenceTo = /delphix-oracle-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleMissingLogStruct - An Oracle missing log file. extends OracleTimeflowLog

func OracleMissingLogFactory 

func OracleMissingLogFactory(
	Container string,
	EndScn *int,
	EndTimestamp string,
	InstanceNum *int,
	Sequence *int,
	StartScn *int,
	StartTimestamp string,
	Timeflow string,
) OracleMissingLogStruct

OracleMissingLogFactory is just a simple function to instantiate the OracleMissingLogStruct

type OracleMultitenantProvisionParametersStruct 

type OracleMultitenantProvisionParametersStruct struct {
	// The new container for the provisioned database.
	// required = true
	Container *OracleDatabaseContainerStruct `json:"container,omitempty"`
	// The security credential of the privileged user to run the
	// provision operation as.
	// create = optional
	Credential Credential `json:"credential,omitempty"`
	// Whether or not to mark this VDB as a masked VDB. It will be marked
	// as masked if this flag or the masking job are set.
	// create = optional
	// update = readonly
	Masked *bool `json:"masked,omitempty"`
	// The Masking Job to be run when this dataset is provisioned or
	// refreshed.
	// update = readonly
	// format = objectReference
	// referenceTo = /delphix-masking-job.json
	// create = optional
	MaskingJob string `json:"maskingJob,omitempty"`
	// The pluggable database source that describes an external database
	// instance.
	// required = true
	Source *OracleVirtualPdbSourceStruct `json:"source,omitempty"`
	// The pluggable database source config including dynamically
	// discovered attributes of the source.
	// required = true
	SourceConfig *OraclePDBConfigStruct `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base
	// provisioning on.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the provision operation as.
	// create = optional
	Username string `json:"username,omitempty"`
	// The new container for the created dataset.
	// create = optional
	VirtualCdb *OracleVirtualCdbProvisionParametersStruct `json:"virtualCdb,omitempty"`
}

OracleMultitenantProvisionParametersStruct - The parameters to use as input to provision Oracle multitenant databases. extends OracleBaseProvisionParameters

func OracleMultitenantProvisionParametersFactory 

func OracleMultitenantProvisionParametersFactory(
	Container *OracleDatabaseContainerStruct,
	Credential Credential,
	Masked *bool,
	MaskingJob string,
	Source *OracleVirtualPdbSourceStruct,
	SourceConfig *OraclePDBConfigStruct,
	TimeflowPointParameters TimeflowPointParameters,
	Username string,
	VirtualCdb *OracleVirtualCdbProvisionParametersStruct,
) OracleMultitenantProvisionParametersStruct

OracleMultitenantProvisionParametersFactory is just a simple function to instantiate the OracleMultitenantProvisionParametersStruct

type OracleNodeListenerStruct 

type OracleNodeListenerStruct struct {
	// The list of client endpoints for this listener of the format
	// hostname:port. These are used when constructing the JDBC
	// connection string.
	// create = readonly
	// update = readonly
	ClientEndpoints []string `json:"clientEndpoints,omitempty"`
	// Whether this listener was automatically discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// Reference to the environment this listener is associated with.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = required
	Environment string `json:"environment,omitempty"`
	// Reference to the host this listener is associated with.
	// referenceTo = /delphix-host.json
	// create = required
	// format = objectReference
	Host string `json:"host,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The list of protocol addresses for this listener. These are used
	// for the local_listener parameter when provisioning VDBs.
	// update = optional
	// minItems = 1
	// create = required
	ProtocolAddresses []string `json:"protocolAddresses,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleNodeListenerStruct - An Oracle node listener. extends OracleListener

func OracleNodeListenerFactory 

func OracleNodeListenerFactory(
	Discovered *bool,
	Environment string,
	Host string,
	Name string,
	Namespace string,
	ProtocolAddresses []string,
	Reference string,
) OracleNodeListenerStruct

OracleNodeListenerFactory is just a simple function to instantiate the OracleNodeListenerStruct

type OraclePDBAttachDataStruct 

type OraclePDBAttachDataStruct struct {
	// Defines whether backup level is enabled.
	// create = optional
	BackupLevelEnabled *bool `json:"backupLevelEnabled,omitempty"`
	// Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A
	// value of 0 means no limit.
	// minimum = 0
	// default = 0
	// create = optional
	BandwidthLimit *int `json:"bandwidthLimit,omitempty"`
	// True if extended block checking should be used for this linked
	// database.
	// default = false
	// create = optional
	CheckLogical *bool `json:"checkLogical,omitempty"`
	// True if SnapSync data from the source should be compressed over
	// the network. Enabling this feature will reduce network bandwidth
	// consumption and may significantly improve throughput, especially
	// over slow network.
	// default = true
	// create = optional
	CompressedLinkingEnabled *bool `json:"compressedLinkingEnabled,omitempty"`
	// Reference to the configuration for the PDB source.
	// format = objectReference
	// referenceTo = /delphix-oracle-pdb-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The password for the DB user.
	// required = true
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The name of the DB user.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// True if SnapSync data from the source should be retrieved through
	// an encrypted connection. Enabling this feature can decrease the
	// performance of SnapSync from the source but has no impact on the
	// performance of VDBs created from the retrieved data.
	// default = false
	// create = optional
	EncryptedLinkingEnabled *bool `json:"encryptedLinkingEnabled,omitempty"`
	// Information about the OS user to use for linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// External file path.
	// maxLength = 1024
	// create = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Number of data files to include in each RMAN backup set.
	// minimum = 1
	// maximum = 64
	// default = 5
	// create = optional
	FilesPerSet *int `json:"filesPerSet,omitempty"`
	// True if attach should succeed even if the resetlogs of the
	// original database does not match the resetlogs of the new database
	// and the resetlogs information of the original database is not a
	// parent incarnation of the current resetlogs. This can happen when
	// the controlfile has been recreated and the incarnation table is
	// incomplete. Use this option with extreme caution. Attached
	// database must be the same database to avoid data corruption later
	// on.
	// default = false
	// create = optional
	Force *bool `json:"force,omitempty"`
	// True if initial load should be done immediately.
	// create = optional
	// default = false
	LinkNow *bool `json:"linkNow,omitempty"`
	// Total number of transport connections to use during SnapSync.
	// default = 1
	// minimum = 1
	// maximum = 16
	// create = optional
	NumberOfConnections *int `json:"numberOfConnections,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// Number of parallel channels to use.
	// minimum = 1
	// maximum = 32
	// default = 2
	// create = optional
	RmanChannels *int `json:"rmanChannels,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OraclePDBAttachDataStruct - Represents parameters to attach an Oracle pluggable database. extends OracleBaseAttachData

func OraclePDBAttachDataFactory 

func OraclePDBAttachDataFactory(
	BackupLevelEnabled *bool,
	BandwidthLimit *int,
	CheckLogical *bool,
	CompressedLinkingEnabled *bool,
	Config string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	EncryptedLinkingEnabled *bool,
	EnvironmentUser string,
	ExternalFilePath string,
	FilesPerSet *int,
	Force *bool,
	LinkNow *bool,
	NumberOfConnections *int,
	Operations *LinkedSourceOperationsStruct,
	RmanChannels *int,
) OraclePDBAttachDataStruct

OraclePDBAttachDataFactory is just a simple function to instantiate the OraclePDBAttachDataStruct

type OraclePDBConfigStruct 

type OraclePDBConfigStruct struct {
	// The DB config of an Oracle multitenant database this pluggable
	// database belongs to.
	// format = objectReference
	// referenceTo = /delphix-oracle-db-config.json
	// create = optional
	// update = optional
	CdbConfig string `json:"cdbConfig,omitempty"`
	// The password of the database user. This must be a
	// PasswordCredential instance.
	// update = optional
	Credentials *PasswordCredentialStruct `json:"credentials,omitempty"`
	// The name of the database.
	// create = required
	// pattern = ^[a-zA-Z0-9][a-zA-Z0-9_]*$
	// maxLength = 30
	DatabaseName string `json:"databaseName,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// create = optional
	// update = optional
	// default = true
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	// create = optional
	// update = optional
	Repository string `json:"repository,omitempty"`
	// The list of database services.
	// create = optional
	// update = optional
	Services []*OracleServiceStruct `json:"services,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the database user.
	// update = optional
	// maxLength = 30
	User string `json:"user,omitempty"`
}

OraclePDBConfigStruct - Representation of properties for an Oracle pluggable database configuration. extends OracleBaseDBConfig

func OraclePDBConfigFactory 

func OraclePDBConfigFactory(
	CdbConfig string,
	Credentials *PasswordCredentialStruct,
	DatabaseName string,
	Discovered *bool,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	Reference string,
	Repository string,
	Services []*OracleServiceStruct,
	User string,
) OraclePDBConfigStruct

OraclePDBConfigFactory is just a simple function to instantiate the OraclePDBConfigStruct

type OraclePDBLinkDataStruct 

type OraclePDBLinkDataStruct struct {
	// Defines whether backup level is enabled.
	// create = optional
	BackupLevelEnabled *bool `json:"backupLevelEnabled,omitempty"`
	// Bandwidth limit (MB/s) for SnapSync and LogSync network traffic. A
	// value of 0 means no limit.
	// minimum = 0
	// default = 0
	// create = optional
	BandwidthLimit *int `json:"bandwidthLimit,omitempty"`
	// True if extended block checking should be used for this linked
	// database.
	// default = false
	// create = optional
	CheckLogical *bool `json:"checkLogical,omitempty"`
	// True if SnapSync data from the source should be compressed over
	// the network. Enabling this feature will reduce network bandwidth
	// consumption and may significantly improve throughput, especially
	// over slow network.
	// default = true
	// create = optional
	CompressedLinkingEnabled *bool `json:"compressedLinkingEnabled,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-oracle-pdb-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The password for the DB user.
	// required = true
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The name of the DB user.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// If true, NOLOGGING operations on this container are treated as
	// faults and cannot be resolved manually. Otherwise, these
	// operations are ignored.
	// default = true
	// create = optional
	DiagnoseNoLoggingFaults *bool `json:"diagnoseNoLoggingFaults,omitempty"`
	// True if two SnapSyncs should be performed in immediate succession
	// to reduce the number of logs required to provision the snapshot.
	// This may significantly reduce the time necessary to provision from
	// a snapshot.
	// default = false
	// create = optional
	DoubleSync *bool `json:"doubleSync,omitempty"`
	// True if SnapSync data from the source should be retrieved through
	// an encrypted connection. Enabling this feature can decrease the
	// performance of SnapSync from the source but has no impact on the
	// performance of VDBs created from the retrieved data.
	// default = false
	// create = optional
	EncryptedLinkingEnabled *bool `json:"encryptedLinkingEnabled,omitempty"`
	// Information about the OS user to use for linking.
	// referenceTo = /delphix-source-environment-user.json
	// required = true
	// format = objectReference
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// External file path.
	// maxLength = 1024
	// create = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Number of data files to include in each RMAN backup set.
	// maximum = 64
	// default = 5
	// create = optional
	// minimum = 1
	FilesPerSet *int `json:"filesPerSet,omitempty"`
	// True if initial load should be done immediately.
	// default = false
	// create = optional
	LinkNow *bool `json:"linkNow,omitempty"`
	// Total number of transport connections to use during SnapSync.
	// maximum = 16
	// create = optional
	// default = 1
	// minimum = 1
	NumberOfConnections *int `json:"numberOfConnections,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// If true, pre-provisioning will be performed after every sync.
	// default = false
	// create = optional
	PreProvisioningEnabled *bool `json:"preProvisioningEnabled,omitempty"`
	// Number of parallel channels to use.
	// minimum = 1
	// maximum = 32
	// default = 2
	// create = optional
	RmanChannels *int `json:"rmanChannels,omitempty"`
	// Skip check that tests if there is enough space available to store
	// the database in the Delphix Engine. The Delphix Engine estimates
	// how much space a database will occupy after compression and
	// prevents SnapSync if insufficient space is available. This
	// safeguard can be overridden using this option. This may be useful
	// when linking highly compressible databases.
	// default = false
	// create = optional
	SkipSpaceCheck *bool `json:"skipSpaceCheck,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	SourcingPolicy *OracleSourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OraclePDBLinkDataStruct - Represents parameters to link a Oracle pluggable database. extends OracleBaseLinkData

func OraclePDBLinkDataFactory 

func OraclePDBLinkDataFactory(
	BackupLevelEnabled *bool,
	BandwidthLimit *int,
	CheckLogical *bool,
	CompressedLinkingEnabled *bool,
	Config string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	DiagnoseNoLoggingFaults *bool,
	DoubleSync *bool,
	EncryptedLinkingEnabled *bool,
	EnvironmentUser string,
	ExternalFilePath string,
	FilesPerSet *int,
	LinkNow *bool,
	NumberOfConnections *int,
	Operations *LinkedSourceOperationsStruct,
	PreProvisioningEnabled *bool,
	RmanChannels *int,
	SkipSpaceCheck *bool,
	SourcingPolicy *OracleSourcingPolicyStruct,
) OraclePDBLinkDataStruct

OraclePDBLinkDataFactory is just a simple function to instantiate the OraclePDBLinkDataStruct

type OraclePDBSourceRuntimeStruct 

type OraclePDBSourceRuntimeStruct struct {
	// True if the source is JDBC accessible. If false then no properties
	// can be retrieved.
	Accessible *bool `json:"accessible,omitempty"`
	// The time that the 'accessible' propery was last checked.
	// format = date
	AccessibleTimestamp string `json:"accessibleTimestamp,omitempty"`
	// List of active database instances for the source.
	ActiveInstances []*OracleActiveInstanceStruct `json:"activeInstances,omitempty"`
	// Operating mode of the database.
	// default = UNKNOWN
	// enum = [READ_WRITE READ_ONLY STANDBY_READ_ONLY MOUNTED_ONLY UNKNOWN]
	DatabaseMode string `json:"databaseMode,omitempty"`
	// The current role of the database.
	// default = UNKNOWN
	// enum = [PHYSICAL_STANDBY LOGICAL_STANDBY SNAPSHOT_STANDBY FAR_SYNC PRIMARY UNKNOWN]
	DatabaseRole string `json:"databaseRole,omitempty"`
	// Size of the database in bytes.
	// units = B
	// base = 1024
	DatabaseSize float64 `json:"databaseSize,omitempty"`
	// Table of key database performance statistics.
	DatabaseStats []*OracleDatabaseStatsSectionStruct `json:"databaseStats,omitempty"`
	// Status indicating whether the source is enabled. A source has a
	// 'PARTIAL' status if its sub-sources are not all enabled.
	// enum = [ENABLED PARTIAL DISABLED]
	Enabled string `json:"enabled,omitempty"`
	// Highest SCN at which non-logged changes were generated.
	LastNonLoggedLocation string `json:"lastNonLoggedLocation,omitempty"`
	// The reason why the source is not JDBC accessible.
	NotAccessibleReason string `json:"notAccessibleReason,omitempty"`
	// Status of the source. 'Unknown' if all attempts to connect to the
	// source failed.
	// enum = [RUNNING INACTIVE PENDING CANCELED FAILED CHECKING UNKNOWN]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OraclePDBSourceRuntimeStruct - Runtime (non-persistent) properties of an Oracle PDB source. extends OracleBaseSourceRuntime

func OraclePDBSourceRuntimeFactory 

func OraclePDBSourceRuntimeFactory(
	Accessible *bool,
	AccessibleTimestamp string,
	ActiveInstances []*OracleActiveInstanceStruct,
	DatabaseMode string,
	DatabaseRole string,
	DatabaseSize float64,
	DatabaseStats []*OracleDatabaseStatsSectionStruct,
	Enabled string,
	LastNonLoggedLocation string,
	NotAccessibleReason string,
	Status string,
) OraclePDBSourceRuntimeStruct

OraclePDBSourceRuntimeFactory is just a simple function to instantiate the OraclePDBSourceRuntimeStruct

type OraclePlatformParametersStruct 

type OraclePlatformParametersStruct struct {
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

OraclePlatformParametersStruct - Oracle platform-specific parameters that are stored on a transformation. extends BasePlatformParameters

func OraclePlatformParametersFactory 

func OraclePlatformParametersFactory() OraclePlatformParametersStruct

OraclePlatformParametersFactory is just a simple function to instantiate the OraclePlatformParametersStruct

type OracleProvisionParametersStruct 

type OracleProvisionParametersStruct struct {
	// The new container for the provisioned database.
	// required = true
	Container *OracleDatabaseContainerStruct `json:"container,omitempty"`
	// The security credential of the privileged user to run the
	// provision operation as.
	// create = optional
	Credential Credential `json:"credential,omitempty"`
	// Whether or not to mark this VDB as a masked VDB. It will be marked
	// as masked if this flag or the masking job are set.
	// create = optional
	// update = readonly
	Masked *bool `json:"masked,omitempty"`
	// The Masking Job to be run when this dataset is provisioned or
	// refreshed.
	// format = objectReference
	// referenceTo = /delphix-masking-job.json
	// create = optional
	// update = readonly
	MaskingJob string `json:"maskingJob,omitempty"`
	// Flag indicating whether to generate a new DBID for the provisioned
	// database.
	// create = optional
	// default = false
	NewDBID *bool `json:"newDBID,omitempty"`
	// Flag indicating whether to open the database after provision.
	// create = optional
	// default = true
	OpenResetlogs *bool `json:"openResetlogs,omitempty"`
	// Flag indicating whether the virtual database is provisioned as a
	// physical standby database.
	// create = optional
	// default = false
	PhysicalStandby *bool `json:"physicalStandby,omitempty"`
	// The source that describes an external database instance.
	// required = true
	Source *OracleVirtualSourceStruct `json:"source,omitempty"`
	// The source config including dynamically discovered attributes of
	// the source.
	// required = true
	SourceConfig OracleDBConfig `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base
	// provisioning on.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the provision operation as.
	// create = optional
	Username string `json:"username,omitempty"`
}

OracleProvisionParametersStruct - The parameters to use as input to provision Oracle (non-multitenant) databases. extends OracleBaseProvisionParameters

func OracleProvisionParametersFactory 

func OracleProvisionParametersFactory(
	Container *OracleDatabaseContainerStruct,
	Credential Credential,
	Masked *bool,
	MaskingJob string,
	NewDBID *bool,
	OpenResetlogs *bool,
	PhysicalStandby *bool,
	Source *OracleVirtualSourceStruct,
	SourceConfig OracleDBConfig,
	TimeflowPointParameters TimeflowPointParameters,
	Username string,
) OracleProvisionParametersStruct

OracleProvisionParametersFactory is just a simple function to instantiate the OracleProvisionParametersStruct

type OracleRACConfigStruct 

type OracleRACConfigStruct struct {
	// The container type of this database.
	// enum = [UNKNOWN ROOT_CDB NON_CDB AUX_CDB]
	// create = readonly
	// update = readonly
	CdbType string `json:"cdbType,omitempty"`
	// The password of the database user. This must be a
	// PasswordCredential instance.
	// update = optional
	Credentials *PasswordCredentialStruct `json:"credentials,omitempty"`
	// The Oracle Clusterware database name.
	// create = optional
	// maxLength = 30
	CrsDatabaseName string `json:"crsDatabaseName,omitempty"`
	// The name of the database.
	// create = required
	// pattern = ^[a-zA-Z0-9_$#]+$
	// maxLength = 8
	DatabaseName string `json:"databaseName,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// The list of RAC instances for this RAC configuration.
	// create = required
	// update = optional
	Instances []*OracleRACInstanceStruct `json:"instances,omitempty"`
	// Whether this source should be used for linking.
	// create = optional
	// update = optional
	// default = true
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The password of a database user that does not have administrative
	// privileges.
	// create = optional
	// update = optional
	NonSysCredentials string `json:"nonSysCredentials,omitempty"`
	// The username of a database user that does not have administrative
	// privileges.
	// create = optional
	// update = optional
	// maxLength = 30
	NonSysUser string `json:"nonSysUser,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// format = objectReference
	// referenceTo = /delphix-oracle-install.json
	// create = required
	// update = optional
	Repository string `json:"repository,omitempty"`
	// The list of database services.
	// create = optional
	// update = optional
	Services []*OracleServiceStruct `json:"services,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The unique name.
	// create = required
	// pattern = ^[a-zA-Z0-9_$#]+$
	// maxLength = 30
	UniqueName string `json:"uniqueName,omitempty"`
	// The username of the database user.
	// update = optional
	// maxLength = 30
	User string `json:"user,omitempty"`
}

OracleRACConfigStruct - Representation of the properties specific to a RAC Oracle DB configuration. extends OracleDBConfig

func OracleRACConfigFactory 

func OracleRACConfigFactory(
	Credentials *PasswordCredentialStruct,
	CrsDatabaseName string,
	DatabaseName string,
	Discovered *bool,
	EnvironmentUser string,
	Instances []*OracleRACInstanceStruct,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	NonSysCredentials string,
	NonSysUser string,
	Reference string,
	Repository string,
	Services []*OracleServiceStruct,
	UniqueName string,
	User string,
) OracleRACConfigStruct

OracleRACConfigFactory is just a simple function to instantiate the OracleRACConfigStruct

type OracleRACInstanceStruct 

type OracleRACInstanceStruct struct {
	// The name of the instance.
	// create = required
	// update = optional
	// pattern = ^[a-zA-Z0-9_]+$
	// maxLength = 15
	InstanceName string `json:"instanceName,omitempty"`
	// The number of the instance.
	// update = optional
	// minimum = 1
	// create = required
	InstanceNumber float64 `json:"instanceNumber,omitempty"`
	// Reference to the Oracle cluster node that the RAC instance is
	// running on.
	// format = objectReference
	// referenceTo = /delphix-oracle-cluster-node.json
	// create = required
	// update = optional
	Node string `json:"node,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleRACInstanceStruct - The representation of an Oracle Database RAC Instance Configuration. extends OracleInstance

func OracleRACInstanceFactory 

func OracleRACInstanceFactory(
	InstanceName string,
	InstanceNumber float64,
	Node string,
) OracleRACInstanceStruct

OracleRACInstanceFactory is just a simple function to instantiate the OracleRACInstanceStruct

type OracleRACSourceConnectionInfoStruct 

type OracleRACSourceConnectionInfoStruct struct {
	// The location of the cluster installation.
	CrsClusterHome string `json:"crsClusterHome,omitempty"`
	// The database name.
	DatabaseName string `json:"databaseName,omitempty"`
	// The JDBC strings used to connect to the source.
	JdbcStrings []string `json:"jdbcStrings,omitempty"`
	// The addresses for the nodes on which the source resides.
	Nodes []string `json:"nodes,omitempty"`
	// The Oracle installation home.
	OracleHome string `json:"oracleHome,omitempty"`
	// The default remote_listener parameter to be used for databases on
	// the cluster.
	RemoteListener string `json:"remoteListener,omitempty"`
	// The Single Client Access Name of the cluster (11.2 and greater
	// clusters only).
	Scan string `json:"scan,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The database version string.
	Version string `json:"version,omitempty"`
}

OracleRACSourceConnectionInfoStruct - Contains information that can be used to connect to a single instance Oracle source. extends OracleSourceConnectionInfo

func OracleRACSourceConnectionInfoFactory 

func OracleRACSourceConnectionInfoFactory(
	CrsClusterHome string,
	DatabaseName string,
	JdbcStrings []string,
	Nodes []string,
	OracleHome string,
	RemoteListener string,
	Scan string,
	Version string,
) OracleRACSourceConnectionInfoStruct

OracleRACSourceConnectionInfoFactory is just a simple function to instantiate the OracleRACSourceConnectionInfoStruct

type OracleRedoLogFileSpecificationStruct 

type OracleRedoLogFileSpecificationStruct struct {
	// The name of the data file, temporary file, or redo log.
	// pattern = ^[a-zA-Z0-9_\-\.]+$
	// create = optional
	// update = optional
	Filename string `json:"filename,omitempty"`
	// The size of the log file in MB.
	// create = optional
	// update = optional
	// minimum = 100
	// default = 100
	Size *int `json:"size,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleRedoLogFileSpecificationStruct - Describes an Oracle redo log file. extends OracleFileSpecification

func OracleRedoLogFileSpecificationFactory 

func OracleRedoLogFileSpecificationFactory(
	Filename string,
	Size *int,
) OracleRedoLogFileSpecificationStruct

OracleRedoLogFileSpecificationFactory is just a simple function to instantiate the OracleRedoLogFileSpecificationStruct

type OracleRefreshParametersStruct 

type OracleRefreshParametersStruct struct {
	// The security credential of the privileged user to run the refresh
	// operation as.
	Credential Credential `json:"credential,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to refresh the
	// database to.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the refresh operation as.
	Username string `json:"username,omitempty"`
}

OracleRefreshParametersStruct - The parameters to use as input to refresh Oracle databases. extends RefreshParameters

func OracleRefreshParametersFactory 

func OracleRefreshParametersFactory(
	Credential Credential,
	TimeflowPointParameters TimeflowPointParameters,
	Username string,
) OracleRefreshParametersStruct

OracleRefreshParametersFactory is just a simple function to instantiate the OracleRefreshParametersStruct

type OracleRollbackParametersStruct 

type OracleRollbackParametersStruct struct {
	// The security credential of the user who has the required
	// privileges to run the rollback operation.
	Credential Credential `json:"credential,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to roll the
	// database back to.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the user who has the required privileges to perform
	// the rollback operation.
	Username string `json:"username,omitempty"`
}

OracleRollbackParametersStruct - The parameters to use as input to roll back Oracle databases. extends RollbackParameters

func OracleRollbackParametersFactory 

func OracleRollbackParametersFactory(
	Credential Credential,
	TimeflowPointParameters TimeflowPointParameters,
	Username string,
) OracleRollbackParametersStruct

OracleRollbackParametersFactory is just a simple function to instantiate the OracleRollbackParametersStruct

type OracleSIConfigStruct 

type OracleSIConfigStruct struct {
	// The container type of this database.
	// enum = [UNKNOWN ROOT_CDB NON_CDB AUX_CDB]
	// create = readonly
	// update = readonly
	CdbType string `json:"cdbType,omitempty"`
	// The password of the database user. This must be a
	// PasswordCredential instance.
	// update = optional
	Credentials *PasswordCredentialStruct `json:"credentials,omitempty"`
	// The name of the database.
	// create = required
	// pattern = ^[a-zA-Z0-9_$#]+$
	// maxLength = 8
	DatabaseName string `json:"databaseName,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// The Oracle instance.
	// create = required
	// update = optional
	Instance *OracleInstanceStruct `json:"instance,omitempty"`
	// Whether this source should be used for linking.
	// update = optional
	// default = true
	// create = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// update = readonly
	// create = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The password of a database user that does not have administrative
	// privileges.
	// create = optional
	// update = optional
	NonSysCredentials string `json:"nonSysCredentials,omitempty"`
	// The username of a database user that does not have administrative
	// privileges.
	// create = optional
	// update = optional
	// maxLength = 30
	NonSysUser string `json:"nonSysUser,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// referenceTo = /delphix-oracle-install.json
	// create = required
	// update = optional
	// format = objectReference
	Repository string `json:"repository,omitempty"`
	// The list of database services.
	// create = optional
	// update = optional
	Services []*OracleServiceStruct `json:"services,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The unique name.
	// create = required
	// pattern = ^[a-zA-Z0-9_$#]+$
	// maxLength = 30
	UniqueName string `json:"uniqueName,omitempty"`
	// The username of the database user.
	// update = optional
	// maxLength = 30
	User string `json:"user,omitempty"`
}

OracleSIConfigStruct - The representation of a single-instance Oracle DB configuration. extends OracleDBConfig

func OracleSIConfigFactory 

func OracleSIConfigFactory(
	Credentials *PasswordCredentialStruct,
	DatabaseName string,
	Discovered *bool,
	EnvironmentUser string,
	Instance *OracleInstanceStruct,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	NonSysCredentials string,
	NonSysUser string,
	Reference string,
	Repository string,
	Services []*OracleServiceStruct,
	UniqueName string,
	User string,
) OracleSIConfigStruct

OracleSIConfigFactory is just a simple function to instantiate the OracleSIConfigStruct

type OracleSISourceConnectionInfoStruct 

type OracleSISourceConnectionInfoStruct struct {
	// The database name.
	DatabaseName string `json:"databaseName,omitempty"`
	// The hostname or IP address of the host where the source resides.
	Host string `json:"host,omitempty"`
	// The JDBC strings used to connect to the source.
	JdbcStrings []string `json:"jdbcStrings,omitempty"`
	// The Oracle installation home.
	OracleHome string `json:"oracleHome,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The database version string.
	Version string `json:"version,omitempty"`
}

OracleSISourceConnectionInfoStruct - Contains information that can be used to connect to a single instance Oracle source. extends OracleSourceConnectionInfo

func OracleSISourceConnectionInfoFactory 

func OracleSISourceConnectionInfoFactory(
	DatabaseName string,
	Host string,
	JdbcStrings []string,
	OracleHome string,
	Version string,
) OracleSISourceConnectionInfoStruct

OracleSISourceConnectionInfoFactory is just a simple function to instantiate the OracleSISourceConnectionInfoStruct

type OracleScanListenerStruct 

type OracleScanListenerStruct struct {
	// The list of client endpoints for this listener of the format
	// hostname:port. These are used when constructing the JDBC
	// connection string.
	// create = readonly
	// update = readonly
	ClientEndpoints []string `json:"clientEndpoints,omitempty"`
	// Whether this listener was automatically discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// Reference to the environment this listener is associated with.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = required
	Environment string `json:"environment,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The list of protocol addresses for this listener. These are used
	// for the local_listener parameter when provisioning VDBs.
	// minItems = 1
	// create = required
	// update = optional
	ProtocolAddresses []string `json:"protocolAddresses,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleScanListenerStruct - An Oracle scan listener. extends OracleListener

func OracleScanListenerFactory 

func OracleScanListenerFactory(
	Discovered *bool,
	Environment string,
	Name string,
	Namespace string,
	ProtocolAddresses []string,
	Reference string,
) OracleScanListenerStruct

OracleScanListenerFactory is just a simple function to instantiate the OracleScanListenerStruct

type OracleServiceStruct 

type OracleServiceStruct struct {
	// Whether this service was automatically discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The connection string used to connect to JDBC.
	// update = optional
	// format = oracleJDBCConnectionString
	// create = required
	JdbcConnectionString string `json:"jdbcConnectionString,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleServiceStruct - The representation of an oracle service object. extends TypedObject

func OracleServiceFactory 

func OracleServiceFactory(
	Discovered *bool,
	JdbcConnectionString string,
) OracleServiceStruct

OracleServiceFactory is just a simple function to instantiate the OracleServiceStruct

type OracleSnapshotRuntimeStruct 

type OracleSnapshotRuntimeStruct struct {
	// List of missing log files for this snapshot, if any.
	MissingLogs []*OracleLogStruct `json:"missingLogs,omitempty"`
	// True if this snapshot can be used as the basis for provisioning a
	// new TimeFlow.
	Provisionable *bool `json:"provisionable,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleSnapshotRuntimeStruct - Runtime (non-persistent) properties of an Oracle TimeFlow snapshot. extends SnapshotRuntime

func OracleSnapshotRuntimeFactory 

func OracleSnapshotRuntimeFactory(
	MissingLogs []*OracleLogStruct,
	Provisionable *bool,
) OracleSnapshotRuntimeStruct

OracleSnapshotRuntimeFactory is just a simple function to instantiate the OracleSnapshotRuntimeStruct

type OracleSnapshotStruct 

type OracleSnapshotStruct struct {
	// A value in the set {CONSISTENT, INCONSISTENT, CRASH_CONSISTENT}
	// indicating what type of recovery strategies must be invoked when
	// provisioning from this snapshot.
	Consistency string `json:"consistency,omitempty"`
	// Reference to the database of which this TimeFlow is a part.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Point in time at which this snapshot was created. This may be
	// different from the time corresponding to the TimeFlow.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// The location within the parent TimeFlow at which this snapshot was
	// initiated.
	FirstChangePoint *OracleTimeflowPointStruct `json:"firstChangePoint,omitempty"`
	// Auxiliary TimeFlows with snapshots controlled by this master
	// snapshot.
	FractionTimeflows []string `json:"fractionTimeflows,omitempty"`
	// True if this snapshot was taken of a standby database.
	// create = optional
	// default = false
	FromPhysicalStandbyVdb *bool `json:"fromPhysicalStandbyVdb,omitempty"`
	// The location of the snapshot within the parent TimeFlow
	// represented by this snapshot.
	LatestChangePoint *OracleTimeflowPointStruct `json:"latestChangePoint,omitempty"`
	// Boolean value indicating if a virtual database provisioned from
	// this snapshot will be missing nologging changes.
	MissingNonLoggedData *bool `json:"missingNonLoggedData,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// Online redo log size in bytes when this snapshot was taken.
	// create = optional
	RedoLogSizeInBytes float64 `json:"redoLogSizeInBytes,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Retention policy, in days. A value of -1 indicates the snapshot
	// should be kept forever.
	// update = optional
	Retention *int `json:"retention,omitempty"`
	// Runtime properties of the snapshot.
	Runtime *OracleSnapshotRuntimeStruct `json:"runtime,omitempty"`
	// Boolean value indicating that this snapshot is in a transient
	// state and should not be user visible.
	Temporary *bool `json:"temporary,omitempty"`
	// TimeFlow of which this snapshot is a part.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Time zone of the source database at the time the snapshot was
	// taken.
	Timezone string `json:"timezone,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of database source repository at the time the snapshot was
	// taken.
	Version string `json:"version,omitempty"`
}

OracleSnapshotStruct - Provisionable snapshot of an Oracle TimeFlow. extends TimeflowSnapshot

func OracleSnapshotFactory 

func OracleSnapshotFactory(
	Consistency string,
	Container string,
	CreationTime string,
	FirstChangePoint *OracleTimeflowPointStruct,
	FractionTimeflows []string,
	FromPhysicalStandbyVdb *bool,
	LatestChangePoint *OracleTimeflowPointStruct,
	MissingNonLoggedData *bool,
	Name string,
	Namespace string,
	RedoLogSizeInBytes float64,
	Reference string,
	Retention *int,
	Runtime *OracleSnapshotRuntimeStruct,
	Temporary *bool,
	Timeflow string,
	Timezone string,
	Version string,
) OracleSnapshotStruct

OracleSnapshotFactory is just a simple function to instantiate the OracleSnapshotStruct

type OracleSource 

type OracleSource interface{}

OracleSource is an empty interface designed to function as the OracleSource API namespace

type OracleSourceConnectionInfo 

type OracleSourceConnectionInfo interface{}

OracleSourceConnectionInfo is an empty interface designed to function as the OracleSourceConnectionInfo API namespace

type OracleSourceRuntimeStruct 

type OracleSourceRuntimeStruct struct {
	// True if the source is JDBC accessible. If false then no properties
	// can be retrieved.
	Accessible *bool `json:"accessible,omitempty"`
	// The time that the 'accessible' propery was last checked.
	// format = date
	AccessibleTimestamp string `json:"accessibleTimestamp,omitempty"`
	// List of active database instances for the source.
	ActiveInstances []*OracleActiveInstanceStruct `json:"activeInstances,omitempty"`
	// True if the database is running in ARCHIVELOG mode.
	ArchivelogEnabled *bool `json:"archivelogEnabled,omitempty"`
	// True if block change tracking is enabled.
	BctEnabled *bool `json:"bctEnabled,omitempty"`
	// Operating mode of the database.
	// default = UNKNOWN
	// enum = [READ_WRITE READ_ONLY STANDBY_READ_ONLY MOUNTED_ONLY UNKNOWN]
	DatabaseMode string `json:"databaseMode,omitempty"`
	// The current role of the database.
	// default = UNKNOWN
	// enum = [PHYSICAL_STANDBY LOGICAL_STANDBY SNAPSHOT_STANDBY FAR_SYNC PRIMARY UNKNOWN]
	DatabaseRole string `json:"databaseRole,omitempty"`
	// Size of the database in bytes.
	// units = B
	// base = 1024
	DatabaseSize float64 `json:"databaseSize,omitempty"`
	// Table of key database performance statistics.
	DatabaseStats []*OracleDatabaseStatsSectionStruct `json:"databaseStats,omitempty"`
	// True if the database has Oracle Direct NFS client enabled.
	DnfsEnabled *bool `json:"dnfsEnabled,omitempty"`
	// Status indicating whether the source is enabled. A source has a
	// 'PARTIAL' status if its sub-sources are not all enabled.
	// enum = [ENABLED PARTIAL DISABLED]
	Enabled string `json:"enabled,omitempty"`
	// Highest SCN at which non-logged changes were generated.
	LastNonLoggedLocation string `json:"lastNonLoggedLocation,omitempty"`
	// The reason why the source is not JDBC accessible.
	NotAccessibleReason string `json:"notAccessibleReason,omitempty"`
	// True for a RAC source database.
	RacEnabled *bool `json:"racEnabled,omitempty"`
	// Status of the source. 'Unknown' if all attempts to connect to the
	// source failed.
	// enum = [RUNNING INACTIVE PENDING CANCELED FAILED CHECKING UNKNOWN]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleSourceRuntimeStruct - Runtime (non-persistent) properties of an Oracle source. extends OracleBaseSourceRuntime

func OracleSourceRuntimeFactory 

func OracleSourceRuntimeFactory(
	Accessible *bool,
	AccessibleTimestamp string,
	ActiveInstances []*OracleActiveInstanceStruct,
	ArchivelogEnabled *bool,
	BctEnabled *bool,
	DatabaseMode string,
	DatabaseRole string,
	DatabaseSize float64,
	DatabaseStats []*OracleDatabaseStatsSectionStruct,
	DnfsEnabled *bool,
	Enabled string,
	LastNonLoggedLocation string,
	NotAccessibleReason string,
	RacEnabled *bool,
	Status string,
) OracleSourceRuntimeStruct

OracleSourceRuntimeFactory is just a simple function to instantiate the OracleSourceRuntimeStruct

type OracleSourcingPolicyStruct 

type OracleSourcingPolicyStruct struct {
	// True if LogSync should run for this database.
	// create = optional
	// update = optional
	// default = false
	LogsyncEnabled *bool `json:"logsyncEnabled,omitempty"`
	// Interval between LogSync requests, in seconds.
	// create = optional
	// update = optional
	// units = sec
	// default = 5
	LogsyncInterval *int `json:"logsyncInterval,omitempty"`
	// LogSync operation mode for this database.
	// enum = [ARCHIVE_ONLY_MODE ARCHIVE_REDO_MODE UNDEFINED]
	// create = optional
	// update = optional
	// default = UNDEFINED
	LogsyncMode string `json:"logsyncMode,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleSourcingPolicyStruct - Database policies for managing SnapSync and LogSync across sources for an Oracle container. extends SourcingPolicy

func OracleSourcingPolicyFactory 

func OracleSourcingPolicyFactory(
	LogsyncEnabled *bool,
	LogsyncInterval *int,
	LogsyncMode string,
) OracleSourcingPolicyStruct

OracleSourcingPolicyFactory is just a simple function to instantiate the OracleSourcingPolicyStruct

type OracleStagingSourceParametersStruct 

type OracleStagingSourceParametersStruct struct {
	// Oracle database configuration parameter overrides.
	// update = optional
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Optional database template to use for staging database creation.
	// If set, configParams will be ignored.
	// format = objectReference
	// referenceTo = /delphix-database-template.json
	// create = optional
	// update = optional
	ConfigTemplate string `json:"configTemplate,omitempty"`
	// The user used to create and manage the configuration.
	// create = optional
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// The base mount point to use for the NFS mounts.
	// create = required
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// The object reference of the source repository that will host the
	// LogSync staging database.
	// format = objectReference
	// referenceTo = /delphix-oracle-install.json
	// create = required
	// update = optional
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleStagingSourceParametersStruct - Parameters provided by the user to create a staging database. extends TypedObject

func OracleStagingSourceParametersFactory 

func OracleStagingSourceParametersFactory(
	ConfigParams map[string]string,
	ConfigTemplate string,
	EnvironmentUser string,
	MountBase string,
	Repository string,
) OracleStagingSourceParametersStruct

OracleStagingSourceParametersFactory is just a simple function to instantiate the OracleStagingSourceParametersStruct

type OracleStagingSourceStruct 

type OracleStagingSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Oracle database configuration parameter overrides.
	// create = optional
	// update = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Optional database template to use for provisioning and refresh. If
	// set, configParams will be ignored on provision or refresh.
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-database-template.json
	// create = optional
	ConfigTemplate string `json:"configTemplate,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point to use for the NFS mounts.
	// create = required
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A list of object references to Oracle Node Listeners selected for
	// this Managed Database. Delphix picks one default listener from the
	// target environment if this list is empty at virtual database
	// provision time.
	// create = optional
	// update = optional
	NodeListeners []string `json:"nodeListeners,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties for this Oracle source.
	Runtime OracleBaseSourceRuntime `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

OracleStagingSourceStruct - A staging Oracle source used for Delphix operations such as log collection and snapshot generation. extends OracleManagedSource

func OracleStagingSourceFactory 

func OracleStagingSourceFactory(
	Config string,
	ConfigParams map[string]string,
	ConfigTemplate string,
	Container string,
	Description string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	NodeListeners []string,
	Reference string,
	Runtime OracleBaseSourceRuntime,
	Staging *bool,
	Status string,
	Virtual *bool,
) OracleStagingSourceStruct

OracleStagingSourceFactory is just a simple function to instantiate the OracleStagingSourceStruct

type OracleStartParametersStruct 

type OracleStartParametersStruct struct {
	// The security credential of the privileged user to run the
	// provision operation as.
	Credential Credential `json:"credential,omitempty"`
	// List of specific Oracle instances to start.
	Instances []float64 `json:"instances,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the provision operation as.
	Username string `json:"username,omitempty"`
}

OracleStartParametersStruct - The parameters to use as input to start oracle sources. extends SourceStartParameters

func OracleStartParametersFactory 

func OracleStartParametersFactory(
	Credential Credential,
	Instances []float64,
	Username string,
) OracleStartParametersStruct

OracleStartParametersFactory is just a simple function to instantiate the OracleStartParametersStruct

type OracleStopParametersStruct 

type OracleStopParametersStruct struct {
	// Whether to issue 'shutdown abort' to shutdown Oracle instances.
	// default = false
	Abort *bool `json:"abort,omitempty"`
	// The security credential of the privileged user to run the
	// provision operation as.
	Credential Credential `json:"credential,omitempty"`
	// List of specific Oracle instances to stop.
	Instances []float64 `json:"instances,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The name of the privileged user to run the provision operation as.
	Username string `json:"username,omitempty"`
}

OracleStopParametersStruct - The parameters to use as input to stop oracle sources. extends SourceStopParameters

func OracleStopParametersFactory 

func OracleStopParametersFactory(
	Abort *bool,
	Credential Credential,
	Instances []float64,
	Username string,
) OracleStopParametersStruct

OracleStopParametersFactory is just a simple function to instantiate the OracleStopParametersStruct

type OracleSyncParametersStruct 

type OracleSyncParametersStruct struct {
	// Indicates whether a fresh SnapSync must be started regardless if
	// it was possible to resume the current SnapSync. If true, we will
	// not resume but instead ignore previous progress and backup all
	// datafiles even if already completed from previous failed SnapSync.
	// This does not force a full backup, if an incremental was in
	// progress this will start a new incremental snapshot.
	// default = false
	// create = optional
	DoNotResume *bool `json:"doNotResume,omitempty"`
	// True if two SnapSyncs should be performed in immediate succession
	// to reduce the number of logs required to provision the snapshot.
	// This may significantly reduce the time necessary to provision from
	// a snapshot.
	// create = optional
	// default = false
	DoubleSync *bool `json:"doubleSync,omitempty"`
	// Whether or not to take another full backup of the source database.
	// default = false
	ForceFullBackup *bool `json:"forceFullBackup,omitempty"`
	// Skip check that tests if there is enough space available to store
	// the database in the Delphix Engine. The Delphix Engine estimates
	// how much space a database will occupy after compression and
	// prevents SnapSync if insufficient space is available. This
	// safeguard can be overridden using this option. This may be useful
	// when linking highly compressible databases.
	// default = false
	// create = optional
	SkipSpaceCheck *bool `json:"skipSpaceCheck,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleSyncParametersStruct - The parameters to use as input to sync Oracle databases. extends SyncParameters

func CreateOracleSyncParameters 

func CreateOracleSyncParameters(
	DoNotResume *bool,
	DoubleSync *bool,
	ForceFullBackup *bool,
	SkipSpaceCheck *bool,
) OracleSyncParametersStruct

func OracleSyncParametersFactory 

func OracleSyncParametersFactory(
	DoNotResume *bool,
	DoubleSync *bool,
	ForceFullBackup *bool,
	SkipSpaceCheck *bool,
) OracleSyncParametersStruct

OracleSyncParametersFactory is just a simple function to instantiate the OracleSyncParametersStruct

type OracleSysauxDatafileSpecificationStruct 

type OracleSysauxDatafileSpecificationStruct struct {
	// Enable or disable the automatic extension of a new or existing
	// datafile or tempfile.
	// create = optional
	// update = optional
	// default = true
	AutoExtend *bool `json:"autoExtend,omitempty"`
	// The size in MB of the next increment of disk space to be allocated
	// automatically when more extents are required. The default is the
	// size of one data block.
	// create = optional
	// update = optional
	AutoExtendIncrement *int `json:"autoExtendIncrement,omitempty"`
	// The name of the data file, temporary file, or redo log.
	// pattern = ^[a-zA-Z0-9_\-\.]+$
	// create = optional
	// update = optional
	Filename string `json:"filename,omitempty"`
	// The maximum disk space allowed for automatic extension of the
	// datafile. Omit this if you do not want to limit the disk space
	// that Oracle can allocate to the datafile or tempfile.
	// create = optional
	// update = optional
	MaxSize *int `json:"maxSize,omitempty"`
	// The size of the file in MB.
	// create = optional
	// update = optional
	// minimum = 900
	// default = 900
	Size *int `json:"size,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleSysauxDatafileSpecificationStruct - Describes an Oracle datafile in the SYSAUX tablespace. extends OracleDatafileTempfileSpecification

func OracleSysauxDatafileSpecificationFactory 

func OracleSysauxDatafileSpecificationFactory(
	AutoExtend *bool,
	AutoExtendIncrement *int,
	Filename string,
	MaxSize *int,
	Size *int,
) OracleSysauxDatafileSpecificationStruct

OracleSysauxDatafileSpecificationFactory is just a simple function to instantiate the OracleSysauxDatafileSpecificationStruct

type OracleSystemDatafileSpecificationStruct 

type OracleSystemDatafileSpecificationStruct struct {
	// Enable or disable the automatic extension of a new or existing
	// datafile or tempfile.
	// default = true
	// create = optional
	// update = optional
	AutoExtend *bool `json:"autoExtend,omitempty"`
	// The size in MB of the next increment of disk space to be allocated
	// automatically when more extents are required. The default is the
	// size of one data block.
	// create = optional
	// update = optional
	AutoExtendIncrement *int `json:"autoExtendIncrement,omitempty"`
	// The name of the data file, temporary file, or redo log.
	// pattern = ^[a-zA-Z0-9_\-\.]+$
	// create = optional
	// update = optional
	Filename string `json:"filename,omitempty"`
	// The maximum disk space allowed for automatic extension of the
	// datafile. Omit this if you do not want to limit the disk space
	// that Oracle can allocate to the datafile or tempfile.
	// create = optional
	// update = optional
	MaxSize *int `json:"maxSize,omitempty"`
	// The size of the file in MB.
	// update = optional
	// minimum = 700
	// default = 700
	// create = optional
	Size *int `json:"size,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleSystemDatafileSpecificationStruct - Describes an Oracle datafile in the SYSTEM tablespace. extends OracleDatafileTempfileSpecification

func OracleSystemDatafileSpecificationFactory 

func OracleSystemDatafileSpecificationFactory(
	AutoExtend *bool,
	AutoExtendIncrement *int,
	Filename string,
	MaxSize *int,
	Size *int,
) OracleSystemDatafileSpecificationStruct

OracleSystemDatafileSpecificationFactory is just a simple function to instantiate the OracleSystemDatafileSpecificationStruct

type OracleTempfileSpecificationStruct 

type OracleTempfileSpecificationStruct struct {
	// Enable or disable the automatic extension of a new or existing
	// datafile or tempfile.
	// create = optional
	// update = optional
	// default = true
	AutoExtend *bool `json:"autoExtend,omitempty"`
	// The size in MB of the next increment of disk space to be allocated
	// automatically when more extents are required. The default is the
	// size of one data block.
	// create = optional
	// update = optional
	AutoExtendIncrement *int `json:"autoExtendIncrement,omitempty"`
	// The name of the data file, temporary file, or redo log.
	// pattern = ^[a-zA-Z0-9_\-\.]+$
	// create = optional
	// update = optional
	Filename string `json:"filename,omitempty"`
	// The maximum disk space allowed for automatic extension of the
	// datafile. Omit this if you do not want to limit the disk space
	// that Oracle can allocate to the datafile or tempfile.
	// create = optional
	// update = optional
	MaxSize *int `json:"maxSize,omitempty"`
	// The size of the file in MB.
	// default = 300
	// create = optional
	// update = optional
	// minimum = 300
	Size *int `json:"size,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleTempfileSpecificationStruct - Describes an Oracle temporary file. extends OracleDatafileTempfileSpecification

func OracleTempfileSpecificationFactory 

func OracleTempfileSpecificationFactory(
	AutoExtend *bool,
	AutoExtendIncrement *int,
	Filename string,
	MaxSize *int,
	Size *int,
) OracleTempfileSpecificationStruct

OracleTempfileSpecificationFactory is just a simple function to instantiate the OracleTempfileSpecificationStruct

type OracleTimeflowLog 

type OracleTimeflowLog interface{}

OracleTimeflowLog is an empty interface designed to function as the OracleTimeflowLog API namespace

type OracleTimeflowPointStruct 

type OracleTimeflowPointStruct struct {
	// The TimeFlow location.
	// create = optional
	Location string `json:"location,omitempty"`
	// Reference to TimeFlow containing this point.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-oracle-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// The logical time corresponding to the TimeFlow location.
	// format = date
	// create = optional
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleTimeflowPointStruct - A unique point within an Oracle database TimeFlow. extends TimeflowPoint

func OracleTimeflowPointFactory 

func OracleTimeflowPointFactory(
	Location string,
	Timeflow string,
	Timestamp string,
) OracleTimeflowPointStruct

OracleTimeflowPointFactory is just a simple function to instantiate the OracleTimeflowPointStruct

type OracleTimeflowStruct 

type OracleTimeflowStruct struct {
	// Reference to the mirror CDB TimeFlow if this is a PDB TimeFlow.
	// format = objectReference
	// referenceTo = /delphix-oracle-timeflow.json
	CdbTimeflow string `json:"cdbTimeflow,omitempty"`
	// Reference to the data container (database) for this TimeFlow.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// The source action that created the TimeFlow.
	// enum = [INITIAL INDETERMINATE REFRESH ROLLBACK TEMPORARY TRANSFORMATION V2P PDB_PLUG WAREHOUSE ORACLE_LIVE_SOURCE_RESYNC SOURCE_CONTINUITY]
	CreationType string `json:"creationType,omitempty"`
	// Oracle-specific incarnation identifier for this TimeFlow.
	IncarnationID string `json:"incarnationID,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The origin point on the parent TimeFlow from which this TimeFlow
	// was provisioned. This will not be present for TimeFlows derived
	// from linked sources.
	ParentPoint *OracleTimeflowPointStruct `json:"parentPoint,omitempty"`
	// Reference to the parent snapshot that serves as the provisioning
	// base for this object. This may be different from the snapshot
	// within the parent point, and is only present for virtual
	// TimeFlows.
	// format = objectReference
	// referenceTo = /delphix-timeflow-snapshot.json
	ParentSnapshot string `json:"parentSnapshot,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Set to true if the TimeFlow represents a warehouse.
	// featureFlag = CONSPRO
	Warehouse *bool `json:"warehouse,omitempty"`
	// Reference to the TimeFlow of the warehouse that this TimeFlow is a
	// part of.
	// featureFlag = CONSPRO
	// format = objectReference
	// referenceTo = /delphix-oracle-timeflow.json
	WarehouseTimeflow string `json:"warehouseTimeflow,omitempty"`
}

OracleTimeflowStruct - TimeFlow representing historical data for a particular timeline within a data container. extends Timeflow

func OracleTimeflowFactory 

func OracleTimeflowFactory(
	CdbTimeflow string,
	Container string,
	CreationType string,
	IncarnationID string,
	Name string,
	Namespace string,
	ParentPoint *OracleTimeflowPointStruct,
	ParentSnapshot string,
	Reference string,
	Warehouse *bool,
	WarehouseTimeflow string,
) OracleTimeflowStruct

OracleTimeflowFactory is just a simple function to instantiate the OracleTimeflowStruct

type OracleUndoDatafileSpecificationStruct 

type OracleUndoDatafileSpecificationStruct struct {
	// Enable or disable the automatic extension of a new or existing
	// datafile or tempfile.
	// default = true
	// create = optional
	// update = optional
	AutoExtend *bool `json:"autoExtend,omitempty"`
	// The size in MB of the next increment of disk space to be allocated
	// automatically when more extents are required. The default is the
	// size of one data block.
	// create = optional
	// update = optional
	AutoExtendIncrement *int `json:"autoExtendIncrement,omitempty"`
	// The name of the data file, temporary file, or redo log.
	// pattern = ^[a-zA-Z0-9_\-\.]+$
	// create = optional
	// update = optional
	Filename string `json:"filename,omitempty"`
	// The maximum disk space allowed for automatic extension of the
	// datafile. Omit this if you do not want to limit the disk space
	// that Oracle can allocate to the datafile or tempfile.
	// create = optional
	// update = optional
	MaxSize *int `json:"maxSize,omitempty"`
	// The size of the file in MB.
	// create = optional
	// update = optional
	// minimum = 300
	// default = 300
	Size *int `json:"size,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleUndoDatafileSpecificationStruct - Describes an Oracle datafile that stores undo data. extends OracleDatafileTempfileSpecification

func OracleUndoDatafileSpecificationFactory 

func OracleUndoDatafileSpecificationFactory(
	AutoExtend *bool,
	AutoExtendIncrement *int,
	Filename string,
	MaxSize *int,
	Size *int,
) OracleUndoDatafileSpecificationStruct

OracleUndoDatafileSpecificationFactory is just a simple function to instantiate the OracleUndoDatafileSpecificationStruct

type OracleVirtualCdbProvisionParametersStruct 

type OracleVirtualCdbProvisionParametersStruct struct {
	// The new container for the created database.
	// required = true
	Container *OracleDatabaseContainerStruct `json:"container,omitempty"`
	// The source that describes an external database instance.
	// required = true
	Source *OracleVirtualCdbSourceStruct `json:"source,omitempty"`
	// The source config including dynamically discovered attributes of
	// the source.
	// required = true
	SourceConfig OracleDBConfig `json:"sourceConfig,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleVirtualCdbProvisionParametersStruct - The parameters to use as input to provision Oracle virtual container databases. extends TypedObject

func OracleVirtualCdbProvisionParametersFactory 

func OracleVirtualCdbProvisionParametersFactory(
	Container *OracleDatabaseContainerStruct,
	Source *OracleVirtualCdbSourceStruct,
	SourceConfig OracleDBConfig,
) OracleVirtualCdbProvisionParametersStruct

OracleVirtualCdbProvisionParametersFactory is just a simple function to instantiate the OracleVirtualCdbProvisionParametersStruct

type OracleVirtualCdbSourceStruct 

type OracleVirtualCdbSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// create = required
	// update = optional
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Archive Log Mode of the Oracle virtual database. NOARCHIVELOG mode
	// is currently not supported for virtual container databases.
	// default = true
	// create = readonly
	// update = readonly
	ArchivelogMode *bool `json:"archivelogMode,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Oracle database configuration parameter overrides.
	// create = optional
	// update = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Optional database template to use for provisioning and refresh. If
	// set, configParams will be ignored on provision or refresh.
	// referenceTo = /delphix-database-template.json
	// create = optional
	// update = optional
	// format = objectReference
	ConfigTemplate string `json:"configTemplate,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Custom environment variables for Oracle databases. These can only
	// be set at the PDB level. Delphix applies the PDB setting to the
	// virtual CDB.
	// create = readonly
	// update = readonly
	CustomEnvVars []OracleCustomEnvVar `json:"customEnvVars,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules. These can only be set at the PDB
	// level. Delphix applies the PDB setting to the virtual CDB.
	// create = readonly
	// update = readonly
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// update = optional
	// default = false
	// create = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point to use for the NFS mounts.
	// maxLength = 256
	// create = required
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// create = optional
	// update = optional
	// maxLength = 256
	// format = objectName
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A list of object references to Oracle Node Listeners selected for
	// this Virtual Database. Delphix picks one default listener from the
	// target environment if this list is empty at virtual database
	// provision time. This is currently not supported for virtual
	// container databases.
	// create = readonly
	// update = readonly
	NodeListeners []string `json:"nodeListeners,omitempty"`
	// User-specified operation hooks for this source. This is currently
	// not supported for virtual container databases.
	// create = readonly
	// update = readonly
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// Number of Online Redo Log Groups. Customizing number of Online
	// Redo Log Groups is currently not supported for virtual container
	// databases.
	// create = readonly
	// update = readonly
	RedoLogGroups *int `json:"redoLogGroups,omitempty"`
	// Online Redo Log size in MB. Customizing Online Redo Log size is
	// currently not supported for virtual container databases.
	// create = readonly
	// update = readonly
	RedoLogSizeInMB *int `json:"redoLogSizeInMB,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties for this Oracle source.
	Runtime OracleBaseSourceRuntime `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

OracleVirtualCdbSourceStruct - A virtual Oracle multitenant container database source. Certain fields of the Oracle virtual source are not applicable to the virtual container database. extends OracleVirtualSource

func OracleVirtualCdbSourceFactory 

func OracleVirtualCdbSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	ArchivelogMode *bool,
	Config string,
	ConfigParams map[string]string,
	ConfigTemplate string,
	Container string,
	CustomEnvVars []OracleCustomEnvVar,
	Description string,
	FileMappingRules string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	NodeListeners []string,
	Operations *VirtualSourceOperationsStruct,
	RedoLogGroups *int,
	RedoLogSizeInMB *int,
	Reference string,
	Runtime OracleBaseSourceRuntime,
	Staging *bool,
	Status string,
	Virtual *bool,
) OracleVirtualCdbSourceStruct

OracleVirtualCdbSourceFactory is just a simple function to instantiate the OracleVirtualCdbSourceStruct

type OracleVirtualIPStruct 

type OracleVirtualIPStruct struct {
	// A boolean indicating whether this VIP was automatically
	// discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The name of the domain where the cluster is residing.
	// required = true
	DomainName string `json:"domainName,omitempty"`
	// The virtual IP address.
	// format = ipv4Address
	// required = true
	Ip string `json:"ip,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

OracleVirtualIPStruct - The parameters used for virtual IP operations. extends TypedObject

func OracleVirtualIPFactory 

func OracleVirtualIPFactory(
	Discovered *bool,
	DomainName string,
	Ip string,
) OracleVirtualIPStruct

OracleVirtualIPFactory is just a simple function to instantiate the OracleVirtualIPStruct

type OracleVirtualPdbSourceStruct 

type OracleVirtualPdbSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// create = required
	// update = optional
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Archive Log Mode of the Oracle virtual database. This is not
	// applicable to pluggable databases.
	// create = readonly
	// update = readonly
	ArchivelogMode *bool `json:"archivelogMode,omitempty"`
	// Reference to the configuration for the source.
	// referenceTo = /delphix-source-config.json
	// create = optional
	// format = objectReference
	Config string `json:"config,omitempty"`
	// Oracle database configuration parameter overrides. This is
	// currently not supported for pluggable databases.
	// create = readonly
	// update = readonly
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Optional database template to use for provisioning and refresh. If
	// set, configParams will be ignored on provision or refresh. This is
	// currently not supported for pluggable databases.
	// update = readonly
	// format = objectReference
	// referenceTo = /delphix-database-template.json
	// create = readonly
	ConfigTemplate string `json:"configTemplate,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Custom environment variables for Oracle databases.
	// create = optional
	// update = optional
	CustomEnvVars []OracleCustomEnvVar `json:"customEnvVars,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point to use for the NFS mounts.
	// create = required
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A list of object references to Oracle Node Listeners selected for
	// this Virtual Database. Delphix picks one default listener from the
	// target environment if this list is empty at virtual database
	// provision time. This is not applicable to pluggable databases.
	// create = readonly
	// update = readonly
	NodeListeners []string `json:"nodeListeners,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// Number of Online Redo Log Groups. This is not applicable to
	// pluggable databases.
	// create = readonly
	// update = readonly
	RedoLogGroups *int `json:"redoLogGroups,omitempty"`
	// Online Redo Log size in MB. This is not applicable to pluggable
	// databases.
	// update = readonly
	// create = readonly
	RedoLogSizeInMB *int `json:"redoLogSizeInMB,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties for this Oracle source.
	Runtime OracleBaseSourceRuntime `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

OracleVirtualPdbSourceStruct - A virtual Oracle multitenant pluggable database source. extends OracleVirtualSource

func OracleVirtualPdbSourceFactory 

func OracleVirtualPdbSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	ArchivelogMode *bool,
	Config string,
	ConfigParams map[string]string,
	ConfigTemplate string,
	Container string,
	CustomEnvVars []OracleCustomEnvVar,
	Description string,
	FileMappingRules string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	NodeListeners []string,
	Operations *VirtualSourceOperationsStruct,
	RedoLogGroups *int,
	RedoLogSizeInMB *int,
	Reference string,
	Runtime OracleBaseSourceRuntime,
	Staging *bool,
	Status string,
	Virtual *bool,
) OracleVirtualPdbSourceStruct

OracleVirtualPdbSourceFactory is just a simple function to instantiate the OracleVirtualPdbSourceStruct

type OracleVirtualSourceStruct 

type OracleVirtualSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// update = optional
	// create = required
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Archive Log Mode of the Oracle virtual database.
	// create = optional
	// update = readonly
	// default = true
	ArchivelogMode *bool `json:"archivelogMode,omitempty"`
	// Reference to the configuration for the source.
	// referenceTo = /delphix-source-config.json
	// create = optional
	// format = objectReference
	Config string `json:"config,omitempty"`
	// Oracle database configuration parameter overrides.
	// create = optional
	// update = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Optional database template to use for provisioning and refresh. If
	// set, configParams will be ignored on provision or refresh.
	// format = objectReference
	// referenceTo = /delphix-database-template.json
	// create = optional
	// update = optional
	ConfigTemplate string `json:"configTemplate,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Custom environment variables for Oracle databases.
	// create = optional
	// update = optional
	CustomEnvVars []OracleCustomEnvVar `json:"customEnvVars,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// update = optional
	// default = false
	// create = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point to use for the NFS mounts.
	// create = required
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A list of object references to Oracle Node Listeners selected for
	// this Managed Database. Delphix picks one default listener from the
	// target environment if this list is empty at virtual database
	// provision time.
	// create = optional
	// update = optional
	NodeListeners []string `json:"nodeListeners,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// Number of Online Redo Log Groups.
	// create = optional
	// update = readonly
	// minimum = 2
	// default = 3
	RedoLogGroups *int `json:"redoLogGroups,omitempty"`
	// Online Redo Log size in MB.
	// create = optional
	// update = readonly
	// minimum = 4
	RedoLogSizeInMB *int `json:"redoLogSizeInMB,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties for this Oracle source.
	Runtime OracleBaseSourceRuntime `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

OracleVirtualSourceStruct - A virtual Oracle source. extends OracleManagedSource

func OracleVirtualSourceFactory 

func OracleVirtualSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	ArchivelogMode *bool,
	Config string,
	ConfigParams map[string]string,
	ConfigTemplate string,
	Container string,
	CustomEnvVars []OracleCustomEnvVar,
	Description string,
	FileMappingRules string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	NodeListeners []string,
	Operations *VirtualSourceOperationsStruct,
	RedoLogGroups *int,
	RedoLogSizeInMB *int,
	Reference string,
	Runtime OracleBaseSourceRuntime,
	Staging *bool,
	Status string,
	Virtual *bool,
) OracleVirtualSourceStruct

OracleVirtualSourceFactory is just a simple function to instantiate the OracleVirtualSourceStruct

type OracleWarehouseSourceStruct 

type OracleWarehouseSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// create = required
	// update = optional
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Archive Log Mode of the Oracle virtual database.
	// update = readonly
	// default = true
	// create = optional
	ArchivelogMode *bool `json:"archivelogMode,omitempty"`
	// Reference to the configuration for the source.
	// create = optional
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	Config string `json:"config,omitempty"`
	// Oracle database configuration parameter overrides.
	// create = optional
	// update = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Optional database template to use for provisioning and refresh. If
	// set, configParams will be ignored on provision or refresh.
	// create = optional
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-database-template.json
	ConfigTemplate string `json:"configTemplate,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Custom environment variables for Oracle databases.
	// update = optional
	// create = optional
	CustomEnvVars []OracleCustomEnvVar `json:"customEnvVars,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// update = optional
	// default = false
	// create = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point to use for the NFS mounts.
	// create = required
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// create = optional
	// update = optional
	// maxLength = 256
	// format = objectName
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// A list of object references to Oracle Node Listeners selected for
	// this Managed Database. Delphix picks one default listener from the
	// target environment if this list is empty at virtual database
	// provision time.
	// create = optional
	// update = optional
	NodeListeners []string `json:"nodeListeners,omitempty"`
	// User-specified operation hooks for this source.
	// update = optional
	// create = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// Number of Online Redo Log Groups.
	// create = optional
	// update = readonly
	// minimum = 2
	// default = 3
	RedoLogGroups *int `json:"redoLogGroups,omitempty"`
	// Online Redo Log size in MB.
	// create = optional
	// update = readonly
	// minimum = 4
	RedoLogSizeInMB *int `json:"redoLogSizeInMB,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties for this Oracle source.
	Runtime OracleBaseSourceRuntime `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

OracleWarehouseSourceStruct - A warehouse represents a housing that accepts databases. extends OracleVirtualSource

func OracleWarehouseSourceFactory 

func OracleWarehouseSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	ArchivelogMode *bool,
	Config string,
	ConfigParams map[string]string,
	ConfigTemplate string,
	Container string,
	CustomEnvVars []OracleCustomEnvVar,
	Description string,
	FileMappingRules string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	NodeListeners []string,
	Operations *VirtualSourceOperationsStruct,
	RedoLogGroups *int,
	RedoLogSizeInMB *int,
	Reference string,
	Runtime OracleBaseSourceRuntime,
	Staging *bool,
	Status string,
	Virtual *bool,
) OracleWarehouseSourceStruct

OracleWarehouseSourceFactory is just a simple function to instantiate the OracleWarehouseSourceStruct

type PasswordCredentialStruct 

type PasswordCredentialStruct struct {
	// The password.
	// format = password
	// required = true
	// minLength = 1
	Password string `json:"password,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PasswordCredentialStruct - The password based security credential. extends Credential

func PasswordCredentialFactory 

func PasswordCredentialFactory(
	Password string,
) PasswordCredentialStruct

PasswordCredentialFactory is just a simple function to instantiate the PasswordCredentialStruct

type PasswordPolicyStruct 

type PasswordPolicyStruct struct {
	// True if password must contain at least one digit.
	// create = required
	// update = optional
	Digit *bool `json:"digit,omitempty"`
	// True to disallow password containing username.
	// create = required
	// update = optional
	DisallowUsernameAsPassword *bool `json:"disallowUsernameAsPassword,omitempty"`
	// True if password must contain at least one lowercase letter.
	// create = required
	// update = optional
	LowercaseLetter *bool `json:"lowercaseLetter,omitempty"`
	// Minimum length for the password.
	// update = optional
	// minimum = 1
	// maximum = 128
	// create = required
	MinLength *int `json:"minLength,omitempty"`
	// Name of password policy.
	// update = optional
	// minLength = 1
	// maxLength = 64
	// create = required
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// The password may not be the same as any of previous n passwords.
	// update = optional
	// minimum = 0
	// maximum = 1
	// create = required
	ReuseDisallowLimit *int `json:"reuseDisallowLimit,omitempty"`
	// True if password must contain at least one symbol.
	// create = required
	// update = optional
	Symbol *bool `json:"symbol,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// True if password must contain at least one uppercase letter.
	// create = required
	// update = optional
	UppercaseLetter *bool `json:"uppercaseLetter,omitempty"`
}

PasswordPolicyStruct - Password policies for Delphix users. extends NamedUserObject cliVisibility = [DOMAIN SYSTEM]

func PasswordPolicyFactory 

func PasswordPolicyFactory(
	Digit *bool,
	DisallowUsernameAsPassword *bool,
	LowercaseLetter *bool,
	MinLength *int,
	Name string,
	Namespace string,
	Reference string,
	ReuseDisallowLimit *int,
	Symbol *bool,
	UppercaseLetter *bool,
) PasswordPolicyStruct

PasswordPolicyFactory is just a simple function to instantiate the PasswordPolicyStruct

type PathConstraint 

type PathConstraint interface{}

PathConstraint is an empty interface designed to function as the PathConstraint API namespace

type PathDescendantConstraintStruct 

type PathDescendantConstraintStruct struct {
	// The name of the axis being constrained.
	// create = required
	AxisName string `json:"axisName,omitempty"`
	// The axis values must be a descendant of this path.
	// format = unixpath
	// create = required
	DescendantOf string `json:"descendantOf,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PathDescendantConstraintStruct - Constraint placed on a filesystem path axis of a particular analytics slice. extends PathConstraint

func PathDescendantConstraintFactory 

func PathDescendantConstraintFactory(
	AxisName string,
	DescendantOf string,
) PathDescendantConstraintStruct

PathDescendantConstraintFactory is just a simple function to instantiate the PathDescendantConstraintStruct

type PemCertificateChainStruct 

type PemCertificateChainStruct struct {
	// The chain of X.509 certificates in PEM format.
	// required = true
	Chain []*PemCertificateStruct `json:"chain,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PemCertificateChainStruct - A chain of X.509 Certificates in PEM format. extends TypedObject

func PemCertificateChainFactory 

func PemCertificateChainFactory(
	Chain []*PemCertificateStruct,
) PemCertificateChainStruct

PemCertificateChainFactory is just a simple function to instantiate the PemCertificateChainStruct

type PemCertificateStruct 

type PemCertificateStruct struct {
	// The X.509 certificate in PEM format.
	// required = true
	Contents string `json:"contents,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

PemCertificateStruct - An X.509 Certificate in PEM format. extends TypedObject

func PemCertificateFactory 

func PemCertificateFactory(
	Contents string,
) PemCertificateStruct

PemCertificateFactory is just a simple function to instantiate the PemCertificateStruct

type PermissionStruct 

type PermissionStruct struct {
	// Name of the action governed by the permission.
	ActionType string `json:"actionType,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PermissionStruct - Describes a permission to perform an operation on an object in the Delphix Engine. extends ReadonlyNamedUserObject

func PermissionFactory 

func PermissionFactory(
	ActionType string,
	Name string,
	Namespace string,
	Reference string,
) PermissionStruct

PermissionFactory is just a simple function to instantiate the PermissionStruct

type PersistentObject 

type PersistentObject interface{}

PersistentObject is an empty interface designed to function as the PersistentObject API namespace

type PgSQLAttachDataStruct 

type PgSQLAttachDataStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-pgsql-db-cluster-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The database that must be used to run SQL queries against this
	// cluster.
	// maxLength = 256
	// default = postgres
	// create = optional
	ConnectionDatabase string `json:"connectionDatabase,omitempty"`
	// The credential of the database cluster user.
	// create = optional
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The username of the database cluster user.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// The external file path.
	// maxLength = 1024
	// create = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// Information about the host OS user on the PPT host to use for
	// linking.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	PptHostUser string `json:"pptHostUser,omitempty"`
	// The Postgres installation on the PPT environment that will be used
	// for pre-provisioning.
	// format = objectReference
	// referenceTo = /delphix-pgsql-install.json
	// required = true
	PptRepository string `json:"pptRepository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLAttachDataStruct - Represents the PostgreSQL specific parameters of an attach request. extends AttachData

func PgSQLAttachDataFactory 

func PgSQLAttachDataFactory(
	Config string,
	ConnectionDatabase string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	ExternalFilePath string,
	Operations *LinkedSourceOperationsStruct,
	PptHostUser string,
	PptRepository string,
) PgSQLAttachDataStruct

PgSQLAttachDataFactory is just a simple function to instantiate the PgSQLAttachDataStruct

type PgSQLCompatibilityCriteriaStruct 

type PgSQLCompatibilityCriteriaStruct struct {
	// Selected repositories are installed on a host with this
	// architecture (32-bit or 64-bit).
	Architecture *int `json:"architecture,omitempty"`
	// Selected repositories are installed on this environment.
	// referenceTo = /delphix-source-environment.json
	// format = objectReference
	Environment string `json:"environment,omitempty"`
	// Selected repositories are installed on a host with this OS.
	// enum = [Linux AIX HPUX SunOS Windows]
	Os string `json:"os,omitempty"`
	// Selected repositories are installed on a host with this type of
	// processor.
	// enum = [x86 ia64 powerpc sparc]
	Processor string `json:"processor,omitempty"`
	// Selected repositories have this size WAL segments.
	// units = B
	// base = 1024
	SegmentSize *int `json:"segmentSize,omitempty"`
	// If true, selected repositories have staging enabled.
	StagingEnabled *bool `json:"stagingEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Selected repositories will match this variant of the PostgreSQL
	// distribution.
	// enum = [PostgreSQL EnterpriseDB]
	Variant string `json:"variant,omitempty"`
	// Selected repositories are this database version. In case of
	// upgrade, selected repositories are strictly greater than this
	// database version.
	// format = pgsqlVersion
	Version string `json:"version,omitempty"`
}

PgSQLCompatibilityCriteriaStruct - The compatibility criteria to use for selecting compatible PgSQL repositories. extends CompatibilityCriteria

func PgSQLCompatibilityCriteriaFactory 

func PgSQLCompatibilityCriteriaFactory(
	Architecture *int,
	Environment string,
	Os string,
	Processor string,
	SegmentSize *int,
	StagingEnabled *bool,
	Variant string,
	Version string,
) PgSQLCompatibilityCriteriaStruct

PgSQLCompatibilityCriteriaFactory is just a simple function to instantiate the PgSQLCompatibilityCriteriaStruct

type PgSQLCreateTransformationParametersStruct 

type PgSQLCreateTransformationParametersStruct struct {
	// The container that will contain the transformed data associated
	// with the newly created transformation; the "transformation
	// container".
	// create = required
	Container *PgSQLDatabaseContainerStruct `json:"container,omitempty"`
	// Reference to the user used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Operations to perform when this transformation is applied.
	// create = required
	Operations []SourceOperation `json:"operations,omitempty"`
	// The port number used for provisioning a PgSQL container during
	// transformation application.
	// create = required
	// minimum = 1
	// maximum = 65535
	Port *int `json:"port,omitempty"`
	// Reference to the repository used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	// create = required
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLCreateTransformationParametersStruct - Represents the parameters of a createTransformation request for a PgSQL container. extends CreateTransformationParameters

func PgSQLCreateTransformationParametersFactory 

func PgSQLCreateTransformationParametersFactory(
	Container *PgSQLDatabaseContainerStruct,
	EnvironmentUser string,
	Operations []SourceOperation,
	Port *int,
	Repository string,
) PgSQLCreateTransformationParametersStruct

PgSQLCreateTransformationParametersFactory is just a simple function to instantiate the PgSQLCreateTransformationParametersStruct

type PgSQLDBClusterConfigConnectivityStruct 

type PgSQLDBClusterConfigConnectivityStruct struct {
	// The database that must be used to run SQL queries against this
	// cluster.
	// create = optional
	// maxLength = 256
	ConnectionDatabase string `json:"connectionDatabase,omitempty"`
	// Database password.
	// format = password
	// required = true
	Password string `json:"password,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Database username.
	// required = true
	Username string `json:"username,omitempty"`
}

PgSQLDBClusterConfigConnectivityStruct - Mechanism to test JDBC connectivity to PostgreSQL DB clusters. extends SourceConfigConnectivity

func PgSQLDBClusterConfigConnectivityFactory 

func PgSQLDBClusterConfigConnectivityFactory(
	ConnectionDatabase string,
	Password string,
	Username string,
) PgSQLDBClusterConfigConnectivityStruct

PgSQLDBClusterConfigConnectivityFactory is just a simple function to instantiate the PgSQLDBClusterConfigConnectivityStruct

type PgSQLDBClusterConfigStruct 

type PgSQLDBClusterConfigStruct struct {
	// The data directory for the PostgreSQL cluster.
	// create = optional
	ClusterDataDirectory string `json:"clusterDataDirectory,omitempty"`
	// The database that must be used to run SQL queries against this
	// cluster.
	// create = optional
	// update = optional
	// maxLength = 256
	ConnectionDatabase string `json:"connectionDatabase,omitempty"`
	// The password of the database cluster user.
	// create = optional
	// update = optional
	Credentials string `json:"credentials,omitempty"`
	// Whether this source was discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// The user used to create and manage the configuration.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// create = optional
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Whether this source should be used for linking.
	// default = true
	// create = optional
	// update = optional
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The port on which the PostgresSQL server for the cluster is
	// listening.
	// minimum = 1
	// maximum = 65535
	// create = required
	// update = optional
	Port *int `json:"port,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The object reference of the source repository.
	// format = objectReference
	// referenceTo = /delphix-pgsql-install.json
	// create = required
	// update = optional
	Repository string `json:"repository,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The username of the database cluster user.
	// update = optional
	// maxLength = 256
	User string `json:"user,omitempty"`
}

PgSQLDBClusterConfigStruct - Configuration information for a PostgreSQL database cluster. extends SourceConfig

func PgSQLDBClusterConfigFactory 

func PgSQLDBClusterConfigFactory(
	ClusterDataDirectory string,
	ConnectionDatabase string,
	Credentials string,
	Discovered *bool,
	EnvironmentUser string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	Port *int,
	Reference string,
	Repository string,
	User string,
) PgSQLDBClusterConfigStruct

PgSQLDBClusterConfigFactory is just a simple function to instantiate the PgSQLDBClusterConfigStruct

type PgSQLDBConfigStruct 

type PgSQLDBConfigStruct struct {
	// The password of the database user.
	// update = optional
	Credentials Credential `json:"credentials,omitempty"`
	// The PostgreSQL cluster this database is part of.
	// format = objectReference
	// referenceTo = /delphix-pgsql-db-cluster-config.json
	DatabaseCluster string `json:"databaseCluster,omitempty"`
	// The name of the database.
	// create = optional
	// update = optional
	// maxLength = 63
	DatabaseName string `json:"databaseName,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the database user.
	// update = optional
	// maxLength = 256
	User string `json:"user,omitempty"`
}

PgSQLDBConfigStruct - Configuration information for a PostgreSQL database in a cluster. extends TypedObject

func PgSQLDBConfigFactory 

func PgSQLDBConfigFactory(
	Credentials Credential,
	DatabaseCluster string,
	DatabaseName string,
	User string,
) PgSQLDBConfigStruct

PgSQLDBConfigFactory is just a simple function to instantiate the PgSQLDBConfigStruct

type PgSQLDBContainerRuntimeStruct 

type PgSQLDBContainerRuntimeStruct struct {
	// The ID of the WAL segment that was last restored in this container
	// (if applicable).
	LastRestoredWALSegment string `json:"lastRestoredWALSegment,omitempty"`
	// True if the LogSync is enabled and running for this container.
	LogSyncActive *bool `json:"logSyncActive,omitempty"`
	// The pre-provisioning runtime for the container.
	PreProvisioningStatus *PreProvisioningRuntimeStruct `json:"preProvisioningStatus,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLDBContainerRuntimeStruct - Runtime properties of a PostgreSQL database container. extends DBContainerRuntime

func PgSQLDBContainerRuntimeFactory 

func PgSQLDBContainerRuntimeFactory(
	LastRestoredWALSegment string,
	LogSyncActive *bool,
	PreProvisioningStatus *PreProvisioningRuntimeStruct,
) PgSQLDBContainerRuntimeStruct

PgSQLDBContainerRuntimeFactory is just a simple function to instantiate the PgSQLDBContainerRuntimeStruct

type PgSQLDatabaseContainerStruct 

type PgSQLDatabaseContainerStruct struct {
	// The date this container was created.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// A reference to the currently active TimeFlow for this container.
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	CurrentTimeflow string `json:"currentTimeflow,omitempty"`
	// Optional user-provided description for the container.
	// maxLength = 1024
	// create = optional
	// update = optional
	Description string `json:"description,omitempty"`
	// A reference to the group containing this container.
	// format = objectReference
	// referenceTo = /delphix-group.json
	// create = required
	Group string `json:"group,omitempty"`
	// True if this container is a masked container.
	Masked *bool `json:"masked,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Native operating system of the original database source system.
	Os string `json:"os,omitempty"`
	// Whether to enable high performance mode.
	// enum = [TEMPORARILY_ENABLED ENABLED DISABLED]
	// default = DISABLED
	// create = readonly
	// update = readonly
	PerformanceMode string `json:"performanceMode,omitempty"`
	// A reference to the previous TimeFlow for this container.
	// referenceTo = /delphix-timeflow.json
	// format = objectReference
	PreviousTimeflow string `json:"previousTimeflow,omitempty"`
	// Native processor type of the original database source system.
	Processor string `json:"processor,omitempty"`
	// A reference to the container this container was provisioned from.
	// format = objectReference
	// referenceTo = /delphix-container.json
	ProvisionContainer string `json:"provisionContainer,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this container.
	Runtime *PgSQLDBContainerRuntimeStruct `json:"runtime,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	// update = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// True if this container is a transformation container.
	Transformation *bool `json:"transformation,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLDatabaseContainerStruct - A PostgreSQL Database Container. extends DatabaseContainer

func PgSQLDatabaseContainerFactory 

func PgSQLDatabaseContainerFactory(
	CreationTime string,
	CurrentTimeflow string,
	Description string,
	Group string,
	Masked *bool,
	Name string,
	Namespace string,
	Os string,
	PreviousTimeflow string,
	Processor string,
	ProvisionContainer string,
	Reference string,
	Runtime *PgSQLDBContainerRuntimeStruct,
	SourcingPolicy *SourcingPolicyStruct,
	Transformation *bool,
) PgSQLDatabaseContainerStruct

PgSQLDatabaseContainerFactory is just a simple function to instantiate the PgSQLDatabaseContainerStruct

type PgSQLExportParametersStruct 

type PgSQLExportParametersStruct struct {
	// Database-specific configuration parameters.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// The filesystem configuration of the exported database.
	// required = true
	FilesystemLayout *TimeflowFilesystemLayoutStruct `json:"filesystemLayout,omitempty"`
	// Entries in the PostgreSQL host-based authentication file
	// (pg_hba.conf).
	// create = optional
	HbaEntries []*PgSQLHBAEntryStruct `json:"hbaEntries,omitempty"`
	// Entries in the PostgreSQL username map file (pg_ident.conf).
	// create = optional
	IdentEntries []*PgSQLIdentEntryStruct `json:"identEntries,omitempty"`
	// If specified, then take the exported database through recovery
	// procedures, if necessary, to reach a consistent point.
	// default = true
	// create = optional
	RecoverDatabase *bool `json:"recoverDatabase,omitempty"`
	// The source config to use when creating the exported database.
	// required = true
	SourceConfig *PgSQLDBClusterConfigStruct `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base export
	// on.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLExportParametersStruct - The parameters to use as input to export PostgreSQL databases. extends DbExportParameters

func PgSQLExportParametersFactory 

func PgSQLExportParametersFactory(
	ConfigParams map[string]string,
	FileMappingRules string,
	FilesystemLayout *TimeflowFilesystemLayoutStruct,
	HbaEntries []*PgSQLHBAEntryStruct,
	IdentEntries []*PgSQLIdentEntryStruct,
	RecoverDatabase *bool,
	SourceConfig *PgSQLDBClusterConfigStruct,
	TimeflowPointParameters TimeflowPointParameters,
) PgSQLExportParametersStruct

PgSQLExportParametersFactory is just a simple function to instantiate the PgSQLExportParametersStruct

type PgSQLHBAEntryStruct 

type PgSQLHBAEntryStruct struct {
	// The client machine address that this entry matches.
	// create = optional
	Address string `json:"address,omitempty"`
	// The authentication method to use when connecting via this entry.
	// enum = [trust reject md5 password gss sspi krb5 ident peer ldap radius cert pam]
	// create = required
	AuthMethod string `json:"authMethod,omitempty"`
	// Options for the authentication method.
	// create = optional
	AuthOptions string `json:"authOptions,omitempty"`
	// The database name this entry matches.
	// maxLength = 63
	// default = all
	// create = required
	Database string `json:"database,omitempty"`
	// The connection type of this entry.
	// enum = [local host hostssl hostnossl]
	// create = required
	EntryType string `json:"entryType,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The database username this entry matches.
	// default = all
	// create = required
	// maxLength = 63
	User string `json:"user,omitempty"`
}

PgSQLHBAEntryStruct - An entry in the PostgreSQL host-based authentication file (pg_hba.conf). extends TypedObject

func PgSQLHBAEntryFactory 

func PgSQLHBAEntryFactory(
	Address string,
	AuthMethod string,
	AuthOptions string,
	Database string,
	EntryType string,
	User string,
) PgSQLHBAEntryStruct

PgSQLHBAEntryFactory is just a simple function to instantiate the PgSQLHBAEntryStruct

type PgSQLIdentEntryStruct 

type PgSQLIdentEntryStruct struct {
	// The database username this entry matches.
	// maxLength = 63
	// create = required
	DatabaseUsername string `json:"databaseUsername,omitempty"`
	// The name of the map to which this entry belongs (used to refer to
	// the map in pg_hba.conf).
	// create = required
	MapName string `json:"mapName,omitempty"`
	// The operating system username this entry matches.
	// create = required
	SystemUsername string `json:"systemUsername,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLIdentEntryStruct - An entry in the PostgreSQL username map file (pg_ident.conf). extends TypedObject

func PgSQLIdentEntryFactory 

func PgSQLIdentEntryFactory(
	DatabaseUsername string,
	MapName string,
	SystemUsername string,
) PgSQLIdentEntryStruct

PgSQLIdentEntryFactory is just a simple function to instantiate the PgSQLIdentEntryStruct

type PgSQLInstallStruct 

type PgSQLInstallStruct struct {
	// 32 or 64 bit installation.
	// enum = [32 64]
	Bits *int `json:"bits,omitempty"`
	// Flag indicating whether the installation was discovered or
	// manually entered.
	Discovered *bool `json:"discovered,omitempty"`
	// Reference to the environment containing this repository.
	// referenceTo = /delphix-source-environment.json
	// create = required
	// format = objectReference
	Environment string `json:"environment,omitempty"`
	// Directory path where the installation is located.
	// create = required
	// maxLength = 1024
	InstallationPath string `json:"installationPath,omitempty"`
	// Flag indicating whether the repository should be used for linking.
	// create = optional
	// update = optional
	// default = true
	LinkingEnabled *bool `json:"linkingEnabled,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Flag indicating whether the repository should be used for
	// provisioning.
	// default = true
	// create = optional
	// update = optional
	ProvisioningEnabled *bool `json:"provisioningEnabled,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Size of the WAL segments (in bytes) generated by PostgreSQL
	// binaries.
	// enum = [1.048576e+06 2.097152e+06 4.194304e+06 8.388608e+06 1.6777216e+07 3.3554432e+07 6.7108864e+07]
	// base = 1024
	// units = B
	SegmentSize *int `json:"segmentSize,omitempty"`
	// Flag indicating whether this repository can be used by the Delphix
	// Engine for internal processing.
	// default = false
	// create = optional
	// update = optional
	Staging *bool `json:"staging,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Variant of the repository.
	// enum = [PostgreSQL EnterpriseDB]
	Variant string `json:"variant,omitempty"`
	// Version of the repository.
	// format = pgsqlVersion
	Version string `json:"version,omitempty"`
}

PgSQLInstallStruct - A PostgreSQL installation. extends SourceRepository

func PgSQLInstallFactory 

func PgSQLInstallFactory(
	Bits *int,
	Discovered *bool,
	Environment string,
	InstallationPath string,
	LinkingEnabled *bool,
	Name string,
	Namespace string,
	ProvisioningEnabled *bool,
	Reference string,
	SegmentSize *int,
	Staging *bool,
	Variant string,
	Version string,
) PgSQLInstallStruct

PgSQLInstallFactory is just a simple function to instantiate the PgSQLInstallStruct

type PgSQLLinkDataStruct 

type PgSQLLinkDataStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-pgsql-db-cluster-config.json
	// required = true
	Config string `json:"config,omitempty"`
	// The database that must be used to run SQL queries against this
	// cluster.
	// maxLength = 256
	// default = postgres
	// create = optional
	ConnectionDatabase string `json:"connectionDatabase,omitempty"`
	// The credential of the database cluster user.
	// create = optional
	DbCredentials *PasswordCredentialStruct `json:"dbCredentials,omitempty"`
	// The username of the database cluster user.
	// required = true
	DbUser string `json:"dbUser,omitempty"`
	// The external file path.
	// maxLength = 1024
	// create = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// Information about the host OS user on the PPT host to use for
	// linking.
	// create = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	PptHostUser string `json:"pptHostUser,omitempty"`
	// The Postgres installation on the PPT environment that will be used
	// for pre-provisioning.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-pgsql-install.json
	PptRepository string `json:"pptRepository,omitempty"`
	// Policies for managing LogSync and SnapSync across sources.
	// create = optional
	SourcingPolicy *SourcingPolicyStruct `json:"sourcingPolicy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLLinkDataStruct - PostgreSQL specific parameters for a link request. extends LinkData

func PgSQLLinkDataFactory 

func PgSQLLinkDataFactory(
	Config string,
	ConnectionDatabase string,
	DbCredentials *PasswordCredentialStruct,
	DbUser string,
	ExternalFilePath string,
	Operations *LinkedSourceOperationsStruct,
	PptHostUser string,
	PptRepository string,
	SourcingPolicy *SourcingPolicyStruct,
) PgSQLLinkDataStruct

PgSQLLinkDataFactory is just a simple function to instantiate the PgSQLLinkDataStruct

type PgSQLLinkedSourceStruct 

type PgSQLLinkedSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// referenceTo = /delphix-container.json
	// format = objectReference
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// The external file path.
	// maxLength = 1024
	// create = optional
	// update = optional
	ExternalFilePath string `json:"externalFilePath,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *LinkedSourceOperationsStruct `json:"operations,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *PgSQLSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// The staging source for pre-provisioning of the database.
	// format = objectReference
	// referenceTo = /delphix-pgsql-staging-source.json
	StagingSource string `json:"stagingSource,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

PgSQLLinkedSourceStruct - A linked PostgreSQL source. extends PgSQLSource

func PgSQLLinkedSourceFactory 

func PgSQLLinkedSourceFactory(
	Config string,
	Container string,
	Description string,
	ExternalFilePath string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	Operations *LinkedSourceOperationsStruct,
	Reference string,
	Runtime *PgSQLSourceRuntimeStruct,
	Staging *bool,
	StagingSource string,
	Status string,
	Virtual *bool,
) PgSQLLinkedSourceStruct

PgSQLLinkedSourceFactory is just a simple function to instantiate the PgSQLLinkedSourceStruct

type PgSQLPlatformParametersStruct 

type PgSQLPlatformParametersStruct struct {
	// The port number used for provisioning a PgSQL container during
	// transformation application. This port must be available when the
	// transformation is applied so that the temporary VDB created during
	// the transformation process can start and listen to this port.
	// minimum = 1
	// maximum = 65535
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLPlatformParametersStruct - PgSQL platform-specific parameters that are stored on a transformation. extends BasePlatformParameters

func PgSQLPlatformParametersFactory 

func PgSQLPlatformParametersFactory(
	Port *int,
) PgSQLPlatformParametersStruct

PgSQLPlatformParametersFactory is just a simple function to instantiate the PgSQLPlatformParametersStruct

type PgSQLProvisionParametersStruct 

type PgSQLProvisionParametersStruct struct {
	// The new container for the provisioned database.
	// required = true
	Container *PgSQLDatabaseContainerStruct `json:"container,omitempty"`
	// Whether or not to mark this VDB as a masked VDB. It will be marked
	// as masked if this flag or the masking job are set.
	// create = optional
	// update = readonly
	Masked *bool `json:"masked,omitempty"`
	// The Masking Job to be run when this dataset is provisioned or
	// refreshed.
	// format = objectReference
	// referenceTo = /delphix-masking-job.json
	// create = optional
	// update = readonly
	MaskingJob string `json:"maskingJob,omitempty"`
	// The source that describes an external database instance.
	// required = true
	Source *PgSQLVirtualSourceStruct `json:"source,omitempty"`
	// The source config for the source.
	// required = true
	SourceConfig *PgSQLDBClusterConfigStruct `json:"sourceConfig,omitempty"`
	// The TimeFlow point, bookmark, or semantic location to base
	// provisioning on.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLProvisionParametersStruct - The parameters to use as input to provision PostgreSQL databases. extends ProvisionParameters

func PgSQLProvisionParametersFactory 

func PgSQLProvisionParametersFactory(
	Container *PgSQLDatabaseContainerStruct,
	Masked *bool,
	MaskingJob string,
	Source *PgSQLVirtualSourceStruct,
	SourceConfig *PgSQLDBClusterConfigStruct,
	TimeflowPointParameters TimeflowPointParameters,
) PgSQLProvisionParametersStruct

PgSQLProvisionParametersFactory is just a simple function to instantiate the PgSQLProvisionParametersStruct

type PgSQLSnapshotStruct 

type PgSQLSnapshotStruct struct {
	// A value in the set {CONSISTENT, INCONSISTENT, CRASH_CONSISTENT}
	// indicating what type of recovery strategies must be invoked when
	// provisioning from this snapshot.
	Consistency string `json:"consistency,omitempty"`
	// Reference to the database of which this TimeFlow is a part.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Point in time at which this snapshot was created. This may be
	// different from the time corresponding to the TimeFlow.
	// format = date
	CreationTime string `json:"creationTime,omitempty"`
	// The location within the parent TimeFlow at which this snapshot was
	// initiated.
	FirstChangePoint *PgSQLTimeflowPointStruct `json:"firstChangePoint,omitempty"`
	// The location of the snapshot within the parent TimeFlow
	// represented by this snapshot.
	LatestChangePoint *PgSQLTimeflowPointStruct `json:"latestChangePoint,omitempty"`
	// Boolean value indicating if a virtual database provisioned from
	// this snapshot will be missing nologging changes.
	MissingNonLoggedData *bool `json:"missingNonLoggedData,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Retention policy, in days. A value of -1 indicates the snapshot
	// should be kept forever.
	// update = optional
	Retention *int `json:"retention,omitempty"`
	// Runtime properties of the snapshot.
	Runtime *SnapshotRuntimeStruct `json:"runtime,omitempty"`
	// Boolean value indicating that this snapshot is in a transient
	// state and should not be user visible.
	Temporary *bool `json:"temporary,omitempty"`
	// TimeFlow of which this snapshot is a part.
	// referenceTo = /delphix-timeflow.json
	// format = objectReference
	Timeflow string `json:"timeflow,omitempty"`
	// Time zone of the source database at the time the snapshot was
	// taken.
	Timezone string `json:"timezone,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Version of database source repository at the time the snapshot was
	// taken.
	Version string `json:"version,omitempty"`
}

PgSQLSnapshotStruct - Provisionable snapshot of a PostgreSQL TimeFlow. extends TimeflowSnapshot

func PgSQLSnapshotFactory 

func PgSQLSnapshotFactory(
	Consistency string,
	Container string,
	CreationTime string,
	FirstChangePoint *PgSQLTimeflowPointStruct,
	LatestChangePoint *PgSQLTimeflowPointStruct,
	MissingNonLoggedData *bool,
	Name string,
	Namespace string,
	Reference string,
	Retention *int,
	Runtime *SnapshotRuntimeStruct,
	Temporary *bool,
	Timeflow string,
	Timezone string,
	Version string,
) PgSQLSnapshotStruct

PgSQLSnapshotFactory is just a simple function to instantiate the PgSQLSnapshotStruct

type PgSQLSource 

type PgSQLSource interface{}

PgSQLSource is an empty interface designed to function as the PgSQLSource API namespace

type PgSQLSourceConnectionInfoStruct 

type PgSQLSourceConnectionInfoStruct struct {
	// The hostname or IP address of the host where the source resides.
	Host string `json:"host,omitempty"`
	// The JDBC string used to connect to the PostgreSQL server instance.
	JdbcString string `json:"jdbcString,omitempty"`
	// The data directory for the PostgreSQL cluster.
	PgDataDirectory string `json:"pgDataDirectory,omitempty"`
	// The port on which the PostgresSQL server for the cluster is
	// listening.
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The username of the database cluster user.
	User string `json:"user,omitempty"`
	// The database version string.
	Version string `json:"version,omitempty"`
}

PgSQLSourceConnectionInfoStruct - Contains information that can be used to connect to a PostgreSQL source. extends SourceConnectionInfo

func PgSQLSourceConnectionInfoFactory 

func PgSQLSourceConnectionInfoFactory(
	Host string,
	JdbcString string,
	PgDataDirectory string,
	Port *int,
	User string,
	Version string,
) PgSQLSourceConnectionInfoStruct

PgSQLSourceConnectionInfoFactory is just a simple function to instantiate the PgSQLSourceConnectionInfoStruct

type PgSQLSourceRuntimeStruct 

type PgSQLSourceRuntimeStruct struct {
	// True if the source is JDBC accessible. If false then no properties
	// can be retrieved.
	Accessible *bool `json:"accessible,omitempty"`
	// The time that the 'accessible' propery was last checked.
	// format = date
	AccessibleTimestamp string `json:"accessibleTimestamp,omitempty"`
	// Size of the database in bytes.
	// units = B
	// base = 1024
	DatabaseSize float64 `json:"databaseSize,omitempty"`
	// Status indicating whether the source is enabled. A source has a
	// 'PARTIAL' status if its sub-sources are not all enabled.
	// enum = [ENABLED PARTIAL DISABLED]
	Enabled string `json:"enabled,omitempty"`
	// The reason why the source is not JDBC accessible.
	NotAccessibleReason string `json:"notAccessibleReason,omitempty"`
	// Status of the source. 'Unknown' if all attempts to connect to the
	// source failed.
	// enum = [RUNNING INACTIVE PENDING CANCELED FAILED CHECKING UNKNOWN]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLSourceRuntimeStruct - Runtime (non-persistent) properties of a PostgreSQL source. extends SourceRuntime

func PgSQLSourceRuntimeFactory 

func PgSQLSourceRuntimeFactory(
	Accessible *bool,
	AccessibleTimestamp string,
	DatabaseSize float64,
	Enabled string,
	NotAccessibleReason string,
	Status string,
) PgSQLSourceRuntimeStruct

PgSQLSourceRuntimeFactory is just a simple function to instantiate the PgSQLSourceRuntimeStruct

type PgSQLStagingSourceStruct 

type PgSQLStagingSourceStruct struct {
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point for the NFS mounts on the pre-provisioning
	// host.
	// maxLength = 256
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// maxLength = 256
	// format = objectName
	// create = optional
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *PgSQLSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

PgSQLStagingSourceStruct - A PostgreSQL staging source used for pre-provisioning. extends PgSQLSource

func PgSQLStagingSourceFactory 

func PgSQLStagingSourceFactory(
	Config string,
	Container string,
	Description string,
	Hosts []string,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	Reference string,
	Runtime *PgSQLSourceRuntimeStruct,
	Staging *bool,
	Status string,
	Virtual *bool,
) PgSQLStagingSourceStruct

PgSQLStagingSourceFactory is just a simple function to instantiate the PgSQLStagingSourceStruct

type PgSQLSyncParametersStruct 

type PgSQLSyncParametersStruct struct {
	// Whether or not to take another full backup of the source database.
	// default = false
	RedoBaseBackup *bool `json:"redoBaseBackup,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLSyncParametersStruct - The parameters to use as input to sync PostgreSQL databases. extends SyncParameters

func PgSQLSyncParametersFactory 

func PgSQLSyncParametersFactory(
	RedoBaseBackup *bool,
) PgSQLSyncParametersStruct

PgSQLSyncParametersFactory is just a simple function to instantiate the PgSQLSyncParametersStruct

type PgSQLTimeflowPointStruct 

type PgSQLTimeflowPointStruct struct {
	// The TimeFlow location.
	// create = optional
	Location string `json:"location,omitempty"`
	// Reference to TimeFlow containing this point.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-pgsql-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// The logical time corresponding to the TimeFlow location.
	// create = optional
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLTimeflowPointStruct - A unique point within a PostgreSQL database TimeFlow. extends TimeflowPoint

func PgSQLTimeflowPointFactory 

func PgSQLTimeflowPointFactory(
	Location string,
	Timeflow string,
	Timestamp string,
) PgSQLTimeflowPointStruct

PgSQLTimeflowPointFactory is just a simple function to instantiate the PgSQLTimeflowPointStruct

type PgSQLTimeflowStruct 

type PgSQLTimeflowStruct struct {
	// Reference to the data container (database) for this TimeFlow.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// The source action that created the TimeFlow.
	// enum = [INITIAL INDETERMINATE REFRESH ROLLBACK TEMPORARY TRANSFORMATION V2P PDB_PLUG WAREHOUSE ORACLE_LIVE_SOURCE_RESYNC SOURCE_CONTINUITY]
	CreationType string `json:"creationType,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// create = required
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The origin point on the parent TimeFlow from which this TimeFlow
	// was provisioned. This will not be present for TimeFlows derived
	// from linked sources.
	ParentPoint *PgSQLTimeflowPointStruct `json:"parentPoint,omitempty"`
	// Reference to the parent snapshot that serves as the provisioning
	// base for this object. This may be different from the snapshot
	// within the parent point, and is only present for virtual
	// TimeFlows.
	// format = objectReference
	// referenceTo = /delphix-timeflow-snapshot.json
	ParentSnapshot string `json:"parentSnapshot,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PgSQLTimeflowStruct - TimeFlow representing historical data for a particular timeline within a PostgreSQL container. extends Timeflow

func PgSQLTimeflowFactory 

func PgSQLTimeflowFactory(
	Container string,
	CreationType string,
	Name string,
	Namespace string,
	ParentPoint *PgSQLTimeflowPointStruct,
	ParentSnapshot string,
	Reference string,
) PgSQLTimeflowStruct

PgSQLTimeflowFactory is just a simple function to instantiate the PgSQLTimeflowStruct

type PgSQLVirtualSourceStruct 

type PgSQLVirtualSourceStruct struct {
	// Indicates whether Delphix should automatically restart this
	// virtual source when target host reboot is detected.
	// create = required
	// update = optional
	AllowAutoVDBRestartOnHostReboot *bool `json:"allowAutoVDBRestartOnHostReboot,omitempty"`
	// Reference to the configuration for the source.
	// format = objectReference
	// referenceTo = /delphix-source-config.json
	// create = optional
	Config string `json:"config,omitempty"`
	// PostgreSQL database configuration parameter overrides.
	// create = optional
	ConfigParams map[string]string `json:"configParams,omitempty"`
	// Reference to the container being fed by this source, if any.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// A user-provided description of the source.
	Description string `json:"description,omitempty"`
	// Database file mapping rules.
	// create = optional
	FileMappingRules string `json:"fileMappingRules,omitempty"`
	// Entries in the PostgreSQL host-based authentication file
	// (pg_hba.conf).
	// create = optional
	HbaEntries []*PgSQLHBAEntryStruct `json:"hbaEntries,omitempty"`
	// Hosts that might affect operations on this source. Property will
	// be null unless the includeHosts parameter is set when listing
	// sources.
	Hosts []string `json:"hosts,omitempty"`
	// Entries in the PostgreSQL username map file (pg_ident.conf).
	// create = optional
	IdentEntries []*PgSQLIdentEntryStruct `json:"identEntries,omitempty"`
	// Flag indicating whether the source is a linked source in the
	// Delphix system.
	Linked *bool `json:"linked,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The base mount point to use for the NFS mounts.
	// maxLength = 256
	// create = required
	MountBase string `json:"mountBase,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// User-specified operation hooks for this source.
	// create = optional
	// update = optional
	Operations *VirtualSourceOperationsStruct `json:"operations,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this source.
	Runtime *PgSQLSourceRuntimeStruct `json:"runtime,omitempty"`
	// Flag indicating whether the source is used as a staging source for
	// pre-provisioning. Staging sources are managed by the Delphix
	// system.
	Staging *bool `json:"staging,omitempty"`
	// Status of this source.
	// enum = [DEFAULT PENDING_UPGRADE]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Flag indicating whether the source is a virtual source in the
	// Delphix system.
	Virtual *bool `json:"virtual,omitempty"`
}

PgSQLVirtualSourceStruct - A virtual PostgreSQL source. extends PgSQLSource

func PgSQLVirtualSourceFactory 

func PgSQLVirtualSourceFactory(
	AllowAutoVDBRestartOnHostReboot *bool,
	Config string,
	ConfigParams map[string]string,
	Container string,
	Description string,
	FileMappingRules string,
	HbaEntries []*PgSQLHBAEntryStruct,
	Hosts []string,
	IdentEntries []*PgSQLIdentEntryStruct,
	Linked *bool,
	LogCollectionEnabled *bool,
	MountBase string,
	Name string,
	Namespace string,
	Operations *VirtualSourceOperationsStruct,
	Reference string,
	Runtime *PgSQLSourceRuntimeStruct,
	Staging *bool,
	Status string,
	Virtual *bool,
) PgSQLVirtualSourceStruct

PgSQLVirtualSourceFactory is just a simple function to instantiate the PgSQLVirtualSourceStruct

type PhoneHomeServiceStruct 

type PhoneHomeServiceStruct struct {
	// True if the phone home service is enabled.
	// required = true
	Enabled *bool `json:"enabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PhoneHomeServiceStruct - Phone home service configuration. extends TypedObject cliVisibility = [SYSTEM]

func PhoneHomeServiceFactory 

func PhoneHomeServiceFactory(
	Enabled *bool,
) PhoneHomeServiceStruct

PhoneHomeServiceFactory is just a simple function to instantiate the PhoneHomeServiceStruct

type Policy 

type Policy interface{}

Policy is an empty interface designed to function as the Policy API namespace

type PolicyApplyTargetParametersStruct 

type PolicyApplyTargetParametersStruct struct {
	// Object reference of the target.
	// format = objectReference
	// referenceTo = /delphix-user-object.json
	Target string `json:"target,omitempty"`
	// Object references of the targets.
	Targets []string `json:"targets,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

PolicyApplyTargetParametersStruct - Specifies the target to which a policy is applied. extends TypedObject

func PolicyApplyTargetParametersFactory 

func PolicyApplyTargetParametersFactory(
	Target string,
	Targets []string,
) PolicyApplyTargetParametersStruct

PolicyApplyTargetParametersFactory is just a simple function to instantiate the PolicyApplyTargetParametersStruct

type PolicyCreateAndApplyParametersStruct 

type PolicyCreateAndApplyParametersStruct struct {
	// Policy to create.
	// required = true
	Policy Policy `json:"policy,omitempty"`
	// Object reference of the target.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-user-object.json
	Target string `json:"target,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PolicyCreateAndApplyParametersStruct - The parameters used for creating and applying policies. extends TypedObject

func PolicyCreateAndApplyParametersFactory 

func PolicyCreateAndApplyParametersFactory(
	Policy Policy,
	Target string,
) PolicyCreateAndApplyParametersStruct

PolicyCreateAndApplyParametersFactory is just a simple function to instantiate the PolicyCreateAndApplyParametersStruct

type PopulateCompatibilityParametersStruct 

type PopulateCompatibilityParametersStruct struct {
	// Restrict returned repositories to this environment.
	// referenceTo = /delphix-source-environment.json
	// create = optional
	// update = optional
	// format = objectReference
	Environment string `json:"environment,omitempty"`
	// The warehouse repository to use as a source of compatibility
	// information.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	SourceRepository string `json:"sourceRepository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PopulateCompatibilityParametersStruct - The criteria necessary to select valid repositories to populate into a warehouse. extends CompatibleRepositoriesParameters

func PopulateCompatibilityParametersFactory 

func PopulateCompatibilityParametersFactory(
	Environment string,
	SourceRepository string,
) PopulateCompatibilityParametersStruct

PopulateCompatibilityParametersFactory is just a simple function to instantiate the PopulateCompatibilityParametersStruct

type PreProvisioningRuntimeStruct 

type PreProvisioningRuntimeStruct struct {
	// Timestamp of the last update to the status.
	LastUpdateTimestamp string `json:"lastUpdateTimestamp,omitempty"`
	// User action required to resolve any error that the
	// pre-provisioning run encountered.
	PendingAction string `json:"pendingAction,omitempty"`
	// Indicates the current state of pre-provisioning for the database.
	// enum = [ACTIVE INACTIVE FAULTED UNKNOWN]
	PreProvisioningState string `json:"preProvisioningState,omitempty"`
	// Response taken based on the status of the pre-provisioning run.
	Response string `json:"response,omitempty"`
	// The status of the pre-provisioning run.
	Status string `json:"status,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

PreProvisioningRuntimeStruct - Runtime properties for pre-provisioning of a MSSQL database container. extends TypedObject

func PreProvisioningRuntimeFactory 

func PreProvisioningRuntimeFactory(
	LastUpdateTimestamp string,
	PendingAction string,
	PreProvisioningState string,
	Response string,
	Status string,
) PreProvisioningRuntimeStruct

PreProvisioningRuntimeFactory is just a simple function to instantiate the PreProvisioningRuntimeStruct

type ProvisionCompatibilityParametersStruct 

type ProvisionCompatibilityParametersStruct struct {
	// Restrict returned repositories to this environment.
	// create = optional
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// The TimeFlow point to use as a source of compatibility
	// information.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ProvisionCompatibilityParametersStruct - The criteria necessary to select valid repositories for provisioning. extends CompatibleRepositoriesParameters

func ProvisionCompatibilityParametersFactory 

func ProvisionCompatibilityParametersFactory(
	Environment string,
	TimeflowPointParameters TimeflowPointParameters,
) ProvisionCompatibilityParametersStruct

ProvisionCompatibilityParametersFactory is just a simple function to instantiate the ProvisionCompatibilityParametersStruct

type ProvisionParameters 

type ProvisionParameters interface{}

ProvisionParameters is an empty interface designed to function as the ProvisionParameters API namespace

type ProxyConfigurationStruct 

type ProxyConfigurationStruct struct {
	// True if the proxy is enabled.
	// update = optional
	Enabled *bool `json:"enabled,omitempty"`
	// Host or IP address to use as proxy.
	// format = host
	// update = optional
	Host string `json:"host,omitempty"`
	// If authentication is required, the password to use when connecting
	// to the proxy.
	// format = password
	// update = optional
	Password string `json:"password,omitempty"`
	// Port to use when connecting to the proxy host.
	// minimum = 1
	// maximum = 65535
	// update = optional
	Port *int `json:"port,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// If authentication is required, the username to use when connecting
	// to the proxy.
	// update = optional
	Username string `json:"username,omitempty"`
}

ProxyConfigurationStruct - Proxy configuration for a specific protocol. extends TypedObject

func ProxyConfigurationFactory 

func ProxyConfigurationFactory(
	Enabled *bool,
	Host string,
	Password string,
	Port *int,
	Username string,
) ProxyConfigurationStruct

ProxyConfigurationFactory is just a simple function to instantiate the ProxyConfigurationStruct

type ProxyServiceStruct 

type ProxyServiceStruct struct {
	// HTTPS proxy configuration.
	// update = optional
	// required = false
	Https *ProxyConfigurationStruct `json:"https,omitempty"`
	// SOCKS proxy configuration.
	// required = false
	// update = optional
	Socks *ProxyConfigurationStruct `json:"socks,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ProxyServiceStruct - Proxy service configuration. extends TypedObject cliVisibility = [SYSTEM]

func ProxyServiceFactory 

func ProxyServiceFactory(
	Https *ProxyConfigurationStruct,
	Socks *ProxyConfigurationStruct,
) ProxyServiceStruct

ProxyServiceFactory is just a simple function to instantiate the ProxyServiceStruct

type PublicKeyCredential 

type PublicKeyCredential interface{}

PublicKeyCredential is an empty interface designed to function as the PublicKeyCredential API namespace

type PublicSystemInfoStruct 

type PublicSystemInfoStruct struct {
	// Maximum supported API version of the current system software.
	ApiVersion *APIVersionStruct `json:"apiVersion,omitempty"`
	// Security banner to display prior to login.
	Banner string `json:"banner,omitempty"`
	// Time at which the current system software was built.
	// format = date
	BuildTimestamp string `json:"buildTimestamp,omitempty"`
	// Description of the current system software.
	BuildTitle string `json:"buildTitle,omitempty"`
	// Delphix version of the current system software.
	BuildVersion *VersionInfoStruct `json:"buildVersion,omitempty"`
	// Indicates whether the server has gone through initial setup or
	// not.
	Configured *bool `json:"configured,omitempty"`
	// The current system locale.
	// format = locale
	CurrentLocale string `json:"currentLocale,omitempty"`
	// The list of enabled features on this Delphix Engine.
	EnabledFeatures []string `json:"enabledFeatures,omitempty"`
	// Qualifier for referencing instances of (e.g. 'Delphix') engines in
	// messages like 'The <engineQualifier> Engine failed to ...'.
	// create = required
	EngineQualifier string `json:"engineQualifier,omitempty"`
	// The operating system kernel name.
	KernelName string `json:"kernelName,omitempty"`
	// List of available locales.
	Locales []string `json:"locales,omitempty"`
	// Name of the product that the system is running.
	ProductName string `json:"productName,omitempty"`
	// Product type.
	ProductType string `json:"productType,omitempty"`
	// Technical support phone numbers.
	// create = optional
	SupportContacts []*SupportContactStruct `json:"supportContacts,omitempty"`
	// Technical Support URL.
	// create = optional
	SupportURL string `json:"supportURL,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Address of vendor headquarters. Free form collection of strings to
	// accomodate any region.
	// create = optional
	VendorAddress []string `json:"vendorAddress,omitempty"`
	// Corporate headquarters email address.
	// create = optional
	// format = email
	VendorEmail string `json:"vendorEmail,omitempty"`
	// Vendor name, for use in messages like 'Please contact <vendorName>
	// customer support'.
	// create = required
	VendorName string `json:"vendorName,omitempty"`
	// Corporate headquarters telephone number.
	// create = optional
	VendorPhoneNumber string `json:"vendorPhoneNumber,omitempty"`
	// Corporate home page.
	// create = optional
	VendorURL string `json:"vendorURL,omitempty"`
}

PublicSystemInfoStruct - Retrieve static system-wide properties. extends TypedObject cliVisibility = [DOMAIN SYSTEM]

func PublicSystemInfoFactory 

func PublicSystemInfoFactory(
	ApiVersion *APIVersionStruct,
	Banner string,
	BuildTimestamp string,
	BuildTitle string,
	BuildVersion *VersionInfoStruct,
	Configured *bool,
	CurrentLocale string,
	EnabledFeatures []string,
	EngineQualifier string,
	KernelName string,
	Locales []string,
	ProductName string,
	ProductType string,
	SupportContacts []*SupportContactStruct,
	SupportURL string,
	VendorAddress []string,
	VendorEmail string,
	VendorName string,
	VendorPhoneNumber string,
	VendorURL string,
) PublicSystemInfoStruct

PublicSystemInfoFactory is just a simple function to instantiate the PublicSystemInfoStruct

type PurgeLogsParametersStruct 

type PurgeLogsParametersStruct struct {
	// Delete expired logs which have been retained to make snapshots
	// consistent.
	// default = false
	// required = true
	DeleteSnapshotLogs *bool `json:"deleteSnapshotLogs,omitempty"`
	// If this is set to true, this operation does not actually delete
	// logs. It returns the affected snapshots and truncated timeline as
	// if the logs were deleted.
	// default = true
	// required = true
	DryRun *bool `json:"dryRun,omitempty"`
	// Amount of space in bytes to reclaim as part of purgeLogs process.
	// minimum = 1
	// units = B
	// base = 1024
	// required = true
	StorageSpaceToReclaim float64 `json:"storageSpaceToReclaim,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PurgeLogsParametersStruct - Represents the parameters of a purgeLogs request. extends TypedObject

func PurgeLogsParametersFactory 

func PurgeLogsParametersFactory(
	DeleteSnapshotLogs *bool,
	DryRun *bool,
	StorageSpaceToReclaim float64,
) PurgeLogsParametersStruct

PurgeLogsParametersFactory is just a simple function to instantiate the PurgeLogsParametersStruct

type PurgeLogsResultStruct 

type PurgeLogsResultStruct struct {
	// List of snapshots which have been rendered unprovisionable because
	// logs needed to make them consistent have been deleted.
	AffectedSnapshots []TimeflowSnapshot `json:"affectedSnapshots,omitempty"`
	// TimeFlow point after the last snapshot beyond which TimeFlow will
	// be lost as a result of purging logs.
	TruncatePoint *OracleTimeflowPointStruct `json:"truncatePoint,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

PurgeLogsResultStruct - Represents the result of a purgeLogs operation. extends TypedObject

func PurgeLogsResultFactory 

func PurgeLogsResultFactory(
	AffectedSnapshots []TimeflowSnapshot,
	TruncatePoint *OracleTimeflowPointStruct,
) PurgeLogsResultStruct

PurgeLogsResultFactory is just a simple function to instantiate the PurgeLogsResultStruct

type QuotaPolicyStruct 

type QuotaPolicyStruct struct {
	// Last time a critical alert was generated.
	// format = date
	CritAlertTime string `json:"critAlertTime,omitempty"`
	// True if this policy is customized specifically for one object.
	// Customized policies cannot be shared between objects.
	// create = optional
	// default = false
	Customized *bool `json:"customized,omitempty"`
	// True if this is the default policy created when the system is
	// setup. Default policies cannot be deleted.
	Default *bool `json:"default,omitempty"`
	// Whether this policy has been directly applied or inherited. See
	// the effectivePolicies parameter of the list call for details.
	// enum = [DIRECT_APPLIED INHERITED]
	EffectiveType string `json:"effectiveType,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Size of the quota, in bytes.
	// base = 1024
	// create = required
	// update = optional
	// minimum = 1
	// units = B
	Size float64 `json:"size,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Last time a warning alert was generated.
	// format = date
	WarnAlertTime string `json:"warnAlertTime,omitempty"`
}

QuotaPolicyStruct - This policy limits the maximum amount of space an object (group or database) can use. extends Policy

func QuotaPolicyFactory 

func QuotaPolicyFactory(
	CritAlertTime string,
	Customized *bool,
	Default *bool,
	EffectiveType string,
	Name string,
	Namespace string,
	Reference string,
	Size float64,
	WarnAlertTime string,
) QuotaPolicyStruct

QuotaPolicyFactory is just a simple function to instantiate the QuotaPolicyStruct

type ReadonlyNamedUserObject 

type ReadonlyNamedUserObject interface{}

ReadonlyNamedUserObject is an empty interface designed to function as the ReadonlyNamedUserObject API namespace

type RefreshParametersStruct 

type RefreshParametersStruct struct {
	// The TimeFlow point, bookmark, or semantic location to refresh the
	// database to.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RefreshParametersStruct - The parameters to use as input to refresh requests for MSSQL, PostgreSQL, AppData, ASE or MySQL. extends TypedObject

func RefreshParametersFactory 

func RefreshParametersFactory(
	TimeflowPointParameters TimeflowPointParameters,
) RefreshParametersStruct

RefreshParametersFactory is just a simple function to instantiate the RefreshParametersStruct

type RefreshPolicyStruct 

type RefreshPolicyStruct struct {
	// True if this policy is customized specifically for one object.
	// Customized policies cannot be shared between objects.
	// create = optional
	// default = false
	Customized *bool `json:"customized,omitempty"`
	// True if this is the default policy created when the system is
	// setup. Default policies cannot be deleted.
	Default *bool `json:"default,omitempty"`
	// Whether this policy has been directly applied or inherited. See
	// the effectivePolicies parameter of the list call for details.
	// enum = [DIRECT_APPLIED INHERITED]
	EffectiveType string `json:"effectiveType,omitempty"`
	// Object name.
	// maxLength = 256
	// format = objectName
	// create = optional
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Provision source, either the latest time or latest snapshot.
	// create = required
	// update = optional
	// enum = [LATEST_SNAPSHOT LATEST_TIME_FLOW_LOG]
	ProvisionSource string `json:"provisionSource,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// List of Schedule objects representing when the policy will
	// execute.
	// create = required
	// update = optional
	ScheduleList []*ScheduleStruct `json:"scheduleList,omitempty"`
	// The timezone of this policy. If not specified, defaults to the
	// Delphix Engine's timezone.
	// create = optional
	// update = optional
	Timezone *TimeZoneStruct `json:"timezone,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RefreshPolicyStruct - This policy refreshes a container according to a schedule. extends SchedulePolicy

func RefreshPolicyFactory 

func RefreshPolicyFactory(
	Customized *bool,
	Default *bool,
	EffectiveType string,
	Name string,
	Namespace string,
	ProvisionSource string,
	Reference string,
	ScheduleList []*ScheduleStruct,
	Timezone *TimeZoneStruct,
) RefreshPolicyStruct

RefreshPolicyFactory is just a simple function to instantiate the RefreshPolicyStruct

type RegistrationInfoStruct 

type RegistrationInfoStruct struct {
	// The registration code for this Delphix Engine.
	Code string `json:"code,omitempty"`
	// The registration portal hostname.
	RegistrationPortalHostname string `json:"registrationPortalHostname,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The UUID for this Delphix Engine.
	Uuid string `json:"uuid,omitempty"`
}

RegistrationInfoStruct - The information required to register the Delphix Engine. extends TypedObject cliVisibility = [SYSTEM]

func RegistrationInfoFactory 

func RegistrationInfoFactory(
	Code string,
	RegistrationPortalHostname string,
	Uuid string,
) RegistrationInfoStruct

RegistrationInfoFactory is just a simple function to instantiate the RegistrationInfoStruct

type RegistrationParametersStruct 

type RegistrationParametersStruct struct {
	// Password to send to registration portal.
	// format = password
	Password string `json:"password,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Username to send to registration portal.
	Username string `json:"username,omitempty"`
}

RegistrationParametersStruct - Credentials used to register the Delphix Engine. extends TypedObject

func RegistrationParametersFactory 

func RegistrationParametersFactory(
	Password string,
	Username string,
) RegistrationParametersStruct

RegistrationParametersFactory is just a simple function to instantiate the RegistrationParametersStruct

type RegistrationStatusStruct 

type RegistrationStatusStruct struct {
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The status of the Delphix Engine's registration. It may be
	// unknown, unregistered, in-progress, or registered.
	// update = optional
	Status string `json:"status,omitempty"`
	// The time at which the registration status was last updated.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RegistrationStatusStruct - Information on the status of the Delphix Engine's registration. extends UserObject cliVisibility = [SYSTEM]

func RegistrationStatusFactory 

func RegistrationStatusFactory(
	Name string,
	Namespace string,
	Reference string,
	Status string,
	Timestamp string,
) RegistrationStatusStruct

RegistrationStatusFactory is just a simple function to instantiate the RegistrationStatusStruct

type RemoteDelphixEngineInfoStruct 

type RemoteDelphixEngineInfoStruct struct {
	// Address of other Delphix Engine.
	// format = host
	// create = required
	Address string `json:"address,omitempty"`
	// Password for the other Delphix Engine.
	// create = required
	Credential *PasswordCredentialStruct `json:"credential,omitempty"`
	// Username for the other Delphix Engine.
	// create = required
	Principal string `json:"principal,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RemoteDelphixEngineInfoStruct - Parameters for logging into another Delphix Engine when running a network throughput test. extends TypedObject

func RemoteDelphixEngineInfoFactory 

func RemoteDelphixEngineInfoFactory(
	Address string,
	Credential *PasswordCredentialStruct,
	Principal string,
) RemoteDelphixEngineInfoStruct

RemoteDelphixEngineInfoFactory is just a simple function to instantiate the RemoteDelphixEngineInfoStruct

type ReplicationListStruct 

type ReplicationListStruct struct {
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// Objects to replicate, in canonical object reference form.
	// minItems = 1
	// create = required
	// update = optional
	Objects []string `json:"objects,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ReplicationListStruct - List of objects that are to be replicated. extends ReplicationObjectSpecification

func ReplicationListFactory 

func ReplicationListFactory(
	Name string,
	Namespace string,
	Objects []string,
	Reference string,
) ReplicationListStruct

ReplicationListFactory is just a simple function to instantiate the ReplicationListStruct

type ReplicationObjectSpecification 

type ReplicationObjectSpecification interface{}

ReplicationObjectSpecification is an empty interface designed to function as the ReplicationObjectSpecification API namespace

type ReplicationSecureListStruct 

type ReplicationSecureListStruct struct {
	// Containers to replicate, in canonical object reference form.
	// minItems = 1
	// create = required
	// update = optional
	Containers []string `json:"containers,omitempty"`
	// Object name.
	// maxLength = 256
	// format = objectName
	// create = optional
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ReplicationSecureListStruct - List of containers that are to be securely replicated. extends ReplicationObjectSpecification

func ReplicationSecureListFactory 

func ReplicationSecureListFactory(
	Containers []string,
	Name string,
	Namespace string,
	Reference string,
) ReplicationSecureListStruct

ReplicationSecureListFactory is just a simple function to instantiate the ReplicationSecureListStruct

type ReplicationSourceStateStruct 

type ReplicationSourceStateStruct struct {
	// The active serialization point, currently being sent or about to
	// be sent to replication targets.
	// format = objectReference
	// referenceTo = /delphix-serialization-point.json
	ActivePoint string `json:"activePoint,omitempty"`
	// The last serialization point sent. This can be null prior to the
	// first replication run.
	// format = objectReference
	// referenceTo = /delphix-serialization-point.json
	LastPoint string `json:"lastPoint,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// A reference to the replication specification responsible for the
	// current state.
	// format = objectReference
	// referenceTo = /delphix-replicationspec.json
	Spec string `json:"spec,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ReplicationSourceStateStruct - State of a replication spec. extends UserObject

func ReplicationSourceStateFactory 

func ReplicationSourceStateFactory(
	ActivePoint string,
	LastPoint string,
	Name string,
	Namespace string,
	Reference string,
	Spec string,
) ReplicationSourceStateStruct

ReplicationSourceStateFactory is just a simple function to instantiate the ReplicationSourceStateStruct

type ReplicationSpecRuntimeStruct 

type ReplicationSpecRuntimeStruct struct {
	// Date of the next execution of this replication spec according to
	// the schedule.
	// format = date
	NextScheduledExecution string `json:"nextScheduledExecution,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ReplicationSpecRuntimeStruct - Runtime properties for a replication spec. extends TypedObject

func ReplicationSpecRuntimeFactory 

func ReplicationSpecRuntimeFactory(
	NextScheduledExecution string,
) ReplicationSpecRuntimeStruct

ReplicationSpecRuntimeFactory is just a simple function to instantiate the ReplicationSpecRuntimeStruct

type ReplicationSpecStruct 

type ReplicationSpecStruct struct {
	// Indication whether the replication spec schedule is enabled or
	// not.
	// create = optional
	// update = optional
	// default = false
	AutomaticReplication *bool `json:"automaticReplication,omitempty"`
	// Bandwidth limit (MB/s) for replication network traffic. A value of
	// 0 means no limit.
	// minimum = 0
	// create = optional
	// update = optional
	// default = 0
	BandwidthLimit *int `json:"bandwidthLimit,omitempty"`
	// Description of this replication spec.
	// create = optional
	// update = optional
	// maxLength = 4096
	Description string `json:"description,omitempty"`
	// Encrypt replication network traffic.
	// create = optional
	// update = optional
	// default = false
	Encrypted *bool `json:"encrypted,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Total number of transport connections to use.
	// create = optional
	// update = optional
	// default = 1
	// minimum = 1
	// maximum = 16
	NumberOfConnections *int `json:"numberOfConnections,omitempty"`
	// Specification of the objects to replicate.
	// create = required
	// update = optional
	ObjectSpecification ReplicationObjectSpecification `json:"objectSpecification,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Runtime properties of this replication spec.
	Runtime *ReplicationSpecRuntimeStruct `json:"runtime,omitempty"`
	// Replication schedule in the form of a quartz-formatted string.
	// create = optional
	// update = optional
	// minLength = 1
	// maxLength = 256
	Schedule string `json:"schedule,omitempty"`
	// Globally unique identifier for this replication spec.
	// minLength = 1
	// maxLength = 256
	Tag string `json:"tag,omitempty"`
	// Credential used to authenticate to the replication target host.
	// create = required
	// update = optional
	TargetCredential *PasswordCredentialStruct `json:"targetCredential,omitempty"`
	// Replication target host address.
	// format = host
	// create = required
	// update = optional
	TargetHost string `json:"targetHost,omitempty"`
	// Target TCP port number for the Delphix Session Protocol.
	// update = optional
	// minimum = 0
	// maximum = 65535
	// default = 8415
	// create = optional
	TargetPort *int `json:"targetPort,omitempty"`
	// Principal name used to authenticate to the replication target
	// host.
	// create = required
	// update = optional
	TargetPrincipal string `json:"targetPrincipal,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Connect to the replication target host via the system-wide SOCKS
	// proxy.
	// default = false
	// create = optional
	// update = optional
	UseSystemSocksSetting *bool `json:"useSystemSocksSetting,omitempty"`
}

ReplicationSpecStruct - Replication setup. extends UserObject

func ReplicationSpecFactory 

func ReplicationSpecFactory(
	AutomaticReplication *bool,
	BandwidthLimit *int,
	Description string,
	Encrypted *bool,
	Name string,
	Namespace string,
	NumberOfConnections *int,
	ObjectSpecification ReplicationObjectSpecification,
	Reference string,
	Runtime *ReplicationSpecRuntimeStruct,
	Schedule string,
	Tag string,
	TargetCredential *PasswordCredentialStruct,
	TargetHost string,
	TargetPort *int,
	TargetPrincipal string,
	UseSystemSocksSetting *bool,
) ReplicationSpecStruct

ReplicationSpecFactory is just a simple function to instantiate the ReplicationSpecStruct

type ReplicationTargetStateStruct 

type ReplicationTargetStateStruct struct {
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ReplicationTargetStateStruct - State of a replication at the target. extends UserObject

func ReplicationTargetStateFactory 

func ReplicationTargetStateFactory(
	Name string,
	Namespace string,
	Reference string,
) ReplicationTargetStateStruct

ReplicationTargetStateFactory is just a simple function to instantiate the ReplicationTargetStateStruct

type ResetIgnoredFaultsParametersStruct 

type ResetIgnoredFaultsParametersStruct struct {
	// Input list of ignored faults which will be marked as resolved.
	// required = true
	FaultReferences []string `json:"faultReferences,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ResetIgnoredFaultsParametersStruct - The parameters to use as input when marking selected ignored faults as resolved. extends TypedObject

func ResetIgnoredFaultsParametersFactory 

func ResetIgnoredFaultsParametersFactory(
	FaultReferences []string,
) ResetIgnoredFaultsParametersStruct

ResetIgnoredFaultsParametersFactory is just a simple function to instantiate the ResetIgnoredFaultsParametersStruct

type ResolveOrIgnoreSelectedFaultsParametersStruct 

type ResolveOrIgnoreSelectedFaultsParametersStruct struct {
	// Input list of faults which will be marked as resolved or ignored.
	// required = true
	FaultReferences []string `json:"faultReferences,omitempty"`
	// Flag indicating whether to ignore the selected faults if they are
	// detected on the same objects in the future.
	// required = true
	// default = false
	Ignore *bool `json:"ignore,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

ResolveOrIgnoreSelectedFaultsParametersStruct - The parameters to use as input when marking selected faults as resolved or ignored. extends TypedObject

func ResolveOrIgnoreSelectedFaultsParametersFactory 

func ResolveOrIgnoreSelectedFaultsParametersFactory(
	FaultReferences []string,
	Ignore *bool,
) ResolveOrIgnoreSelectedFaultsParametersStruct

ResolveOrIgnoreSelectedFaultsParametersFactory is just a simple function to instantiate the ResolveOrIgnoreSelectedFaultsParametersStruct

type RespError 

type RespError struct {
	Type        string `json:"type,omitempty"`
	Status      string `json:"status,omitempty"`
	ErrorStruct `json:"error,omitempty"`
}

RespError holds the resty response failure message

type RetentionPolicyStruct 

type RetentionPolicyStruct struct {
	// True if this policy is customized specifically for one object.
	// Customized policies cannot be shared between objects.
	// default = false
	// create = optional
	Customized *bool `json:"customized,omitempty"`
	// Amount of time (in dataUnit units) to keep source data.
	// create = optional
	// update = optional
	DataDuration *int `json:"dataDuration,omitempty"`
	// Time unit for dataDuration.
	// enum = [DAY WEEK MONTH QUARTER YEAR]
	// create = optional
	// update = optional
	DataUnit string `json:"dataUnit,omitempty"`
	// Day of month upon which to enforce monthly snapshot retention.
	// create = optional
	// update = optional
	DayOfMonth *int `json:"dayOfMonth,omitempty"`
	// Day of week upon which to enforce weekly snapshot retention.
	// enum = [MONDAY TUESDAY WEDNESDAY THURSDAY FRIDAY SATURDAY SUNDAY]
	// create = optional
	// update = optional
	DayOfWeek string `json:"dayOfWeek,omitempty"`
	// Day of year upon which to enforce yearly snapshot retention,
	// expressed a month / day string (e.g., "Jan 1").
	// create = optional
	// update = optional
	// maxLength = 32
	DayOfYear string `json:"dayOfYear,omitempty"`
	// True if this is the default policy created when the system is
	// setup. Default policies cannot be deleted.
	Default *bool `json:"default,omitempty"`
	// Whether this policy has been directly applied or inherited. See
	// the effectivePolicies parameter of the list call for details.
	// enum = [DIRECT_APPLIED INHERITED]
	EffectiveType string `json:"effectiveType,omitempty"`
	// Amount of time (in logUnit units) to keep log data.
	// update = optional
	// create = optional
	LogDuration *int `json:"logDuration,omitempty"`
	// Time unit for logDuration.
	// enum = [DAY WEEK MONTH QUARTER YEAR]
	// create = optional
	// update = optional
	LogUnit string `json:"logUnit,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Number of daily snapshots to keep.
	// update = optional
	// create = optional
	NumOfDaily *int `json:"numOfDaily,omitempty"`
	// Number of monthly snapshots to keep.
	// create = optional
	// update = optional
	NumOfMonthly *int `json:"numOfMonthly,omitempty"`
	// Number of weekly snapshots to keep.
	// create = optional
	// update = optional
	NumOfWeekly *int `json:"numOfWeekly,omitempty"`
	// Number of yearly snapshots to keep.
	// create = optional
	// update = optional
	NumOfYearly *int `json:"numOfYearly,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RetentionPolicyStruct - This policy controls what data (log and snapshot) is kept. extends Policy

func RetentionPolicyFactory 

func RetentionPolicyFactory(
	Customized *bool,
	DataDuration *int,
	DataUnit string,
	DayOfMonth *int,
	DayOfWeek string,
	DayOfYear string,
	Default *bool,
	EffectiveType string,
	LogDuration *int,
	LogUnit string,
	Name string,
	Namespace string,
	NumOfDaily *int,
	NumOfMonthly *int,
	NumOfWeekly *int,
	NumOfYearly *int,
	Reference string,
) RetentionPolicyStruct

RetentionPolicyFactory is just a simple function to instantiate the RetentionPolicyStruct

type RoleStruct 

type RoleStruct struct {
	// Determines if the role can be modified or not. Some roles are
	// shipped with the Delphix Engine and cannot be changed.
	Immutable *bool `json:"immutable,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// List of permissions contained in the role.
	// create = required
	// update = optional
	Permissions []string `json:"permissions,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RoleStruct - Describes a role as applied to a user on an object. extends UserObject

func RoleFactory 

func RoleFactory(
	Immutable *bool,
	Name string,
	Namespace string,
	Permissions []string,
	Reference string,
) RoleStruct

RoleFactory is just a simple function to instantiate the RoleStruct

type RollbackParametersStruct 

type RollbackParametersStruct struct {
	// The TimeFlow point, bookmark, or semantic location to roll the
	// database back to.
	// required = true
	// properties = map[type:map[default:TimeflowPointSemantic]]
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

RollbackParametersStruct - The parameters to use as input to rollback requests for MSSQL, PostgreSQL, AppData, ASE or MySQL. extends TypedObject

func RollbackParametersFactory 

func RollbackParametersFactory(
	TimeflowPointParameters TimeflowPointParameters,
) RollbackParametersStruct

RollbackParametersFactory is just a simple function to instantiate the RollbackParametersStruct

type RsaKeyPairStruct 

type RsaKeyPairStruct struct {
	// The size of each key to be generated.
	// create = optional
	// minimum = 2048
	// maximum = 4096
	// default = 2048
	KeySize *int `json:"keySize,omitempty"`
	// The signature algorithm this key pair will use to sign
	// certificates and CSRs.
	// create = optional
	// enum = [SHA256withRSA SHA384withRSA SHA512withRSA]
	// default = SHA256withRSA
	SignatureAlgorithm string `json:"signatureAlgorithm,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RsaKeyPairStruct - A key pair generated using the RSA algorithm. extends KeyPair

func RsaKeyPairFactory 

func RsaKeyPairFactory(
	KeySize *int,
	SignatureAlgorithm string,
) RsaKeyPairStruct

RsaKeyPairFactory is just a simple function to instantiate the RsaKeyPairStruct

type RunBashOnSourceOperationStruct 

type RunBashOnSourceOperationStruct struct {
	// The shell command to execute on the target host.
	// create = required
	// update = required
	Command string `json:"command,omitempty"`
	// A name for the source operation.
	// create = required
	// update = optional
	Name string `json:"name,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RunBashOnSourceOperationStruct - A user-specifiable operation that runs a shell command on the target host using the Delphix supplied Bash shell. extends SourceOperation

func RunBashOnSourceOperationFactory 

func RunBashOnSourceOperationFactory(
	Command string,
	Name string,
) RunBashOnSourceOperationStruct

RunBashOnSourceOperationFactory is just a simple function to instantiate the RunBashOnSourceOperationStruct

type RunCommandOnSourceOperationStruct 

type RunCommandOnSourceOperationStruct struct {
	// The shell command to execute on the target host.
	// update = optional
	// create = required
	Command string `json:"command,omitempty"`
	// A name for the source operation.
	// create = required
	// update = optional
	Name string `json:"name,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RunCommandOnSourceOperationStruct - A user-specifiable operation that runs a shell command on the target host. extends SourceOperation

func RunCommandOnSourceOperationFactory 

func RunCommandOnSourceOperationFactory(
	Command string,
	Name string,
) RunCommandOnSourceOperationStruct

RunCommandOnSourceOperationFactory is just a simple function to instantiate the RunCommandOnSourceOperationStruct

type RunExpectOnSourceOperationStruct 

type RunExpectOnSourceOperationStruct struct {
	// The expect command to execute on the target host.
	// create = required
	// update = optional
	Command string `json:"command,omitempty"`
	// A name for the source operation.
	// create = required
	// update = optional
	Name string `json:"name,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RunExpectOnSourceOperationStruct - A user-specifiable operation that runs an expect script on the target host. extends SourceOperation

func RunExpectOnSourceOperationFactory 

func RunExpectOnSourceOperationFactory(
	Command string,
	Name string,
) RunExpectOnSourceOperationStruct

RunExpectOnSourceOperationFactory is just a simple function to instantiate the RunExpectOnSourceOperationStruct

type RunMaskingJobOperationStruct 

type RunMaskingJobOperationStruct struct {
	// The location this Masking Job will be executed on.
	// update = readonly
	// create = readonly
	Host string `json:"host,omitempty"`
	// The Masking Job ID of the Masking Job to be executed.
	// create = readonly
	// update = readonly
	MaskingJobId string `json:"maskingJobId,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RunMaskingJobOperationStruct - An operation that runs a Masking Job on the local Delphix Masking Engine instance. extends Operation

func RunMaskingJobOperationFactory 

func RunMaskingJobOperationFactory() RunMaskingJobOperationStruct

RunMaskingJobOperationFactory is just a simple function to instantiate the RunMaskingJobOperationStruct

type RunPowerShellOnSourceOperationStruct 

type RunPowerShellOnSourceOperationStruct struct {
	// The PowerShell command to execute on the target host.
	// create = required
	// update = optional
	Command string `json:"command,omitempty"`
	// A name for the source operation.
	// create = required
	// update = optional
	Name string `json:"name,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

RunPowerShellOnSourceOperationStruct - A user-specifiable operation that runs a PowerShell command on the target host. extends SourceOperation

func RunPowerShellOnSourceOperationFactory 

func RunPowerShellOnSourceOperationFactory(
	Command string,
	Name string,
) RunPowerShellOnSourceOperationStruct

RunPowerShellOnSourceOperationFactory is just a simple function to instantiate the RunPowerShellOnSourceOperationStruct

type SMTPConfigStruct 

type SMTPConfigStruct struct {
	// True if username/password authentication should be used.
	// default = false
	// update = optional
	AuthenticationEnabled *bool `json:"authenticationEnabled,omitempty"`
	// True if outbound email is enabled.
	// update = optional
	Enabled *bool `json:"enabled,omitempty"`
	// From address to use when sending mail. If unspecified,
	// 'noreply@delphix.com' is used.
	// format = email
	// update = optional
	FromAddress string `json:"fromAddress,omitempty"`
	// If authentication is enabled, password to use when authenticating
	// to the server.
	// format = password
	// update = optional
	Password string `json:"password,omitempty"`
	// Port number to use. A value of -1 indicates the default (25 or 587
	// for TLS).
	// maximum = 65535
	// default = -1
	// update = optional
	// minimum = -1
	Port *int `json:"port,omitempty"`
	// Maximum timeout to wait, in seconds, when sending mail.
	// update = optional
	// minimum = 1
	SendTimeout *int `json:"sendTimeout,omitempty"`
	// IP address or hostname of SMTP relay server.
	// update = optional
	// format = host
	Server string `json:"server,omitempty"`
	// True if TLS (transport layer security) should be used.
	// default = false
	// update = optional
	TlsEnabled *bool `json:"tlsEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// If authentication is enabled, username to use when authenticating
	// to the server.
	// update = optional
	Username string `json:"username,omitempty"`
}

SMTPConfigStruct - SMTP configuration. extends TypedObject cliVisibility = [SYSTEM]

func SMTPConfigFactory 

func SMTPConfigFactory(
	AuthenticationEnabled *bool,
	Enabled *bool,
	FromAddress string,
	Password string,
	Port *int,
	SendTimeout *int,
	Server string,
	TlsEnabled *bool,
	Username string,
) SMTPConfigStruct

SMTPConfigFactory is just a simple function to instantiate the SMTPConfigStruct

type SNMPConfigStruct 

type SNMPConfigStruct struct {
	// The network which is authorized to query this SNMP server, in CIDR
	// notation. Toallow any client, then leave unset or set to
	// 0.0.0.0/0. To block all clients, set to 127.0.0.1/8.
	// format = cidrAddress
	// update = optional
	// default = 0.0.0.0/0
	AuthorizedNetwork string `json:"authorizedNetwork,omitempty"`
	// The community string that clients must provide when querying this
	// server.
	// update = optional
	// default = public
	Community string `json:"community,omitempty"`
	// True if the SNMP service is enabled.
	// update = optional
	// default = true
	Enabled *bool `json:"enabled,omitempty"`
	// The physical location of this Delphix Engine (OID 1.3.6.1.2.1.1.6
	// - sysLocation).
	// update = optional
	Location string `json:"location,omitempty"`
	// SNMP trap severity. SNMP managers are only notified of events at
	// or above this level.
	// update = optional
	// enum = [CRITICAL WARNING INFORMATIONAL]
	// default = WARNING
	Severity string `json:"severity,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SNMPConfigStruct - SNMP configuration. extends TypedObject cliVisibility = [SYSTEM]

func SNMPConfigFactory 

func SNMPConfigFactory(
	AuthorizedNetwork string,
	Community string,
	Enabled *bool,
	Location string,
	Severity string,
) SNMPConfigStruct

SNMPConfigFactory is just a simple function to instantiate the SNMPConfigStruct

type SNMPManagerStruct 

type SNMPManagerStruct struct {
	// SNMP manager host.
	// create = required
	// update = optional
	// format = host
	Address string `json:"address,omitempty"`
	// SNMP manager community string.
	// update = optional
	// create = required
	CommunityString string `json:"communityString,omitempty"`
	// Describes if the most recent attempt to send a trap succeeded or
	// failed.
	// enum = [FAILED SUCCEEDED PENDING UNCHECKED]
	// default = PENDING
	// create = readonly
	// update = readonly
	LastSendStatus string `json:"lastSendStatus,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// SNMP manager port number.
	// minimum = 1
	// maximum = 65535
	// default = 162
	// create = optional
	// update = optional
	Port *int `json:"port,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// True if INFORM messages are to be sent to this manager, false for
	// TRAP messages.
	// update = optional
	// default = false
	// create = optional
	UseInform *bool `json:"useInform,omitempty"`
}

SNMPManagerStruct - SNMP manager configuration. extends PersistentObject cliVisibility = [SYSTEM]

func SNMPManagerFactory 

func SNMPManagerFactory(
	Address string,
	CommunityString string,
	Namespace string,
	Port *int,
	Reference string,
	UseInform *bool,
) SNMPManagerStruct

SNMPManagerFactory is just a simple function to instantiate the SNMPManagerStruct

type SSHConnectivityStruct 

type SSHConnectivityStruct struct {
	// Target host name or IP address.
	// required = true
	Address string `json:"address,omitempty"`
	// User credentials.
	// required = true
	Credentials Credential `json:"credentials,omitempty"`
	// SSH port on remote server.
	// default = 22
	// minimum = 1
	// maximum = 65535
	Port *int `json:"port,omitempty"`
	// Mechanism to use for ssh host verification.
	// required = false
	SshVerificationStrategy SshVerificationStrategy `json:"sshVerificationStrategy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// User name.
	// required = true
	Username string `json:"username,omitempty"`
}

SSHConnectivityStruct - Mechanism to test SSH connectivity of arbitrary hosts. extends TypedObject

func SSHConnectivityFactory 

func SSHConnectivityFactory(
	Address string,
	Credentials Credential,
	Port *int,
	SshVerificationStrategy SshVerificationStrategy,
	Username string,
) SSHConnectivityStruct

SSHConnectivityFactory is just a simple function to instantiate the SSHConnectivityStruct

type SamlAuthParametersStruct 

type SamlAuthParametersStruct struct {
	// Set to true to encode SAML authentication requests.
	// required = true
	// default = true
	EncodeRequest *bool `json:"encodeRequest,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SamlAuthParametersStruct - The parameter to use as input to determine whether to encode a SAML authentication request. extends TypedObject

func SamlAuthParametersFactory 

func SamlAuthParametersFactory(
	EncodeRequest *bool,
) SamlAuthParametersStruct

SamlAuthParametersFactory is just a simple function to instantiate the SamlAuthParametersStruct

type SamlInfoStruct 

type SamlInfoStruct struct {
	// Whether or not SAML authentication is configured and enabled for
	// this Delphix Engine.
	Enabled *bool `json:"enabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SamlInfoStruct - Global SAML information. extends TypedObject cliVisibility = [SYSTEM]

func SamlInfoFactory 

func SamlInfoFactory(
	Enabled *bool,
) SamlInfoStruct

SamlInfoFactory is just a simple function to instantiate the SamlInfoStruct

type SamlServiceProviderStruct 

type SamlServiceProviderStruct struct {
	// The public URL the Delphix Engine will be accessed at.
	// required = true
	BaseUrl string `json:"baseUrl,omitempty"`
	// The decryption (private) key that will be used to decrypt SAML
	// assertions. Leave empty if response will not be encrypted. This
	// key MUST be a PKCS8 key.
	// create = optional
	// update = optional
	DecryptingKey string `json:"decryptingKey,omitempty"`
	// URL to which the SAML authentication request will be sent.
	// required = true
	Destination string `json:"destination,omitempty"`
	// Unique name of service provider.
	// required = true
	EntityId string `json:"entityId,omitempty"`
	// Algorithm used for creation of digital signature on metadata.
	// required = true
	HashAlgUrl string `json:"hashAlgUrl,omitempty"`
	// A unique identifier that is provided by the identity provider to
	// ensure we are a valid service provider.
	// required = true
	IssuerId string `json:"issuerId,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// The signing (public) key that will be used to verify SAML
	// signatures. Leave empty if responses will not be signed.
	// update = optional
	// create = optional
	SigningKey string `json:"signingKey,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SamlServiceProviderStruct - SAML service provider configuration. extends ReadonlyNamedUserObject cliVisibility = [SYSTEM]

func SamlServiceProviderFactory 

func SamlServiceProviderFactory(
	BaseUrl string,
	DecryptingKey string,
	Destination string,
	EntityId string,
	HashAlgUrl string,
	IssuerId string,
	Name string,
	Namespace string,
	Reference string,
	SigningKey string,
) SamlServiceProviderStruct

SamlServiceProviderFactory is just a simple function to instantiate the SamlServiceProviderStruct

type SchedulePolicy 

type SchedulePolicy interface{}

SchedulePolicy is an empty interface designed to function as the SchedulePolicy API namespace

type ScheduleStruct 

type ScheduleStruct struct {
	// Schedule cron string. See CronTrigger documentation at
	// http://quartz-scheduler.org/ for details.
	// maxLength = 120
	// create = required
	// update = required
	CronString string `json:"cronString,omitempty"`
	// Cutoff time in seconds. The policy job will suspend if not
	// completed within the given time limit.
	// update = optional
	// units = sec
	// create = optional
	CutoffTime *int `json:"cutoffTime,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ScheduleStruct - Represent a schedule in the Delphix system. extends TypedObject

func ScheduleFactory 

func ScheduleFactory(
	CronString string,
	CutoffTime *int,
) ScheduleStruct

ScheduleFactory is just a simple function to instantiate the ScheduleStruct

type SchemaDraftV4Struct 

type SchemaDraftV4Struct struct {
}

SchemaDraftV4Struct - A dummy schema that is used to represent JSON that is a valid Draft v4 schema.

type SchemaStruct 

type SchemaStruct struct {
	// JSON representation of the schema based on the locale and API
	// Session version.
	Schema string `json:"schema,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SchemaStruct - Schema object. extends TypedObject

func SchemaFactory 

func SchemaFactory(
	Schema string,
) SchemaStruct

SchemaFactory is just a simple function to instantiate the SchemaStruct

type ScrubStatusStruct 

type ScrubStatusStruct struct {
	// Amount of data scrubbed, in bytes.
	// base = 1024
	// units = B
	Completed float64 `json:"completed,omitempty"`
	// Time scrub ended.
	// format = date
	EndTime string `json:"endTime,omitempty"`
	// Number of errors encountered during scrub.
	Errors float64 `json:"errors,omitempty"`
	// Time scrub was started.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// Scrub state.
	// enum = [NONE ACTIVE COMPLETED CANCELED]
	State string `json:"state,omitempty"`
	// Total amount of data to scrub (including completed), in bytes.
	// units = B
	// base = 1024
	Total float64 `json:"total,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ScrubStatusStruct - The status of a scrub of the storage in the system. extends TypedObject cliVisibility = [SYSTEM]

func ScrubStatusFactory 

func ScrubStatusFactory(
	Completed float64,
	EndTime string,
	Errors float64,
	StartTime string,
	State string,
	Total float64,
) ScrubStatusStruct

ScrubStatusFactory is just a simple function to instantiate the ScrubStatusStruct

type SecurityConfigStruct 

type SecurityConfigStruct struct {
	// Allowed origin domains for CORS. Should be a comma separated list.
	// Use * for all domains. Defaults to none. Changing this value
	// requires a stack restart for it to take effect.
	// update = optional
	AllowedCORSOrigins string `json:"allowedCORSOrigins,omitempty"`
	// Banner displayed prior to login.
	// update = optional
	Banner string `json:"banner,omitempty"`
	// Whether or not CORS is enabled. Changing this value requires a
	// stack restart for it to take effect.
	// update = optional
	IsCORSEnabled *bool `json:"isCORSEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SecurityConfigStruct - System wide security configuration. extends TypedObject cliVisibility = [SYSTEM]

func SecurityConfigFactory 

func SecurityConfigFactory(
	AllowedCORSOrigins string,
	Banner string,
	IsCORSEnabled *bool,
) SecurityConfigStruct

SecurityConfigFactory is just a simple function to instantiate the SecurityConfigStruct

type SerializationPointStruct 

type SerializationPointStruct struct {
	// Average throughput of the transfer of the serialization point
	// (bytes/s).
	// base = 1024
	// units = B/s
	AverageThroughput float64 `json:"averageThroughput,omitempty"`
	// Bytes of the serialization point which have been transferred.
	// units = B
	// base = 1024
	BytesTransferred *int `json:"bytesTransferred,omitempty"`
	// Timestamp of the data being stored in the serialization point.
	// format = date
	DataTimestamp string `json:"dataTimestamp,omitempty"`
	// The elapsed time spent sending the serialization point
	// (nanoseconds).
	// units = nsec
	// base = 1024
	ElapsedTimeNanos float64 `json:"elapsedTimeNanos,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// An arbitrary string used to map the serialization point to a
	// corresponding replication spec or namespace.
	Tag string `json:"tag,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SerializationPointStruct - A serialization point represents the data and metadata associated with a replication spec at a point in time. extends UserObject

func SerializationPointFactory 

func SerializationPointFactory(
	AverageThroughput float64,
	BytesTransferred *int,
	DataTimestamp string,
	ElapsedTimeNanos float64,
	Name string,
	Namespace string,
	Reference string,
	Tag string,
) SerializationPointStruct

SerializationPointFactory is just a simple function to instantiate the SerializationPointStruct

type SeverityFilterStruct 

type SeverityFilterStruct struct {
	// List of severity levels. Only alerts matching one of the given
	// severity levels are included.
	// create = optional
	// update = optional
	// uniqueItems = true
	// minItems = 1
	SeverityLevels []string `json:"severityLevels,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SeverityFilterStruct - An alert filter that specifies which severity levels to match against. extends AlertFilter

func SeverityFilterFactory 

func SeverityFilterFactory(
	SeverityLevels []string,
) SeverityFilterStruct

SeverityFilterFactory is just a simple function to instantiate the SeverityFilterStruct

type SingletonUpdateStruct 

type SingletonUpdateStruct struct {
	// Type of target object.
	// format = type
	ObjectType string `json:"objectType,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SingletonUpdateStruct - An event indicating an update to a singleton object on the system. extends Notification

func SingletonUpdateFactory 

func SingletonUpdateFactory(
	ObjectType string,
) SingletonUpdateStruct

SingletonUpdateFactory is just a simple function to instantiate the SingletonUpdateStruct

type SnapshotCapacityDataStruct 

type SnapshotCapacityDataStruct struct {
	// Reference to the container to which this snapshot belongs.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// List of VDBs that have been provisioned from this snapshot.
	DescendantVDBs []string `json:"descendantVDBs,omitempty"`
	// The manual retention setting on this snapshot, in days.
	ManualRetention *int `json:"manualRetention,omitempty"`
	// Whether this snapshot is currently being retained due to policy
	// settings.
	PolicyRetention *bool `json:"policyRetention,omitempty"`
	// Reference to the snapshot.
	// format = objectReference
	// referenceTo = /delphix-timeflow-snapshot.json
	Snapshot string `json:"snapshot,omitempty"`
	// Time at which this snapshot was taken.
	// format = date
	SnapshotTimestamp string `json:"snapshotTimestamp,omitempty"`
	// Space used by the snapshot.
	// units = B
	// base = 1024
	Space float64 `json:"space,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SnapshotCapacityDataStruct - Capacity metrics for a single snapshot. extends TypedObject cliVisibility = [DOMAIN]

func SnapshotCapacityDataFactory 

func SnapshotCapacityDataFactory(
	Container string,
	DescendantVDBs []string,
	ManualRetention *int,
	PolicyRetention *bool,
	Snapshot string,
	SnapshotTimestamp string,
	Space float64,
) SnapshotCapacityDataStruct

SnapshotCapacityDataFactory is just a simple function to instantiate the SnapshotCapacityDataStruct

type SnapshotLogFetchParametersStruct 

type SnapshotLogFetchParametersStruct struct {
	// User credentials. If not provided will use environment credentials
	// for 'username' on 'host'.
	Credentials Credential `json:"credentials,omitempty"`
	// Directory on the remote server where the missing log files reside.
	// required = true
	Directory string `json:"directory,omitempty"`
	// Remote host to connect to.
	// required = true
	Host string `json:"host,omitempty"`
	// SSH port to connect to.
	// default = 22
	Port *int `json:"port,omitempty"`
	// Reference to the snapshot for which to fetch logs.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-oracle-snapshot.json
	Snapshot string `json:"snapshot,omitempty"`
	// Mechanism to use for ssh host verification.
	// required = false
	SshVerificationStrategy SshVerificationStrategy `json:"sshVerificationStrategy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// User name to authenticate as.
	// required = true
	Username string `json:"username,omitempty"`
}

SnapshotLogFetchParametersStruct - Parameters to fetch log files that cover a snapshot and the TimeFlow range up to the next snapshot. extends LogFetchSSH

func SnapshotLogFetchParametersFactory 

func SnapshotLogFetchParametersFactory(
	Credentials Credential,
	Directory string,
	Host string,
	Port *int,
	Snapshot string,
	SshVerificationStrategy SshVerificationStrategy,
	Username string,
) SnapshotLogFetchParametersStruct

SnapshotLogFetchParametersFactory is just a simple function to instantiate the SnapshotLogFetchParametersStruct

type SnapshotPolicyStruct 

type SnapshotPolicyStruct struct {
	// True if this policy is customized specifically for one object.
	// Customized policies cannot be shared between objects.
	// create = optional
	// default = false
	Customized *bool `json:"customized,omitempty"`
	// True if this is the default policy created when the system is
	// setup. Default policies cannot be deleted.
	Default *bool `json:"default,omitempty"`
	// Whether this policy has been directly applied or inherited. See
	// the effectivePolicies parameter of the list call for details.
	// enum = [DIRECT_APPLIED INHERITED]
	EffectiveType string `json:"effectiveType,omitempty"`
	// Object name.
	// create = optional
	// update = optional
	// maxLength = 256
	// format = objectName
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// List of Schedule objects representing when the policy will
	// execute.
	// create = required
	// update = optional
	ScheduleList []*ScheduleStruct `json:"scheduleList,omitempty"`
	// The timezone of this policy. If not specified, defaults to the
	// Delphix Engine's timezone.
	// create = optional
	// update = optional
	Timezone *TimeZoneStruct `json:"timezone,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SnapshotPolicyStruct - This policy creates snapshots of a container with externally managed sources (virtual databases) according to a schedule. extends SchedulePolicy

func SnapshotPolicyFactory 

func SnapshotPolicyFactory(
	Customized *bool,
	Default *bool,
	EffectiveType string,
	Name string,
	Namespace string,
	Reference string,
	ScheduleList []*ScheduleStruct,
	Timezone *TimeZoneStruct,
) SnapshotPolicyStruct

SnapshotPolicyFactory is just a simple function to instantiate the SnapshotPolicyStruct

type SnapshotRuntimeStruct 

type SnapshotRuntimeStruct struct {
	// True if this snapshot can be used as the basis for provisioning a
	// new TimeFlow.
	Provisionable *bool `json:"provisionable,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SnapshotRuntimeStruct - Runtime properties of a TimeFlow snapshot. extends TypedObject

func SnapshotRuntimeFactory 

func SnapshotRuntimeFactory(
	Provisionable *bool,
) SnapshotRuntimeStruct

SnapshotRuntimeFactory is just a simple function to instantiate the SnapshotRuntimeStruct

type SnapshotSpaceMapStruct 

type SnapshotSpaceMapStruct struct {
	// Amount of space, per object, in bytes, that it uses.
	SizeMap map[string]string `json:"sizeMap,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SnapshotSpaceMapStruct - Mapping of containers and snapshots to their respective space usage. extends TypedObject

func SnapshotSpaceMapFactory 

func SnapshotSpaceMapFactory(
	SizeMap map[string]string,
) SnapshotSpaceMapStruct

SnapshotSpaceMapFactory is just a simple function to instantiate the SnapshotSpaceMapStruct

type SnapshotSpaceParametersStruct 

type SnapshotSpaceParametersStruct struct {
	// FilesystemObjects to query, in canonical object reference form.
	// required = true
	ObjectReferences []string `json:"objectReferences,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SnapshotSpaceParametersStruct - Input to the operation to determine how much space is used by a set of snapshots. extends TypedObject

func SnapshotSpaceParametersFactory 

func SnapshotSpaceParametersFactory(
	ObjectReferences []string,
) SnapshotSpaceParametersStruct

SnapshotSpaceParametersFactory is just a simple function to instantiate the SnapshotSpaceParametersStruct

type SnapshotSpaceResultStruct 

type SnapshotSpaceResultStruct struct {
	// Total amount of space, in bytes, that would be freed by deleting
	// the input snapshots.
	// units = B
	// base = 1024
	TotalSize float64 `json:"totalSize,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SnapshotSpaceResultStruct - Result of the operation to determine how much space is used by a set of snapshots. extends TypedObject

func SnapshotSpaceResultFactory 

func SnapshotSpaceResultFactory(
	TotalSize float64,
) SnapshotSpaceResultStruct

SnapshotSpaceResultFactory is just a simple function to instantiate the SnapshotSpaceResultStruct

type Source 

type Source interface{}

Source is an empty interface designed to function as the Source API namespace

type SourceConfig 

type SourceConfig interface{}

SourceConfig is an empty interface designed to function as the SourceConfig API namespace

type SourceConfigConnectivityStruct 

type SourceConfigConnectivityStruct struct {
	// Database password.
	// format = password
	// required = true
	Password string `json:"password,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Database username.
	// required = true
	Username string `json:"username,omitempty"`
}

SourceConfigConnectivityStruct - Mechanism to test JDBC connectivity to source configs. extends AbstractSourceConfigConnectivity

func SourceConfigConnectivityFactory 

func SourceConfigConnectivityFactory(
	Password string,
	Username string,
) SourceConfigConnectivityStruct

SourceConfigConnectivityFactory is just a simple function to instantiate the SourceConfigConnectivityStruct

type SourceConnectionInfo 

type SourceConnectionInfo interface{}

SourceConnectionInfo is an empty interface designed to function as the SourceConnectionInfo API namespace

type SourceDisableParametersStruct 

type SourceDisableParametersStruct struct {
	// Whether to attempt a cleanup of the database from the environment
	// before the disable.
	// default = true
	AttemptCleanup *bool `json:"attemptCleanup,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SourceDisableParametersStruct - The parameters to use as input to disable a MSSQL, PostgreSQL, AppData, ASE or MySQL source. extends TypedObject

func SourceDisableParametersFactory 

func SourceDisableParametersFactory(
	AttemptCleanup *bool,
) SourceDisableParametersStruct

SourceDisableParametersFactory is just a simple function to instantiate the SourceDisableParametersStruct

type SourceEnableParametersStruct 

type SourceEnableParametersStruct struct {
	// Whether to attempt a startup of the source after the enable.
	// default = true
	AttemptStart *bool `json:"attemptStart,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SourceEnableParametersStruct - The parameters to use as input to enable a MSSQL, PostgreSQL, AppData, ASE or MySQL source. extends TypedObject

func SourceEnableParametersFactory 

func SourceEnableParametersFactory(
	AttemptStart *bool,
) SourceEnableParametersStruct

SourceEnableParametersFactory is just a simple function to instantiate the SourceEnableParametersStruct

type SourceEnvironment 

type SourceEnvironment interface{}

SourceEnvironment is an empty interface designed to function as the SourceEnvironment API namespace

type SourceEnvironmentCreateParameters 

type SourceEnvironmentCreateParameters interface{}

SourceEnvironmentCreateParameters is an empty interface designed to function as the SourceEnvironmentCreateParameters API namespace

type SourceOperation 

type SourceOperation interface{}

SourceOperation is an empty interface designed to function as the SourceOperation API namespace

type SourceRepository 

type SourceRepository interface{}

SourceRepository is an empty interface designed to function as the SourceRepository API namespace

type SourceRepositoryTemplateStruct 

type SourceRepositoryTemplateStruct struct {
	// The reference to the database container.
	// referenceTo = /delphix-container.json
	// format = objectReference
	// create = required
	Container string `json:"container,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The reference to the target repository.
	// format = objectReference
	// create = required
	// referenceTo = /delphix-source-repository.json
	Repository string `json:"repository,omitempty"`
	// The reference to the associated template.
	// referenceTo = /delphix-database-template.json
	// format = objectReference
	// create = required
	Template string `json:"template,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

SourceRepositoryTemplateStruct - The representation of a repository template object. extends NamedUserObject

func SourceRepositoryTemplateFactory 

func SourceRepositoryTemplateFactory(
	Container string,
	Name string,
	Namespace string,
	Reference string,
	Repository string,
	Template string,
) SourceRepositoryTemplateStruct

SourceRepositoryTemplateFactory is just a simple function to instantiate the SourceRepositoryTemplateStruct

type SourceRuntime 

type SourceRuntime interface{}

SourceRuntime is an empty interface designed to function as the SourceRuntime API namespace

type SourceStartParametersStruct 

type SourceStartParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SourceStartParametersStruct - The parameters to use as input to start a MSSQL, PostgreSQL, AppData, ASE or MySQL source. extends TypedObject

func SourceStartParametersFactory 

func SourceStartParametersFactory() SourceStartParametersStruct

SourceStartParametersFactory is just a simple function to instantiate the SourceStartParametersStruct

type SourceStopParametersStruct 

type SourceStopParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SourceStopParametersStruct - The parameters to use as input to stop a MSSQL, PostgreSQL, AppData, ASE or MySQL source. extends TypedObject

func SourceStopParametersFactory 

func SourceStopParametersFactory() SourceStopParametersStruct

SourceStopParametersFactory is just a simple function to instantiate the SourceStopParametersStruct

type SourceUpgradeParametersStruct 

type SourceUpgradeParametersStruct struct {
	// The source config that the source database upgrades to.
	// required = true
	SourceConfig SourceConfig `json:"sourceConfig,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

SourceUpgradeParametersStruct - The parameters to use as input to upgrade a source. extends TypedObject

func SourceUpgradeParametersFactory 

func SourceUpgradeParametersFactory(
	SourceConfig SourceConfig,
) SourceUpgradeParametersStruct

SourceUpgradeParametersFactory is just a simple function to instantiate the SourceUpgradeParametersStruct

type SourcingPolicyStruct 

type SourcingPolicyStruct struct {
	// True if LogSync should run for this database.
	// create = optional
	// update = optional
	// default = false
	LogsyncEnabled *bool `json:"logsyncEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SourcingPolicyStruct - Database policies for managing SnapSync and LogSync across sources for a MSSQL container. extends TypedObject

func SourcingPolicyFactory 

func SourcingPolicyFactory(
	LogsyncEnabled *bool,
) SourcingPolicyStruct

SourcingPolicyFactory is just a simple function to instantiate the SourcingPolicyStruct

type SplunkHecConfigStruct 

type SplunkHecConfigStruct struct {
	// Whether we should send metrics data to Splunk.
	// create = required
	// update = optional
	// default = true
	EnableMetrics *bool `json:"enableMetrics,omitempty"`
	// Whether to use HTTPS to connect to Splunk. This should correspond
	// to your HTTP Event Collector settings in Splunk.
	// create = required
	// update = optional
	EnableSSL *bool `json:"enableSSL,omitempty"`
	// Whether we should send Delphix Insight data to Splunk using this
	// configuration.
	// default = false
	// create = required
	// update = optional
	Enabled *bool `json:"enabled,omitempty"`
	// The frequency in number of seconds at which the Events will be
	// pushed to Splunk. Defaults to 60 seconds.
	// update = optional
	// minimum = 5
	// maximum = 3600
	// default = 60
	// create = optional
	EventsPushFrequency *int `json:"eventsPushFrequency,omitempty"`
	// The TCP port number for the Splunk HTTP Event Collector (HEC).
	// maximum = 65535
	// create = required
	// update = optional
	// minimum = 1
	HecPort *int `json:"hecPort,omitempty"`
	// The token for the Splunk HTTP Event Collector (HEC).
	// create = required
	// update = optional
	HecToken string `json:"hecToken,omitempty"`
	// Splunk host name or IP address.
	// create = required
	// update = optional
	Host string `json:"host,omitempty"`
	// The Splunk Index events will be sent to. Must be set as an allowed
	// index for the HEC token.
	// create = required
	// update = optional
	MainIndex string `json:"mainIndex,omitempty"`
	// The Splunk Index metrics will be sent to. Must be set as an
	// allowed index for the HEC token. If none is specified the
	// mainIndex will be used for metrics as well.
	// create = optional
	// update = optional
	MetricsIndex string `json:"metricsIndex,omitempty"`
	// The frequency in number of seconds at which the Performance
	// Metrics will be pushed to Splunk. Defaults to 60 seconds.
	// default = 60
	// create = optional
	// update = optional
	// minimum = 5
	// maximum = 3600
	MetricsPushFrequency *int `json:"metricsPushFrequency,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The resolution of performance metrics data sent to Splunk. The
	// options are SECOND for 1-second resolution, or MINUTE for 1-minute
	// resolution.
	// default = MINUTE
	// create = optional
	// update = optional
	// enum = [SECOND MINUTE]
	PerformanceMetricsResolution string `json:"performanceMetricsResolution,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SplunkHecConfigStruct - Splunk HTTP Event Collector specific configuration information. extends UserObject cliVisibility = [SYSTEM]

func SplunkHecConfigFactory 

func SplunkHecConfigFactory(
	EnableMetrics *bool,
	EnableSSL *bool,
	Enabled *bool,
	EventsPushFrequency *int,
	HecPort *int,
	HecToken string,
	Host string,
	MainIndex string,
	MetricsIndex string,
	MetricsPushFrequency *int,
	Name string,
	Namespace string,
	PerformanceMetricsResolution string,
	Reference string,
) SplunkHecConfigStruct

SplunkHecConfigFactory is just a simple function to instantiate the SplunkHecConfigStruct

type SshAcceptAlwaysStruct 

type SshAcceptAlwaysStruct struct {
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

SshAcceptAlwaysStruct - Key-verification strategy that always accepts the host's key. extends SshVerificationStrategy

func SshAcceptAlwaysFactory 

func SshAcceptAlwaysFactory() SshAcceptAlwaysStruct

SshAcceptAlwaysFactory is just a simple function to instantiate the SshAcceptAlwaysStruct

type SshVerificationStrategy 

type SshVerificationStrategy interface{}

SshVerificationStrategy is an empty interface designed to function as the SshVerificationStrategy API namespace

type SshVerifyBase 

type SshVerifyBase interface{}

SshVerifyBase is an empty interface designed to function as the SshVerifyBase API namespace

type SshVerifyFingerprintStruct 

type SshVerifyFingerprintStruct struct {
	// Base-64 encoded fingerprint of the ssh key of the host.
	// format = hostFingerprint
	// required = true
	Fingerprint string `json:"fingerprint,omitempty"`
	// Hash function for the fingerprint.
	// enum = [SHA256 SHA512]
	// required = true
	FingerprintType string `json:"fingerprintType,omitempty"`
	// Type of ssh key.
	// enum = [RSA DSA ECDSA ED25519]
	// required = true
	KeyType string `json:"keyType,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SshVerifyFingerprintStruct - SSH verification strategy based on a known per-host fingerprint. extends SshVerifyBase

func SshVerifyFingerprintFactory 

func SshVerifyFingerprintFactory(
	Fingerprint string,
	FingerprintType string,
	KeyType string,
) SshVerifyFingerprintStruct

SshVerifyFingerprintFactory is just a simple function to instantiate the SshVerifyFingerprintStruct

type SshVerifyRawKeyStruct 

type SshVerifyRawKeyStruct struct {
	// Type of ssh key.
	// enum = [RSA DSA ECDSA ED25519]
	// required = true
	KeyType string `json:"keyType,omitempty"`
	// Base64-encoded ssh key of the host.
	// required = true
	// format = hostKey
	RawKey string `json:"rawKey,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

SshVerifyRawKeyStruct - SSH verification strategy based on a known per-host key. extends SshVerifyBase

func SshVerifyRawKeyFactory 

func SshVerifyRawKeyFactory(
	KeyType string,
	RawKey string,
) SshVerifyRawKeyStruct

SshVerifyRawKeyFactory is just a simple function to instantiate the SshVerifyRawKeyStruct

type StagingCompatibilityParametersStruct 

type StagingCompatibilityParametersStruct struct {
	// Restrict returned repositories to this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	// create = optional
	// update = optional
	Environment string `json:"environment,omitempty"`
	// The repository to use as a source of compatibility information.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	SourceRepository string `json:"sourceRepository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StagingCompatibilityParametersStruct - The criteria necessary to select valid repositories for staging. extends CompatibleRepositoriesParameters

func StagingCompatibilityParametersFactory 

func StagingCompatibilityParametersFactory(
	Environment string,
	SourceRepository string,
) StagingCompatibilityParametersStruct

StagingCompatibilityParametersFactory is just a simple function to instantiate the StagingCompatibilityParametersStruct

type StatisticAxisStruct 

type StatisticAxisStruct struct {
	// The name for this axis.
	AxisName string `json:"axisName,omitempty"`
	// The type of constraint that can be applied to this axis.
	ConstraintType string `json:"constraintType,omitempty"`
	// A deeper explanation of the data this corresponds to.
	Explanation string `json:"explanation,omitempty"`
	// Whether this axis appears as an attribute of a datapoint stream or
	// of datapoints themselves.
	StreamAttribute *bool `json:"streamAttribute,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// The type of value this axis will have for collected data.
	// enum = [INTEGER BOOLEAN STRING HISTOGRAM]
	ValueType string `json:"valueType,omitempty"`
}

StatisticAxisStruct - The attributes of a statistic axis. extends TypedObject

func StatisticAxisFactory 

func StatisticAxisFactory(
	AxisName string,
	ConstraintType string,
	Explanation string,
	StreamAttribute *bool,
	ValueType string,
) StatisticAxisStruct

StatisticAxisFactory is just a simple function to instantiate the StatisticAxisStruct

type StatisticEnumAxisStruct 

type StatisticEnumAxisStruct struct {
	// The name for this axis.
	AxisName string `json:"axisName,omitempty"`
	// The type of constraint that can be applied to this axis.
	ConstraintType string `json:"constraintType,omitempty"`
	// The set of values that are allowed for this axis.
	EnumValues []string `json:"enumValues,omitempty"`
	// A deeper explanation of the data this corresponds to.
	Explanation string `json:"explanation,omitempty"`
	// Whether this axis appears as an attribute of a datapoint stream or
	// of datapoints themselves.
	StreamAttribute *bool `json:"streamAttribute,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The type of value this axis will have for collected data.
	// enum = [INTEGER BOOLEAN STRING HISTOGRAM]
	ValueType string `json:"valueType,omitempty"`
}

StatisticEnumAxisStruct - The attributes of a statistic axis which is an enum type. extends StatisticAxis

func StatisticEnumAxisFactory 

func StatisticEnumAxisFactory(
	AxisName string,
	ConstraintType string,
	EnumValues []string,
	Explanation string,
	StreamAttribute *bool,
	ValueType string,
) StatisticEnumAxisStruct

StatisticEnumAxisFactory is just a simple function to instantiate the StatisticEnumAxisStruct

type StatisticSliceStruct 

type StatisticSliceStruct struct {
	// Axis constraints act as per-axis filters on data that is being
	// collected.
	// create = optional
	AxisConstraints []AxisConstraint `json:"axisConstraints,omitempty"`
	// The set of axes to collect (usually these are not constrained
	// axes).
	// create = required
	CollectionAxes []string `json:"collectionAxes,omitempty"`
	// The minimum interval between each reading for this statistic.
	// units = sec
	// create = optional
	CollectionInterval *int `json:"collectionInterval,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// Collection state of the slice.
	// enum = [INITIALIZED RUNNING PAUSED FAILED]
	State string `json:"state,omitempty"`
	// The type name for the data this can collect.
	// create = required
	StatisticType string `json:"statisticType,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StatisticSliceStruct - Collects a slice of a multidimensional analytics statistic. extends NamedUserObject cliVisibility = [DOMAIN SYSTEM]

func StatisticSliceFactory 

func StatisticSliceFactory(
	AxisConstraints []AxisConstraint,
	CollectionAxes []string,
	CollectionInterval *int,
	Name string,
	Namespace string,
	Reference string,
	State string,
	StatisticType string,
) StatisticSliceStruct

StatisticSliceFactory is just a simple function to instantiate the StatisticSliceStruct

type StatisticStruct 

type StatisticStruct struct {
	// The set of axes this statistic has.
	Axes []*StatisticAxisStruct `json:"axes,omitempty"`
	// A deeper explanation of the data this can collect.
	Explanation string `json:"explanation,omitempty"`
	// The smallest unit of time this statistic can measure on.
	// units = sec
	MinCollectionInterval *int `json:"minCollectionInterval,omitempty"`
	// The type name for the data this can collect.
	StatisticType string `json:"statisticType,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StatisticStruct - Multidimensional analytics statistics which can be queried for data. extends TypedObject cliVisibility = [DOMAIN]

func StatisticFactory 

func StatisticFactory(
	Axes []*StatisticAxisStruct,
	Explanation string,
	MinCollectionInterval *int,
	StatisticType string,
) StatisticStruct

StatisticFactory is just a simple function to instantiate the StatisticStruct

type StorageDeviceInitializeStatusStruct 

type StorageDeviceInitializeStatusStruct struct {
	// Amount of data initialized, in bytes.
	// base = 1024
	// units = B
	BytesDone float64 `json:"bytesDone,omitempty"`
	// Total amount of data to initialize (including data already
	// initialized), in bytes.
	// base = 1024
	// units = B
	BytesEst float64 `json:"bytesEst,omitempty"`
	// Initialization state.
	// enum = [NONE ACTIVE CANCELED SUSPENDED COMPLETED]
	State string `json:"state,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StorageDeviceInitializeStatusStruct - The status of an initialize operation of a storage device in the system. extends TypedObject

func StorageDeviceInitializeStatusFactory 

func StorageDeviceInitializeStatusFactory(
	BytesDone float64,
	BytesEst float64,
	State string,
) StorageDeviceInitializeStatusStruct

StorageDeviceInitializeStatusFactory is just a simple function to instantiate the StorageDeviceInitializeStatusStruct

type StorageDeviceRemovalStatusStruct 

type StorageDeviceRemovalStatusStruct struct {
	// Amount of data removed, in bytes.
	// base = 1024
	// units = B
	Copied float64 `json:"copied,omitempty"`
	// Memory used to account for removed devices, in bytes.
	// base = 1024
	// units = B
	MappingMemory float64 `json:"mappingMemory,omitempty"`
	// Time removal was started.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// Removal state.
	// enum = [NONE ACTIVE COMPLETED CANCELED]
	State string `json:"state,omitempty"`
	// Total amount of data to remove (including completed), in bytes.
	// base = 1024
	// units = B
	Total float64 `json:"total,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StorageDeviceRemovalStatusStruct - The status of a device removal of the storage in the system. extends TypedObject cliVisibility = [SYSTEM]

func StorageDeviceRemovalStatusFactory 

func StorageDeviceRemovalStatusFactory(
	Copied float64,
	MappingMemory float64,
	StartTime string,
	State string,
	Total float64,
) StorageDeviceRemovalStatusStruct

StorageDeviceRemovalStatusFactory is just a simple function to instantiate the StorageDeviceRemovalStatusStruct

type StorageDeviceRemovalVerifyResultStruct 

type StorageDeviceRemovalVerifyResultStruct struct {
	// Free space of the pool if this device is removed, in bytes.
	// base = 1024
	// units = B
	NewFreeBytes float64 `json:"newFreeBytes,omitempty"`
	// Amount of memory to be used by mappings if this device is removed,
	// in bytes.
	// base = 1024
	// units = B
	NewMappingMemory float64 `json:"newMappingMemory,omitempty"`
	// Free space of the pool before this device is removed, in bytes.
	// units = B
	// base = 1024
	OldFreeBytes float64 `json:"oldFreeBytes,omitempty"`
	// Amount of memory used by removal mappings before this device is
	// removed, in bytes.
	// base = 1024
	// units = B
	OldMappingMemory float64 `json:"oldMappingMemory,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StorageDeviceRemovalVerifyResultStruct - The . extends TypedObject

func StorageDeviceRemovalVerifyResultFactory 

func StorageDeviceRemovalVerifyResultFactory(
	NewFreeBytes float64,
	NewMappingMemory float64,
	OldFreeBytes float64,
	OldMappingMemory float64,
) StorageDeviceRemovalVerifyResultStruct

StorageDeviceRemovalVerifyResultFactory is just a simple function to instantiate the StorageDeviceRemovalVerifyResultStruct

type StorageDeviceStruct 

type StorageDeviceStruct struct {
	// True if the device is currently configured in the system.
	Configured *bool `json:"configured,omitempty"`
	// Model ID of the device.
	Model string `json:"model,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Serial number of the device.
	Serial string `json:"serial,omitempty"`
	// Physical size of the device, in bytes.
	// base = 1024
	// units = B
	Size float64 `json:"size,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Vendor ID of the device.
	Vendor string `json:"vendor,omitempty"`
}

StorageDeviceStruct - A storage device on the system. extends NamedUserObject cliVisibility = [SYSTEM]

func StorageDeviceFactory 

func StorageDeviceFactory(
	Configured *bool,
	Model string,
	Name string,
	Namespace string,
	Reference string,
	Serial string,
	Size float64,
	Vendor string,
) StorageDeviceStruct

StorageDeviceFactory is just a simple function to instantiate the StorageDeviceStruct

type StorageTestParametersStruct 

type StorageTestParametersStruct struct {
	// The list of devices to be used for the test.
	// create = optional
	Devices []string `json:"devices,omitempty"`
	// Run time of each test, in seconds.
	// minimum = 1
	// maximum = 3600
	// default = 120
	// create = optional
	Duration *int `json:"duration,omitempty"`
	// True if the disks should be initialized prior to running the
	// benchmark.
	// default = true
	// create = optional
	InitializeDevices *bool `json:"initializeDevices,omitempty"`
	// True if the entire disk should be initialized prior to running the
	// benchmark.
	// default = false
	// create = optional
	InitializeEntireDevice *bool `json:"initializeEntireDevice,omitempty"`
	// Total disk space, spread over all devices, used by the test (in
	// bytes).
	// units = B
	// base = 1024
	// minimum = 1.048576e+06
	// default = 5.49755813888e+11
	// create = optional
	TestRegion float64 `json:"testRegion,omitempty"`
	// The tests that are to be run.
	// default = ALL
	// create = required
	// enum = [ALL MINIMAL READ WRITE RANDREAD]
	Tests string `json:"tests,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StorageTestParametersStruct - Parameters used to execute a storage test. extends TypedObject

func StorageTestParametersFactory 

func StorageTestParametersFactory(
	Devices []string,
	Duration *int,
	InitializeDevices *bool,
	InitializeEntireDevice *bool,
	TestRegion float64,
	Tests string,
) StorageTestParametersStruct

StorageTestParametersFactory is just a simple function to instantiate the StorageTestParametersStruct

type StorageTestResultStruct 

type StorageTestResultStruct struct {
	// Average latency in milliseconds.
	AverageLatency float64 `json:"averageLatency,omitempty"`
	// Block size used for the test.
	// units = B
	// base = 1024
	BlockSize *int `json:"blockSize,omitempty"`
	// IO operations per second.
	Iops *int `json:"iops,omitempty"`
	// No of jobs/threads used.
	Jobs *int `json:"jobs,omitempty"`
	// 95th percentile latency in milliseconds.
	Latency95thPercentile float64 `json:"latency95thPercentile,omitempty"`
	// Grade assigned to the test for latency.
	LatencyGrade string `json:"latencyGrade,omitempty"`
	// Load scaling.
	LoadScaling float64 `json:"loadScaling,omitempty"`
	// Grade assigned to the test for load scaling.
	LoadScalingGrade string `json:"loadScalingGrade,omitempty"`
	// Maximum latency in milliseconds.
	MaxLatency float64 `json:"maxLatency,omitempty"`
	// Minimum latency in milliseconds.
	MinLatency float64 `json:"minLatency,omitempty"`
	// Standard deviation of latency in milliseconds.
	StddevLatency float64 `json:"stddevLatency,omitempty"`
	// Name of the test for which the grade is assigned.
	TestName string `json:"testName,omitempty"`
	// The test type.
	// enum = [READ WRITE RANDREAD RANDWRITE]
	TestType string `json:"testType,omitempty"`
	// Throughput.
	// base = 1024
	// units = bps
	Throughput float64 `json:"throughput,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StorageTestResultStruct - The test results of one storage test. extends TypedObject

func StorageTestResultFactory 

func StorageTestResultFactory(
	AverageLatency float64,
	BlockSize *int,
	Iops *int,
	Jobs *int,
	Latency95thPercentile float64,
	LatencyGrade string,
	LoadScaling float64,
	LoadScalingGrade string,
	MaxLatency float64,
	MinLatency float64,
	StddevLatency float64,
	TestName string,
	TestType string,
	Throughput float64,
) StorageTestResultStruct

StorageTestResultFactory is just a simple function to instantiate the StorageTestResultStruct

type StorageTestStruct 

type StorageTestStruct struct {
	// Time when the test ended.
	// format = date
	EndTime string `json:"endTime,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The parameters used to execute the test.
	Parameters *StorageTestParametersStruct `json:"parameters,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Time when the test was started.
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// The state of the test.
	// enum = [WAITING RUNNING COMPLETED FAILED CANCELED]
	State string `json:"state,omitempty"`
	// The results assigned to various tests.
	TestResults []*StorageTestResultStruct `json:"testResults,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StorageTestStruct - Test the performance of storage devices. extends ReadonlyNamedUserObject cliVisibility = [SYSTEM]

func StorageTestFactory 

func StorageTestFactory(
	EndTime string,
	Name string,
	Namespace string,
	Parameters *StorageTestParametersStruct,
	Reference string,
	StartTime string,
	State string,
	TestResults []*StorageTestResultStruct,
) StorageTestStruct

StorageTestFactory is just a simple function to instantiate the StorageTestStruct

type StringConstraint 

type StringConstraint interface{}

StringConstraint is an empty interface designed to function as the StringConstraint API namespace

type StringEqualConstraintStruct 

type StringEqualConstraintStruct struct {
	// The name of the axis being constrained.
	// create = required
	AxisName string `json:"axisName,omitempty"`
	// The axis values must match this string.
	// create = required
	Equals string `json:"equals,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

StringEqualConstraintStruct - Constraint placed on a string axis of a particular analytics slice. extends StringConstraint

func StringEqualConstraintFactory 

func StringEqualConstraintFactory(
	AxisName string,
	Equals string,
) StringEqualConstraintStruct

StringEqualConstraintFactory is just a simple function to instantiate the StringEqualConstraintStruct

type SupportAccessStateStruct 

type SupportAccessStateStruct struct {
	// How the support shell can be accessed.
	// update = required
	// enum = [DISABLED ENABLED_NO_TOKEN ENABLED_WITH_TOKEN]
	AccessType string `json:"accessType,omitempty"`
	// If ENABLED_WITH_TOKEN, time that the token will no longer be
	// valid.
	// update = optional
	// format = date
	EndTime string `json:"endTime,omitempty"`
	// If ENABLED_WITH_TOKEN, the time that the token will be valid.
	// update = optional
	// format = date
	StartTime string `json:"startTime,omitempty"`
	// If ENABLED_WITH_TOKEN, the token that must be supplied to login.
	// update = optional
	Token string `json:"token,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SupportAccessStateStruct - The state of the access to the support shell. extends TypedObject cliVisibility = [SYSTEM]

func SupportAccessStateFactory 

func SupportAccessStateFactory(
	AccessType string,
	EndTime string,
	StartTime string,
	Token string,
) SupportAccessStateStruct

SupportAccessStateFactory is just a simple function to instantiate the SupportAccessStateStruct

type SupportBundleGenerateParametersStruct 

type SupportBundleGenerateParametersStruct struct {
	// Type of support bundle to generate. Reserved for Delphix support
	// use.
	// default = ALL
	// enum = [PHONEHOME MDS OS CORE LOG DROPBOX STORAGE_TEST MASKING ALL]
	BundleType string `json:"bundleType,omitempty"`
	// The list of environments from which logs should be collected.
	// uniqueItems = true
	// required = false
	Environments []string `json:"environments,omitempty"`
	// Whether or not to include the analytics data in the support bundle
	// which is generated. Including analytics data may significantly
	// increase the support bundle size and upload time, but enables
	// analysis of performance characteristics of the Delphix Engine.
	// default = false
	IncludeAnalyticsData *bool `json:"includeAnalyticsData,omitempty"`
	// The list of sources from which logs should be collected.
	// required = false
	// uniqueItems = true
	Sources []string `json:"sources,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

SupportBundleGenerateParametersStruct - Parameters to be used when generating a support bundle. extends BaseSupportBundleParameters

func SupportBundleGenerateParametersFactory 

func SupportBundleGenerateParametersFactory(
	BundleType string,
	Environments []string,
	IncludeAnalyticsData *bool,
	Sources []string,
) SupportBundleGenerateParametersStruct

SupportBundleGenerateParametersFactory is just a simple function to instantiate the SupportBundleGenerateParametersStruct

type SupportBundleUploadParametersStruct 

type SupportBundleUploadParametersStruct struct {
	// Type of support bundle to generate. Reserved for Delphix support
	// use.
	// default = ALL
	// enum = [PHONEHOME MDS OS CORE LOG DROPBOX STORAGE_TEST MASKING ALL]
	BundleType string `json:"bundleType,omitempty"`
	// The Delphix support case number.
	CaseNumber *int `json:"caseNumber,omitempty"`
	// The list of environments from which logs should be collected.
	// required = false
	// uniqueItems = true
	Environments []string `json:"environments,omitempty"`
	// Whether or not to include the analytics data in the support bundle
	// which is generated. Including analytics data may significantly
	// increase the support bundle size and upload time, but enables
	// analysis of performance characteristics of the Delphix Engine.
	// default = false
	IncludeAnalyticsData *bool `json:"includeAnalyticsData,omitempty"`
	// The list of sources from which logs should be collected.
	// required = false
	// uniqueItems = true
	Sources []string `json:"sources,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SupportBundleUploadParametersStruct - Parameters to be used when uploading a support bundle. extends BaseSupportBundleParameters

func SupportBundleUploadParametersFactory 

func SupportBundleUploadParametersFactory(
	BundleType string,
	CaseNumber *int,
	Environments []string,
	IncludeAnalyticsData *bool,
	Sources []string,
) SupportBundleUploadParametersStruct

SupportBundleUploadParametersFactory is just a simple function to instantiate the SupportBundleUploadParametersStruct

type SupportContactStruct 

type SupportContactStruct struct {
	// An ISO country code, as recognized by modern browsers for
	// resolving locale.
	// required = true
	// enum = [-- AF AL DZ AS AD AO AQ AG AR AM AW AU AT AZ BS BH BD BB BY BE BZ BJ BM BT BO BA BW BV BR IO BN BG BF BI KH CM CA CV KY CF TD CL CN CX CC CO KM CG CD CK CR CI HR CU CY CZ DK DJ DM DO EC EG SV GQ ER EE ET FK FO FJ FI FR GF PF TF GA GM GE DE GH GI GR GL GD GP GU GT GN GW GY HT HM HN HK HU IS IN ID IR IQ IE IL IT JM JP JO KZ KE KI KP KR KW KG LA LV LB LS LR LY LI LT LU MO MK MG MW MY MV ML MT MH MQ MR MU YT MX FM MD MC MN ME MS MA MZ MM NA NR NP NL AN NC NZ NI NE NG NU NF MP NO OM PK PW PS PA PG PY PE PH PN PL PT PR QA RE RO RU RW SH KN LC PM VC WS SM ST SA SN RS SC SL SG SK SI SB SO ZA GS ES LK SD SR SJ SZ SE CH SY TW TJ TZ TH TL TG TK TO TT TN TR TM TC TV UG UA AE GB US UM UY UZ VU VE VN VG VI WF EH YE ZM ZW]
	Country string `json:"country,omitempty"`
	// A telephone number, formatted in accordance with the norms of the
	// associated country.
	PhoneNumber string `json:"phoneNumber,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SupportContactStruct - A support telephone number mapped to a given country. May include text (e.g. 1-800-FOR-HELP). extends TypedObject

func SupportContactFactory 

func SupportContactFactory(
	Country string,
	PhoneNumber string,
) SupportContactStruct

SupportContactFactory is just a simple function to instantiate the SupportContactStruct

type SwitchTimeflowParametersStruct 

type SwitchTimeflowParametersStruct struct {
	// The reference to the target TimeFlow that should be made the
	// current TimeFlow.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SwitchTimeflowParametersStruct - The input parameters used for the TimeFlow switch operation. extends TypedObject

func SwitchTimeflowParametersFactory 

func SwitchTimeflowParametersFactory(
	Timeflow string,
) SwitchTimeflowParametersStruct

SwitchTimeflowParametersFactory is just a simple function to instantiate the SwitchTimeflowParametersStruct

type SyncParametersStruct 

type SyncParametersStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SyncParametersStruct - The parameters to use as input to sync requests. extends TypedObject

func SyncParametersFactory 

func SyncParametersFactory() SyncParametersStruct

SyncParametersFactory is just a simple function to instantiate the SyncParametersStruct

type SyncPolicyStruct 

type SyncPolicyStruct struct {
	// True if this policy is customized specifically for one object.
	// Customized policies cannot be shared between objects.
	// create = optional
	// default = false
	Customized *bool `json:"customized,omitempty"`
	// True if this is the default policy created when the system is
	// setup. Default policies cannot be deleted.
	Default *bool `json:"default,omitempty"`
	// Whether this policy has been directly applied or inherited. See
	// the effectivePolicies parameter of the list call for details.
	// enum = [DIRECT_APPLIED INHERITED]
	EffectiveType string `json:"effectiveType,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// List of Schedule objects representing when the policy will
	// execute.
	// create = required
	// update = optional
	ScheduleList []*ScheduleStruct `json:"scheduleList,omitempty"`
	// The timezone of this policy. If not specified, defaults to the
	// Delphix Engine's timezone.
	// create = optional
	// update = optional
	Timezone *TimeZoneStruct `json:"timezone,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SyncPolicyStruct - This policy syncs a container (runs SnapSync) according to the given schedule. extends SchedulePolicy

func SyncPolicyFactory 

func SyncPolicyFactory(
	Customized *bool,
	Default *bool,
	EffectiveType string,
	Name string,
	Namespace string,
	Reference string,
	ScheduleList []*ScheduleStruct,
	Timezone *TimeZoneStruct,
) SyncPolicyStruct

SyncPolicyFactory is just a simple function to instantiate the SyncPolicyStruct

type SyslogConfigStruct 

type SyslogConfigStruct struct {
	// True if the syslog service is enabled.
	// update = optional
	// default = true
	Enabled *bool `json:"enabled,omitempty"`
	// Syslog message format.
	// update = optional
	// enum = [TEXT JSON]
	// default = TEXT
	Format string `json:"format,omitempty"`
	// Syslog logging pattern. Events will be logged in the pattern as
	// specified.
	// update = optional
	// default = %-5p delphix : %m%n
	Pattern string `json:"pattern,omitempty"`
	// List of syslog servers. At least one syslog server must be
	// specified.
	// update = required
	Servers []*SyslogServerStruct `json:"servers,omitempty"`
	// Syslog logging severity. Only events at or above this severity
	// will be logged.
	// update = optional
	// enum = [EMERGENCY ALERT CRITICAL ERROR WARNING NOTICE INFORMATIONAL DEBUG]
	// default = WARNING
	Severity string `json:"severity,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SyslogConfigStruct - Syslog configuration. extends TypedObject cliVisibility = [SYSTEM]

func SyslogConfigFactory 

func SyslogConfigFactory(
	Enabled *bool,
	Format string,
	Pattern string,
	Servers []*SyslogServerStruct,
	Severity string,
) SyslogConfigStruct

SyslogConfigFactory is just a simple function to instantiate the SyslogConfigStruct

type SyslogServerStruct 

type SyslogServerStruct struct {
	// Syslog host name or IP address.
	// format = host
	// required = true
	Address string `json:"address,omitempty"`
	// Syslog port number.
	// required = true
	// minimum = 0
	// maximum = 65535
	// default = 514
	Port *int `json:"port,omitempty"`
	// Syslog transport protocol.
	// required = true
	// enum = [udp tcp]
	// default = udp
	Protocol string `json:"protocol,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SyslogServerStruct - Syslog server configuration. extends TypedObject

func SyslogServerFactory 

func SyslogServerFactory(
	Address string,
	Port *int,
	Protocol string,
) SyslogServerStruct

SyslogServerFactory is just a simple function to instantiate the SyslogServerStruct

type SystemInfoStruct 

type SystemInfoStruct struct {
	// Maximum supported API version of the current system software.
	ApiVersion *APIVersionStruct `json:"apiVersion,omitempty"`
	// Security banner to display prior to login.
	Banner string `json:"banner,omitempty"`
	// Time at which the current system software was built.
	// format = date
	BuildTimestamp string `json:"buildTimestamp,omitempty"`
	// Description of the current system software.
	BuildTitle string `json:"buildTitle,omitempty"`
	// Delphix version of the current system software.
	BuildVersion *VersionInfoStruct `json:"buildVersion,omitempty"`
	// Indicates whether the server has gone through initial setup or
	// not.
	Configured *bool `json:"configured,omitempty"`
	// Percentage of CPU reserved on the host.
	// units = %
	CpuReservation float64 `json:"cpuReservation,omitempty"`
	// The current system locale.
	// format = locale
	CurrentLocale string `json:"currentLocale,omitempty"`
	// The list of enabled features on this Delphix Engine.
	EnabledFeatures []string `json:"enabledFeatures,omitempty"`
	// Qualifier for referencing instances of (e.g. 'Delphix') engines in
	// messages like 'The <engineQualifier> Engine failed to ...'.
	// create = required
	EngineQualifier string `json:"engineQualifier,omitempty"`
	// System hostname.
	// format = hostname
	// update = optional
	Hostname string `json:"hostname,omitempty"`
	// The date and time that the Delphix Engine was installed.
	// format = date
	InstallationTime string `json:"installationTime,omitempty"`
	// The operating system kernel name.
	KernelName string `json:"kernelName,omitempty"`
	// List of available locales.
	Locales []string `json:"locales,omitempty"`
	// Amount of memory reserved on the host.
	// units = B
	// base = 1024
	MemoryReservation float64 `json:"memoryReservation,omitempty"`
	// Total memory on the system, in bytes.
	// units = B
	// base = 1024
	MemorySize float64 `json:"memorySize,omitempty"`
	// Description of the current system platform.
	Platform string `json:"platform,omitempty"`
	// Processors on the system.
	Processors []*CPUInfoStruct `json:"processors,omitempty"`
	// Name of the product that the system is running.
	ProductName string `json:"productName,omitempty"`
	// Product type.
	ProductType string `json:"productType,omitempty"`
	// SSH public key to be added to SSH authorized_keys for environment
	// users using the SystemKeyCredential authorization mechanism.
	SshPublicKey string `json:"sshPublicKey,omitempty"`
	// Total amount of raw storage allocated for dSources, VDBs, and
	// system metadata. Zero if storage has not yet been configured.
	// units = B
	// base = 1024
	StorageTotal float64 `json:"storageTotal,omitempty"`
	// Amount of raw storage used by dSources, VDBs and system metadata.
	// units = B
	// base = 1024
	StorageUsed float64 `json:"storageUsed,omitempty"`
	// Technical support phone numbers.
	// create = optional
	SupportContacts []*SupportContactStruct `json:"supportContacts,omitempty"`
	// Technical Support URL.
	// create = optional
	SupportURL string `json:"supportURL,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Delphix Engine up time.
	UpTime *UpTimeInfoStruct `json:"upTime,omitempty"`
	// Globally unique identifier for this software installation.
	Uuid string `json:"uuid,omitempty"`
	// Address of vendor headquarters. Free form collection of strings to
	// accomodate any region.
	// create = optional
	VendorAddress []string `json:"vendorAddress,omitempty"`
	// Corporate headquarters email address.
	// create = optional
	// format = email
	VendorEmail string `json:"vendorEmail,omitempty"`
	// Vendor name, for use in messages like 'Please contact <vendorName>
	// customer support'.
	// create = required
	VendorName string `json:"vendorName,omitempty"`
	// Corporate headquarters telephone number.
	// create = optional
	VendorPhoneNumber string `json:"vendorPhoneNumber,omitempty"`
	// Corporate home page.
	// create = optional
	VendorURL string `json:"vendorURL,omitempty"`
}

SystemInfoStruct - Retrieve system-wide properties and manage the state of the system. extends PublicSystemInfo cliVisibility = [DOMAIN SYSTEM]

func SystemInfoFactory 

func SystemInfoFactory(
	ApiVersion *APIVersionStruct,
	Banner string,
	BuildTimestamp string,
	BuildTitle string,
	BuildVersion *VersionInfoStruct,
	Configured *bool,
	CpuReservation float64,
	CurrentLocale string,
	EnabledFeatures []string,
	EngineQualifier string,
	Hostname string,
	InstallationTime string,
	KernelName string,
	Locales []string,
	MemoryReservation float64,
	MemorySize float64,
	Platform string,
	Processors []*CPUInfoStruct,
	ProductName string,
	ProductType string,
	SshPublicKey string,
	StorageTotal float64,
	StorageUsed float64,
	SupportContacts []*SupportContactStruct,
	SupportURL string,
	UpTime *UpTimeInfoStruct,
	Uuid string,
	VendorAddress []string,
	VendorEmail string,
	VendorName string,
	VendorPhoneNumber string,
	VendorURL string,
) SystemInfoStruct

SystemInfoFactory is just a simple function to instantiate the SystemInfoStruct

type SystemInitializationParametersStruct 

type SystemInitializationParametersStruct struct {
	// Password to use for the default domain administrator.
	// create = required
	// format = password
	// default = delphix
	DefaultPassword string `json:"defaultPassword,omitempty"`
	// Name of the default domain administrator to create.
	// maxLength = 256
	// default = delphix_admin
	// create = optional
	// pattern = ^[a-zA-Z][-_.a-zA-Z0-9]*$
	// minLength = 1
	DefaultUser string `json:"defaultUser,omitempty"`
	// List of storage devices to use.
	// create = required
	Devices []string `json:"devices,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SystemInitializationParametersStruct - Parameters used for intializing an engine. extends TypedObject

func SystemInitializationParametersFactory 

func SystemInitializationParametersFactory(
	DefaultPassword string,
	DefaultUser string,
	Devices []string,
) SystemInitializationParametersStruct

SystemInitializationParametersFactory is just a simple function to instantiate the SystemInitializationParametersStruct

type SystemKeyCredentialStruct 

type SystemKeyCredentialStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

SystemKeyCredentialStruct - The system public key based security credential. extends PublicKeyCredential

func SystemKeyCredentialFactory 

func SystemKeyCredentialFactory() SystemKeyCredentialStruct

SystemKeyCredentialFactory is just a simple function to instantiate the SystemKeyCredentialStruct

type SystemPackageStruct 

type SystemPackageStruct struct {
	// Package name.
	// maxLength = 256
	// format = objectName
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Possible versions for this package.
	// update = readonly
	PossibleVersions []string `json:"possibleVersions,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Current version of the package.
	// update = required
	Version string `json:"version,omitempty"`
}

SystemPackageStruct - A package whose version can be changed by sysadmins. extends NamedUserObject cliVisibility = [SYSTEM]

func SystemPackageFactory 

func SystemPackageFactory(
	Name string,
	Namespace string,
	PossibleVersions []string,
	Reference string,
	Version string,
) SystemPackageStruct

SystemPackageFactory is just a simple function to instantiate the SystemPackageStruct

type SystemVersionStruct 

type SystemVersionStruct struct {
	// Date on which the version was built.
	// format = date
	BuildDate string `json:"buildDate,omitempty"`
	// Date on which this version was installed.
	// format = date
	InstallDate string `json:"installDate,omitempty"`
	// The minimum DelphixOS version supported by this Delphix version.
	MinOsVersion string `json:"minOsVersion,omitempty"`
	// The minimum required Delphix version in order to upgrade.
	MinVersion string `json:"minVersion,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// DelphixOS is running from this version.
	OsRunning *bool `json:"osRunning,omitempty"`
	// The DelphixOS version number.
	OsVersion string `json:"osVersion,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The state of the version.
	// enum = [PREVIOUS CURRENTLY_RUNNING DEFERRED UPLOADED UNPACKING DELETING VERIFYING VERIFIED APPLYING UNKNOWN DISABLE_FAILED]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Date on which this version was last verified.
	// format = date
	VerifyDate string `json:"verifyDate,omitempty"`
	// The Delphix version number.
	Version string `json:"version,omitempty"`
}

SystemVersionStruct - Describes a Delphix software revision. extends NamedUserObject cliVisibility = [SYSTEM]

func SystemVersionFactory 

func SystemVersionFactory(
	BuildDate string,
	InstallDate string,
	MinOsVersion string,
	MinVersion string,
	Name string,
	Namespace string,
	OsRunning *bool,
	OsVersion string,
	Reference string,
	Status string,
	VerifyDate string,
	Version string,
) SystemVersionStruct

SystemVersionFactory is just a simple function to instantiate the SystemVersionStruct

type TCPStatsDatapointStreamStruct 

type TCPStatsDatapointStreamStruct struct {
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// The local Delphix Engine IP address.
	// format = ipAddress
	LocalAddress string `json:"localAddress,omitempty"`
	// The local TCP port number.
	LocalPort *int `json:"localPort,omitempty"`
	// The remote IP address.
	// format = ipAddress
	RemoteAddress string `json:"remoteAddress,omitempty"`
	// The remote TCP port number.
	RemotePort *int `json:"remotePort,omitempty"`
	// The network service.
	Service string `json:"service,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TCPStatsDatapointStreamStruct - A stream of datapoints from a TCP_STATS analytics slice. extends DatapointStream

func TCPStatsDatapointStreamFactory 

func TCPStatsDatapointStreamFactory(
	Datapoints []Datapoint,
	LocalAddress string,
	LocalPort *int,
	RemoteAddress string,
	RemotePort *int,
	Service string,
) TCPStatsDatapointStreamStruct

TCPStatsDatapointStreamFactory is just a simple function to instantiate the TCPStatsDatapointStreamStruct

type TCPStatsDatapointStruct 

type TCPStatsDatapointStruct struct {
	// The size of the local congestion window.
	// units = B
	// base = 1024
	CongestionWindowSize *int `json:"congestionWindowSize,omitempty"`
	// Data bytes received.
	// units = B
	// base = 1024
	InBytes *int `json:"inBytes,omitempty"`
	// Number of bytes received out of order. This is a subset of the
	// 'inBytes' value.
	// units = B
	// base = 1024
	InUnorderedBytes *int `json:"inUnorderedBytes,omitempty"`
	// Data bytes transmitted.
	// units = B
	// base = 1024
	OutBytes *int `json:"outBytes,omitempty"`
	// The size of the local receive window.
	// units = B
	// base = 1024
	ReceiveWindowSize *int `json:"receiveWindowSize,omitempty"`
	// Bytes retransmitted.
	// units = B
	// base = 1024
	RetransmittedBytes *int `json:"retransmittedBytes,omitempty"`
	// The smoothed average round trip time for this connection (us).
	// units = usec
	RoundTripTime *int `json:"roundTripTime,omitempty"`
	// The size of the peer's receive window.
	// base = 1024
	// units = B
	SendWindowSize *int `json:"sendWindowSize,omitempty"`
	// The time this datapoint was collected.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Number of bytes sent but unacknowledged.
	// units = B
	// base = 1024
	UnacknowledgedBytes *int `json:"unacknowledgedBytes,omitempty"`
	// Number of bytes in the transmit queue that have not been sent.
	// units = B
	// base = 1024
	UnsentBytes *int `json:"unsentBytes,omitempty"`
}

TCPStatsDatapointStruct - An analytics datapoint generated by the TCP_STATS statistic type. extends Datapoint

func TCPStatsDatapointFactory 

func TCPStatsDatapointFactory(
	CongestionWindowSize *int,
	InBytes *int,
	InUnorderedBytes *int,
	OutBytes *int,
	ReceiveWindowSize *int,
	RetransmittedBytes *int,
	RoundTripTime *int,
	SendWindowSize *int,
	Timestamp string,
	UnacknowledgedBytes *int,
	UnsentBytes *int,
) TCPStatsDatapointStruct

TCPStatsDatapointFactory is just a simple function to instantiate the TCPStatsDatapointStruct

type TargetFilterStruct 

type TargetFilterStruct struct {
	// List of object references. Only alerts related to one of the
	// targets or its children are included.
	// minItems = 1
	// create = optional
	// update = optional
	Targets []string `json:"targets,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TargetFilterStruct - An alert filter that specifies which targets to match against. extends AlertFilter

func TargetFilterFactory 

func TargetFilterFactory(
	Targets []string,
) TargetFilterStruct

TargetFilterFactory is just a simple function to instantiate the TargetFilterStruct

type TargetOwnerFilterStruct 

type TargetOwnerFilterStruct struct {
	// Target owners to match against.
	// create = required
	// update = optional
	// minItems = 1
	Owners []string `json:"owners,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TargetOwnerFilterStruct - An alert filter which matches when an alert's target is owned by one of the specified users. extends AlertFilter

func TargetOwnerFilterFactory 

func TargetOwnerFilterFactory(
	Owners []string,
) TargetOwnerFilterStruct

TargetOwnerFilterFactory is just a simple function to instantiate the TargetOwnerFilterStruct

type TimeConfigStruct 

type TimeConfigStruct struct {
	// Current system time. This value can only be set if NTP is
	// disabled. The management service is automatically restarted if the
	// time is changed.
	// format = date
	// update = optional
	CurrentTime string `json:"currentTime,omitempty"`
	// NTP configuration.
	// update = optional
	NtpConfig *NTPConfigStruct `json:"ntpConfig,omitempty"`
	// Default time zone for system wide policies and schedules. The
	// management service is automatically restarted if the timezone is
	// changed.
	// update = optional
	// default = Etc/UTC
	SystemTimeZone string `json:"systemTimeZone,omitempty"`
	// The difference, in minutes, between UTC and local time. For
	// example, if your time zone is UTC -5:00 (Eastern Standard Time),
	// 300 will be returned. Daylight saving time prevents this value
	// from being a constant even for a given locale.
	SystemTimeZoneOffset *int `json:"systemTimeZoneOffset,omitempty"`
	// System time zone offset as a String. For instance 'UTC -5:00'.
	SystemTimeZoneOffsetString string `json:"systemTimeZoneOffsetString,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeConfigStruct - Get and set the current time configuration. extends TypedObject cliVisibility = [SYSTEM DOMAIN]

func TimeConfigFactory 

func TimeConfigFactory(
	CurrentTime string,
	NtpConfig *NTPConfigStruct,
	SystemTimeZone string,
	SystemTimeZoneOffset *int,
	SystemTimeZoneOffsetString string,
) TimeConfigStruct

TimeConfigFactory is just a simple function to instantiate the TimeConfigStruct

type TimeRangeParametersStruct 

type TimeRangeParametersStruct struct {
	// The date at the end of the period.
	// format = date
	// create = required
	EndTime string `json:"endTime,omitempty"`
	// The date at the beginning of the period.
	// format = date
	// create = required
	StartTime string `json:"startTime,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeRangeParametersStruct - The parameters to use as input for methods requiring a time range. extends TypedObject

func TimeRangeParametersFactory 

func TimeRangeParametersFactory(
	EndTime string,
	StartTime string,
) TimeRangeParametersStruct

TimeRangeParametersFactory is just a simple function to instantiate the TimeRangeParametersStruct

type TimeZoneStruct 

type TimeZoneStruct struct {
	// The ID of this time zone.
	// required = true
	// enum = [ACT AET AGT ART AST Africa/Abidjan Africa/Accra Africa/Addis_Ababa Africa/Algiers Africa/Asmara Africa/Asmera Africa/Bamako Africa/Bangui Africa/Banjul Africa/Bissau Africa/Blantyre Africa/Brazzaville Africa/Bujumbura Africa/Cairo Africa/Casablanca Africa/Ceuta Africa/Conakry Africa/Dakar Africa/Dar_es_Salaam Africa/Djibouti Africa/Douala Africa/El_Aaiun Africa/Freetown Africa/Gaborone Africa/Harare Africa/Johannesburg Africa/Juba Africa/Kampala Africa/Khartoum Africa/Kigali Africa/Kinshasa Africa/Lagos Africa/Libreville Africa/Lome Africa/Luanda Africa/Lubumbashi Africa/Lusaka Africa/Malabo Africa/Maputo Africa/Maseru Africa/Mbabane Africa/Mogadishu Africa/Monrovia Africa/Nairobi Africa/Ndjamena Africa/Niamey Africa/Nouakchott Africa/Ouagadougou Africa/Porto-Novo Africa/Sao_Tome Africa/Timbuktu Africa/Tripoli Africa/Tunis Africa/Windhoek America/Adak America/Anchorage America/Anguilla America/Antigua America/Araguaina America/Argentina/Buenos_Aires America/Argentina/Catamarca America/Argentina/ComodRivadavia America/Argentina/Cordoba America/Argentina/Jujuy America/Argentina/La_Rioja America/Argentina/Mendoza America/Argentina/Rio_Gallegos America/Argentina/Salta America/Argentina/San_Juan America/Argentina/San_Luis America/Argentina/Tucuman America/Argentina/Ushuaia America/Aruba America/Asuncion America/Atikokan America/Atka America/Bahia America/Bahia_Banderas America/Barbados America/Belem America/Belize America/Blanc-Sablon America/Boa_Vista America/Bogota America/Boise America/Buenos_Aires America/Cambridge_Bay America/Campo_Grande America/Cancun America/Caracas America/Catamarca America/Cayenne America/Cayman America/Chicago America/Chihuahua America/Coral_Harbour America/Cordoba America/Costa_Rica America/Creston America/Cuiaba America/Curacao America/Danmarkshavn America/Dawson America/Dawson_Creek America/Denver America/Detroit America/Dominica America/Edmonton America/Eirunepe America/El_Salvador America/Ensenada America/Fort_Nelson America/Fort_Wayne America/Fortaleza America/Glace_Bay America/Godthab America/Goose_Bay America/Grand_Turk America/Grenada America/Guadeloupe America/Guatemala America/Guayaquil America/Guyana America/Halifax America/Havana America/Hermosillo America/Indiana/Indianapolis America/Indiana/Knox America/Indiana/Marengo America/Indiana/Petersburg America/Indiana/Tell_City America/Indiana/Vevay America/Indiana/Vincennes America/Indiana/Winamac America/Indianapolis America/Inuvik America/Iqaluit America/Jamaica America/Jujuy America/Juneau America/Kentucky/Louisville America/Kentucky/Monticello America/Knox_IN America/Kralendijk America/La_Paz America/Lima America/Los_Angeles America/Louisville America/Lower_Princes America/Maceio America/Managua America/Manaus America/Marigot America/Martinique America/Matamoros America/Mazatlan America/Mendoza America/Menominee America/Merida America/Metlakatla America/Mexico_City America/Miquelon America/Moncton America/Monterrey America/Montevideo America/Montreal America/Montserrat America/Nassau America/New_York America/Nipigon America/Nome America/Noronha America/North_Dakota/Beulah America/North_Dakota/Center America/North_Dakota/New_Salem America/Ojinaga America/Panama America/Pangnirtung America/Paramaribo America/Phoenix America/Port-au-Prince America/Port_of_Spain America/Porto_Acre America/Porto_Velho America/Puerto_Rico America/Punta_Arenas America/Rainy_River America/Rankin_Inlet America/Recife America/Regina America/Resolute America/Rio_Branco America/Rosario America/Santa_Isabel America/Santarem America/Santiago America/Santo_Domingo America/Sao_Paulo America/Scoresbysund America/Shiprock America/Sitka America/St_Barthelemy America/St_Johns America/St_Kitts America/St_Lucia America/St_Thomas America/St_Vincent America/Swift_Current America/Tegucigalpa America/Thule America/Thunder_Bay America/Tijuana America/Toronto America/Tortola America/Vancouver America/Virgin America/Whitehorse America/Winnipeg America/Yakutat America/Yellowknife Antarctica/Casey Antarctica/Davis Antarctica/DumontDUrville Antarctica/Macquarie Antarctica/Mawson Antarctica/McMurdo Antarctica/Palmer Antarctica/Rothera Antarctica/South_Pole Antarctica/Syowa Antarctica/Troll Antarctica/Vostok Arctic/Longyearbyen Asia/Aden Asia/Almaty Asia/Amman Asia/Anadyr Asia/Aqtau Asia/Aqtobe Asia/Ashgabat Asia/Ashkhabad Asia/Atyrau Asia/Baghdad Asia/Bahrain Asia/Baku Asia/Bangkok Asia/Barnaul Asia/Beirut Asia/Bishkek Asia/Brunei Asia/Calcutta Asia/Chita Asia/Choibalsan Asia/Chongqing Asia/Chungking Asia/Colombo Asia/Dacca Asia/Damascus Asia/Dhaka Asia/Dili Asia/Dubai Asia/Dushanbe Asia/Famagusta Asia/Gaza Asia/Harbin Asia/Hebron Asia/Ho_Chi_Minh Asia/Hong_Kong Asia/Hovd Asia/Irkutsk Asia/Istanbul Asia/Jakarta Asia/Jayapura Asia/Jerusalem Asia/Kabul Asia/Kamchatka Asia/Karachi Asia/Kashgar Asia/Kathmandu Asia/Katmandu Asia/Khandyga Asia/Kolkata Asia/Krasnoyarsk Asia/Kuala_Lumpur Asia/Kuching Asia/Kuwait Asia/Macao Asia/Macau Asia/Magadan Asia/Makassar Asia/Manila Asia/Muscat Asia/Nicosia Asia/Novokuznetsk Asia/Novosibirsk Asia/Omsk Asia/Oral Asia/Phnom_Penh Asia/Pontianak Asia/Pyongyang Asia/Qatar Asia/Qyzylorda Asia/Rangoon Asia/Riyadh Asia/Saigon Asia/Sakhalin Asia/Samarkand Asia/Seoul Asia/Shanghai Asia/Singapore Asia/Srednekolymsk Asia/Taipei Asia/Tashkent Asia/Tbilisi Asia/Tehran Asia/Tel_Aviv Asia/Thimbu Asia/Thimphu Asia/Tomsk Asia/Tokyo Asia/Ujung_Pandang Asia/Ulaanbaatar Asia/Ulan_Bator Asia/Urumqi Asia/Ust-Nera Asia/Vientiane Asia/Vladivostok Asia/Yakutsk Asia/Yangon Asia/Yekaterinburg Asia/Yerevan Atlantic/Azores Atlantic/Bermuda Atlantic/Canary Atlantic/Cape_Verde Atlantic/Faeroe Atlantic/Faroe Atlantic/Jan_Mayen Atlantic/Madeira Atlantic/Reykjavik Atlantic/South_Georgia Atlantic/St_Helena Atlantic/Stanley Australia/ACT Australia/Adelaide Australia/Brisbane Australia/Broken_Hill Australia/Canberra Australia/Currie Australia/Darwin Australia/Eucla Australia/Hobart Australia/LHI Australia/Lindeman Australia/Lord_Howe Australia/Melbourne Australia/NSW Australia/North Australia/Perth Australia/Queensland Australia/South Australia/Sydney Australia/Tasmania Australia/Victoria Australia/West Australia/Yancowinna BET BST Brazil/Acre Brazil/DeNoronha Brazil/East Brazil/West CAT CET CNT CST CST6CDT CTT Canada/Atlantic Canada/Central Canada/Eastern Canada/Mountain Canada/Newfoundland Canada/Pacific Canada/Saskatchewan Canada/Yukon Chile/Continental Chile/EasterIsland Cuba EAT ECT EET EST EST5EDT Egypt Eire Etc/GMT Etc/GMT+0 Etc/GMT+1 Etc/GMT+10 Etc/GMT+11 Etc/GMT+12 Etc/GMT+2 Etc/GMT+3 Etc/GMT+4 Etc/GMT+5 Etc/GMT+6 Etc/GMT+7 Etc/GMT+8 Etc/GMT+9 Etc/GMT-0 Etc/GMT-1 Etc/GMT-10 Etc/GMT-11 Etc/GMT-12 Etc/GMT-13 Etc/GMT-14 Etc/GMT-2 Etc/GMT-3 Etc/GMT-4 Etc/GMT-5 Etc/GMT-6 Etc/GMT-7 Etc/GMT-8 Etc/GMT-9 Etc/GMT0 Etc/Greenwich Etc/UCT Etc/UTC Etc/Universal Etc/Zulu Europe/Amsterdam Europe/Andorra Europe/Astrakhan Europe/Athens Europe/Belfast Europe/Belgrade Europe/Berlin Europe/Bratislava Europe/Brussels Europe/Bucharest Europe/Budapest Europe/Busingen Europe/Chisinau Europe/Copenhagen Europe/Dublin Europe/Gibraltar Europe/Guernsey Europe/Helsinki Europe/Isle_of_Man Europe/Istanbul Europe/Jersey Europe/Kaliningrad Europe/Kiev Europe/Kirov Europe/Lisbon Europe/Ljubljana Europe/London Europe/Luxembourg Europe/Madrid Europe/Malta Europe/Mariehamn Europe/Minsk Europe/Monaco Europe/Moscow Europe/Nicosia Europe/Oslo Europe/Paris Europe/Podgorica Europe/Prague Europe/Riga Europe/Rome Europe/Samara Europe/San_Marino Europe/Sarajevo Europe/Saratov Europe/Simferopol Europe/Skopje Europe/Sofia Europe/Stockholm Europe/Tallinn Europe/Tirane Europe/Tiraspol Europe/Ulyanovsk Europe/Uzhgorod Europe/Vaduz Europe/Vatican Europe/Vienna Europe/Vilnius Europe/Volgograd Europe/Warsaw Europe/Zagreb Europe/Zaporozhye Europe/Zurich GB GB-Eire GMT GMT0 Greenwich HST Hongkong IET IST Iceland Indian/Antananarivo Indian/Chagos Indian/Christmas Indian/Cocos Indian/Comoro Indian/Kerguelen Indian/Mahe Indian/Maldives Indian/Mauritius Indian/Mayotte Indian/Reunion Iran Israel JST Jamaica Japan Kwajalein Libya MET MIT MST MST7MDT Mexico/BajaNorte Mexico/BajaSur Mexico/General NET NST NZ NZ-CHAT Navajo PLT PNT PRC PRT PST PST8PDT Pacific/Apia Pacific/Auckland Pacific/Bougainville Pacific/Chatham Pacific/Chuuk Pacific/Easter Pacific/Efate Pacific/Enderbury Pacific/Fakaofo Pacific/Fiji Pacific/Funafuti Pacific/Galapagos Pacific/Gambier Pacific/Guadalcanal Pacific/Guam Pacific/Honolulu Pacific/Johnston Pacific/Kiritimati Pacific/Kosrae Pacific/Kwajalein Pacific/Majuro Pacific/Marquesas Pacific/Midway Pacific/Nauru Pacific/Niue Pacific/Norfolk Pacific/Noumea Pacific/Pago_Pago Pacific/Palau Pacific/Pitcairn Pacific/Pohnpei Pacific/Ponape Pacific/Port_Moresby Pacific/Rarotonga Pacific/Saipan Pacific/Samoa Pacific/Tahiti Pacific/Tarawa Pacific/Tongatapu Pacific/Truk Pacific/Wake Pacific/Wallis Pacific/Yap Poland Portugal ROK SST Singapore SystemV/AST4 SystemV/AST4ADT SystemV/CST6 SystemV/CST6CDT SystemV/EST5 SystemV/EST5EDT SystemV/HST10 SystemV/MST7 SystemV/MST7MDT SystemV/PST8 SystemV/PST8PDT SystemV/YST9 SystemV/YST9YDT Turkey UCT US/Alaska US/Aleutian US/Arizona US/Central US/East-Indiana US/Eastern US/Hawaii US/Indiana-Starke US/Michigan US/Mountain US/Pacific US/Pacific-New US/Samoa UTC Universal VST W-SU WET Zulu]
	Id string `json:"id,omitempty"`
	// The difference, in minutes, between UTC and local time. For
	// example, if your time zone is UTC -5:00 (Eastern Standard Time),
	// 300 will be returned. Daylight saving time prevents this value
	// from being a constant even for a given locale.
	Offset *int `json:"offset,omitempty"`
	// The Offset as a String. For instance 'UTC -5:00'.
	OffsetString string `json:"offsetString,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeZoneStruct - This represents a time zone offset. extends TypedObject

func TimeZoneFactory 

func TimeZoneFactory(
	Id string,
	Offset *int,
	OffsetString string,
) TimeZoneStruct

TimeZoneFactory is just a simple function to instantiate the TimeZoneStruct

type Timeflow 

type Timeflow interface{}

Timeflow is an empty interface designed to function as the Timeflow API namespace

type TimeflowBookmarkCreateParametersStruct 

type TimeflowBookmarkCreateParametersStruct struct {
	// The bookmark name.
	// required = true
	Name string `json:"name,omitempty"`
	// Indicates whether retention should be allowed to clean up the
	// TimeFlow bookmark and associated data.
	// create = optional
	RetentionProof *bool `json:"retentionProof,omitempty"`
	// A tag for the bookmark that can be used to group bookmarks
	// together or qualify the type of the bookmark.
	// create = optional
	// maxLength = 64
	Tag string `json:"tag,omitempty"`
	// The TimeFlow point which is referenced by this bookmark.
	// required = true
	TimeflowPoint TimeflowPoint `json:"timeflowPoint,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowBookmarkCreateParametersStruct - The parameters to use as input to create TimeFlow bookmarks. extends TypedObject

func TimeflowBookmarkCreateParametersFactory 

func TimeflowBookmarkCreateParametersFactory(
	Name string,
	RetentionProof *bool,
	Tag string,
	TimeflowPoint TimeflowPoint,
) TimeflowBookmarkCreateParametersStruct

TimeflowBookmarkCreateParametersFactory is just a simple function to instantiate the TimeflowBookmarkCreateParametersStruct

type TimeflowBookmarkStruct 

type TimeflowBookmarkStruct struct {
	// The TimeFlow location.
	Location string `json:"location,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Indicates whether retention should be allowed to clean up the
	// TimeFlow bookmark and associated data.
	// update = optional
	RetentionProof *bool `json:"retentionProof,omitempty"`
	// A tag for the bookmark that can be used to group TimeFlow
	// bookmarks together or qualify the type of the bookmark.
	// maxLength = 64
	Tag string `json:"tag,omitempty"`
	// Reference to the TimeFlow for this bookmark.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// The logical time corresponding to the TimeFlow location.
	// format = date
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowBookmarkStruct - A TimeFlow bookmark is a user defined name for a TimeFlow point (location or timestamp within a TimeFlow). extends NamedUserObject

func TimeflowBookmarkFactory 

func TimeflowBookmarkFactory(
	Location string,
	Name string,
	Namespace string,
	Reference string,
	RetentionProof *bool,
	Tag string,
	Timeflow string,
	Timestamp string,
) TimeflowBookmarkStruct

TimeflowBookmarkFactory is just a simple function to instantiate the TimeflowBookmarkStruct

type TimeflowFilesystemLayoutStruct 

type TimeflowFilesystemLayoutStruct struct {
	// The directory for archive files.
	// create = optional
	ArchiveDirectory string `json:"archiveDirectory,omitempty"`
	// The directory for data files.
	// create = optional
	DataDirectory string `json:"dataDirectory,omitempty"`
	// The directory for external files.
	// create = optional
	ExternalDirectory string `json:"externalDirectory,omitempty"`
	// The directory for script files.
	// create = optional
	ScriptDirectory string `json:"scriptDirectory,omitempty"`
	// The base directory to use for the exported database.
	// create = optional
	TargetDirectory string `json:"targetDirectory,omitempty"`
	// The directory for temporary files.
	// create = optional
	TempDirectory string `json:"tempDirectory,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowFilesystemLayoutStruct - A filesystem layout that matches the filesystem of a Delphix TimeFlow. extends FilesystemLayout

func TimeflowFilesystemLayoutFactory 

func TimeflowFilesystemLayoutFactory(
	ArchiveDirectory string,
	DataDirectory string,
	ExternalDirectory string,
	ScriptDirectory string,
	TargetDirectory string,
	TempDirectory string,
) TimeflowFilesystemLayoutStruct

TimeflowFilesystemLayoutFactory is just a simple function to instantiate the TimeflowFilesystemLayoutStruct

type TimeflowLogFetchParametersStruct 

type TimeflowLogFetchParametersStruct struct {
	// User credentials. If not provided will use environment credentials
	// for 'username' on 'host'.
	Credentials Credential `json:"credentials,omitempty"`
	// Directory on the remote server where the missing log files reside.
	// required = true
	Directory string `json:"directory,omitempty"`
	// The ending SCN of the range of log files to fetch.
	// required = true
	EndLocation string `json:"endLocation,omitempty"`
	// Remote host to connect to.
	// required = true
	Host string `json:"host,omitempty"`
	// SSH port to connect to.
	// default = 22
	Port *int `json:"port,omitempty"`
	// Mechanism to use for ssh host verification.
	// required = false
	SshVerificationStrategy SshVerificationStrategy `json:"sshVerificationStrategy,omitempty"`
	// The starting SCN of the range of log files to fetch.
	// required = true
	StartLocation string `json:"startLocation,omitempty"`
	// Reference to the TimeFlow for which to fetch logs.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-oracle-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// User name to authenticate as.
	// required = true
	Username string `json:"username,omitempty"`
}

TimeflowLogFetchParametersStruct - Parameters to fetch log files within a TimeFlow. extends LogFetchSSH

func TimeflowLogFetchParametersFactory 

func TimeflowLogFetchParametersFactory(
	Credentials Credential,
	Directory string,
	EndLocation string,
	Host string,
	Port *int,
	SshVerificationStrategy SshVerificationStrategy,
	StartLocation string,
	Timeflow string,
	Username string,
) TimeflowLogFetchParametersStruct

TimeflowLogFetchParametersFactory is just a simple function to instantiate the TimeflowLogFetchParametersStruct

type TimeflowPoint 

type TimeflowPoint interface{}

TimeflowPoint is an empty interface designed to function as the TimeflowPoint API namespace

type TimeflowPointBookmarkStruct 

type TimeflowPointBookmarkStruct struct {
	// Reference to the bookmark.
	// format = objectReference
	// referenceTo = /delphix-timeflow-bookmark.json
	// required = true
	Bookmark string `json:"bookmark,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowPointBookmarkStruct - TimeFlow point based on a TimeFlow bookmark. extends TimeflowPointParameters

func TimeflowPointBookmarkFactory 

func TimeflowPointBookmarkFactory(
	Bookmark string,
) TimeflowPointBookmarkStruct

TimeflowPointBookmarkFactory is just a simple function to instantiate the TimeflowPointBookmarkStruct

type TimeflowPointBookmarkTagStruct 

type TimeflowPointBookmarkTagStruct struct {
	// Reference to the container.
	// format = objectReference
	// referenceTo = /delphix-container.json
	// required = true
	Container string `json:"container,omitempty"`
	// The name of the tag.
	// required = true
	Tag string `json:"tag,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowPointBookmarkTagStruct - TimeFlow point based on a TimeFlow bookmark tag. extends TimeflowPointParameters

func TimeflowPointBookmarkTagFactory 

func TimeflowPointBookmarkTagFactory(
	Container string,
	Tag string,
) TimeflowPointBookmarkTagStruct

TimeflowPointBookmarkTagFactory is just a simple function to instantiate the TimeflowPointBookmarkTagStruct

type TimeflowPointLocationStruct 

type TimeflowPointLocationStruct struct {
	// The TimeFlow location.
	// required = true
	// pattern = ^[\S]+$
	Location string `json:"location,omitempty"`
	// Reference to TimeFlow containing this location.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-timeflow.json
	Timeflow string `json:"timeflow,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowPointLocationStruct - TimeFlow point based on a database-specific identifier (SCN, LSN, etc). extends TimeflowPointParameters

func TimeflowPointLocationFactory 

func TimeflowPointLocationFactory(
	Location string,
	Timeflow string,
) TimeflowPointLocationStruct

TimeflowPointLocationFactory is just a simple function to instantiate the TimeflowPointLocationStruct

type TimeflowPointParameters 

type TimeflowPointParameters interface{}

TimeflowPointParameters is an empty interface designed to function as the TimeflowPointParameters API namespace

type TimeflowPointSemanticStruct 

type TimeflowPointSemanticStruct struct {
	// Reference to the container.
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-container.json
	// create = optional
	Container string `json:"container,omitempty"`
	// A semantic description of a TimeFlow location.
	// create = optional
	// update = optional
	// enum = [LATEST_POINT LATEST_SNAPSHOT]
	// default = LATEST_POINT
	Location string `json:"location,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowPointSemanticStruct - TimeFlow point based on a semantic reference. extends TimeflowPointParameters

func TimeflowPointSemanticFactory 

func TimeflowPointSemanticFactory(
	Container string,
	Location string,
) TimeflowPointSemanticStruct

TimeflowPointSemanticFactory is just a simple function to instantiate the TimeflowPointSemanticStruct

type TimeflowPointSnapshotStruct 

type TimeflowPointSnapshotStruct struct {
	// Reference to the snapshot.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-timeflow-snapshot.json
	Snapshot string `json:"snapshot,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowPointSnapshotStruct - TimeFlow point based on a snapshot reference. extends TimeflowPointParameters

func TimeflowPointSnapshotFactory 

func TimeflowPointSnapshotFactory(
	Snapshot string,
) TimeflowPointSnapshotStruct

TimeflowPointSnapshotFactory is just a simple function to instantiate the TimeflowPointSnapshotStruct

type TimeflowPointTimestampStruct 

type TimeflowPointTimestampStruct struct {
	// Reference to TimeFlow containing this point.
	// referenceTo = /delphix-timeflow.json
	// required = true
	// format = objectReference
	Timeflow string `json:"timeflow,omitempty"`
	// The logical time corresponding to the TimeFlow location.
	// format = date
	// required = true
	Timestamp string `json:"timestamp,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowPointTimestampStruct - TimeFlow point based on a timestamp. extends TimeflowPointParameters

func TimeflowPointTimestampFactory 

func TimeflowPointTimestampFactory(
	Timeflow string,
	Timestamp string,
) TimeflowPointTimestampStruct

TimeflowPointTimestampFactory is just a simple function to instantiate the TimeflowPointTimestampStruct

type TimeflowRangeParametersStruct 

type TimeflowRangeParametersStruct struct {
	// The ending TimeFlow point of the time period to search for
	// TimeFlow ranges.
	EndPoint TimeflowPoint `json:"endPoint,omitempty"`
	// The starting TimeFlow point of the time period to search for
	// TimeFlow ranges.
	StartPoint TimeflowPoint `json:"startPoint,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowRangeParametersStruct - The parameters to use as input to fetch TimeFlow ranges. extends TypedObject

func TimeflowRangeParametersFactory 

func TimeflowRangeParametersFactory(
	EndPoint TimeflowPoint,
	StartPoint TimeflowPoint,
) TimeflowRangeParametersStruct

TimeflowRangeParametersFactory is just a simple function to instantiate the TimeflowRangeParametersStruct

type TimeflowRangeStruct 

type TimeflowRangeStruct struct {
	// The ending TimeFlow point of this range.
	EndPoint TimeflowPoint `json:"endPoint,omitempty"`
	// Whether or not this TimeFlow range is provisionable.
	Provisionable *bool `json:"provisionable,omitempty"`
	// The starting TimeFlow point of this range.
	StartPoint TimeflowPoint `json:"startPoint,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowRangeStruct - Time range within a TimeFlow. extends TypedObject

func TimeflowRangeFactory 

func TimeflowRangeFactory(
	EndPoint TimeflowPoint,
	Provisionable *bool,
	StartPoint TimeflowPoint,
) TimeflowRangeStruct

TimeflowRangeFactory is just a simple function to instantiate the TimeflowRangeStruct

type TimeflowRepairParameters 

type TimeflowRepairParameters interface{}

TimeflowRepairParameters is an empty interface designed to function as the TimeflowRepairParameters API namespace

type TimeflowRepairSSHStruct 

type TimeflowRepairSSHStruct struct {
	// User credentials. If not provided will use environment credentials
	// for 'username' on 'host'.
	Credentials Credential `json:"credentials,omitempty"`
	// Directory on the remote server where the missing log files reside.
	// required = true
	Directory string `json:"directory,omitempty"`
	// The ending point of the range of log files to fetch.
	// required = true
	EndLocation string `json:"endLocation,omitempty"`
	// Remote host to connect to.
	// required = true
	Host string `json:"host,omitempty"`
	// SSH port to connect to.
	// default = 22
	Port *int `json:"port,omitempty"`
	// Mechanism to use for ssh host verification.
	// required = false
	SshVerificationStrategy SshVerificationStrategy `json:"sshVerificationStrategy,omitempty"`
	// The starting point of the range of log files to fetch.
	// required = true
	StartLocation string `json:"startLocation,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
	// User name to authenticate as.
	// required = true
	Username string `json:"username,omitempty"`
}

TimeflowRepairSSHStruct - Parameters to repair log files within a TimeFlow. extends TimeflowRepairParameters

func TimeflowRepairSSHFactory 

func TimeflowRepairSSHFactory(
	Credentials Credential,
	Directory string,
	EndLocation string,
	Host string,
	Port *int,
	SshVerificationStrategy SshVerificationStrategy,
	StartLocation string,
	Username string,
) TimeflowRepairSSHStruct

TimeflowRepairSSHFactory is just a simple function to instantiate the TimeflowRepairSSHStruct

type TimeflowSnapshot 

type TimeflowSnapshot interface{}

TimeflowSnapshot is an empty interface designed to function as the TimeflowSnapshot API namespace

type TimeflowSnapshotDayRangeStruct 

type TimeflowSnapshotDayRangeStruct struct {
	// Number of TimeFlow snapshots on that day.
	Count float64 `json:"count,omitempty"`
	// Date for which TimeFlow snapshots have been aggregated.
	Date string `json:"date,omitempty"`
	// End of day of this range in the time zone used for computation.
	// format = date
	EndOfDay string `json:"endOfDay,omitempty"`
	// Start of day of this range in the time zone used for computation.
	// format = date
	StartOfDay string `json:"startOfDay,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TimeflowSnapshotDayRangeStruct - Count of TimeFlow snapshots aggregated by day. extends TypedObject

func TimeflowSnapshotDayRangeFactory 

func TimeflowSnapshotDayRangeFactory(
	Count float64,
	Date string,
	EndOfDay string,
	StartOfDay string,
) TimeflowSnapshotDayRangeStruct

TimeflowSnapshotDayRangeFactory is just a simple function to instantiate the TimeflowSnapshotDayRangeStruct

type ToolkitDiscoveryDefinitionStruct 

type ToolkitDiscoveryDefinitionStruct struct {
	// True if this toolkit supports manual discovery of source configs.
	// required = false
	ManualSourceConfigDiscovery *bool `json:"manualSourceConfigDiscovery,omitempty"`
	// A workflow script that discovers repositories on a target
	// environment. The script must return a list of repositories
	// matching the repositorySchema.
	// required = true
	RepositoryDiscovery string `json:"repositoryDiscovery,omitempty"`
	// A list of fields in the repositorySchema that collectively
	// identify each discovered repository.
	// required = true
	RepositoryIdentityFields []string `json:"repositoryIdentityFields,omitempty"`
	// The field of the repositorySchema to display to the end user for
	// naming this repository.
	// required = true
	RepositoryNameField string `json:"repositoryNameField,omitempty"`
	// A user defined schema to represent the repository.
	// required = true
	RepositorySchema *SchemaDraftV4Struct `json:"repositorySchema,omitempty"`
	// A workflow script that discovers source configs on a target
	// environment. The script must return a list of source configs
	// matching the sourceConfigSchema.
	// required = true
	SourceConfigDiscovery string `json:"sourceConfigDiscovery,omitempty"`
	// A list of fields in the sourceConfigSchema that collectively
	// identify each discovered source config.
	// required = true
	SourceConfigIdentityFields []string `json:"sourceConfigIdentityFields,omitempty"`
	// The field of the sourceConfigSchema to display to the end user for
	// naming this source config.
	// required = true
	SourceConfigNameField string `json:"sourceConfigNameField,omitempty"`
	// A user defined schema to represent the source config.
	// required = true
	SourceConfigSchema *SchemaDraftV4Struct `json:"sourceConfigSchema,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ToolkitDiscoveryDefinitionStruct - Defines the discovery schemas and workflow scripts for a toolkit. extends TypedObject

func ToolkitDiscoveryDefinitionFactory 

func ToolkitDiscoveryDefinitionFactory(
	ManualSourceConfigDiscovery *bool,
	RepositoryDiscovery string,
	RepositoryIdentityFields []string,
	RepositoryNameField string,
	RepositorySchema *SchemaDraftV4Struct,
	SourceConfigDiscovery string,
	SourceConfigIdentityFields []string,
	SourceConfigNameField string,
	SourceConfigSchema *SchemaDraftV4Struct,
) ToolkitDiscoveryDefinitionStruct

ToolkitDiscoveryDefinitionFactory is just a simple function to instantiate the ToolkitDiscoveryDefinitionStruct

type ToolkitLinkedDirectSourceStruct 

type ToolkitLinkedDirectSourceStruct struct {
	// A user defined schema for the linking parameters.
	// required = true
	Parameters *SchemaDraftV4Struct `json:"parameters,omitempty"`
	// A workflow script to run immediately after snapshotting the staged
	// source.
	// required = true
	PostSnapshot string `json:"postSnapshot,omitempty"`
	// A workflow script to run just prior to snapshotting the staged
	// source.
	// required = true
	PreSnapshot string `json:"preSnapshot,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// True if this toolkit requires old-style AppData-defined
	// properties.
	// create = optional
	UsesGrandfatheredAppDataProperties *bool `json:"usesGrandfatheredAppDataProperties,omitempty"`
}

ToolkitLinkedDirectSourceStruct - A linked source definition for toolkits that perform linking using direct file sync. extends ToolkitLinkedSource

func ToolkitLinkedDirectSourceFactory 

func ToolkitLinkedDirectSourceFactory(
	Parameters *SchemaDraftV4Struct,
	PostSnapshot string,
	PreSnapshot string,
	UsesGrandfatheredAppDataProperties *bool,
) ToolkitLinkedDirectSourceStruct

ToolkitLinkedDirectSourceFactory is just a simple function to instantiate the ToolkitLinkedDirectSourceStruct

type ToolkitLinkedSource 

type ToolkitLinkedSource interface{}

ToolkitLinkedSource is an empty interface designed to function as the ToolkitLinkedSource API namespace

type ToolkitLinkedStagedSourceStruct 

type ToolkitLinkedStagedSourceStruct struct {
	// A workflow script that specifies where the storage for the copy of
	// the application should be mounted.
	// required = false
	MountSpec string `json:"mountSpec,omitempty"`
	// A workflow script that specifies which user/group should own the
	// mount where the application will be copied.
	// required = false
	OwnershipSpec string `json:"ownershipSpec,omitempty"`
	// A user defined schema for the linking parameters.
	// required = true
	Parameters *SchemaDraftV4Struct `json:"parameters,omitempty"`
	// A workflow script to run immediately after snapshotting the staged
	// source.
	// required = true
	PostSnapshot string `json:"postSnapshot,omitempty"`
	// A workflow script to run just prior to snapshotting the staged
	// source.
	// required = true
	PreSnapshot string `json:"preSnapshot,omitempty"`
	// A workflow script that builds the staging instance from
	// production.
	// required = true
	Resync string `json:"resync,omitempty"`
	// A workflow script that start the staged source. The staged files
	// will be mounted and available.
	// required = true
	StartStaging string `json:"startStaging,omitempty"`
	// A workflow script that returns whether or not the data source is
	// active/inactive. The script should exit with an exit status of
	// ACTIVE if the data source is available. The script should exit
	// with an exit status of INACTIVE if the data source is unavailable.
	// An exit status of UNKNOWN implies the script encountered an
	// unexpected state or error. If no status script is supplied, the
	// dSource will always be in an active state while enabled.
	// required = false
	Status string `json:"status,omitempty"`
	// A workflow script that stop the staged source. The staged files
	// will be mounted and available. Upon completion of this workflow,
	// the staged files will be unmounted.
	// required = true
	StopStaging string `json:"stopStaging,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// A workflow script run periodically to monitor the health of the
	// data source and staging environment. This script will be run every
	// 10 seconds.
	// required = false
	Worker string `json:"worker,omitempty"`
}

ToolkitLinkedStagedSourceStruct - A linked staged source definition for toolkits. extends ToolkitLinkedSource

func ToolkitLinkedStagedSourceFactory 

func ToolkitLinkedStagedSourceFactory(
	MountSpec string,
	OwnershipSpec string,
	Parameters *SchemaDraftV4Struct,
	PostSnapshot string,
	PreSnapshot string,
	Resync string,
	StartStaging string,
	Status string,
	StopStaging string,
	Worker string,
) ToolkitLinkedStagedSourceStruct

ToolkitLinkedStagedSourceFactory is just a simple function to instantiate the ToolkitLinkedStagedSourceStruct

type ToolkitLocaleStruct 

type ToolkitLocaleStruct struct {
	// The name of this locale.
	// format = locale
	// required = true
	LocaleName string `json:"localeName,omitempty"`
	// A mapping of message IDs to messages for this locale.
	// required = true
	Messages map[string]string `json:"messages,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

ToolkitLocaleStruct - Contains a mapping from message IDs to messages for a locale. extends TypedObject

func ToolkitLocaleFactory 

func ToolkitLocaleFactory(
	LocaleName string,
	Messages map[string]string,
) ToolkitLocaleStruct

ToolkitLocaleFactory is just a simple function to instantiate the ToolkitLocaleStruct

type ToolkitStruct 

type ToolkitStruct struct {
	// The Delphix API version that the toolkit was built against.
	// required = true
	BuildApi *APIVersionStruct `json:"buildApi,omitempty"`
	// The default locale for this toolkit. This locale defines the set
	// of all message IDs for the toolkit and serves as the fallback
	// locale when messages cannot be localized in a particular locale.
	// If no messages are specified for the toolkit, the defaultLocale
	// may be any locale.
	// format = locale
	// required = true
	DefaultLocale string `json:"defaultLocale,omitempty"`
	// Definition of how to discover sources of this type.
	// required = false
	DiscoveryDefinition *ToolkitDiscoveryDefinitionStruct `json:"discoveryDefinition,omitempty"`
	// A list of host types compatible with this toolkit.
	// required = true
	HostTypes []string `json:"hostTypes,omitempty"`
	// Implementation language for workflows in this toolkit.
	// enum = [LUA PYTHON27]
	// required = true
	Language string `json:"language,omitempty"`
	// Definition of how to link sources of this type.
	// required = true
	LinkedSourceDefinition ToolkitLinkedSource `json:"linkedSourceDefinition,omitempty"`
	// The set of localizable messages for this toolkit.
	// required = false
	Messages []*ToolkitLocaleStruct `json:"messages,omitempty"`
	// A unique and descriptive name for the toolkit.
	// pattern = ^[a-z0-9_:-]+$
	// required = true
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// A human readable name for the toolkit.
	// required = true
	// maxLength = 256
	PrettyName string `json:"prettyName,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Resources for use by workflows in this toolkit.
	// required = true
	Resources map[string]string `json:"resources,omitempty"`
	// Schema for metadata collected during snapshotting.
	// required = true
	SnapshotSchema *SchemaDraftV4Struct `json:"snapshotSchema,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Definition of how to upgrade sources of this type.
	// required = false
	UpgradeDefinition *ToolkitUpgradeDefinitionStruct `json:"upgradeDefinition,omitempty"`
	// The version of the toolkit that is of the form:
	// 'major.minor.patch'.
	// format = toolkitVersion
	// required = true
	Version string `json:"version,omitempty"`
	// Definition of how to provision virtual sources of this type.
	// required = true
	VirtualSourceDefinition *ToolkitVirtualSourceStruct `json:"virtualSourceDefinition,omitempty"`
}

ToolkitStruct - An installed toolkit. extends NamedUserObject

func ToolkitFactory 

func ToolkitFactory(
	BuildApi *APIVersionStruct,
	DefaultLocale string,
	DiscoveryDefinition *ToolkitDiscoveryDefinitionStruct,
	HostTypes []string,
	Language string,
	LinkedSourceDefinition ToolkitLinkedSource,
	Messages []*ToolkitLocaleStruct,
	Name string,
	Namespace string,
	PrettyName string,
	Reference string,
	Resources map[string]string,
	SnapshotSchema *SchemaDraftV4Struct,
	UpgradeDefinition *ToolkitUpgradeDefinitionStruct,
	Version string,
	VirtualSourceDefinition *ToolkitVirtualSourceStruct,
) ToolkitStruct

ToolkitFactory is just a simple function to instantiate the ToolkitStruct

type ToolkitUpgradeDefinitionStruct 

type ToolkitUpgradeDefinitionStruct struct {
	// The version of the toolkit that we are upgrading from.
	// format = toolkitVersion
	// required = true
	FromVersion string `json:"fromVersion,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// A workflow script to upgrade the linked source parameters.
	// required = true
	UpgradeLinkedSource string `json:"upgradeLinkedSource,omitempty"`
	// A workflow script to upgrade the manually-discovered source config
	// parameters.
	// required = false
	UpgradeManualSourceConfig string `json:"upgradeManualSourceConfig,omitempty"`
	// A workflow script to upgrade the snapshot metadata.
	// required = true
	UpgradeSnapshot string `json:"upgradeSnapshot,omitempty"`
	// A workflow script to upgrade the virtual source parameters.
	// required = true
	UpgradeVirtualSource string `json:"upgradeVirtualSource,omitempty"`
}

ToolkitUpgradeDefinitionStruct - The toolkit upgrade logic to upgrade metadata from the previous version of the toolkit. extends TypedObject

func ToolkitUpgradeDefinitionFactory 

func ToolkitUpgradeDefinitionFactory(
	FromVersion string,
	UpgradeLinkedSource string,
	UpgradeManualSourceConfig string,
	UpgradeSnapshot string,
	UpgradeVirtualSource string,
) ToolkitUpgradeDefinitionStruct

ToolkitUpgradeDefinitionFactory is just a simple function to instantiate the ToolkitUpgradeDefinitionStruct

type ToolkitVirtualSourceStruct 

type ToolkitVirtualSourceStruct struct {
	// A workflow script run when configuring a virtual copy of the
	// application in a new environment.
	// required = true
	Configure string `json:"configure,omitempty"`
	// A workflow script to run when creating an empty application.
	// required = false
	Initialize string `json:"initialize,omitempty"`
	// A workflow script that specifies where the virtual copy of the
	// application should be mounted.
	// required = false
	MountSpec string `json:"mountSpec,omitempty"`
	// A workflow script that specifies which user/group should own the
	// files inside the virtual copy of the application.
	// required = false
	OwnershipSpec string `json:"ownershipSpec,omitempty"`
	// A user defined schema for the provisioning parameters.
	// required = true
	Parameters *SchemaDraftV4Struct `json:"parameters,omitempty"`
	// A workflow script to run after taking a snapshot of a virtual copy
	// of the application.
	// required = true
	PostSnapshot string `json:"postSnapshot,omitempty"`
	// A workflow script to run before taking a snapshot of a virtual
	// copy of the application.
	// required = true
	PreSnapshot string `json:"preSnapshot,omitempty"`
	// A workflow script run when returning a virtual copy of the
	// appliction to an environment that it was previously removed from.
	// required = true
	Reconfigure string `json:"reconfigure,omitempty"`
	// A workflow script to run when starting a virtual copy of the
	// application.
	// required = true
	Start string `json:"start,omitempty"`
	// The workflow script to run to determine if a virtual copy of the
	// application is running. The script should output 'ACTIVE' if the
	// application is running, 'INACTIVE' if the application is not
	// running, and 'UNKNOWN' if the script encounters an unexpected
	// problem.
	// required = false
	Status string `json:"status,omitempty"`
	// A workflow script to run when stopping a virtual copy of the
	// application.
	// required = true
	Stop string `json:"stop,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// A workflow script run when removing a virtual copy of the
	// application from an environment (e.g. on delete, disable, or
	// refresh).
	// required = true
	Unconfigure string `json:"unconfigure,omitempty"`
}

ToolkitVirtualSourceStruct - A virtual source definition for toolkits. extends TypedObject

func ToolkitVirtualSourceFactory 

func ToolkitVirtualSourceFactory(
	Configure string,
	Initialize string,
	MountSpec string,
	OwnershipSpec string,
	Parameters *SchemaDraftV4Struct,
	PostSnapshot string,
	PreSnapshot string,
	Reconfigure string,
	Start string,
	Status string,
	Stop string,
	Unconfigure string,
) ToolkitVirtualSourceStruct

ToolkitVirtualSourceFactory is just a simple function to instantiate the ToolkitVirtualSourceStruct

type TracerouteInfoStruct 

type TracerouteInfoStruct struct {
	// Latency of network hops from host to Delphix Engine.
	NetworkHops string `json:"networkHops,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TracerouteInfoStruct - Trace route info from target host to Delphix Engine. extends TypedObject

func TracerouteInfoFactory 

func TracerouteInfoFactory(
	NetworkHops string,
) TracerouteInfoStruct

TracerouteInfoFactory is just a simple function to instantiate the TracerouteInfoStruct

type TransformationStruct 

type TransformationStruct struct {
	// A reference to the container which is a transformed version of the
	// parent container.
	// format = objectReference
	// referenceTo = /delphix-container.json
	Container string `json:"container,omitempty"`
	// Reference to the user used during application of the
	// transformation.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// update = optional
	EnvironmentUser string `json:"environmentUser,omitempty"`
	// Object name.
	// maxLength = 256
	// format = objectName
	// create = optional
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Operations to perform when this transformation is applied.
	Operations []SourceOperation `json:"operations,omitempty"`
	// Platform-specific parameters that are stored on a transformation.
	PlatformParams BasePlatformParameters `json:"platformParams,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Reference to the repository used during application of the
	// transformation.
	// referenceTo = /delphix-source-repository.json
	// update = optional
	// format = objectReference
	Repository string `json:"repository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

TransformationStruct - A data platform agnostic transformation object. extends UserObject

func TransformationFactory 

func TransformationFactory(
	Container string,
	EnvironmentUser string,
	Name string,
	Namespace string,
	Operations []SourceOperation,
	PlatformParams BasePlatformParameters,
	Reference string,
	Repository string,
) TransformationStruct

TransformationFactory is just a simple function to instantiate the TransformationStruct

type TypedObject 

type TypedObject interface{}

TypedObject is an empty interface designed to function as the TypedObject API namespace

type UnixHostCreateParametersStruct 

type UnixHostCreateParametersStruct struct {
	// The host object.
	// create = required
	Host Host `json:"host,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

UnixHostCreateParametersStruct - The parameters used for the add Unix host operation. extends HostCreateParameters

func UnixHostCreateParametersFactory 

func UnixHostCreateParametersFactory(
	Host Host,
) UnixHostCreateParametersStruct

UnixHostCreateParametersFactory is just a simple function to instantiate the UnixHostCreateParametersStruct

type UnixHostEnvironmentStruct 

type UnixHostEnvironmentStruct struct {
	// Parameters for an environment with SAP ASE instances.
	// create = optional
	// update = optional
	AseHostEnvironmentParameters *ASEHostEnvironmentParametersStruct `json:"aseHostEnvironmentParameters,omitempty"`
	// The environment description.
	// create = optional
	// update = optional
	// maxLength = 1024
	Description string `json:"description,omitempty"`
	// Indicates whether the source environment is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// The reference to the associated host.
	// format = objectReference
	// referenceTo = /delphix-host.json
	Host string `json:"host,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source
	// environment.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A reference to the primary user for this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// update = optional
	PrimaryUser string `json:"primaryUser,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

UnixHostEnvironmentStruct - The representation of a unix host environment object. extends HostEnvironment

func UnixHostEnvironmentFactory 

func UnixHostEnvironmentFactory(
	AseHostEnvironmentParameters *ASEHostEnvironmentParametersStruct,
	Description string,
	Enabled *bool,
	Host string,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	PrimaryUser string,
	Reference string,
) UnixHostEnvironmentStruct

UnixHostEnvironmentFactory is just a simple function to instantiate the UnixHostEnvironmentStruct

type UnixHostStruct 

type UnixHostStruct struct {
	// The address associated with the host.
	// update = optional
	// format = host
	// create = required
	Address string `json:"address,omitempty"`
	// The date the host was added.
	DateAdded string `json:"dateAdded,omitempty"`
	// The lowercase alias to use inside the user managed DSP keystore.
	// create = optional
	// update = optional
	// minLength = 1
	DspKeystoreAlias string `json:"dspKeystoreAlias,omitempty"`
	// The password for the user managed DSP keystore.
	// format = password
	// create = optional
	// update = optional
	// minLength = 1
	DspKeystorePassword string `json:"dspKeystorePassword,omitempty"`
	// The path to the user managed DSP keystore.
	// create = optional
	// update = optional
	// minLength = 1
	DspKeystorePath string `json:"dspKeystorePath,omitempty"`
	// The password for the user managed DSP truststore.
	// create = optional
	// update = optional
	// minLength = 1
	// format = password
	DspTruststorePassword string `json:"dspTruststorePassword,omitempty"`
	// The path to the user managed DSP truststore.
	// update = optional
	// minLength = 1
	// create = optional
	DspTruststorePath string `json:"dspTruststorePath,omitempty"`
	// The host configuration object associated with the host.
	HostConfiguration *HostConfigurationStruct `json:"hostConfiguration,omitempty"`
	// Runtime properties for this host.
	HostRuntime *HostRuntimeStruct `json:"hostRuntime,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The list of host/IP addresses to use for NFS export.
	// uniqueItems = true
	// create = optional
	// update = optional
	NfsAddressList []string `json:"nfsAddressList,omitempty"`
	// The password for the user managed Oracle JDBC keystore.
	// update = optional
	// minLength = 1
	// format = password
	// create = optional
	OracleJdbcKeystorePassword string `json:"oracleJdbcKeystorePassword,omitempty"`
	// Profile for escalating user privileges.
	// create = optional
	// update = optional
	// referenceTo = /delphix-host-privilege-elevation-profile.json
	// format = objectReference
	PrivilegeElevationProfile string `json:"privilegeElevationProfile,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The port number used to connect to the host via SSH.
	// update = optional
	// default = 22
	// minimum = 1
	// maximum = 65535
	// create = optional
	SshPort *int `json:"sshPort,omitempty"`
	// Mechanism to use for ssh host verification.
	// create = optional
	// update = optional
	SshVerificationStrategy SshVerificationStrategy `json:"sshVerificationStrategy,omitempty"`
	// The path for the toolkit that resides on the host.
	// create = required
	// update = optional
	ToolkitPath string `json:"toolkitPath,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

UnixHostStruct - The representation of a Unix host object. extends Host

func UnixHostFactory 

func UnixHostFactory(
	Address string,
	DateAdded string,
	DspKeystoreAlias string,
	DspKeystorePassword string,
	DspKeystorePath string,
	DspTruststorePassword string,
	DspTruststorePath string,
	HostConfiguration *HostConfigurationStruct,
	HostRuntime *HostRuntimeStruct,
	Name string,
	Namespace string,
	NfsAddressList []string,
	OracleJdbcKeystorePassword string,
	PrivilegeElevationProfile string,
	Reference string,
	SshPort *int,
	SshVerificationStrategy SshVerificationStrategy,
	ToolkitPath string,
) UnixHostStruct

UnixHostFactory is just a simple function to instantiate the UnixHostStruct

type UpTimeInfoStruct 

type UpTimeInfoStruct struct {
	// Management Stack up time.
	Mgmt string `json:"mgmt,omitempty"`
	// OS up time.
	Os string `json:"os,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

UpTimeInfoStruct - Information about the up time of OS and management stack. extends TypedObject

func UpTimeInfoFactory 

func UpTimeInfoFactory(
	Mgmt string,
	Os string,
) UpTimeInfoStruct

UpTimeInfoFactory is just a simple function to instantiate the UpTimeInfoStruct

type UpgradeCheckResultStruct 

type UpgradeCheckResultStruct struct {
	// A localized, textual description of the action the user should
	// take to overcome the error.
	// create = readonly
	// update = readonly
	Action string `json:"action,omitempty"`
	// A unique identifier for the type of the upgrade check result.
	// create = readonly
	// update = readonly
	BundleId string `json:"bundleId,omitempty"`
	// A localized, textual description of the error.
	// update = readonly
	// create = readonly
	Description string `json:"description,omitempty"`
	// A localized, textual description of the impact the error might
	// have on the system.
	// create = readonly
	// update = readonly
	Impact string `json:"impact,omitempty"`
	// Object name.
	// create = required
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Script output related to the check result to assist in resolving
	// the issue.
	// create = readonly
	// update = readonly
	Output string `json:"output,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The severity of the missing upgrade requirement. CRITICAL check
	// results block the upgrade.
	// enum = [WARNING CRITICAL INFORMATIONAL]
	// create = readonly
	// update = readonly
	Severity string `json:"severity,omitempty"`
	// The status of the upgrade check result.
	// enum = [ACTIVE IGNORED RESOLVED]
	// create = readonly
	// update = readonly
	Status string `json:"status,omitempty"`
	// A localized string that is the broad category of this check.
	// create = readonly
	// update = readonly
	Title string `json:"title,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// A reference to the upgrade version that generated this check
	// result.
	// create = readonly
	// update = readonly
	// format = objectReference
	// referenceTo = /delphix-upgrade-version.json
	Version string `json:"version,omitempty"`
}

UpgradeCheckResultStruct - Describes unsatisfied upgrade requirements. extends NamedUserObject cliVisibility = [SYSTEM]

func UpgradeCheckResultFactory 

func UpgradeCheckResultFactory(
	Name string,
	Namespace string,
	Reference string,
) UpgradeCheckResultStruct

UpgradeCheckResultFactory is just a simple function to instantiate the UpgradeCheckResultStruct

type UpgradeCheckResultsVersionParametersStruct 

type UpgradeCheckResultsVersionParametersStruct struct {
	// BundleID of upgrade check result(s).
	// create = optional
	BundleId string `json:"bundleId,omitempty"`
	// Reference to a single upgrade check result.
	// create = optional
	// format = objectReference
	// referenceTo = /delphix-upgrade-check-result.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

UpgradeCheckResultsVersionParametersStruct - Parameters used to modify an upgradeCheckResult. These parameters are mutually exclusive. extends TypedObject

func UpgradeCheckResultsVersionParametersFactory 

func UpgradeCheckResultsVersionParametersFactory(
	BundleId string,
	Reference string,
) UpgradeCheckResultsVersionParametersStruct

UpgradeCheckResultsVersionParametersFactory is just a simple function to instantiate the UpgradeCheckResultsVersionParametersStruct

type UpgradeCompatibilityParametersStruct 

type UpgradeCompatibilityParametersStruct struct {
	// Restrict returned repositories to this environment.
	// referenceTo = /delphix-source-environment.json
	// create = optional
	// update = optional
	// format = objectReference
	Environment string `json:"environment,omitempty"`
	// The repository to use as a source of compatibility information.
	// required = true
	// format = objectReference
	// referenceTo = /delphix-source-repository.json
	SourceRepository string `json:"sourceRepository,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

UpgradeCompatibilityParametersStruct - The criteria necessary to select valid repositories for upgrading. extends CompatibleRepositoriesParameters

func UpgradeCompatibilityParametersFactory 

func UpgradeCompatibilityParametersFactory(
	Environment string,
	SourceRepository string,
) UpgradeCompatibilityParametersStruct

UpgradeCompatibilityParametersFactory is just a simple function to instantiate the UpgradeCompatibilityParametersStruct

type UpgradeNotificationStruct 

type UpgradeNotificationStruct struct {
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

UpgradeNotificationStruct - An object to track when an upgrade is happening to trigger UI response. extends Notification

func UpgradeNotificationFactory 

func UpgradeNotificationFactory() UpgradeNotificationStruct

UpgradeNotificationFactory is just a simple function to instantiate the UpgradeNotificationStruct

type UserAuthInfoStruct 

type UserAuthInfoStruct struct {
	// The list of authorizations granted to the current user.
	Authorizations []*AuthorizationStruct `json:"authorizations,omitempty"`
	// A reference to the system-defined Self-Service user role.
	// format = objectReference
	// referenceTo = /delphix-role.json
	JetStreamUserRole string `json:"jetStreamUserRole,omitempty"`
	// A reference to the system-defined owner role.
	// format = objectReference
	// referenceTo = /delphix-role.json
	OwnerRole string `json:"ownerRole,omitempty"`
	// A reference to the system-defined provisioner role.
	// format = objectReference
	// referenceTo = /delphix-role.json
	ProvisionerRole string `json:"provisionerRole,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// The currently logged in user.
	User *UserStruct `json:"user,omitempty"`
}

UserAuthInfoStruct - Summary authorization information about the current user. extends TypedObject

func UserAuthInfoFactory 

func UserAuthInfoFactory(
	Authorizations []*AuthorizationStruct,
	JetStreamUserRole string,
	OwnerRole string,
	ProvisionerRole string,
	User *UserStruct,
) UserAuthInfoStruct

UserAuthInfoFactory is just a simple function to instantiate the UserAuthInfoStruct

type UserInterfaceConfigStruct 

type UserInterfaceConfigStruct struct {
	// Indicates whether user-interface analytics are enabled or not.
	// update = optional
	AnalyticsEnabled *bool `json:"analyticsEnabled,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

UserInterfaceConfigStruct - User Interface Configuration. extends TypedObject cliVisibility = [DOMAIN SYSTEM]

func UserInterfaceConfigFactory 

func UserInterfaceConfigFactory(
	AnalyticsEnabled *bool,
) UserInterfaceConfigStruct

UserInterfaceConfigFactory is just a simple function to instantiate the UserInterfaceConfigStruct

type UserObject 

type UserObject interface{}

UserObject is an empty interface designed to function as the UserObject API namespace

type UserStruct 

type UserStruct struct {
	// User authentication type.
	// enum = [LDAP NATIVE SAML]
	// create = optional
	AuthenticationType string `json:"authenticationType,omitempty"`
	// Credential used for authentication.
	// create = optional
	Credential *PasswordCredentialStruct `json:"credential,omitempty"`
	// Email address for the user.
	// maxLength = 256
	// create = optional
	// update = optional
	// format = email
	EmailAddress string `json:"emailAddress,omitempty"`
	// True if the user is currently enabled and can log into the system.
	// default = true
	// create = optional
	Enabled *bool `json:"enabled,omitempty"`
	// First name of user.
	// maxLength = 64
	// create = optional
	// update = optional
	FirstName string `json:"firstName,omitempty"`
	// Home phone number of user.
	// maxLength = 32
	// create = optional
	// update = optional
	HomePhoneNumber string `json:"homePhoneNumber,omitempty"`
	// True if this is the default user and cannot be deleted.
	// create = optional
	IsDefault *bool `json:"isDefault,omitempty"`
	// Last name of user.
	// update = optional
	// maxLength = 64
	// create = optional
	LastName string `json:"lastName,omitempty"`
	// Preferred locale as an IETF BCP 47 language tag, defaults to
	// 'en-US'.
	// update = optional
	// format = locale
	// default = en-US
	// maxLength = 16
	// create = optional
	Locale string `json:"locale,omitempty"`
	// Mobile phone number of user.
	// update = optional
	// maxLength = 32
	// create = optional
	MobilePhoneNumber string `json:"mobilePhoneNumber,omitempty"`
	// Name of user.
	// create = required
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// Whether the user's password should be updated and why.
	// enum = [NONE FIRST_LOGIN ADMIN_REQUEST PASSWORD_POLICY]
	// default = NONE
	// update = optional
	PasswordUpdateRequest string `json:"passwordUpdateRequest,omitempty"`
	// Principal name used for authentication.
	// create = optional
	// update = optional
	Principal string `json:"principal,omitempty"`
	// Public key used for authentication.
	// create = optional
	// update = optional
	PublicKey string `json:"publicKey,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Session timeout in minutes.
	// units = min
	// create = optional
	// update = optional
	// minimum = 1
	// default = 30
	SessionTimeout *int `json:"sessionTimeout,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Type of user.
	// enum = [SYSTEM DOMAIN]
	// default = DOMAIN
	// create = optional
	UserType string `json:"userType,omitempty"`
	// Work phone number of user.
	// maxLength = 32
	// create = optional
	// update = optional
	WorkPhoneNumber string `json:"workPhoneNumber,omitempty"`
}

UserStruct - Delphix users. extends NamedUserObject cliVisibility = [DOMAIN SYSTEM]

func UserFactory 

func UserFactory(
	AuthenticationType string,
	Credential *PasswordCredentialStruct,
	EmailAddress string,
	Enabled *bool,
	FirstName string,
	HomePhoneNumber string,
	IsDefault *bool,
	LastName string,
	Locale string,
	MobilePhoneNumber string,
	Name string,
	Namespace string,
	PasswordUpdateRequest string,
	Principal string,
	PublicKey string,
	Reference string,
	SessionTimeout *int,
	UserType string,
	WorkPhoneNumber string,
) UserStruct

UserFactory is just a simple function to instantiate the UserStruct

type VMwarePlatformParametersStruct 

type VMwarePlatformParametersStruct struct {
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

VMwarePlatformParametersStruct - VMware platform-specific parameters that are stored on a transformation. extends BasePlatformParameters

func VMwarePlatformParametersFactory 

func VMwarePlatformParametersFactory() VMwarePlatformParametersStruct

VMwarePlatformParametersFactory is just a simple function to instantiate the VMwarePlatformParametersStruct

type ValidateSMTPParametersStruct 

type ValidateSMTPParametersStruct struct {
	// List of email addresses to send test email to.
	// required = true
	Addresses []string `json:"addresses,omitempty"`
	// SMTP configuration to use for validation.
	// required = true
	Config *SMTPConfigStruct `json:"config,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

ValidateSMTPParametersStruct - Validate SMTP configuration without committing it by sending mail to the specified address(es). extends TypedObject

func ValidateSMTPParametersFactory 

func ValidateSMTPParametersFactory(
	Addresses []string,
	Config *SMTPConfigStruct,
) ValidateSMTPParametersStruct

ValidateSMTPParametersFactory is just a simple function to instantiate the ValidateSMTPParametersStruct

type VerifyVersionParametersStruct 

type VerifyVersionParametersStruct struct {
	// If true, validates the success of upgrading the Delphix Engine
	// without updating the OSsoftware. The operation will detect a
	// failure if the upgrade version requires a version of the OSthat is
	// newer than what is currently running.
	// create = optional
	// default = false
	Defer *bool `json:"defer,omitempty"`
	// Object type.
	// format = type
	// required = true
	Type string `json:"type,omitempty"`
}

VerifyVersionParametersStruct - The parameters to use as input to verifying an upgrade. extends TypedObject

func VerifyVersionParametersFactory 

func VerifyVersionParametersFactory(
	Defer *bool,
) VerifyVersionParametersStruct

VerifyVersionParametersFactory is just a simple function to instantiate the VerifyVersionParametersStruct

type VersionInfoStruct 

type VersionInfoStruct struct {
	// Major version number.
	Major *int `json:"major,omitempty"`
	// Micro version number.
	Micro *int `json:"micro,omitempty"`
	// Minor version number.
	Minor *int `json:"minor,omitempty"`
	// Patch version number.
	Patch *int `json:"patch,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

VersionInfoStruct - Representation of a Delphix software revision. extends TypedObject

func VersionInfoFactory 

func VersionInfoFactory(
	Major *int,
	Micro *int,
	Minor *int,
	Patch *int,
) VersionInfoStruct

VersionInfoFactory is just a simple function to instantiate the VersionInfoStruct

type VfsOpsDatapointStreamStruct 

type VfsOpsDatapointStreamStruct struct {
	// Whether reads were cached.
	Cached *bool `json:"cached,omitempty"`
	// The set of datapoints in the stream.
	Datapoints []Datapoint `json:"datapoints,omitempty"`
	// I/O operation type.
	// enum = [read write]
	Op string `json:"op,omitempty"`
	// Path of the affected file.
	// format = unixpath
	Path string `json:"path,omitempty"`
	// Whether writes were synchronous.
	Sync *bool `json:"sync,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

VfsOpsDatapointStreamStruct - A stream of datapoints from a VFS_OPS analytics slice. extends DatapointStream

func VfsOpsDatapointStreamFactory 

func VfsOpsDatapointStreamFactory(
	Cached *bool,
	Datapoints []Datapoint,
	Op string,
	Path string,
	Sync *bool,
) VfsOpsDatapointStreamStruct

VfsOpsDatapointStreamFactory is just a simple function to instantiate the VfsOpsDatapointStreamStruct

type VirtualDatasetCreationParameters 

type VirtualDatasetCreationParameters interface{}

VirtualDatasetCreationParameters is an empty interface designed to function as the VirtualDatasetCreationParameters API namespace

type VirtualSourceOperationsStruct 

type VirtualSourceOperationsStruct struct {
	// Operations to perform when initially creating the virtual source
	// and every time it is refreshed.
	// create = optional
	// update = optional
	ConfigureClone []SourceOperation `json:"configureClone,omitempty"`
	// Operations to perform after refreshing a virtual source. These
	// operations can be used to restore any data or configuration backed
	// up in the preRefresh operations.
	// create = optional
	// update = optional
	PostRefresh []SourceOperation `json:"postRefresh,omitempty"`
	// Operations to perform after rewinding a virtual source. These
	// operations can be used to automate processes once the rewind is
	// complete.
	// create = optional
	// update = optional
	PostRollback []SourceOperation `json:"postRollback,omitempty"`
	// Operations to perform after snapshotting a virtual source.
	// create = optional
	// update = optional
	PostSnapshot []SourceOperation `json:"postSnapshot,omitempty"`
	// Operations to perform after starting a virtual source.
	// create = optional
	// update = optional
	PostStart []SourceOperation `json:"postStart,omitempty"`
	// Operations to perform after stopping a virtual source.
	// update = optional
	// create = optional
	PostStop []SourceOperation `json:"postStop,omitempty"`
	// Operations to perform before refreshing a virtual source. These
	// operations can backup any data or configuration from the running
	// source before doing the refresh.
	// create = optional
	// update = optional
	PreRefresh []SourceOperation `json:"preRefresh,omitempty"`
	// Operations to perform before rewinding a virtual source. These
	// operations can backup any data or configuration from the running
	// source prior to rewinding.
	// create = optional
	// update = optional
	PreRollback []SourceOperation `json:"preRollback,omitempty"`
	// Operations to perform before snapshotting a virtual source. These
	// operations can quiesce any data prior to snapshotting.
	// create = optional
	// update = optional
	PreSnapshot []SourceOperation `json:"preSnapshot,omitempty"`
	// Operations to perform before starting a virtual source.
	// create = optional
	// update = optional
	PreStart []SourceOperation `json:"preStart,omitempty"`
	// Operations to perform before stopping a virtual source.
	// update = optional
	// create = optional
	PreStop []SourceOperation `json:"preStop,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

VirtualSourceOperationsStruct - Describes operations which are performed on virtual sources at various times. extends TypedObject

func VirtualSourceOperationsFactory 

func VirtualSourceOperationsFactory(
	ConfigureClone []SourceOperation,
	PostRefresh []SourceOperation,
	PostRollback []SourceOperation,
	PostSnapshot []SourceOperation,
	PostStart []SourceOperation,
	PostStop []SourceOperation,
	PreRefresh []SourceOperation,
	PreRollback []SourceOperation,
	PreSnapshot []SourceOperation,
	PreStart []SourceOperation,
	PreStop []SourceOperation,
) VirtualSourceOperationsStruct

VirtualSourceOperationsFactory is just a simple function to instantiate the VirtualSourceOperationsStruct

type WindowsClusterCreateParametersStruct 

type WindowsClusterCreateParametersStruct struct {
	// The representation of the cluster object.
	// create = required
	Cluster *WindowsClusterStruct `json:"cluster,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to the created source
	// environment.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// The primary user associated with the environment.
	// create = required
	PrimaryUser *EnvironmentUserStruct `json:"primaryUser,omitempty"`
	// Create as a target environment.
	// create = optional
	Target *bool `json:"target,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

WindowsClusterCreateParametersStruct - The parameters used to create a Windows Cluster. extends SourceEnvironmentCreateParameters

func WindowsClusterCreateParametersFactory 

func WindowsClusterCreateParametersFactory(
	Cluster *WindowsClusterStruct,
	LogCollectionEnabled *bool,
	PrimaryUser *EnvironmentUserStruct,
	Target *bool,
) WindowsClusterCreateParametersStruct

WindowsClusterCreateParametersFactory is just a simple function to instantiate the WindowsClusterCreateParametersStruct

type WindowsClusterNodeStruct 

type WindowsClusterNodeStruct struct {
	// A reference to the Windows cluster environment this node belongs
	// to.
	// format = objectReference
	// referenceTo = /delphix-windows-cluster.json
	Cluster string `json:"cluster,omitempty"`
	// Indicates whether the node is discovered.
	Discovered *bool `json:"discovered,omitempty"`
	// A reference to the physical host.
	// referenceTo = /delphix-host.json
	// format = objectReference
	Host string `json:"host,omitempty"`
	// Object name.
	// maxLength = 256
	// create = required
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// referenceTo = /delphix-persistent-object.json
	// format = objectReference
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

WindowsClusterNodeStruct - A node in a Windows Cluster. extends NamedUserObject

func WindowsClusterNodeFactory 

func WindowsClusterNodeFactory(
	Cluster string,
	Discovered *bool,
	Host string,
	Name string,
	Namespace string,
	Reference string,
) WindowsClusterNodeStruct

WindowsClusterNodeFactory is just a simple function to instantiate the WindowsClusterNodeStruct

type WindowsClusterStruct 

type WindowsClusterStruct struct {
	// The address that will be used to perform discovery on the cluster.
	// create = required
	// update = optional
	Address string `json:"address,omitempty"`
	// The environment description.
	// create = optional
	// update = optional
	// maxLength = 1024
	Description string `json:"description,omitempty"`
	// Indicates whether the source environment is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source
	// environment.
	// update = optional
	// default = false
	// create = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// update = optional
	// maxLength = 256
	// format = objectName
	// create = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A reference to the primary user for this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// update = optional
	PrimaryUser string `json:"primaryUser,omitempty"`
	// A reference to the proxy that will be used to discover the
	// cluster.
	// format = objectReference
	// referenceTo = /delphix-host.json
	// create = required
	// update = optional
	Proxy string `json:"proxy,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// A reference to the proxy host that will be used for cluster
	// support operations.
	// referenceTo = /delphix-host.json
	// update = optional
	// format = objectReference
	TargetProxy string `json:"targetProxy,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

WindowsClusterStruct - A Windows cluster environment. extends SourceEnvironment

func WindowsClusterFactory 

func WindowsClusterFactory(
	Address string,
	Description string,
	Enabled *bool,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	PrimaryUser string,
	Proxy string,
	Reference string,
	TargetProxy string,
) WindowsClusterStruct

WindowsClusterFactory is just a simple function to instantiate the WindowsClusterStruct

type WindowsHostCreateParametersStruct 

type WindowsHostCreateParametersStruct struct {
	// The host object.
	// create = required
	Host Host `json:"host,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

WindowsHostCreateParametersStruct - The parameters used for the add Windows host operation. extends HostCreateParameters

func WindowsHostCreateParametersFactory 

func WindowsHostCreateParametersFactory(
	Host Host,
) WindowsHostCreateParametersStruct

WindowsHostCreateParametersFactory is just a simple function to instantiate the WindowsHostCreateParametersStruct

type WindowsHostEnvironmentStruct 

type WindowsHostEnvironmentStruct struct {
	// The environment description.
	// create = optional
	// update = optional
	// maxLength = 1024
	Description string `json:"description,omitempty"`
	// Indicates whether the source environment is enabled.
	Enabled *bool `json:"enabled,omitempty"`
	// The reference to the associated host.
	// format = objectReference
	// referenceTo = /delphix-host.json
	Host string `json:"host,omitempty"`
	// Flag indicating whether it is allowed to collect logs, potentially
	// containing sensitive information, related to this source
	// environment.
	// default = false
	// create = optional
	// update = optional
	LogCollectionEnabled *bool `json:"logCollectionEnabled,omitempty"`
	// Object name.
	// maxLength = 256
	// format = objectName
	// create = optional
	// update = optional
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// A reference to the primary user for this environment.
	// format = objectReference
	// referenceTo = /delphix-source-environment-user.json
	// update = optional
	PrimaryUser string `json:"primaryUser,omitempty"`
	// The reference to the proxy associated with the host.
	// format = objectReference
	// referenceTo = /delphix-host.json
	// create = optional
	// update = optional
	Proxy string `json:"proxy,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

WindowsHostEnvironmentStruct - The representation of a windows host environment object. extends HostEnvironment

func WindowsHostEnvironmentFactory 

func WindowsHostEnvironmentFactory(
	Description string,
	Enabled *bool,
	Host string,
	LogCollectionEnabled *bool,
	Name string,
	Namespace string,
	PrimaryUser string,
	Proxy string,
	Reference string,
) WindowsHostEnvironmentStruct

WindowsHostEnvironmentFactory is just a simple function to instantiate the WindowsHostEnvironmentStruct

type WindowsHostStruct 

type WindowsHostStruct struct {
	// The address associated with the host.
	// update = optional
	// format = host
	// create = required
	Address string `json:"address,omitempty"`
	// Unique per Delphix key used to authenticate with the remote
	// Delphix Connector.
	// create = optional
	// update = optional
	ConnectorAuthenticationKey string `json:"connectorAuthenticationKey,omitempty"`
	// The port that the connector connects on.
	// create = optional
	// update = optional
	ConnectorPort float64 `json:"connectorPort,omitempty"`
	// The date the host was added.
	DateAdded string `json:"dateAdded,omitempty"`
	// The lowercase alias to use inside the user managed DSP keystore.
	// create = optional
	// update = optional
	// minLength = 1
	DspKeystoreAlias string `json:"dspKeystoreAlias,omitempty"`
	// The password for the user managed DSP keystore.
	// create = optional
	// update = optional
	// minLength = 1
	// format = password
	DspKeystorePassword string `json:"dspKeystorePassword,omitempty"`
	// The path to the user managed DSP keystore.
	// create = optional
	// update = optional
	// minLength = 1
	DspKeystorePath string `json:"dspKeystorePath,omitempty"`
	// The password for the user managed DSP truststore.
	// minLength = 1
	// format = password
	// create = optional
	// update = optional
	DspTruststorePassword string `json:"dspTruststorePassword,omitempty"`
	// The path to the user managed DSP truststore.
	// update = optional
	// minLength = 1
	// create = optional
	DspTruststorePath string `json:"dspTruststorePath,omitempty"`
	// The host configuration object associated with the host.
	HostConfiguration *HostConfigurationStruct `json:"hostConfiguration,omitempty"`
	// Runtime properties for this host.
	HostRuntime *HostRuntimeStruct `json:"hostRuntime,omitempty"`
	// Object name.
	// create = readonly
	// update = readonly
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// referenceTo = /delphix-namespace.json
	// format = objectReference
	Namespace string `json:"namespace,omitempty"`
	// The list of host/IP addresses to use for NFS export.
	// update = optional
	// uniqueItems = true
	// create = optional
	NfsAddressList []string `json:"nfsAddressList,omitempty"`
	// Profile for escalating user privileges.
	// create = optional
	// update = optional
	// referenceTo = /delphix-host-privilege-elevation-profile.json
	// format = objectReference
	PrivilegeElevationProfile string `json:"privilegeElevationProfile,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// The port number used to connect to the host via SSH.
	// create = optional
	// update = optional
	// default = 22
	// minimum = 1
	// maximum = 65535
	SshPort *int `json:"sshPort,omitempty"`
	// The path for the toolkit that resides on the host.
	// create = readonly
	// update = readonly
	ToolkitPath string `json:"toolkitPath,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

WindowsHostStruct - The representation of a Windows host object. extends Host

func WindowsHostFactory 

func WindowsHostFactory(
	Address string,
	ConnectorAuthenticationKey string,
	ConnectorPort float64,
	DateAdded string,
	DspKeystoreAlias string,
	DspKeystorePassword string,
	DspKeystorePath string,
	DspTruststorePassword string,
	DspTruststorePath string,
	HostConfiguration *HostConfigurationStruct,
	HostRuntime *HostRuntimeStruct,
	Name string,
	Namespace string,
	NfsAddressList []string,
	PrivilegeElevationProfile string,
	Reference string,
	SshPort *int,
) WindowsHostStruct

WindowsHostFactory is just a simple function to instantiate the WindowsHostStruct

type WorkflowFunctionDefinitionStruct 

type WorkflowFunctionDefinitionStruct struct {
	// The input schema for this function according to DRAFTV4.
	// update = optional
	// create = required
	InputSchema *SchemaDraftV4Struct `json:"inputSchema,omitempty"`
	// The name of this function.
	// create = required
	// update = optional
	Name string `json:"name,omitempty"`
	// The output schema for this function according to DRAFTV4.
	// create = required
	// update = optional
	OutputSchema *SchemaDraftV4Struct `json:"outputSchema,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

WorkflowFunctionDefinitionStruct - The definition of a Workflow Function. extends TypedObject

func WorkflowFunctionDefinitionFactory 

func WorkflowFunctionDefinitionFactory(
	InputSchema *SchemaDraftV4Struct,
	Name string,
	OutputSchema *SchemaDraftV4Struct,
) WorkflowFunctionDefinitionStruct

WorkflowFunctionDefinitionFactory is just a simple function to instantiate the WorkflowFunctionDefinitionStruct

type X500DistinguishedName 

type X500DistinguishedName interface{}

X500DistinguishedName is an empty interface designed to function as the X500DistinguishedName API namespace

type X500DistinguishedNameCompositeStruct 

type X500DistinguishedNameCompositeStruct struct {
	// The composite Distinguished Name.
	// create = required
	Dname string `json:"dname,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

X500DistinguishedNameCompositeStruct - The representation of a composite X.500 Distinguished Name. extends X500DistinguishedName

func X500DistinguishedNameCompositeFactory 

func X500DistinguishedNameCompositeFactory(
	Dname string,
) X500DistinguishedNameCompositeStruct

X500DistinguishedNameCompositeFactory is just a simple function to instantiate the X500DistinguishedNameCompositeStruct

type X500DistinguishedNameFieldsStruct 

type X500DistinguishedNameFieldsStruct struct {
	// City/locality (L).
	// create = optional
	City string `json:"city,omitempty"`
	// Common name (CN).
	// create = required
	CommonName string `json:"commonName,omitempty"`
	// Country (C).
	// create = optional
	Country string `json:"country,omitempty"`
	// Organization (O).
	// create = optional
	Organization string `json:"organization,omitempty"`
	// Organization unit (OU).
	// create = optional
	OrganizationUnit string `json:"organizationUnit,omitempty"`
	// State/region (ST).
	// create = optional
	StateRegion string `json:"stateRegion,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

X500DistinguishedNameFieldsStruct - The representation of a X.500 Distinguished Name by separate fields. extends X500DistinguishedName

func X500DistinguishedNameFieldsFactory 

func X500DistinguishedNameFieldsFactory(
	City string,
	CommonName string,
	Country string,
	Organization string,
	OrganizationUnit string,
	StateRegion string,
) X500DistinguishedNameFieldsStruct

X500DistinguishedNameFieldsFactory is just a simple function to instantiate the X500DistinguishedNameFieldsStruct

type X509CertificateStruct 

type X509CertificateStruct struct {
	// Delphix trusts this certificate .
	Accepted *bool `json:"accepted,omitempty"`
	// Issuer of this certificate.
	IssuedByDN string `json:"issuedByDN,omitempty"`
	// Distinguished name of subject of this certificate.
	IssuedToDN string `json:"issuedToDN,omitempty"`
	// MD5 fingerprint.
	Md5Fingerprint string `json:"md5Fingerprint,omitempty"`
	// Object name.
	// format = objectName
	// create = optional
	// update = optional
	// maxLength = 256
	Name string `json:"name,omitempty"`
	// Alternate namespace for this object, for replicated and restored
	// objects.
	// format = objectReference
	// referenceTo = /delphix-namespace.json
	Namespace string `json:"namespace,omitempty"`
	// The object reference.
	// format = objectReference
	// referenceTo = /delphix-persistent-object.json
	Reference string `json:"reference,omitempty"`
	// Certificate serial number.
	SerialNumber string `json:"serialNumber,omitempty"`
	// SHA-1 fingerprint.
	Sha1Fingerprint string `json:"sha1Fingerprint,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Start of validity.
	ValidFrom string `json:"validFrom,omitempty"`
	// End of validity.
	ValidTo string `json:"validTo,omitempty"`
}

X509CertificateStruct - X509 Certificate. extends UserObject cliVisibility = [SYSTEM]

func X509CertificateFactory 

func X509CertificateFactory(
	Accepted *bool,
	IssuedByDN string,
	IssuedToDN string,
	Md5Fingerprint string,
	Name string,
	Namespace string,
	Reference string,
	SerialNumber string,
	Sha1Fingerprint string,
	ValidFrom string,
	ValidTo string,
) X509CertificateStruct

X509CertificateFactory is just a simple function to instantiate the X509CertificateStruct

type XPPCompatibilityParametersStruct 

type XPPCompatibilityParametersStruct struct {
	// Restrict returned repositories to this environment.
	// create = optional
	// update = optional
	// format = objectReference
	// referenceTo = /delphix-source-environment.json
	Environment string `json:"environment,omitempty"`
	// The TimeFlow point to use as a source of compatibility
	// information.
	// properties = map[type:map[default:TimeflowPointSemantic]]
	// required = true
	TimeflowPointParameters TimeflowPointParameters `json:"timeflowPointParameters,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

XPPCompatibilityParametersStruct - The criteria necessary to select valid repositories for cross-platform provisioning. extends CompatibleRepositoriesParameters

func XPPCompatibilityParametersFactory 

func XPPCompatibilityParametersFactory(
	Environment string,
	TimeflowPointParameters TimeflowPointParameters,
) XPPCompatibilityParametersStruct

XPPCompatibilityParametersFactory is just a simple function to instantiate the XPPCompatibilityParametersStruct

type XppLastRunStatusStruct 

type XppLastRunStatusStruct struct {
	// Error message associated with the last run, if any.
	ErrorMessage string `json:"errorMessage,omitempty"`
	// Last cross-platform provision job run on the container.
	Job *JobStruct `json:"job,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

XppLastRunStatusStruct - Status of the last cross-platform provision of the container. extends ChecklistItem

func XppLastRunStatusFactory 

func XppLastRunStatusFactory(
	ErrorMessage string,
	Job *JobStruct,
) XppLastRunStatusStruct

XppLastRunStatusFactory is just a simple function to instantiate the XppLastRunStatusStruct

type XppStagingStatusStruct 

type XppStagingStatusStruct struct {
	// Description of this status item.
	Description string `json:"description,omitempty"`
	// Status message, if applicable.
	Message string `json:"message,omitempty"`
	// The status item name.
	Name string `json:"name,omitempty"`
	// Status of this item.
	// enum = [SUCCESS WARNING ERROR]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

XppStagingStatusStruct - Status of the cross-platform provisioning staging environment. extends ChecklistItemDetail

func XppStagingStatusFactory 

func XppStagingStatusFactory(
	Description string,
	Message string,
	Name string,
	Status string,
) XppStagingStatusStruct

XppStagingStatusFactory is just a simple function to instantiate the XppStagingStatusStruct

type XppStatusStruct 

type XppStatusStruct struct {
	// Status of the last cross-platform provision of the container.
	LastRunStatus *XppLastRunStatusStruct `json:"lastRunStatus,omitempty"`
	// Status of the cross-platform provisioning staging environment.
	StagingStatus *XppStagingStatusStruct `json:"stagingStatus,omitempty"`
	// Status of the cross-platform provisioning target environment.
	TargetStatus *XppTargetStatusStruct `json:"targetStatus,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
	// Cross-platform provisioning validation status of the container.
	ValidateStatus *XppValidateStatusStruct `json:"validateStatus,omitempty"`
}

XppStatusStruct - The current cross-platform provisioning status of a container. extends Checklist

func XppStatusFactory 

func XppStatusFactory(
	LastRunStatus *XppLastRunStatusStruct,
	StagingStatus *XppStagingStatusStruct,
	TargetStatus *XppTargetStatusStruct,
	ValidateStatus *XppValidateStatusStruct,
) XppStatusStruct

XppStatusFactory is just a simple function to instantiate the XppStatusStruct

type XppTargetStatusStruct 

type XppTargetStatusStruct struct {
	// Description of this status item.
	Description string `json:"description,omitempty"`
	// Status message, if applicable.
	Message string `json:"message,omitempty"`
	// The status item name.
	Name string `json:"name,omitempty"`
	// Status of this item.
	// enum = [SUCCESS WARNING ERROR]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

XppTargetStatusStruct - Status of the cross-platform provisioning target environment. extends ChecklistItemDetail

func XppTargetStatusFactory 

func XppTargetStatusFactory(
	Description string,
	Message string,
	Name string,
	Status string,
) XppTargetStatusStruct

XppTargetStatusFactory is just a simple function to instantiate the XppTargetStatusStruct

type XppValidateStatusStruct 

type XppValidateStatusStruct struct {
	// Description of this status item.
	Description string `json:"description,omitempty"`
	// Status message, if applicable.
	Message string `json:"message,omitempty"`
	// The status item name.
	Name string `json:"name,omitempty"`
	// Status of this item.
	// enum = [SUCCESS WARNING ERROR]
	Status string `json:"status,omitempty"`
	// Object type.
	// required = true
	// format = type
	Type string `json:"type,omitempty"`
}

XppValidateStatusStruct - Cross-platform provisioning validation status of the container. extends ChecklistItemDetail

func XppValidateStatusFactory 

func XppValidateStatusFactory(
	Description string,
	Message string,
	Name string,
	Status string,
) XppValidateStatusStruct

XppValidateStatusFactory is just a simple function to instantiate the XppValidateStatusStruct

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.