\AdminAPI

All URIs are relative to http://localhost:8080

Health

HealthResponse Health(ctx).Execute()

Liveness probe

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AdminAPI.Health(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdminAPI.Health``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Health`: HealthResponse
	fmt.Fprintf(os.Stdout, "Response from `AdminAPI.Health`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiHealthRequest struct via the builder pattern

Return type

HealthResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Metrics

string Metrics(ctx).Execute()

Prometheus metrics

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AdminAPI.Metrics(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdminAPI.Metrics``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Metrics`: string
	fmt.Fprintf(os.Stdout, "Response from `AdminAPI.Metrics`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiMetricsRequest struct via the builder pattern

Return type

string

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: text/plain, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModelsCount

ModelCountResponse ModelsCount(ctx).Execute()

Current model count

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AdminAPI.ModelsCount(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdminAPI.ModelsCount``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ModelsCount`: ModelCountResponse
	fmt.Fprintf(os.Stdout, "Response from `AdminAPI.ModelsCount`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiModelsCountRequest struct via the builder pattern

Return type

ModelCountResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Ready

ReadyResponse Ready(ctx).Execute()

Readiness probe

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AdminAPI.Ready(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdminAPI.Ready``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Ready`: ReadyResponse
	fmt.Fprintf(os.Stdout, "Response from `AdminAPI.Ready`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiReadyRequest struct via the builder pattern

Return type

ReadyResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Status

map[string]interface{} Status(ctx).Execute()

Runtime status

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AdminAPI.Status(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdminAPI.Status``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Status`: map[string]interface{}
	fmt.Fprintf(os.Stdout, "Response from `AdminAPI.Status`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiStatusRequest struct via the builder pattern

Return type

map[string]interface{}

Authorization

bearerAuth

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Version

VersionResponse Version(ctx).Execute()

Service and OpenAPI version

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.AdminAPI.Version(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `AdminAPI.Version``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `Version`: VersionResponse
	fmt.Fprintf(os.Stdout, "Response from `AdminAPI.Version`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiVersionRequest struct via the builder pattern

Return type

VersionResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateRequest

Properties

Methods

NewCreateRequest

func NewCreateRequest(payload map[string]interface{}, ) *CreateRequest

NewCreateRequest instantiates a new CreateRequest 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

NewCreateRequestWithDefaults

func NewCreateRequestWithDefaults() *CreateRequest

NewCreateRequestWithDefaults instantiates a new CreateRequest 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

GetPayload

func (o *CreateRequest) GetPayload() map[string]interface{}

GetPayload returns the Payload field if non-nil, zero value otherwise.

GetPayloadOk

func (o *CreateRequest) GetPayloadOk() (*map[string]interface{}, bool)

GetPayloadOk returns a tuple with the Payload field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPayload

func (o *CreateRequest) SetPayload(v map[string]interface{})

SetPayload sets Payload field to given value.

[Back to Model list] [Back to API list] [Back to README]

\DiscoveryAPI

All URIs are relative to http://localhost:8080

ListModels

ModelsResponse ListModels(ctx).Execute()

List available model versions

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.DiscoveryAPI.ListModels(context.Background()).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `DiscoveryAPI.ListModels``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ListModels`: ModelsResponse
	fmt.Fprintf(os.Stdout, "Response from `DiscoveryAPI.ListModels`: %v\n", resp)
}

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to a apiListModelsRequest struct via the builder pattern

Return type

ModelsResponse

Authorization

No authorization required

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ErrorResponse

Properties

Methods

NewErrorResponse

func NewErrorResponse(code string, message string, ) *ErrorResponse

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

func NewErrorResponseWithDefaults() *ErrorResponse

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

GetCode

func (o *ErrorResponse) GetCode() string

GetCode returns the Code field if non-nil, zero value otherwise.

GetCodeOk

func (o *ErrorResponse) GetCodeOk() (*string, bool)

GetCodeOk returns a tuple with the Code field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetCode

func (o *ErrorResponse) SetCode(v string)

SetCode sets Code field to given value.

GetMessage

func (o *ErrorResponse) GetMessage() string

GetMessage returns the Message field if non-nil, zero value otherwise.

GetMessageOk

func (o *ErrorResponse) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMessage

func (o *ErrorResponse) SetMessage(v string)

SetMessage sets Message field to given value.

GetDetails

func (o *ErrorResponse) GetDetails() interface{}

GetDetails returns the Details field if non-nil, zero value otherwise.

GetDetailsOk

func (o *ErrorResponse) GetDetailsOk() (*interface{}, bool)

GetDetailsOk returns a tuple with the Details field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDetails

func (o *ErrorResponse) SetDetails(v interface{})

SetDetails sets Details field to given value.

HasDetails

func (o *ErrorResponse) HasDetails() bool

HasDetails returns a boolean if a field has been set.

SetDetailsNil

func (o *ErrorResponse) SetDetailsNil(b bool)

SetDetailsNil sets the value for Details to be an explicit nil

UnsetDetails

func (o *ErrorResponse) UnsetDetails()

UnsetDetails ensures that no value is present for Details, not even an explicit nil

[Back to Model list] [Back to API list] [Back to README]

HealthResponse

Properties

Methods

NewHealthResponse

func NewHealthResponse(status string, ) *HealthResponse

NewHealthResponse instantiates a new HealthResponse 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

NewHealthResponseWithDefaults

func NewHealthResponseWithDefaults() *HealthResponse

NewHealthResponseWithDefaults instantiates a new HealthResponse 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

GetStatus

func (o *HealthResponse) GetStatus() string

GetStatus returns the Status field if non-nil, zero value otherwise.

GetStatusOk

func (o *HealthResponse) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStatus

func (o *HealthResponse) SetStatus(v string)

SetStatus sets Status field to given value.

[Back to Model list] [Back to API list] [Back to README]

ModelCountResponse

Properties

Methods

NewModelCountResponse

func NewModelCountResponse(modelsCount int64, ) *ModelCountResponse

NewModelCountResponse instantiates a new ModelCountResponse 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

NewModelCountResponseWithDefaults

func NewModelCountResponseWithDefaults() *ModelCountResponse

NewModelCountResponseWithDefaults instantiates a new ModelCountResponse 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

GetModelsCount

func (o *ModelCountResponse) GetModelsCount() int64

GetModelsCount returns the ModelsCount field if non-nil, zero value otherwise.

GetModelsCountOk

func (o *ModelCountResponse) GetModelsCountOk() (*int64, bool)

GetModelsCountOk returns a tuple with the ModelsCount field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetModelsCount

func (o *ModelCountResponse) SetModelsCount(v int64)

SetModelsCount sets ModelsCount field to given value.

[Back to Model list] [Back to API list] [Back to README]

ModelVersion

Properties

Methods

NewModelVersion

func NewModelVersion(id string, version string, ) *ModelVersion

NewModelVersion instantiates a new ModelVersion 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

NewModelVersionWithDefaults

func NewModelVersionWithDefaults() *ModelVersion

NewModelVersionWithDefaults instantiates a new ModelVersion 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

GetId

func (o *ModelVersion) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *ModelVersion) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *ModelVersion) SetId(v string)

SetId sets Id field to given value.

GetVersion

func (o *ModelVersion) GetVersion() string

GetVersion returns the Version field if non-nil, zero value otherwise.

GetVersionOk

func (o *ModelVersion) GetVersionOk() (*string, bool)

GetVersionOk returns a tuple with the Version field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVersion

func (o *ModelVersion) SetVersion(v string)

SetVersion sets Version field to given value.

[Back to Model list] [Back to API list] [Back to README]

\ModelsAPI

All URIs are relative to http://localhost:8080

CreateRecord

Record CreateRecord(ctx, model, version).IdempotencyKey(idempotencyKey).CreateRequest(createRequest).Execute()

Validate and create a record

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {
	model := "model_example" // string | Model identifier.
	version := "version_example" // string | Model version.
	idempotencyKey := "idempotencyKey_example" // string | Client-generated key used to deduplicate retries for side-effecting requests.
	createRequest := *openapiclient.NewCreateRequest(map[string]interface{}{"key": interface{}(123)}) // CreateRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ModelsAPI.CreateRecord(context.Background(), model, version).IdempotencyKey(idempotencyKey).CreateRequest(createRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ModelsAPI.CreateRecord``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `CreateRecord`: Record
	fmt.Fprintf(os.Stdout, "Response from `ModelsAPI.CreateRecord`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiCreateRecordRequest struct via the builder pattern

idempotencyKey | string | Client-generated key used to deduplicate retries for side-effecting requests. | createRequest | CreateRequest | |

Return type

Record

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

QueryRecords

QueryResponse QueryRecords(ctx, model, version).QueryRequest(queryRequest).Execute()

Query records for a model version

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {
	model := "model_example" // string | Model identifier.
	version := "version_example" // string | Model version.
	queryRequest := *openapiclient.NewQueryRequest(*openapiclient.NewRecordQueryFilter([]openapiclient.RecordQueryCondition{*openapiclient.NewRecordQueryCondition("Field_example", "Op_example", interface{}(123))})) // QueryRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ModelsAPI.QueryRecords(context.Background(), model, version).QueryRequest(queryRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ModelsAPI.QueryRecords``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `QueryRecords`: QueryResponse
	fmt.Fprintf(os.Stdout, "Response from `ModelsAPI.QueryRecords`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiQueryRecordsRequest struct via the builder pattern

queryRequest | QueryRequest | |

Return type

QueryResponse

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ValidateModelPayload

ValidationReport ValidateModelPayload(ctx, model, version).ValidateRequest(validateRequest).Execute()

Validate payload against model rules

Example

package main

import (
	"context"
	"fmt"
	"os"
	openapiclient "github.com/CE-RISE-software/hex-core-sdk-go"
)

func main() {
	model := "model_example" // string | Model identifier, for example `re-indicators-specification`.
	version := "version_example" // string | Model version string, for example `0.0.3`.
	validateRequest := *openapiclient.NewValidateRequest(map[string]interface{}{"key": interface{}(123)}) // ValidateRequest | 

	configuration := openapiclient.NewConfiguration()
	apiClient := openapiclient.NewAPIClient(configuration)
	resp, r, err := apiClient.ModelsAPI.ValidateModelPayload(context.Background(), model, version).ValidateRequest(validateRequest).Execute()
	if err != nil {
		fmt.Fprintf(os.Stderr, "Error when calling `ModelsAPI.ValidateModelPayload``: %v\n", err)
		fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r)
	}
	// response from `ValidateModelPayload`: ValidationReport
	fmt.Fprintf(os.Stdout, "Response from `ModelsAPI.ValidateModelPayload`: %v\n", resp)
}

Path Parameters

Other Parameters

Other parameters are passed through a pointer to a apiValidateModelPayloadRequest struct via the builder pattern

validateRequest | ValidateRequest | |

Return type

ValidationReport

Authorization

bearerAuth

HTTP request headers

• Content-Type: application/json
• Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ModelsResponse

Properties

Methods

NewModelsResponse

func NewModelsResponse(models []ModelVersion, ) *ModelsResponse

NewModelsResponse instantiates a new ModelsResponse 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

NewModelsResponseWithDefaults

func NewModelsResponseWithDefaults() *ModelsResponse

NewModelsResponseWithDefaults instantiates a new ModelsResponse 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

GetModels

func (o *ModelsResponse) GetModels() []ModelVersion

GetModels returns the Models field if non-nil, zero value otherwise.

GetModelsOk

func (o *ModelsResponse) GetModelsOk() (*[]ModelVersion, bool)

GetModelsOk returns a tuple with the Models field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetModels

func (o *ModelsResponse) SetModels(v []ModelVersion)

SetModels sets Models field to given value.

[Back to Model list] [Back to API list] [Back to README]

QueryRequest

Properties

Methods

NewQueryRequest

func NewQueryRequest(filter RecordQueryFilter, ) *QueryRequest

NewQueryRequest instantiates a new QueryRequest 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

NewQueryRequestWithDefaults

func NewQueryRequestWithDefaults() *QueryRequest

NewQueryRequestWithDefaults instantiates a new QueryRequest 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

GetFilter

func (o *QueryRequest) GetFilter() RecordQueryFilter

GetFilter returns the Filter field if non-nil, zero value otherwise.

GetFilterOk

func (o *QueryRequest) GetFilterOk() (*RecordQueryFilter, bool)

GetFilterOk returns a tuple with the Filter field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetFilter

func (o *QueryRequest) SetFilter(v RecordQueryFilter)

SetFilter sets Filter field to given value.

[Back to Model list] [Back to API list] [Back to README]

QueryResponse

Properties

Methods

NewQueryResponse

func NewQueryResponse(records []Record, ) *QueryResponse

NewQueryResponse instantiates a new QueryResponse 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

NewQueryResponseWithDefaults

func NewQueryResponseWithDefaults() *QueryResponse

NewQueryResponseWithDefaults instantiates a new QueryResponse 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

GetRecords

func (o *QueryResponse) GetRecords() []Record

GetRecords returns the Records field if non-nil, zero value otherwise.

GetRecordsOk

func (o *QueryResponse) GetRecordsOk() (*[]Record, bool)

GetRecordsOk returns a tuple with the Records field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetRecords

func (o *QueryResponse) SetRecords(v []Record)

SetRecords sets Records field to given value.

[Back to Model list] [Back to API list] [Back to README]

ReadyResponse

Properties

Methods

NewReadyResponse

func NewReadyResponse(status string, ) *ReadyResponse

NewReadyResponse instantiates a new ReadyResponse 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

NewReadyResponseWithDefaults

func NewReadyResponseWithDefaults() *ReadyResponse

NewReadyResponseWithDefaults instantiates a new ReadyResponse 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

GetStatus

func (o *ReadyResponse) GetStatus() string

GetStatus returns the Status field if non-nil, zero value otherwise.

GetStatusOk

func (o *ReadyResponse) GetStatusOk() (*string, bool)

GetStatusOk returns a tuple with the Status field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetStatus

func (o *ReadyResponse) SetStatus(v string)

SetStatus sets Status field to given value.

[Back to Model list] [Back to API list] [Back to README]

Record

Properties

Methods

NewRecord

func NewRecord(id string, model string, version string, payload map[string]interface{}, ) *Record

NewRecord instantiates a new Record 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

NewRecordWithDefaults

func NewRecordWithDefaults() *Record

NewRecordWithDefaults instantiates a new Record 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

GetId

func (o *Record) GetId() string

GetId returns the Id field if non-nil, zero value otherwise.

GetIdOk

func (o *Record) GetIdOk() (*string, bool)

GetIdOk returns a tuple with the Id field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetId

func (o *Record) SetId(v string)

SetId sets Id field to given value.

GetModel

func (o *Record) GetModel() string

GetModel returns the Model field if non-nil, zero value otherwise.

GetModelOk

func (o *Record) GetModelOk() (*string, bool)

GetModelOk returns a tuple with the Model field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetModel

func (o *Record) SetModel(v string)

SetModel sets Model field to given value.

GetVersion

func (o *Record) GetVersion() string

GetVersion returns the Version field if non-nil, zero value otherwise.

GetVersionOk

func (o *Record) GetVersionOk() (*string, bool)

GetVersionOk returns a tuple with the Version field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetVersion

func (o *Record) SetVersion(v string)

SetVersion sets Version field to given value.

GetPayload

func (o *Record) GetPayload() map[string]interface{}

GetPayload returns the Payload field if non-nil, zero value otherwise.

GetPayloadOk

func (o *Record) GetPayloadOk() (*map[string]interface{}, bool)

GetPayloadOk returns a tuple with the Payload field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPayload

func (o *Record) SetPayload(v map[string]interface{})

SetPayload sets Payload field to given value.

[Back to Model list] [Back to API list] [Back to README]

RecordQueryCondition

Properties

Methods

NewRecordQueryCondition

func NewRecordQueryCondition(field string, op string, value interface{}, ) *RecordQueryCondition

NewRecordQueryCondition instantiates a new RecordQueryCondition 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

NewRecordQueryConditionWithDefaults

func NewRecordQueryConditionWithDefaults() *RecordQueryCondition

NewRecordQueryConditionWithDefaults instantiates a new RecordQueryCondition 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

GetField

func (o *RecordQueryCondition) GetField() string

GetField returns the Field field if non-nil, zero value otherwise.

GetFieldOk

func (o *RecordQueryCondition) GetFieldOk() (*string, bool)

GetFieldOk returns a tuple with the Field field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetField

func (o *RecordQueryCondition) SetField(v string)

SetField sets Field field to given value.

GetOp

func (o *RecordQueryCondition) GetOp() string

GetOp returns the Op field if non-nil, zero value otherwise.

GetOpOk

func (o *RecordQueryCondition) GetOpOk() (*string, bool)

GetOpOk returns a tuple with the Op field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOp

func (o *RecordQueryCondition) SetOp(v string)

SetOp sets Op field to given value.

GetValue

func (o *RecordQueryCondition) GetValue() interface{}

GetValue returns the Value field if non-nil, zero value otherwise.

GetValueOk

func (o *RecordQueryCondition) GetValueOk() (*interface{}, bool)

GetValueOk returns a tuple with the Value field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetValue

func (o *RecordQueryCondition) SetValue(v interface{})

SetValue sets Value field to given value.

SetValueNil

func (o *RecordQueryCondition) SetValueNil(b bool)

SetValueNil sets the value for Value to be an explicit nil

UnsetValue

func (o *RecordQueryCondition) UnsetValue()

UnsetValue ensures that no value is present for Value, not even an explicit nil

[Back to Model list] [Back to API list] [Back to README]

RecordQueryFilter

Properties

Methods

NewRecordQueryFilter

func NewRecordQueryFilter(where []RecordQueryCondition, ) *RecordQueryFilter

NewRecordQueryFilter instantiates a new RecordQueryFilter 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

NewRecordQueryFilterWithDefaults

func NewRecordQueryFilterWithDefaults() *RecordQueryFilter

NewRecordQueryFilterWithDefaults instantiates a new RecordQueryFilter 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

GetWhere

func (o *RecordQueryFilter) GetWhere() []RecordQueryCondition

GetWhere returns the Where field if non-nil, zero value otherwise.

GetWhereOk

func (o *RecordQueryFilter) GetWhereOk() (*[]RecordQueryCondition, bool)

GetWhereOk returns a tuple with the Where field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetWhere

func (o *RecordQueryFilter) SetWhere(v []RecordQueryCondition)

SetWhere sets Where field to given value.

GetSort

func (o *RecordQueryFilter) GetSort() []RecordQuerySort

GetSort returns the Sort field if non-nil, zero value otherwise.

GetSortOk

func (o *RecordQueryFilter) GetSortOk() (*[]RecordQuerySort, bool)

GetSortOk returns a tuple with the Sort field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSort

func (o *RecordQueryFilter) SetSort(v []RecordQuerySort)

SetSort sets Sort field to given value.

HasSort

func (o *RecordQueryFilter) HasSort() bool

HasSort returns a boolean if a field has been set.

GetLimit

func (o *RecordQueryFilter) GetLimit() int64

GetLimit returns the Limit field if non-nil, zero value otherwise.

GetLimitOk

func (o *RecordQueryFilter) GetLimitOk() (*int64, bool)

GetLimitOk returns a tuple with the Limit field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetLimit

func (o *RecordQueryFilter) SetLimit(v int64)

SetLimit sets Limit field to given value.

HasLimit

func (o *RecordQueryFilter) HasLimit() bool

HasLimit returns a boolean if a field has been set.

GetOffset

func (o *RecordQueryFilter) GetOffset() int64

GetOffset returns the Offset field if non-nil, zero value otherwise.

GetOffsetOk

func (o *RecordQueryFilter) GetOffsetOk() (*int64, bool)

GetOffsetOk returns a tuple with the Offset field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOffset

func (o *RecordQueryFilter) SetOffset(v int64)

SetOffset sets Offset field to given value.

HasOffset

func (o *RecordQueryFilter) HasOffset() bool

HasOffset returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]

RecordQuerySort

Properties

Methods

NewRecordQuerySort

func NewRecordQuerySort(field string, direction string, ) *RecordQuerySort

NewRecordQuerySort instantiates a new RecordQuerySort 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

NewRecordQuerySortWithDefaults

func NewRecordQuerySortWithDefaults() *RecordQuerySort

NewRecordQuerySortWithDefaults instantiates a new RecordQuerySort 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

GetField

func (o *RecordQuerySort) GetField() string

GetField returns the Field field if non-nil, zero value otherwise.

GetFieldOk

func (o *RecordQuerySort) GetFieldOk() (*string, bool)

GetFieldOk returns a tuple with the Field field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetField

func (o *RecordQuerySort) SetField(v string)

SetField sets Field field to given value.

GetDirection

func (o *RecordQuerySort) GetDirection() string

GetDirection returns the Direction field if non-nil, zero value otherwise.

GetDirectionOk

func (o *RecordQuerySort) GetDirectionOk() (*string, bool)

GetDirectionOk returns a tuple with the Direction field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetDirection

func (o *RecordQuerySort) SetDirection(v string)

SetDirection sets Direction field to given value.

[Back to Model list] [Back to API list] [Back to README]

Summary

• AdminAPI
• CreateRequest
• DiscoveryAPI
• ErrorResponse
• HealthResponse
• ModelCountResponse
• ModelVersion
• ModelsAPI
• ModelsResponse
• QueryRequest
• QueryResponse
• ReadyResponse
• Record
• RecordQueryCondition
• RecordQueryFilter
• RecordQuerySort
• SUMMARY
• ValidateRequest
• ValidationReport
• ValidationResult
• VersionResponse

ValidateRequest

Properties

Methods

NewValidateRequest

func NewValidateRequest(payload map[string]interface{}, ) *ValidateRequest

NewValidateRequest instantiates a new ValidateRequest 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

NewValidateRequestWithDefaults

func NewValidateRequestWithDefaults() *ValidateRequest

NewValidateRequestWithDefaults instantiates a new ValidateRequest 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

GetPayload

func (o *ValidateRequest) GetPayload() map[string]interface{}

GetPayload returns the Payload field if non-nil, zero value otherwise.

GetPayloadOk

func (o *ValidateRequest) GetPayloadOk() (*map[string]interface{}, bool)

GetPayloadOk returns a tuple with the Payload field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPayload

func (o *ValidateRequest) SetPayload(v map[string]interface{})

SetPayload sets Payload field to given value.

[Back to Model list] [Back to API list] [Back to README]

ValidationReport

Properties

Methods

NewValidationReport

func NewValidationReport(passed bool, results []ValidationResult, ) *ValidationReport

NewValidationReport instantiates a new ValidationReport 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

NewValidationReportWithDefaults

func NewValidationReportWithDefaults() *ValidationReport

NewValidationReportWithDefaults instantiates a new ValidationReport 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

GetPassed

func (o *ValidationReport) GetPassed() bool

GetPassed returns the Passed field if non-nil, zero value otherwise.

GetPassedOk

func (o *ValidationReport) GetPassedOk() (*bool, bool)

GetPassedOk returns a tuple with the Passed field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPassed

func (o *ValidationReport) SetPassed(v bool)

SetPassed sets Passed field to given value.

GetResults

func (o *ValidationReport) GetResults() []ValidationResult

GetResults returns the Results field if non-nil, zero value otherwise.

GetResultsOk

func (o *ValidationReport) GetResultsOk() (*[]ValidationResult, bool)

GetResultsOk returns a tuple with the Results field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetResults

func (o *ValidationReport) SetResults(v []ValidationResult)

SetResults sets Results field to given value.

[Back to Model list] [Back to API list] [Back to README]

ValidationResult

Properties

Methods

NewValidationResult

func NewValidationResult() *ValidationResult

NewValidationResult instantiates a new ValidationResult 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

NewValidationResultWithDefaults

func NewValidationResultWithDefaults() *ValidationResult

NewValidationResultWithDefaults instantiates a new ValidationResult 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

GetPath

func (o *ValidationResult) GetPath() string

GetPath returns the Path field if non-nil, zero value otherwise.

GetPathOk

func (o *ValidationResult) GetPathOk() (*string, bool)

GetPathOk returns a tuple with the Path field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetPath

func (o *ValidationResult) SetPath(v string)

SetPath sets Path field to given value.

HasPath

func (o *ValidationResult) HasPath() bool

HasPath returns a boolean if a field has been set.

GetMessage

func (o *ValidationResult) GetMessage() string

GetMessage returns the Message field if non-nil, zero value otherwise.

GetMessageOk

func (o *ValidationResult) GetMessageOk() (*string, bool)

GetMessageOk returns a tuple with the Message field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetMessage

func (o *ValidationResult) SetMessage(v string)

SetMessage sets Message field to given value.

HasMessage

func (o *ValidationResult) HasMessage() bool

HasMessage returns a boolean if a field has been set.

GetSeverity

func (o *ValidationResult) GetSeverity() string

GetSeverity returns the Severity field if non-nil, zero value otherwise.

GetSeverityOk

func (o *ValidationResult) GetSeverityOk() (*string, bool)

GetSeverityOk returns a tuple with the Severity field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetSeverity

func (o *ValidationResult) SetSeverity(v string)

SetSeverity sets Severity field to given value.

HasSeverity

func (o *ValidationResult) HasSeverity() bool

HasSeverity returns a boolean if a field has been set.

[Back to Model list] [Back to API list] [Back to README]

VersionResponse

Properties

Methods

NewVersionResponse

func NewVersionResponse(service string, serviceVersion string, openapiVersion string, ) *VersionResponse

NewVersionResponse instantiates a new VersionResponse 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

NewVersionResponseWithDefaults

func NewVersionResponseWithDefaults() *VersionResponse

NewVersionResponseWithDefaults instantiates a new VersionResponse 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

GetService

func (o *VersionResponse) GetService() string

GetService returns the Service field if non-nil, zero value otherwise.

GetServiceOk

func (o *VersionResponse) GetServiceOk() (*string, bool)

GetServiceOk returns a tuple with the Service field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetService

func (o *VersionResponse) SetService(v string)

SetService sets Service field to given value.

GetServiceVersion

func (o *VersionResponse) GetServiceVersion() string

GetServiceVersion returns the ServiceVersion field if non-nil, zero value otherwise.

GetServiceVersionOk

func (o *VersionResponse) GetServiceVersionOk() (*string, bool)

GetServiceVersionOk returns a tuple with the ServiceVersion field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetServiceVersion

func (o *VersionResponse) SetServiceVersion(v string)

SetServiceVersion sets ServiceVersion field to given value.

GetOpenapiVersion

func (o *VersionResponse) GetOpenapiVersion() string

GetOpenapiVersion returns the OpenapiVersion field if non-nil, zero value otherwise.

GetOpenapiVersionOk

func (o *VersionResponse) GetOpenapiVersionOk() (*string, bool)

GetOpenapiVersionOk returns a tuple with the OpenapiVersion field if it’s non-nil, zero value otherwise and a boolean to check if the value has been set.

SetOpenapiVersion

func (o *VersionResponse) SetOpenapiVersion(v string)

SetOpenapiVersion sets OpenapiVersion field to given value.

[Back to Model list] [Back to API list] [Back to README]