Categorygithub.com/ionos-cloud/sdk-go-logging
modulepackage
1.0.1
Repository: https://github.com/ionos-cloud/sdk-go-logging.git
Documentation: pkg.go.dev

# README

Go API client for ionoscloud

Logging as a Service (LaaS) is a service that provides a centralized logging system where users are able to push and aggregate their system or application logs. This service also provides a visualization platform where users are able to observe, search and filter the logs and also create dashboards and alerts for their data points. This service can be managed through a browser-based "Data Center Designer" (DCD) tool or via an API. The API allows you to create logging pipelines or modify existing ones. It is designed to allow users to leverage the same power and flexibility found within the DCD visual tool. Both tools are consistent with their concepts and lend well to making the experience smooth and intuitive.

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.0.1
  • Package version: 1.0.1
  • 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 ionoscloud "github.com/ionos-cloud/sdk-go-logging"

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(), ionoscloud.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(), ionoscloud.ContextServerVariables, map[string]string{
	"basePath": "v2",
})

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

Documentation for API Endpoints

All URIs are relative to https://logging.de-txl.ionos.com

ClassMethodHTTP requestDescription
PipelinesApiPipelinesDeleteDelete /pipelines/{pipelineId}Delete a pipeline
PipelinesApiPipelinesFindByIdGet /pipelines/{pipelineId}Fetch a pipeline
PipelinesApiPipelinesGetGet /pipelinesList pipelines
PipelinesApiPipelinesKeyPostPost /pipelines/{pipelineId}/keyRenews the key of a Pipeline
PipelinesApiPipelinesPatchPatch /pipelines/{pipelineId}Patch a pipeline
PipelinesApiPipelinesPostPost /pipelinesCreate a pipeline

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

tokenAuth

  • 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

Author

# Functions

