client

package module
v1.1.3 Latest Latest
Warning

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

Go to latest
Published: Apr 13, 2022 License: MPL-2.0 Imports: 0 Imported by: 0

README

constellix-go-client

This repository contains the golang client SDK to interact with Constellix DNS Platform using REST API calls. This SDK is used by terraform-provider-constellix.

Installation

Use go get to retrieve the SDK to add it to your GOPATH workspace, or project's Go module dependencies.

$go get github.com/Constellix/constellix-go-client

There are no additional dependancies needed to be installed.

Overview

  • client :- This package contains the HTTP Client configuration as well as service methods which serves the CRUD operations on the DNS Objects in Constellix DNS platform.

  • models :- This package contains all the models structs and utility methods for the same.

How to Use

import the client in your go application and retrive the client object by calling client.GetClient() method.

import github.com/Constellix/constellix-go-client/client
client.GetClient("apikey", "secretkey", client.Insecure(true/false))

Use that client object to call the service methods to perform the CRUD operations on the model objects.

Example,

    client.Save(obj<type interface>,endpoint<type string>)

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL