# README

Go API client for data_views

OpenAPI schema for data view endpoints

Overview

This API client was generated by the OpenAPI Generator project. By using the OpenAPI-spec from a remote server, you can easily generate an API client.

API version: 0.1
Package version: 1.0.0
Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

go get github.com/stretchr/testify/assert
go get golang.org/x/net/context

Put the package under your project folder and add the following in import:

import data_views "github.com/elastic/terraform-provider-elasticstack/data_views"

To use a proxy, set the environment variable HTTP_PROXY:

os.Setenv("HTTP_PROXY", "http://proxy_name:proxy_port")

Configuration of Server URL

Default configuration comes with Servers field that contains server objects as defined in the OpenAPI specification.

Select Server Configuration

For using other server than the one defined on index 0 set context value sw.ContextServerIndex of type int.

ctx := context.WithValue(context.Background(), data_views.ContextServerIndex, 1)

Templated Server URL

Templated server URL is formatted using default variables from configuration or from context value sw.ContextServerVariables of type map[string]string.

ctx := context.WithValue(context.Background(), data_views.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

Note, enum values are always validated and all unused variables are silently ignored.

URLs Configuration per Operation

Each operation can use different server URL defined using OperationServers map in the Configuration. An operation is uniquely identified by "{classname}Service.{nickname}" string. Similar rules for overriding default operation server index and variables applies by using sw.ContextOperationServerIndices and sw.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), data_views.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), data_views.ContextOperationServerVariables, map[string]map[string]string{
	"{classname}Service.{nickname}": {
		"port": "8443",
	},
})

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
DataViewsAPI	CreateDataView	Post /s/{spaceId}/api/data_views/data_view	Creates a data view.
DataViewsAPI	CreateRuntimeField	Post /s/{spaceId}/api/data_views/data_view/{viewId}/runtime_field	Creates a runtime field.
DataViewsAPI	CreateUpdateRuntimeField	Put /s/{spaceId}/api/data_views/data_view/{viewId}/runtime_field	Create or update an existing runtime field.
DataViewsAPI	DeleteDataView	Delete /s/{spaceId}/api/data_views/data_view/{viewId}	Deletes a data view.
DataViewsAPI	DeleteRuntimeField	Delete /s/{spaceId}/api/data_views/data_view/{viewId}/runtime_field/{fieldName}	Delete a runtime field from a data view.
DataViewsAPI	GetAllDataViews	Get /s/{spaceId}/api/data_views	Retrieves a list of all data views.
DataViewsAPI	GetDataView	Get /s/{spaceId}/api/data_views/data_view/{viewId}	Retrieves a single data view by identifier.
DataViewsAPI	GetDefaultDataView	Get /s/{spaceId}/api/data_views/default	Retrieves the default data view identifier.
DataViewsAPI	GetRuntimeField	Get /s/{spaceId}/api/data_views/data_view/{viewId}/runtime_field/{fieldName}	Retrieves a runtime field.
DataViewsAPI	SetDefaultDatailView	Post /s/{spaceId}/api/data_views/default	Sets the default data view identifier.
DataViewsAPI	UpdateDataView	Post /s/{spaceId}/api/data_views/data_view/{viewId}	Updates a data view.
DataViewsAPI	UpdateFieldsMetadata	Post /s/{spaceId}/api/data_views/data_view/{viewId}/fields	Update fields presentation metadata such as count, customLabel and format.
DataViewsAPI	UpdateRuntimeField	Post /s/{spaceId}/api/data_views/data_view/{viewId}/runtime_field/{fieldName}	Update an existing runtime field.

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

basicAuth

Type: HTTP basic authentication

Example

auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{
    UserName: "username",
    Password: "password",
})
r, err := client.Service.Operation(auth, args)

apiKeyAuth

Type: API key
API key parameter name: Authorization
Location: HTTP header

Note, each API key must be added to a map of map[string]APIKey where the key is: Authorization and passed in as the auth context for each request.

Example

auth := context.WithValue(
		context.Background(),
		sw.ContextAPIKeys,
		map[string]sw.APIKey{
			"Authorization": {Key: "API_KEY_STRING"},
		},
	)
r, err := client.Service.Operation(auth, args)

Documentation for Utility Methods

Due to the fact that model structure members are all pointers, this package contains a number of utility functions to easily obtain pointers to values of basic types. Each of these functions takes a value of the given basic type and returns a pointer to it:

PtrBool
PtrInt
PtrInt32
PtrInt64
PtrFloat
PtrFloat32
PtrFloat64
PtrString
PtrTime