AddPinnedCert - enables pinning of the sha256 public fingerprint to the http client's transport.
CacheExpires helper function to determine remaining time before repeating a request.
IsNil checks if an input is nil.
NewAPIClient creates a new API client.
NewAPIResponse returns a new APIResponse object.
NewAPIResponseWithError returns a new APIResponse object with the provided error message.
NewConfiguration returns a new Configuration object.
No description provided by the author
No description provided by the author
NewDestination instantiates a new Destination 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.
NewDestinationWithDefaults instantiates a new Destination 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.
NewErrorMessage instantiates a new ErrorMessage 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.
NewErrorMessageWithDefaults instantiates a new ErrorMessage 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.
NewErrorResponse instantiates a new ErrorResponse 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.
NewErrorResponseWithDefaults instantiates a new ErrorResponse 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.
NewGenericOpenAPIError - constructor for GenericOpenAPIError.
NewMetadata instantiates a new Metadata 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.
NewMetadataWithDefaults instantiates a new Metadata 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
NewPipeline instantiates a new Pipeline 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.
NewPipelineCreate instantiates a new PipelineCreate 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.
NewPipelineCreateProperties instantiates a new PipelineCreateProperties 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.
NewPipelineCreatePropertiesLogs instantiates a new PipelineCreatePropertiesLogs 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.
NewPipelineCreatePropertiesLogsWithDefaults instantiates a new PipelineCreatePropertiesLogs 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.
NewPipelineCreatePropertiesWithDefaults instantiates a new PipelineCreateProperties 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.
NewPipelineCreateWithDefaults instantiates a new PipelineCreate 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.
NewPipelineListResponse instantiates a new PipelineListResponse 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.
NewPipelineListResponseWithDefaults instantiates a new PipelineListResponse 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.
NewPipelinePatch instantiates a new PipelinePatch 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.
NewPipelinePatchProperties instantiates a new PipelinePatchProperties 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.
NewPipelinePatchPropertiesWithDefaults instantiates a new PipelinePatchProperties 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.
NewPipelinePatchWithDefaults instantiates a new PipelinePatch 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.
NewPipelineProperties instantiates a new PipelineProperties 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.
NewPipelinePropertiesWithDefaults instantiates a new PipelineProperties 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.
NewPipelineResponse instantiates a new PipelineResponse 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.
NewPipelineResponseAllOf instantiates a new PipelineResponseAllOf 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.
NewPipelineResponseAllOf1 instantiates a new PipelineResponseAllOf1 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.
NewPipelineResponseAllOf1WithDefaults instantiates a new PipelineResponseAllOf1 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.
NewPipelineResponseAllOfWithDefaults instantiates a new PipelineResponseAllOf 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.
NewPipelineResponseWithDefaults instantiates a new PipelineResponse 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.
NewPipelinesKeyPost200Response instantiates a new PipelinesKeyPost200Response 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.
NewPipelinesKeyPost200ResponseWithDefaults instantiates a new PipelinesKeyPost200Response 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.
NewPipelineWithDefaults instantiates a new Pipeline 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.
NewProcessor instantiates a new Processor 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.
NewProcessorWithDefaults instantiates a new Processor 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 - returns a pointer to given boolean value.
PtrFloat32 - returns a pointer to given float value.
PtrFloat64 - returns a pointer to given float value.
PtrInt - returns a pointer to given integer value.
PtrInt32 - returns a pointer to given integer value.
PtrInt64 - returns a pointer to given integer value.
PtrString - returns a pointer to given string value.
PtrTime - returns a pointer to given Time value.
No description provided by the author
ToBool - returns the value of the bool pointer passed in.
ToBoolDefault - returns the value of the bool pointer passed in, or false if the pointer is nil.
ToBoolSlice - returns a bool slice of the pointer passed in.
ToByte - returns the value of the byte pointer passed in.
ToByteDefault - returns the value of the byte pointer passed in, or 0 if the pointer is nil.
ToByteSlice - returns a byte slice of the pointer passed in.
ToFloat32 - returns the value of the float32 pointer passed in.
ToFloat32Default - returns the value of the float32 pointer passed in, or 0 if the pointer is nil.
ToFloat32Slice - returns a float32 slice of the pointer passed in.
ToFloat64 - returns the value of the float64 pointer passed in.
ToFloat64Default - returns the value of the float64 pointer passed in, or 0 if the pointer is nil.
ToFloat64Slice - returns a float64 slice of the pointer passed in.
ToInt - returns the value of the int pointer passed in.
ToInt16 - returns the value of the int16 pointer passed in.
ToInt16Default - returns the value of the int16 pointer passed in, or 0 if the pointer is nil.
ToInt16Slice - returns a int16 slice of the pointer passed in.
ToInt32 - returns the value of the int32 pointer passed in.
ToInt32Default - returns the value of the int32 pointer passed in, or 0 if the pointer is nil.
ToInt32Slice - returns a int32 slice of the pointer passed in.
ToInt64 - returns the value of the int64 pointer passed in.
ToInt64Default - returns the value of the int64 pointer passed in, or 0 if the pointer is nil.
ToInt64Slice - returns a int64 slice of the pointer passed in.
ToInt8 - returns the value of the int8 pointer passed in.
ToInt8Default - returns the value of the int8 pointer passed in, or 0 if the pointer is nil.
ToInt8Slice - returns a int8 slice of the pointer passed in.
ToIntDefault - returns the value of the int pointer passed in, or 0 if the pointer is nil.
ToIntSlice - returns a int slice of the pointer passed in.
ToPtr - returns a pointer to the given value.
ToString - returns the value of the string pointer passed in.
ToStringDefault - returns the value of the string pointer passed in, or "" if the pointer is nil.
ToStringSlice - returns a string slice of the pointer passed in.
ToTime - returns the value of the Time pointer passed in.
ToTimeDefault - returns the value of the Time pointer passed in, or 0001-01-01 00:00:00 +0000 UTC if the pointer is nil.
ToTimeSlice - returns a Time slice of the pointer passed in.
ToUint - returns the value of the uint pointer passed in.
ToUint16 - returns the value of the uint16 pointer passed in.
ToUint16Default - returns the value of the uint16 pointer passed in, or 0 if the pointer is nil.
ToUint16Slice - returns a uint16 slice of the pointer passed in.
ToUint32 - returns the value of the uint32 pointer passed in.
ToUint32Default - returns the value of the uint32 pointer passed in, or 0 if the pointer is nil.
ToUint32Slice - returns a uint32 slice of the pointer passed in.
ToUint64 - returns the value of the uint64 pointer passed in.
ToUint64Default - returns the value of the uint64 pointer passed in, or 0 if the pointer is nil.
ToUint64Slice - returns a uint63 slice of the pointer passed in.
ToUint8 -returns the value of the uint8 pointer passed in.
ToUint8Default - returns the value of the uint8 pointer passed in, or 0 if the pointer is nil.
ToUint8Slice - returns a uint8 slice of the pointer passed in.
ToUintDefault - returns the value of the uint pointer passed in, or 0 if the pointer is nil.
ToUintSlice - returns a uint slice of the pointer passed in.
ToValue - returns the value of the pointer passed in.
ToValueDefault - returns the value of the pointer passed in, or the default type value if the pointer is nil.

# Constants

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
Trace We recommend you only set this field for debugging purposes.
No description provided by the author

# 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.
No description provided by the author

# Structs

APIClient manages communication with the IONOS Logging REST API API v0.0.1 In most cases there should be only one, shared, APIClient.
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.
BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth.
Configuration stores the configuration of the API client.
Destination The information of the logging aggregator storage.
ErrorMessage struct for ErrorMessage.
ErrorResponse struct for ErrorResponse.
GenericOpenAPIError Provides access to the body, error and model on returned errors.
No description provided by the author
Metadata Metadata of the resource.
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
Pipeline pipeline response.
PipelineCreate Request payload with all data needed to create a new logging pipeline.
PipelineCreateProperties Create pipeline properties.
PipelineCreatePropertiesLogs struct for PipelineCreatePropertiesLogs.
PipelineListResponse List of pipelines.
PipelinePatch Request payload with any data that is possible to patch a logging pipeline.
PipelinePatchProperties Patch pipeline properties.
PipelineProperties A pipeline properties.
PipelineResponse struct for PipelineResponse.
PipelineResponseAllOf struct for PipelineResponseAllOf.
PipelineResponseAllOf1 struct for PipelineResponseAllOf1.
PipelinesKeyPost200Response struct for PipelinesKeyPost200Response.
Processor struct for Processor.
ServerConfiguration stores the information about a server.
ServerVariable stores the information about a server variable.

# Interfaces

No description provided by the author

# Type aliases

No description provided by the author
PipelinesApiService PipelinesApi service.
ServerConfigurations stores multiple ServerConfiguration items.
TLSDial can be assigned to a http.Transport's DialTLS field.