# README
DCT Go Client SDK
This is a Go Client SDK leveraging the DCT APIGW.
For SDK usage, please refer to OPENAPI-README.md file
DCT Go Client SDK Generator Script
This is a guide on generation of the client SDK in Go Lang for the DCT Orbital APIGW.
Getting Started
The reources for code generation are present in the 'generation-scripts' directory. The script codegen.sh generates a GO Client SDK using the openapi-generator-cli tool. It generates the SDK, initializes the SDK and runs a test go function.
Prerequisites
Java needs to be installed to run the jar file. And Golang >= 1.17 needs to be installed in the machine where the script is run.
Refer to the official docs of the respective languages for guidance.
Delphix Control Tower SDK for Go
This repository houses the Go Client SDK for Delphix Control Tower APIs ( Multi Cloud Version).
Getting Started
To be added.
Prerequisites
Also the script requires an API Spec file for the DCT-APIGW. A sample file is present in the directory. For the latest spec, please download it from https://raw.githubusercontent.com/delphix/orbital-api-gateway/main/app/src/main/resources/api.yaml
Running the Script
As mentioned above the script requires a spec file.
Run the script as follows
sh codegen.sh api.yaml
On successful run, following tasks will result:
1. Generation of client SDK
2. Initialize the SDK module
3. Run the Test Go file, input the API key and hostname of the Delphix Engine and display list of Engines added to the APIGW
Running the tests
The test.go file executes a get all engines operation on the configured DCT-APIGW. To run the test on your delphix engine, provide the API key and Hostname of the engine when prompted.
Break down into end to end tests
The test essentially tests if the client SDK is functional and should be run before raising a PR. The result of the test will be available at the end of the script as follows.
List of engines are:
my-host.domain.co
If in any case, the test fails, we will be getting a 'test failed' message in the end.
Deployment
Once successful generation of client SDK and the test succeeds, we are ready to raise a PR.
Contributing
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.
Authors
- Dephix Engineering - Company
License
This project is licensed under the Apache License 2.0. Full license is available here.
Versioning
We use SemVer for versioning. For the versions available, see the tags on this repository.
# Packages
No description provided by the author
# Functions
CacheExpires helper function to determine remaining time before repeating a request.
NewApiClient instantiates a new ApiClient object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewAPIClient creates a new API client.
NewApiClientCreateParameter instantiates a new ApiClientCreateParameter object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewApiClientCreateParameterWithDefaults instantiates a new ApiClientCreateParameter object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewApiClientCreateResponse instantiates a new ApiClientCreateResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewApiClientCreateResponseWithDefaults instantiates a new ApiClientCreateResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewApiClientWithDefaults instantiates a new ApiClient object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewBaseProvisionVDBParameters instantiates a new BaseProvisionVDBParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBaseProvisionVDBParametersWithDefaults instantiates a new BaseProvisionVDBParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewBookmark instantiates a new Bookmark object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewBookmarkWithDefaults instantiates a new Bookmark object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewConfiguration returns a new Configuration object.
NewCreateBookmarkResponse instantiates a new CreateBookmarkResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCreateBookmarkResponseWithDefaults instantiates a new CreateBookmarkResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCreateEnvironmentResponse instantiates a new CreateEnvironmentResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCreateEnvironmentResponseWithDefaults instantiates a new CreateEnvironmentResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCreateVDBGroupRequest instantiates a new CreateVDBGroupRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCreateVDBGroupRequestWithDefaults instantiates a new CreateVDBGroupRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewCreateVDBGroupResponse instantiates a new CreateVDBGroupResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewCreateVDBGroupResponseWithDefaults instantiates a new CreateVDBGroupResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDataPointBySnapshotParameters instantiates a new DataPointBySnapshotParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDataPointBySnapshotParametersWithDefaults instantiates a new DataPointBySnapshotParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDataPointByTimestampParameters instantiates a new DataPointByTimestampParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDataPointByTimestampParametersWithDefaults instantiates a new DataPointByTimestampParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDeleteEngineResponse instantiates a new DeleteEngineResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeleteEngineResponseWithDefaults instantiates a new DeleteEngineResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDeleteEnvironmentResponse instantiates a new DeleteEnvironmentResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeleteEnvironmentResponseWithDefaults instantiates a new DeleteEnvironmentResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDeleteVDBParameters instantiates a new DeleteVDBParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeleteVDBParametersWithDefaults instantiates a new DeleteVDBParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDeleteVDBResponse instantiates a new DeleteVDBResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDeleteVDBResponseWithDefaults instantiates a new DeleteVDBResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDisableEnvironmentResponse instantiates a new DisableEnvironmentResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDisableEnvironmentResponseWithDefaults instantiates a new DisableEnvironmentResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDisableVDBParameters instantiates a new DisableVDBParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDisableVDBParametersWithDefaults instantiates a new DisableVDBParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDisableVDBResponse instantiates a new DisableVDBResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDisableVDBResponseWithDefaults instantiates a new DisableVDBResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewDSource instantiates a new DSource object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewDSourceWithDefaults instantiates a new DSource object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEnableEnvironmentResponse instantiates a new EnableEnvironmentResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEnableEnvironmentResponseWithDefaults instantiates a new EnableEnvironmentResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEnableVDBParameters instantiates a new EnableVDBParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEnableVDBParametersWithDefaults instantiates a new EnableVDBParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEnableVDBResponse instantiates a new EnableVDBResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEnableVDBResponseWithDefaults instantiates a new EnableVDBResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEngine instantiates a new Engine object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEngineConnectivityCheckRequest instantiates a new EngineConnectivityCheckRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEngineConnectivityCheckRequestWithDefaults instantiates a new EngineConnectivityCheckRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEngineConnectivityCheckResponse instantiates a new EngineConnectivityCheckResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEngineConnectivityCheckResponseWithDefaults instantiates a new EngineConnectivityCheckResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEngineRegistrationParameter instantiates a new EngineRegistrationParameter object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEngineRegistrationParameterWithDefaults instantiates a new EngineRegistrationParameter object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEngineWithDefaults instantiates a new Engine object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEnvironment instantiates a new Environment object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEnvironmentCreateParameters instantiates a new EnvironmentCreateParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewEnvironmentCreateParametersWithDefaults instantiates a new EnvironmentCreateParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewEnvironmentWithDefaults instantiates a new Environment object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewError instantiates a new Error object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewErrorWithDefaults instantiates a new Error object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHashicorpVault instantiates a new HashicorpVault object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHashicorpVaultWithDefaults instantiates a new HashicorpVault object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHook instantiates a new Hook object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHookWithDefaults instantiates a new Hook object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewHost instantiates a new Host object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewHostWithDefaults instantiates a new Host object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewJob instantiates a new Job object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewJobWithDefaults instantiates a new Job object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListBookmarksByVDBGroupsResponse instantiates a new ListBookmarksByVDBGroupsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListBookmarksByVDBGroupsResponseWithDefaults instantiates a new ListBookmarksByVDBGroupsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListBookmarksResponse instantiates a new ListBookmarksResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListBookmarksResponseWithDefaults instantiates a new ListBookmarksResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListDSourcesResponse instantiates a new ListDSourcesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListDSourcesResponseWithDefaults instantiates a new ListDSourcesResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListEnvironmentsResponse instantiates a new ListEnvironmentsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListEnvironmentsResponseWithDefaults instantiates a new ListEnvironmentsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListSnaphotsResponse instantiates a new ListSnaphotsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListSnaphotsResponseWithDefaults instantiates a new ListSnaphotsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListSourcesResponse instantiates a new ListSourcesResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListSourcesResponseWithDefaults instantiates a new ListSourcesResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListVDBGroupsByBookmarkResponse instantiates a new ListVDBGroupsByBookmarkResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListVDBGroupsByBookmarkResponseWithDefaults instantiates a new ListVDBGroupsByBookmarkResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListVDBGroupsResponse instantiates a new ListVDBGroupsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListVDBGroupsResponseWithDefaults instantiates a new ListVDBGroupsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewListVDBsResponse instantiates a new ListVDBsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewListVDBsResponseWithDefaults instantiates a new ListVDBsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
NewPaginatedResponseMetadata instantiates a new PaginatedResponseMetadata object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewPaginatedResponseMetadataWithDefaults instantiates a new PaginatedResponseMetadata object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProvisionVDBBySnapshotParameters instantiates a new ProvisionVDBBySnapshotParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProvisionVDBBySnapshotParametersWithDefaults instantiates a new ProvisionVDBBySnapshotParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProvisionVDBByTimestampParameters instantiates a new ProvisionVDBByTimestampParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProvisionVDBByTimestampParametersAllOf instantiates a new ProvisionVDBByTimestampParametersAllOf object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProvisionVDBByTimestampParametersAllOfWithDefaults instantiates a new ProvisionVDBByTimestampParametersAllOf object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProvisionVDBByTimestampParametersWithDefaults instantiates a new ProvisionVDBByTimestampParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewProvisionVDBResponse instantiates a new ProvisionVDBResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewProvisionVDBResponseWithDefaults instantiates a new ProvisionVDBResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRefreshEnvironmentResponse instantiates a new RefreshEnvironmentResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRefreshEnvironmentResponseWithDefaults instantiates a new RefreshEnvironmentResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRefreshVDBBySnapshotParameters instantiates a new RefreshVDBBySnapshotParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRefreshVDBBySnapshotParametersWithDefaults instantiates a new RefreshVDBBySnapshotParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRefreshVDBBySnapshotResponse instantiates a new RefreshVDBBySnapshotResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRefreshVDBBySnapshotResponseWithDefaults instantiates a new RefreshVDBBySnapshotResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRefreshVDBByTimestampParameters instantiates a new RefreshVDBByTimestampParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRefreshVDBByTimestampParametersWithDefaults instantiates a new RefreshVDBByTimestampParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRefreshVDBByTimestampResponse instantiates a new RefreshVDBByTimestampResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRefreshVDBByTimestampResponseWithDefaults instantiates a new RefreshVDBByTimestampResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRegisteredEngine instantiates a new RegisteredEngine object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRegisteredEngineWithDefaults instantiates a new RegisteredEngine object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRollbackVDBBySnapshotParameters instantiates a new RollbackVDBBySnapshotParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRollbackVDBBySnapshotParametersWithDefaults instantiates a new RollbackVDBBySnapshotParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRollbackVDBBySnapshotResponse instantiates a new RollbackVDBBySnapshotResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRollbackVDBBySnapshotResponseWithDefaults instantiates a new RollbackVDBBySnapshotResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRollbackVDBByTimestampParameters instantiates a new RollbackVDBByTimestampParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRollbackVDBByTimestampParametersWithDefaults instantiates a new RollbackVDBByTimestampParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewRollbackVDBByTimestampResponse instantiates a new RollbackVDBByTimestampResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewRollbackVDBByTimestampResponseWithDefaults instantiates a new RollbackVDBByTimestampResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSnapshot instantiates a new Snapshot object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSnapshotWithDefaults instantiates a new Snapshot object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewSource instantiates a new Source object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewSourceWithDefaults instantiates a new Source object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStartVDBResponse instantiates a new StartVDBResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStartVDBResponseWithDefaults instantiates a new StartVDBResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewStopVDBResponse instantiates a new StopVDBResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewStopVDBResponseWithDefaults instantiates a new StopVDBResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTag instantiates a new Tag object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTagsRequest instantiates a new TagsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTagsRequestWithDefaults instantiates a new TagsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTagsResponse instantiates a new TagsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewTagsResponseWithDefaults instantiates a new TagsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewTagWithDefaults instantiates a new Tag object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewUpdateVDBParameters instantiates a new UpdateVDBParameters object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewUpdateVDBParametersWithDefaults instantiates a new UpdateVDBParameters object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVDB instantiates a new VDB object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVDBGroup instantiates a new VDBGroup object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed.
NewVDBGroupWithDefaults instantiates a new VDBGroup object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
NewVDBWithDefaults instantiates a new VDB object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set.
PtrBool is a helper routine that returns a pointer to given boolean value.
PtrFloat32 is a helper routine that returns a pointer to given float value.
PtrFloat64 is a helper routine that returns a pointer to given float value.
PtrInt is a helper routine that returns a pointer to given integer value.
PtrInt32 is a helper routine that returns a pointer to given integer value.
PtrInt64 is a helper routine that returns a pointer to given integer value.
PtrString is a helper routine that returns a pointer to given string value.
PtrTime is helper routine that returns a pointer to given Time value.
# Variables
ContextAccessToken takes a string oauth2 access token as authentication for the request.
ContextAPIKeys takes a string apikey as authentication for the request.
ContextBasicAuth takes BasicAuth as authentication for the request.
ContextHttpSignatureAuth takes HttpSignatureAuth as authentication for the request.
ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
ContextOperationServerIndices uses a server configuration from the index mapping.
ContextOperationServerVariables overrides a server configuration variables using operation specific values.
ContextServerIndex uses a server configuration from the index.
ContextServerVariables overrides a server configuration variables.
# Structs
No description provided by the author
ApiClient struct for ApiClient.
APIClient manages communication with the Delphix API Gateway API v1.0 In most cases there should be only one, shared, APIClient.
ApiClientCreateParameter struct for ApiClientCreateParameter.
ApiClientCreateResponse struct for ApiClientCreateResponse.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIKey provides API key based authentication to a request passed via context using ContextAPIKey.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
APIResponse stores the API response returned by the server.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BaseProvisionVDBParameters struct for BaseProvisionVDBParameters.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Bookmark A Data Control Tower object that references points in time for one or more datasets.
Configuration stores the configuration of the API client.
CreateBookmarkResponse struct for CreateBookmarkResponse.
CreateEnvironmentResponse struct for CreateEnvironmentResponse.
CreateVDBGroupRequest struct for CreateVDBGroupRequest.
CreateVDBGroupResponse struct for CreateVDBGroupResponse.
DataPointBySnapshotParameters struct for DataPointBySnapshotParameters.
DataPointByTimestampParameters struct for DataPointByTimestampParameters.
DeleteEngineResponse struct for DeleteEngineResponse.
DeleteEnvironmentResponse struct for DeleteEnvironmentResponse.
DeleteVDBParameters Parameters to delete a VDB.
DeleteVDBResponse struct for DeleteVDBResponse.
DisableEnvironmentResponse struct for DisableEnvironmentResponse.
DisableVDBParameters Parameters to disable a VDB.
DisableVDBResponse struct for DisableVDBResponse.
DSource The Delphix storage-based copy of the source databse including its history.
EnableEnvironmentResponse struct for EnableEnvironmentResponse.
EnableVDBParameters Parameters to enable a VDB.
EnableVDBResponse struct for EnableVDBResponse.
Engine A Delphix Virtualization or Masking Engine.
EngineConnectivityCheckRequest Parameters to check connectivity between engine and remote host.
EngineConnectivityCheckResponse Response received for connectivity status check.
EngineRegistrationParameter Parameters to register and authenticate an engine.
Environment A grouping of a single host or a cluster of hosts.
EnvironmentCreateParameters struct for EnvironmentCreateParameters.
Error struct for Error.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
HashicorpVault Configuration required to connect and authenticate with an Hashicorp Vault which stores engines username and passwords.
Hook struct for Hook.
Host A physical/virtual server.
Job An asynchronous task.
ListBookmarksByVDBGroupsResponse struct for ListBookmarksByVDBGroupsResponse.
ListBookmarksResponse struct for ListBookmarksResponse.
ListDSourcesResponse struct for ListDSourcesResponse.
ListEnvironmentsResponse struct for ListEnvironmentsResponse.
ListSnaphotsResponse struct for ListSnaphotsResponse.
ListSourcesResponse struct for ListSourcesResponse.
ListVDBGroupsByBookmarkResponse struct for ListVDBGroupsByBookmarkResponse.
ListVDBGroupsResponse struct for ListVDBGroupsResponse.
ListVDBsResponse struct for ListVDBsResponse.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
PaginatedResponseMetadata struct for PaginatedResponseMetadata.
ProvisionVDBBySnapshotParameters struct for ProvisionVDBBySnapshotParameters.
ProvisionVDBByTimestampParameters struct for ProvisionVDBByTimestampParameters.
ProvisionVDBByTimestampParametersAllOf struct for ProvisionVDBByTimestampParametersAllOf.
ProvisionVDBResponse struct for ProvisionVDBResponse.
RefreshEnvironmentResponse struct for RefreshEnvironmentResponse.
RefreshVDBBySnapshotParameters struct for RefreshVDBBySnapshotParameters.
RefreshVDBBySnapshotResponse struct for RefreshVDBBySnapshotResponse.
RefreshVDBByTimestampParameters struct for RefreshVDBByTimestampParameters.
RefreshVDBByTimestampResponse struct for RefreshVDBByTimestampResponse.
RegisteredEngine A registered engine's connection and authentication settings.
RollbackVDBBySnapshotParameters struct for RollbackVDBBySnapshotParameters.
RollbackVDBBySnapshotResponse struct for RollbackVDBBySnapshotResponse.
RollbackVDBByTimestampParameters struct for RollbackVDBByTimestampParameters.
RollbackVDBByTimestampResponse struct for RollbackVDBByTimestampResponse.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.
Snapshot Virtualization Engine Snapshot of a dSource or VDB.
Source The Delphix representation of the source database (not typically managed by Delphix).
StartVDBResponse struct for StartVDBResponse.
StopVDBResponse struct for StopVDBResponse.
Tag struct for Tag.
TagsRequest struct for TagsRequest.
TagsResponse struct for TagsResponse.
UpdateVDBParameters Parameters to update a VDB.
VDB A Delphix virtual database or dataset.
VDBGroup A collection of virtual databases and datesets.
# Type aliases
ApiClientsApiService ApiClientsApi service.
BookmarksApiService BookmarksApi service.
DSourcesApiService DSourcesApi service.
EnginesApiService EnginesApi service.
EnvironmentsApiService EnvironmentsApi service.
JobsApiService JobsApi service.
ManagementApiService ManagementApi service.
ServerConfigurations stores multiple ServerConfiguration items.
SnapshotsApiService SnapshotsApi service.
SourcesApiService SourcesApi service.
VDBGroupsApiService VDBGroupsApi service.
VDBsApiService VDBsApi service.