senzingrestapi

package
v0.10.3 Latest Latest
Warning

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

 Go to latest Published: Dec 12, 2024 License: Apache-2.0 Imports: 27 Imported by: 3

Documentation

Overview

Package senzingrestapi is code generate by ogen.

ogen is an OpenAPI v3 code generator for Go.

Code generated by ogen, DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithServerURL 

func WithServerURL(ctx context.Context, u *url.URL) context.Context

WithServerURL sets context key to override server URL.

Types

type AddDataSourcesApplicationJSONForbidden 

type AddDataSourcesApplicationJSONForbidden SzErrorResponse

func (*AddDataSourcesApplicationJSONForbidden) Decode 

func (s *AddDataSourcesApplicationJSONForbidden) Decode(d *jx.Decoder) error

Decode decodes AddDataSourcesApplicationJSONForbidden from json.

func (*AddDataSourcesApplicationJSONForbidden) Encode 

func (s *AddDataSourcesApplicationJSONForbidden) Encode(e *jx.Encoder)

Encode encodes AddDataSourcesApplicationJSONForbidden as json.

func (*AddDataSourcesApplicationJSONForbidden) MarshalJSON 

func (s *AddDataSourcesApplicationJSONForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddDataSourcesApplicationJSONForbidden) UnmarshalJSON 

func (s *AddDataSourcesApplicationJSONForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddDataSourcesApplicationJSONForbidden) Validate 

func (s *AddDataSourcesApplicationJSONForbidden) Validate() error

type AddDataSourcesApplicationJSONInternalServerError 

type AddDataSourcesApplicationJSONInternalServerError SzErrorResponse

func (*AddDataSourcesApplicationJSONInternalServerError) Decode 

func (s *AddDataSourcesApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes AddDataSourcesApplicationJSONInternalServerError from json.

func (*AddDataSourcesApplicationJSONInternalServerError) Encode 

func (s *AddDataSourcesApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes AddDataSourcesApplicationJSONInternalServerError as json.

func (*AddDataSourcesApplicationJSONInternalServerError) MarshalJSON 

func (s *AddDataSourcesApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddDataSourcesApplicationJSONInternalServerError) UnmarshalJSON 

func (s *AddDataSourcesApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddDataSourcesApplicationJSONInternalServerError) Validate 

func (s *AddDataSourcesApplicationJSONInternalServerError) Validate() error

type AddDataSourcesForbiddenDefault 

type AddDataSourcesForbiddenDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (AddDataSourcesForbiddenDefault) Read 

func (s AddDataSourcesForbiddenDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddDataSourcesOKDefault 

type AddDataSourcesOKDefault struct {
	Data io.Reader
}

The response describing the configured data sources. Ref: #/components/schemas/SzDataSourcesResponse

func (AddDataSourcesOKDefault) Read 

func (s AddDataSourcesOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddDataSourcesParams 

type AddDataSourcesParams struct {
	// The multi-valued query parameter where each value is a data source
	// code identifying data sources to be created.  If a data source code
	// is specified only via this parameter then the data source ID is
	// generated by the API server -- which is usually fine.  If you want
	// to specify the data source ID, then use the request body instead.
	DataSource []string
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

AddDataSourcesParams is parameters of addDataSources operation.

type AddDataSourcesReq 

type AddDataSourcesReq interface {
	// contains filtered or unexported methods
}

type AddDataSourcesReqApplicationJSON 

type AddDataSourcesReqApplicationJSON struct {
	Type                        AddDataSourcesReqApplicationJSONType // switch on this field
	SzDataSourceDescriptorArray []SzDataSourceDescriptor
	SzDataSourceDescriptor      SzDataSourceDescriptor
}

AddDataSourcesReqApplicationJSON represents sum type.

func NewSzDataSourceDescriptorAddDataSourcesReqApplicationJSON 

func NewSzDataSourceDescriptorAddDataSourcesReqApplicationJSON(v SzDataSourceDescriptor) AddDataSourcesReqApplicationJSON

NewSzDataSourceDescriptorAddDataSourcesReqApplicationJSON returns new AddDataSourcesReqApplicationJSON from SzDataSourceDescriptor.

func NewSzDataSourceDescriptorArrayAddDataSourcesReqApplicationJSON 

func NewSzDataSourceDescriptorArrayAddDataSourcesReqApplicationJSON(v []SzDataSourceDescriptor) AddDataSourcesReqApplicationJSON

NewSzDataSourceDescriptorArrayAddDataSourcesReqApplicationJSON returns new AddDataSourcesReqApplicationJSON from []SzDataSourceDescriptor.

func (*AddDataSourcesReqApplicationJSON) Decode 

func (s *AddDataSourcesReqApplicationJSON) Decode(d *jx.Decoder) error

Decode decodes AddDataSourcesReqApplicationJSON from json.

func (AddDataSourcesReqApplicationJSON) Encode 

func (s AddDataSourcesReqApplicationJSON) Encode(e *jx.Encoder)

Encode encodes AddDataSourcesReqApplicationJSON as json.

func (AddDataSourcesReqApplicationJSON) GetSzDataSourceDescriptor 

func (s AddDataSourcesReqApplicationJSON) GetSzDataSourceDescriptor() (v SzDataSourceDescriptor, ok bool)

GetSzDataSourceDescriptor returns SzDataSourceDescriptor and true boolean if AddDataSourcesReqApplicationJSON is SzDataSourceDescriptor.

func (AddDataSourcesReqApplicationJSON) GetSzDataSourceDescriptorArray 

func (s AddDataSourcesReqApplicationJSON) GetSzDataSourceDescriptorArray() (v []SzDataSourceDescriptor, ok bool)

GetSzDataSourceDescriptorArray returns []SzDataSourceDescriptor and true boolean if AddDataSourcesReqApplicationJSON is []SzDataSourceDescriptor.

func (AddDataSourcesReqApplicationJSON) IsSzDataSourceDescriptor 

func (s AddDataSourcesReqApplicationJSON) IsSzDataSourceDescriptor() bool

IsSzDataSourceDescriptor reports whether AddDataSourcesReqApplicationJSON is SzDataSourceDescriptor.

func (AddDataSourcesReqApplicationJSON) IsSzDataSourceDescriptorArray 

func (s AddDataSourcesReqApplicationJSON) IsSzDataSourceDescriptorArray() bool

IsSzDataSourceDescriptorArray reports whether AddDataSourcesReqApplicationJSON is []SzDataSourceDescriptor.

func (AddDataSourcesReqApplicationJSON) MarshalJSON 

func (s AddDataSourcesReqApplicationJSON) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddDataSourcesReqApplicationJSON) SetSzDataSourceDescriptor 

func (s *AddDataSourcesReqApplicationJSON) SetSzDataSourceDescriptor(v SzDataSourceDescriptor)

SetSzDataSourceDescriptor sets AddDataSourcesReqApplicationJSON to SzDataSourceDescriptor.

func (*AddDataSourcesReqApplicationJSON) SetSzDataSourceDescriptorArray 

func (s *AddDataSourcesReqApplicationJSON) SetSzDataSourceDescriptorArray(v []SzDataSourceDescriptor)

SetSzDataSourceDescriptorArray sets AddDataSourcesReqApplicationJSON to []SzDataSourceDescriptor.

func (*AddDataSourcesReqApplicationJSON) UnmarshalJSON 

func (s *AddDataSourcesReqApplicationJSON) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (AddDataSourcesReqApplicationJSON) Validate 

func (s AddDataSourcesReqApplicationJSON) Validate() error

type AddDataSourcesReqApplicationJSONType 

type AddDataSourcesReqApplicationJSONType string

AddDataSourcesReqApplicationJSONType is oneOf type of AddDataSourcesReqApplicationJSON. 

const (
	SzDataSourceDescriptorArrayAddDataSourcesReqApplicationJSON AddDataSourcesReqApplicationJSONType = "[]SzDataSourceDescriptor"
	SzDataSourceDescriptorAddDataSourcesReqApplicationJSON      AddDataSourcesReqApplicationJSONType = "SzDataSourceDescriptor"
)

Possible values for AddDataSourcesReqApplicationJSONType.

type AddDataSourcesReqEmptyBody 

type AddDataSourcesReqEmptyBody struct{}

type AddDataSourcesReqTextPlain 

type AddDataSourcesReqTextPlain struct {
	Data io.Reader
}

func (AddDataSourcesReqTextPlain) Read 

func (s AddDataSourcesReqTextPlain) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddDataSourcesRes 

type AddDataSourcesRes interface {
	// contains filtered or unexported methods
}

type AddRecordApplicationJSONBadRequest 

type AddRecordApplicationJSONBadRequest SzErrorResponse

func (*AddRecordApplicationJSONBadRequest) Decode 

func (s *AddRecordApplicationJSONBadRequest) Decode(d *jx.Decoder) error

Decode decodes AddRecordApplicationJSONBadRequest from json.

func (*AddRecordApplicationJSONBadRequest) Encode 

func (s *AddRecordApplicationJSONBadRequest) Encode(e *jx.Encoder)

Encode encodes AddRecordApplicationJSONBadRequest as json.

func (*AddRecordApplicationJSONBadRequest) MarshalJSON 

func (s *AddRecordApplicationJSONBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordApplicationJSONBadRequest) UnmarshalJSON 

func (s *AddRecordApplicationJSONBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddRecordApplicationJSONBadRequest) Validate 

func (s *AddRecordApplicationJSONBadRequest) Validate() error

type AddRecordApplicationJSONForbidden 

type AddRecordApplicationJSONForbidden SzErrorResponse

func (*AddRecordApplicationJSONForbidden) Decode 

func (s *AddRecordApplicationJSONForbidden) Decode(d *jx.Decoder) error

Decode decodes AddRecordApplicationJSONForbidden from json.

func (*AddRecordApplicationJSONForbidden) Encode 

func (s *AddRecordApplicationJSONForbidden) Encode(e *jx.Encoder)

Encode encodes AddRecordApplicationJSONForbidden as json.

func (*AddRecordApplicationJSONForbidden) MarshalJSON 

func (s *AddRecordApplicationJSONForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordApplicationJSONForbidden) UnmarshalJSON 

func (s *AddRecordApplicationJSONForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddRecordApplicationJSONForbidden) Validate 

func (s *AddRecordApplicationJSONForbidden) Validate() error

type AddRecordApplicationJSONInternalServerError 

type AddRecordApplicationJSONInternalServerError SzErrorResponse

func (*AddRecordApplicationJSONInternalServerError) Decode 

func (s *AddRecordApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes AddRecordApplicationJSONInternalServerError from json.

func (*AddRecordApplicationJSONInternalServerError) Encode 

func (s *AddRecordApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes AddRecordApplicationJSONInternalServerError as json.

func (*AddRecordApplicationJSONInternalServerError) MarshalJSON 

func (s *AddRecordApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordApplicationJSONInternalServerError) UnmarshalJSON 

func (s *AddRecordApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddRecordApplicationJSONInternalServerError) Validate 

func (s *AddRecordApplicationJSONInternalServerError) Validate() error

type AddRecordApplicationJSONNotFound 

type AddRecordApplicationJSONNotFound SzErrorResponse

func (*AddRecordApplicationJSONNotFound) Decode 

func (s *AddRecordApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes AddRecordApplicationJSONNotFound from json.

func (*AddRecordApplicationJSONNotFound) Encode 

func (s *AddRecordApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes AddRecordApplicationJSONNotFound as json.

func (*AddRecordApplicationJSONNotFound) MarshalJSON 

func (s *AddRecordApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordApplicationJSONNotFound) UnmarshalJSON 

func (s *AddRecordApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddRecordApplicationJSONNotFound) Validate 

func (s *AddRecordApplicationJSONNotFound) Validate() error

type AddRecordBadRequestDefault 

type AddRecordBadRequestDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (AddRecordBadRequestDefault) Read 

func (s AddRecordBadRequestDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddRecordForbiddenDefault 

type AddRecordForbiddenDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (AddRecordForbiddenDefault) Read 

func (s AddRecordForbiddenDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddRecordNotFoundDefault 

type AddRecordNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (AddRecordNotFoundDefault) Read 

func (s AddRecordNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddRecordOKDefault 

type AddRecordOKDefault struct {
	Data io.Reader
}

Describes the response when a record is successfully loaded. Ref: #/components/schemas/SzLoadRecordResponse

func (AddRecordOKDefault) Read 

func (s AddRecordOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddRecordParams 

type AddRecordParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// The identifier that uniquely identifies the requested record within a given data source.  This may
	// have been specified when the record was loaded or generated automatically.
	RecordId string
	// The optional load ID to associate with the loaded record.
	LoadId OptString
	// Set to `true` to include resolution information related to loading, and `false` to exclude it.
	// This defaults to `false`.
	WithInfo OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

AddRecordParams is parameters of addRecord operation.

type AddRecordReq 

type AddRecordReq map[string]jx.Raw

func (*AddRecordReq) Decode 

func (s *AddRecordReq) Decode(d *jx.Decoder) error

Decode decodes AddRecordReq from json.

func (AddRecordReq) Encode 

func (s AddRecordReq) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (AddRecordReq) MarshalJSON 

func (s AddRecordReq) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordReq) UnmarshalJSON 

func (s *AddRecordReq) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type AddRecordRes 

type AddRecordRes interface {
	// contains filtered or unexported methods
}

type AddRecordWithReturnedRecordIdApplicationJSONBadRequest 

type AddRecordWithReturnedRecordIdApplicationJSONBadRequest SzErrorResponse

func (*AddRecordWithReturnedRecordIdApplicationJSONBadRequest) Decode 

func (s *AddRecordWithReturnedRecordIdApplicationJSONBadRequest) Decode(d *jx.Decoder) error

Decode decodes AddRecordWithReturnedRecordIdApplicationJSONBadRequest from json.

func (*AddRecordWithReturnedRecordIdApplicationJSONBadRequest) Encode 

func (s *AddRecordWithReturnedRecordIdApplicationJSONBadRequest) Encode(e *jx.Encoder)

Encode encodes AddRecordWithReturnedRecordIdApplicationJSONBadRequest as json.

func (*AddRecordWithReturnedRecordIdApplicationJSONBadRequest) MarshalJSON 

func (s *AddRecordWithReturnedRecordIdApplicationJSONBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordWithReturnedRecordIdApplicationJSONBadRequest) UnmarshalJSON 

func (s *AddRecordWithReturnedRecordIdApplicationJSONBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddRecordWithReturnedRecordIdApplicationJSONBadRequest) Validate 

func (s *AddRecordWithReturnedRecordIdApplicationJSONBadRequest) Validate() error

type AddRecordWithReturnedRecordIdApplicationJSONForbidden 

type AddRecordWithReturnedRecordIdApplicationJSONForbidden SzErrorResponse

func (*AddRecordWithReturnedRecordIdApplicationJSONForbidden) Decode 

func (s *AddRecordWithReturnedRecordIdApplicationJSONForbidden) Decode(d *jx.Decoder) error

Decode decodes AddRecordWithReturnedRecordIdApplicationJSONForbidden from json.

func (*AddRecordWithReturnedRecordIdApplicationJSONForbidden) Encode 

func (s *AddRecordWithReturnedRecordIdApplicationJSONForbidden) Encode(e *jx.Encoder)

Encode encodes AddRecordWithReturnedRecordIdApplicationJSONForbidden as json.

func (*AddRecordWithReturnedRecordIdApplicationJSONForbidden) MarshalJSON 

func (s *AddRecordWithReturnedRecordIdApplicationJSONForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordWithReturnedRecordIdApplicationJSONForbidden) UnmarshalJSON 

func (s *AddRecordWithReturnedRecordIdApplicationJSONForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddRecordWithReturnedRecordIdApplicationJSONForbidden) Validate 

func (s *AddRecordWithReturnedRecordIdApplicationJSONForbidden) Validate() error

type AddRecordWithReturnedRecordIdApplicationJSONInternalServerError 

type AddRecordWithReturnedRecordIdApplicationJSONInternalServerError SzErrorResponse

func (*AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) Decode 

func (s *AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes AddRecordWithReturnedRecordIdApplicationJSONInternalServerError from json.

func (*AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) Encode 

func (s *AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes AddRecordWithReturnedRecordIdApplicationJSONInternalServerError as json.

func (*AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) MarshalJSON 

func (s *AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) UnmarshalJSON 

func (s *AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) Validate 

func (s *AddRecordWithReturnedRecordIdApplicationJSONInternalServerError) Validate() error

type AddRecordWithReturnedRecordIdApplicationJSONNotFound 

type AddRecordWithReturnedRecordIdApplicationJSONNotFound SzErrorResponse

func (*AddRecordWithReturnedRecordIdApplicationJSONNotFound) Decode 

func (s *AddRecordWithReturnedRecordIdApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes AddRecordWithReturnedRecordIdApplicationJSONNotFound from json.

func (*AddRecordWithReturnedRecordIdApplicationJSONNotFound) Encode 

func (s *AddRecordWithReturnedRecordIdApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes AddRecordWithReturnedRecordIdApplicationJSONNotFound as json.

func (*AddRecordWithReturnedRecordIdApplicationJSONNotFound) MarshalJSON 

func (s *AddRecordWithReturnedRecordIdApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordWithReturnedRecordIdApplicationJSONNotFound) UnmarshalJSON 

func (s *AddRecordWithReturnedRecordIdApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*AddRecordWithReturnedRecordIdApplicationJSONNotFound) Validate 

func (s *AddRecordWithReturnedRecordIdApplicationJSONNotFound) Validate() error

type AddRecordWithReturnedRecordIdBadRequestDefault 

type AddRecordWithReturnedRecordIdBadRequestDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (AddRecordWithReturnedRecordIdBadRequestDefault) Read 

func (s AddRecordWithReturnedRecordIdBadRequestDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddRecordWithReturnedRecordIdForbiddenDefault 

type AddRecordWithReturnedRecordIdForbiddenDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (AddRecordWithReturnedRecordIdForbiddenDefault) Read 

func (s AddRecordWithReturnedRecordIdForbiddenDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddRecordWithReturnedRecordIdNotFoundDefault 

type AddRecordWithReturnedRecordIdNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (AddRecordWithReturnedRecordIdNotFoundDefault) Read 

func (s AddRecordWithReturnedRecordIdNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddRecordWithReturnedRecordIdOKDefault 

type AddRecordWithReturnedRecordIdOKDefault struct {
	Data io.Reader
}

Describes the response when a record is successfully loaded. Ref: #/components/schemas/SzLoadRecordResponse

func (AddRecordWithReturnedRecordIdOKDefault) Read 

func (s AddRecordWithReturnedRecordIdOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AddRecordWithReturnedRecordIdParams 

type AddRecordWithReturnedRecordIdParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// The optional load ID to associate with the loaded record.
	LoadId OptString
	// Set to `true` to include resolution information related to loading, and `false` to exclude it.
	// This defaults to `false`.
	WithInfo OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

AddRecordWithReturnedRecordIdParams is parameters of addRecordWithReturnedRecordId operation.

type AddRecordWithReturnedRecordIdReq 

type AddRecordWithReturnedRecordIdReq map[string]jx.Raw

func (*AddRecordWithReturnedRecordIdReq) Decode 

func (s *AddRecordWithReturnedRecordIdReq) Decode(d *jx.Decoder) error

Decode decodes AddRecordWithReturnedRecordIdReq from json.

func (AddRecordWithReturnedRecordIdReq) Encode 

func (s AddRecordWithReturnedRecordIdReq) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (AddRecordWithReturnedRecordIdReq) MarshalJSON 

func (s AddRecordWithReturnedRecordIdReq) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AddRecordWithReturnedRecordIdReq) UnmarshalJSON 

func (s *AddRecordWithReturnedRecordIdReq) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type AddRecordWithReturnedRecordIdRes 

type AddRecordWithReturnedRecordIdRes interface {
	// contains filtered or unexported methods
}

type AnalyzeBulkRecordsOKDefault 

type AnalyzeBulkRecordsOKDefault struct {
	Data io.Reader
}

The response describing the analysis of bulk data records. Ref: #/components/schemas/SzBulkDataAnalysisResponse

func (AnalyzeBulkRecordsOKDefault) Read 

func (s AnalyzeBulkRecordsOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AnalyzeBulkRecordsParams 

type AnalyzeBulkRecordsParams struct {
	// The suggested maximum time between SSE `progress` events specified in milliseconds.  If not
	// specified then the default of `3000` milliseconds (i.e.: 3 seconds) is used.  This parameter is
	// NOT used if the operation is not producing an SSE response (i.e.: `text/event-stream` media type
	// was not requested via the `Accept` header).
	ProgressPeriod OptInt64
	// The number of seconds to wait for an additional Web Sockets message before assuming end-of-file
	// (EOF) when using this end-point via Web Sockets protocol.  If this number of seconds elapses with
	// no additional incoming data then the server assumes that there are no more file chunks forthcoming.
	//   If not specified then the default of `3` seconds is used. This parameter is NOT used if the
	// operation is not invoked via the Web Sockets (`ws://`) protocol.  **NOTE**: This is specified in
	// seconds, **not** milliseconds.
	EofSendTimeout OptInt32
}

AnalyzeBulkRecordsParams is parameters of analyzeBulkRecords operation.

type AnalyzeBulkRecordsReq 

type AnalyzeBulkRecordsReq interface {
	// contains filtered or unexported methods
}

type AnalyzeBulkRecordsReqApplicationJSON 

type AnalyzeBulkRecordsReqApplicationJSON string

func (*AnalyzeBulkRecordsReqApplicationJSON) Decode 

func (s *AnalyzeBulkRecordsReqApplicationJSON) Decode(d *jx.Decoder) error

Decode decodes AnalyzeBulkRecordsReqApplicationJSON from json.

func (AnalyzeBulkRecordsReqApplicationJSON) Encode 

func (s AnalyzeBulkRecordsReqApplicationJSON) Encode(e *jx.Encoder)

Encode encodes AnalyzeBulkRecordsReqApplicationJSON as json.

func (AnalyzeBulkRecordsReqApplicationJSON) MarshalJSON 

func (s AnalyzeBulkRecordsReqApplicationJSON) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*AnalyzeBulkRecordsReqApplicationJSON) UnmarshalJSON 

func (s *AnalyzeBulkRecordsReqApplicationJSON) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type AnalyzeBulkRecordsReqApplicationXJsonlines 

type AnalyzeBulkRecordsReqApplicationXJsonlines struct {
	Data io.Reader
}

func (AnalyzeBulkRecordsReqApplicationXJsonlines) Read 

func (s AnalyzeBulkRecordsReqApplicationXJsonlines) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AnalyzeBulkRecordsReqMultipartFormData 

type AnalyzeBulkRecordsReqMultipartFormData struct {
	Body OptMultipartFile `json:"body"`
}

func (*AnalyzeBulkRecordsReqMultipartFormData) GetBody 

func (s *AnalyzeBulkRecordsReqMultipartFormData) GetBody() OptMultipartFile

GetBody returns the value of Body.

func (*AnalyzeBulkRecordsReqMultipartFormData) SetBody 

func (s *AnalyzeBulkRecordsReqMultipartFormData) SetBody(val OptMultipartFile)

SetBody sets the value of Body.

type AnalyzeBulkRecordsReqTextCsv 

type AnalyzeBulkRecordsReqTextCsv struct {
	Data io.Reader
}

func (AnalyzeBulkRecordsReqTextCsv) Read 

func (s AnalyzeBulkRecordsReqTextCsv) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AnalyzeBulkRecordsReqTextPlain 

type AnalyzeBulkRecordsReqTextPlain struct {
	Data io.Reader
}

func (AnalyzeBulkRecordsReqTextPlain) Read 

func (s AnalyzeBulkRecordsReqTextPlain) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type AnalyzeBulkRecordsRes 

type AnalyzeBulkRecordsRes interface {
	// contains filtered or unexported methods
}

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client implements OAS client.

func NewClient 

func NewClient(serverURL string, opts ...ClientOption) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) AddDataSources 

func (c *Client) AddDataSources(ctx context.Context, request AddDataSourcesReq, params AddDataSourcesParams) (AddDataSourcesRes, error)

AddDataSources invokes addDataSources operation.

Obtains the current default configuration, adds the specified data sources and sets the modified configuration as the new default configuration -- returning the set of all configured data sources. **NOTE:** This operation may not be allowed. Some conditions that might cause this operation to be forbidden are: 1. The server does not have administrative functions enabled. 2. The server is running in "read-only" mode. 3. The server is started with a file-based configuration specified by `G2CONFIGFILE` property in the initialziation parameters. 4. The server is started with a specific configuration ID and therefore cannot modify the configuration and change to a new configuration.

POST /data-sources

func (*Client) AddRecord 

func (c *Client) AddRecord(ctx context.Context, request AddRecordReq, params AddRecordParams) (AddRecordRes, error)

AddRecord invokes addRecord operation.

This operation loads a single record using the data source identified by the data source code in the request path. The record will be identified uniquely within the data source by the record ID provided in the request path. The provided record in the request body is described in JSON using the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). The provided JSON record may omit the `RECORD_ID`, but if it contains a `RECORD_ID` then it **must** match the record ID provided on the request path. The record ID is returned as part of the response. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the load. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value.

PUT /data-sources/{dataSourceCode}/records/{recordId}

func (*Client) AddRecordWithReturnedRecordId 

func (c *Client) AddRecordWithReturnedRecordId(ctx context.Context, request AddRecordWithReturnedRecordIdReq, params AddRecordWithReturnedRecordIdParams) (AddRecordWithReturnedRecordIdRes, error)

AddRecordWithReturnedRecordId invokes addRecordWithReturnedRecordId operation.

This operation loads a single record using the data source identified by the data source code in the request path. The provided record in the request body is described in JSON using the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). The provided record may contain a `RECORD_ID` to identify it uniquely among other records in the same data source, but if it does not then a record ID will be automatically generated. The record ID is returned as part of the response. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the load. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value.

POST /data-sources/{dataSourceCode}/records

func (*Client) AnalyzeBulkRecords 

func (c *Client) AnalyzeBulkRecords(ctx context.Context, request AnalyzeBulkRecordsReq, params AnalyzeBulkRecordsParams) (AnalyzeBulkRecordsRes, error)

AnalyzeBulkRecords invokes analyzeBulkRecords operation.

Provides a means to analyze a bulk data file of records prior to loading it. The records are encoded as a JSON array of JSON objects, a single JSON object per line in JSON-lines file format, or as a CSV with one record per row. The data should be in pre-mapped format using JSON property names or CSV column names as described by the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). **SCALABILITY NOTE:** This operation can be invoked in three ways. In order of increasingly better scalability these are listed below: 1. Standard HTTP Request/Response 2. HTTP Request with SSE Response (see below) 3. HTTP Upgrade Request for Web Sockets (see below) Standard HTTP Request/Response (method 1) has the worst scalability because a long-running operation will tie up a Web Server thread **and** continue until complete even if the client aborts the operation since no data is written back to the client until complete and therefore the terminated connection will not be detected. SSE (method 2) mitigates the problem of detecting when a client has aborted the operation because periodic progress responses are written to the client and therefore a terminated connection will be detected. However, the best way to invoke this operation is via Web Sockets (method 3) which not only can detect disconnection of the client, but it also upgrades the request to use its own thread outside the Web Server thread pool. **SSE NOTE:** This end-point supports "Server-sent Events" (SSE) via the `text/event-stream` media type. This support is activated by adding the `Accept: text/event-stream` header to a request to override the default `application/json` media type. Further, the end-point will behave similarly to its standard operation but will produce `progress` events at regular intervals that are equivalent to its `200` response schema. Upon success, the final event will be `completed` with the same response schema as a `200` response. Upon failure, the final event will be `failed` with same `SzErrorResponse` schema as the `4xx` or `5xx`. **WEB SOCKETS NOTE**: If invoking via Web Sockets then the client may send text or binary chunks of the JSON, JSON-Lines or CSV bulk data file as messages. In Web Sockets, text messages are *always* sent as UTF-8. If the file's character encoding is unknown then the client should send binary messages and the server will attempt to auto-detect the character encoding. Each message should adhere to the maximum message size specified by the `webSocketsMessageMaxSize` property returned by the `GET /server-info` end-point. The end of file is detected when the number of seconds specified by the `eofSendTimeout` query parameter have elapsed without a new message being received.

POST /bulk-data/analyze

func (*Client) DeleteRecord 

func (c *Client) DeleteRecord(ctx context.Context, params DeleteRecordParams) (DeleteRecordRes, error)

DeleteRecord invokes deleteRecord operation.

This operation deletes a single record identified by the data source code and record ID in the request path. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the delete. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value.

DELETE /data-sources/{dataSourceCode}/records/{recordId}

func (*Client) FindEntityNetwork 

func (c *Client) FindEntityNetwork(ctx context.Context, params FindEntityNetworkParams) (FindEntityNetworkRes, error)

FindEntityNetwork invokes findEntityNetwork operation.

This operation finds the entity network around one or more entities. This attempts to find paths between the specified entities. If no paths exist, then island networks are returned with each island network containing up to a specified number of related entities. The entities are identified by their entity IDs or by data source code and record ID pairs for constituent records of those entities. **NOTE:** If the first entity is identified by entity ID then the subsequent entities must also be identified entity ID. Similarly, if the first entity is identified by the data source code and record ID of a consistuent record then the subsequent entities must also be identified by the data source code and record ID of constituent records. **ALSO NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve.

GET /entity-networks

func (*Client) FindEntityPath 

func (c *Client) FindEntityPath(ctx context.Context, params FindEntityPathParams) (FindEntityPathRes, error)

FindEntityPath invokes findEntityPath operation.

This operation finds the path between two entities and returns a description of that entity path (if any) or a response indicating that there is no path between the entities. The subject entities are either identfieid by entity ID or by data source code and record ID pairs for constituent records of those entities. **NOTE:** If the first entity is identified by entity ID then the second must also be identified an entity ID. Similarly, if the first entity is identified by data source code and record ID then the second must also be identified by data source code and record ID. **ALSO NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve.

GET /entity-paths

func (*Client) GetActiveConfig 

func (c *Client) GetActiveConfig(ctx context.Context) (GetActiveConfigRes, error)

GetActiveConfig invokes getActiveConfig operation.

This operation returns the JSON configuration that is currently being used by the native Senzing API initialized by the running server. No processing or interpretation is performed on the JSON. This may differ from the registered "default configuration" which the server would use if no other configuration were provided.

GET /configs/active

func (*Client) GetAttributeType 

func (c *Client) GetAttributeType(ctx context.Context, params GetAttributeTypeParams) (GetAttributeTypeRes, error)

GetAttributeType invokes getAttributeType operation.

This operation will provide a description of a single attribute type for the specified attribute type code.

GET /attribute-types/{attributeCode}

func (*Client) GetAttributeTypes 

func (c *Client) GetAttributeTypes(ctx context.Context, params GetAttributeTypesParams) (GetAttributeTypesRes, error)

GetAttributeTypes invokes getAttributeTypes operation.

This operation will provide a list of attribute types that are configured. The client can filter the returned list of attribute types using various query parameters.

GET /attribute-types

func (*Client) GetDataSource 

func (c *Client) GetDataSource(ctx context.Context, params GetDataSourceParams) (GetDataSourceRes, error)

GetDataSource invokes getDataSource operation.

This operation provides details on a specific data source identified by the data source code in the requested path.

GET /data-sources/{dataSourceCode}

func (*Client) GetDataSources 

func (c *Client) GetDataSources(ctx context.Context, params GetDataSourcesParams) (GetDataSourcesRes, error)

GetDataSources invokes getDataSources operation.

This operation will provide a list of data source codes as well as a list of detailed descriptions of each data source.

GET /data-sources

func (*Client) GetEntityByEntityId 

func (c *Client) GetEntityByEntityId(ctx context.Context, params GetEntityByEntityIdParams) (GetEntityByEntityIdRes, error)

GetEntityByEntityId invokes getEntityByEntityId operation.

Gets the details on a resolved entity that is identified by the entity ID specified in the request path. **NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve. An alternative way to identify an entity is by one of its constituent records using `GET /data-sources/{dataSourceCode}/records/{recordId}/entity`.

GET /entities/{entityId}

func (*Client) GetEntityByRecordId 

func (c *Client) GetEntityByRecordId(ctx context.Context, params GetEntityByRecordIdParams) (GetEntityByRecordIdRes, error)

GetEntityByRecordId invokes getEntityByRecordId operation.

Gets the details on a resolved entity that contains the record identified by the data source code and record ID in the specified request path.

GET /data-sources/{dataSourceCode}/records/{recordId}/entity

func (*Client) GetRecord 

func (c *Client) GetRecord(ctx context.Context, params GetRecordParams) (GetRecordRes, error)

GetRecord invokes getRecord operation.

Gets details on a specific entity record identified by the data source code and record ID specified in the request path.

GET /data-sources/{dataSourceCode}/records/{recordId}

func (*Client) GetServerInfo 

func (c *Client) GetServerInfo(ctx context.Context) (GetServerInfoRes, error)

GetServerInfo invokes getServerInfo operation.

This operation will provides server information describing the options with which the server was started. This can be used to determine if the admin operations are enabled or if only read operations may be invoked. This also allows the client to know the maximum message size for Web Sockets communication.

GET /server-info

func (*Client) GetTemplateConfig 

func (c *Client) GetTemplateConfig(ctx context.Context) (GetTemplateConfigRes, error)

GetTemplateConfig invokes getTemplateConfig operation.

This operation returns a template base JSON configuration that can be modified or customized by the caller. The returned template is according to the underlying native Senzing API and may change between version upgrades to Senzing. No processing or interpretation is performed on the JSON. This will likely differ from the registered "default configuration" or currently "active configuration" being used by the running API server.

GET /configs/template

func (*Client) GetVirtualEntityByRecordIds 

func (c *Client) GetVirtualEntityByRecordIds(ctx context.Context, params GetVirtualEntityByRecordIdsParams) (GetVirtualEntityByRecordIdsRes, error)

GetVirtualEntityByRecordIds invokes getVirtualEntityByRecordIds operation.

This operation simulates the resolution of the one or more specified records into a single entity and returns the simulated "virtual" entity. The subject records are identified by data source code and record ID pairs.

GET /virtual-entities

func (*Client) Heartbeat 

func (c *Client) Heartbeat(ctx context.Context) (*SzBaseResponse, error)

Heartbeat invokes heartbeat operation.

The heartbeat operation can be used to ensure that the HTTP server is indeed running, but this operation does not call upon the underlying native Senzing API and therefore does not ensure the Senzing initialization or configuration is valid.

GET /heartbeat

func (*Client) HowEntityByEntityID 

func (c *Client) HowEntityByEntityID(ctx context.Context, params HowEntityByEntityIDParams) (HowEntityByEntityIDRes, error)

HowEntityByEntityID invokes howEntityByEntityID operation.

This operation provides an anlysis of how the records in an entity resolved. The subject entity is identified by the entity ID in the request path. **NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve. An alternative way to identify an entity is by one of its constituent records using `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/how`.

GET /entities/{entityId}/how

func (*Client) HowEntityByRecordID 

func (c *Client) HowEntityByRecordID(ctx context.Context, params HowEntityByRecordIDParams) (HowEntityByRecordIDRes, error)

HowEntityByRecordID invokes howEntityByRecordID operation.

This operation provides an anlysis of how the records in an entity resolved. The subject entity is the one containing the record identified by the data source code and record ID in the request path.

GET /data-sources/{dataSourceCode}/records/{recordId}/entity/how

func (*Client) License 

func (c *Client) License(ctx context.Context, params LicenseParams) (LicenseRes, error)

License invokes license operation.

This operation will obtain license information for the underlying native Senzing API.

GET /license

func (*Client) LoadBulkRecords 

func (c *Client) LoadBulkRecords(ctx context.Context, request LoadBulkRecordsReq, params LoadBulkRecordsParams) (LoadBulkRecordsRes, error)

LoadBulkRecords invokes loadBulkRecords operation.

Provides a means to load a bulk data file of records. The records are encoded as a JSON array of JSON objects, a single JSON object per line in JSON-lines file format, or as a CSV with one record per row. The data should be in pre-mapped format using JSON property names or CSV column names as described by the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). **SCALABILITY NOTE:** This operation can be invoked in three ways. In order of increasingly better scalability these are listed below: 1. Standard HTTP Request/Response 2. HTTP Request with SSE Response (see below) 3. HTTP Upgrade Request for Web Sockets (see below) Standard HTTP Request/Response (method 1) has the worst scalability because a long-running operation will tie up a Web Server thread **and** continue until complete even if the client aborts the operation since no data is written back to the client until complete and therefore the terminated connection will not be detected. SSE (method 2) mitigates the problem of detecting when a client has aborted the operation because periodic progress responses are written to the client and therefore a terminated connection will be detected. However, the best way to invoke this operation is via Web Sockets (method 3) which not only can detect disconnection of the client, but it also upgrades the request to use its own thread outside the Web Server thread pool. **SSE NOTE:** This end-point supports "Server-sent Events" (SSE) via the `text/event-stream` media type. This support is activated by adding the `Accept: text/event-stream` header to a request to override the default `application/json` media type. Further, the end-point will behave similarly to its standard operation but will produce `progress` events at regular intervals that are equivalent to its `200` response schema. Upon success, the final event will be `completed` with the same response schema as a `200` response. Upon failure, the final event will be `failed` with same `SzErrorResponse` schema as the `4xx` or `5xx`. **WEB SOCKETS NOTE**: If invoking via Web Sockets then the client may send text or binary chunks of the JSON, JSON-Lines or CSV bulk data file as messages. In Web Sockets, text messages are *always* sent as UTF-8. If the file's character encoding is unknown then the client should send binary messages and the server will attempt to auto-detect the character encoding. Each message should adhere to the maximum message size specified by the `webSocketsMessageMaxSize` property returned by the `GET /server-info` end-point. The end of file is detected when the number of seconds specified by the `eofSendTimeout` query parameter have elapsed without a new message being received.

POST /bulk-data/load

func (*Client) OpenAPISpecification added in v0.9.4 

func (c *Client) OpenAPISpecification(ctx context.Context) (OpenAPISpecificationOKDefault, error)

OpenAPISpecification invokes openAPISpecification operation.

This operation can be used to obtain the Open API specification in JSON format. The specification can either be the `data` field of a standard response (i.e.: a response with a `meta`, `links` and `data` field) or as raw format where the root JSON document is the Open API specification JSON.

GET /specifications/open-api

func (*Client) ReevaluateEntity 

func (c *Client) ReevaluateEntity(ctx context.Context, params ReevaluateEntityParams) (ReevaluateEntityRes, error)

ReevaluateEntity invokes reevaluateEntity operation.

Reevaluates an entity identified by the entity ID specified via the `entityId` query parameter. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the reevaluation. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value. **ALSO NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve.

POST /reevaluate-entity

func (*Client) ReevaluateRecord 

func (c *Client) ReevaluateRecord(ctx context.Context, params ReevaluateRecordParams) (ReevaluateRecordRes, error)

ReevaluateRecord invokes reevaluateRecord operation.

This operation reevaluates a single record identified by the data source code and record ID in the request path. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the reevaluation. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value.

POST /data-sources/{dataSourceCode}/records/{recordId}/reevaluate

func (*Client) Root 

func (c *Client) Root(ctx context.Context) (*SzBaseResponse, error)

Root invokes root operation.

The root operation can be used to ensure that the HTTP server is indeed running, but this operation does not call upon the underlying native Senzing API and therefore does not ensure the Senzing initialization or configuration is valid.

GET /

func (*Client) SearchEntitiesByGet 

func (c *Client) SearchEntitiesByGet(ctx context.Context, params SearchEntitiesByGetParams) (SearchEntitiesByGetRes, error)

SearchEntitiesByGet invokes searchEntitiesByGet operation.

This operation finds all entities that would resolve or relate to the search candidate features specified by the `attr` and/or `attrs` query parameters. The search candidate features are treated as if they belonged to an inbound record being loaded, thus the attribute names are given by the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). If including the search candidate features as query parameters presents privacy concerns due to sensitivity of the data, they can alternately be sent in the request body using the `POST /search-entities` endpoint. **NOTE:** This operation differs from a keyword search in that it uses deterministic entity resolution rules to determine the result set. This means that features that are considered "generic" (i.e.: overly common) will be ignored just as they are during entity resolution and will not yield search results. For example, searching on a gender by itself will return no results rather than half of all entities. Similarly, a phone number such as `555-1212` may yield no results.

GET /entities

func (*Client) SearchEntitiesByPost 

func (c *Client) SearchEntitiesByPost(ctx context.Context, request SearchEntitiesByPostReq, params SearchEntitiesByPostParams) (SearchEntitiesByPostRes, error)

SearchEntitiesByPost invokes searchEntitiesByPost operation.

This operation finds all entities that would resolve or relate to the search candidate features specified in JSON request body. The search candidate features are treated as if they belonged to an inbound record being loaded. The JSON format of the request body is defined by the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). This operation is similar to the `GET /entities` endpoint in function except that it provides a means to avoid specifying potentially sensitive data in query parameters, but instead in the request body. **NOTE:** This operation differs from a keyword search in that it uses deterministic entity resolution rules to determine the result set. This means that features that are considered "generic" (i.e.: overly common) will be ignored just as they are during entity resolution and will not yield search results. For example, searching on a gender by itself will return no results rather than half of all entities. Similarly, a phone number such as `555-1212` may yield no results.

POST /search-entities

func (*Client) Version 

func (c *Client) Version(ctx context.Context, params VersionParams) (VersionRes, error)

Version invokes version operation.

This operation will obtain the full version information for the server. Much of the same information is available in the `meta` segment of every JSON response.

GET /version

func (*Client) WhyEntities 

func (c *Client) WhyEntities(ctx context.Context, params WhyEntitiesParams) (WhyEntitiesRes, error)

WhyEntities invokes whyEntities operation.

This operation provides an anlysis of why two entities related, did not relate or did not resolve. The entities are identified either by entity ID's or by data source code and record ID pairs for constituent records of those entities. **NOTE:** If the first entity is identified by entity ID then the second must also be identified an entity ID. Similarly, if the first entity is identified by data source code and record ID then the second must also be identified by data source code and record ID. **ALSO NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve.

GET /why/entities

func (*Client) WhyEntityByEntityID 

func (c *Client) WhyEntityByEntityID(ctx context.Context, params WhyEntityByEntityIDParams) (WhyEntityByEntityIDRes, error)

WhyEntityByEntityID invokes whyEntityByEntityID operation.

This operation provides an anlysis of why the records in an entity resolved. The subject entity is identified by the entity ID in the request path. **NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve. An alternative way to identify an entity is by one of its constituent records using `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why`.

GET /entities/{entityId}/why

func (*Client) WhyEntityByRecordID 

func (c *Client) WhyEntityByRecordID(ctx context.Context, params WhyEntityByRecordIDParams) (WhyEntityByRecordIDRes, error)

WhyEntityByRecordID invokes whyEntityByRecordID operation.

This operation provides an anlysis of why the records in an entity resolved. The subject entity is the one containing the record identified by the data source code and record ID in the request path.

GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why

func (*Client) WhyRecords 

func (c *Client) WhyRecords(ctx context.Context, params WhyRecordsParams) (WhyRecordsRes, error)

WhyRecords invokes whyRecords operation.

This operation provides an anlysis of two records identified by data source code and record ID in respective qeury parameters resolved or did not resolve.

GET /why/records

type ClientOption 

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption is client config option.

func WithClient 

func WithClient(client ht.Client) ClientOption

WithClient specifies http client to use.

type DeleteRecordApplicationJSONInternalServerError 

type DeleteRecordApplicationJSONInternalServerError SzErrorResponse

func (*DeleteRecordApplicationJSONInternalServerError) Decode 

func (s *DeleteRecordApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes DeleteRecordApplicationJSONInternalServerError from json.

func (*DeleteRecordApplicationJSONInternalServerError) Encode 

func (s *DeleteRecordApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes DeleteRecordApplicationJSONInternalServerError as json.

func (*DeleteRecordApplicationJSONInternalServerError) MarshalJSON 

func (s *DeleteRecordApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteRecordApplicationJSONInternalServerError) UnmarshalJSON 

func (s *DeleteRecordApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteRecordApplicationJSONInternalServerError) Validate 

func (s *DeleteRecordApplicationJSONInternalServerError) Validate() error

type DeleteRecordApplicationJSONNotFound 

type DeleteRecordApplicationJSONNotFound SzErrorResponse

func (*DeleteRecordApplicationJSONNotFound) Decode 

func (s *DeleteRecordApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes DeleteRecordApplicationJSONNotFound from json.

func (*DeleteRecordApplicationJSONNotFound) Encode 

func (s *DeleteRecordApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes DeleteRecordApplicationJSONNotFound as json.

func (*DeleteRecordApplicationJSONNotFound) MarshalJSON 

func (s *DeleteRecordApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DeleteRecordApplicationJSONNotFound) UnmarshalJSON 

func (s *DeleteRecordApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DeleteRecordApplicationJSONNotFound) Validate 

func (s *DeleteRecordApplicationJSONNotFound) Validate() error

type DeleteRecordNotFoundDefault 

type DeleteRecordNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (DeleteRecordNotFoundDefault) Read 

func (s DeleteRecordNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type DeleteRecordOKDefault 

type DeleteRecordOKDefault struct {
	Data io.Reader
}

Ref: #/components/schemas/SzDeleteRecordResponse

func (DeleteRecordOKDefault) Read 

func (s DeleteRecordOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type DeleteRecordParams 

type DeleteRecordParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// The identifier that uniquely identifies the requested record within a given data source.  This may
	// have been specified when the record was loaded or generated automatically.
	RecordId string
	// The optional load ID to associate with the loaded record.
	LoadId OptString
	// Set to `true` to include resolution information related to loading, and `false` to exclude it.
	// This defaults to `false`.
	WithInfo OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

DeleteRecordParams is parameters of deleteRecord operation.

type DeleteRecordRes 

type DeleteRecordRes interface {
	// contains filtered or unexported methods
}

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type FindEntityNetworkApplicationJSONBadRequest 

type FindEntityNetworkApplicationJSONBadRequest SzErrorResponse

func (*FindEntityNetworkApplicationJSONBadRequest) Decode 

func (s *FindEntityNetworkApplicationJSONBadRequest) Decode(d *jx.Decoder) error

Decode decodes FindEntityNetworkApplicationJSONBadRequest from json.

func (*FindEntityNetworkApplicationJSONBadRequest) Encode 

func (s *FindEntityNetworkApplicationJSONBadRequest) Encode(e *jx.Encoder)

Encode encodes FindEntityNetworkApplicationJSONBadRequest as json.

func (*FindEntityNetworkApplicationJSONBadRequest) MarshalJSON 

func (s *FindEntityNetworkApplicationJSONBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FindEntityNetworkApplicationJSONBadRequest) UnmarshalJSON 

func (s *FindEntityNetworkApplicationJSONBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FindEntityNetworkApplicationJSONBadRequest) Validate 

func (s *FindEntityNetworkApplicationJSONBadRequest) Validate() error

type FindEntityNetworkApplicationJSONInternalServerError 

type FindEntityNetworkApplicationJSONInternalServerError SzErrorResponse

func (*FindEntityNetworkApplicationJSONInternalServerError) Decode 

func (s *FindEntityNetworkApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes FindEntityNetworkApplicationJSONInternalServerError from json.

func (*FindEntityNetworkApplicationJSONInternalServerError) Encode 

func (s *FindEntityNetworkApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes FindEntityNetworkApplicationJSONInternalServerError as json.

func (*FindEntityNetworkApplicationJSONInternalServerError) MarshalJSON 

func (s *FindEntityNetworkApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FindEntityNetworkApplicationJSONInternalServerError) UnmarshalJSON 

func (s *FindEntityNetworkApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FindEntityNetworkApplicationJSONInternalServerError) Validate 

func (s *FindEntityNetworkApplicationJSONInternalServerError) Validate() error

type FindEntityNetworkBadRequestDefault 

type FindEntityNetworkBadRequestDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (FindEntityNetworkBadRequestDefault) Read 

func (s FindEntityNetworkBadRequestDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type FindEntityNetworkOKDefault 

type FindEntityNetworkOKDefault struct {
	Data io.Reader
}

The response describing a network of resolved entities. Ref: #/components/schemas/SzEntityNetworkResponse

func (FindEntityNetworkOKDefault) Read 

func (s FindEntityNetworkOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type FindEntityNetworkParams 

type FindEntityNetworkParams struct {
	// The maximum number of degrees to look for a path between the specified entities.  If not specified,
	//  this defaults to `3`. Unlike `GET /entity-paths/` the value here may be zero (0) which allows the
	// caller to specify a list of entities and simply "build out" the network around each to a maximum
	// number of degrees and up to a maximum number of entities.
	MaxDegrees OptInt8
	// The maximum number of degrees to build out around each of the specified entities regardless of
	// those entities being on the path between entities.  The number of entities built out is limited by
	// the `maxEntities` parameter.  This defaults to `1` degree if not specified.
	BuildOut OptInt8
	// The maximum number of entities to build out when the `buildOut` is greater than zero (0).  This
	// defaults to `1000` if not specified.
	MaxEntities OptInt32
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Set to `true` to include resolution statistics for features.  This defaults to `false`.
	WithFeatureStats OptBool
	// Set to `true` to include "expressed" features that are derived composite keys such as name + date
	// of birth keys.  This defaults to `false`.
	WithInternalFeatures OptBool
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

FindEntityNetworkParams is parameters of findEntityNetwork operation.

type FindEntityNetworkRes 

type FindEntityNetworkRes interface {
	// contains filtered or unexported methods
}

type FindEntityPathApplicationJSONBadRequest 

type FindEntityPathApplicationJSONBadRequest SzErrorResponse

func (*FindEntityPathApplicationJSONBadRequest) Decode 

func (s *FindEntityPathApplicationJSONBadRequest) Decode(d *jx.Decoder) error

Decode decodes FindEntityPathApplicationJSONBadRequest from json.

func (*FindEntityPathApplicationJSONBadRequest) Encode 

func (s *FindEntityPathApplicationJSONBadRequest) Encode(e *jx.Encoder)

Encode encodes FindEntityPathApplicationJSONBadRequest as json.

func (*FindEntityPathApplicationJSONBadRequest) MarshalJSON 

func (s *FindEntityPathApplicationJSONBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FindEntityPathApplicationJSONBadRequest) UnmarshalJSON 

func (s *FindEntityPathApplicationJSONBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FindEntityPathApplicationJSONBadRequest) Validate 

func (s *FindEntityPathApplicationJSONBadRequest) Validate() error

type FindEntityPathApplicationJSONInternalServerError 

type FindEntityPathApplicationJSONInternalServerError SzErrorResponse

func (*FindEntityPathApplicationJSONInternalServerError) Decode 

func (s *FindEntityPathApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes FindEntityPathApplicationJSONInternalServerError from json.

func (*FindEntityPathApplicationJSONInternalServerError) Encode 

func (s *FindEntityPathApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes FindEntityPathApplicationJSONInternalServerError as json.

func (*FindEntityPathApplicationJSONInternalServerError) MarshalJSON 

func (s *FindEntityPathApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*FindEntityPathApplicationJSONInternalServerError) UnmarshalJSON 

func (s *FindEntityPathApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*FindEntityPathApplicationJSONInternalServerError) Validate 

func (s *FindEntityPathApplicationJSONInternalServerError) Validate() error

type FindEntityPathBadRequestDefault 

type FindEntityPathBadRequestDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (FindEntityPathBadRequestDefault) Read 

func (s FindEntityPathBadRequestDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type FindEntityPathOKDefault 

type FindEntityPathOKDefault struct {
	Data io.Reader
}

The response describing a path between two resolved entities. Ref: #/components/schemas/SzEntityPathResponse

func (FindEntityPathOKDefault) Read 

func (s FindEntityPathOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type FindEntityPathParams 

type FindEntityPathParams struct {
	// The maximum number of degrees to look for a path from the first entity to the last entity.  This
	// defaults to `3` if not specified. If specified, the value must be greater-than zero (0) since a
	// path cannot exist at zero degrees of separation.
	MaxDegrees OptInt8
	// If the avoidEntities parameter is provided then this flag is used to control whether or not to
	// forbid the avoided entities rather than include them in the path as a "last resort".
	ForbidAvoided OptBool
	// The multi-valued query parameter where each value is a data source code identifying data sources
	// for which one must be included in the entities for the path.  If not provided, then the default is
	// to NOT require any specific data sources.
	S []string
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Set to `true` to include resolution statistics for features.  This defaults to `false`.
	WithFeatureStats OptBool
	// Set to `true` to include "expressed" features that are derived composite keys such as name + date
	// of birth keys.  This defaults to `false`.
	WithInternalFeatures OptBool
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

FindEntityPathParams is parameters of findEntityPath operation.

type FindEntityPathRes 

type FindEntityPathRes interface {
	// contains filtered or unexported methods
}

type GetActiveConfigOKDefault 

type GetActiveConfigOKDefault struct {
	Data io.Reader
}

The response containing raw configuration in the rawData field. Ref: #/components/schemas/SzConfigResponse

func (GetActiveConfigOKDefault) Read 

func (s GetActiveConfigOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetActiveConfigRes 

type GetActiveConfigRes interface {
	// contains filtered or unexported methods
}

type GetAttributeTypeApplicationJSONInternalServerError 

type GetAttributeTypeApplicationJSONInternalServerError SzErrorResponse

func (*GetAttributeTypeApplicationJSONInternalServerError) Decode 

func (s *GetAttributeTypeApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes GetAttributeTypeApplicationJSONInternalServerError from json.

func (*GetAttributeTypeApplicationJSONInternalServerError) Encode 

func (s *GetAttributeTypeApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes GetAttributeTypeApplicationJSONInternalServerError as json.

func (*GetAttributeTypeApplicationJSONInternalServerError) MarshalJSON 

func (s *GetAttributeTypeApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetAttributeTypeApplicationJSONInternalServerError) UnmarshalJSON 

func (s *GetAttributeTypeApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetAttributeTypeApplicationJSONInternalServerError) Validate 

func (s *GetAttributeTypeApplicationJSONInternalServerError) Validate() error

type GetAttributeTypeApplicationJSONNotFound 

type GetAttributeTypeApplicationJSONNotFound SzErrorResponse

func (*GetAttributeTypeApplicationJSONNotFound) Decode 

func (s *GetAttributeTypeApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes GetAttributeTypeApplicationJSONNotFound from json.

func (*GetAttributeTypeApplicationJSONNotFound) Encode 

func (s *GetAttributeTypeApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes GetAttributeTypeApplicationJSONNotFound as json.

func (*GetAttributeTypeApplicationJSONNotFound) MarshalJSON 

func (s *GetAttributeTypeApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetAttributeTypeApplicationJSONNotFound) UnmarshalJSON 

func (s *GetAttributeTypeApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetAttributeTypeApplicationJSONNotFound) Validate 

func (s *GetAttributeTypeApplicationJSONNotFound) Validate() error

type GetAttributeTypeNotFoundDefault 

type GetAttributeTypeNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (GetAttributeTypeNotFoundDefault) Read 

func (s GetAttributeTypeNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetAttributeTypeOKDefault 

type GetAttributeTypeOKDefault struct {
	Data io.Reader
}

The response containing information for a single attribute type. Ref: #/components/schemas/SzAttributeTypeResponse

func (GetAttributeTypeOKDefault) Read 

func (s GetAttributeTypeOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetAttributeTypeParams 

type GetAttributeTypeParams struct {
	// The attribute code that uniquely identifies the attribute type.
	AttributeCode string
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

GetAttributeTypeParams is parameters of getAttributeType operation.

type GetAttributeTypeRes 

type GetAttributeTypeRes interface {
	// contains filtered or unexported methods
}

type GetAttributeTypesOKDefault 

type GetAttributeTypesOKDefault struct {
	Data io.Reader
}

The response containing attribute type information. Ref: #/components/schemas/SzAttributeTypesResponse

func (GetAttributeTypesOKDefault) Read 

func (s GetAttributeTypesOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetAttributeTypesParams 

type GetAttributeTypesParams struct {
	// Set to `true` to include internal attribute types that are generally not mapped by users.  This
	// defaults to false.
	WithInternal OptBool
	// If specified, this filters the list of returned attribute types to those of a specific attribute
	// class.  If not specified then no filtering on attribute class is performed and all are returned.
	AttributeClass OptSzAttributeClass
	// If specified, this filters the list of returned attribute types to those belonging to a specific
	// feature type.  If not specified then no filtering on feature type is performed and all are
	// returned.
	FeatureType OptString
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

GetAttributeTypesParams is parameters of getAttributeTypes operation.

type GetAttributeTypesRes 

type GetAttributeTypesRes interface {
	// contains filtered or unexported methods
}

type GetDataSourceOKDefault 

type GetDataSourceOKDefault struct {
	Data io.Reader
}

The response describing a data source. Ref: #/components/schemas/SzDataSourceResponse

func (GetDataSourceOKDefault) Read 

func (s GetDataSourceOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetDataSourceParams 

type GetDataSourceParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

GetDataSourceParams is parameters of getDataSource operation.

type GetDataSourceRes 

type GetDataSourceRes interface {
	// contains filtered or unexported methods
}

type GetDataSourcesOKDefault 

type GetDataSourcesOKDefault struct {
	Data io.Reader
}

The response describing the configured data sources. Ref: #/components/schemas/SzDataSourcesResponse

func (GetDataSourcesOKDefault) Read 

func (s GetDataSourcesOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetDataSourcesParams 

type GetDataSourcesParams struct {
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

GetDataSourcesParams is parameters of getDataSources operation.

type GetDataSourcesRes 

type GetDataSourcesRes interface {
	// contains filtered or unexported methods
}

type GetEntityByEntityIdApplicationJSONInternalServerError 

type GetEntityByEntityIdApplicationJSONInternalServerError SzErrorResponse

func (*GetEntityByEntityIdApplicationJSONInternalServerError) Decode 

func (s *GetEntityByEntityIdApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes GetEntityByEntityIdApplicationJSONInternalServerError from json.

func (*GetEntityByEntityIdApplicationJSONInternalServerError) Encode 

func (s *GetEntityByEntityIdApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes GetEntityByEntityIdApplicationJSONInternalServerError as json.

func (*GetEntityByEntityIdApplicationJSONInternalServerError) MarshalJSON 

func (s *GetEntityByEntityIdApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetEntityByEntityIdApplicationJSONInternalServerError) UnmarshalJSON 

func (s *GetEntityByEntityIdApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetEntityByEntityIdApplicationJSONInternalServerError) Validate 

func (s *GetEntityByEntityIdApplicationJSONInternalServerError) Validate() error

type GetEntityByEntityIdApplicationJSONNotFound 

type GetEntityByEntityIdApplicationJSONNotFound SzErrorResponse

func (*GetEntityByEntityIdApplicationJSONNotFound) Decode 

func (s *GetEntityByEntityIdApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes GetEntityByEntityIdApplicationJSONNotFound from json.

func (*GetEntityByEntityIdApplicationJSONNotFound) Encode 

func (s *GetEntityByEntityIdApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes GetEntityByEntityIdApplicationJSONNotFound as json.

func (*GetEntityByEntityIdApplicationJSONNotFound) MarshalJSON 

func (s *GetEntityByEntityIdApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetEntityByEntityIdApplicationJSONNotFound) UnmarshalJSON 

func (s *GetEntityByEntityIdApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetEntityByEntityIdApplicationJSONNotFound) Validate 

func (s *GetEntityByEntityIdApplicationJSONNotFound) Validate() error

type GetEntityByEntityIdNotFoundDefault 

type GetEntityByEntityIdNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (GetEntityByEntityIdNotFoundDefault) Read 

func (s GetEntityByEntityIdNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetEntityByEntityIdOKDefault 

type GetEntityByEntityIdOKDefault struct {
	Data io.Reader
}

The response describing a resolved entity and possibly its related entities. Ref: #/components/schemas/SzEntityResponse

func (GetEntityByEntityIdOKDefault) Read 

func (s GetEntityByEntityIdOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetEntityByEntityIdParams 

type GetEntityByEntityIdParams struct {
	// The unique numeric ID that identifies that entity being requested.
	EntityId int64
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Set to `true` to include resolution statistics for features.  This defaults to `false`.
	WithFeatureStats OptBool
	// Set to `true` to include "expressed" features that are derived composite keys such as name + date
	// of birth keys.  This defaults to `false`.
	WithInternalFeatures OptBool
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Controls how to handle the first-degree related entities.  The possible values are:
	// * `NONE` - Do not include any data on first-degree related entities --
	// this is the fastest option from a performance perspective because
	// related entities do not have to be retrieved.
	// * `PARTIAL` - **(default value)** Include only partial stub
	// information for related entities with the `partial` property of the
	// `SzRelatedEntity` instances set to `true`.  Obtaining additional
	// information requires subsequent API calls.
	// * `FULL` - Include full data on the first-degree related entities
	// according to the `featureMode` and `detailLevel` **unless**
	// `forceMinimal` is `true`.  This option obtains the entity network
	// at one degree for the requested entity and will populate up to 1000
	// related entities as much as possible with respect to the
	// `featureMode` and `detailLevel`.  Related entities beyond the first
	// 1000 will be left incomplete and have their `partial` property set
	// to `true` regardless of the `detailLevel` and `featureMode`.  If
	// this value is specified along with `forceMinimal=true` then
	// `PARTIAL` is used instead.
	WithRelated OptSzRelationshipMode
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

GetEntityByEntityIdParams is parameters of getEntityByEntityId operation.

type GetEntityByEntityIdRes 

type GetEntityByEntityIdRes interface {
	// contains filtered or unexported methods
}

type GetEntityByRecordIdApplicationJSONInternalServerError 

type GetEntityByRecordIdApplicationJSONInternalServerError SzErrorResponse

func (*GetEntityByRecordIdApplicationJSONInternalServerError) Decode 

func (s *GetEntityByRecordIdApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes GetEntityByRecordIdApplicationJSONInternalServerError from json.

func (*GetEntityByRecordIdApplicationJSONInternalServerError) Encode 

func (s *GetEntityByRecordIdApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes GetEntityByRecordIdApplicationJSONInternalServerError as json.

func (*GetEntityByRecordIdApplicationJSONInternalServerError) MarshalJSON 

func (s *GetEntityByRecordIdApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetEntityByRecordIdApplicationJSONInternalServerError) UnmarshalJSON 

func (s *GetEntityByRecordIdApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetEntityByRecordIdApplicationJSONInternalServerError) Validate 

func (s *GetEntityByRecordIdApplicationJSONInternalServerError) Validate() error

type GetEntityByRecordIdApplicationJSONNotFound 

type GetEntityByRecordIdApplicationJSONNotFound SzErrorResponse

func (*GetEntityByRecordIdApplicationJSONNotFound) Decode 

func (s *GetEntityByRecordIdApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes GetEntityByRecordIdApplicationJSONNotFound from json.

func (*GetEntityByRecordIdApplicationJSONNotFound) Encode 

func (s *GetEntityByRecordIdApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes GetEntityByRecordIdApplicationJSONNotFound as json.

func (*GetEntityByRecordIdApplicationJSONNotFound) MarshalJSON 

func (s *GetEntityByRecordIdApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetEntityByRecordIdApplicationJSONNotFound) UnmarshalJSON 

func (s *GetEntityByRecordIdApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetEntityByRecordIdApplicationJSONNotFound) Validate 

func (s *GetEntityByRecordIdApplicationJSONNotFound) Validate() error

type GetEntityByRecordIdNotFoundDefault 

type GetEntityByRecordIdNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (GetEntityByRecordIdNotFoundDefault) Read 

func (s GetEntityByRecordIdNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetEntityByRecordIdOKDefault 

type GetEntityByRecordIdOKDefault struct {
	Data io.Reader
}

The response describing a resolved entity and possibly its related entities. Ref: #/components/schemas/SzEntityResponse

func (GetEntityByRecordIdOKDefault) Read 

func (s GetEntityByRecordIdOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetEntityByRecordIdParams 

type GetEntityByRecordIdParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// The identifier that uniquely identifies the requested record within a given data source.  This may
	// have been specified when the record was loaded or generated automatically.
	RecordId string
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Set to `true` to include resolution statistics for features.  This defaults to `false`.
	WithFeatureStats OptBool
	// Set to `true` to include "expressed" features that are derived composite keys such as name + date
	// of birth keys.  This defaults to `false`.
	WithInternalFeatures OptBool
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Controls how to handle the first-degree related entities.  The possible values are:
	// * `NONE` - Do not include any data on first-degree related entities --
	// this is the fastest option from a performance perspective because
	// related entities do not have to be retrieved.
	// * `PARTIAL` - **(default value)** Include only partial stub
	// information for related entities with the `partial` property of the
	// `SzRelatedEntity` instances set to `true`.  Obtaining additional
	// information requires subsequent API calls.
	// * `FULL` - Include full data on the first-degree related entities
	// according to the `featureMode` and `detailLevel` **unless**
	// `forceMinimal` is `true`.  This option obtains the entity network
	// at one degree for the requested entity and will populate up to 1000
	// related entities as much as possible with respect to the
	// `featureMode` and `detailLevel`.  Related entities beyond the first
	// 1000 will be left incomplete and have their `partial` property set
	// to `true` regardless of the `detailLevel` and `featureMode`.  If
	// this value is specified along with `forceMinimal=true` then
	// `PARTIAL` is used instead.
	WithRelated OptSzRelationshipMode
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

GetEntityByRecordIdParams is parameters of getEntityByRecordId operation.

type GetEntityByRecordIdRes 

type GetEntityByRecordIdRes interface {
	// contains filtered or unexported methods
}

type GetRecordApplicationJSONInternalServerError 

type GetRecordApplicationJSONInternalServerError SzErrorResponse

func (*GetRecordApplicationJSONInternalServerError) Decode 

func (s *GetRecordApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes GetRecordApplicationJSONInternalServerError from json.

func (*GetRecordApplicationJSONInternalServerError) Encode 

func (s *GetRecordApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes GetRecordApplicationJSONInternalServerError as json.

func (*GetRecordApplicationJSONInternalServerError) MarshalJSON 

func (s *GetRecordApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetRecordApplicationJSONInternalServerError) UnmarshalJSON 

func (s *GetRecordApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetRecordApplicationJSONInternalServerError) Validate 

func (s *GetRecordApplicationJSONInternalServerError) Validate() error

type GetRecordApplicationJSONNotFound 

type GetRecordApplicationJSONNotFound SzErrorResponse

func (*GetRecordApplicationJSONNotFound) Decode 

func (s *GetRecordApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes GetRecordApplicationJSONNotFound from json.

func (*GetRecordApplicationJSONNotFound) Encode 

func (s *GetRecordApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes GetRecordApplicationJSONNotFound as json.

func (*GetRecordApplicationJSONNotFound) MarshalJSON 

func (s *GetRecordApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetRecordApplicationJSONNotFound) UnmarshalJSON 

func (s *GetRecordApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetRecordApplicationJSONNotFound) Validate 

func (s *GetRecordApplicationJSONNotFound) Validate() error

type GetRecordNotFoundDefault 

type GetRecordNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (GetRecordNotFoundDefault) Read 

func (s GetRecordNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetRecordOKDefault 

type GetRecordOKDefault struct {
	Data io.Reader
}

The response describing an entity record. Ref: #/components/schemas/SzRecordResponse

func (GetRecordOKDefault) Read 

func (s GetRecordOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetRecordParams 

type GetRecordParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// The identifier that uniquely identifies the requested record within a given data source.  This may
	// have been specified when the record was loaded or generated automatically.
	RecordId string
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

GetRecordParams is parameters of getRecord operation.

type GetRecordRes 

type GetRecordRes interface {
	// contains filtered or unexported methods
}

type GetServerInfoOKDefault 

type GetServerInfoOKDefault struct {
	Data io.Reader
}

The response containing the server info. Ref: #/components/schemas/SzServerInfoResponse

func (GetServerInfoOKDefault) Read 

func (s GetServerInfoOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetServerInfoRes 

type GetServerInfoRes interface {
	// contains filtered or unexported methods
}

type GetTemplateConfigOKDefault 

type GetTemplateConfigOKDefault struct {
	Data io.Reader
}

The response containing raw configuration in the rawData field. Ref: #/components/schemas/SzConfigResponse

func (GetTemplateConfigOKDefault) Read 

func (s GetTemplateConfigOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetTemplateConfigRes 

type GetTemplateConfigRes interface {
	// contains filtered or unexported methods
}

type GetVirtualEntityByRecordIdsApplicationJSONBadRequest 

type GetVirtualEntityByRecordIdsApplicationJSONBadRequest SzErrorResponse

func (*GetVirtualEntityByRecordIdsApplicationJSONBadRequest) Decode 

func (s *GetVirtualEntityByRecordIdsApplicationJSONBadRequest) Decode(d *jx.Decoder) error

Decode decodes GetVirtualEntityByRecordIdsApplicationJSONBadRequest from json.

func (*GetVirtualEntityByRecordIdsApplicationJSONBadRequest) Encode 

func (s *GetVirtualEntityByRecordIdsApplicationJSONBadRequest) Encode(e *jx.Encoder)

Encode encodes GetVirtualEntityByRecordIdsApplicationJSONBadRequest as json.

func (*GetVirtualEntityByRecordIdsApplicationJSONBadRequest) MarshalJSON 

func (s *GetVirtualEntityByRecordIdsApplicationJSONBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetVirtualEntityByRecordIdsApplicationJSONBadRequest) UnmarshalJSON 

func (s *GetVirtualEntityByRecordIdsApplicationJSONBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetVirtualEntityByRecordIdsApplicationJSONBadRequest) Validate 

func (s *GetVirtualEntityByRecordIdsApplicationJSONBadRequest) Validate() error

type GetVirtualEntityByRecordIdsApplicationJSONInternalServerError 

type GetVirtualEntityByRecordIdsApplicationJSONInternalServerError SzErrorResponse

func (*GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) Decode 

func (s *GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes GetVirtualEntityByRecordIdsApplicationJSONInternalServerError from json.

func (*GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) Encode 

func (s *GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes GetVirtualEntityByRecordIdsApplicationJSONInternalServerError as json.

func (*GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) MarshalJSON 

func (s *GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) UnmarshalJSON 

func (s *GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) Validate 

func (s *GetVirtualEntityByRecordIdsApplicationJSONInternalServerError) Validate() error

type GetVirtualEntityByRecordIdsBadRequestDefault 

type GetVirtualEntityByRecordIdsBadRequestDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (GetVirtualEntityByRecordIdsBadRequestDefault) Read 

func (s GetVirtualEntityByRecordIdsBadRequestDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetVirtualEntityByRecordIdsOKDefault 

type GetVirtualEntityByRecordIdsOKDefault struct {
	Data io.Reader
}

The response describing a simulated virtual entity and possibly its related entities. Ref: #/components/schemas/SzVirtualEntityResponse

func (GetVirtualEntityByRecordIdsOKDefault) Read 

func (s GetVirtualEntityByRecordIdsOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type GetVirtualEntityByRecordIdsParams 

type GetVirtualEntityByRecordIdsParams struct {
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Set to `true` to include resolution statistics for features.  This defaults to `false`.
	WithFeatureStats OptBool
	// Set to `true` to include "expressed" features that are derived composite keys such as name + date
	// of birth keys.  This defaults to `false`.
	WithInternalFeatures OptBool
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

GetVirtualEntityByRecordIdsParams is parameters of getVirtualEntityByRecordIds operation.

type GetVirtualEntityByRecordIdsRes 

type GetVirtualEntityByRecordIdsRes interface {
	// contains filtered or unexported methods
}

type Handler 

type Handler interface {
	// AddDataSources implements addDataSources operation.
	//
	// Obtains the current default configuration, adds the specified data
	// sources and sets the modified configuration as the new default
	// configuration -- returning the set of all configured data sources.
	// **NOTE:** This operation may not be allowed.  Some conditions that
	// might cause this operation to be forbidden are:
	// 1. The server does not have administrative functions enabled.
	// 2. The server is running in "read-only" mode.
	// 3. The server is started with a file-based configuration specified
	// by `G2CONFIGFILE` property in the initialziation parameters.
	// 4. The server is started with a specific configuration ID and
	// therefore cannot modify the configuration and change to a new
	// configuration.
	//
	// POST /data-sources
	AddDataSources(ctx context.Context, req AddDataSourcesReq, params AddDataSourcesParams) (AddDataSourcesRes, error)
	// AddRecord implements addRecord operation.
	//
	// This operation loads a single record using the data source identified by
	// the data source code in the request path.  The record will be identified
	// uniquely within the data source by the record ID provided in the request
	// path.  The provided record in the request body is described in JSON
	// using the [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// The provided JSON record may omit the `RECORD_ID`, but if it contains a
	// `RECORD_ID` then it **must** match the record ID provided on the request
	// path.  The record ID is returned as part of the response.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the load.  This can be used to update a search index
	// or external data mart.   Additionally, Senzing API Server provides a
	// means to have the "raw" entity resolution info (from the underlying
	// native Senzing API) automatically sent to a messaging service such as
	// those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the
	// `withInfo` query parameter value.
	//
	// PUT /data-sources/{dataSourceCode}/records/{recordId}
	AddRecord(ctx context.Context, req AddRecordReq, params AddRecordParams) (AddRecordRes, error)
	// AddRecordWithReturnedRecordId implements addRecordWithReturnedRecordId operation.
	//
	// This operation loads a single record using the data source identified by
	// the data source code in the request path.  The provided record in the
	// request body is described in JSON using the
	// [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// The provided record may contain a `RECORD_ID` to identify it uniquely
	// among other records in the same data source, but if it does not then a
	// record ID will be automatically generated.  The record ID is returned
	// as part of the response.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the load.  This can be used to update a search index
	// or external data mart.   Additionally, Senzing API Server provides a
	// means to have the "raw" entity resolution info (from the underlying
	// native Senzing API) automatically sent to a messaging service such as
	// those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the
	// `withInfo` query parameter value.
	//
	// POST /data-sources/{dataSourceCode}/records
	AddRecordWithReturnedRecordId(ctx context.Context, req AddRecordWithReturnedRecordIdReq, params AddRecordWithReturnedRecordIdParams) (AddRecordWithReturnedRecordIdRes, error)
	// AnalyzeBulkRecords implements analyzeBulkRecords operation.
	//
	// Provides a means to analyze a bulk data file of records prior to loading
	// it.  The records are encoded as a JSON array of JSON objects, a single
	// JSON object per line in JSON-lines file format, or as a CSV with one
	// record per row.  The data should be in pre-mapped format using JSON
	// property names or CSV column names as described by the
	// [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// **SCALABILITY NOTE:** This operation can be invoked in three ways.  In
	// order of increasingly better scalability these are listed below:
	// 1. Standard HTTP Request/Response
	// 2. HTTP Request with SSE Response (see below)
	// 3. HTTP Upgrade Request for Web Sockets (see below)
	// Standard HTTP Request/Response (method 1) has the worst scalability
	// because a long-running operation will tie up a Web Server thread **and**
	// continue until complete even if the client aborts the operation since
	// no data is written back to the client until complete and therefore the
	// terminated connection will not be detected.  SSE (method 2) mitigates
	// the problem of detecting when a client has aborted the operation
	// because periodic progress responses are written to the client and
	// therefore a terminated connection will be detected.  However, the best
	// way to invoke this operation is via Web Sockets (method 3) which not
	// only can detect disconnection of the client, but it also upgrades the
	// request to use its own thread outside the Web Server thread pool.
	// **SSE NOTE:** This end-point supports "Server-sent Events" (SSE) via the
	// `text/event-stream` media type.  This support is activated by adding the
	// `Accept: text/event-stream` header to a request to override the
	// default `application/json` media type.  Further, the end-point will behave
	// similarly to its standard operation but will produce `progress` events
	// at regular intervals that are equivalent to its `200` response schema.
	// Upon success, the final event will be `completed` with the same response
	// schema as a `200` response.  Upon failure, the final event will be
	// `failed` with same `SzErrorResponse` schema as the `4xx` or `5xx`.
	// **WEB SOCKETS NOTE**: If invoking via Web Sockets then the client may
	// send text or binary chunks of the JSON, JSON-Lines or CSV bulk data file
	// as messages.  In Web Sockets, text messages are *always* sent as UTF-8.
	// If the file's character encoding is unknown then the client should send
	// binary messages and the server will attempt to auto-detect the character
	// encoding.  Each message should adhere to the maximum message size
	// specified by the `webSocketsMessageMaxSize` property returned by the
	// `GET /server-info` end-point.  The end of file is detected when the
	// number of seconds specified by the `eofSendTimeout` query parameter have
	// elapsed without a new message being received.
	//
	// POST /bulk-data/analyze
	AnalyzeBulkRecords(ctx context.Context, req AnalyzeBulkRecordsReq, params AnalyzeBulkRecordsParams) (AnalyzeBulkRecordsRes, error)
	// DeleteRecord implements deleteRecord operation.
	//
	// This operation deletes a single record identified by the data source
	// code and record ID in the request path.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the delete.  This can be used to update a search
	// index or external data mart.   Additionally, Senzing API Server provides
	// a means to have the "raw" entity resolution info (from the underlying
	// native Senzing API) automatically sent to a messaging service such as
	// those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the
	// `withInfo` query parameter value.
	//
	// DELETE /data-sources/{dataSourceCode}/records/{recordId}
	DeleteRecord(ctx context.Context, params DeleteRecordParams) (DeleteRecordRes, error)
	// FindEntityNetwork implements findEntityNetwork operation.
	//
	// This operation finds the entity network around one or more entities.
	// This attempts to find paths between the specified entities.  If no
	// paths exist, then island networks are returned with each island network
	// containing up to a specified number of related entities.  The entities
	// are identified by their entity IDs or by data source code and record ID
	// pairs for constituent records of those entities.
	// **NOTE:** If the first entity is identified by entity ID then the
	// subsequent entities must also be identified entity ID.  Similarly, if
	// the first entity is identified by the data source code and record ID
	// of a consistuent record then the subsequent entities must also be
	// identified by the data source code and record ID of constituent records.
	// **ALSO NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.
	//
	// GET /entity-networks
	FindEntityNetwork(ctx context.Context, params FindEntityNetworkParams) (FindEntityNetworkRes, error)
	// FindEntityPath implements findEntityPath operation.
	//
	// This operation finds the path between two entities and returns a
	// description of that entity path (if any) or a response indicating that
	// there is no path between the entities.  The subject entities are either
	// identfieid by entity ID or by data source code and record ID pairs for
	// constituent records of those entities.
	// **NOTE:** If the first entity is identified by entity ID then the second
	// must also be identified an entity ID.  Similarly, if the first entity is
	// identified by data source code and record ID then the second must also
	// be identified by data source code and record ID.
	// **ALSO NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.
	//
	// GET /entity-paths
	FindEntityPath(ctx context.Context, params FindEntityPathParams) (FindEntityPathRes, error)
	// GetActiveConfig implements getActiveConfig operation.
	//
	// This operation returns the JSON configuration that is currently being
	// used by the native Senzing API initialized by the running server.  No
	// processing or interpretation is performed on the JSON.  This may differ
	// from the registered "default configuration" which the server would
	// use if no other configuration were provided.
	//
	// GET /configs/active
	GetActiveConfig(ctx context.Context) (GetActiveConfigRes, error)
	// GetAttributeType implements getAttributeType operation.
	//
	// This operation will provide a description of a single attribute type for
	// the specified attribute type code.
	//
	// GET /attribute-types/{attributeCode}
	GetAttributeType(ctx context.Context, params GetAttributeTypeParams) (GetAttributeTypeRes, error)
	// GetAttributeTypes implements getAttributeTypes operation.
	//
	// This operation will provide a list of attribute types that are
	// configured.  The client can filter the returned list of attribute types
	// using various query parameters.
	//
	// GET /attribute-types
	GetAttributeTypes(ctx context.Context, params GetAttributeTypesParams) (GetAttributeTypesRes, error)
	// GetDataSource implements getDataSource operation.
	//
	// This operation provides details on a specific data source identified
	// by the data source code in the requested path.
	//
	// GET /data-sources/{dataSourceCode}
	GetDataSource(ctx context.Context, params GetDataSourceParams) (GetDataSourceRes, error)
	// GetDataSources implements getDataSources operation.
	//
	// This operation will provide a list of data source codes as well as a
	// list of detailed descriptions of each data source.
	//
	// GET /data-sources
	GetDataSources(ctx context.Context, params GetDataSourcesParams) (GetDataSourcesRes, error)
	// GetEntityByEntityId implements getEntityByEntityId operation.
	//
	// Gets the details on a resolved entity that is identified by the entity
	// ID specified in the request path.
	// **NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.  An alternative way to identify an entity is
	// by one of its constituent records using
	// `GET /data-sources/{dataSourceCode}/records/{recordId}/entity`.
	//
	// GET /entities/{entityId}
	GetEntityByEntityId(ctx context.Context, params GetEntityByEntityIdParams) (GetEntityByEntityIdRes, error)
	// GetEntityByRecordId implements getEntityByRecordId operation.
	//
	// Gets the details on a resolved entity that contains the record
	// identified by the data source code and record ID in the specified
	// request path.
	//
	// GET /data-sources/{dataSourceCode}/records/{recordId}/entity
	GetEntityByRecordId(ctx context.Context, params GetEntityByRecordIdParams) (GetEntityByRecordIdRes, error)
	// GetRecord implements getRecord operation.
	//
	// Gets details on a specific entity record identified by the data source
	// code and record ID specified in the request path.
	//
	// GET /data-sources/{dataSourceCode}/records/{recordId}
	GetRecord(ctx context.Context, params GetRecordParams) (GetRecordRes, error)
	// GetServerInfo implements getServerInfo operation.
	//
	// This operation will provides server information describing the options
	// with which the server was started.  This can be used to determine if
	// the admin operations are enabled or if only read operations may be
	// invoked.  This also allows the client to know the maximum message size
	// for Web Sockets communication.
	//
	// GET /server-info
	GetServerInfo(ctx context.Context) (GetServerInfoRes, error)
	// GetTemplateConfig implements getTemplateConfig operation.
	//
	// This operation returns a template base JSON configuration that can be
	// modified or customized by the caller.  The returned template is
	// according to the underlying native Senzing API and may change between
	// version upgrades to Senzing.  No processing or interpretation is
	// performed on the JSON.  This will likely differ from the registered
	// "default configuration" or currently "active configuration" being used
	// by the running API server.
	//
	// GET /configs/template
	GetTemplateConfig(ctx context.Context) (GetTemplateConfigRes, error)
	// GetVirtualEntityByRecordIds implements getVirtualEntityByRecordIds operation.
	//
	// This operation simulates the resolution of the one or more specified
	// records into a single entity and returns the simulated "virtual"
	// entity.  The subject records are identified by data source code and
	// record ID pairs.
	//
	// GET /virtual-entities
	GetVirtualEntityByRecordIds(ctx context.Context, params GetVirtualEntityByRecordIdsParams) (GetVirtualEntityByRecordIdsRes, error)
	// Heartbeat implements heartbeat operation.
	//
	// The heartbeat operation can be used to ensure that the HTTP server is
	// indeed running, but this operation does not call upon the underlying
	// native Senzing API and therefore does not ensure the Senzing
	// initialization or configuration is valid.
	//
	// GET /heartbeat
	Heartbeat(ctx context.Context) (*SzBaseResponse, error)
	// HowEntityByEntityID implements howEntityByEntityID operation.
	//
	// This operation provides an anlysis of how the records in an entity
	// resolved.  The subject entity is identified by the entity ID in the
	// request path.
	// **NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.  An alternative way to identify an entity is
	// by one of its constituent records using
	// `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/how`.
	//
	// GET /entities/{entityId}/how
	HowEntityByEntityID(ctx context.Context, params HowEntityByEntityIDParams) (HowEntityByEntityIDRes, error)
	// HowEntityByRecordID implements howEntityByRecordID operation.
	//
	// This operation provides an anlysis of how the records in an entity
	// resolved.  The subject entity is the one containing the record
	// identified by the data source code and record ID in the request path.
	//
	// GET /data-sources/{dataSourceCode}/records/{recordId}/entity/how
	HowEntityByRecordID(ctx context.Context, params HowEntityByRecordIDParams) (HowEntityByRecordIDRes, error)
	// License implements license operation.
	//
	// This operation will obtain license information for the underlying
	// native Senzing API.
	//
	// GET /license
	License(ctx context.Context, params LicenseParams) (LicenseRes, error)
	// LoadBulkRecords implements loadBulkRecords operation.
	//
	// Provides a means to load a bulk data file of records.  The records are
	// encoded as a JSON array of JSON objects, a single JSON object per line
	// in JSON-lines file format, or as a CSV with one record per row.  The
	// data should be in pre-mapped format using JSON property names or CSV
	// column names as described by the
	// [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// **SCALABILITY NOTE:** This operation can be invoked in three ways.  In
	// order of increasingly better scalability these are listed below:
	// 1. Standard HTTP Request/Response
	// 2. HTTP Request with SSE Response (see below)
	// 3. HTTP Upgrade Request for Web Sockets (see below)
	// Standard HTTP Request/Response (method 1) has the worst scalability
	// because a long-running operation will tie up a Web Server thread **and**
	// continue until complete even if the client aborts the operation since
	// no data is written back to the client until complete and therefore the
	// terminated connection will not be detected.  SSE (method 2) mitigates
	// the problem of detecting when a client has aborted the operation
	// because periodic progress responses are written to the client and
	// therefore a terminated connection will be detected.  However, the best
	// way to invoke this operation is via Web Sockets (method 3) which not
	// only can detect disconnection of the client, but it also upgrades the
	// request to use its own thread outside the Web Server thread pool.
	// **SSE NOTE:** This end-point supports "Server-sent Events" (SSE) via the
	// `text/event-stream` media type.  This support is activated by adding the
	// `Accept: text/event-stream` header to a request to override the
	// default `application/json` media type.  Further, the end-point will behave
	// similarly to its standard operation but will produce `progress` events
	// at regular intervals that are equivalent to its `200` response schema.
	// Upon success, the final event will be `completed` with the same response
	// schema as a `200` response.  Upon failure, the final event will be
	// `failed` with same `SzErrorResponse` schema as the `4xx` or `5xx`.
	// **WEB SOCKETS NOTE**: If invoking via Web Sockets then the client may
	// send text or binary chunks of the JSON, JSON-Lines or CSV bulk data file
	// as messages.  In Web Sockets, text messages are *always* sent as UTF-8.
	// If the file's character encoding is unknown then the client should send
	// binary messages and the server will attempt to auto-detect the character
	// encoding.  Each message should adhere to the maximum message size
	// specified by the `webSocketsMessageMaxSize` property returned by the
	// `GET /server-info` end-point.  The end of file is detected when the
	// number of seconds specified by the `eofSendTimeout` query parameter have
	// elapsed without a new message being received.
	//
	// POST /bulk-data/load
	LoadBulkRecords(ctx context.Context, req LoadBulkRecordsReq, params LoadBulkRecordsParams) (LoadBulkRecordsRes, error)
	// OpenAPISpecification implements openAPISpecification operation.
	//
	// This operation can be used to obtain the Open API specification in JSON
	// format.  The specification can either be the `data` field of a standard
	// response (i.e.: a response with a `meta`, `links` and `data` field) or
	// as raw format where the root JSON document is the Open API specification
	// JSON.
	//
	// GET /specifications/open-api
	OpenAPISpecification(ctx context.Context) (OpenAPISpecificationOKDefault, error)
	// ReevaluateEntity implements reevaluateEntity operation.
	//
	// Reevaluates an entity identified by the entity ID specified via the
	// `entityId` query parameter.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the reevaluation.  This can be used to update a
	// search index or external data mart.   Additionally, Senzing API Server
	// provides a means to have the "raw" entity resolution info (from the
	// underlying native Senzing API) automatically sent to a messaging service
	// such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of
	// the `withInfo` query parameter value.
	// **ALSO NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.
	//
	// POST /reevaluate-entity
	ReevaluateEntity(ctx context.Context, params ReevaluateEntityParams) (ReevaluateEntityRes, error)
	// ReevaluateRecord implements reevaluateRecord operation.
	//
	// This operation reevaluates a single record identified by the data source
	// code and record ID in the request path.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the reevaluation.  This can be used to update a
	// search index or external data mart.   Additionally, Senzing API Server
	// provides a means to have the "raw" entity resolution info (from the
	// underlying native Senzing API) automatically sent to a messaging service
	// such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of
	// the `withInfo` query parameter value.
	//
	// POST /data-sources/{dataSourceCode}/records/{recordId}/reevaluate
	ReevaluateRecord(ctx context.Context, params ReevaluateRecordParams) (ReevaluateRecordRes, error)
	// Root implements root operation.
	//
	// The root operation can be used to ensure that the HTTP server is
	// indeed running, but this operation does not call upon the underlying
	// native Senzing API and therefore does not ensure the Senzing
	// initialization or configuration is valid.
	//
	// GET /
	Root(ctx context.Context) (*SzBaseResponse, error)
	// SearchEntitiesByGet implements searchEntitiesByGet operation.
	//
	// This operation finds all entities that would resolve or relate to the
	// search candidate features specified by the `attr` and/or `attrs` query
	// parameters.  The search candidate features are treated as if they
	// belonged to an inbound record being loaded, thus the attribute names are
	// given by the [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// If including the search candidate features as query parameters presents
	// privacy concerns due to sensitivity of the data, they can alternately
	// be sent in the request body using the `POST /search-entities` endpoint.
	// **NOTE:** This operation differs from a keyword search in that it uses
	// deterministic entity resolution rules to determine the result set.  This
	// means that features that are considered "generic" (i.e.: overly common)
	// will be ignored just as they are during entity resolution and will not
	// yield search results.  For example, searching on a gender by itself will
	// return no results rather than half of all entities.  Similarly, a phone
	// number such as `555-1212` may yield no results.
	//
	// GET /entities
	SearchEntitiesByGet(ctx context.Context, params SearchEntitiesByGetParams) (SearchEntitiesByGetRes, error)
	// SearchEntitiesByPost implements searchEntitiesByPost operation.
	//
	// This operation finds all entities that would resolve or relate to the
	// search candidate features specified in JSON request body.  The search
	// candidate features are treated as if they belonged to an inbound record
	// being loaded.  The JSON format of the request body is defined by the
	// [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// This operation is similar to the `GET /entities` endpoint in function
	// except that it provides a means to avoid specifying potentially
	// sensitive data in query parameters, but instead in the request body.
	// **NOTE:** This operation differs from a keyword search in that it uses
	// deterministic entity resolution rules to determine the result set.  This
	// means that features that are considered "generic" (i.e.: overly common)
	// will be ignored just as they are during entity resolution and will not
	// yield search results.  For example, searching on a gender by itself will
	// return no results rather than half of all entities.  Similarly, a phone
	// number such as `555-1212` may yield no results.
	//
	// POST /search-entities
	SearchEntitiesByPost(ctx context.Context, req SearchEntitiesByPostReq, params SearchEntitiesByPostParams) (SearchEntitiesByPostRes, error)
	// Version implements version operation.
	//
	// This operation will obtain the full version information for the server.
	// Much of the same information is available in the `meta` segment of
	// every JSON response.
	//
	// GET /version
	Version(ctx context.Context, params VersionParams) (VersionRes, error)
	// WhyEntities implements whyEntities operation.
	//
	// This operation provides an anlysis of why two entities related, did not
	// relate or did not resolve.  The entities are identified either by
	// entity ID's or by data source code and record ID pairs for constituent
	// records of those entities.
	// **NOTE:** If the first entity is identified by entity ID then the second
	// must also be identified an entity ID.  Similarly, if the first entity is
	// identified by data source code and record ID then the second must also
	// be identified by data source code and record ID.
	// **ALSO NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.
	//
	// GET /why/entities
	WhyEntities(ctx context.Context, params WhyEntitiesParams) (WhyEntitiesRes, error)
	// WhyEntityByEntityID implements whyEntityByEntityID operation.
	//
	// This operation provides an anlysis of why the records in an entity
	// resolved.  The subject entity is identified by the entity ID in the
	// request path.
	// **NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.  An alternative way to identify an entity is
	// by one of its constituent records using
	// `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why`.
	//
	// GET /entities/{entityId}/why
	WhyEntityByEntityID(ctx context.Context, params WhyEntityByEntityIDParams) (WhyEntityByEntityIDRes, error)
	// WhyEntityByRecordID implements whyEntityByRecordID operation.
	//
	// This operation provides an anlysis of why the records in an entity
	// resolved.  The subject entity is the one containing the record
	// identified by the data source code and record ID in the request path.
	//
	// GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why
	WhyEntityByRecordID(ctx context.Context, params WhyEntityByRecordIDParams) (WhyEntityByRecordIDRes, error)
	// WhyRecords implements whyRecords operation.
	//
	// This operation provides an anlysis of two records identified by data
	// source code and record ID in respective qeury parameters resolved or
	// did not resolve.
	//
	// GET /why/records
	WhyRecords(ctx context.Context, params WhyRecordsParams) (WhyRecordsRes, error)
}

Handler handles operations described by OpenAPI v3 specification.

type HowEntityByEntityIDApplicationJSONInternalServerError 

type HowEntityByEntityIDApplicationJSONInternalServerError SzErrorResponse

func (*HowEntityByEntityIDApplicationJSONInternalServerError) Decode 

func (s *HowEntityByEntityIDApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes HowEntityByEntityIDApplicationJSONInternalServerError from json.

func (*HowEntityByEntityIDApplicationJSONInternalServerError) Encode 

func (s *HowEntityByEntityIDApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes HowEntityByEntityIDApplicationJSONInternalServerError as json.

func (*HowEntityByEntityIDApplicationJSONInternalServerError) MarshalJSON 

func (s *HowEntityByEntityIDApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*HowEntityByEntityIDApplicationJSONInternalServerError) UnmarshalJSON 

func (s *HowEntityByEntityIDApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*HowEntityByEntityIDApplicationJSONInternalServerError) Validate 

func (s *HowEntityByEntityIDApplicationJSONInternalServerError) Validate() error

type HowEntityByEntityIDApplicationJSONNotFound 

type HowEntityByEntityIDApplicationJSONNotFound SzErrorResponse

func (*HowEntityByEntityIDApplicationJSONNotFound) Decode 

func (s *HowEntityByEntityIDApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes HowEntityByEntityIDApplicationJSONNotFound from json.

func (*HowEntityByEntityIDApplicationJSONNotFound) Encode 

func (s *HowEntityByEntityIDApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes HowEntityByEntityIDApplicationJSONNotFound as json.

func (*HowEntityByEntityIDApplicationJSONNotFound) MarshalJSON 

func (s *HowEntityByEntityIDApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*HowEntityByEntityIDApplicationJSONNotFound) UnmarshalJSON 

func (s *HowEntityByEntityIDApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*HowEntityByEntityIDApplicationJSONNotFound) Validate 

func (s *HowEntityByEntityIDApplicationJSONNotFound) Validate() error

type HowEntityByEntityIDNotFoundDefault 

type HowEntityByEntityIDNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (HowEntityByEntityIDNotFoundDefault) Read 

func (s HowEntityByEntityIDNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type HowEntityByEntityIDOKDefault 

type HowEntityByEntityIDOKDefault struct {
	Data io.Reader
}

The response describing the result of the "how entity" operation. Ref: #/components/schemas/SzHowEntityResponse

func (HowEntityByEntityIDOKDefault) Read 

func (s HowEntityByEntityIDOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type HowEntityByEntityIDParams 

type HowEntityByEntityIDParams struct {
	// The unique numeric ID that identifies the entity for which to perform the analysis.
	EntityId int64
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

HowEntityByEntityIDParams is parameters of howEntityByEntityID operation.

type HowEntityByEntityIDRes 

type HowEntityByEntityIDRes interface {
	// contains filtered or unexported methods
}

type HowEntityByRecordIDApplicationJSONInternalServerError 

type HowEntityByRecordIDApplicationJSONInternalServerError SzErrorResponse

func (*HowEntityByRecordIDApplicationJSONInternalServerError) Decode 

func (s *HowEntityByRecordIDApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes HowEntityByRecordIDApplicationJSONInternalServerError from json.

func (*HowEntityByRecordIDApplicationJSONInternalServerError) Encode 

func (s *HowEntityByRecordIDApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes HowEntityByRecordIDApplicationJSONInternalServerError as json.

func (*HowEntityByRecordIDApplicationJSONInternalServerError) MarshalJSON 

func (s *HowEntityByRecordIDApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*HowEntityByRecordIDApplicationJSONInternalServerError) UnmarshalJSON 

func (s *HowEntityByRecordIDApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*HowEntityByRecordIDApplicationJSONInternalServerError) Validate 

func (s *HowEntityByRecordIDApplicationJSONInternalServerError) Validate() error

type HowEntityByRecordIDApplicationJSONNotFound 

type HowEntityByRecordIDApplicationJSONNotFound SzErrorResponse

func (*HowEntityByRecordIDApplicationJSONNotFound) Decode 

func (s *HowEntityByRecordIDApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes HowEntityByRecordIDApplicationJSONNotFound from json.

func (*HowEntityByRecordIDApplicationJSONNotFound) Encode 

func (s *HowEntityByRecordIDApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes HowEntityByRecordIDApplicationJSONNotFound as json.

func (*HowEntityByRecordIDApplicationJSONNotFound) MarshalJSON 

func (s *HowEntityByRecordIDApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*HowEntityByRecordIDApplicationJSONNotFound) UnmarshalJSON 

func (s *HowEntityByRecordIDApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*HowEntityByRecordIDApplicationJSONNotFound) Validate 

func (s *HowEntityByRecordIDApplicationJSONNotFound) Validate() error

type HowEntityByRecordIDNotFoundDefault 

type HowEntityByRecordIDNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (HowEntityByRecordIDNotFoundDefault) Read 

func (s HowEntityByRecordIDNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type HowEntityByRecordIDOKDefault 

type HowEntityByRecordIDOKDefault struct {
	Data io.Reader
}

The response describing the result of the "how entity" operation. Ref: #/components/schemas/SzHowEntityResponse

func (HowEntityByRecordIDOKDefault) Read 

func (s HowEntityByRecordIDOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type HowEntityByRecordIDParams 

type HowEntityByRecordIDParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// The identifier that uniquely identifies the requested record within a given data source.  This may
	// have been specified when the record was loaded or generated automatically.
	RecordId string
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

HowEntityByRecordIDParams is parameters of howEntityByRecordID operation.

type HowEntityByRecordIDRes 

type HowEntityByRecordIDRes interface {
	// contains filtered or unexported methods
}

type Invoker added in v0.9.0 

type Invoker interface {
	// AddDataSources invokes addDataSources operation.
	//
	// Obtains the current default configuration, adds the specified data
	// sources and sets the modified configuration as the new default
	// configuration -- returning the set of all configured data sources.
	// **NOTE:** This operation may not be allowed.  Some conditions that
	// might cause this operation to be forbidden are:
	// 1. The server does not have administrative functions enabled.
	// 2. The server is running in "read-only" mode.
	// 3. The server is started with a file-based configuration specified
	// by `G2CONFIGFILE` property in the initialziation parameters.
	// 4. The server is started with a specific configuration ID and
	// therefore cannot modify the configuration and change to a new
	// configuration.
	//
	// POST /data-sources
	AddDataSources(ctx context.Context, request AddDataSourcesReq, params AddDataSourcesParams) (AddDataSourcesRes, error)
	// AddRecord invokes addRecord operation.
	//
	// This operation loads a single record using the data source identified by
	// the data source code in the request path.  The record will be identified
	// uniquely within the data source by the record ID provided in the request
	// path.  The provided record in the request body is described in JSON
	// using the [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// The provided JSON record may omit the `RECORD_ID`, but if it contains a
	// `RECORD_ID` then it **must** match the record ID provided on the request
	// path.  The record ID is returned as part of the response.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the load.  This can be used to update a search index
	// or external data mart.   Additionally, Senzing API Server provides a
	// means to have the "raw" entity resolution info (from the underlying
	// native Senzing API) automatically sent to a messaging service such as
	// those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the
	// `withInfo` query parameter value.
	//
	// PUT /data-sources/{dataSourceCode}/records/{recordId}
	AddRecord(ctx context.Context, request AddRecordReq, params AddRecordParams) (AddRecordRes, error)
	// AddRecordWithReturnedRecordId invokes addRecordWithReturnedRecordId operation.
	//
	// This operation loads a single record using the data source identified by
	// the data source code in the request path.  The provided record in the
	// request body is described in JSON using the
	// [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// The provided record may contain a `RECORD_ID` to identify it uniquely
	// among other records in the same data source, but if it does not then a
	// record ID will be automatically generated.  The record ID is returned
	// as part of the response.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the load.  This can be used to update a search index
	// or external data mart.   Additionally, Senzing API Server provides a
	// means to have the "raw" entity resolution info (from the underlying
	// native Senzing API) automatically sent to a messaging service such as
	// those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the
	// `withInfo` query parameter value.
	//
	// POST /data-sources/{dataSourceCode}/records
	AddRecordWithReturnedRecordId(ctx context.Context, request AddRecordWithReturnedRecordIdReq, params AddRecordWithReturnedRecordIdParams) (AddRecordWithReturnedRecordIdRes, error)
	// AnalyzeBulkRecords invokes analyzeBulkRecords operation.
	//
	// Provides a means to analyze a bulk data file of records prior to loading
	// it.  The records are encoded as a JSON array of JSON objects, a single
	// JSON object per line in JSON-lines file format, or as a CSV with one
	// record per row.  The data should be in pre-mapped format using JSON
	// property names or CSV column names as described by the
	// [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// **SCALABILITY NOTE:** This operation can be invoked in three ways.  In
	// order of increasingly better scalability these are listed below:
	// 1. Standard HTTP Request/Response
	// 2. HTTP Request with SSE Response (see below)
	// 3. HTTP Upgrade Request for Web Sockets (see below)
	// Standard HTTP Request/Response (method 1) has the worst scalability
	// because a long-running operation will tie up a Web Server thread **and**
	// continue until complete even if the client aborts the operation since
	// no data is written back to the client until complete and therefore the
	// terminated connection will not be detected.  SSE (method 2) mitigates
	// the problem of detecting when a client has aborted the operation
	// because periodic progress responses are written to the client and
	// therefore a terminated connection will be detected.  However, the best
	// way to invoke this operation is via Web Sockets (method 3) which not
	// only can detect disconnection of the client, but it also upgrades the
	// request to use its own thread outside the Web Server thread pool.
	// **SSE NOTE:** This end-point supports "Server-sent Events" (SSE) via the
	// `text/event-stream` media type.  This support is activated by adding the
	// `Accept: text/event-stream` header to a request to override the
	// default `application/json` media type.  Further, the end-point will behave
	// similarly to its standard operation but will produce `progress` events
	// at regular intervals that are equivalent to its `200` response schema.
	// Upon success, the final event will be `completed` with the same response
	// schema as a `200` response.  Upon failure, the final event will be
	// `failed` with same `SzErrorResponse` schema as the `4xx` or `5xx`.
	// **WEB SOCKETS NOTE**: If invoking via Web Sockets then the client may
	// send text or binary chunks of the JSON, JSON-Lines or CSV bulk data file
	// as messages.  In Web Sockets, text messages are *always* sent as UTF-8.
	// If the file's character encoding is unknown then the client should send
	// binary messages and the server will attempt to auto-detect the character
	// encoding.  Each message should adhere to the maximum message size
	// specified by the `webSocketsMessageMaxSize` property returned by the
	// `GET /server-info` end-point.  The end of file is detected when the
	// number of seconds specified by the `eofSendTimeout` query parameter have
	// elapsed without a new message being received.
	//
	// POST /bulk-data/analyze
	AnalyzeBulkRecords(ctx context.Context, request AnalyzeBulkRecordsReq, params AnalyzeBulkRecordsParams) (AnalyzeBulkRecordsRes, error)
	// DeleteRecord invokes deleteRecord operation.
	//
	// This operation deletes a single record identified by the data source
	// code and record ID in the request path.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the delete.  This can be used to update a search
	// index or external data mart.   Additionally, Senzing API Server provides
	// a means to have the "raw" entity resolution info (from the underlying
	// native Senzing API) automatically sent to a messaging service such as
	// those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the
	// `withInfo` query parameter value.
	//
	// DELETE /data-sources/{dataSourceCode}/records/{recordId}
	DeleteRecord(ctx context.Context, params DeleteRecordParams) (DeleteRecordRes, error)
	// FindEntityNetwork invokes findEntityNetwork operation.
	//
	// This operation finds the entity network around one or more entities.
	// This attempts to find paths between the specified entities.  If no
	// paths exist, then island networks are returned with each island network
	// containing up to a specified number of related entities.  The entities
	// are identified by their entity IDs or by data source code and record ID
	// pairs for constituent records of those entities.
	// **NOTE:** If the first entity is identified by entity ID then the
	// subsequent entities must also be identified entity ID.  Similarly, if
	// the first entity is identified by the data source code and record ID
	// of a consistuent record then the subsequent entities must also be
	// identified by the data source code and record ID of constituent records.
	// **ALSO NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.
	//
	// GET /entity-networks
	FindEntityNetwork(ctx context.Context, params FindEntityNetworkParams) (FindEntityNetworkRes, error)
	// FindEntityPath invokes findEntityPath operation.
	//
	// This operation finds the path between two entities and returns a
	// description of that entity path (if any) or a response indicating that
	// there is no path between the entities.  The subject entities are either
	// identfieid by entity ID or by data source code and record ID pairs for
	// constituent records of those entities.
	// **NOTE:** If the first entity is identified by entity ID then the second
	// must also be identified an entity ID.  Similarly, if the first entity is
	// identified by data source code and record ID then the second must also
	// be identified by data source code and record ID.
	// **ALSO NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.
	//
	// GET /entity-paths
	FindEntityPath(ctx context.Context, params FindEntityPathParams) (FindEntityPathRes, error)
	// GetActiveConfig invokes getActiveConfig operation.
	//
	// This operation returns the JSON configuration that is currently being
	// used by the native Senzing API initialized by the running server.  No
	// processing or interpretation is performed on the JSON.  This may differ
	// from the registered "default configuration" which the server would
	// use if no other configuration were provided.
	//
	// GET /configs/active
	GetActiveConfig(ctx context.Context) (GetActiveConfigRes, error)
	// GetAttributeType invokes getAttributeType operation.
	//
	// This operation will provide a description of a single attribute type for
	// the specified attribute type code.
	//
	// GET /attribute-types/{attributeCode}
	GetAttributeType(ctx context.Context, params GetAttributeTypeParams) (GetAttributeTypeRes, error)
	// GetAttributeTypes invokes getAttributeTypes operation.
	//
	// This operation will provide a list of attribute types that are
	// configured.  The client can filter the returned list of attribute types
	// using various query parameters.
	//
	// GET /attribute-types
	GetAttributeTypes(ctx context.Context, params GetAttributeTypesParams) (GetAttributeTypesRes, error)
	// GetDataSource invokes getDataSource operation.
	//
	// This operation provides details on a specific data source identified
	// by the data source code in the requested path.
	//
	// GET /data-sources/{dataSourceCode}
	GetDataSource(ctx context.Context, params GetDataSourceParams) (GetDataSourceRes, error)
	// GetDataSources invokes getDataSources operation.
	//
	// This operation will provide a list of data source codes as well as a
	// list of detailed descriptions of each data source.
	//
	// GET /data-sources
	GetDataSources(ctx context.Context, params GetDataSourcesParams) (GetDataSourcesRes, error)
	// GetEntityByEntityId invokes getEntityByEntityId operation.
	//
	// Gets the details on a resolved entity that is identified by the entity
	// ID specified in the request path.
	// **NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.  An alternative way to identify an entity is
	// by one of its constituent records using
	// `GET /data-sources/{dataSourceCode}/records/{recordId}/entity`.
	//
	// GET /entities/{entityId}
	GetEntityByEntityId(ctx context.Context, params GetEntityByEntityIdParams) (GetEntityByEntityIdRes, error)
	// GetEntityByRecordId invokes getEntityByRecordId operation.
	//
	// Gets the details on a resolved entity that contains the record
	// identified by the data source code and record ID in the specified
	// request path.
	//
	// GET /data-sources/{dataSourceCode}/records/{recordId}/entity
	GetEntityByRecordId(ctx context.Context, params GetEntityByRecordIdParams) (GetEntityByRecordIdRes, error)
	// GetRecord invokes getRecord operation.
	//
	// Gets details on a specific entity record identified by the data source
	// code and record ID specified in the request path.
	//
	// GET /data-sources/{dataSourceCode}/records/{recordId}
	GetRecord(ctx context.Context, params GetRecordParams) (GetRecordRes, error)
	// GetServerInfo invokes getServerInfo operation.
	//
	// This operation will provides server information describing the options
	// with which the server was started.  This can be used to determine if
	// the admin operations are enabled or if only read operations may be
	// invoked.  This also allows the client to know the maximum message size
	// for Web Sockets communication.
	//
	// GET /server-info
	GetServerInfo(ctx context.Context) (GetServerInfoRes, error)
	// GetTemplateConfig invokes getTemplateConfig operation.
	//
	// This operation returns a template base JSON configuration that can be
	// modified or customized by the caller.  The returned template is
	// according to the underlying native Senzing API and may change between
	// version upgrades to Senzing.  No processing or interpretation is
	// performed on the JSON.  This will likely differ from the registered
	// "default configuration" or currently "active configuration" being used
	// by the running API server.
	//
	// GET /configs/template
	GetTemplateConfig(ctx context.Context) (GetTemplateConfigRes, error)
	// GetVirtualEntityByRecordIds invokes getVirtualEntityByRecordIds operation.
	//
	// This operation simulates the resolution of the one or more specified
	// records into a single entity and returns the simulated "virtual"
	// entity.  The subject records are identified by data source code and
	// record ID pairs.
	//
	// GET /virtual-entities
	GetVirtualEntityByRecordIds(ctx context.Context, params GetVirtualEntityByRecordIdsParams) (GetVirtualEntityByRecordIdsRes, error)
	// Heartbeat invokes heartbeat operation.
	//
	// The heartbeat operation can be used to ensure that the HTTP server is
	// indeed running, but this operation does not call upon the underlying
	// native Senzing API and therefore does not ensure the Senzing
	// initialization or configuration is valid.
	//
	// GET /heartbeat
	Heartbeat(ctx context.Context) (*SzBaseResponse, error)
	// HowEntityByEntityID invokes howEntityByEntityID operation.
	//
	// This operation provides an anlysis of how the records in an entity
	// resolved.  The subject entity is identified by the entity ID in the
	// request path.
	// **NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.  An alternative way to identify an entity is
	// by one of its constituent records using
	// `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/how`.
	//
	// GET /entities/{entityId}/how
	HowEntityByEntityID(ctx context.Context, params HowEntityByEntityIDParams) (HowEntityByEntityIDRes, error)
	// HowEntityByRecordID invokes howEntityByRecordID operation.
	//
	// This operation provides an anlysis of how the records in an entity
	// resolved.  The subject entity is the one containing the record
	// identified by the data source code and record ID in the request path.
	//
	// GET /data-sources/{dataSourceCode}/records/{recordId}/entity/how
	HowEntityByRecordID(ctx context.Context, params HowEntityByRecordIDParams) (HowEntityByRecordIDRes, error)
	// License invokes license operation.
	//
	// This operation will obtain license information for the underlying
	// native Senzing API.
	//
	// GET /license
	License(ctx context.Context, params LicenseParams) (LicenseRes, error)
	// LoadBulkRecords invokes loadBulkRecords operation.
	//
	// Provides a means to load a bulk data file of records.  The records are
	// encoded as a JSON array of JSON objects, a single JSON object per line
	// in JSON-lines file format, or as a CSV with one record per row.  The
	// data should be in pre-mapped format using JSON property names or CSV
	// column names as described by the
	// [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// **SCALABILITY NOTE:** This operation can be invoked in three ways.  In
	// order of increasingly better scalability these are listed below:
	// 1. Standard HTTP Request/Response
	// 2. HTTP Request with SSE Response (see below)
	// 3. HTTP Upgrade Request for Web Sockets (see below)
	// Standard HTTP Request/Response (method 1) has the worst scalability
	// because a long-running operation will tie up a Web Server thread **and**
	// continue until complete even if the client aborts the operation since
	// no data is written back to the client until complete and therefore the
	// terminated connection will not be detected.  SSE (method 2) mitigates
	// the problem of detecting when a client has aborted the operation
	// because periodic progress responses are written to the client and
	// therefore a terminated connection will be detected.  However, the best
	// way to invoke this operation is via Web Sockets (method 3) which not
	// only can detect disconnection of the client, but it also upgrades the
	// request to use its own thread outside the Web Server thread pool.
	// **SSE NOTE:** This end-point supports "Server-sent Events" (SSE) via the
	// `text/event-stream` media type.  This support is activated by adding the
	// `Accept: text/event-stream` header to a request to override the
	// default `application/json` media type.  Further, the end-point will behave
	// similarly to its standard operation but will produce `progress` events
	// at regular intervals that are equivalent to its `200` response schema.
	// Upon success, the final event will be `completed` with the same response
	// schema as a `200` response.  Upon failure, the final event will be
	// `failed` with same `SzErrorResponse` schema as the `4xx` or `5xx`.
	// **WEB SOCKETS NOTE**: If invoking via Web Sockets then the client may
	// send text or binary chunks of the JSON, JSON-Lines or CSV bulk data file
	// as messages.  In Web Sockets, text messages are *always* sent as UTF-8.
	// If the file's character encoding is unknown then the client should send
	// binary messages and the server will attempt to auto-detect the character
	// encoding.  Each message should adhere to the maximum message size
	// specified by the `webSocketsMessageMaxSize` property returned by the
	// `GET /server-info` end-point.  The end of file is detected when the
	// number of seconds specified by the `eofSendTimeout` query parameter have
	// elapsed without a new message being received.
	//
	// POST /bulk-data/load
	LoadBulkRecords(ctx context.Context, request LoadBulkRecordsReq, params LoadBulkRecordsParams) (LoadBulkRecordsRes, error)
	// OpenAPISpecification invokes openAPISpecification operation.
	//
	// This operation can be used to obtain the Open API specification in JSON
	// format.  The specification can either be the `data` field of a standard
	// response (i.e.: a response with a `meta`, `links` and `data` field) or
	// as raw format where the root JSON document is the Open API specification
	// JSON.
	//
	// GET /specifications/open-api
	OpenAPISpecification(ctx context.Context) (OpenAPISpecificationOKDefault, error)
	// ReevaluateEntity invokes reevaluateEntity operation.
	//
	// Reevaluates an entity identified by the entity ID specified via the
	// `entityId` query parameter.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the reevaluation.  This can be used to update a
	// search index or external data mart.   Additionally, Senzing API Server
	// provides a means to have the "raw" entity resolution info (from the
	// underlying native Senzing API) automatically sent to a messaging service
	// such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of
	// the `withInfo` query parameter value.
	// **ALSO NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.
	//
	// POST /reevaluate-entity
	ReevaluateEntity(ctx context.Context, params ReevaluateEntityParams) (ReevaluateEntityRes, error)
	// ReevaluateRecord invokes reevaluateRecord operation.
	//
	// This operation reevaluates a single record identified by the data source
	// code and record ID in the request path.
	// **NOTE:** The `withInfo` parameter will return the entity resolution
	// info pertaining to the reevaluation.  This can be used to update a
	// search index or external data mart.   Additionally, Senzing API Server
	// provides a means to have the "raw" entity resolution info (from the
	// underlying native Senzing API) automatically sent to a messaging service
	// such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of
	// the `withInfo` query parameter value.
	//
	// POST /data-sources/{dataSourceCode}/records/{recordId}/reevaluate
	ReevaluateRecord(ctx context.Context, params ReevaluateRecordParams) (ReevaluateRecordRes, error)
	// Root invokes root operation.
	//
	// The root operation can be used to ensure that the HTTP server is
	// indeed running, but this operation does not call upon the underlying
	// native Senzing API and therefore does not ensure the Senzing
	// initialization or configuration is valid.
	//
	// GET /
	Root(ctx context.Context) (*SzBaseResponse, error)
	// SearchEntitiesByGet invokes searchEntitiesByGet operation.
	//
	// This operation finds all entities that would resolve or relate to the
	// search candidate features specified by the `attr` and/or `attrs` query
	// parameters.  The search candidate features are treated as if they
	// belonged to an inbound record being loaded, thus the attribute names are
	// given by the [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// If including the search candidate features as query parameters presents
	// privacy concerns due to sensitivity of the data, they can alternately
	// be sent in the request body using the `POST /search-entities` endpoint.
	// **NOTE:** This operation differs from a keyword search in that it uses
	// deterministic entity resolution rules to determine the result set.  This
	// means that features that are considered "generic" (i.e.: overly common)
	// will be ignored just as they are during entity resolution and will not
	// yield search results.  For example, searching on a gender by itself will
	// return no results rather than half of all entities.  Similarly, a phone
	// number such as `555-1212` may yield no results.
	//
	// GET /entities
	SearchEntitiesByGet(ctx context.Context, params SearchEntitiesByGetParams) (SearchEntitiesByGetRes, error)
	// SearchEntitiesByPost invokes searchEntitiesByPost operation.
	//
	// This operation finds all entities that would resolve or relate to the
	// search candidate features specified in JSON request body.  The search
	// candidate features are treated as if they belonged to an inbound record
	// being loaded.  The JSON format of the request body is defined by the
	// [Senzing Generic Entity Specification](https://senzing.zendesk.
	// com/hc/en-us/articles/231925448-Generic-Entity-Specification).
	// This operation is similar to the `GET /entities` endpoint in function
	// except that it provides a means to avoid specifying potentially
	// sensitive data in query parameters, but instead in the request body.
	// **NOTE:** This operation differs from a keyword search in that it uses
	// deterministic entity resolution rules to determine the result set.  This
	// means that features that are considered "generic" (i.e.: overly common)
	// will be ignored just as they are during entity resolution and will not
	// yield search results.  For example, searching on a gender by itself will
	// return no results rather than half of all entities.  Similarly, a phone
	// number such as `555-1212` may yield no results.
	//
	// POST /search-entities
	SearchEntitiesByPost(ctx context.Context, request SearchEntitiesByPostReq, params SearchEntitiesByPostParams) (SearchEntitiesByPostRes, error)
	// Version invokes version operation.
	//
	// This operation will obtain the full version information for the server.
	// Much of the same information is available in the `meta` segment of
	// every JSON response.
	//
	// GET /version
	Version(ctx context.Context, params VersionParams) (VersionRes, error)
	// WhyEntities invokes whyEntities operation.
	//
	// This operation provides an anlysis of why two entities related, did not
	// relate or did not resolve.  The entities are identified either by
	// entity ID's or by data source code and record ID pairs for constituent
	// records of those entities.
	// **NOTE:** If the first entity is identified by entity ID then the second
	// must also be identified an entity ID.  Similarly, if the first entity is
	// identified by data source code and record ID then the second must also
	// be identified by data source code and record ID.
	// **ALSO NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.
	//
	// GET /why/entities
	WhyEntities(ctx context.Context, params WhyEntitiesParams) (WhyEntitiesRes, error)
	// WhyEntityByEntityID invokes whyEntityByEntityID operation.
	//
	// This operation provides an anlysis of why the records in an entity
	// resolved.  The subject entity is identified by the entity ID in the
	// request path.
	// **NOTE:** Bear in mind that entity ID's are transient and may be
	// recycled or repurposed as new records are loaded and entities resolve,
	// unresolve and re-resolve.  An alternative way to identify an entity is
	// by one of its constituent records using
	// `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why`.
	//
	// GET /entities/{entityId}/why
	WhyEntityByEntityID(ctx context.Context, params WhyEntityByEntityIDParams) (WhyEntityByEntityIDRes, error)
	// WhyEntityByRecordID invokes whyEntityByRecordID operation.
	//
	// This operation provides an anlysis of why the records in an entity
	// resolved.  The subject entity is the one containing the record
	// identified by the data source code and record ID in the request path.
	//
	// GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why
	WhyEntityByRecordID(ctx context.Context, params WhyEntityByRecordIDParams) (WhyEntityByRecordIDRes, error)
	// WhyRecords invokes whyRecords operation.
	//
	// This operation provides an anlysis of two records identified by data
	// source code and record ID in respective qeury parameters resolved or
	// did not resolve.
	//
	// GET /why/records
	WhyRecords(ctx context.Context, params WhyRecordsParams) (WhyRecordsRes, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Labeler added in v0.9.4 

type Labeler struct {
	// contains filtered or unexported fields
}

Labeler is used to allow adding custom attributes to the server request metrics.

func LabelerFromContext added in v0.9.4 

func LabelerFromContext(ctx context.Context) (*Labeler, bool)

LabelerFromContext retrieves the Labeler from the provided context, if present.

If no Labeler was found in the provided context a new, empty Labeler is returned and the second return value is false. In this case it is safe to use the Labeler but any attributes added to it will not be used.

func (*Labeler) Add added in v0.9.4 

func (l *Labeler) Add(attrs ...attribute.KeyValue)

Add attributes to the Labeler.

func (*Labeler) AttributeSet added in v0.9.4 

func (l *Labeler) AttributeSet() attribute.Set

AttributeSet returns the attributes added to the Labeler as an attribute.Set.

type LicenseOKDefault 

type LicenseOKDefault struct {
	Data io.Reader
}

The response containing the license information. Ref: #/components/schemas/SzLicenseResponse

func (LicenseOKDefault) Read 

func (s LicenseOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type LicenseParams 

type LicenseParams struct {
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

LicenseParams is parameters of license operation.

type LicenseRes 

type LicenseRes interface {
	// contains filtered or unexported methods
}

type LoadBulkRecordsApplicationJSONForbidden 

type LoadBulkRecordsApplicationJSONForbidden SzErrorResponse

func (*LoadBulkRecordsApplicationJSONForbidden) Decode 

func (s *LoadBulkRecordsApplicationJSONForbidden) Decode(d *jx.Decoder) error

Decode decodes LoadBulkRecordsApplicationJSONForbidden from json.

func (*LoadBulkRecordsApplicationJSONForbidden) Encode 

func (s *LoadBulkRecordsApplicationJSONForbidden) Encode(e *jx.Encoder)

Encode encodes LoadBulkRecordsApplicationJSONForbidden as json.

func (*LoadBulkRecordsApplicationJSONForbidden) MarshalJSON 

func (s *LoadBulkRecordsApplicationJSONForbidden) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*LoadBulkRecordsApplicationJSONForbidden) UnmarshalJSON 

func (s *LoadBulkRecordsApplicationJSONForbidden) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*LoadBulkRecordsApplicationJSONForbidden) Validate 

func (s *LoadBulkRecordsApplicationJSONForbidden) Validate() error

type LoadBulkRecordsApplicationJSONInternalServerError 

type LoadBulkRecordsApplicationJSONInternalServerError SzErrorResponse

func (*LoadBulkRecordsApplicationJSONInternalServerError) Decode 

func (s *LoadBulkRecordsApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes LoadBulkRecordsApplicationJSONInternalServerError from json.

func (*LoadBulkRecordsApplicationJSONInternalServerError) Encode 

func (s *LoadBulkRecordsApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes LoadBulkRecordsApplicationJSONInternalServerError as json.

func (*LoadBulkRecordsApplicationJSONInternalServerError) MarshalJSON 

func (s *LoadBulkRecordsApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*LoadBulkRecordsApplicationJSONInternalServerError) UnmarshalJSON 

func (s *LoadBulkRecordsApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*LoadBulkRecordsApplicationJSONInternalServerError) Validate 

func (s *LoadBulkRecordsApplicationJSONInternalServerError) Validate() error

type LoadBulkRecordsForbiddenDefault 

type LoadBulkRecordsForbiddenDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (LoadBulkRecordsForbiddenDefault) Read 

func (s LoadBulkRecordsForbiddenDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type LoadBulkRecordsOKDefault 

type LoadBulkRecordsOKDefault struct {
	Data io.Reader
}

The response describing the result of loading bulk data. Ref: #/components/schemas/SzBulkLoadResponse

func (LoadBulkRecordsOKDefault) Read 

func (s LoadBulkRecordsOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type LoadBulkRecordsParams 

type LoadBulkRecordsParams struct {
	// Used to set the overriding data source for the records.  This data
	// source will be assigned to every record **unless** the record's
	// data source (including blank data source) has a specific mapping
	// specified by a `mapDataSources` or `mapDataSource` parameters.  If
	// this parameter is **not** provided and no specific overrides are
	// provided for a record then the data source specified in the inbound
	// record is used directly.  If the record has no data source and no
	// override is provided then it will fail to load.
	DataSource OptString
	// A URL-encoded JSON object whose properties are interpreted as
	// data source codes to map from and whose corresponding values are
	// interpretted as data source codes to map to.  For example,
	// `{"EMPL": "EMPLOYEES"}` (url-encoded of course) would map all
	// records with inbound data source `EMPL` to `EMPLOYEES`.  To map
	// only inbound records with no data source to a specific data source
	// you would use an empty JSON property (e.g.: `{"": "CUSTOMERS"}`).
	// If the `dataSource` parameter is **not** provided and no specific
	// overrides are provided for a record with this parameter or via
	// `mapDataSource` then the data source specified in the inbound
	// record is used directly.  If the record has no data source and no
	// overriding or mapped data source is provided for an empty data
	// source then the record will fail to load.
	// **NOTE**: If both this parameter and the `mapDataSource` parameter
	// is provided then the mappings are merged with the more ad-hoc
	// `mapDataSource` parameter taking precedence since it is likely being
	// used for debugging and diagnostic purposes to avoid the URL
	// encoding.
	// Here are some examples of encoding this parameter:
	// - **JavaScript Example**
	// “`javascript
	// var dataSourceMap = {
	// "": "CUSTOMERS",
	// "EMPL": "EMPLOYEES",
	// "VEND": "VENDORS"
	// };
	// var mapDataSources = JSON.stringify(dataSourceMap);
	// var urlPath = "/bulk-data/load?mapDataSources="
	// + encodeURIComponent(mapDataSources);
	// “`
	// - **Java Example**
	// “`java
	// JsonObjectBuilder builder = Json.createObjectBuilder();
	// builder.add("", "CUSTOMERS");
	// builder.add("EMPL", "EMPLOYEES");
	// builder.add("VEND", "VENDORS");
	// JsonObject dataSourceMap = builder.build();
	// String mapDataSources = dataSourceMap.toString();
	// String encodedMap     = URLEncoder.encode(mapDataSources, "UTF-8");
	// String urlPath = "/bulk-data/load?mapDataSources=" + encodedMap;
	// “`
	// In both of the above examples the `urlPath` variable is set to:
	// “`json
	// /bulk-data/load?mapDataSources=%7B%22%22%3A%22CUSTOMERS%22%2C%22EMPL%22%3A%22EMPLOYEES%22%2C%22VEND%22%3A%22VENDORS%22%7D
	// “`.
	MapDataSources OptString
	// As an alternative to the `mapDataSources` parameter you may specify
	// the `mapDataSource` parameter zero or more times to add additional
	// data source mappings or **override** data source mappings from
	// `mapDataSources`.  If you are using this API programmatically
	// then you should typically use the `mapDataSources` parameter
	// instead of this one.  But when manually constructing a URL in the
	// browser address bar, in a command-line tool like `curl` or in a REST
	// client browser extension for debugging or testing purposes, encoding
	// the JSON value for `mapDataSources` can be unwieldy.  This parameter
	// (which is multi-valued) lets you specify delimited strings that
	// begin with the delimiter character, followed by the original
	// data source name, then the delimiter character and the new data
	// source name.  You should only have to URL-encode the delimiter you
	// choose and maybe spaces.  For example, `:EMPL:EMPLOYEES` or
	// `|EMPL|EMPLOYEES` (url-encoded of course) would map all records with
	// inbound data source `EMPL` to `EMPLOYEES`.  To map only inbound
	// records with no data source to a specific data source you would
	// begin the value with two repeated delimiter characters followed by
	// the new data source value (e.g.: `||CUSTOMERS` or `::CUSTOMERS`).
	// If the `dataSource` parameter is **not** provided and no specific
	// overrides are provided for a record with this parameter or the
	// `mapDataSources` parameter then the data source specified in the
	// inbound record is used directly.  If the record has no data source
	// and no overriding or mapped data source is provided for an empty
	// data source then the record will fail to load.
	MapDataSource []string
	// The maximum number of failures that can occur before the bulk
	// load operation is aborted.  If the value is less-than or equal-to
	// zero (0) then the operation will continue regardless of the number
	// of errors that occur.
	MaxFailures OptInt32
	// The suggested maximum time between SSE `progress` events specified in milliseconds.  If not
	// specified then the default of `3000` milliseconds (i.e.: 3 seconds) is used.  This parameter is
	// NOT used if the operation is not producing an SSE response (i.e.: `text/event-stream` media type
	// was not requested via the `Accept` header).
	ProgressPeriod OptInt64
	// The number of seconds to wait for an additional Web Sockets message before assuming end-of-file
	// (EOF) when using this end-point via Web Sockets protocol.  If this number of seconds elapses with
	// no additional incoming data then the server assumes that there are no more file chunks forthcoming.
	//   If not specified then the default of `3` seconds is used. This parameter is NOT used if the
	// operation is not invoked via the Web Sockets (`ws://`) protocol.  **NOTE**: This is specified in
	// seconds, **not** milliseconds.
	EofSendTimeout OptInt32
}

LoadBulkRecordsParams is parameters of loadBulkRecords operation.

type LoadBulkRecordsReq 

type LoadBulkRecordsReq interface {
	// contains filtered or unexported methods
}

type LoadBulkRecordsReqApplicationJSON 

type LoadBulkRecordsReqApplicationJSON string

func (*LoadBulkRecordsReqApplicationJSON) Decode 

func (s *LoadBulkRecordsReqApplicationJSON) Decode(d *jx.Decoder) error

Decode decodes LoadBulkRecordsReqApplicationJSON from json.

func (LoadBulkRecordsReqApplicationJSON) Encode 

func (s LoadBulkRecordsReqApplicationJSON) Encode(e *jx.Encoder)

Encode encodes LoadBulkRecordsReqApplicationJSON as json.

func (LoadBulkRecordsReqApplicationJSON) MarshalJSON 

func (s LoadBulkRecordsReqApplicationJSON) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*LoadBulkRecordsReqApplicationJSON) UnmarshalJSON 

func (s *LoadBulkRecordsReqApplicationJSON) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type LoadBulkRecordsReqApplicationXJsonlines 

type LoadBulkRecordsReqApplicationXJsonlines struct {
	Data io.Reader
}

func (LoadBulkRecordsReqApplicationXJsonlines) Read 

func (s LoadBulkRecordsReqApplicationXJsonlines) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type LoadBulkRecordsReqMultipartFormData 

type LoadBulkRecordsReqMultipartFormData struct {
	Body OptMultipartFile `json:"body"`
}

func (*LoadBulkRecordsReqMultipartFormData) GetBody 

func (s *LoadBulkRecordsReqMultipartFormData) GetBody() OptMultipartFile

GetBody returns the value of Body.

func (*LoadBulkRecordsReqMultipartFormData) SetBody 

func (s *LoadBulkRecordsReqMultipartFormData) SetBody(val OptMultipartFile)

SetBody sets the value of Body.

type LoadBulkRecordsReqTextCsv 

type LoadBulkRecordsReqTextCsv struct {
	Data io.Reader
}

func (LoadBulkRecordsReqTextCsv) Read 

func (s LoadBulkRecordsReqTextCsv) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type LoadBulkRecordsReqTextPlain 

type LoadBulkRecordsReqTextPlain struct {
	Data io.Reader
}

func (LoadBulkRecordsReqTextPlain) Read 

func (s LoadBulkRecordsReqTextPlain) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type LoadBulkRecordsRes 

type LoadBulkRecordsRes interface {
	// contains filtered or unexported methods
}

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type OpenAPISpecificationOKDefault added in v0.9.4 

type OpenAPISpecificationOKDefault struct {
	Data io.Reader
}

This represents the possible return type for an Open API specification which can be an instance of `SzOpenApiSpecResponse` or raw JSON of the Open API specification. Ref: #/components/schemas/SzOpenApiSpecResponseOrRawJson

func (OpenAPISpecificationOKDefault) Read added in v0.9.4 

func (s OpenAPISpecificationOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type OptBool 

type OptBool struct {
	Value bool
	Set   bool
}

OptBool is optional bool.

func NewOptBool 

func NewOptBool(v bool) OptBool

NewOptBool returns new OptBool with value set to v.

func (*OptBool) Decode 

func (o *OptBool) Decode(d *jx.Decoder) error

Decode decodes bool from json.

func (OptBool) Encode 

func (o OptBool) Encode(e *jx.Encoder)

Encode encodes bool as json.

func (OptBool) Get 

func (o OptBool) Get() (v bool, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptBool) IsSet 

func (o OptBool) IsSet() bool

IsSet returns true if OptBool was set.

func (OptBool) MarshalJSON 

func (s OptBool) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptBool) Or 

func (o OptBool) Or(d bool) bool

Or returns value if set, or given parameter if does not.

func (*OptBool) Reset 

func (o *OptBool) Reset()

Reset unsets value.

func (*OptBool) SetTo 

func (o *OptBool) SetTo(v bool)

SetTo sets value to v.

func (*OptBool) UnmarshalJSON 

func (s *OptBool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptDateTime 

type OptDateTime struct {
	Value time.Time
	Set   bool
}

OptDateTime is optional time.Time.

func NewOptDateTime 

func NewOptDateTime(v time.Time) OptDateTime

NewOptDateTime returns new OptDateTime with value set to v.

func (*OptDateTime) Decode 

func (o *OptDateTime) Decode(d *jx.Decoder, format func(*jx.Decoder) (time.Time, error)) error

Decode decodes time.Time from json.

func (OptDateTime) Encode 

func (o OptDateTime) Encode(e *jx.Encoder, format func(*jx.Encoder, time.Time))

Encode encodes time.Time as json.

func (OptDateTime) Get 

func (o OptDateTime) Get() (v time.Time, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptDateTime) IsSet 

func (o OptDateTime) IsSet() bool

IsSet returns true if OptDateTime was set.

func (OptDateTime) MarshalJSON 

func (s OptDateTime) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptDateTime) Or 

func (o OptDateTime) Or(d time.Time) time.Time

Or returns value if set, or given parameter if does not.

func (*OptDateTime) Reset 

func (o *OptDateTime) Reset()

Reset unsets value.

func (*OptDateTime) SetTo 

func (o *OptDateTime) SetTo(v time.Time)

SetTo sets value to v.

func (*OptDateTime) UnmarshalJSON 

func (s *OptDateTime) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptInt16 

type OptInt16 struct {
	Value int16
	Set   bool
}

OptInt16 is optional int16.

func NewOptInt16 

func NewOptInt16(v int16) OptInt16

NewOptInt16 returns new OptInt16 with value set to v.

func (*OptInt16) Decode 

func (o *OptInt16) Decode(d *jx.Decoder) error

Decode decodes int16 from json.

func (OptInt16) Encode 

func (o OptInt16) Encode(e *jx.Encoder)

Encode encodes int16 as json.

func (OptInt16) Get 

func (o OptInt16) Get() (v int16, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptInt16) IsSet 

func (o OptInt16) IsSet() bool

IsSet returns true if OptInt16 was set.

func (OptInt16) MarshalJSON 

func (s OptInt16) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptInt16) Or 

func (o OptInt16) Or(d int16) int16

Or returns value if set, or given parameter if does not.

func (*OptInt16) Reset 

func (o *OptInt16) Reset()

Reset unsets value.

func (*OptInt16) SetTo 

func (o *OptInt16) SetTo(v int16)

SetTo sets value to v.

func (*OptInt16) UnmarshalJSON 

func (s *OptInt16) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptInt32 

type OptInt32 struct {
	Value int32
	Set   bool
}

OptInt32 is optional int32.

func NewOptInt32 

func NewOptInt32(v int32) OptInt32

NewOptInt32 returns new OptInt32 with value set to v.

func (*OptInt32) Decode 

func (o *OptInt32) Decode(d *jx.Decoder) error

Decode decodes int32 from json.

func (OptInt32) Encode 

func (o OptInt32) Encode(e *jx.Encoder)

Encode encodes int32 as json.

func (OptInt32) Get 

func (o OptInt32) Get() (v int32, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptInt32) IsSet 

func (o OptInt32) IsSet() bool

IsSet returns true if OptInt32 was set.

func (OptInt32) MarshalJSON 

func (s OptInt32) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptInt32) Or 

func (o OptInt32) Or(d int32) int32

Or returns value if set, or given parameter if does not.

func (*OptInt32) Reset 

func (o *OptInt32) Reset()

Reset unsets value.

func (*OptInt32) SetTo 

func (o *OptInt32) SetTo(v int32)

SetTo sets value to v.

func (*OptInt32) UnmarshalJSON 

func (s *OptInt32) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptInt64 

type OptInt64 struct {
	Value int64
	Set   bool
}

OptInt64 is optional int64.

func NewOptInt64 

func NewOptInt64(v int64) OptInt64

NewOptInt64 returns new OptInt64 with value set to v.

func (*OptInt64) Decode 

func (o *OptInt64) Decode(d *jx.Decoder) error

Decode decodes int64 from json.

func (OptInt64) Encode 

func (o OptInt64) Encode(e *jx.Encoder)

Encode encodes int64 as json.

func (OptInt64) Get 

func (o OptInt64) Get() (v int64, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptInt64) IsSet 

func (o OptInt64) IsSet() bool

IsSet returns true if OptInt64 was set.

func (OptInt64) MarshalJSON 

func (s OptInt64) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptInt64) Or 

func (o OptInt64) Or(d int64) int64

Or returns value if set, or given parameter if does not.

func (*OptInt64) Reset 

func (o *OptInt64) Reset()

Reset unsets value.

func (*OptInt64) SetTo 

func (o *OptInt64) SetTo(v int64)

SetTo sets value to v.

func (*OptInt64) UnmarshalJSON 

func (s *OptInt64) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptInt8 

type OptInt8 struct {
	Value int8
	Set   bool
}

OptInt8 is optional int8.

func NewOptInt8 

func NewOptInt8(v int8) OptInt8

NewOptInt8 returns new OptInt8 with value set to v.

func (*OptInt8) Decode 

func (o *OptInt8) Decode(d *jx.Decoder) error

Decode decodes int8 from json.

func (OptInt8) Encode 

func (o OptInt8) Encode(e *jx.Encoder)

Encode encodes int8 as json.

func (OptInt8) Get 

func (o OptInt8) Get() (v int8, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptInt8) IsSet 

func (o OptInt8) IsSet() bool

IsSet returns true if OptInt8 was set.

func (OptInt8) MarshalJSON 

func (s OptInt8) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptInt8) Or 

func (o OptInt8) Or(d int8) int8

Or returns value if set, or given parameter if does not.

func (*OptInt8) Reset 

func (o *OptInt8) Reset()

Reset unsets value.

func (*OptInt8) SetTo 

func (o *OptInt8) SetTo(v int8)

SetTo sets value to v.

func (*OptInt8) UnmarshalJSON 

func (s *OptInt8) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptMultipartFile 

type OptMultipartFile struct {
	Value ht.MultipartFile
	Set   bool
}

OptMultipartFile is optional ht.MultipartFile.

func NewOptMultipartFile 

func NewOptMultipartFile(v ht.MultipartFile) OptMultipartFile

NewOptMultipartFile returns new OptMultipartFile with value set to v.

func (OptMultipartFile) Get 

func (o OptMultipartFile) Get() (v ht.MultipartFile, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptMultipartFile) IsSet 

func (o OptMultipartFile) IsSet() bool

IsSet returns true if OptMultipartFile was set.

func (OptMultipartFile) Or 

func (o OptMultipartFile) Or(d ht.MultipartFile) ht.MultipartFile

Or returns value if set, or given parameter if does not.

func (*OptMultipartFile) Reset 

func (o *OptMultipartFile) Reset()

Reset unsets value.

func (*OptMultipartFile) SetTo 

func (o *OptMultipartFile) SetTo(v ht.MultipartFile)

SetTo sets value to v.

type OptNilBool 

type OptNilBool struct {
	Value bool
	Set   bool
	Null  bool
}

OptNilBool is optional nullable bool.

func NewOptNilBool 

func NewOptNilBool(v bool) OptNilBool

NewOptNilBool returns new OptNilBool with value set to v.

func (*OptNilBool) Decode 

func (o *OptNilBool) Decode(d *jx.Decoder) error

Decode decodes bool from json.

func (OptNilBool) Encode 

func (o OptNilBool) Encode(e *jx.Encoder)

Encode encodes bool as json.

func (OptNilBool) Get 

func (o OptNilBool) Get() (v bool, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilBool) IsNull 

func (o OptNilBool) IsNull() bool

IsSet returns true if value is Null.

func (OptNilBool) IsSet 

func (o OptNilBool) IsSet() bool

IsSet returns true if OptNilBool was set.

func (OptNilBool) MarshalJSON 

func (s OptNilBool) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilBool) Or 

func (o OptNilBool) Or(d bool) bool

Or returns value if set, or given parameter if does not.

func (*OptNilBool) Reset 

func (o *OptNilBool) Reset()

Reset unsets value.

func (*OptNilBool) SetTo 

func (o *OptNilBool) SetTo(v bool)

SetTo sets value to v.

func (*OptNilBool) SetToNull 

func (o *OptNilBool) SetToNull()

SetNull sets value to null.

func (*OptNilBool) UnmarshalJSON 

func (s *OptNilBool) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilInt32 

type OptNilInt32 struct {
	Value int32
	Set   bool
	Null  bool
}

OptNilInt32 is optional nullable int32.

func NewOptNilInt32 

func NewOptNilInt32(v int32) OptNilInt32

NewOptNilInt32 returns new OptNilInt32 with value set to v.

func (*OptNilInt32) Decode 

func (o *OptNilInt32) Decode(d *jx.Decoder) error

Decode decodes int32 from json.

func (OptNilInt32) Encode 

func (o OptNilInt32) Encode(e *jx.Encoder)

Encode encodes int32 as json.

func (OptNilInt32) Get 

func (o OptNilInt32) Get() (v int32, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilInt32) IsNull 

func (o OptNilInt32) IsNull() bool

IsSet returns true if value is Null.

func (OptNilInt32) IsSet 

func (o OptNilInt32) IsSet() bool

IsSet returns true if OptNilInt32 was set.

func (OptNilInt32) MarshalJSON 

func (s OptNilInt32) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilInt32) Or 

func (o OptNilInt32) Or(d int32) int32

Or returns value if set, or given parameter if does not.

func (*OptNilInt32) Reset 

func (o *OptNilInt32) Reset()

Reset unsets value.

func (*OptNilInt32) SetTo 

func (o *OptNilInt32) SetTo(v int32)

SetTo sets value to v.

func (*OptNilInt32) SetToNull 

func (o *OptNilInt32) SetToNull()

SetNull sets value to null.

func (*OptNilInt32) UnmarshalJSON 

func (s *OptNilInt32) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilInt64Array 

type OptNilInt64Array struct {
	Value []int64
	Set   bool
	Null  bool
}

OptNilInt64Array is optional nullable []int64.

func NewOptNilInt64Array 

func NewOptNilInt64Array(v []int64) OptNilInt64Array

NewOptNilInt64Array returns new OptNilInt64Array with value set to v.

func (*OptNilInt64Array) Decode 

func (o *OptNilInt64Array) Decode(d *jx.Decoder) error

Decode decodes []int64 from json.

func (OptNilInt64Array) Encode 

func (o OptNilInt64Array) Encode(e *jx.Encoder)

Encode encodes []int64 as json.

func (OptNilInt64Array) Get 

func (o OptNilInt64Array) Get() (v []int64, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilInt64Array) IsNull 

func (o OptNilInt64Array) IsNull() bool

IsSet returns true if value is Null.

func (OptNilInt64Array) IsSet 

func (o OptNilInt64Array) IsSet() bool

IsSet returns true if OptNilInt64Array was set.

func (OptNilInt64Array) MarshalJSON 

func (s OptNilInt64Array) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilInt64Array) Or 

func (o OptNilInt64Array) Or(d []int64) []int64

Or returns value if set, or given parameter if does not.

func (*OptNilInt64Array) Reset 

func (o *OptNilInt64Array) Reset()

Reset unsets value.

func (*OptNilInt64Array) SetTo 

func (o *OptNilInt64Array) SetTo(v []int64)

SetTo sets value to v.

func (*OptNilInt64Array) SetToNull 

func (o *OptNilInt64Array) SetToNull()

SetNull sets value to null.

func (*OptNilInt64Array) UnmarshalJSON 

func (s *OptNilInt64Array) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilString 

type OptNilString struct {
	Value string
	Set   bool
	Null  bool
}

OptNilString is optional nullable string.

func NewOptNilString 

func NewOptNilString(v string) OptNilString

NewOptNilString returns new OptNilString with value set to v.

func (*OptNilString) Decode 

func (o *OptNilString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (OptNilString) Encode 

func (o OptNilString) Encode(e *jx.Encoder)

Encode encodes string as json.

func (OptNilString) Get 

func (o OptNilString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilString) IsNull 

func (o OptNilString) IsNull() bool

IsSet returns true if value is Null.

func (OptNilString) IsSet 

func (o OptNilString) IsSet() bool

IsSet returns true if OptNilString was set.

func (OptNilString) MarshalJSON 

func (s OptNilString) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilString) Or 

func (o OptNilString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*OptNilString) Reset 

func (o *OptNilString) Reset()

Reset unsets value.

func (*OptNilString) SetTo 

func (o *OptNilString) SetTo(v string)

SetTo sets value to v.

func (*OptNilString) SetToNull 

func (o *OptNilString) SetToNull()

SetNull sets value to null.

func (*OptNilString) UnmarshalJSON 

func (s *OptNilString) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilStringArray 

type OptNilStringArray struct {
	Value []string
	Set   bool
	Null  bool
}

OptNilStringArray is optional nullable []string.

func NewOptNilStringArray 

func NewOptNilStringArray(v []string) OptNilStringArray

NewOptNilStringArray returns new OptNilStringArray with value set to v.

func (*OptNilStringArray) Decode 

func (o *OptNilStringArray) Decode(d *jx.Decoder) error

Decode decodes []string from json.

func (OptNilStringArray) Encode 

func (o OptNilStringArray) Encode(e *jx.Encoder)

Encode encodes []string as json.

func (OptNilStringArray) Get 

func (o OptNilStringArray) Get() (v []string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilStringArray) IsNull 

func (o OptNilStringArray) IsNull() bool

IsSet returns true if value is Null.

func (OptNilStringArray) IsSet 

func (o OptNilStringArray) IsSet() bool

IsSet returns true if OptNilStringArray was set.

func (OptNilStringArray) MarshalJSON 

func (s OptNilStringArray) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilStringArray) Or 

func (o OptNilStringArray) Or(d []string) []string

Or returns value if set, or given parameter if does not.

func (*OptNilStringArray) Reset 

func (o *OptNilStringArray) Reset()

Reset unsets value.

func (*OptNilStringArray) SetTo 

func (o *OptNilStringArray) SetTo(v []string)

SetTo sets value to v.

func (*OptNilStringArray) SetToNull 

func (o *OptNilStringArray) SetToNull()

SetNull sets value to null.

func (*OptNilStringArray) UnmarshalJSON 

func (s *OptNilStringArray) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzAttributeSearchResponseRawData 

type OptNilSzAttributeSearchResponseRawData struct {
	Value SzAttributeSearchResponseRawData
	Set   bool
	Null  bool
}

OptNilSzAttributeSearchResponseRawData is optional nullable SzAttributeSearchResponseRawData.

func NewOptNilSzAttributeSearchResponseRawData 

func NewOptNilSzAttributeSearchResponseRawData(v SzAttributeSearchResponseRawData) OptNilSzAttributeSearchResponseRawData

NewOptNilSzAttributeSearchResponseRawData returns new OptNilSzAttributeSearchResponseRawData with value set to v.

func (*OptNilSzAttributeSearchResponseRawData) Decode 

func (o *OptNilSzAttributeSearchResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResponseRawData from json.

func (OptNilSzAttributeSearchResponseRawData) Encode 

func (o OptNilSzAttributeSearchResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzAttributeSearchResponseRawData as json.

func (OptNilSzAttributeSearchResponseRawData) Get 

func (o OptNilSzAttributeSearchResponseRawData) Get() (v SzAttributeSearchResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzAttributeSearchResponseRawData) IsNull 

func (o OptNilSzAttributeSearchResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzAttributeSearchResponseRawData) IsSet 

func (o OptNilSzAttributeSearchResponseRawData) IsSet() bool

IsSet returns true if OptNilSzAttributeSearchResponseRawData was set.

func (OptNilSzAttributeSearchResponseRawData) MarshalJSON 

func (s OptNilSzAttributeSearchResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzAttributeSearchResponseRawData) Or 

func (o OptNilSzAttributeSearchResponseRawData) Or(d SzAttributeSearchResponseRawData) SzAttributeSearchResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzAttributeSearchResponseRawData) Reset 

func (o *OptNilSzAttributeSearchResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzAttributeSearchResponseRawData) SetTo 

func (o *OptNilSzAttributeSearchResponseRawData) SetTo(v SzAttributeSearchResponseRawData)

SetTo sets value to v.

func (*OptNilSzAttributeSearchResponseRawData) SetToNull 

func (o *OptNilSzAttributeSearchResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzAttributeSearchResponseRawData) UnmarshalJSON 

func (s *OptNilSzAttributeSearchResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzAttributeSearchResultFeatureScores 

type OptNilSzAttributeSearchResultFeatureScores struct {
	Value SzAttributeSearchResultFeatureScores
	Set   bool
	Null  bool
}

OptNilSzAttributeSearchResultFeatureScores is optional nullable SzAttributeSearchResultFeatureScores.

func NewOptNilSzAttributeSearchResultFeatureScores 

func NewOptNilSzAttributeSearchResultFeatureScores(v SzAttributeSearchResultFeatureScores) OptNilSzAttributeSearchResultFeatureScores

NewOptNilSzAttributeSearchResultFeatureScores returns new OptNilSzAttributeSearchResultFeatureScores with value set to v.

func (*OptNilSzAttributeSearchResultFeatureScores) Decode 

func (o *OptNilSzAttributeSearchResultFeatureScores) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResultFeatureScores from json.

func (OptNilSzAttributeSearchResultFeatureScores) Encode 

func (o OptNilSzAttributeSearchResultFeatureScores) Encode(e *jx.Encoder)

Encode encodes SzAttributeSearchResultFeatureScores as json.

func (OptNilSzAttributeSearchResultFeatureScores) Get 

func (o OptNilSzAttributeSearchResultFeatureScores) Get() (v SzAttributeSearchResultFeatureScores, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzAttributeSearchResultFeatureScores) IsNull 

func (o OptNilSzAttributeSearchResultFeatureScores) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzAttributeSearchResultFeatureScores) IsSet 

func (o OptNilSzAttributeSearchResultFeatureScores) IsSet() bool

IsSet returns true if OptNilSzAttributeSearchResultFeatureScores was set.

func (OptNilSzAttributeSearchResultFeatureScores) MarshalJSON 

func (s OptNilSzAttributeSearchResultFeatureScores) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzAttributeSearchResultFeatureScores) Or 

func (o OptNilSzAttributeSearchResultFeatureScores) Or(d SzAttributeSearchResultFeatureScores) SzAttributeSearchResultFeatureScores

Or returns value if set, or given parameter if does not.

func (*OptNilSzAttributeSearchResultFeatureScores) Reset 

func (o *OptNilSzAttributeSearchResultFeatureScores) Reset()

Reset unsets value.

func (*OptNilSzAttributeSearchResultFeatureScores) SetTo 

func (o *OptNilSzAttributeSearchResultFeatureScores) SetTo(v SzAttributeSearchResultFeatureScores)

SetTo sets value to v.

func (*OptNilSzAttributeSearchResultFeatureScores) SetToNull 

func (o *OptNilSzAttributeSearchResultFeatureScores) SetToNull()

SetNull sets value to null.

func (*OptNilSzAttributeSearchResultFeatureScores) UnmarshalJSON 

func (s *OptNilSzAttributeSearchResultFeatureScores) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzAttributeTypeResponseRawData 

type OptNilSzAttributeTypeResponseRawData struct {
	Value SzAttributeTypeResponseRawData
	Set   bool
	Null  bool
}

OptNilSzAttributeTypeResponseRawData is optional nullable SzAttributeTypeResponseRawData.

func NewOptNilSzAttributeTypeResponseRawData 

func NewOptNilSzAttributeTypeResponseRawData(v SzAttributeTypeResponseRawData) OptNilSzAttributeTypeResponseRawData

NewOptNilSzAttributeTypeResponseRawData returns new OptNilSzAttributeTypeResponseRawData with value set to v.

func (*OptNilSzAttributeTypeResponseRawData) Decode 

func (o *OptNilSzAttributeTypeResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypeResponseRawData from json.

func (OptNilSzAttributeTypeResponseRawData) Encode 

func (o OptNilSzAttributeTypeResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzAttributeTypeResponseRawData as json.

func (OptNilSzAttributeTypeResponseRawData) Get 

func (o OptNilSzAttributeTypeResponseRawData) Get() (v SzAttributeTypeResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzAttributeTypeResponseRawData) IsNull 

func (o OptNilSzAttributeTypeResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzAttributeTypeResponseRawData) IsSet 

func (o OptNilSzAttributeTypeResponseRawData) IsSet() bool

IsSet returns true if OptNilSzAttributeTypeResponseRawData was set.

func (OptNilSzAttributeTypeResponseRawData) MarshalJSON 

func (s OptNilSzAttributeTypeResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzAttributeTypeResponseRawData) Or 

func (o OptNilSzAttributeTypeResponseRawData) Or(d SzAttributeTypeResponseRawData) SzAttributeTypeResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzAttributeTypeResponseRawData) Reset 

func (o *OptNilSzAttributeTypeResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzAttributeTypeResponseRawData) SetTo 

func (o *OptNilSzAttributeTypeResponseRawData) SetTo(v SzAttributeTypeResponseRawData)

SetTo sets value to v.

func (*OptNilSzAttributeTypeResponseRawData) SetToNull 

func (o *OptNilSzAttributeTypeResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzAttributeTypeResponseRawData) UnmarshalJSON 

func (s *OptNilSzAttributeTypeResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzAttributeTypesResponseRawData 

type OptNilSzAttributeTypesResponseRawData struct {
	Value SzAttributeTypesResponseRawData
	Set   bool
	Null  bool
}

OptNilSzAttributeTypesResponseRawData is optional nullable SzAttributeTypesResponseRawData.

func NewOptNilSzAttributeTypesResponseRawData 

func NewOptNilSzAttributeTypesResponseRawData(v SzAttributeTypesResponseRawData) OptNilSzAttributeTypesResponseRawData

NewOptNilSzAttributeTypesResponseRawData returns new OptNilSzAttributeTypesResponseRawData with value set to v.

func (*OptNilSzAttributeTypesResponseRawData) Decode 

func (o *OptNilSzAttributeTypesResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypesResponseRawData from json.

func (OptNilSzAttributeTypesResponseRawData) Encode 

func (o OptNilSzAttributeTypesResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzAttributeTypesResponseRawData as json.

func (OptNilSzAttributeTypesResponseRawData) Get 

func (o OptNilSzAttributeTypesResponseRawData) Get() (v SzAttributeTypesResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzAttributeTypesResponseRawData) IsNull 

func (o OptNilSzAttributeTypesResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzAttributeTypesResponseRawData) IsSet 

func (o OptNilSzAttributeTypesResponseRawData) IsSet() bool

IsSet returns true if OptNilSzAttributeTypesResponseRawData was set.

func (OptNilSzAttributeTypesResponseRawData) MarshalJSON 

func (s OptNilSzAttributeTypesResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzAttributeTypesResponseRawData) Or 

func (o OptNilSzAttributeTypesResponseRawData) Or(d SzAttributeTypesResponseRawData) SzAttributeTypesResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzAttributeTypesResponseRawData) Reset 

func (o *OptNilSzAttributeTypesResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzAttributeTypesResponseRawData) SetTo 

func (o *OptNilSzAttributeTypesResponseRawData) SetTo(v SzAttributeTypesResponseRawData)

SetTo sets value to v.

func (*OptNilSzAttributeTypesResponseRawData) SetToNull 

func (o *OptNilSzAttributeTypesResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzAttributeTypesResponseRawData) UnmarshalJSON 

func (s *OptNilSzAttributeTypesResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzConfigResponseRawData added in v0.9.0 

type OptNilSzConfigResponseRawData struct {
	Value SzConfigResponseRawData
	Set   bool
	Null  bool
}

OptNilSzConfigResponseRawData is optional nullable SzConfigResponseRawData.

func NewOptNilSzConfigResponseRawData added in v0.9.0 

func NewOptNilSzConfigResponseRawData(v SzConfigResponseRawData) OptNilSzConfigResponseRawData

NewOptNilSzConfigResponseRawData returns new OptNilSzConfigResponseRawData with value set to v.

func (*OptNilSzConfigResponseRawData) Decode added in v0.9.0 

func (o *OptNilSzConfigResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzConfigResponseRawData from json.

func (OptNilSzConfigResponseRawData) Encode added in v0.9.0 

func (o OptNilSzConfigResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzConfigResponseRawData as json.

func (OptNilSzConfigResponseRawData) Get added in v0.9.0 

func (o OptNilSzConfigResponseRawData) Get() (v SzConfigResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzConfigResponseRawData) IsNull added in v0.9.0 

func (o OptNilSzConfigResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzConfigResponseRawData) IsSet added in v0.9.0 

func (o OptNilSzConfigResponseRawData) IsSet() bool

IsSet returns true if OptNilSzConfigResponseRawData was set.

func (OptNilSzConfigResponseRawData) MarshalJSON added in v0.9.0 

func (s OptNilSzConfigResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzConfigResponseRawData) Or added in v0.9.0 

func (o OptNilSzConfigResponseRawData) Or(d SzConfigResponseRawData) SzConfigResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzConfigResponseRawData) Reset added in v0.9.0 

func (o *OptNilSzConfigResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzConfigResponseRawData) SetTo added in v0.9.0 

func (o *OptNilSzConfigResponseRawData) SetTo(v SzConfigResponseRawData)

SetTo sets value to v.

func (*OptNilSzConfigResponseRawData) SetToNull added in v0.9.0 

func (o *OptNilSzConfigResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzConfigResponseRawData) UnmarshalJSON added in v0.9.0 

func (s *OptNilSzConfigResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzDataSourceResponseRawData 

type OptNilSzDataSourceResponseRawData struct {
	Value SzDataSourceResponseRawData
	Set   bool
	Null  bool
}

OptNilSzDataSourceResponseRawData is optional nullable SzDataSourceResponseRawData.

func NewOptNilSzDataSourceResponseRawData 

func NewOptNilSzDataSourceResponseRawData(v SzDataSourceResponseRawData) OptNilSzDataSourceResponseRawData

NewOptNilSzDataSourceResponseRawData returns new OptNilSzDataSourceResponseRawData with value set to v.

func (*OptNilSzDataSourceResponseRawData) Decode 

func (o *OptNilSzDataSourceResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceResponseRawData from json.

func (OptNilSzDataSourceResponseRawData) Encode 

func (o OptNilSzDataSourceResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzDataSourceResponseRawData as json.

func (OptNilSzDataSourceResponseRawData) Get 

func (o OptNilSzDataSourceResponseRawData) Get() (v SzDataSourceResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzDataSourceResponseRawData) IsNull 

func (o OptNilSzDataSourceResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzDataSourceResponseRawData) IsSet 

func (o OptNilSzDataSourceResponseRawData) IsSet() bool

IsSet returns true if OptNilSzDataSourceResponseRawData was set.

func (OptNilSzDataSourceResponseRawData) MarshalJSON 

func (s OptNilSzDataSourceResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzDataSourceResponseRawData) Or 

func (o OptNilSzDataSourceResponseRawData) Or(d SzDataSourceResponseRawData) SzDataSourceResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzDataSourceResponseRawData) Reset 

func (o *OptNilSzDataSourceResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzDataSourceResponseRawData) SetTo 

func (o *OptNilSzDataSourceResponseRawData) SetTo(v SzDataSourceResponseRawData)

SetTo sets value to v.

func (*OptNilSzDataSourceResponseRawData) SetToNull 

func (o *OptNilSzDataSourceResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzDataSourceResponseRawData) UnmarshalJSON 

func (s *OptNilSzDataSourceResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzDataSourcesResponseRawData 

type OptNilSzDataSourcesResponseRawData struct {
	Value SzDataSourcesResponseRawData
	Set   bool
	Null  bool
}

OptNilSzDataSourcesResponseRawData is optional nullable SzDataSourcesResponseRawData.

func NewOptNilSzDataSourcesResponseRawData 

func NewOptNilSzDataSourcesResponseRawData(v SzDataSourcesResponseRawData) OptNilSzDataSourcesResponseRawData

NewOptNilSzDataSourcesResponseRawData returns new OptNilSzDataSourcesResponseRawData with value set to v.

func (*OptNilSzDataSourcesResponseRawData) Decode 

func (o *OptNilSzDataSourcesResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzDataSourcesResponseRawData from json.

func (OptNilSzDataSourcesResponseRawData) Encode 

func (o OptNilSzDataSourcesResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzDataSourcesResponseRawData as json.

func (OptNilSzDataSourcesResponseRawData) Get 

func (o OptNilSzDataSourcesResponseRawData) Get() (v SzDataSourcesResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzDataSourcesResponseRawData) IsNull 

func (o OptNilSzDataSourcesResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzDataSourcesResponseRawData) IsSet 

func (o OptNilSzDataSourcesResponseRawData) IsSet() bool

IsSet returns true if OptNilSzDataSourcesResponseRawData was set.

func (OptNilSzDataSourcesResponseRawData) MarshalJSON 

func (s OptNilSzDataSourcesResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzDataSourcesResponseRawData) Or 

func (o OptNilSzDataSourcesResponseRawData) Or(d SzDataSourcesResponseRawData) SzDataSourcesResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzDataSourcesResponseRawData) Reset 

func (o *OptNilSzDataSourcesResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzDataSourcesResponseRawData) SetTo 

func (o *OptNilSzDataSourcesResponseRawData) SetTo(v SzDataSourcesResponseRawData)

SetTo sets value to v.

func (*OptNilSzDataSourcesResponseRawData) SetToNull 

func (o *OptNilSzDataSourcesResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzDataSourcesResponseRawData) UnmarshalJSON 

func (s *OptNilSzDataSourcesResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzDeleteRecordResponseRawData 

type OptNilSzDeleteRecordResponseRawData struct {
	Value SzDeleteRecordResponseRawData
	Set   bool
	Null  bool
}

OptNilSzDeleteRecordResponseRawData is optional nullable SzDeleteRecordResponseRawData.

func NewOptNilSzDeleteRecordResponseRawData 

func NewOptNilSzDeleteRecordResponseRawData(v SzDeleteRecordResponseRawData) OptNilSzDeleteRecordResponseRawData

NewOptNilSzDeleteRecordResponseRawData returns new OptNilSzDeleteRecordResponseRawData with value set to v.

func (*OptNilSzDeleteRecordResponseRawData) Decode 

func (o *OptNilSzDeleteRecordResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzDeleteRecordResponseRawData from json.

func (OptNilSzDeleteRecordResponseRawData) Encode 

func (o OptNilSzDeleteRecordResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzDeleteRecordResponseRawData as json.

func (OptNilSzDeleteRecordResponseRawData) Get 

func (o OptNilSzDeleteRecordResponseRawData) Get() (v SzDeleteRecordResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzDeleteRecordResponseRawData) IsNull 

func (o OptNilSzDeleteRecordResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzDeleteRecordResponseRawData) IsSet 

func (o OptNilSzDeleteRecordResponseRawData) IsSet() bool

IsSet returns true if OptNilSzDeleteRecordResponseRawData was set.

func (OptNilSzDeleteRecordResponseRawData) MarshalJSON 

func (s OptNilSzDeleteRecordResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzDeleteRecordResponseRawData) Or 

func (o OptNilSzDeleteRecordResponseRawData) Or(d SzDeleteRecordResponseRawData) SzDeleteRecordResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzDeleteRecordResponseRawData) Reset 

func (o *OptNilSzDeleteRecordResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzDeleteRecordResponseRawData) SetTo 

func (o *OptNilSzDeleteRecordResponseRawData) SetTo(v SzDeleteRecordResponseRawData)

SetTo sets value to v.

func (*OptNilSzDeleteRecordResponseRawData) SetToNull 

func (o *OptNilSzDeleteRecordResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzDeleteRecordResponseRawData) UnmarshalJSON 

func (s *OptNilSzDeleteRecordResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzDisclosedRelationArray 

type OptNilSzDisclosedRelationArray struct {
	Value []SzDisclosedRelation
	Set   bool
	Null  bool
}

OptNilSzDisclosedRelationArray is optional nullable []SzDisclosedRelation.

func NewOptNilSzDisclosedRelationArray 

func NewOptNilSzDisclosedRelationArray(v []SzDisclosedRelation) OptNilSzDisclosedRelationArray

NewOptNilSzDisclosedRelationArray returns new OptNilSzDisclosedRelationArray with value set to v.

func (*OptNilSzDisclosedRelationArray) Decode 

func (o *OptNilSzDisclosedRelationArray) Decode(d *jx.Decoder) error

Decode decodes []SzDisclosedRelation from json.

func (OptNilSzDisclosedRelationArray) Encode 

func (o OptNilSzDisclosedRelationArray) Encode(e *jx.Encoder)

Encode encodes []SzDisclosedRelation as json.

func (OptNilSzDisclosedRelationArray) Get 

func (o OptNilSzDisclosedRelationArray) Get() (v []SzDisclosedRelation, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzDisclosedRelationArray) IsNull 

func (o OptNilSzDisclosedRelationArray) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzDisclosedRelationArray) IsSet 

func (o OptNilSzDisclosedRelationArray) IsSet() bool

IsSet returns true if OptNilSzDisclosedRelationArray was set.

func (OptNilSzDisclosedRelationArray) MarshalJSON 

func (s OptNilSzDisclosedRelationArray) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzDisclosedRelationArray) Or 

func (o OptNilSzDisclosedRelationArray) Or(d []SzDisclosedRelation) []SzDisclosedRelation

Or returns value if set, or given parameter if does not.

func (*OptNilSzDisclosedRelationArray) Reset 

func (o *OptNilSzDisclosedRelationArray) Reset()

Reset unsets value.

func (*OptNilSzDisclosedRelationArray) SetTo 

func (o *OptNilSzDisclosedRelationArray) SetTo(v []SzDisclosedRelation)

SetTo sets value to v.

func (*OptNilSzDisclosedRelationArray) SetToNull 

func (o *OptNilSzDisclosedRelationArray) SetToNull()

SetNull sets value to null.

func (*OptNilSzDisclosedRelationArray) UnmarshalJSON 

func (s *OptNilSzDisclosedRelationArray) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzEntityNetworkResponseRawData 

type OptNilSzEntityNetworkResponseRawData struct {
	Value SzEntityNetworkResponseRawData
	Set   bool
	Null  bool
}

OptNilSzEntityNetworkResponseRawData is optional nullable SzEntityNetworkResponseRawData.

func NewOptNilSzEntityNetworkResponseRawData 

func NewOptNilSzEntityNetworkResponseRawData(v SzEntityNetworkResponseRawData) OptNilSzEntityNetworkResponseRawData

NewOptNilSzEntityNetworkResponseRawData returns new OptNilSzEntityNetworkResponseRawData with value set to v.

func (*OptNilSzEntityNetworkResponseRawData) Decode 

func (o *OptNilSzEntityNetworkResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzEntityNetworkResponseRawData from json.

func (OptNilSzEntityNetworkResponseRawData) Encode 

func (o OptNilSzEntityNetworkResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzEntityNetworkResponseRawData as json.

func (OptNilSzEntityNetworkResponseRawData) Get 

func (o OptNilSzEntityNetworkResponseRawData) Get() (v SzEntityNetworkResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzEntityNetworkResponseRawData) IsNull 

func (o OptNilSzEntityNetworkResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzEntityNetworkResponseRawData) IsSet 

func (o OptNilSzEntityNetworkResponseRawData) IsSet() bool

IsSet returns true if OptNilSzEntityNetworkResponseRawData was set.

func (OptNilSzEntityNetworkResponseRawData) MarshalJSON 

func (s OptNilSzEntityNetworkResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzEntityNetworkResponseRawData) Or 

func (o OptNilSzEntityNetworkResponseRawData) Or(d SzEntityNetworkResponseRawData) SzEntityNetworkResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzEntityNetworkResponseRawData) Reset 

func (o *OptNilSzEntityNetworkResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzEntityNetworkResponseRawData) SetTo 

func (o *OptNilSzEntityNetworkResponseRawData) SetTo(v SzEntityNetworkResponseRawData)

SetTo sets value to v.

func (*OptNilSzEntityNetworkResponseRawData) SetToNull 

func (o *OptNilSzEntityNetworkResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzEntityNetworkResponseRawData) UnmarshalJSON 

func (s *OptNilSzEntityNetworkResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzEntityPathResponseRawData 

type OptNilSzEntityPathResponseRawData struct {
	Value SzEntityPathResponseRawData
	Set   bool
	Null  bool
}

OptNilSzEntityPathResponseRawData is optional nullable SzEntityPathResponseRawData.

func NewOptNilSzEntityPathResponseRawData 

func NewOptNilSzEntityPathResponseRawData(v SzEntityPathResponseRawData) OptNilSzEntityPathResponseRawData

NewOptNilSzEntityPathResponseRawData returns new OptNilSzEntityPathResponseRawData with value set to v.

func (*OptNilSzEntityPathResponseRawData) Decode 

func (o *OptNilSzEntityPathResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzEntityPathResponseRawData from json.

func (OptNilSzEntityPathResponseRawData) Encode 

func (o OptNilSzEntityPathResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzEntityPathResponseRawData as json.

func (OptNilSzEntityPathResponseRawData) Get 

func (o OptNilSzEntityPathResponseRawData) Get() (v SzEntityPathResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzEntityPathResponseRawData) IsNull 

func (o OptNilSzEntityPathResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzEntityPathResponseRawData) IsSet 

func (o OptNilSzEntityPathResponseRawData) IsSet() bool

IsSet returns true if OptNilSzEntityPathResponseRawData was set.

func (OptNilSzEntityPathResponseRawData) MarshalJSON 

func (s OptNilSzEntityPathResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzEntityPathResponseRawData) Or 

func (o OptNilSzEntityPathResponseRawData) Or(d SzEntityPathResponseRawData) SzEntityPathResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzEntityPathResponseRawData) Reset 

func (o *OptNilSzEntityPathResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzEntityPathResponseRawData) SetTo 

func (o *OptNilSzEntityPathResponseRawData) SetTo(v SzEntityPathResponseRawData)

SetTo sets value to v.

func (*OptNilSzEntityPathResponseRawData) SetToNull 

func (o *OptNilSzEntityPathResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzEntityPathResponseRawData) UnmarshalJSON 

func (s *OptNilSzEntityPathResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzEntityResponseRawData 

type OptNilSzEntityResponseRawData struct {
	Value SzEntityResponseRawData
	Set   bool
	Null  bool
}

OptNilSzEntityResponseRawData is optional nullable SzEntityResponseRawData.

func NewOptNilSzEntityResponseRawData 

func NewOptNilSzEntityResponseRawData(v SzEntityResponseRawData) OptNilSzEntityResponseRawData

NewOptNilSzEntityResponseRawData returns new OptNilSzEntityResponseRawData with value set to v.

func (*OptNilSzEntityResponseRawData) Decode 

func (o *OptNilSzEntityResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzEntityResponseRawData from json.

func (OptNilSzEntityResponseRawData) Encode 

func (o OptNilSzEntityResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzEntityResponseRawData as json.

func (OptNilSzEntityResponseRawData) Get 

func (o OptNilSzEntityResponseRawData) Get() (v SzEntityResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzEntityResponseRawData) IsNull 

func (o OptNilSzEntityResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzEntityResponseRawData) IsSet 

func (o OptNilSzEntityResponseRawData) IsSet() bool

IsSet returns true if OptNilSzEntityResponseRawData was set.

func (OptNilSzEntityResponseRawData) MarshalJSON 

func (s OptNilSzEntityResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzEntityResponseRawData) Or 

func (o OptNilSzEntityResponseRawData) Or(d SzEntityResponseRawData) SzEntityResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzEntityResponseRawData) Reset 

func (o *OptNilSzEntityResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzEntityResponseRawData) SetTo 

func (o *OptNilSzEntityResponseRawData) SetTo(v SzEntityResponseRawData)

SetTo sets value to v.

func (*OptNilSzEntityResponseRawData) SetToNull 

func (o *OptNilSzEntityResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzEntityResponseRawData) UnmarshalJSON 

func (s *OptNilSzEntityResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzFeatureReferenceArray 

type OptNilSzFeatureReferenceArray struct {
	Value []SzFeatureReference
	Set   bool
	Null  bool
}

OptNilSzFeatureReferenceArray is optional nullable []SzFeatureReference.

func NewOptNilSzFeatureReferenceArray 

func NewOptNilSzFeatureReferenceArray(v []SzFeatureReference) OptNilSzFeatureReferenceArray

NewOptNilSzFeatureReferenceArray returns new OptNilSzFeatureReferenceArray with value set to v.

func (*OptNilSzFeatureReferenceArray) Decode 

func (o *OptNilSzFeatureReferenceArray) Decode(d *jx.Decoder) error

Decode decodes []SzFeatureReference from json.

func (OptNilSzFeatureReferenceArray) Encode 

func (o OptNilSzFeatureReferenceArray) Encode(e *jx.Encoder)

Encode encodes []SzFeatureReference as json.

func (OptNilSzFeatureReferenceArray) Get 

func (o OptNilSzFeatureReferenceArray) Get() (v []SzFeatureReference, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzFeatureReferenceArray) IsNull 

func (o OptNilSzFeatureReferenceArray) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzFeatureReferenceArray) IsSet 

func (o OptNilSzFeatureReferenceArray) IsSet() bool

IsSet returns true if OptNilSzFeatureReferenceArray was set.

func (OptNilSzFeatureReferenceArray) MarshalJSON 

func (s OptNilSzFeatureReferenceArray) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzFeatureReferenceArray) Or 

func (o OptNilSzFeatureReferenceArray) Or(d []SzFeatureReference) []SzFeatureReference

Or returns value if set, or given parameter if does not.

func (*OptNilSzFeatureReferenceArray) Reset 

func (o *OptNilSzFeatureReferenceArray) Reset()

Reset unsets value.

func (*OptNilSzFeatureReferenceArray) SetTo 

func (o *OptNilSzFeatureReferenceArray) SetTo(v []SzFeatureReference)

SetTo sets value to v.

func (*OptNilSzFeatureReferenceArray) SetToNull 

func (o *OptNilSzFeatureReferenceArray) SetToNull()

SetNull sets value to null.

func (*OptNilSzFeatureReferenceArray) UnmarshalJSON 

func (s *OptNilSzFeatureReferenceArray) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzHowEntityResponseRawData 

type OptNilSzHowEntityResponseRawData struct {
	Value SzHowEntityResponseRawData
	Set   bool
	Null  bool
}

OptNilSzHowEntityResponseRawData is optional nullable SzHowEntityResponseRawData.

func NewOptNilSzHowEntityResponseRawData 

func NewOptNilSzHowEntityResponseRawData(v SzHowEntityResponseRawData) OptNilSzHowEntityResponseRawData

NewOptNilSzHowEntityResponseRawData returns new OptNilSzHowEntityResponseRawData with value set to v.

func (*OptNilSzHowEntityResponseRawData) Decode 

func (o *OptNilSzHowEntityResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzHowEntityResponseRawData from json.

func (OptNilSzHowEntityResponseRawData) Encode 

func (o OptNilSzHowEntityResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzHowEntityResponseRawData as json.

func (OptNilSzHowEntityResponseRawData) Get 

func (o OptNilSzHowEntityResponseRawData) Get() (v SzHowEntityResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzHowEntityResponseRawData) IsNull 

func (o OptNilSzHowEntityResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzHowEntityResponseRawData) IsSet 

func (o OptNilSzHowEntityResponseRawData) IsSet() bool

IsSet returns true if OptNilSzHowEntityResponseRawData was set.

func (OptNilSzHowEntityResponseRawData) MarshalJSON 

func (s OptNilSzHowEntityResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzHowEntityResponseRawData) Or 

func (o OptNilSzHowEntityResponseRawData) Or(d SzHowEntityResponseRawData) SzHowEntityResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzHowEntityResponseRawData) Reset 

func (o *OptNilSzHowEntityResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzHowEntityResponseRawData) SetTo 

func (o *OptNilSzHowEntityResponseRawData) SetTo(v SzHowEntityResponseRawData)

SetTo sets value to v.

func (*OptNilSzHowEntityResponseRawData) SetToNull 

func (o *OptNilSzHowEntityResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzHowEntityResponseRawData) UnmarshalJSON 

func (s *OptNilSzHowEntityResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzHowMatchInfoFeatureScores 

type OptNilSzHowMatchInfoFeatureScores struct {
	Value SzHowMatchInfoFeatureScores
	Set   bool
	Null  bool
}

OptNilSzHowMatchInfoFeatureScores is optional nullable SzHowMatchInfoFeatureScores.

func NewOptNilSzHowMatchInfoFeatureScores 

func NewOptNilSzHowMatchInfoFeatureScores(v SzHowMatchInfoFeatureScores) OptNilSzHowMatchInfoFeatureScores

NewOptNilSzHowMatchInfoFeatureScores returns new OptNilSzHowMatchInfoFeatureScores with value set to v.

func (*OptNilSzHowMatchInfoFeatureScores) Decode 

func (o *OptNilSzHowMatchInfoFeatureScores) Decode(d *jx.Decoder) error

Decode decodes SzHowMatchInfoFeatureScores from json.

func (OptNilSzHowMatchInfoFeatureScores) Encode 

func (o OptNilSzHowMatchInfoFeatureScores) Encode(e *jx.Encoder)

Encode encodes SzHowMatchInfoFeatureScores as json.

func (OptNilSzHowMatchInfoFeatureScores) Get 

func (o OptNilSzHowMatchInfoFeatureScores) Get() (v SzHowMatchInfoFeatureScores, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzHowMatchInfoFeatureScores) IsNull 

func (o OptNilSzHowMatchInfoFeatureScores) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzHowMatchInfoFeatureScores) IsSet 

func (o OptNilSzHowMatchInfoFeatureScores) IsSet() bool

IsSet returns true if OptNilSzHowMatchInfoFeatureScores was set.

func (OptNilSzHowMatchInfoFeatureScores) MarshalJSON 

func (s OptNilSzHowMatchInfoFeatureScores) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzHowMatchInfoFeatureScores) Or 

func (o OptNilSzHowMatchInfoFeatureScores) Or(d SzHowMatchInfoFeatureScores) SzHowMatchInfoFeatureScores

Or returns value if set, or given parameter if does not.

func (*OptNilSzHowMatchInfoFeatureScores) Reset 

func (o *OptNilSzHowMatchInfoFeatureScores) Reset()

Reset unsets value.

func (*OptNilSzHowMatchInfoFeatureScores) SetTo 

func (o *OptNilSzHowMatchInfoFeatureScores) SetTo(v SzHowMatchInfoFeatureScores)

SetTo sets value to v.

func (*OptNilSzHowMatchInfoFeatureScores) SetToNull 

func (o *OptNilSzHowMatchInfoFeatureScores) SetToNull()

SetNull sets value to null.

func (*OptNilSzHowMatchInfoFeatureScores) UnmarshalJSON 

func (s *OptNilSzHowMatchInfoFeatureScores) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzLicenseResponseRawData 

type OptNilSzLicenseResponseRawData struct {
	Value SzLicenseResponseRawData
	Set   bool
	Null  bool
}

OptNilSzLicenseResponseRawData is optional nullable SzLicenseResponseRawData.

func NewOptNilSzLicenseResponseRawData 

func NewOptNilSzLicenseResponseRawData(v SzLicenseResponseRawData) OptNilSzLicenseResponseRawData

NewOptNilSzLicenseResponseRawData returns new OptNilSzLicenseResponseRawData with value set to v.

func (*OptNilSzLicenseResponseRawData) Decode 

func (o *OptNilSzLicenseResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzLicenseResponseRawData from json.

func (OptNilSzLicenseResponseRawData) Encode 

func (o OptNilSzLicenseResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzLicenseResponseRawData as json.

func (OptNilSzLicenseResponseRawData) Get 

func (o OptNilSzLicenseResponseRawData) Get() (v SzLicenseResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzLicenseResponseRawData) IsNull 

func (o OptNilSzLicenseResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzLicenseResponseRawData) IsSet 

func (o OptNilSzLicenseResponseRawData) IsSet() bool

IsSet returns true if OptNilSzLicenseResponseRawData was set.

func (OptNilSzLicenseResponseRawData) MarshalJSON 

func (s OptNilSzLicenseResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzLicenseResponseRawData) Or 

func (o OptNilSzLicenseResponseRawData) Or(d SzLicenseResponseRawData) SzLicenseResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzLicenseResponseRawData) Reset 

func (o *OptNilSzLicenseResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzLicenseResponseRawData) SetTo 

func (o *OptNilSzLicenseResponseRawData) SetTo(v SzLicenseResponseRawData)

SetTo sets value to v.

func (*OptNilSzLicenseResponseRawData) SetToNull 

func (o *OptNilSzLicenseResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzLicenseResponseRawData) UnmarshalJSON 

func (s *OptNilSzLicenseResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzLoadRecordResponseRawData 

type OptNilSzLoadRecordResponseRawData struct {
	Value SzLoadRecordResponseRawData
	Set   bool
	Null  bool
}

OptNilSzLoadRecordResponseRawData is optional nullable SzLoadRecordResponseRawData.

func NewOptNilSzLoadRecordResponseRawData 

func NewOptNilSzLoadRecordResponseRawData(v SzLoadRecordResponseRawData) OptNilSzLoadRecordResponseRawData

NewOptNilSzLoadRecordResponseRawData returns new OptNilSzLoadRecordResponseRawData with value set to v.

func (*OptNilSzLoadRecordResponseRawData) Decode 

func (o *OptNilSzLoadRecordResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzLoadRecordResponseRawData from json.

func (OptNilSzLoadRecordResponseRawData) Encode 

func (o OptNilSzLoadRecordResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzLoadRecordResponseRawData as json.

func (OptNilSzLoadRecordResponseRawData) Get 

func (o OptNilSzLoadRecordResponseRawData) Get() (v SzLoadRecordResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzLoadRecordResponseRawData) IsNull 

func (o OptNilSzLoadRecordResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzLoadRecordResponseRawData) IsSet 

func (o OptNilSzLoadRecordResponseRawData) IsSet() bool

IsSet returns true if OptNilSzLoadRecordResponseRawData was set.

func (OptNilSzLoadRecordResponseRawData) MarshalJSON 

func (s OptNilSzLoadRecordResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzLoadRecordResponseRawData) Or 

func (o OptNilSzLoadRecordResponseRawData) Or(d SzLoadRecordResponseRawData) SzLoadRecordResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzLoadRecordResponseRawData) Reset 

func (o *OptNilSzLoadRecordResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzLoadRecordResponseRawData) SetTo 

func (o *OptNilSzLoadRecordResponseRawData) SetTo(v SzLoadRecordResponseRawData)

SetTo sets value to v.

func (*OptNilSzLoadRecordResponseRawData) SetToNull 

func (o *OptNilSzLoadRecordResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzLoadRecordResponseRawData) UnmarshalJSON 

func (s *OptNilSzLoadRecordResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzMetaTimings 

type OptNilSzMetaTimings struct {
	Value SzMetaTimings
	Set   bool
	Null  bool
}

OptNilSzMetaTimings is optional nullable SzMetaTimings.

func NewOptNilSzMetaTimings 

func NewOptNilSzMetaTimings(v SzMetaTimings) OptNilSzMetaTimings

NewOptNilSzMetaTimings returns new OptNilSzMetaTimings with value set to v.

func (*OptNilSzMetaTimings) Decode 

func (o *OptNilSzMetaTimings) Decode(d *jx.Decoder) error

Decode decodes SzMetaTimings from json.

func (OptNilSzMetaTimings) Encode 

func (o OptNilSzMetaTimings) Encode(e *jx.Encoder)

Encode encodes SzMetaTimings as json.

func (OptNilSzMetaTimings) Get 

func (o OptNilSzMetaTimings) Get() (v SzMetaTimings, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzMetaTimings) IsNull 

func (o OptNilSzMetaTimings) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzMetaTimings) IsSet 

func (o OptNilSzMetaTimings) IsSet() bool

IsSet returns true if OptNilSzMetaTimings was set.

func (OptNilSzMetaTimings) MarshalJSON 

func (s OptNilSzMetaTimings) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzMetaTimings) Or 

func (o OptNilSzMetaTimings) Or(d SzMetaTimings) SzMetaTimings

Or returns value if set, or given parameter if does not.

func (*OptNilSzMetaTimings) Reset 

func (o *OptNilSzMetaTimings) Reset()

Reset unsets value.

func (*OptNilSzMetaTimings) SetTo 

func (o *OptNilSzMetaTimings) SetTo(v SzMetaTimings)

SetTo sets value to v.

func (*OptNilSzMetaTimings) SetToNull 

func (o *OptNilSzMetaTimings) SetToNull()

SetNull sets value to null.

func (*OptNilSzMetaTimings) UnmarshalJSON 

func (s *OptNilSzMetaTimings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzRecordResponseRawData 

type OptNilSzRecordResponseRawData struct {
	Value SzRecordResponseRawData
	Set   bool
	Null  bool
}

OptNilSzRecordResponseRawData is optional nullable SzRecordResponseRawData.

func NewOptNilSzRecordResponseRawData 

func NewOptNilSzRecordResponseRawData(v SzRecordResponseRawData) OptNilSzRecordResponseRawData

NewOptNilSzRecordResponseRawData returns new OptNilSzRecordResponseRawData with value set to v.

func (*OptNilSzRecordResponseRawData) Decode 

func (o *OptNilSzRecordResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzRecordResponseRawData from json.

func (OptNilSzRecordResponseRawData) Encode 

func (o OptNilSzRecordResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzRecordResponseRawData as json.

func (OptNilSzRecordResponseRawData) Get 

func (o OptNilSzRecordResponseRawData) Get() (v SzRecordResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzRecordResponseRawData) IsNull 

func (o OptNilSzRecordResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzRecordResponseRawData) IsSet 

func (o OptNilSzRecordResponseRawData) IsSet() bool

IsSet returns true if OptNilSzRecordResponseRawData was set.

func (OptNilSzRecordResponseRawData) MarshalJSON 

func (s OptNilSzRecordResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzRecordResponseRawData) Or 

func (o OptNilSzRecordResponseRawData) Or(d SzRecordResponseRawData) SzRecordResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzRecordResponseRawData) Reset 

func (o *OptNilSzRecordResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzRecordResponseRawData) SetTo 

func (o *OptNilSzRecordResponseRawData) SetTo(v SzRecordResponseRawData)

SetTo sets value to v.

func (*OptNilSzRecordResponseRawData) SetToNull 

func (o *OptNilSzRecordResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzRecordResponseRawData) UnmarshalJSON 

func (s *OptNilSzRecordResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzReevaluateResponseRawData 

type OptNilSzReevaluateResponseRawData struct {
	Value SzReevaluateResponseRawData
	Set   bool
	Null  bool
}

OptNilSzReevaluateResponseRawData is optional nullable SzReevaluateResponseRawData.

func NewOptNilSzReevaluateResponseRawData 

func NewOptNilSzReevaluateResponseRawData(v SzReevaluateResponseRawData) OptNilSzReevaluateResponseRawData

NewOptNilSzReevaluateResponseRawData returns new OptNilSzReevaluateResponseRawData with value set to v.

func (*OptNilSzReevaluateResponseRawData) Decode 

func (o *OptNilSzReevaluateResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzReevaluateResponseRawData from json.

func (OptNilSzReevaluateResponseRawData) Encode 

func (o OptNilSzReevaluateResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzReevaluateResponseRawData as json.

func (OptNilSzReevaluateResponseRawData) Get 

func (o OptNilSzReevaluateResponseRawData) Get() (v SzReevaluateResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzReevaluateResponseRawData) IsNull 

func (o OptNilSzReevaluateResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzReevaluateResponseRawData) IsSet 

func (o OptNilSzReevaluateResponseRawData) IsSet() bool

IsSet returns true if OptNilSzReevaluateResponseRawData was set.

func (OptNilSzReevaluateResponseRawData) MarshalJSON 

func (s OptNilSzReevaluateResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzReevaluateResponseRawData) Or 

func (o OptNilSzReevaluateResponseRawData) Or(d SzReevaluateResponseRawData) SzReevaluateResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzReevaluateResponseRawData) Reset 

func (o *OptNilSzReevaluateResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzReevaluateResponseRawData) SetTo 

func (o *OptNilSzReevaluateResponseRawData) SetTo(v SzReevaluateResponseRawData)

SetTo sets value to v.

func (*OptNilSzReevaluateResponseRawData) SetToNull 

func (o *OptNilSzReevaluateResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzReevaluateResponseRawData) UnmarshalJSON 

func (s *OptNilSzReevaluateResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzVersionResponseRawData 

type OptNilSzVersionResponseRawData struct {
	Value SzVersionResponseRawData
	Set   bool
	Null  bool
}

OptNilSzVersionResponseRawData is optional nullable SzVersionResponseRawData.

func NewOptNilSzVersionResponseRawData 

func NewOptNilSzVersionResponseRawData(v SzVersionResponseRawData) OptNilSzVersionResponseRawData

NewOptNilSzVersionResponseRawData returns new OptNilSzVersionResponseRawData with value set to v.

func (*OptNilSzVersionResponseRawData) Decode 

func (o *OptNilSzVersionResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzVersionResponseRawData from json.

func (OptNilSzVersionResponseRawData) Encode 

func (o OptNilSzVersionResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzVersionResponseRawData as json.

func (OptNilSzVersionResponseRawData) Get 

func (o OptNilSzVersionResponseRawData) Get() (v SzVersionResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzVersionResponseRawData) IsNull 

func (o OptNilSzVersionResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzVersionResponseRawData) IsSet 

func (o OptNilSzVersionResponseRawData) IsSet() bool

IsSet returns true if OptNilSzVersionResponseRawData was set.

func (OptNilSzVersionResponseRawData) MarshalJSON 

func (s OptNilSzVersionResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzVersionResponseRawData) Or 

func (o OptNilSzVersionResponseRawData) Or(d SzVersionResponseRawData) SzVersionResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzVersionResponseRawData) Reset 

func (o *OptNilSzVersionResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzVersionResponseRawData) SetTo 

func (o *OptNilSzVersionResponseRawData) SetTo(v SzVersionResponseRawData)

SetTo sets value to v.

func (*OptNilSzVersionResponseRawData) SetToNull 

func (o *OptNilSzVersionResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzVersionResponseRawData) UnmarshalJSON 

func (s *OptNilSzVersionResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzVirtualEntityResponseRawData 

type OptNilSzVirtualEntityResponseRawData struct {
	Value SzVirtualEntityResponseRawData
	Set   bool
	Null  bool
}

OptNilSzVirtualEntityResponseRawData is optional nullable SzVirtualEntityResponseRawData.

func NewOptNilSzVirtualEntityResponseRawData 

func NewOptNilSzVirtualEntityResponseRawData(v SzVirtualEntityResponseRawData) OptNilSzVirtualEntityResponseRawData

NewOptNilSzVirtualEntityResponseRawData returns new OptNilSzVirtualEntityResponseRawData with value set to v.

func (*OptNilSzVirtualEntityResponseRawData) Decode 

func (o *OptNilSzVirtualEntityResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzVirtualEntityResponseRawData from json.

func (OptNilSzVirtualEntityResponseRawData) Encode 

func (o OptNilSzVirtualEntityResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzVirtualEntityResponseRawData as json.

func (OptNilSzVirtualEntityResponseRawData) Get 

func (o OptNilSzVirtualEntityResponseRawData) Get() (v SzVirtualEntityResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzVirtualEntityResponseRawData) IsNull 

func (o OptNilSzVirtualEntityResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzVirtualEntityResponseRawData) IsSet 

func (o OptNilSzVirtualEntityResponseRawData) IsSet() bool

IsSet returns true if OptNilSzVirtualEntityResponseRawData was set.

func (OptNilSzVirtualEntityResponseRawData) MarshalJSON 

func (s OptNilSzVirtualEntityResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzVirtualEntityResponseRawData) Or 

func (o OptNilSzVirtualEntityResponseRawData) Or(d SzVirtualEntityResponseRawData) SzVirtualEntityResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzVirtualEntityResponseRawData) Reset 

func (o *OptNilSzVirtualEntityResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzVirtualEntityResponseRawData) SetTo 

func (o *OptNilSzVirtualEntityResponseRawData) SetTo(v SzVirtualEntityResponseRawData)

SetTo sets value to v.

func (*OptNilSzVirtualEntityResponseRawData) SetToNull 

func (o *OptNilSzVirtualEntityResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzVirtualEntityResponseRawData) UnmarshalJSON 

func (s *OptNilSzVirtualEntityResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzWhyEntitiesResponseRawData 

type OptNilSzWhyEntitiesResponseRawData struct {
	Value SzWhyEntitiesResponseRawData
	Set   bool
	Null  bool
}

OptNilSzWhyEntitiesResponseRawData is optional nullable SzWhyEntitiesResponseRawData.

func NewOptNilSzWhyEntitiesResponseRawData 

func NewOptNilSzWhyEntitiesResponseRawData(v SzWhyEntitiesResponseRawData) OptNilSzWhyEntitiesResponseRawData

NewOptNilSzWhyEntitiesResponseRawData returns new OptNilSzWhyEntitiesResponseRawData with value set to v.

func (*OptNilSzWhyEntitiesResponseRawData) Decode 

func (o *OptNilSzWhyEntitiesResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntitiesResponseRawData from json.

func (OptNilSzWhyEntitiesResponseRawData) Encode 

func (o OptNilSzWhyEntitiesResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzWhyEntitiesResponseRawData as json.

func (OptNilSzWhyEntitiesResponseRawData) Get 

func (o OptNilSzWhyEntitiesResponseRawData) Get() (v SzWhyEntitiesResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzWhyEntitiesResponseRawData) IsNull 

func (o OptNilSzWhyEntitiesResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzWhyEntitiesResponseRawData) IsSet 

func (o OptNilSzWhyEntitiesResponseRawData) IsSet() bool

IsSet returns true if OptNilSzWhyEntitiesResponseRawData was set.

func (OptNilSzWhyEntitiesResponseRawData) MarshalJSON 

func (s OptNilSzWhyEntitiesResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzWhyEntitiesResponseRawData) Or 

func (o OptNilSzWhyEntitiesResponseRawData) Or(d SzWhyEntitiesResponseRawData) SzWhyEntitiesResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzWhyEntitiesResponseRawData) Reset 

func (o *OptNilSzWhyEntitiesResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzWhyEntitiesResponseRawData) SetTo 

func (o *OptNilSzWhyEntitiesResponseRawData) SetTo(v SzWhyEntitiesResponseRawData)

SetTo sets value to v.

func (*OptNilSzWhyEntitiesResponseRawData) SetToNull 

func (o *OptNilSzWhyEntitiesResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzWhyEntitiesResponseRawData) UnmarshalJSON 

func (s *OptNilSzWhyEntitiesResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzWhyEntityResponseRawData 

type OptNilSzWhyEntityResponseRawData struct {
	Value SzWhyEntityResponseRawData
	Set   bool
	Null  bool
}

OptNilSzWhyEntityResponseRawData is optional nullable SzWhyEntityResponseRawData.

func NewOptNilSzWhyEntityResponseRawData 

func NewOptNilSzWhyEntityResponseRawData(v SzWhyEntityResponseRawData) OptNilSzWhyEntityResponseRawData

NewOptNilSzWhyEntityResponseRawData returns new OptNilSzWhyEntityResponseRawData with value set to v.

func (*OptNilSzWhyEntityResponseRawData) Decode 

func (o *OptNilSzWhyEntityResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntityResponseRawData from json.

func (OptNilSzWhyEntityResponseRawData) Encode 

func (o OptNilSzWhyEntityResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzWhyEntityResponseRawData as json.

func (OptNilSzWhyEntityResponseRawData) Get 

func (o OptNilSzWhyEntityResponseRawData) Get() (v SzWhyEntityResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzWhyEntityResponseRawData) IsNull 

func (o OptNilSzWhyEntityResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzWhyEntityResponseRawData) IsSet 

func (o OptNilSzWhyEntityResponseRawData) IsSet() bool

IsSet returns true if OptNilSzWhyEntityResponseRawData was set.

func (OptNilSzWhyEntityResponseRawData) MarshalJSON 

func (s OptNilSzWhyEntityResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzWhyEntityResponseRawData) Or 

func (o OptNilSzWhyEntityResponseRawData) Or(d SzWhyEntityResponseRawData) SzWhyEntityResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzWhyEntityResponseRawData) Reset 

func (o *OptNilSzWhyEntityResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzWhyEntityResponseRawData) SetTo 

func (o *OptNilSzWhyEntityResponseRawData) SetTo(v SzWhyEntityResponseRawData)

SetTo sets value to v.

func (*OptNilSzWhyEntityResponseRawData) SetToNull 

func (o *OptNilSzWhyEntityResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzWhyEntityResponseRawData) UnmarshalJSON 

func (s *OptNilSzWhyEntityResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzWhyMatchInfoCandidateKeys 

type OptNilSzWhyMatchInfoCandidateKeys struct {
	Value SzWhyMatchInfoCandidateKeys
	Set   bool
	Null  bool
}

OptNilSzWhyMatchInfoCandidateKeys is optional nullable SzWhyMatchInfoCandidateKeys.

func NewOptNilSzWhyMatchInfoCandidateKeys 

func NewOptNilSzWhyMatchInfoCandidateKeys(v SzWhyMatchInfoCandidateKeys) OptNilSzWhyMatchInfoCandidateKeys

NewOptNilSzWhyMatchInfoCandidateKeys returns new OptNilSzWhyMatchInfoCandidateKeys with value set to v.

func (*OptNilSzWhyMatchInfoCandidateKeys) Decode 

func (o *OptNilSzWhyMatchInfoCandidateKeys) Decode(d *jx.Decoder) error

Decode decodes SzWhyMatchInfoCandidateKeys from json.

func (OptNilSzWhyMatchInfoCandidateKeys) Encode 

func (o OptNilSzWhyMatchInfoCandidateKeys) Encode(e *jx.Encoder)

Encode encodes SzWhyMatchInfoCandidateKeys as json.

func (OptNilSzWhyMatchInfoCandidateKeys) Get 

func (o OptNilSzWhyMatchInfoCandidateKeys) Get() (v SzWhyMatchInfoCandidateKeys, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzWhyMatchInfoCandidateKeys) IsNull 

func (o OptNilSzWhyMatchInfoCandidateKeys) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzWhyMatchInfoCandidateKeys) IsSet 

func (o OptNilSzWhyMatchInfoCandidateKeys) IsSet() bool

IsSet returns true if OptNilSzWhyMatchInfoCandidateKeys was set.

func (OptNilSzWhyMatchInfoCandidateKeys) MarshalJSON 

func (s OptNilSzWhyMatchInfoCandidateKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzWhyMatchInfoCandidateKeys) Or 

func (o OptNilSzWhyMatchInfoCandidateKeys) Or(d SzWhyMatchInfoCandidateKeys) SzWhyMatchInfoCandidateKeys

Or returns value if set, or given parameter if does not.

func (*OptNilSzWhyMatchInfoCandidateKeys) Reset 

func (o *OptNilSzWhyMatchInfoCandidateKeys) Reset()

Reset unsets value.

func (*OptNilSzWhyMatchInfoCandidateKeys) SetTo 

func (o *OptNilSzWhyMatchInfoCandidateKeys) SetTo(v SzWhyMatchInfoCandidateKeys)

SetTo sets value to v.

func (*OptNilSzWhyMatchInfoCandidateKeys) SetToNull 

func (o *OptNilSzWhyMatchInfoCandidateKeys) SetToNull()

SetNull sets value to null.

func (*OptNilSzWhyMatchInfoCandidateKeys) UnmarshalJSON 

func (s *OptNilSzWhyMatchInfoCandidateKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzWhyMatchInfoFeatureScores 

type OptNilSzWhyMatchInfoFeatureScores struct {
	Value SzWhyMatchInfoFeatureScores
	Set   bool
	Null  bool
}

OptNilSzWhyMatchInfoFeatureScores is optional nullable SzWhyMatchInfoFeatureScores.

func NewOptNilSzWhyMatchInfoFeatureScores 

func NewOptNilSzWhyMatchInfoFeatureScores(v SzWhyMatchInfoFeatureScores) OptNilSzWhyMatchInfoFeatureScores

NewOptNilSzWhyMatchInfoFeatureScores returns new OptNilSzWhyMatchInfoFeatureScores with value set to v.

func (*OptNilSzWhyMatchInfoFeatureScores) Decode 

func (o *OptNilSzWhyMatchInfoFeatureScores) Decode(d *jx.Decoder) error

Decode decodes SzWhyMatchInfoFeatureScores from json.

func (OptNilSzWhyMatchInfoFeatureScores) Encode 

func (o OptNilSzWhyMatchInfoFeatureScores) Encode(e *jx.Encoder)

Encode encodes SzWhyMatchInfoFeatureScores as json.

func (OptNilSzWhyMatchInfoFeatureScores) Get 

func (o OptNilSzWhyMatchInfoFeatureScores) Get() (v SzWhyMatchInfoFeatureScores, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzWhyMatchInfoFeatureScores) IsNull 

func (o OptNilSzWhyMatchInfoFeatureScores) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzWhyMatchInfoFeatureScores) IsSet 

func (o OptNilSzWhyMatchInfoFeatureScores) IsSet() bool

IsSet returns true if OptNilSzWhyMatchInfoFeatureScores was set.

func (OptNilSzWhyMatchInfoFeatureScores) MarshalJSON 

func (s OptNilSzWhyMatchInfoFeatureScores) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzWhyMatchInfoFeatureScores) Or 

func (o OptNilSzWhyMatchInfoFeatureScores) Or(d SzWhyMatchInfoFeatureScores) SzWhyMatchInfoFeatureScores

Or returns value if set, or given parameter if does not.

func (*OptNilSzWhyMatchInfoFeatureScores) Reset 

func (o *OptNilSzWhyMatchInfoFeatureScores) Reset()

Reset unsets value.

func (*OptNilSzWhyMatchInfoFeatureScores) SetTo 

func (o *OptNilSzWhyMatchInfoFeatureScores) SetTo(v SzWhyMatchInfoFeatureScores)

SetTo sets value to v.

func (*OptNilSzWhyMatchInfoFeatureScores) SetToNull 

func (o *OptNilSzWhyMatchInfoFeatureScores) SetToNull()

SetNull sets value to null.

func (*OptNilSzWhyMatchInfoFeatureScores) UnmarshalJSON 

func (s *OptNilSzWhyMatchInfoFeatureScores) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptNilSzWhyRecordsResponseRawData 

type OptNilSzWhyRecordsResponseRawData struct {
	Value SzWhyRecordsResponseRawData
	Set   bool
	Null  bool
}

OptNilSzWhyRecordsResponseRawData is optional nullable SzWhyRecordsResponseRawData.

func NewOptNilSzWhyRecordsResponseRawData 

func NewOptNilSzWhyRecordsResponseRawData(v SzWhyRecordsResponseRawData) OptNilSzWhyRecordsResponseRawData

NewOptNilSzWhyRecordsResponseRawData returns new OptNilSzWhyRecordsResponseRawData with value set to v.

func (*OptNilSzWhyRecordsResponseRawData) Decode 

func (o *OptNilSzWhyRecordsResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzWhyRecordsResponseRawData from json.

func (OptNilSzWhyRecordsResponseRawData) Encode 

func (o OptNilSzWhyRecordsResponseRawData) Encode(e *jx.Encoder)

Encode encodes SzWhyRecordsResponseRawData as json.

func (OptNilSzWhyRecordsResponseRawData) Get 

func (o OptNilSzWhyRecordsResponseRawData) Get() (v SzWhyRecordsResponseRawData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptNilSzWhyRecordsResponseRawData) IsNull 

func (o OptNilSzWhyRecordsResponseRawData) IsNull() bool

IsSet returns true if value is Null.

func (OptNilSzWhyRecordsResponseRawData) IsSet 

func (o OptNilSzWhyRecordsResponseRawData) IsSet() bool

IsSet returns true if OptNilSzWhyRecordsResponseRawData was set.

func (OptNilSzWhyRecordsResponseRawData) MarshalJSON 

func (s OptNilSzWhyRecordsResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptNilSzWhyRecordsResponseRawData) Or 

func (o OptNilSzWhyRecordsResponseRawData) Or(d SzWhyRecordsResponseRawData) SzWhyRecordsResponseRawData

Or returns value if set, or given parameter if does not.

func (*OptNilSzWhyRecordsResponseRawData) Reset 

func (o *OptNilSzWhyRecordsResponseRawData) Reset()

Reset unsets value.

func (*OptNilSzWhyRecordsResponseRawData) SetTo 

func (o *OptNilSzWhyRecordsResponseRawData) SetTo(v SzWhyRecordsResponseRawData)

SetTo sets value to v.

func (*OptNilSzWhyRecordsResponseRawData) SetToNull 

func (o *OptNilSzWhyRecordsResponseRawData) SetToNull()

SetNull sets value to null.

func (*OptNilSzWhyRecordsResponseRawData) UnmarshalJSON 

func (s *OptNilSzWhyRecordsResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptString 

type OptString struct {
	Value string
	Set   bool
}

OptString is optional string.

func NewOptString 

func NewOptString(v string) OptString

NewOptString returns new OptString with value set to v.

func (*OptString) Decode 

func (o *OptString) Decode(d *jx.Decoder) error

Decode decodes string from json.

func (OptString) Encode 

func (o OptString) Encode(e *jx.Encoder)

Encode encodes string as json.

func (OptString) Get 

func (o OptString) Get() (v string, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptString) IsSet 

func (o OptString) IsSet() bool

IsSet returns true if OptString was set.

func (OptString) MarshalJSON 

func (s OptString) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptString) Or 

func (o OptString) Or(d string) string

Or returns value if set, or given parameter if does not.

func (*OptString) Reset 

func (o *OptString) Reset()

Reset unsets value.

func (*OptString) SetTo 

func (o *OptString) SetTo(v string)

SetTo sets value to v.

func (*OptString) UnmarshalJSON 

func (s *OptString) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzAttributeClass 

type OptSzAttributeClass struct {
	Value SzAttributeClass
	Set   bool
}

OptSzAttributeClass is optional SzAttributeClass.

func NewOptSzAttributeClass 

func NewOptSzAttributeClass(v SzAttributeClass) OptSzAttributeClass

NewOptSzAttributeClass returns new OptSzAttributeClass with value set to v.

func (*OptSzAttributeClass) Decode 

func (o *OptSzAttributeClass) Decode(d *jx.Decoder) error

Decode decodes SzAttributeClass from json.

func (OptSzAttributeClass) Encode 

func (o OptSzAttributeClass) Encode(e *jx.Encoder)

Encode encodes SzAttributeClass as json.

func (OptSzAttributeClass) Get 

func (o OptSzAttributeClass) Get() (v SzAttributeClass, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzAttributeClass) IsSet 

func (o OptSzAttributeClass) IsSet() bool

IsSet returns true if OptSzAttributeClass was set.

func (OptSzAttributeClass) MarshalJSON 

func (s OptSzAttributeClass) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzAttributeClass) Or 

func (o OptSzAttributeClass) Or(d SzAttributeClass) SzAttributeClass

Or returns value if set, or given parameter if does not.

func (*OptSzAttributeClass) Reset 

func (o *OptSzAttributeClass) Reset()

Reset unsets value.

func (*OptSzAttributeClass) SetTo 

func (o *OptSzAttributeClass) SetTo(v SzAttributeClass)

SetTo sets value to v.

func (*OptSzAttributeClass) UnmarshalJSON 

func (s *OptSzAttributeClass) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzAttributeNecessity 

type OptSzAttributeNecessity struct {
	Value SzAttributeNecessity
	Set   bool
}

OptSzAttributeNecessity is optional SzAttributeNecessity.

func NewOptSzAttributeNecessity 

func NewOptSzAttributeNecessity(v SzAttributeNecessity) OptSzAttributeNecessity

NewOptSzAttributeNecessity returns new OptSzAttributeNecessity with value set to v.

func (*OptSzAttributeNecessity) Decode 

func (o *OptSzAttributeNecessity) Decode(d *jx.Decoder) error

Decode decodes SzAttributeNecessity from json.

func (OptSzAttributeNecessity) Encode 

func (o OptSzAttributeNecessity) Encode(e *jx.Encoder)

Encode encodes SzAttributeNecessity as json.

func (OptSzAttributeNecessity) Get 

func (o OptSzAttributeNecessity) Get() (v SzAttributeNecessity, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzAttributeNecessity) IsSet 

func (o OptSzAttributeNecessity) IsSet() bool

IsSet returns true if OptSzAttributeNecessity was set.

func (OptSzAttributeNecessity) MarshalJSON 

func (s OptSzAttributeNecessity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzAttributeNecessity) Or 

func (o OptSzAttributeNecessity) Or(d SzAttributeNecessity) SzAttributeNecessity

Or returns value if set, or given parameter if does not.

func (*OptSzAttributeNecessity) Reset 

func (o *OptSzAttributeNecessity) Reset()

Reset unsets value.

func (*OptSzAttributeNecessity) SetTo 

func (o *OptSzAttributeNecessity) SetTo(v SzAttributeNecessity)

SetTo sets value to v.

func (*OptSzAttributeNecessity) UnmarshalJSON 

func (s *OptSzAttributeNecessity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzAttributeSearchResponseData 

type OptSzAttributeSearchResponseData struct {
	Value SzAttributeSearchResponseData
	Set   bool
}

OptSzAttributeSearchResponseData is optional SzAttributeSearchResponseData.

func NewOptSzAttributeSearchResponseData 

func NewOptSzAttributeSearchResponseData(v SzAttributeSearchResponseData) OptSzAttributeSearchResponseData

NewOptSzAttributeSearchResponseData returns new OptSzAttributeSearchResponseData with value set to v.

func (*OptSzAttributeSearchResponseData) Decode 

func (o *OptSzAttributeSearchResponseData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResponseData from json.

func (OptSzAttributeSearchResponseData) Encode 

func (o OptSzAttributeSearchResponseData) Encode(e *jx.Encoder)

Encode encodes SzAttributeSearchResponseData as json.

func (OptSzAttributeSearchResponseData) Get 

func (o OptSzAttributeSearchResponseData) Get() (v SzAttributeSearchResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzAttributeSearchResponseData) IsSet 

func (o OptSzAttributeSearchResponseData) IsSet() bool

IsSet returns true if OptSzAttributeSearchResponseData was set.

func (OptSzAttributeSearchResponseData) MarshalJSON 

func (s OptSzAttributeSearchResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzAttributeSearchResponseData) Or 

func (o OptSzAttributeSearchResponseData) Or(d SzAttributeSearchResponseData) SzAttributeSearchResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzAttributeSearchResponseData) Reset 

func (o *OptSzAttributeSearchResponseData) Reset()

Reset unsets value.

func (*OptSzAttributeSearchResponseData) SetTo 

func (o *OptSzAttributeSearchResponseData) SetTo(v SzAttributeSearchResponseData)

SetTo sets value to v.

func (*OptSzAttributeSearchResponseData) UnmarshalJSON 

func (s *OptSzAttributeSearchResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzAttributeSearchResultFeatures 

type OptSzAttributeSearchResultFeatures struct {
	Value SzAttributeSearchResultFeatures
	Set   bool
}

OptSzAttributeSearchResultFeatures is optional SzAttributeSearchResultFeatures.

func NewOptSzAttributeSearchResultFeatures 

func NewOptSzAttributeSearchResultFeatures(v SzAttributeSearchResultFeatures) OptSzAttributeSearchResultFeatures

NewOptSzAttributeSearchResultFeatures returns new OptSzAttributeSearchResultFeatures with value set to v.

func (*OptSzAttributeSearchResultFeatures) Decode 

func (o *OptSzAttributeSearchResultFeatures) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResultFeatures from json.

func (OptSzAttributeSearchResultFeatures) Encode 

func (o OptSzAttributeSearchResultFeatures) Encode(e *jx.Encoder)

Encode encodes SzAttributeSearchResultFeatures as json.

func (OptSzAttributeSearchResultFeatures) Get 

func (o OptSzAttributeSearchResultFeatures) Get() (v SzAttributeSearchResultFeatures, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzAttributeSearchResultFeatures) IsSet 

func (o OptSzAttributeSearchResultFeatures) IsSet() bool

IsSet returns true if OptSzAttributeSearchResultFeatures was set.

func (OptSzAttributeSearchResultFeatures) MarshalJSON 

func (s OptSzAttributeSearchResultFeatures) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzAttributeSearchResultFeatures) Or 

func (o OptSzAttributeSearchResultFeatures) Or(d SzAttributeSearchResultFeatures) SzAttributeSearchResultFeatures

Or returns value if set, or given parameter if does not.

func (*OptSzAttributeSearchResultFeatures) Reset 

func (o *OptSzAttributeSearchResultFeatures) Reset()

Reset unsets value.

func (*OptSzAttributeSearchResultFeatures) SetTo 

func (o *OptSzAttributeSearchResultFeatures) SetTo(v SzAttributeSearchResultFeatures)

SetTo sets value to v.

func (*OptSzAttributeSearchResultFeatures) UnmarshalJSON 

func (s *OptSzAttributeSearchResultFeatures) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzAttributeSearchResultType 

type OptSzAttributeSearchResultType struct {
	Value SzAttributeSearchResultType
	Set   bool
}

OptSzAttributeSearchResultType is optional SzAttributeSearchResultType.

func NewOptSzAttributeSearchResultType 

func NewOptSzAttributeSearchResultType(v SzAttributeSearchResultType) OptSzAttributeSearchResultType

NewOptSzAttributeSearchResultType returns new OptSzAttributeSearchResultType with value set to v.

func (*OptSzAttributeSearchResultType) Decode 

func (o *OptSzAttributeSearchResultType) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResultType from json.

func (OptSzAttributeSearchResultType) Encode 

func (o OptSzAttributeSearchResultType) Encode(e *jx.Encoder)

Encode encodes SzAttributeSearchResultType as json.

func (OptSzAttributeSearchResultType) Get 

func (o OptSzAttributeSearchResultType) Get() (v SzAttributeSearchResultType, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzAttributeSearchResultType) IsSet 

func (o OptSzAttributeSearchResultType) IsSet() bool

IsSet returns true if OptSzAttributeSearchResultType was set.

func (OptSzAttributeSearchResultType) MarshalJSON 

func (s OptSzAttributeSearchResultType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzAttributeSearchResultType) Or 

func (o OptSzAttributeSearchResultType) Or(d SzAttributeSearchResultType) SzAttributeSearchResultType

Or returns value if set, or given parameter if does not.

func (*OptSzAttributeSearchResultType) Reset 

func (o *OptSzAttributeSearchResultType) Reset()

Reset unsets value.

func (*OptSzAttributeSearchResultType) SetTo 

func (o *OptSzAttributeSearchResultType) SetTo(v SzAttributeSearchResultType)

SetTo sets value to v.

func (*OptSzAttributeSearchResultType) UnmarshalJSON 

func (s *OptSzAttributeSearchResultType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzAttributeType 

type OptSzAttributeType struct {
	Value SzAttributeType
	Set   bool
}

OptSzAttributeType is optional SzAttributeType.

func NewOptSzAttributeType 

func NewOptSzAttributeType(v SzAttributeType) OptSzAttributeType

NewOptSzAttributeType returns new OptSzAttributeType with value set to v.

func (*OptSzAttributeType) Decode 

func (o *OptSzAttributeType) Decode(d *jx.Decoder) error

Decode decodes SzAttributeType from json.

func (OptSzAttributeType) Encode 

func (o OptSzAttributeType) Encode(e *jx.Encoder)

Encode encodes SzAttributeType as json.

func (OptSzAttributeType) Get 

func (o OptSzAttributeType) Get() (v SzAttributeType, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzAttributeType) IsSet 

func (o OptSzAttributeType) IsSet() bool

IsSet returns true if OptSzAttributeType was set.

func (OptSzAttributeType) MarshalJSON 

func (s OptSzAttributeType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzAttributeType) Or 

func (o OptSzAttributeType) Or(d SzAttributeType) SzAttributeType

Or returns value if set, or given parameter if does not.

func (*OptSzAttributeType) Reset 

func (o *OptSzAttributeType) Reset()

Reset unsets value.

func (*OptSzAttributeType) SetTo 

func (o *OptSzAttributeType) SetTo(v SzAttributeType)

SetTo sets value to v.

func (*OptSzAttributeType) UnmarshalJSON 

func (s *OptSzAttributeType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzAttributeTypeResponseData 

type OptSzAttributeTypeResponseData struct {
	Value SzAttributeTypeResponseData
	Set   bool
}

OptSzAttributeTypeResponseData is optional SzAttributeTypeResponseData.

func NewOptSzAttributeTypeResponseData 

func NewOptSzAttributeTypeResponseData(v SzAttributeTypeResponseData) OptSzAttributeTypeResponseData

NewOptSzAttributeTypeResponseData returns new OptSzAttributeTypeResponseData with value set to v.

func (*OptSzAttributeTypeResponseData) Decode 

func (o *OptSzAttributeTypeResponseData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypeResponseData from json.

func (OptSzAttributeTypeResponseData) Encode 

func (o OptSzAttributeTypeResponseData) Encode(e *jx.Encoder)

Encode encodes SzAttributeTypeResponseData as json.

func (OptSzAttributeTypeResponseData) Get 

func (o OptSzAttributeTypeResponseData) Get() (v SzAttributeTypeResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzAttributeTypeResponseData) IsSet 

func (o OptSzAttributeTypeResponseData) IsSet() bool

IsSet returns true if OptSzAttributeTypeResponseData was set.

func (OptSzAttributeTypeResponseData) MarshalJSON 

func (s OptSzAttributeTypeResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzAttributeTypeResponseData) Or 

func (o OptSzAttributeTypeResponseData) Or(d SzAttributeTypeResponseData) SzAttributeTypeResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzAttributeTypeResponseData) Reset 

func (o *OptSzAttributeTypeResponseData) Reset()

Reset unsets value.

func (*OptSzAttributeTypeResponseData) SetTo 

func (o *OptSzAttributeTypeResponseData) SetTo(v SzAttributeTypeResponseData)

SetTo sets value to v.

func (*OptSzAttributeTypeResponseData) UnmarshalJSON 

func (s *OptSzAttributeTypeResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzAttributeTypesResponseData 

type OptSzAttributeTypesResponseData struct {
	Value SzAttributeTypesResponseData
	Set   bool
}

OptSzAttributeTypesResponseData is optional SzAttributeTypesResponseData.

func NewOptSzAttributeTypesResponseData 

func NewOptSzAttributeTypesResponseData(v SzAttributeTypesResponseData) OptSzAttributeTypesResponseData

NewOptSzAttributeTypesResponseData returns new OptSzAttributeTypesResponseData with value set to v.

func (*OptSzAttributeTypesResponseData) Decode 

func (o *OptSzAttributeTypesResponseData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypesResponseData from json.

func (OptSzAttributeTypesResponseData) Encode 

func (o OptSzAttributeTypesResponseData) Encode(e *jx.Encoder)

Encode encodes SzAttributeTypesResponseData as json.

func (OptSzAttributeTypesResponseData) Get 

func (o OptSzAttributeTypesResponseData) Get() (v SzAttributeTypesResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzAttributeTypesResponseData) IsSet 

func (o OptSzAttributeTypesResponseData) IsSet() bool

IsSet returns true if OptSzAttributeTypesResponseData was set.

func (OptSzAttributeTypesResponseData) MarshalJSON 

func (s OptSzAttributeTypesResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzAttributeTypesResponseData) Or 

func (o OptSzAttributeTypesResponseData) Or(d SzAttributeTypesResponseData) SzAttributeTypesResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzAttributeTypesResponseData) Reset 

func (o *OptSzAttributeTypesResponseData) Reset()

Reset unsets value.

func (*OptSzAttributeTypesResponseData) SetTo 

func (o *OptSzAttributeTypesResponseData) SetTo(v SzAttributeTypesResponseData)

SetTo sets value to v.

func (*OptSzAttributeTypesResponseData) UnmarshalJSON 

func (s *OptSzAttributeTypesResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzBulkDataAnalysis 

type OptSzBulkDataAnalysis struct {
	Value SzBulkDataAnalysis
	Set   bool
}

OptSzBulkDataAnalysis is optional SzBulkDataAnalysis.

func NewOptSzBulkDataAnalysis 

func NewOptSzBulkDataAnalysis(v SzBulkDataAnalysis) OptSzBulkDataAnalysis

NewOptSzBulkDataAnalysis returns new OptSzBulkDataAnalysis with value set to v.

func (*OptSzBulkDataAnalysis) Decode 

func (o *OptSzBulkDataAnalysis) Decode(d *jx.Decoder) error

Decode decodes SzBulkDataAnalysis from json.

func (OptSzBulkDataAnalysis) Encode 

func (o OptSzBulkDataAnalysis) Encode(e *jx.Encoder)

Encode encodes SzBulkDataAnalysis as json.

func (OptSzBulkDataAnalysis) Get 

func (o OptSzBulkDataAnalysis) Get() (v SzBulkDataAnalysis, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzBulkDataAnalysis) IsSet 

func (o OptSzBulkDataAnalysis) IsSet() bool

IsSet returns true if OptSzBulkDataAnalysis was set.

func (OptSzBulkDataAnalysis) MarshalJSON 

func (s OptSzBulkDataAnalysis) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzBulkDataAnalysis) Or 

func (o OptSzBulkDataAnalysis) Or(d SzBulkDataAnalysis) SzBulkDataAnalysis

Or returns value if set, or given parameter if does not.

func (*OptSzBulkDataAnalysis) Reset 

func (o *OptSzBulkDataAnalysis) Reset()

Reset unsets value.

func (*OptSzBulkDataAnalysis) SetTo 

func (o *OptSzBulkDataAnalysis) SetTo(v SzBulkDataAnalysis)

SetTo sets value to v.

func (*OptSzBulkDataAnalysis) UnmarshalJSON 

func (s *OptSzBulkDataAnalysis) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzBulkDataStatus 

type OptSzBulkDataStatus struct {
	Value SzBulkDataStatus
	Set   bool
}

OptSzBulkDataStatus is optional SzBulkDataStatus.

func NewOptSzBulkDataStatus 

func NewOptSzBulkDataStatus(v SzBulkDataStatus) OptSzBulkDataStatus

NewOptSzBulkDataStatus returns new OptSzBulkDataStatus with value set to v.

func (*OptSzBulkDataStatus) Decode 

func (o *OptSzBulkDataStatus) Decode(d *jx.Decoder) error

Decode decodes SzBulkDataStatus from json.

func (OptSzBulkDataStatus) Encode 

func (o OptSzBulkDataStatus) Encode(e *jx.Encoder)

Encode encodes SzBulkDataStatus as json.

func (OptSzBulkDataStatus) Get 

func (o OptSzBulkDataStatus) Get() (v SzBulkDataStatus, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzBulkDataStatus) IsSet 

func (o OptSzBulkDataStatus) IsSet() bool

IsSet returns true if OptSzBulkDataStatus was set.

func (OptSzBulkDataStatus) MarshalJSON 

func (s OptSzBulkDataStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzBulkDataStatus) Or 

func (o OptSzBulkDataStatus) Or(d SzBulkDataStatus) SzBulkDataStatus

Or returns value if set, or given parameter if does not.

func (*OptSzBulkDataStatus) Reset 

func (o *OptSzBulkDataStatus) Reset()

Reset unsets value.

func (*OptSzBulkDataStatus) SetTo 

func (o *OptSzBulkDataStatus) SetTo(v SzBulkDataStatus)

SetTo sets value to v.

func (*OptSzBulkDataStatus) UnmarshalJSON 

func (s *OptSzBulkDataStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzBulkLoadResult 

type OptSzBulkLoadResult struct {
	Value SzBulkLoadResult
	Set   bool
}

OptSzBulkLoadResult is optional SzBulkLoadResult.

func NewOptSzBulkLoadResult 

func NewOptSzBulkLoadResult(v SzBulkLoadResult) OptSzBulkLoadResult

NewOptSzBulkLoadResult returns new OptSzBulkLoadResult with value set to v.

func (*OptSzBulkLoadResult) Decode 

func (o *OptSzBulkLoadResult) Decode(d *jx.Decoder) error

Decode decodes SzBulkLoadResult from json.

func (OptSzBulkLoadResult) Encode 

func (o OptSzBulkLoadResult) Encode(e *jx.Encoder)

Encode encodes SzBulkLoadResult as json.

func (OptSzBulkLoadResult) Get 

func (o OptSzBulkLoadResult) Get() (v SzBulkLoadResult, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzBulkLoadResult) IsSet 

func (o OptSzBulkLoadResult) IsSet() bool

IsSet returns true if OptSzBulkLoadResult was set.

func (OptSzBulkLoadResult) MarshalJSON 

func (s OptSzBulkLoadResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzBulkLoadResult) Or 

func (o OptSzBulkLoadResult) Or(d SzBulkLoadResult) SzBulkLoadResult

Or returns value if set, or given parameter if does not.

func (*OptSzBulkLoadResult) Reset 

func (o *OptSzBulkLoadResult) Reset()

Reset unsets value.

func (*OptSzBulkLoadResult) SetTo 

func (o *OptSzBulkLoadResult) SetTo(v SzBulkLoadResult)

SetTo sets value to v.

func (*OptSzBulkLoadResult) UnmarshalJSON 

func (s *OptSzBulkLoadResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzDataSource 

type OptSzDataSource struct {
	Value SzDataSource
	Set   bool
}

OptSzDataSource is optional SzDataSource.

func NewOptSzDataSource 

func NewOptSzDataSource(v SzDataSource) OptSzDataSource

NewOptSzDataSource returns new OptSzDataSource with value set to v.

func (*OptSzDataSource) Decode 

func (o *OptSzDataSource) Decode(d *jx.Decoder) error

Decode decodes SzDataSource from json.

func (OptSzDataSource) Encode 

func (o OptSzDataSource) Encode(e *jx.Encoder)

Encode encodes SzDataSource as json.

func (OptSzDataSource) Get 

func (o OptSzDataSource) Get() (v SzDataSource, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzDataSource) IsSet 

func (o OptSzDataSource) IsSet() bool

IsSet returns true if OptSzDataSource was set.

func (OptSzDataSource) MarshalJSON 

func (s OptSzDataSource) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzDataSource) Or 

func (o OptSzDataSource) Or(d SzDataSource) SzDataSource

Or returns value if set, or given parameter if does not.

func (*OptSzDataSource) Reset 

func (o *OptSzDataSource) Reset()

Reset unsets value.

func (*OptSzDataSource) SetTo 

func (o *OptSzDataSource) SetTo(v SzDataSource)

SetTo sets value to v.

func (*OptSzDataSource) UnmarshalJSON 

func (s *OptSzDataSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzDataSourceResponseData 

type OptSzDataSourceResponseData struct {
	Value SzDataSourceResponseData
	Set   bool
}

OptSzDataSourceResponseData is optional SzDataSourceResponseData.

func NewOptSzDataSourceResponseData 

func NewOptSzDataSourceResponseData(v SzDataSourceResponseData) OptSzDataSourceResponseData

NewOptSzDataSourceResponseData returns new OptSzDataSourceResponseData with value set to v.

func (*OptSzDataSourceResponseData) Decode 

func (o *OptSzDataSourceResponseData) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceResponseData from json.

func (OptSzDataSourceResponseData) Encode 

func (o OptSzDataSourceResponseData) Encode(e *jx.Encoder)

Encode encodes SzDataSourceResponseData as json.

func (OptSzDataSourceResponseData) Get 

func (o OptSzDataSourceResponseData) Get() (v SzDataSourceResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzDataSourceResponseData) IsSet 

func (o OptSzDataSourceResponseData) IsSet() bool

IsSet returns true if OptSzDataSourceResponseData was set.

func (OptSzDataSourceResponseData) MarshalJSON 

func (s OptSzDataSourceResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzDataSourceResponseData) Or 

func (o OptSzDataSourceResponseData) Or(d SzDataSourceResponseData) SzDataSourceResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzDataSourceResponseData) Reset 

func (o *OptSzDataSourceResponseData) Reset()

Reset unsets value.

func (*OptSzDataSourceResponseData) SetTo 

func (o *OptSzDataSourceResponseData) SetTo(v SzDataSourceResponseData)

SetTo sets value to v.

func (*OptSzDataSourceResponseData) UnmarshalJSON 

func (s *OptSzDataSourceResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzDataSourcesResponseData 

type OptSzDataSourcesResponseData struct {
	Value SzDataSourcesResponseData
	Set   bool
}

OptSzDataSourcesResponseData is optional SzDataSourcesResponseData.

func NewOptSzDataSourcesResponseData 

func NewOptSzDataSourcesResponseData(v SzDataSourcesResponseData) OptSzDataSourcesResponseData

NewOptSzDataSourcesResponseData returns new OptSzDataSourcesResponseData with value set to v.

func (*OptSzDataSourcesResponseData) Decode 

func (o *OptSzDataSourcesResponseData) Decode(d *jx.Decoder) error

Decode decodes SzDataSourcesResponseData from json.

func (OptSzDataSourcesResponseData) Encode 

func (o OptSzDataSourcesResponseData) Encode(e *jx.Encoder)

Encode encodes SzDataSourcesResponseData as json.

func (OptSzDataSourcesResponseData) Get 

func (o OptSzDataSourcesResponseData) Get() (v SzDataSourcesResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzDataSourcesResponseData) IsSet 

func (o OptSzDataSourcesResponseData) IsSet() bool

IsSet returns true if OptSzDataSourcesResponseData was set.

func (OptSzDataSourcesResponseData) MarshalJSON 

func (s OptSzDataSourcesResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzDataSourcesResponseData) Or 

func (o OptSzDataSourcesResponseData) Or(d SzDataSourcesResponseData) SzDataSourcesResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzDataSourcesResponseData) Reset 

func (o *OptSzDataSourcesResponseData) Reset()

Reset unsets value.

func (*OptSzDataSourcesResponseData) SetTo 

func (o *OptSzDataSourcesResponseData) SetTo(v SzDataSourcesResponseData)

SetTo sets value to v.

func (*OptSzDataSourcesResponseData) UnmarshalJSON 

func (s *OptSzDataSourcesResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzDataSourcesResponseDataDataSourceDetails 

type OptSzDataSourcesResponseDataDataSourceDetails struct {
	Value SzDataSourcesResponseDataDataSourceDetails
	Set   bool
}

OptSzDataSourcesResponseDataDataSourceDetails is optional SzDataSourcesResponseDataDataSourceDetails.

func NewOptSzDataSourcesResponseDataDataSourceDetails 

func NewOptSzDataSourcesResponseDataDataSourceDetails(v SzDataSourcesResponseDataDataSourceDetails) OptSzDataSourcesResponseDataDataSourceDetails

NewOptSzDataSourcesResponseDataDataSourceDetails returns new OptSzDataSourcesResponseDataDataSourceDetails with value set to v.

func (*OptSzDataSourcesResponseDataDataSourceDetails) Decode 

func (o *OptSzDataSourcesResponseDataDataSourceDetails) Decode(d *jx.Decoder) error

Decode decodes SzDataSourcesResponseDataDataSourceDetails from json.

func (OptSzDataSourcesResponseDataDataSourceDetails) Encode 

func (o OptSzDataSourcesResponseDataDataSourceDetails) Encode(e *jx.Encoder)

Encode encodes SzDataSourcesResponseDataDataSourceDetails as json.

func (OptSzDataSourcesResponseDataDataSourceDetails) Get 

func (o OptSzDataSourcesResponseDataDataSourceDetails) Get() (v SzDataSourcesResponseDataDataSourceDetails, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzDataSourcesResponseDataDataSourceDetails) IsSet 

func (o OptSzDataSourcesResponseDataDataSourceDetails) IsSet() bool

IsSet returns true if OptSzDataSourcesResponseDataDataSourceDetails was set.

func (OptSzDataSourcesResponseDataDataSourceDetails) MarshalJSON 

func (s OptSzDataSourcesResponseDataDataSourceDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzDataSourcesResponseDataDataSourceDetails) Or 

func (o OptSzDataSourcesResponseDataDataSourceDetails) Or(d SzDataSourcesResponseDataDataSourceDetails) SzDataSourcesResponseDataDataSourceDetails

Or returns value if set, or given parameter if does not.

func (*OptSzDataSourcesResponseDataDataSourceDetails) Reset 

func (o *OptSzDataSourcesResponseDataDataSourceDetails) Reset()

Reset unsets value.

func (*OptSzDataSourcesResponseDataDataSourceDetails) SetTo 

func (o *OptSzDataSourcesResponseDataDataSourceDetails) SetTo(v SzDataSourcesResponseDataDataSourceDetails)

SetTo sets value to v.

func (*OptSzDataSourcesResponseDataDataSourceDetails) UnmarshalJSON 

func (s *OptSzDataSourcesResponseDataDataSourceDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzDeleteRecordResponseData 

type OptSzDeleteRecordResponseData struct {
	Value SzDeleteRecordResponseData
	Set   bool
}

OptSzDeleteRecordResponseData is optional SzDeleteRecordResponseData.

func NewOptSzDeleteRecordResponseData 

func NewOptSzDeleteRecordResponseData(v SzDeleteRecordResponseData) OptSzDeleteRecordResponseData

NewOptSzDeleteRecordResponseData returns new OptSzDeleteRecordResponseData with value set to v.

func (*OptSzDeleteRecordResponseData) Decode 

func (o *OptSzDeleteRecordResponseData) Decode(d *jx.Decoder) error

Decode decodes SzDeleteRecordResponseData from json.

func (OptSzDeleteRecordResponseData) Encode 

func (o OptSzDeleteRecordResponseData) Encode(e *jx.Encoder)

Encode encodes SzDeleteRecordResponseData as json.

func (OptSzDeleteRecordResponseData) Get 

func (o OptSzDeleteRecordResponseData) Get() (v SzDeleteRecordResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzDeleteRecordResponseData) IsSet 

func (o OptSzDeleteRecordResponseData) IsSet() bool

IsSet returns true if OptSzDeleteRecordResponseData was set.

func (OptSzDeleteRecordResponseData) MarshalJSON 

func (s OptSzDeleteRecordResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzDeleteRecordResponseData) Or 

func (o OptSzDeleteRecordResponseData) Or(d SzDeleteRecordResponseData) SzDeleteRecordResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzDeleteRecordResponseData) Reset 

func (o *OptSzDeleteRecordResponseData) Reset()

Reset unsets value.

func (*OptSzDeleteRecordResponseData) SetTo 

func (o *OptSzDeleteRecordResponseData) SetTo(v SzDeleteRecordResponseData)

SetTo sets value to v.

func (*OptSzDeleteRecordResponseData) UnmarshalJSON 

func (s *OptSzDeleteRecordResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzDetailLevel 

type OptSzDetailLevel struct {
	Value SzDetailLevel
	Set   bool
}

OptSzDetailLevel is optional SzDetailLevel.

func NewOptSzDetailLevel 

func NewOptSzDetailLevel(v SzDetailLevel) OptSzDetailLevel

NewOptSzDetailLevel returns new OptSzDetailLevel with value set to v.

func (OptSzDetailLevel) Get 

func (o OptSzDetailLevel) Get() (v SzDetailLevel, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzDetailLevel) IsSet 

func (o OptSzDetailLevel) IsSet() bool

IsSet returns true if OptSzDetailLevel was set.

func (OptSzDetailLevel) Or 

func (o OptSzDetailLevel) Or(d SzDetailLevel) SzDetailLevel

Or returns value if set, or given parameter if does not.

func (*OptSzDetailLevel) Reset 

func (o *OptSzDetailLevel) Reset()

Reset unsets value.

func (*OptSzDetailLevel) SetTo 

func (o *OptSzDetailLevel) SetTo(v SzDetailLevel)

SetTo sets value to v.

type OptSzEntityData 

type OptSzEntityData struct {
	Value SzEntityData
	Set   bool
}

OptSzEntityData is optional SzEntityData.

func NewOptSzEntityData 

func NewOptSzEntityData(v SzEntityData) OptSzEntityData

NewOptSzEntityData returns new OptSzEntityData with value set to v.

func (*OptSzEntityData) Decode 

func (o *OptSzEntityData) Decode(d *jx.Decoder) error

Decode decodes SzEntityData from json.

func (OptSzEntityData) Encode 

func (o OptSzEntityData) Encode(e *jx.Encoder)

Encode encodes SzEntityData as json.

func (OptSzEntityData) Get 

func (o OptSzEntityData) Get() (v SzEntityData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzEntityData) IsSet 

func (o OptSzEntityData) IsSet() bool

IsSet returns true if OptSzEntityData was set.

func (OptSzEntityData) MarshalJSON 

func (s OptSzEntityData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzEntityData) Or 

func (o OptSzEntityData) Or(d SzEntityData) SzEntityData

Or returns value if set, or given parameter if does not.

func (*OptSzEntityData) Reset 

func (o *OptSzEntityData) Reset()

Reset unsets value.

func (*OptSzEntityData) SetTo 

func (o *OptSzEntityData) SetTo(v SzEntityData)

SetTo sets value to v.

func (*OptSzEntityData) UnmarshalJSON 

func (s *OptSzEntityData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzEntityFeatureStatistics 

type OptSzEntityFeatureStatistics struct {
	Value SzEntityFeatureStatistics
	Set   bool
}

OptSzEntityFeatureStatistics is optional SzEntityFeatureStatistics.

func NewOptSzEntityFeatureStatistics 

func NewOptSzEntityFeatureStatistics(v SzEntityFeatureStatistics) OptSzEntityFeatureStatistics

NewOptSzEntityFeatureStatistics returns new OptSzEntityFeatureStatistics with value set to v.

func (*OptSzEntityFeatureStatistics) Decode 

func (o *OptSzEntityFeatureStatistics) Decode(d *jx.Decoder) error

Decode decodes SzEntityFeatureStatistics from json.

func (OptSzEntityFeatureStatistics) Encode 

func (o OptSzEntityFeatureStatistics) Encode(e *jx.Encoder)

Encode encodes SzEntityFeatureStatistics as json.

func (OptSzEntityFeatureStatistics) Get 

func (o OptSzEntityFeatureStatistics) Get() (v SzEntityFeatureStatistics, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzEntityFeatureStatistics) IsSet 

func (o OptSzEntityFeatureStatistics) IsSet() bool

IsSet returns true if OptSzEntityFeatureStatistics was set.

func (OptSzEntityFeatureStatistics) MarshalJSON 

func (s OptSzEntityFeatureStatistics) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzEntityFeatureStatistics) Or 

func (o OptSzEntityFeatureStatistics) Or(d SzEntityFeatureStatistics) SzEntityFeatureStatistics

Or returns value if set, or given parameter if does not.

func (*OptSzEntityFeatureStatistics) Reset 

func (o *OptSzEntityFeatureStatistics) Reset()

Reset unsets value.

func (*OptSzEntityFeatureStatistics) SetTo 

func (o *OptSzEntityFeatureStatistics) SetTo(v SzEntityFeatureStatistics)

SetTo sets value to v.

func (*OptSzEntityFeatureStatistics) UnmarshalJSON 

func (s *OptSzEntityFeatureStatistics) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzEntityNetworkData 

type OptSzEntityNetworkData struct {
	Value SzEntityNetworkData
	Set   bool
}

OptSzEntityNetworkData is optional SzEntityNetworkData.

func NewOptSzEntityNetworkData 

func NewOptSzEntityNetworkData(v SzEntityNetworkData) OptSzEntityNetworkData

NewOptSzEntityNetworkData returns new OptSzEntityNetworkData with value set to v.

func (*OptSzEntityNetworkData) Decode 

func (o *OptSzEntityNetworkData) Decode(d *jx.Decoder) error

Decode decodes SzEntityNetworkData from json.

func (OptSzEntityNetworkData) Encode 

func (o OptSzEntityNetworkData) Encode(e *jx.Encoder)

Encode encodes SzEntityNetworkData as json.

func (OptSzEntityNetworkData) Get 

func (o OptSzEntityNetworkData) Get() (v SzEntityNetworkData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzEntityNetworkData) IsSet 

func (o OptSzEntityNetworkData) IsSet() bool

IsSet returns true if OptSzEntityNetworkData was set.

func (OptSzEntityNetworkData) MarshalJSON 

func (s OptSzEntityNetworkData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzEntityNetworkData) Or 

func (o OptSzEntityNetworkData) Or(d SzEntityNetworkData) SzEntityNetworkData

Or returns value if set, or given parameter if does not.

func (*OptSzEntityNetworkData) Reset 

func (o *OptSzEntityNetworkData) Reset()

Reset unsets value.

func (*OptSzEntityNetworkData) SetTo 

func (o *OptSzEntityNetworkData) SetTo(v SzEntityNetworkData)

SetTo sets value to v.

func (*OptSzEntityNetworkData) UnmarshalJSON 

func (s *OptSzEntityNetworkData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzEntityPath 

type OptSzEntityPath struct {
	Value SzEntityPath
	Set   bool
}

OptSzEntityPath is optional SzEntityPath.

func NewOptSzEntityPath 

func NewOptSzEntityPath(v SzEntityPath) OptSzEntityPath

NewOptSzEntityPath returns new OptSzEntityPath with value set to v.

func (*OptSzEntityPath) Decode 

func (o *OptSzEntityPath) Decode(d *jx.Decoder) error

Decode decodes SzEntityPath from json.

func (OptSzEntityPath) Encode 

func (o OptSzEntityPath) Encode(e *jx.Encoder)

Encode encodes SzEntityPath as json.

func (OptSzEntityPath) Get 

func (o OptSzEntityPath) Get() (v SzEntityPath, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzEntityPath) IsSet 

func (o OptSzEntityPath) IsSet() bool

IsSet returns true if OptSzEntityPath was set.

func (OptSzEntityPath) MarshalJSON 

func (s OptSzEntityPath) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzEntityPath) Or 

func (o OptSzEntityPath) Or(d SzEntityPath) SzEntityPath

Or returns value if set, or given parameter if does not.

func (*OptSzEntityPath) Reset 

func (o *OptSzEntityPath) Reset()

Reset unsets value.

func (*OptSzEntityPath) SetTo 

func (o *OptSzEntityPath) SetTo(v SzEntityPath)

SetTo sets value to v.

func (*OptSzEntityPath) UnmarshalJSON 

func (s *OptSzEntityPath) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzEntityPathData 

type OptSzEntityPathData struct {
	Value SzEntityPathData
	Set   bool
}

OptSzEntityPathData is optional SzEntityPathData.

func NewOptSzEntityPathData 

func NewOptSzEntityPathData(v SzEntityPathData) OptSzEntityPathData

NewOptSzEntityPathData returns new OptSzEntityPathData with value set to v.

func (*OptSzEntityPathData) Decode 

func (o *OptSzEntityPathData) Decode(d *jx.Decoder) error

Decode decodes SzEntityPathData from json.

func (OptSzEntityPathData) Encode 

func (o OptSzEntityPathData) Encode(e *jx.Encoder)

Encode encodes SzEntityPathData as json.

func (OptSzEntityPathData) Get 

func (o OptSzEntityPathData) Get() (v SzEntityPathData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzEntityPathData) IsSet 

func (o OptSzEntityPathData) IsSet() bool

IsSet returns true if OptSzEntityPathData was set.

func (OptSzEntityPathData) MarshalJSON 

func (s OptSzEntityPathData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzEntityPathData) Or 

func (o OptSzEntityPathData) Or(d SzEntityPathData) SzEntityPathData

Or returns value if set, or given parameter if does not.

func (*OptSzEntityPathData) Reset 

func (o *OptSzEntityPathData) Reset()

Reset unsets value.

func (*OptSzEntityPathData) SetTo 

func (o *OptSzEntityPathData) SetTo(v SzEntityPathData)

SetTo sets value to v.

func (*OptSzEntityPathData) UnmarshalJSON 

func (s *OptSzEntityPathData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzEntityRecord 

type OptSzEntityRecord struct {
	Value SzEntityRecord
	Set   bool
}

OptSzEntityRecord is optional SzEntityRecord.

func NewOptSzEntityRecord 

func NewOptSzEntityRecord(v SzEntityRecord) OptSzEntityRecord

NewOptSzEntityRecord returns new OptSzEntityRecord with value set to v.

func (*OptSzEntityRecord) Decode 

func (o *OptSzEntityRecord) Decode(d *jx.Decoder) error

Decode decodes SzEntityRecord from json.

func (OptSzEntityRecord) Encode 

func (o OptSzEntityRecord) Encode(e *jx.Encoder)

Encode encodes SzEntityRecord as json.

func (OptSzEntityRecord) Get 

func (o OptSzEntityRecord) Get() (v SzEntityRecord, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzEntityRecord) IsSet 

func (o OptSzEntityRecord) IsSet() bool

IsSet returns true if OptSzEntityRecord was set.

func (OptSzEntityRecord) MarshalJSON 

func (s OptSzEntityRecord) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzEntityRecord) Or 

func (o OptSzEntityRecord) Or(d SzEntityRecord) SzEntityRecord

Or returns value if set, or given parameter if does not.

func (*OptSzEntityRecord) Reset 

func (o *OptSzEntityRecord) Reset()

Reset unsets value.

func (*OptSzEntityRecord) SetTo 

func (o *OptSzEntityRecord) SetTo(v SzEntityRecord)

SetTo sets value to v.

func (*OptSzEntityRecord) UnmarshalJSON 

func (s *OptSzEntityRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzEntityRecordOriginalSourceData 

type OptSzEntityRecordOriginalSourceData struct {
	Value SzEntityRecordOriginalSourceData
	Set   bool
}

OptSzEntityRecordOriginalSourceData is optional SzEntityRecordOriginalSourceData.

func NewOptSzEntityRecordOriginalSourceData 

func NewOptSzEntityRecordOriginalSourceData(v SzEntityRecordOriginalSourceData) OptSzEntityRecordOriginalSourceData

NewOptSzEntityRecordOriginalSourceData returns new OptSzEntityRecordOriginalSourceData with value set to v.

func (*OptSzEntityRecordOriginalSourceData) Decode 

func (o *OptSzEntityRecordOriginalSourceData) Decode(d *jx.Decoder) error

Decode decodes SzEntityRecordOriginalSourceData from json.

func (OptSzEntityRecordOriginalSourceData) Encode 

func (o OptSzEntityRecordOriginalSourceData) Encode(e *jx.Encoder)

Encode encodes SzEntityRecordOriginalSourceData as json.

func (OptSzEntityRecordOriginalSourceData) Get 

func (o OptSzEntityRecordOriginalSourceData) Get() (v SzEntityRecordOriginalSourceData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzEntityRecordOriginalSourceData) IsSet 

func (o OptSzEntityRecordOriginalSourceData) IsSet() bool

IsSet returns true if OptSzEntityRecordOriginalSourceData was set.

func (OptSzEntityRecordOriginalSourceData) MarshalJSON 

func (s OptSzEntityRecordOriginalSourceData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzEntityRecordOriginalSourceData) Or 

func (o OptSzEntityRecordOriginalSourceData) Or(d SzEntityRecordOriginalSourceData) SzEntityRecordOriginalSourceData

Or returns value if set, or given parameter if does not.

func (*OptSzEntityRecordOriginalSourceData) Reset 

func (o *OptSzEntityRecordOriginalSourceData) Reset()

Reset unsets value.

func (*OptSzEntityRecordOriginalSourceData) SetTo 

func (o *OptSzEntityRecordOriginalSourceData) SetTo(v SzEntityRecordOriginalSourceData)

SetTo sets value to v.

func (*OptSzEntityRecordOriginalSourceData) UnmarshalJSON 

func (s *OptSzEntityRecordOriginalSourceData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzError 

type OptSzError struct {
	Value SzError
	Set   bool
}

OptSzError is optional SzError.

func NewOptSzError 

func NewOptSzError(v SzError) OptSzError

NewOptSzError returns new OptSzError with value set to v.

func (*OptSzError) Decode 

func (o *OptSzError) Decode(d *jx.Decoder) error

Decode decodes SzError from json.

func (OptSzError) Encode 

func (o OptSzError) Encode(e *jx.Encoder)

Encode encodes SzError as json.

func (OptSzError) Get 

func (o OptSzError) Get() (v SzError, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzError) IsSet 

func (o OptSzError) IsSet() bool

IsSet returns true if OptSzError was set.

func (OptSzError) MarshalJSON 

func (s OptSzError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzError) Or 

func (o OptSzError) Or(d SzError) SzError

Or returns value if set, or given parameter if does not.

func (*OptSzError) Reset 

func (o *OptSzError) Reset()

Reset unsets value.

func (*OptSzError) SetTo 

func (o *OptSzError) SetTo(v SzError)

SetTo sets value to v.

func (*OptSzError) UnmarshalJSON 

func (s *OptSzError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzFeatureMode 

type OptSzFeatureMode struct {
	Value SzFeatureMode
	Set   bool
}

OptSzFeatureMode is optional SzFeatureMode.

func NewOptSzFeatureMode 

func NewOptSzFeatureMode(v SzFeatureMode) OptSzFeatureMode

NewOptSzFeatureMode returns new OptSzFeatureMode with value set to v.

func (OptSzFeatureMode) Get 

func (o OptSzFeatureMode) Get() (v SzFeatureMode, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzFeatureMode) IsSet 

func (o OptSzFeatureMode) IsSet() bool

IsSet returns true if OptSzFeatureMode was set.

func (OptSzFeatureMode) Or 

func (o OptSzFeatureMode) Or(d SzFeatureMode) SzFeatureMode

Or returns value if set, or given parameter if does not.

func (*OptSzFeatureMode) Reset 

func (o *OptSzFeatureMode) Reset()

Reset unsets value.

func (*OptSzFeatureMode) SetTo 

func (o *OptSzFeatureMode) SetTo(v SzFeatureMode)

SetTo sets value to v.

type OptSzHowEntityResult 

type OptSzHowEntityResult struct {
	Value SzHowEntityResult
	Set   bool
}

OptSzHowEntityResult is optional SzHowEntityResult.

func NewOptSzHowEntityResult 

func NewOptSzHowEntityResult(v SzHowEntityResult) OptSzHowEntityResult

NewOptSzHowEntityResult returns new OptSzHowEntityResult with value set to v.

func (*OptSzHowEntityResult) Decode 

func (o *OptSzHowEntityResult) Decode(d *jx.Decoder) error

Decode decodes SzHowEntityResult from json.

func (OptSzHowEntityResult) Encode 

func (o OptSzHowEntityResult) Encode(e *jx.Encoder)

Encode encodes SzHowEntityResult as json.

func (OptSzHowEntityResult) Get 

func (o OptSzHowEntityResult) Get() (v SzHowEntityResult, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzHowEntityResult) IsSet 

func (o OptSzHowEntityResult) IsSet() bool

IsSet returns true if OptSzHowEntityResult was set.

func (OptSzHowEntityResult) MarshalJSON 

func (s OptSzHowEntityResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzHowEntityResult) Or 

func (o OptSzHowEntityResult) Or(d SzHowEntityResult) SzHowEntityResult

Or returns value if set, or given parameter if does not.

func (*OptSzHowEntityResult) Reset 

func (o *OptSzHowEntityResult) Reset()

Reset unsets value.

func (*OptSzHowEntityResult) SetTo 

func (o *OptSzHowEntityResult) SetTo(v SzHowEntityResult)

SetTo sets value to v.

func (*OptSzHowEntityResult) UnmarshalJSON 

func (s *OptSzHowEntityResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzHowEntityResultResolutionSteps 

type OptSzHowEntityResultResolutionSteps struct {
	Value SzHowEntityResultResolutionSteps
	Set   bool
}

OptSzHowEntityResultResolutionSteps is optional SzHowEntityResultResolutionSteps.

func NewOptSzHowEntityResultResolutionSteps 

func NewOptSzHowEntityResultResolutionSteps(v SzHowEntityResultResolutionSteps) OptSzHowEntityResultResolutionSteps

NewOptSzHowEntityResultResolutionSteps returns new OptSzHowEntityResultResolutionSteps with value set to v.

func (*OptSzHowEntityResultResolutionSteps) Decode 

func (o *OptSzHowEntityResultResolutionSteps) Decode(d *jx.Decoder) error

Decode decodes SzHowEntityResultResolutionSteps from json.

func (OptSzHowEntityResultResolutionSteps) Encode 

func (o OptSzHowEntityResultResolutionSteps) Encode(e *jx.Encoder)

Encode encodes SzHowEntityResultResolutionSteps as json.

func (OptSzHowEntityResultResolutionSteps) Get 

func (o OptSzHowEntityResultResolutionSteps) Get() (v SzHowEntityResultResolutionSteps, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzHowEntityResultResolutionSteps) IsSet 

func (o OptSzHowEntityResultResolutionSteps) IsSet() bool

IsSet returns true if OptSzHowEntityResultResolutionSteps was set.

func (OptSzHowEntityResultResolutionSteps) MarshalJSON 

func (s OptSzHowEntityResultResolutionSteps) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzHowEntityResultResolutionSteps) Or 

func (o OptSzHowEntityResultResolutionSteps) Or(d SzHowEntityResultResolutionSteps) SzHowEntityResultResolutionSteps

Or returns value if set, or given parameter if does not.

func (*OptSzHowEntityResultResolutionSteps) Reset 

func (o *OptSzHowEntityResultResolutionSteps) Reset()

Reset unsets value.

func (*OptSzHowEntityResultResolutionSteps) SetTo 

func (o *OptSzHowEntityResultResolutionSteps) SetTo(v SzHowEntityResultResolutionSteps)

SetTo sets value to v.

func (*OptSzHowEntityResultResolutionSteps) UnmarshalJSON 

func (s *OptSzHowEntityResultResolutionSteps) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzHowMatchInfo 

type OptSzHowMatchInfo struct {
	Value SzHowMatchInfo
	Set   bool
}

OptSzHowMatchInfo is optional SzHowMatchInfo.

func NewOptSzHowMatchInfo 

func NewOptSzHowMatchInfo(v SzHowMatchInfo) OptSzHowMatchInfo

NewOptSzHowMatchInfo returns new OptSzHowMatchInfo with value set to v.

func (*OptSzHowMatchInfo) Decode 

func (o *OptSzHowMatchInfo) Decode(d *jx.Decoder) error

Decode decodes SzHowMatchInfo from json.

func (OptSzHowMatchInfo) Encode 

func (o OptSzHowMatchInfo) Encode(e *jx.Encoder)

Encode encodes SzHowMatchInfo as json.

func (OptSzHowMatchInfo) Get 

func (o OptSzHowMatchInfo) Get() (v SzHowMatchInfo, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzHowMatchInfo) IsSet 

func (o OptSzHowMatchInfo) IsSet() bool

IsSet returns true if OptSzHowMatchInfo was set.

func (OptSzHowMatchInfo) MarshalJSON 

func (s OptSzHowMatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzHowMatchInfo) Or 

func (o OptSzHowMatchInfo) Or(d SzHowMatchInfo) SzHowMatchInfo

Or returns value if set, or given parameter if does not.

func (*OptSzHowMatchInfo) Reset 

func (o *OptSzHowMatchInfo) Reset()

Reset unsets value.

func (*OptSzHowMatchInfo) SetTo 

func (o *OptSzHowMatchInfo) SetTo(v SzHowMatchInfo)

SetTo sets value to v.

func (*OptSzHowMatchInfo) UnmarshalJSON 

func (s *OptSzHowMatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzHttpMethod 

type OptSzHttpMethod struct {
	Value SzHttpMethod
	Set   bool
}

OptSzHttpMethod is optional SzHttpMethod.

func NewOptSzHttpMethod 

func NewOptSzHttpMethod(v SzHttpMethod) OptSzHttpMethod

NewOptSzHttpMethod returns new OptSzHttpMethod with value set to v.

func (*OptSzHttpMethod) Decode 

func (o *OptSzHttpMethod) Decode(d *jx.Decoder) error

Decode decodes SzHttpMethod from json.

func (OptSzHttpMethod) Encode 

func (o OptSzHttpMethod) Encode(e *jx.Encoder)

Encode encodes SzHttpMethod as json.

func (OptSzHttpMethod) Get 

func (o OptSzHttpMethod) Get() (v SzHttpMethod, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzHttpMethod) IsSet 

func (o OptSzHttpMethod) IsSet() bool

IsSet returns true if OptSzHttpMethod was set.

func (OptSzHttpMethod) MarshalJSON 

func (s OptSzHttpMethod) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzHttpMethod) Or 

func (o OptSzHttpMethod) Or(d SzHttpMethod) SzHttpMethod

Or returns value if set, or given parameter if does not.

func (*OptSzHttpMethod) Reset 

func (o *OptSzHttpMethod) Reset()

Reset unsets value.

func (*OptSzHttpMethod) SetTo 

func (o *OptSzHttpMethod) SetTo(v SzHttpMethod)

SetTo sets value to v.

func (*OptSzHttpMethod) UnmarshalJSON 

func (s *OptSzHttpMethod) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzLicenseInfo 

type OptSzLicenseInfo struct {
	Value SzLicenseInfo
	Set   bool
}

OptSzLicenseInfo is optional SzLicenseInfo.

func NewOptSzLicenseInfo 

func NewOptSzLicenseInfo(v SzLicenseInfo) OptSzLicenseInfo

NewOptSzLicenseInfo returns new OptSzLicenseInfo with value set to v.

func (*OptSzLicenseInfo) Decode 

func (o *OptSzLicenseInfo) Decode(d *jx.Decoder) error

Decode decodes SzLicenseInfo from json.

func (OptSzLicenseInfo) Encode 

func (o OptSzLicenseInfo) Encode(e *jx.Encoder)

Encode encodes SzLicenseInfo as json.

func (OptSzLicenseInfo) Get 

func (o OptSzLicenseInfo) Get() (v SzLicenseInfo, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzLicenseInfo) IsSet 

func (o OptSzLicenseInfo) IsSet() bool

IsSet returns true if OptSzLicenseInfo was set.

func (OptSzLicenseInfo) MarshalJSON 

func (s OptSzLicenseInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzLicenseInfo) Or 

func (o OptSzLicenseInfo) Or(d SzLicenseInfo) SzLicenseInfo

Or returns value if set, or given parameter if does not.

func (*OptSzLicenseInfo) Reset 

func (o *OptSzLicenseInfo) Reset()

Reset unsets value.

func (*OptSzLicenseInfo) SetTo 

func (o *OptSzLicenseInfo) SetTo(v SzLicenseInfo)

SetTo sets value to v.

func (*OptSzLicenseInfo) UnmarshalJSON 

func (s *OptSzLicenseInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzLicenseResponseData 

type OptSzLicenseResponseData struct {
	Value SzLicenseResponseData
	Set   bool
}

OptSzLicenseResponseData is optional SzLicenseResponseData.

func NewOptSzLicenseResponseData 

func NewOptSzLicenseResponseData(v SzLicenseResponseData) OptSzLicenseResponseData

NewOptSzLicenseResponseData returns new OptSzLicenseResponseData with value set to v.

func (*OptSzLicenseResponseData) Decode 

func (o *OptSzLicenseResponseData) Decode(d *jx.Decoder) error

Decode decodes SzLicenseResponseData from json.

func (OptSzLicenseResponseData) Encode 

func (o OptSzLicenseResponseData) Encode(e *jx.Encoder)

Encode encodes SzLicenseResponseData as json.

func (OptSzLicenseResponseData) Get 

func (o OptSzLicenseResponseData) Get() (v SzLicenseResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzLicenseResponseData) IsSet 

func (o OptSzLicenseResponseData) IsSet() bool

IsSet returns true if OptSzLicenseResponseData was set.

func (OptSzLicenseResponseData) MarshalJSON 

func (s OptSzLicenseResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzLicenseResponseData) Or 

func (o OptSzLicenseResponseData) Or(d SzLicenseResponseData) SzLicenseResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzLicenseResponseData) Reset 

func (o *OptSzLicenseResponseData) Reset()

Reset unsets value.

func (*OptSzLicenseResponseData) SetTo 

func (o *OptSzLicenseResponseData) SetTo(v SzLicenseResponseData)

SetTo sets value to v.

func (*OptSzLicenseResponseData) UnmarshalJSON 

func (s *OptSzLicenseResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler. 

type OptSzLinks struct {
	Value SzLinks
	Set   bool
}

OptSzLinks is optional SzLinks. 

func NewOptSzLinks(v SzLinks) OptSzLinks

NewOptSzLinks returns new OptSzLinks with value set to v.

func (*OptSzLinks) Decode 

func (o *OptSzLinks) Decode(d *jx.Decoder) error

Decode decodes SzLinks from json.

func (OptSzLinks) Encode 

func (o OptSzLinks) Encode(e *jx.Encoder)

Encode encodes SzLinks as json.

func (OptSzLinks) Get 

func (o OptSzLinks) Get() (v SzLinks, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzLinks) IsSet 

func (o OptSzLinks) IsSet() bool

IsSet returns true if OptSzLinks was set.

func (OptSzLinks) MarshalJSON 

func (s OptSzLinks) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzLinks) Or 

func (o OptSzLinks) Or(d SzLinks) SzLinks

Or returns value if set, or given parameter if does not.

func (*OptSzLinks) Reset 

func (o *OptSzLinks) Reset()

Reset unsets value.

func (*OptSzLinks) SetTo 

func (o *OptSzLinks) SetTo(v SzLinks)

SetTo sets value to v.

func (*OptSzLinks) UnmarshalJSON 

func (s *OptSzLinks) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzLoadRecordResponseData 

type OptSzLoadRecordResponseData struct {
	Value SzLoadRecordResponseData
	Set   bool
}

OptSzLoadRecordResponseData is optional SzLoadRecordResponseData.

func NewOptSzLoadRecordResponseData 

func NewOptSzLoadRecordResponseData(v SzLoadRecordResponseData) OptSzLoadRecordResponseData

NewOptSzLoadRecordResponseData returns new OptSzLoadRecordResponseData with value set to v.

func (*OptSzLoadRecordResponseData) Decode 

func (o *OptSzLoadRecordResponseData) Decode(d *jx.Decoder) error

Decode decodes SzLoadRecordResponseData from json.

func (OptSzLoadRecordResponseData) Encode 

func (o OptSzLoadRecordResponseData) Encode(e *jx.Encoder)

Encode encodes SzLoadRecordResponseData as json.

func (OptSzLoadRecordResponseData) Get 

func (o OptSzLoadRecordResponseData) Get() (v SzLoadRecordResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzLoadRecordResponseData) IsSet 

func (o OptSzLoadRecordResponseData) IsSet() bool

IsSet returns true if OptSzLoadRecordResponseData was set.

func (OptSzLoadRecordResponseData) MarshalJSON 

func (s OptSzLoadRecordResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzLoadRecordResponseData) Or 

func (o OptSzLoadRecordResponseData) Or(d SzLoadRecordResponseData) SzLoadRecordResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzLoadRecordResponseData) Reset 

func (o *OptSzLoadRecordResponseData) Reset()

Reset unsets value.

func (*OptSzLoadRecordResponseData) SetTo 

func (o *OptSzLoadRecordResponseData) SetTo(v SzLoadRecordResponseData)

SetTo sets value to v.

func (*OptSzLoadRecordResponseData) UnmarshalJSON 

func (s *OptSzLoadRecordResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzMatchLevel 

type OptSzMatchLevel struct {
	Value SzMatchLevel
	Set   bool
}

OptSzMatchLevel is optional SzMatchLevel.

func NewOptSzMatchLevel 

func NewOptSzMatchLevel(v SzMatchLevel) OptSzMatchLevel

NewOptSzMatchLevel returns new OptSzMatchLevel with value set to v.

func (*OptSzMatchLevel) Decode 

func (o *OptSzMatchLevel) Decode(d *jx.Decoder) error

Decode decodes SzMatchLevel from json.

func (OptSzMatchLevel) Encode 

func (o OptSzMatchLevel) Encode(e *jx.Encoder)

Encode encodes SzMatchLevel as json.

func (OptSzMatchLevel) Get 

func (o OptSzMatchLevel) Get() (v SzMatchLevel, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzMatchLevel) IsSet 

func (o OptSzMatchLevel) IsSet() bool

IsSet returns true if OptSzMatchLevel was set.

func (OptSzMatchLevel) MarshalJSON 

func (s OptSzMatchLevel) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzMatchLevel) Or 

func (o OptSzMatchLevel) Or(d SzMatchLevel) SzMatchLevel

Or returns value if set, or given parameter if does not.

func (*OptSzMatchLevel) Reset 

func (o *OptSzMatchLevel) Reset()

Reset unsets value.

func (*OptSzMatchLevel) SetTo 

func (o *OptSzMatchLevel) SetTo(v SzMatchLevel)

SetTo sets value to v.

func (*OptSzMatchLevel) UnmarshalJSON 

func (s *OptSzMatchLevel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzMatchedRecordOriginalSourceData 

type OptSzMatchedRecordOriginalSourceData struct {
	Value SzMatchedRecordOriginalSourceData
	Set   bool
}

OptSzMatchedRecordOriginalSourceData is optional SzMatchedRecordOriginalSourceData.

func NewOptSzMatchedRecordOriginalSourceData 

func NewOptSzMatchedRecordOriginalSourceData(v SzMatchedRecordOriginalSourceData) OptSzMatchedRecordOriginalSourceData

NewOptSzMatchedRecordOriginalSourceData returns new OptSzMatchedRecordOriginalSourceData with value set to v.

func (*OptSzMatchedRecordOriginalSourceData) Decode 

func (o *OptSzMatchedRecordOriginalSourceData) Decode(d *jx.Decoder) error

Decode decodes SzMatchedRecordOriginalSourceData from json.

func (OptSzMatchedRecordOriginalSourceData) Encode 

func (o OptSzMatchedRecordOriginalSourceData) Encode(e *jx.Encoder)

Encode encodes SzMatchedRecordOriginalSourceData as json.

func (OptSzMatchedRecordOriginalSourceData) Get 

func (o OptSzMatchedRecordOriginalSourceData) Get() (v SzMatchedRecordOriginalSourceData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzMatchedRecordOriginalSourceData) IsSet 

func (o OptSzMatchedRecordOriginalSourceData) IsSet() bool

IsSet returns true if OptSzMatchedRecordOriginalSourceData was set.

func (OptSzMatchedRecordOriginalSourceData) MarshalJSON 

func (s OptSzMatchedRecordOriginalSourceData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzMatchedRecordOriginalSourceData) Or 

func (o OptSzMatchedRecordOriginalSourceData) Or(d SzMatchedRecordOriginalSourceData) SzMatchedRecordOriginalSourceData

Or returns value if set, or given parameter if does not.

func (*OptSzMatchedRecordOriginalSourceData) Reset 

func (o *OptSzMatchedRecordOriginalSourceData) Reset()

Reset unsets value.

func (*OptSzMatchedRecordOriginalSourceData) SetTo 

func (o *OptSzMatchedRecordOriginalSourceData) SetTo(v SzMatchedRecordOriginalSourceData)

SetTo sets value to v.

func (*OptSzMatchedRecordOriginalSourceData) UnmarshalJSON 

func (s *OptSzMatchedRecordOriginalSourceData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzMeta 

type OptSzMeta struct {
	Value SzMeta
	Set   bool
}

OptSzMeta is optional SzMeta.

func NewOptSzMeta 

func NewOptSzMeta(v SzMeta) OptSzMeta

NewOptSzMeta returns new OptSzMeta with value set to v.

func (*OptSzMeta) Decode 

func (o *OptSzMeta) Decode(d *jx.Decoder) error

Decode decodes SzMeta from json.

func (OptSzMeta) Encode 

func (o OptSzMeta) Encode(e *jx.Encoder)

Encode encodes SzMeta as json.

func (OptSzMeta) Get 

func (o OptSzMeta) Get() (v SzMeta, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzMeta) IsSet 

func (o OptSzMeta) IsSet() bool

IsSet returns true if OptSzMeta was set.

func (OptSzMeta) MarshalJSON 

func (s OptSzMeta) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzMeta) Or 

func (o OptSzMeta) Or(d SzMeta) SzMeta

Or returns value if set, or given parameter if does not.

func (*OptSzMeta) Reset 

func (o *OptSzMeta) Reset()

Reset unsets value.

func (*OptSzMeta) SetTo 

func (o *OptSzMeta) SetTo(v SzMeta)

SetTo sets value to v.

func (*OptSzMeta) UnmarshalJSON 

func (s *OptSzMeta) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzNameScoring 

type OptSzNameScoring struct {
	Value SzNameScoring
	Set   bool
}

OptSzNameScoring is optional SzNameScoring.

func NewOptSzNameScoring 

func NewOptSzNameScoring(v SzNameScoring) OptSzNameScoring

NewOptSzNameScoring returns new OptSzNameScoring with value set to v.

func (*OptSzNameScoring) Decode 

func (o *OptSzNameScoring) Decode(d *jx.Decoder) error

Decode decodes SzNameScoring from json.

func (OptSzNameScoring) Encode 

func (o OptSzNameScoring) Encode(e *jx.Encoder)

Encode encodes SzNameScoring as json.

func (OptSzNameScoring) Get 

func (o OptSzNameScoring) Get() (v SzNameScoring, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzNameScoring) IsSet 

func (o OptSzNameScoring) IsSet() bool

IsSet returns true if OptSzNameScoring was set.

func (OptSzNameScoring) MarshalJSON 

func (s OptSzNameScoring) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzNameScoring) Or 

func (o OptSzNameScoring) Or(d SzNameScoring) SzNameScoring

Or returns value if set, or given parameter if does not.

func (*OptSzNameScoring) Reset 

func (o *OptSzNameScoring) Reset()

Reset unsets value.

func (*OptSzNameScoring) SetTo 

func (o *OptSzNameScoring) SetTo(v SzNameScoring)

SetTo sets value to v.

func (*OptSzNameScoring) UnmarshalJSON 

func (s *OptSzNameScoring) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzRecordResponseData 

type OptSzRecordResponseData struct {
	Value SzRecordResponseData
	Set   bool
}

OptSzRecordResponseData is optional SzRecordResponseData.

func NewOptSzRecordResponseData 

func NewOptSzRecordResponseData(v SzRecordResponseData) OptSzRecordResponseData

NewOptSzRecordResponseData returns new OptSzRecordResponseData with value set to v.

func (*OptSzRecordResponseData) Decode 

func (o *OptSzRecordResponseData) Decode(d *jx.Decoder) error

Decode decodes SzRecordResponseData from json.

func (OptSzRecordResponseData) Encode 

func (o OptSzRecordResponseData) Encode(e *jx.Encoder)

Encode encodes SzRecordResponseData as json.

func (OptSzRecordResponseData) Get 

func (o OptSzRecordResponseData) Get() (v SzRecordResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzRecordResponseData) IsSet 

func (o OptSzRecordResponseData) IsSet() bool

IsSet returns true if OptSzRecordResponseData was set.

func (OptSzRecordResponseData) MarshalJSON 

func (s OptSzRecordResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzRecordResponseData) Or 

func (o OptSzRecordResponseData) Or(d SzRecordResponseData) SzRecordResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzRecordResponseData) Reset 

func (o *OptSzRecordResponseData) Reset()

Reset unsets value.

func (*OptSzRecordResponseData) SetTo 

func (o *OptSzRecordResponseData) SetTo(v SzRecordResponseData)

SetTo sets value to v.

func (*OptSzRecordResponseData) UnmarshalJSON 

func (s *OptSzRecordResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzReevaluateResponseData 

type OptSzReevaluateResponseData struct {
	Value SzReevaluateResponseData
	Set   bool
}

OptSzReevaluateResponseData is optional SzReevaluateResponseData.

func NewOptSzReevaluateResponseData 

func NewOptSzReevaluateResponseData(v SzReevaluateResponseData) OptSzReevaluateResponseData

NewOptSzReevaluateResponseData returns new OptSzReevaluateResponseData with value set to v.

func (*OptSzReevaluateResponseData) Decode 

func (o *OptSzReevaluateResponseData) Decode(d *jx.Decoder) error

Decode decodes SzReevaluateResponseData from json.

func (OptSzReevaluateResponseData) Encode 

func (o OptSzReevaluateResponseData) Encode(e *jx.Encoder)

Encode encodes SzReevaluateResponseData as json.

func (OptSzReevaluateResponseData) Get 

func (o OptSzReevaluateResponseData) Get() (v SzReevaluateResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzReevaluateResponseData) IsSet 

func (o OptSzReevaluateResponseData) IsSet() bool

IsSet returns true if OptSzReevaluateResponseData was set.

func (OptSzReevaluateResponseData) MarshalJSON 

func (s OptSzReevaluateResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzReevaluateResponseData) Or 

func (o OptSzReevaluateResponseData) Or(d SzReevaluateResponseData) SzReevaluateResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzReevaluateResponseData) Reset 

func (o *OptSzReevaluateResponseData) Reset()

Reset unsets value.

func (*OptSzReevaluateResponseData) SetTo 

func (o *OptSzReevaluateResponseData) SetTo(v SzReevaluateResponseData)

SetTo sets value to v.

func (*OptSzReevaluateResponseData) UnmarshalJSON 

func (s *OptSzReevaluateResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzRelatedEntityFeatures 

type OptSzRelatedEntityFeatures struct {
	Value SzRelatedEntityFeatures
	Set   bool
}

OptSzRelatedEntityFeatures is optional SzRelatedEntityFeatures.

func NewOptSzRelatedEntityFeatures 

func NewOptSzRelatedEntityFeatures(v SzRelatedEntityFeatures) OptSzRelatedEntityFeatures

NewOptSzRelatedEntityFeatures returns new OptSzRelatedEntityFeatures with value set to v.

func (*OptSzRelatedEntityFeatures) Decode 

func (o *OptSzRelatedEntityFeatures) Decode(d *jx.Decoder) error

Decode decodes SzRelatedEntityFeatures from json.

func (OptSzRelatedEntityFeatures) Encode 

func (o OptSzRelatedEntityFeatures) Encode(e *jx.Encoder)

Encode encodes SzRelatedEntityFeatures as json.

func (OptSzRelatedEntityFeatures) Get 

func (o OptSzRelatedEntityFeatures) Get() (v SzRelatedEntityFeatures, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzRelatedEntityFeatures) IsSet 

func (o OptSzRelatedEntityFeatures) IsSet() bool

IsSet returns true if OptSzRelatedEntityFeatures was set.

func (OptSzRelatedEntityFeatures) MarshalJSON 

func (s OptSzRelatedEntityFeatures) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzRelatedEntityFeatures) Or 

func (o OptSzRelatedEntityFeatures) Or(d SzRelatedEntityFeatures) SzRelatedEntityFeatures

Or returns value if set, or given parameter if does not.

func (*OptSzRelatedEntityFeatures) Reset 

func (o *OptSzRelatedEntityFeatures) Reset()

Reset unsets value.

func (*OptSzRelatedEntityFeatures) SetTo 

func (o *OptSzRelatedEntityFeatures) SetTo(v SzRelatedEntityFeatures)

SetTo sets value to v.

func (*OptSzRelatedEntityFeatures) UnmarshalJSON 

func (s *OptSzRelatedEntityFeatures) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzRelationDirection 

type OptSzRelationDirection struct {
	Value SzRelationDirection
	Set   bool
}

OptSzRelationDirection is optional SzRelationDirection.

func NewOptSzRelationDirection 

func NewOptSzRelationDirection(v SzRelationDirection) OptSzRelationDirection

NewOptSzRelationDirection returns new OptSzRelationDirection with value set to v.

func (*OptSzRelationDirection) Decode 

func (o *OptSzRelationDirection) Decode(d *jx.Decoder) error

Decode decodes SzRelationDirection from json.

func (OptSzRelationDirection) Encode 

func (o OptSzRelationDirection) Encode(e *jx.Encoder)

Encode encodes SzRelationDirection as json.

func (OptSzRelationDirection) Get 

func (o OptSzRelationDirection) Get() (v SzRelationDirection, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzRelationDirection) IsSet 

func (o OptSzRelationDirection) IsSet() bool

IsSet returns true if OptSzRelationDirection was set.

func (OptSzRelationDirection) MarshalJSON 

func (s OptSzRelationDirection) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzRelationDirection) Or 

func (o OptSzRelationDirection) Or(d SzRelationDirection) SzRelationDirection

Or returns value if set, or given parameter if does not.

func (*OptSzRelationDirection) Reset 

func (o *OptSzRelationDirection) Reset()

Reset unsets value.

func (*OptSzRelationDirection) SetTo 

func (o *OptSzRelationDirection) SetTo(v SzRelationDirection)

SetTo sets value to v.

func (*OptSzRelationDirection) UnmarshalJSON 

func (s *OptSzRelationDirection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzRelationshipMode 

type OptSzRelationshipMode struct {
	Value SzRelationshipMode
	Set   bool
}

OptSzRelationshipMode is optional SzRelationshipMode.

func NewOptSzRelationshipMode 

func NewOptSzRelationshipMode(v SzRelationshipMode) OptSzRelationshipMode

NewOptSzRelationshipMode returns new OptSzRelationshipMode with value set to v.

func (OptSzRelationshipMode) Get 

func (o OptSzRelationshipMode) Get() (v SzRelationshipMode, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzRelationshipMode) IsSet 

func (o OptSzRelationshipMode) IsSet() bool

IsSet returns true if OptSzRelationshipMode was set.

func (OptSzRelationshipMode) Or 

func (o OptSzRelationshipMode) Or(d SzRelationshipMode) SzRelationshipMode

Or returns value if set, or given parameter if does not.

func (*OptSzRelationshipMode) Reset 

func (o *OptSzRelationshipMode) Reset()

Reset unsets value.

func (*OptSzRelationshipMode) SetTo 

func (o *OptSzRelationshipMode) SetTo(v SzRelationshipMode)

SetTo sets value to v.

type OptSzRelationshipType 

type OptSzRelationshipType struct {
	Value SzRelationshipType
	Set   bool
}

OptSzRelationshipType is optional SzRelationshipType.

func NewOptSzRelationshipType 

func NewOptSzRelationshipType(v SzRelationshipType) OptSzRelationshipType

NewOptSzRelationshipType returns new OptSzRelationshipType with value set to v.

func (*OptSzRelationshipType) Decode 

func (o *OptSzRelationshipType) Decode(d *jx.Decoder) error

Decode decodes SzRelationshipType from json.

func (OptSzRelationshipType) Encode 

func (o OptSzRelationshipType) Encode(e *jx.Encoder)

Encode encodes SzRelationshipType as json.

func (OptSzRelationshipType) Get 

func (o OptSzRelationshipType) Get() (v SzRelationshipType, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzRelationshipType) IsSet 

func (o OptSzRelationshipType) IsSet() bool

IsSet returns true if OptSzRelationshipType was set.

func (OptSzRelationshipType) MarshalJSON 

func (s OptSzRelationshipType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzRelationshipType) Or 

func (o OptSzRelationshipType) Or(d SzRelationshipType) SzRelationshipType

Or returns value if set, or given parameter if does not.

func (*OptSzRelationshipType) Reset 

func (o *OptSzRelationshipType) Reset()

Reset unsets value.

func (*OptSzRelationshipType) SetTo 

func (o *OptSzRelationshipType) SetTo(v SzRelationshipType)

SetTo sets value to v.

func (*OptSzRelationshipType) UnmarshalJSON 

func (s *OptSzRelationshipType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzResolutionInfo 

type OptSzResolutionInfo struct {
	Value SzResolutionInfo
	Set   bool
}

OptSzResolutionInfo is optional SzResolutionInfo.

func NewOptSzResolutionInfo 

func NewOptSzResolutionInfo(v SzResolutionInfo) OptSzResolutionInfo

NewOptSzResolutionInfo returns new OptSzResolutionInfo with value set to v.

func (*OptSzResolutionInfo) Decode 

func (o *OptSzResolutionInfo) Decode(d *jx.Decoder) error

Decode decodes SzResolutionInfo from json.

func (OptSzResolutionInfo) Encode 

func (o OptSzResolutionInfo) Encode(e *jx.Encoder)

Encode encodes SzResolutionInfo as json.

func (OptSzResolutionInfo) Get 

func (o OptSzResolutionInfo) Get() (v SzResolutionInfo, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzResolutionInfo) IsSet 

func (o OptSzResolutionInfo) IsSet() bool

IsSet returns true if OptSzResolutionInfo was set.

func (OptSzResolutionInfo) MarshalJSON 

func (s OptSzResolutionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzResolutionInfo) Or 

func (o OptSzResolutionInfo) Or(d SzResolutionInfo) SzResolutionInfo

Or returns value if set, or given parameter if does not.

func (*OptSzResolutionInfo) Reset 

func (o *OptSzResolutionInfo) Reset()

Reset unsets value.

func (*OptSzResolutionInfo) SetTo 

func (o *OptSzResolutionInfo) SetTo(v SzResolutionInfo)

SetTo sets value to v.

func (*OptSzResolutionInfo) UnmarshalJSON 

func (s *OptSzResolutionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzResolvedEntity 

type OptSzResolvedEntity struct {
	Value SzResolvedEntity
	Set   bool
}

OptSzResolvedEntity is optional SzResolvedEntity.

func NewOptSzResolvedEntity 

func NewOptSzResolvedEntity(v SzResolvedEntity) OptSzResolvedEntity

NewOptSzResolvedEntity returns new OptSzResolvedEntity with value set to v.

func (*OptSzResolvedEntity) Decode 

func (o *OptSzResolvedEntity) Decode(d *jx.Decoder) error

Decode decodes SzResolvedEntity from json.

func (OptSzResolvedEntity) Encode 

func (o OptSzResolvedEntity) Encode(e *jx.Encoder)

Encode encodes SzResolvedEntity as json.

func (OptSzResolvedEntity) Get 

func (o OptSzResolvedEntity) Get() (v SzResolvedEntity, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzResolvedEntity) IsSet 

func (o OptSzResolvedEntity) IsSet() bool

IsSet returns true if OptSzResolvedEntity was set.

func (OptSzResolvedEntity) MarshalJSON 

func (s OptSzResolvedEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzResolvedEntity) Or 

func (o OptSzResolvedEntity) Or(d SzResolvedEntity) SzResolvedEntity

Or returns value if set, or given parameter if does not.

func (*OptSzResolvedEntity) Reset 

func (o *OptSzResolvedEntity) Reset()

Reset unsets value.

func (*OptSzResolvedEntity) SetTo 

func (o *OptSzResolvedEntity) SetTo(v SzResolvedEntity)

SetTo sets value to v.

func (*OptSzResolvedEntity) UnmarshalJSON 

func (s *OptSzResolvedEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzResolvedEntityFeatures 

type OptSzResolvedEntityFeatures struct {
	Value SzResolvedEntityFeatures
	Set   bool
}

OptSzResolvedEntityFeatures is optional SzResolvedEntityFeatures.

func NewOptSzResolvedEntityFeatures 

func NewOptSzResolvedEntityFeatures(v SzResolvedEntityFeatures) OptSzResolvedEntityFeatures

NewOptSzResolvedEntityFeatures returns new OptSzResolvedEntityFeatures with value set to v.

func (*OptSzResolvedEntityFeatures) Decode 

func (o *OptSzResolvedEntityFeatures) Decode(d *jx.Decoder) error

Decode decodes SzResolvedEntityFeatures from json.

func (OptSzResolvedEntityFeatures) Encode 

func (o OptSzResolvedEntityFeatures) Encode(e *jx.Encoder)

Encode encodes SzResolvedEntityFeatures as json.

func (OptSzResolvedEntityFeatures) Get 

func (o OptSzResolvedEntityFeatures) Get() (v SzResolvedEntityFeatures, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzResolvedEntityFeatures) IsSet 

func (o OptSzResolvedEntityFeatures) IsSet() bool

IsSet returns true if OptSzResolvedEntityFeatures was set.

func (OptSzResolvedEntityFeatures) MarshalJSON 

func (s OptSzResolvedEntityFeatures) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzResolvedEntityFeatures) Or 

func (o OptSzResolvedEntityFeatures) Or(d SzResolvedEntityFeatures) SzResolvedEntityFeatures

Or returns value if set, or given parameter if does not.

func (*OptSzResolvedEntityFeatures) Reset 

func (o *OptSzResolvedEntityFeatures) Reset()

Reset unsets value.

func (*OptSzResolvedEntityFeatures) SetTo 

func (o *OptSzResolvedEntityFeatures) SetTo(v SzResolvedEntityFeatures)

SetTo sets value to v.

func (*OptSzResolvedEntityFeatures) UnmarshalJSON 

func (s *OptSzResolvedEntityFeatures) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzScoredFeature 

type OptSzScoredFeature struct {
	Value SzScoredFeature
	Set   bool
}

OptSzScoredFeature is optional SzScoredFeature.

func NewOptSzScoredFeature 

func NewOptSzScoredFeature(v SzScoredFeature) OptSzScoredFeature

NewOptSzScoredFeature returns new OptSzScoredFeature with value set to v.

func (*OptSzScoredFeature) Decode 

func (o *OptSzScoredFeature) Decode(d *jx.Decoder) error

Decode decodes SzScoredFeature from json.

func (OptSzScoredFeature) Encode 

func (o OptSzScoredFeature) Encode(e *jx.Encoder)

Encode encodes SzScoredFeature as json.

func (OptSzScoredFeature) Get 

func (o OptSzScoredFeature) Get() (v SzScoredFeature, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzScoredFeature) IsSet 

func (o OptSzScoredFeature) IsSet() bool

IsSet returns true if OptSzScoredFeature was set.

func (OptSzScoredFeature) MarshalJSON 

func (s OptSzScoredFeature) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzScoredFeature) Or 

func (o OptSzScoredFeature) Or(d SzScoredFeature) SzScoredFeature

Or returns value if set, or given parameter if does not.

func (*OptSzScoredFeature) Reset 

func (o *OptSzScoredFeature) Reset()

Reset unsets value.

func (*OptSzScoredFeature) SetTo 

func (o *OptSzScoredFeature) SetTo(v SzScoredFeature)

SetTo sets value to v.

func (*OptSzScoredFeature) UnmarshalJSON 

func (s *OptSzScoredFeature) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzScoringBehavior 

type OptSzScoringBehavior struct {
	Value SzScoringBehavior
	Set   bool
}

OptSzScoringBehavior is optional SzScoringBehavior.

func NewOptSzScoringBehavior 

func NewOptSzScoringBehavior(v SzScoringBehavior) OptSzScoringBehavior

NewOptSzScoringBehavior returns new OptSzScoringBehavior with value set to v.

func (*OptSzScoringBehavior) Decode 

func (o *OptSzScoringBehavior) Decode(d *jx.Decoder) error

Decode decodes SzScoringBehavior from json.

func (OptSzScoringBehavior) Encode 

func (o OptSzScoringBehavior) Encode(e *jx.Encoder)

Encode encodes SzScoringBehavior as json.

func (OptSzScoringBehavior) Get 

func (o OptSzScoringBehavior) Get() (v SzScoringBehavior, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzScoringBehavior) IsSet 

func (o OptSzScoringBehavior) IsSet() bool

IsSet returns true if OptSzScoringBehavior was set.

func (OptSzScoringBehavior) MarshalJSON 

func (s OptSzScoringBehavior) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzScoringBehavior) Or 

func (o OptSzScoringBehavior) Or(d SzScoringBehavior) SzScoringBehavior

Or returns value if set, or given parameter if does not.

func (*OptSzScoringBehavior) Reset 

func (o *OptSzScoringBehavior) Reset()

Reset unsets value.

func (*OptSzScoringBehavior) SetTo 

func (o *OptSzScoringBehavior) SetTo(v SzScoringBehavior)

SetTo sets value to v.

func (*OptSzScoringBehavior) UnmarshalJSON 

func (s *OptSzScoringBehavior) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzScoringBucket 

type OptSzScoringBucket struct {
	Value SzScoringBucket
	Set   bool
}

OptSzScoringBucket is optional SzScoringBucket.

func NewOptSzScoringBucket 

func NewOptSzScoringBucket(v SzScoringBucket) OptSzScoringBucket

NewOptSzScoringBucket returns new OptSzScoringBucket with value set to v.

func (*OptSzScoringBucket) Decode 

func (o *OptSzScoringBucket) Decode(d *jx.Decoder) error

Decode decodes SzScoringBucket from json.

func (OptSzScoringBucket) Encode 

func (o OptSzScoringBucket) Encode(e *jx.Encoder)

Encode encodes SzScoringBucket as json.

func (OptSzScoringBucket) Get 

func (o OptSzScoringBucket) Get() (v SzScoringBucket, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzScoringBucket) IsSet 

func (o OptSzScoringBucket) IsSet() bool

IsSet returns true if OptSzScoringBucket was set.

func (OptSzScoringBucket) MarshalJSON 

func (s OptSzScoringBucket) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzScoringBucket) Or 

func (o OptSzScoringBucket) Or(d SzScoringBucket) SzScoringBucket

Or returns value if set, or given parameter if does not.

func (*OptSzScoringBucket) Reset 

func (o *OptSzScoringBucket) Reset()

Reset unsets value.

func (*OptSzScoringBucket) SetTo 

func (o *OptSzScoringBucket) SetTo(v SzScoringBucket)

SetTo sets value to v.

func (*OptSzScoringBucket) UnmarshalJSON 

func (s *OptSzScoringBucket) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzScoringFrequency 

type OptSzScoringFrequency struct {
	Value SzScoringFrequency
	Set   bool
}

OptSzScoringFrequency is optional SzScoringFrequency.

func NewOptSzScoringFrequency 

func NewOptSzScoringFrequency(v SzScoringFrequency) OptSzScoringFrequency

NewOptSzScoringFrequency returns new OptSzScoringFrequency with value set to v.

func (*OptSzScoringFrequency) Decode 

func (o *OptSzScoringFrequency) Decode(d *jx.Decoder) error

Decode decodes SzScoringFrequency from json.

func (OptSzScoringFrequency) Encode 

func (o OptSzScoringFrequency) Encode(e *jx.Encoder)

Encode encodes SzScoringFrequency as json.

func (OptSzScoringFrequency) Get 

func (o OptSzScoringFrequency) Get() (v SzScoringFrequency, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzScoringFrequency) IsSet 

func (o OptSzScoringFrequency) IsSet() bool

IsSet returns true if OptSzScoringFrequency was set.

func (OptSzScoringFrequency) MarshalJSON 

func (s OptSzScoringFrequency) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzScoringFrequency) Or 

func (o OptSzScoringFrequency) Or(d SzScoringFrequency) SzScoringFrequency

Or returns value if set, or given parameter if does not.

func (*OptSzScoringFrequency) Reset 

func (o *OptSzScoringFrequency) Reset()

Reset unsets value.

func (*OptSzScoringFrequency) SetTo 

func (o *OptSzScoringFrequency) SetTo(v SzScoringFrequency)

SetTo sets value to v.

func (*OptSzScoringFrequency) UnmarshalJSON 

func (s *OptSzScoringFrequency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzServerInfo 

type OptSzServerInfo struct {
	Value SzServerInfo
	Set   bool
}

OptSzServerInfo is optional SzServerInfo.

func NewOptSzServerInfo 

func NewOptSzServerInfo(v SzServerInfo) OptSzServerInfo

NewOptSzServerInfo returns new OptSzServerInfo with value set to v.

func (*OptSzServerInfo) Decode 

func (o *OptSzServerInfo) Decode(d *jx.Decoder) error

Decode decodes SzServerInfo from json.

func (OptSzServerInfo) Encode 

func (o OptSzServerInfo) Encode(e *jx.Encoder)

Encode encodes SzServerInfo as json.

func (OptSzServerInfo) Get 

func (o OptSzServerInfo) Get() (v SzServerInfo, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzServerInfo) IsSet 

func (o OptSzServerInfo) IsSet() bool

IsSet returns true if OptSzServerInfo was set.

func (OptSzServerInfo) MarshalJSON 

func (s OptSzServerInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzServerInfo) Or 

func (o OptSzServerInfo) Or(d SzServerInfo) SzServerInfo

Or returns value if set, or given parameter if does not.

func (*OptSzServerInfo) Reset 

func (o *OptSzServerInfo) Reset()

Reset unsets value.

func (*OptSzServerInfo) SetTo 

func (o *OptSzServerInfo) SetTo(v SzServerInfo)

SetTo sets value to v.

func (*OptSzServerInfo) UnmarshalJSON 

func (s *OptSzServerInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzVersionInfo 

type OptSzVersionInfo struct {
	Value SzVersionInfo
	Set   bool
}

OptSzVersionInfo is optional SzVersionInfo.

func NewOptSzVersionInfo 

func NewOptSzVersionInfo(v SzVersionInfo) OptSzVersionInfo

NewOptSzVersionInfo returns new OptSzVersionInfo with value set to v.

func (*OptSzVersionInfo) Decode 

func (o *OptSzVersionInfo) Decode(d *jx.Decoder) error

Decode decodes SzVersionInfo from json.

func (OptSzVersionInfo) Encode 

func (o OptSzVersionInfo) Encode(e *jx.Encoder)

Encode encodes SzVersionInfo as json.

func (OptSzVersionInfo) Get 

func (o OptSzVersionInfo) Get() (v SzVersionInfo, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzVersionInfo) IsSet 

func (o OptSzVersionInfo) IsSet() bool

IsSet returns true if OptSzVersionInfo was set.

func (OptSzVersionInfo) MarshalJSON 

func (s OptSzVersionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzVersionInfo) Or 

func (o OptSzVersionInfo) Or(d SzVersionInfo) SzVersionInfo

Or returns value if set, or given parameter if does not.

func (*OptSzVersionInfo) Reset 

func (o *OptSzVersionInfo) Reset()

Reset unsets value.

func (*OptSzVersionInfo) SetTo 

func (o *OptSzVersionInfo) SetTo(v SzVersionInfo)

SetTo sets value to v.

func (*OptSzVersionInfo) UnmarshalJSON 

func (s *OptSzVersionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzVirtualEntity 

type OptSzVirtualEntity struct {
	Value SzVirtualEntity
	Set   bool
}

OptSzVirtualEntity is optional SzVirtualEntity.

func NewOptSzVirtualEntity 

func NewOptSzVirtualEntity(v SzVirtualEntity) OptSzVirtualEntity

NewOptSzVirtualEntity returns new OptSzVirtualEntity with value set to v.

func (*OptSzVirtualEntity) Decode 

func (o *OptSzVirtualEntity) Decode(d *jx.Decoder) error

Decode decodes SzVirtualEntity from json.

func (OptSzVirtualEntity) Encode 

func (o OptSzVirtualEntity) Encode(e *jx.Encoder)

Encode encodes SzVirtualEntity as json.

func (OptSzVirtualEntity) Get 

func (o OptSzVirtualEntity) Get() (v SzVirtualEntity, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzVirtualEntity) IsSet 

func (o OptSzVirtualEntity) IsSet() bool

IsSet returns true if OptSzVirtualEntity was set.

func (OptSzVirtualEntity) MarshalJSON 

func (s OptSzVirtualEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzVirtualEntity) Or 

func (o OptSzVirtualEntity) Or(d SzVirtualEntity) SzVirtualEntity

Or returns value if set, or given parameter if does not.

func (*OptSzVirtualEntity) Reset 

func (o *OptSzVirtualEntity) Reset()

Reset unsets value.

func (*OptSzVirtualEntity) SetTo 

func (o *OptSzVirtualEntity) SetTo(v SzVirtualEntity)

SetTo sets value to v.

func (*OptSzVirtualEntity) UnmarshalJSON 

func (s *OptSzVirtualEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzVirtualEntityData 

type OptSzVirtualEntityData struct {
	Value SzVirtualEntityData
	Set   bool
}

OptSzVirtualEntityData is optional SzVirtualEntityData.

func NewOptSzVirtualEntityData 

func NewOptSzVirtualEntityData(v SzVirtualEntityData) OptSzVirtualEntityData

NewOptSzVirtualEntityData returns new OptSzVirtualEntityData with value set to v.

func (*OptSzVirtualEntityData) Decode 

func (o *OptSzVirtualEntityData) Decode(d *jx.Decoder) error

Decode decodes SzVirtualEntityData from json.

func (OptSzVirtualEntityData) Encode 

func (o OptSzVirtualEntityData) Encode(e *jx.Encoder)

Encode encodes SzVirtualEntityData as json.

func (OptSzVirtualEntityData) Get 

func (o OptSzVirtualEntityData) Get() (v SzVirtualEntityData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzVirtualEntityData) IsSet 

func (o OptSzVirtualEntityData) IsSet() bool

IsSet returns true if OptSzVirtualEntityData was set.

func (OptSzVirtualEntityData) MarshalJSON 

func (s OptSzVirtualEntityData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzVirtualEntityData) Or 

func (o OptSzVirtualEntityData) Or(d SzVirtualEntityData) SzVirtualEntityData

Or returns value if set, or given parameter if does not.

func (*OptSzVirtualEntityData) Reset 

func (o *OptSzVirtualEntityData) Reset()

Reset unsets value.

func (*OptSzVirtualEntityData) SetTo 

func (o *OptSzVirtualEntityData) SetTo(v SzVirtualEntityData)

SetTo sets value to v.

func (*OptSzVirtualEntityData) UnmarshalJSON 

func (s *OptSzVirtualEntityData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzWhyEntitiesResponseData 

type OptSzWhyEntitiesResponseData struct {
	Value SzWhyEntitiesResponseData
	Set   bool
}

OptSzWhyEntitiesResponseData is optional SzWhyEntitiesResponseData.

func NewOptSzWhyEntitiesResponseData 

func NewOptSzWhyEntitiesResponseData(v SzWhyEntitiesResponseData) OptSzWhyEntitiesResponseData

NewOptSzWhyEntitiesResponseData returns new OptSzWhyEntitiesResponseData with value set to v.

func (*OptSzWhyEntitiesResponseData) Decode 

func (o *OptSzWhyEntitiesResponseData) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntitiesResponseData from json.

func (OptSzWhyEntitiesResponseData) Encode 

func (o OptSzWhyEntitiesResponseData) Encode(e *jx.Encoder)

Encode encodes SzWhyEntitiesResponseData as json.

func (OptSzWhyEntitiesResponseData) Get 

func (o OptSzWhyEntitiesResponseData) Get() (v SzWhyEntitiesResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzWhyEntitiesResponseData) IsSet 

func (o OptSzWhyEntitiesResponseData) IsSet() bool

IsSet returns true if OptSzWhyEntitiesResponseData was set.

func (OptSzWhyEntitiesResponseData) MarshalJSON 

func (s OptSzWhyEntitiesResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzWhyEntitiesResponseData) Or 

func (o OptSzWhyEntitiesResponseData) Or(d SzWhyEntitiesResponseData) SzWhyEntitiesResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzWhyEntitiesResponseData) Reset 

func (o *OptSzWhyEntitiesResponseData) Reset()

Reset unsets value.

func (*OptSzWhyEntitiesResponseData) SetTo 

func (o *OptSzWhyEntitiesResponseData) SetTo(v SzWhyEntitiesResponseData)

SetTo sets value to v.

func (*OptSzWhyEntitiesResponseData) UnmarshalJSON 

func (s *OptSzWhyEntitiesResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzWhyEntitiesResult 

type OptSzWhyEntitiesResult struct {
	Value SzWhyEntitiesResult
	Set   bool
}

OptSzWhyEntitiesResult is optional SzWhyEntitiesResult.

func NewOptSzWhyEntitiesResult 

func NewOptSzWhyEntitiesResult(v SzWhyEntitiesResult) OptSzWhyEntitiesResult

NewOptSzWhyEntitiesResult returns new OptSzWhyEntitiesResult with value set to v.

func (*OptSzWhyEntitiesResult) Decode 

func (o *OptSzWhyEntitiesResult) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntitiesResult from json.

func (OptSzWhyEntitiesResult) Encode 

func (o OptSzWhyEntitiesResult) Encode(e *jx.Encoder)

Encode encodes SzWhyEntitiesResult as json.

func (OptSzWhyEntitiesResult) Get 

func (o OptSzWhyEntitiesResult) Get() (v SzWhyEntitiesResult, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzWhyEntitiesResult) IsSet 

func (o OptSzWhyEntitiesResult) IsSet() bool

IsSet returns true if OptSzWhyEntitiesResult was set.

func (OptSzWhyEntitiesResult) MarshalJSON 

func (s OptSzWhyEntitiesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzWhyEntitiesResult) Or 

func (o OptSzWhyEntitiesResult) Or(d SzWhyEntitiesResult) SzWhyEntitiesResult

Or returns value if set, or given parameter if does not.

func (*OptSzWhyEntitiesResult) Reset 

func (o *OptSzWhyEntitiesResult) Reset()

Reset unsets value.

func (*OptSzWhyEntitiesResult) SetTo 

func (o *OptSzWhyEntitiesResult) SetTo(v SzWhyEntitiesResult)

SetTo sets value to v.

func (*OptSzWhyEntitiesResult) UnmarshalJSON 

func (s *OptSzWhyEntitiesResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzWhyEntityResponseData 

type OptSzWhyEntityResponseData struct {
	Value SzWhyEntityResponseData
	Set   bool
}

OptSzWhyEntityResponseData is optional SzWhyEntityResponseData.

func NewOptSzWhyEntityResponseData 

func NewOptSzWhyEntityResponseData(v SzWhyEntityResponseData) OptSzWhyEntityResponseData

NewOptSzWhyEntityResponseData returns new OptSzWhyEntityResponseData with value set to v.

func (*OptSzWhyEntityResponseData) Decode 

func (o *OptSzWhyEntityResponseData) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntityResponseData from json.

func (OptSzWhyEntityResponseData) Encode 

func (o OptSzWhyEntityResponseData) Encode(e *jx.Encoder)

Encode encodes SzWhyEntityResponseData as json.

func (OptSzWhyEntityResponseData) Get 

func (o OptSzWhyEntityResponseData) Get() (v SzWhyEntityResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzWhyEntityResponseData) IsSet 

func (o OptSzWhyEntityResponseData) IsSet() bool

IsSet returns true if OptSzWhyEntityResponseData was set.

func (OptSzWhyEntityResponseData) MarshalJSON 

func (s OptSzWhyEntityResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzWhyEntityResponseData) Or 

func (o OptSzWhyEntityResponseData) Or(d SzWhyEntityResponseData) SzWhyEntityResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzWhyEntityResponseData) Reset 

func (o *OptSzWhyEntityResponseData) Reset()

Reset unsets value.

func (*OptSzWhyEntityResponseData) SetTo 

func (o *OptSzWhyEntityResponseData) SetTo(v SzWhyEntityResponseData)

SetTo sets value to v.

func (*OptSzWhyEntityResponseData) UnmarshalJSON 

func (s *OptSzWhyEntityResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzWhyMatchInfo 

type OptSzWhyMatchInfo struct {
	Value SzWhyMatchInfo
	Set   bool
}

OptSzWhyMatchInfo is optional SzWhyMatchInfo.

func NewOptSzWhyMatchInfo 

func NewOptSzWhyMatchInfo(v SzWhyMatchInfo) OptSzWhyMatchInfo

NewOptSzWhyMatchInfo returns new OptSzWhyMatchInfo with value set to v.

func (*OptSzWhyMatchInfo) Decode 

func (o *OptSzWhyMatchInfo) Decode(d *jx.Decoder) error

Decode decodes SzWhyMatchInfo from json.

func (OptSzWhyMatchInfo) Encode 

func (o OptSzWhyMatchInfo) Encode(e *jx.Encoder)

Encode encodes SzWhyMatchInfo as json.

func (OptSzWhyMatchInfo) Get 

func (o OptSzWhyMatchInfo) Get() (v SzWhyMatchInfo, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzWhyMatchInfo) IsSet 

func (o OptSzWhyMatchInfo) IsSet() bool

IsSet returns true if OptSzWhyMatchInfo was set.

func (OptSzWhyMatchInfo) MarshalJSON 

func (s OptSzWhyMatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzWhyMatchInfo) Or 

func (o OptSzWhyMatchInfo) Or(d SzWhyMatchInfo) SzWhyMatchInfo

Or returns value if set, or given parameter if does not.

func (*OptSzWhyMatchInfo) Reset 

func (o *OptSzWhyMatchInfo) Reset()

Reset unsets value.

func (*OptSzWhyMatchInfo) SetTo 

func (o *OptSzWhyMatchInfo) SetTo(v SzWhyMatchInfo)

SetTo sets value to v.

func (*OptSzWhyMatchInfo) UnmarshalJSON 

func (s *OptSzWhyMatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzWhyRecordsResponseData 

type OptSzWhyRecordsResponseData struct {
	Value SzWhyRecordsResponseData
	Set   bool
}

OptSzWhyRecordsResponseData is optional SzWhyRecordsResponseData.

func NewOptSzWhyRecordsResponseData 

func NewOptSzWhyRecordsResponseData(v SzWhyRecordsResponseData) OptSzWhyRecordsResponseData

NewOptSzWhyRecordsResponseData returns new OptSzWhyRecordsResponseData with value set to v.

func (*OptSzWhyRecordsResponseData) Decode 

func (o *OptSzWhyRecordsResponseData) Decode(d *jx.Decoder) error

Decode decodes SzWhyRecordsResponseData from json.

func (OptSzWhyRecordsResponseData) Encode 

func (o OptSzWhyRecordsResponseData) Encode(e *jx.Encoder)

Encode encodes SzWhyRecordsResponseData as json.

func (OptSzWhyRecordsResponseData) Get 

func (o OptSzWhyRecordsResponseData) Get() (v SzWhyRecordsResponseData, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzWhyRecordsResponseData) IsSet 

func (o OptSzWhyRecordsResponseData) IsSet() bool

IsSet returns true if OptSzWhyRecordsResponseData was set.

func (OptSzWhyRecordsResponseData) MarshalJSON 

func (s OptSzWhyRecordsResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzWhyRecordsResponseData) Or 

func (o OptSzWhyRecordsResponseData) Or(d SzWhyRecordsResponseData) SzWhyRecordsResponseData

Or returns value if set, or given parameter if does not.

func (*OptSzWhyRecordsResponseData) Reset 

func (o *OptSzWhyRecordsResponseData) Reset()

Reset unsets value.

func (*OptSzWhyRecordsResponseData) SetTo 

func (o *OptSzWhyRecordsResponseData) SetTo(v SzWhyRecordsResponseData)

SetTo sets value to v.

func (*OptSzWhyRecordsResponseData) UnmarshalJSON 

func (s *OptSzWhyRecordsResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OptSzWhyRecordsResult 

type OptSzWhyRecordsResult struct {
	Value SzWhyRecordsResult
	Set   bool
}

OptSzWhyRecordsResult is optional SzWhyRecordsResult.

func NewOptSzWhyRecordsResult 

func NewOptSzWhyRecordsResult(v SzWhyRecordsResult) OptSzWhyRecordsResult

NewOptSzWhyRecordsResult returns new OptSzWhyRecordsResult with value set to v.

func (*OptSzWhyRecordsResult) Decode 

func (o *OptSzWhyRecordsResult) Decode(d *jx.Decoder) error

Decode decodes SzWhyRecordsResult from json.

func (OptSzWhyRecordsResult) Encode 

func (o OptSzWhyRecordsResult) Encode(e *jx.Encoder)

Encode encodes SzWhyRecordsResult as json.

func (OptSzWhyRecordsResult) Get 

func (o OptSzWhyRecordsResult) Get() (v SzWhyRecordsResult, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptSzWhyRecordsResult) IsSet 

func (o OptSzWhyRecordsResult) IsSet() bool

IsSet returns true if OptSzWhyRecordsResult was set.

func (OptSzWhyRecordsResult) MarshalJSON 

func (s OptSzWhyRecordsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptSzWhyRecordsResult) Or 

func (o OptSzWhyRecordsResult) Or(d SzWhyRecordsResult) SzWhyRecordsResult

Or returns value if set, or given parameter if does not.

func (*OptSzWhyRecordsResult) Reset 

func (o *OptSzWhyRecordsResult) Reset()

Reset unsets value.

func (*OptSzWhyRecordsResult) SetTo 

func (o *OptSzWhyRecordsResult) SetTo(v SzWhyRecordsResult)

SetTo sets value to v.

func (*OptSzWhyRecordsResult) UnmarshalJSON 

func (s *OptSzWhyRecordsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithMeterProvider 

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the otel.GetMeterProvider() is used.

func WithTracerProvider 

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer.

If none is specified, the global provider is used.

type ReevaluateEntityApplicationJSONInternalServerError 

type ReevaluateEntityApplicationJSONInternalServerError SzErrorResponse

func (*ReevaluateEntityApplicationJSONInternalServerError) Decode 

func (s *ReevaluateEntityApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes ReevaluateEntityApplicationJSONInternalServerError from json.

func (*ReevaluateEntityApplicationJSONInternalServerError) Encode 

func (s *ReevaluateEntityApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes ReevaluateEntityApplicationJSONInternalServerError as json.

func (*ReevaluateEntityApplicationJSONInternalServerError) MarshalJSON 

func (s *ReevaluateEntityApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReevaluateEntityApplicationJSONInternalServerError) UnmarshalJSON 

func (s *ReevaluateEntityApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReevaluateEntityApplicationJSONInternalServerError) Validate 

func (s *ReevaluateEntityApplicationJSONInternalServerError) Validate() error

type ReevaluateEntityApplicationJSONNotFound 

type ReevaluateEntityApplicationJSONNotFound SzErrorResponse

func (*ReevaluateEntityApplicationJSONNotFound) Decode 

func (s *ReevaluateEntityApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes ReevaluateEntityApplicationJSONNotFound from json.

func (*ReevaluateEntityApplicationJSONNotFound) Encode 

func (s *ReevaluateEntityApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes ReevaluateEntityApplicationJSONNotFound as json.

func (*ReevaluateEntityApplicationJSONNotFound) MarshalJSON 

func (s *ReevaluateEntityApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReevaluateEntityApplicationJSONNotFound) UnmarshalJSON 

func (s *ReevaluateEntityApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReevaluateEntityApplicationJSONNotFound) Validate 

func (s *ReevaluateEntityApplicationJSONNotFound) Validate() error

type ReevaluateEntityNotFoundDefault 

type ReevaluateEntityNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (ReevaluateEntityNotFoundDefault) Read 

func (s ReevaluateEntityNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type ReevaluateEntityOKDefault 

type ReevaluateEntityOKDefault struct {
	Data io.Reader
}

Ref: #/components/schemas/SzReevaluateResponse

func (ReevaluateEntityOKDefault) Read 

func (s ReevaluateEntityOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type ReevaluateEntityParams 

type ReevaluateEntityParams struct {
	// The entity ID of the entity to reevaluate.
	EntityId int64
	// Set to `true` to include resolution information related to loading, and `false` to exclude it.
	// This defaults to `false`.
	WithInfo OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

ReevaluateEntityParams is parameters of reevaluateEntity operation.

type ReevaluateEntityRes 

type ReevaluateEntityRes interface {
	// contains filtered or unexported methods
}

type ReevaluateRecordApplicationJSONInternalServerError 

type ReevaluateRecordApplicationJSONInternalServerError SzErrorResponse

func (*ReevaluateRecordApplicationJSONInternalServerError) Decode 

func (s *ReevaluateRecordApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes ReevaluateRecordApplicationJSONInternalServerError from json.

func (*ReevaluateRecordApplicationJSONInternalServerError) Encode 

func (s *ReevaluateRecordApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes ReevaluateRecordApplicationJSONInternalServerError as json.

func (*ReevaluateRecordApplicationJSONInternalServerError) MarshalJSON 

func (s *ReevaluateRecordApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReevaluateRecordApplicationJSONInternalServerError) UnmarshalJSON 

func (s *ReevaluateRecordApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReevaluateRecordApplicationJSONInternalServerError) Validate 

func (s *ReevaluateRecordApplicationJSONInternalServerError) Validate() error

type ReevaluateRecordApplicationJSONNotFound 

type ReevaluateRecordApplicationJSONNotFound SzErrorResponse

func (*ReevaluateRecordApplicationJSONNotFound) Decode 

func (s *ReevaluateRecordApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes ReevaluateRecordApplicationJSONNotFound from json.

func (*ReevaluateRecordApplicationJSONNotFound) Encode 

func (s *ReevaluateRecordApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes ReevaluateRecordApplicationJSONNotFound as json.

func (*ReevaluateRecordApplicationJSONNotFound) MarshalJSON 

func (s *ReevaluateRecordApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ReevaluateRecordApplicationJSONNotFound) UnmarshalJSON 

func (s *ReevaluateRecordApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ReevaluateRecordApplicationJSONNotFound) Validate 

func (s *ReevaluateRecordApplicationJSONNotFound) Validate() error

type ReevaluateRecordNotFoundDefault 

type ReevaluateRecordNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (ReevaluateRecordNotFoundDefault) Read 

func (s ReevaluateRecordNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type ReevaluateRecordOKDefault 

type ReevaluateRecordOKDefault struct {
	Data io.Reader
}

Ref: #/components/schemas/SzReevaluateResponse

func (ReevaluateRecordOKDefault) Read 

func (s ReevaluateRecordOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type ReevaluateRecordParams 

type ReevaluateRecordParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// The identifier that uniquely identifies the requested record within a given data source.  This may
	// have been specified when the record was loaded or generated automatically.
	RecordId string
	// Set to `true` to include resolution information related to loading, and `false` to exclude it.
	// This defaults to `false`.
	WithInfo OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

ReevaluateRecordParams is parameters of reevaluateRecord operation.

type ReevaluateRecordRes 

type ReevaluateRecordRes interface {
	// contains filtered or unexported methods
}

type Route 

type Route struct {
	// contains filtered or unexported fields
}

Route is route object.

func (Route) Args 

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) Name 

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationID 

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

func (Route) PathPattern 

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

func (Route) Summary added in v0.9.0 

func (r Route) Summary() string

Summary returns OpenAPI summary.

type SearchEntitiesByGetApplicationJSONBadRequest 

type SearchEntitiesByGetApplicationJSONBadRequest SzErrorResponse

func (*SearchEntitiesByGetApplicationJSONBadRequest) Decode 

func (s *SearchEntitiesByGetApplicationJSONBadRequest) Decode(d *jx.Decoder) error

Decode decodes SearchEntitiesByGetApplicationJSONBadRequest from json.

func (*SearchEntitiesByGetApplicationJSONBadRequest) Encode 

func (s *SearchEntitiesByGetApplicationJSONBadRequest) Encode(e *jx.Encoder)

Encode encodes SearchEntitiesByGetApplicationJSONBadRequest as json.

func (*SearchEntitiesByGetApplicationJSONBadRequest) MarshalJSON 

func (s *SearchEntitiesByGetApplicationJSONBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEntitiesByGetApplicationJSONBadRequest) UnmarshalJSON 

func (s *SearchEntitiesByGetApplicationJSONBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SearchEntitiesByGetApplicationJSONBadRequest) Validate 

func (s *SearchEntitiesByGetApplicationJSONBadRequest) Validate() error

type SearchEntitiesByGetApplicationJSONInternalServerError 

type SearchEntitiesByGetApplicationJSONInternalServerError SzErrorResponse

func (*SearchEntitiesByGetApplicationJSONInternalServerError) Decode 

func (s *SearchEntitiesByGetApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes SearchEntitiesByGetApplicationJSONInternalServerError from json.

func (*SearchEntitiesByGetApplicationJSONInternalServerError) Encode 

func (s *SearchEntitiesByGetApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes SearchEntitiesByGetApplicationJSONInternalServerError as json.

func (*SearchEntitiesByGetApplicationJSONInternalServerError) MarshalJSON 

func (s *SearchEntitiesByGetApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEntitiesByGetApplicationJSONInternalServerError) UnmarshalJSON 

func (s *SearchEntitiesByGetApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SearchEntitiesByGetApplicationJSONInternalServerError) Validate 

func (s *SearchEntitiesByGetApplicationJSONInternalServerError) Validate() error

type SearchEntitiesByGetBadRequestDefault 

type SearchEntitiesByGetBadRequestDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (SearchEntitiesByGetBadRequestDefault) Read 

func (s SearchEntitiesByGetBadRequestDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type SearchEntitiesByGetOKDefault 

type SearchEntitiesByGetOKDefault struct {
	Data io.Reader
}

The response describing the resolved entities found from a search. Ref: #/components/schemas/SzAttributeSearchResponse

func (SearchEntitiesByGetOKDefault) Read 

func (s SearchEntitiesByGetOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type SearchEntitiesByGetParams 

type SearchEntitiesByGetParams struct {
	// The JSON record describing the entity attributes in the same
	// format as how an entity record is loaded.  The specified
	// attributes are treated as a hypothetical record being loaded,
	// and the result is anything that would have matched or related
	// to it.  Here are some examples of encoding this parameter:
	// - **JavaScript Example**
	// “`javascript
	// var searchCriteria = {
	// "NAME_FULL": "Joe Schmoe",
	// "DATE_OF_BIRTH": "03-SEP-1987"
	// };
	// var searchAttrs = JSON.stringify(searchCriteria);
	// var urlPath = "/entities?attrs=" + encodeURIComponent(searchAttrs);
	// “`
	// - **Java Example**
	// “`java
	// JsonObjectBuilder builder = Json.createObjectBuilder();
	// builder.add("NAME_FULL", "Joe Schmoe");
	// builder.add("DATE_OF_BIRTH", "03-SEP-1987");
	// JsonObject searchCriteria = builder.build();
	// String searchAttrs = searchCriteria.toString();
	// String encodedAttrs = URLEncoder.encode(searchAttrs, "UTF-8");
	// String urlPath = "/entities?attrs=" + encodedAttrs;
	// “`
	// In both of the above examples the `urlPath` variable is set to:
	// “`json
	// /entities?attrs=%7B%22NAME_FULL%22%3A%22Joe%20Schmoe%22%2C%22DATE_OF_BIRTH%22%3A%2203-SEP-1987%22%7D
	// “`.
	Attrs OptString
	// Either the `attrs` or `attr` parameter is required, **however** if the `attrs` parameter is
	// provided it takes precedence and the `attr` parameter will be ignored.  If you are using this API
	// programmatically then you should typically use the `attrs` parameter.  But when manually
	// constructing a URL in the browser address bar, in a command-line tool like `curl` or in a REST
	// client browser extension for debugging or testing purposes, encoding that JSON value can be
	// unwieldy.  This parameter (which is multi-valued) lets you specify colon-delimited strings that
	// are prefixed with the JSON property name and suffixed with the value.  For example,
	// `NAME_FIRST:Joe` (url encoded of course).  This side-steps the need to URL-encode the structural
	// JSON characters and usually means you need only URL-encode basic characters like colons (`%3A`)
	// and spaces (`%20`).  The JSON constructed using this parameter is obviously flat.  If you want to
	// group properties together by their "usage type" (e.g.: `NAME_TYPE`, `PHONE_TYPE` or
	// `ADDRESS_TYPE`) then you would **also** prefix with the type (e.g.:
	// `HOME_PHONE_NUMBER:702-555-1212`).
	Attr []string
	// Optional parameter that can be specified zero or more times to indicate which
	// `SzAttributeSearchResultType`'s should be included in the search results.  If not specified then
	// all match types are included.  *NOTE*: This parameter is ignored unless the underlying native
	// Senzing API is version 2.4.1 or later.
	IncludeOnly []SzAttributeSearchResultType
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Set to `true` to include resolution statistics for features.  This defaults to `false`.
	WithFeatureStats OptBool
	// Set to `true` to include "expressed" features that are derived composite keys such as name + date
	// of birth keys.  This defaults to `false`.
	WithInternalFeatures OptBool
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Set to `true` to include partial information of related entities for the returned entities.  This
	// defaults to `false`.
	WithRelationships OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

SearchEntitiesByGetParams is parameters of searchEntitiesByGet operation.

type SearchEntitiesByGetRes 

type SearchEntitiesByGetRes interface {
	// contains filtered or unexported methods
}

type SearchEntitiesByPostApplicationJSONBadRequest 

type SearchEntitiesByPostApplicationJSONBadRequest SzErrorResponse

func (*SearchEntitiesByPostApplicationJSONBadRequest) Decode 

func (s *SearchEntitiesByPostApplicationJSONBadRequest) Decode(d *jx.Decoder) error

Decode decodes SearchEntitiesByPostApplicationJSONBadRequest from json.

func (*SearchEntitiesByPostApplicationJSONBadRequest) Encode 

func (s *SearchEntitiesByPostApplicationJSONBadRequest) Encode(e *jx.Encoder)

Encode encodes SearchEntitiesByPostApplicationJSONBadRequest as json.

func (*SearchEntitiesByPostApplicationJSONBadRequest) MarshalJSON 

func (s *SearchEntitiesByPostApplicationJSONBadRequest) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEntitiesByPostApplicationJSONBadRequest) UnmarshalJSON 

func (s *SearchEntitiesByPostApplicationJSONBadRequest) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SearchEntitiesByPostApplicationJSONBadRequest) Validate 

func (s *SearchEntitiesByPostApplicationJSONBadRequest) Validate() error

type SearchEntitiesByPostApplicationJSONInternalServerError 

type SearchEntitiesByPostApplicationJSONInternalServerError SzErrorResponse

func (*SearchEntitiesByPostApplicationJSONInternalServerError) Decode 

func (s *SearchEntitiesByPostApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes SearchEntitiesByPostApplicationJSONInternalServerError from json.

func (*SearchEntitiesByPostApplicationJSONInternalServerError) Encode 

func (s *SearchEntitiesByPostApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes SearchEntitiesByPostApplicationJSONInternalServerError as json.

func (*SearchEntitiesByPostApplicationJSONInternalServerError) MarshalJSON 

func (s *SearchEntitiesByPostApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEntitiesByPostApplicationJSONInternalServerError) UnmarshalJSON 

func (s *SearchEntitiesByPostApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SearchEntitiesByPostApplicationJSONInternalServerError) Validate 

func (s *SearchEntitiesByPostApplicationJSONInternalServerError) Validate() error

type SearchEntitiesByPostBadRequestDefault 

type SearchEntitiesByPostBadRequestDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (SearchEntitiesByPostBadRequestDefault) Read 

func (s SearchEntitiesByPostBadRequestDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type SearchEntitiesByPostOKDefault 

type SearchEntitiesByPostOKDefault struct {
	Data io.Reader
}

The response describing the resolved entities found from a search. Ref: #/components/schemas/SzAttributeSearchResponse

func (SearchEntitiesByPostOKDefault) Read 

func (s SearchEntitiesByPostOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type SearchEntitiesByPostParams 

type SearchEntitiesByPostParams struct {
	// Optional parameter that can be specified zero or more times to indicate which
	// `SzAttributeSearchResultType`'s should be included in the search results.  If not specified then
	// all match types are included.  *NOTE*: This parameter is ignored unless the underlying native
	// Senzing API is version 2.4.1 or later.
	IncludeOnly []SzAttributeSearchResultType
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Set to `true` to include resolution statistics for features.  This defaults to `false`.
	WithFeatureStats OptBool
	// Set to `true` to include "expressed" features that are derived composite keys such as name + date
	// of birth keys.  This defaults to `false`.
	WithInternalFeatures OptBool
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Set to `true` to include partial information of related entities for the returned entities.  This
	// defaults to `false`.
	WithRelationships OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

SearchEntitiesByPostParams is parameters of searchEntitiesByPost operation.

type SearchEntitiesByPostReq 

type SearchEntitiesByPostReq map[string]jx.Raw

func (*SearchEntitiesByPostReq) Decode 

func (s *SearchEntitiesByPostReq) Decode(d *jx.Decoder) error

Decode decodes SearchEntitiesByPostReq from json.

func (SearchEntitiesByPostReq) Encode 

func (s SearchEntitiesByPostReq) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SearchEntitiesByPostReq) MarshalJSON 

func (s SearchEntitiesByPostReq) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SearchEntitiesByPostReq) UnmarshalJSON 

func (s *SearchEntitiesByPostReq) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SearchEntitiesByPostRes 

type SearchEntitiesByPostRes interface {
	// contains filtered or unexported methods
}

type Server 

type Server struct {
	// contains filtered or unexported fields
}

Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.

func NewServer 

func NewServer(h Handler, opts ...ServerOption) (*Server, error)

NewServer creates new Server.

func (*Server) FindPath 

func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)

FindPath finds Route for given method and URL.

func (*Server) FindRoute 

func (s *Server) FindRoute(method, path string) (Route, bool)

FindRoute finds Route for given method and path.

Note: this method does not unescape path or handle reserved characters in path properly. Use FindPath instead.

func (*Server) ServeHTTP 

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves http request as defined by OpenAPI v3 specification, calling handler that matches the path or returning not found error.

type ServerErrorDefault 

type ServerErrorDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (ServerErrorDefault) Read 

func (s ServerErrorDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type ServerOption 

type ServerOption interface {
	// contains filtered or unexported methods
}

ServerOption is server config option.

func WithErrorHandler 

func WithErrorHandler(h ErrorHandler) ServerOption

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory 

func WithMaxMultipartMemory(max int64) ServerOption

WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.

func WithMethodNotAllowed 

func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithMiddleware 

func WithMiddleware(m ...Middleware) ServerOption

WithMiddleware specifies middlewares to use.

func WithNotFound 

func WithNotFound(notFound http.HandlerFunc) ServerOption

WithNotFound specifies Not Found handler to use.

func WithPathPrefix 

func WithPathPrefix(prefix string) ServerOption

WithPathPrefix specifies server path prefix.

type SzAttributeClass 

type SzAttributeClass string

Enumerates the various classes of attribute types (and features). This is a generalization over attribute type that is more general than feature type (NOTE: stand-alone attribute types such as "DATA_SOURCE" or "RECORD_ID" do not have a feature type, but do have an attribute class of "OBSERVATION"). Attribute class determines how attributes / features are grouped together (e.g.: "nameData" contains all name features and "identifierData" contains all identifier features). The possible values are: * `ADDRESS` - Attributes pertaining to an address such as "POSTAL_CODE" * `CHARACTERISTIC` - Attributes pertaining to physical characteristics of an entity. Such as "BIRTH_DATE" * `IDENTIFIER` - Attributes pertaining to identifiers such as drivers license number, passport number, or email address. * `NAME` - Attributes pertaing to names such as "NAME_FIRST" or "NAME_LAST" * `OBSERVATION` - Attributes pertaining to meta-data about the observation (record) such as "RECORD_ID" or "DATA_SOURCE" * `PHONE` - Attributes pertaining to phone numbers such "PHONE_NUMBER" or "PHONE_EXTENSION" * `RELATIONSHIP` - Attributes pertaining to relationships such as "RELATIONSHIP_TYPE". * `OTHER` - An attribute class for custom features or for attributes that are loaded but not mapped. Ref: #/components/schemas/SzAttributeClass 

const (
	SzAttributeClassADDRESS        SzAttributeClass = "ADDRESS"
	SzAttributeClassCHARACTERISTIC SzAttributeClass = "CHARACTERISTIC"
	SzAttributeClassIDENTIFIER     SzAttributeClass = "IDENTIFIER"
	SzAttributeClassNAME           SzAttributeClass = "NAME"
	SzAttributeClassOBSERVATION    SzAttributeClass = "OBSERVATION"
	SzAttributeClassPHONE          SzAttributeClass = "PHONE"
	SzAttributeClassRELATIONSHIP   SzAttributeClass = "RELATIONSHIP"
	SzAttributeClassOTHER          SzAttributeClass = "OTHER"
)

func (SzAttributeClass) AllValues added in v0.9.0 

func (SzAttributeClass) AllValues() []SzAttributeClass

AllValues returns all SzAttributeClass values.

func (*SzAttributeClass) Decode 

func (s *SzAttributeClass) Decode(d *jx.Decoder) error

Decode decodes SzAttributeClass from json.

func (SzAttributeClass) Encode 

func (s SzAttributeClass) Encode(e *jx.Encoder)

Encode encodes SzAttributeClass as json.

func (SzAttributeClass) MarshalJSON 

func (s SzAttributeClass) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzAttributeClass) MarshalText 

func (s SzAttributeClass) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzAttributeClass) UnmarshalJSON 

func (s *SzAttributeClass) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeClass) UnmarshalText 

func (s *SzAttributeClass) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzAttributeClass) Validate 

func (s SzAttributeClass) Validate() error

type SzAttributeNecessity 

type SzAttributeNecessity string

Describes the necessity for this attribute type within the feature type. Possible values are: * `REQUIRED` - The attribute for the attribute type must be provided whenever the feature is provided (e.g.: "PASSPORT_NUMBER" is required with the "PASSPORT" feature). * `SUFFICIENT` - If no attributes for `REQUIRED` attribute types are provided for the feature, then at least one marked `SUFFICIENT` must be provided (e.g.: "NAME_FULL" or "NAME_ORG" for the "NAME" feature) * `PREFERRED` - Attributes of `PREFERRED` attribute types are optional, but providing them greatly enhances accuracy for scoring and matching purposes (e.g.: a "PASSPORT_COUNTRY" for "PASSPORT" feature) * `OPTIONAL` - Attributes of `OPTIONAL` attribute types are optional and do not significantly affect accuracy for scoring and matching purposes, but do provide additional information (e.g.: "PASSPORT_ISSUE_DT" for the "PASSPORT" feature). Ref: #/components/schemas/SzAttributeNecessity 

const (
	SzAttributeNecessityREQUIRED   SzAttributeNecessity = "REQUIRED"
	SzAttributeNecessitySUFFICIENT SzAttributeNecessity = "SUFFICIENT"
	SzAttributeNecessityPREFERRED  SzAttributeNecessity = "PREFERRED"
	SzAttributeNecessityOPTIONAL   SzAttributeNecessity = "OPTIONAL"
)

func (SzAttributeNecessity) AllValues added in v0.9.0 

func (SzAttributeNecessity) AllValues() []SzAttributeNecessity

AllValues returns all SzAttributeNecessity values.

func (*SzAttributeNecessity) Decode 

func (s *SzAttributeNecessity) Decode(d *jx.Decoder) error

Decode decodes SzAttributeNecessity from json.

func (SzAttributeNecessity) Encode 

func (s SzAttributeNecessity) Encode(e *jx.Encoder)

Encode encodes SzAttributeNecessity as json.

func (SzAttributeNecessity) MarshalJSON 

func (s SzAttributeNecessity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzAttributeNecessity) MarshalText 

func (s SzAttributeNecessity) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzAttributeNecessity) UnmarshalJSON 

func (s *SzAttributeNecessity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeNecessity) UnmarshalText 

func (s *SzAttributeNecessity) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzAttributeNecessity) Validate 

func (s SzAttributeNecessity) Validate() error

type SzAttributeSearchResponse 

type SzAttributeSearchResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzAttributeSearchResponseRawData `json:"rawData"`
	Data    OptSzAttributeSearchResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzAttributeSearchResponse

func (*SzAttributeSearchResponse) Decode 

func (s *SzAttributeSearchResponse) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResponse from json.

func (*SzAttributeSearchResponse) Encode 

func (s *SzAttributeSearchResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzAttributeSearchResponse) GetData 

func (s *SzAttributeSearchResponse) GetData() OptSzAttributeSearchResponseData

GetData returns the value of Data. 

func (s *SzAttributeSearchResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzAttributeSearchResponse) GetMeta 

func (s *SzAttributeSearchResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzAttributeSearchResponse) GetRawData 

func (s *SzAttributeSearchResponse) GetRawData() OptNilSzAttributeSearchResponseRawData

GetRawData returns the value of RawData.

func (*SzAttributeSearchResponse) MarshalJSON 

func (s *SzAttributeSearchResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeSearchResponse) SetData 

func (s *SzAttributeSearchResponse) SetData(val OptSzAttributeSearchResponseData)

SetData sets the value of Data. 

func (s *SzAttributeSearchResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzAttributeSearchResponse) SetMeta 

func (s *SzAttributeSearchResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzAttributeSearchResponse) SetRawData 

func (s *SzAttributeSearchResponse) SetRawData(val OptNilSzAttributeSearchResponseRawData)

SetRawData sets the value of RawData.

func (*SzAttributeSearchResponse) UnmarshalJSON 

func (s *SzAttributeSearchResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeSearchResponse) Validate 

func (s *SzAttributeSearchResponse) Validate() error

type SzAttributeSearchResponseData 

type SzAttributeSearchResponseData struct {
	// The array of `AttributeSearchResult` instances describing the entities matching the specified
	// entity search attributes including the `AttributeSearchResultType` for each.
	SearchResults []SzAttributeSearchResult `json:"searchResults"`
}

Describes the data segment of the `SzAttributeSearchResponse`. Ref: #/components/schemas/SzAttributeSearchResponseData

func (*SzAttributeSearchResponseData) Decode 

func (s *SzAttributeSearchResponseData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResponseData from json.

func (*SzAttributeSearchResponseData) Encode 

func (s *SzAttributeSearchResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzAttributeSearchResponseData) GetSearchResults 

func (s *SzAttributeSearchResponseData) GetSearchResults() []SzAttributeSearchResult

GetSearchResults returns the value of SearchResults.

func (*SzAttributeSearchResponseData) MarshalJSON 

func (s *SzAttributeSearchResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeSearchResponseData) SetSearchResults 

func (s *SzAttributeSearchResponseData) SetSearchResults(val []SzAttributeSearchResult)

SetSearchResults sets the value of SearchResults.

func (*SzAttributeSearchResponseData) UnmarshalJSON 

func (s *SzAttributeSearchResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeSearchResponseData) Validate 

func (s *SzAttributeSearchResponseData) Validate() error

type SzAttributeSearchResponseRawData 

type SzAttributeSearchResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzAttributeSearchResponseRawData) Decode 

func (s *SzAttributeSearchResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResponseRawData from json.

func (SzAttributeSearchResponseRawData) Encode 

func (s SzAttributeSearchResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzAttributeSearchResponseRawData) MarshalJSON 

func (s SzAttributeSearchResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeSearchResponseRawData) UnmarshalJSON 

func (s *SzAttributeSearchResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzAttributeSearchResult 

type SzAttributeSearchResult struct {
	// The unique numeric ID identifying the entity.
	EntityId OptInt64 `json:"entityId"`
	// The name associated with this entity that is considered the best name among all the associated
	// names.
	EntityName OptString `json:"entityName"`
	// Usually the same as the entityName property, but this may differ if the entity was found based on
	// a name search.  In such a case, this field represents the name that most closely matches the name
	// that was searched on.
	BestName OptString `json:"bestName"`
	// The array of DataSourceRecordSummary instances describing the number of records associated with
	// each data source that contributes to this entity.
	RecordSummaries []SzDataSourceRecordSummary `json:"recordSummaries"`
	// An array of names associated with the entity that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "Joe Schmoe" or "AKA: Joseph P. Schmoe").
	NameData []string `json:"nameData"`
	// An array of characteristics associated with the entity that are formatted for readability.  These
	// will be prefixed by a characteristic type and optionally by a "usage type" if one was provided.
	// **NOTE:** The `characteristicData` field is derived from the feature data values that contribute
	// to the `ATTRIBUTE_DATA` field at the record level in the "raw data" JSON.
	CharacteristicData []string `json:"characteristicData"`
	// An array of addresses associated with the entity that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "HOME: 101 Main Street").
	AddressData []string `json:"addressData"`
	// An array of phone numbers associated with the entity that are formatted for readability.  These
	// may be prefixed by a "usage type" if one was provided (e.g.: "HOME: 702-555-1212").
	PhoneData []string `json:"phoneData"`
	// An array of entity data associated with the entity where the items are formatted for readability.
	// These will be prefixed by an identifier type and may be prefixed by a "usage type" if one was
	// provided (e.g.: "ID: 123456789" or "EMAIL: WORK: joe@nowhere.com").
	IdentifierData []string `json:"identifierData"`
	// An array of relationship data items associated with the entity that describes disclosed
	// relationships.
	RelationshipData []string `json:"relationshipData"`
	// An array of associated data items that were loaded with the entity's records but not normally
	// recognized or used for entity resolution. This array usually contains useful information from the
	// source systems.
	OtherData []string `json:"otherData"`
	// The array of `SzMatchedRecord` instances describing the records associated with this entity.
	Records []SzMatchedRecord `json:"records"`
	// The map of string feature names to arrays of SzEntityFeature instances describing the values
	// associated with each respective feature name.
	Features OptSzAttributeSearchResultFeatures `json:"features"`
	// If true then this `SzResolvedEntity` has complete features and records, otherwise they are not
	// provided.  Also, the recordSummary items may be missing the topRecordIds if partial is true.  This
	// can be true for partially retrieved related entities or if features are suppressed, if the detail
	// level has suppressed records or related matching info (in the case of related entities) or if the
	// force-minimal response flag has been been specified.
	Partial OptBool `json:"partial"`
	// The timestamp that the entity was last seen (i.e.: most recent record was loaded).
	LastSeenTimestamp OptDateTime `json:"lastSeenTimestamp"`
	// The integer "match level" describing how the related entity matched to the primary resolved entity.
	MatchLevel OptInt32 `json:"matchLevel"`
	// The match key describing what features matched between the primary resolved entity and the related
	// entity.
	MatchKey OptString `json:"matchKey"`
	// The code identifying the resolution rule that related this entity to the primary resolved entity.
	ResolutionRuleCode OptString                      `json:"resolutionRuleCode"`
	ResultType         OptSzAttributeSearchResultType `json:"resultType"`
	// The best name score between the search criteria and this matched search entity.  The higher the
	// score the closer the name match.  This uses either the full name score or organization name score.
	//  If none exist then this filed is omitted.
	BestNameScore OptInt32 `json:"bestNameScore"`
	// The map of feature types to arrays of `SzSearchFeatureScore` instances for that feature type.
	FeatureScores OptNilSzAttributeSearchResultFeatureScores `json:"featureScores"`
	// The array of RelatedEntity instances describing the possible matches, discovered relationships,
	// and disclosed relationships.
	RelatedEntities []SzRelatedEntity `json:"relatedEntities"`
}

Merged schema. Ref: #/components/schemas/SzAttributeSearchResult

func (*SzAttributeSearchResult) Decode 

func (s *SzAttributeSearchResult) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResult from json.

func (*SzAttributeSearchResult) Encode 

func (s *SzAttributeSearchResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzAttributeSearchResult) GetAddressData 

func (s *SzAttributeSearchResult) GetAddressData() []string

GetAddressData returns the value of AddressData.

func (*SzAttributeSearchResult) GetBestName 

func (s *SzAttributeSearchResult) GetBestName() OptString

GetBestName returns the value of BestName.

func (*SzAttributeSearchResult) GetBestNameScore 

func (s *SzAttributeSearchResult) GetBestNameScore() OptInt32

GetBestNameScore returns the value of BestNameScore.

func (*SzAttributeSearchResult) GetCharacteristicData 

func (s *SzAttributeSearchResult) GetCharacteristicData() []string

GetCharacteristicData returns the value of CharacteristicData.

func (*SzAttributeSearchResult) GetEntityId 

func (s *SzAttributeSearchResult) GetEntityId() OptInt64

GetEntityId returns the value of EntityId.

func (*SzAttributeSearchResult) GetEntityName 

func (s *SzAttributeSearchResult) GetEntityName() OptString

GetEntityName returns the value of EntityName.

func (*SzAttributeSearchResult) GetFeatureScores 

func (s *SzAttributeSearchResult) GetFeatureScores() OptNilSzAttributeSearchResultFeatureScores

GetFeatureScores returns the value of FeatureScores.

func (*SzAttributeSearchResult) GetFeatures 

func (s *SzAttributeSearchResult) GetFeatures() OptSzAttributeSearchResultFeatures

GetFeatures returns the value of Features.

func (*SzAttributeSearchResult) GetIdentifierData 

func (s *SzAttributeSearchResult) GetIdentifierData() []string

GetIdentifierData returns the value of IdentifierData.

func (*SzAttributeSearchResult) GetLastSeenTimestamp 

func (s *SzAttributeSearchResult) GetLastSeenTimestamp() OptDateTime

GetLastSeenTimestamp returns the value of LastSeenTimestamp.

func (*SzAttributeSearchResult) GetMatchKey 

func (s *SzAttributeSearchResult) GetMatchKey() OptString

GetMatchKey returns the value of MatchKey.

func (*SzAttributeSearchResult) GetMatchLevel 

func (s *SzAttributeSearchResult) GetMatchLevel() OptInt32

GetMatchLevel returns the value of MatchLevel.

func (*SzAttributeSearchResult) GetNameData 

func (s *SzAttributeSearchResult) GetNameData() []string

GetNameData returns the value of NameData.

func (*SzAttributeSearchResult) GetOtherData 

func (s *SzAttributeSearchResult) GetOtherData() []string

GetOtherData returns the value of OtherData.

func (*SzAttributeSearchResult) GetPartial 

func (s *SzAttributeSearchResult) GetPartial() OptBool

GetPartial returns the value of Partial.

func (*SzAttributeSearchResult) GetPhoneData 

func (s *SzAttributeSearchResult) GetPhoneData() []string

GetPhoneData returns the value of PhoneData.

func (*SzAttributeSearchResult) GetRecordSummaries 

func (s *SzAttributeSearchResult) GetRecordSummaries() []SzDataSourceRecordSummary

GetRecordSummaries returns the value of RecordSummaries.

func (*SzAttributeSearchResult) GetRecords 

func (s *SzAttributeSearchResult) GetRecords() []SzMatchedRecord

GetRecords returns the value of Records.

func (*SzAttributeSearchResult) GetRelatedEntities 

func (s *SzAttributeSearchResult) GetRelatedEntities() []SzRelatedEntity

GetRelatedEntities returns the value of RelatedEntities.

func (*SzAttributeSearchResult) GetRelationshipData 

func (s *SzAttributeSearchResult) GetRelationshipData() []string

GetRelationshipData returns the value of RelationshipData.

func (*SzAttributeSearchResult) GetResolutionRuleCode 

func (s *SzAttributeSearchResult) GetResolutionRuleCode() OptString

GetResolutionRuleCode returns the value of ResolutionRuleCode.

func (*SzAttributeSearchResult) GetResultType 

func (s *SzAttributeSearchResult) GetResultType() OptSzAttributeSearchResultType

GetResultType returns the value of ResultType.

func (*SzAttributeSearchResult) MarshalJSON 

func (s *SzAttributeSearchResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeSearchResult) SetAddressData 

func (s *SzAttributeSearchResult) SetAddressData(val []string)

SetAddressData sets the value of AddressData.

func (*SzAttributeSearchResult) SetBestName 

func (s *SzAttributeSearchResult) SetBestName(val OptString)

SetBestName sets the value of BestName.

func (*SzAttributeSearchResult) SetBestNameScore 

func (s *SzAttributeSearchResult) SetBestNameScore(val OptInt32)

SetBestNameScore sets the value of BestNameScore.

func (*SzAttributeSearchResult) SetCharacteristicData 

func (s *SzAttributeSearchResult) SetCharacteristicData(val []string)

SetCharacteristicData sets the value of CharacteristicData.

func (*SzAttributeSearchResult) SetEntityId 

func (s *SzAttributeSearchResult) SetEntityId(val OptInt64)

SetEntityId sets the value of EntityId.

func (*SzAttributeSearchResult) SetEntityName 

func (s *SzAttributeSearchResult) SetEntityName(val OptString)

SetEntityName sets the value of EntityName.

func (*SzAttributeSearchResult) SetFeatureScores 

func (s *SzAttributeSearchResult) SetFeatureScores(val OptNilSzAttributeSearchResultFeatureScores)

SetFeatureScores sets the value of FeatureScores.

func (*SzAttributeSearchResult) SetFeatures 

func (s *SzAttributeSearchResult) SetFeatures(val OptSzAttributeSearchResultFeatures)

SetFeatures sets the value of Features.

func (*SzAttributeSearchResult) SetIdentifierData 

func (s *SzAttributeSearchResult) SetIdentifierData(val []string)

SetIdentifierData sets the value of IdentifierData.

func (*SzAttributeSearchResult) SetLastSeenTimestamp 

func (s *SzAttributeSearchResult) SetLastSeenTimestamp(val OptDateTime)

SetLastSeenTimestamp sets the value of LastSeenTimestamp.

func (*SzAttributeSearchResult) SetMatchKey 

func (s *SzAttributeSearchResult) SetMatchKey(val OptString)

SetMatchKey sets the value of MatchKey.

func (*SzAttributeSearchResult) SetMatchLevel 

func (s *SzAttributeSearchResult) SetMatchLevel(val OptInt32)

SetMatchLevel sets the value of MatchLevel.

func (*SzAttributeSearchResult) SetNameData 

func (s *SzAttributeSearchResult) SetNameData(val []string)

SetNameData sets the value of NameData.

func (*SzAttributeSearchResult) SetOtherData 

func (s *SzAttributeSearchResult) SetOtherData(val []string)

SetOtherData sets the value of OtherData.

func (*SzAttributeSearchResult) SetPartial 

func (s *SzAttributeSearchResult) SetPartial(val OptBool)

SetPartial sets the value of Partial.

func (*SzAttributeSearchResult) SetPhoneData 

func (s *SzAttributeSearchResult) SetPhoneData(val []string)

SetPhoneData sets the value of PhoneData.

func (*SzAttributeSearchResult) SetRecordSummaries 

func (s *SzAttributeSearchResult) SetRecordSummaries(val []SzDataSourceRecordSummary)

SetRecordSummaries sets the value of RecordSummaries.

func (*SzAttributeSearchResult) SetRecords 

func (s *SzAttributeSearchResult) SetRecords(val []SzMatchedRecord)

SetRecords sets the value of Records.

func (*SzAttributeSearchResult) SetRelatedEntities 

func (s *SzAttributeSearchResult) SetRelatedEntities(val []SzRelatedEntity)

SetRelatedEntities sets the value of RelatedEntities.

func (*SzAttributeSearchResult) SetRelationshipData 

func (s *SzAttributeSearchResult) SetRelationshipData(val []string)

SetRelationshipData sets the value of RelationshipData.

func (*SzAttributeSearchResult) SetResolutionRuleCode 

func (s *SzAttributeSearchResult) SetResolutionRuleCode(val OptString)

SetResolutionRuleCode sets the value of ResolutionRuleCode.

func (*SzAttributeSearchResult) SetResultType 

func (s *SzAttributeSearchResult) SetResultType(val OptSzAttributeSearchResultType)

SetResultType sets the value of ResultType.

func (*SzAttributeSearchResult) UnmarshalJSON 

func (s *SzAttributeSearchResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeSearchResult) Validate 

func (s *SzAttributeSearchResult) Validate() error

type SzAttributeSearchResultFeatureScores 

type SzAttributeSearchResultFeatureScores map[string][]SzSearchFeatureScore

The map of feature types to arrays of `SzSearchFeatureScore` instances for that feature type.

func (*SzAttributeSearchResultFeatureScores) Decode 

func (s *SzAttributeSearchResultFeatureScores) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResultFeatureScores from json.

func (SzAttributeSearchResultFeatureScores) Encode 

func (s SzAttributeSearchResultFeatureScores) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzAttributeSearchResultFeatureScores) MarshalJSON 

func (s SzAttributeSearchResultFeatureScores) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeSearchResultFeatureScores) UnmarshalJSON 

func (s *SzAttributeSearchResultFeatureScores) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SzAttributeSearchResultFeatureScores) Validate 

func (s SzAttributeSearchResultFeatureScores) Validate() error

type SzAttributeSearchResultFeatures 

type SzAttributeSearchResultFeatures map[string][]SzEntityFeature

The map of string feature names to arrays of SzEntityFeature instances describing the values associated with each respective feature name.

func (*SzAttributeSearchResultFeatures) Decode 

func (s *SzAttributeSearchResultFeatures) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResultFeatures from json.

func (SzAttributeSearchResultFeatures) Encode 

func (s SzAttributeSearchResultFeatures) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzAttributeSearchResultFeatures) MarshalJSON 

func (s SzAttributeSearchResultFeatures) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeSearchResultFeatures) UnmarshalJSON 

func (s *SzAttributeSearchResultFeatures) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SzAttributeSearchResultFeatures) Validate 

func (s SzAttributeSearchResultFeatures) Validate() error

type SzAttributeSearchResultType 

type SzAttributeSearchResultType string

Describes how the entity matching the search attributes would have entity resolved against those attributes (either a match, possible match, discovered relationship or name only match). The possible values are: * `MATCH` - The search criteria matches the entity and would resolve against it. * `POSSIBLE_MATCH` - The search criteria comes close to matching the entity but not close enough that it would resolve against it. * `POSSIBLE_RELATION` - The search criteria would not match against the entity but some features are the same and relate them. * `NAME_ONLY_MATCH` - The search criteria matches the entity in name only which is not strong enough for a relationship, but provides for a weak search match. Ref: #/components/schemas/SzAttributeSearchResultType 

const (
	SzAttributeSearchResultTypeMATCH            SzAttributeSearchResultType = "MATCH"
	SzAttributeSearchResultTypePOSSIBLEMATCH    SzAttributeSearchResultType = "POSSIBLE_MATCH"
	SzAttributeSearchResultTypePOSSIBLERELATION SzAttributeSearchResultType = "POSSIBLE_RELATION"
	SzAttributeSearchResultTypeNAMEONLYMATCH    SzAttributeSearchResultType = "NAME_ONLY_MATCH"
)

func (SzAttributeSearchResultType) AllValues added in v0.9.0 

func (SzAttributeSearchResultType) AllValues() []SzAttributeSearchResultType

AllValues returns all SzAttributeSearchResultType values.

func (*SzAttributeSearchResultType) Decode 

func (s *SzAttributeSearchResultType) Decode(d *jx.Decoder) error

Decode decodes SzAttributeSearchResultType from json.

func (SzAttributeSearchResultType) Encode 

func (s SzAttributeSearchResultType) Encode(e *jx.Encoder)

Encode encodes SzAttributeSearchResultType as json.

func (SzAttributeSearchResultType) MarshalJSON 

func (s SzAttributeSearchResultType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzAttributeSearchResultType) MarshalText 

func (s SzAttributeSearchResultType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzAttributeSearchResultType) UnmarshalJSON 

func (s *SzAttributeSearchResultType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeSearchResultType) UnmarshalText 

func (s *SzAttributeSearchResultType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzAttributeSearchResultType) Validate 

func (s SzAttributeSearchResultType) Validate() error

type SzAttributeType 

type SzAttributeType struct {
	// The unique string that identifies the attribute type among all other attribute types.
	AttributeCode OptString `json:"attributeCode"`
	// The default value assumed for the attribute when it is not provided but is required as part of a
	// feature.
	DefaultValue   OptNilString            `json:"defaultValue"`
	Necessity      OptSzAttributeNecessity `json:"necessity"`
	AttributeClass OptSzAttributeClass     `json:"attributeClass"`
	// Identifiers the feature type that this attribute type is an attribute of (if any).  For example,
	// the "NAME_FIRST" attribute type would be an attribute of the "NAME" feature type and
	// "PASSPORT_COUNTRY" would be an attribute of "PASSPORT" feature type. Some (advanced) attribute
	// types are stand-alone and do not belong to a feature (e.g.: "RECORD_ID").
	FeatureType OptNilString `json:"featureType"`
	// Indicates if the attribute type is considered to be "advanced". Advanced attribute types usually
	// require the user to have some knowledge of how the data is mapped in the entity repository (e.g.:
	// "RECORD_ID" or "DATA_SOURCE").  An application may exclude displaying these as options if these
	// things are being auto-generated or automatically selected for the user.  You may want to contact
	// Senzing support before leveraging advanced attribute types in your application.
	Advanced OptBool `json:"advanced"`
	// Whether or not an attribute type is typically generated internally based on other attribute types.
	//  These are not commonly used by the user except in some rare cases.  Examples include pre-hashed
	// versions of attributes that are hashed.
	Internal OptBool `json:"internal"`
}

Describes an attribute type that partially (or fully) describes a feature of an entity that may be loaded as part of a record or used as criteria in a search. Ref: #/components/schemas/SzAttributeType

func (*SzAttributeType) Decode 

func (s *SzAttributeType) Decode(d *jx.Decoder) error

Decode decodes SzAttributeType from json.

func (*SzAttributeType) Encode 

func (s *SzAttributeType) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzAttributeType) GetAdvanced 

func (s *SzAttributeType) GetAdvanced() OptBool

GetAdvanced returns the value of Advanced.

func (*SzAttributeType) GetAttributeClass 

func (s *SzAttributeType) GetAttributeClass() OptSzAttributeClass

GetAttributeClass returns the value of AttributeClass.

func (*SzAttributeType) GetAttributeCode 

func (s *SzAttributeType) GetAttributeCode() OptString

GetAttributeCode returns the value of AttributeCode.

func (*SzAttributeType) GetDefaultValue 

func (s *SzAttributeType) GetDefaultValue() OptNilString

GetDefaultValue returns the value of DefaultValue.

func (*SzAttributeType) GetFeatureType 

func (s *SzAttributeType) GetFeatureType() OptNilString

GetFeatureType returns the value of FeatureType.

func (*SzAttributeType) GetInternal 

func (s *SzAttributeType) GetInternal() OptBool

GetInternal returns the value of Internal.

func (*SzAttributeType) GetNecessity 

func (s *SzAttributeType) GetNecessity() OptSzAttributeNecessity

GetNecessity returns the value of Necessity.

func (*SzAttributeType) MarshalJSON 

func (s *SzAttributeType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeType) SetAdvanced 

func (s *SzAttributeType) SetAdvanced(val OptBool)

SetAdvanced sets the value of Advanced.

func (*SzAttributeType) SetAttributeClass 

func (s *SzAttributeType) SetAttributeClass(val OptSzAttributeClass)

SetAttributeClass sets the value of AttributeClass.

func (*SzAttributeType) SetAttributeCode 

func (s *SzAttributeType) SetAttributeCode(val OptString)

SetAttributeCode sets the value of AttributeCode.

func (*SzAttributeType) SetDefaultValue 

func (s *SzAttributeType) SetDefaultValue(val OptNilString)

SetDefaultValue sets the value of DefaultValue.

func (*SzAttributeType) SetFeatureType 

func (s *SzAttributeType) SetFeatureType(val OptNilString)

SetFeatureType sets the value of FeatureType.

func (*SzAttributeType) SetInternal 

func (s *SzAttributeType) SetInternal(val OptBool)

SetInternal sets the value of Internal.

func (*SzAttributeType) SetNecessity 

func (s *SzAttributeType) SetNecessity(val OptSzAttributeNecessity)

SetNecessity sets the value of Necessity.

func (*SzAttributeType) UnmarshalJSON 

func (s *SzAttributeType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeType) Validate 

func (s *SzAttributeType) Validate() error

type SzAttributeTypeResponse 

type SzAttributeTypeResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzAttributeTypeResponseRawData `json:"rawData"`
	Data    OptSzAttributeTypeResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzAttributeTypeResponse

func (*SzAttributeTypeResponse) Decode 

func (s *SzAttributeTypeResponse) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypeResponse from json.

func (*SzAttributeTypeResponse) Encode 

func (s *SzAttributeTypeResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzAttributeTypeResponse) GetData 

func (s *SzAttributeTypeResponse) GetData() OptSzAttributeTypeResponseData

GetData returns the value of Data. 

func (s *SzAttributeTypeResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzAttributeTypeResponse) GetMeta 

func (s *SzAttributeTypeResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzAttributeTypeResponse) GetRawData 

func (s *SzAttributeTypeResponse) GetRawData() OptNilSzAttributeTypeResponseRawData

GetRawData returns the value of RawData.

func (*SzAttributeTypeResponse) MarshalJSON 

func (s *SzAttributeTypeResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeTypeResponse) SetData 

func (s *SzAttributeTypeResponse) SetData(val OptSzAttributeTypeResponseData)

SetData sets the value of Data. 

func (s *SzAttributeTypeResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzAttributeTypeResponse) SetMeta 

func (s *SzAttributeTypeResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzAttributeTypeResponse) SetRawData 

func (s *SzAttributeTypeResponse) SetRawData(val OptNilSzAttributeTypeResponseRawData)

SetRawData sets the value of RawData.

func (*SzAttributeTypeResponse) UnmarshalJSON 

func (s *SzAttributeTypeResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeTypeResponse) Validate 

func (s *SzAttributeTypeResponse) Validate() error

type SzAttributeTypeResponseData 

type SzAttributeTypeResponseData struct {
	AttributeType OptSzAttributeType `json:"attributeType"`
}

Describes the data segment associated with `SzAttributeTypeResponse`. Ref: #/components/schemas/SzAttributeTypeResponseData

func (*SzAttributeTypeResponseData) Decode 

func (s *SzAttributeTypeResponseData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypeResponseData from json.

func (*SzAttributeTypeResponseData) Encode 

func (s *SzAttributeTypeResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzAttributeTypeResponseData) GetAttributeType 

func (s *SzAttributeTypeResponseData) GetAttributeType() OptSzAttributeType

GetAttributeType returns the value of AttributeType.

func (*SzAttributeTypeResponseData) MarshalJSON 

func (s *SzAttributeTypeResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeTypeResponseData) SetAttributeType 

func (s *SzAttributeTypeResponseData) SetAttributeType(val OptSzAttributeType)

SetAttributeType sets the value of AttributeType.

func (*SzAttributeTypeResponseData) UnmarshalJSON 

func (s *SzAttributeTypeResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeTypeResponseData) Validate 

func (s *SzAttributeTypeResponseData) Validate() error

type SzAttributeTypeResponseRawData 

type SzAttributeTypeResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzAttributeTypeResponseRawData) Decode 

func (s *SzAttributeTypeResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypeResponseRawData from json.

func (SzAttributeTypeResponseRawData) Encode 

func (s SzAttributeTypeResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzAttributeTypeResponseRawData) MarshalJSON 

func (s SzAttributeTypeResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeTypeResponseRawData) UnmarshalJSON 

func (s *SzAttributeTypeResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzAttributeTypesResponse 

type SzAttributeTypesResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzAttributeTypesResponseRawData `json:"rawData"`
	Data    OptSzAttributeTypesResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzAttributeTypesResponse

func (*SzAttributeTypesResponse) Decode 

func (s *SzAttributeTypesResponse) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypesResponse from json.

func (*SzAttributeTypesResponse) Encode 

func (s *SzAttributeTypesResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzAttributeTypesResponse) GetData 

func (s *SzAttributeTypesResponse) GetData() OptSzAttributeTypesResponseData

GetData returns the value of Data. 

func (s *SzAttributeTypesResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzAttributeTypesResponse) GetMeta 

func (s *SzAttributeTypesResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzAttributeTypesResponse) GetRawData 

func (s *SzAttributeTypesResponse) GetRawData() OptNilSzAttributeTypesResponseRawData

GetRawData returns the value of RawData.

func (*SzAttributeTypesResponse) MarshalJSON 

func (s *SzAttributeTypesResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeTypesResponse) SetData 

func (s *SzAttributeTypesResponse) SetData(val OptSzAttributeTypesResponseData)

SetData sets the value of Data. 

func (s *SzAttributeTypesResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzAttributeTypesResponse) SetMeta 

func (s *SzAttributeTypesResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzAttributeTypesResponse) SetRawData 

func (s *SzAttributeTypesResponse) SetRawData(val OptNilSzAttributeTypesResponseRawData)

SetRawData sets the value of RawData.

func (*SzAttributeTypesResponse) UnmarshalJSON 

func (s *SzAttributeTypesResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeTypesResponse) Validate 

func (s *SzAttributeTypesResponse) Validate() error

type SzAttributeTypesResponseData 

type SzAttributeTypesResponseData struct {
	// The list of attribute types.
	AttributeTypes []SzAttributeType `json:"attributeTypes"`
}

Describes the data associated with the `SzAttributeTypesResponse`. Ref: #/components/schemas/SzAttributeTypesResponseData

func (*SzAttributeTypesResponseData) Decode 

func (s *SzAttributeTypesResponseData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypesResponseData from json.

func (*SzAttributeTypesResponseData) Encode 

func (s *SzAttributeTypesResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzAttributeTypesResponseData) GetAttributeTypes 

func (s *SzAttributeTypesResponseData) GetAttributeTypes() []SzAttributeType

GetAttributeTypes returns the value of AttributeTypes.

func (*SzAttributeTypesResponseData) MarshalJSON 

func (s *SzAttributeTypesResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeTypesResponseData) SetAttributeTypes 

func (s *SzAttributeTypesResponseData) SetAttributeTypes(val []SzAttributeType)

SetAttributeTypes sets the value of AttributeTypes.

func (*SzAttributeTypesResponseData) UnmarshalJSON 

func (s *SzAttributeTypesResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzAttributeTypesResponseData) Validate 

func (s *SzAttributeTypesResponseData) Validate() error

type SzAttributeTypesResponseRawData 

type SzAttributeTypesResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzAttributeTypesResponseRawData) Decode 

func (s *SzAttributeTypesResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzAttributeTypesResponseRawData from json.

func (SzAttributeTypesResponseRawData) Encode 

func (s SzAttributeTypesResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzAttributeTypesResponseRawData) MarshalJSON 

func (s SzAttributeTypesResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzAttributeTypesResponseRawData) UnmarshalJSON 

func (s *SzAttributeTypesResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzBaseResponse 

type SzBaseResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
}

Represents the base information included in all responses sans the actual data for the response. Ref: #/components/schemas/SzBaseResponse

func (*SzBaseResponse) Decode 

func (s *SzBaseResponse) Decode(d *jx.Decoder) error

Decode decodes SzBaseResponse from json.

func (*SzBaseResponse) Encode 

func (s *SzBaseResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler. 

func (s *SzBaseResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzBaseResponse) GetMeta 

func (s *SzBaseResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzBaseResponse) MarshalJSON 

func (s *SzBaseResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler. 

func (s *SzBaseResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzBaseResponse) SetMeta 

func (s *SzBaseResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzBaseResponse) UnmarshalJSON 

func (s *SzBaseResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzBaseResponse) Validate 

func (s *SzBaseResponse) Validate() error

type SzBulkDataAnalysis 

type SzBulkDataAnalysis struct {
	// The state of the bulk load.
	Status OptSzBulkDataStatus `json:"status"`
	// The character encoding used to process the bulk data.
	CharacterEncoding OptString `json:"characterEncoding"`
	// The media type of the bulk data.
	MediaType OptString `json:"mediaType"`
	// The number of records found in the bulk data.  This may not match the number of "observed
	// entities" once loaded since some records may be exact duplicates.
	RecordCount OptInt32 `json:"recordCount"`
	// The number of records provided that include a `RECORD_ID` value.
	RecordsWithRecordIdCount OptInt32 `json:"recordsWithRecordIdCount"`
	// The number of records provided that include a `DATA_SOURCE` value.
	RecordsWithDataSourceCount OptInt32 `json:"recordsWithDataSourceCount"`
	// The array of `SzDataSourceRecordAnalysis` elements providing statistics on the records by data
	// source.
	AnalysisByDataSource []SzDataSourceRecordAnalysis `json:"analysisByDataSource"`
}

Describes the analysis performed against a set of bulk data records described as a JSON array, JSON Lines format or CSV format. Ref: #/components/schemas/SzBulkDataAnalysis

func (*SzBulkDataAnalysis) Decode 

func (s *SzBulkDataAnalysis) Decode(d *jx.Decoder) error

Decode decodes SzBulkDataAnalysis from json.

func (*SzBulkDataAnalysis) Encode 

func (s *SzBulkDataAnalysis) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzBulkDataAnalysis) GetAnalysisByDataSource 

func (s *SzBulkDataAnalysis) GetAnalysisByDataSource() []SzDataSourceRecordAnalysis

GetAnalysisByDataSource returns the value of AnalysisByDataSource.

func (*SzBulkDataAnalysis) GetCharacterEncoding 

func (s *SzBulkDataAnalysis) GetCharacterEncoding() OptString

GetCharacterEncoding returns the value of CharacterEncoding.

func (*SzBulkDataAnalysis) GetMediaType 

func (s *SzBulkDataAnalysis) GetMediaType() OptString

GetMediaType returns the value of MediaType.

func (*SzBulkDataAnalysis) GetRecordCount 

func (s *SzBulkDataAnalysis) GetRecordCount() OptInt32

GetRecordCount returns the value of RecordCount.

func (*SzBulkDataAnalysis) GetRecordsWithDataSourceCount 

func (s *SzBulkDataAnalysis) GetRecordsWithDataSourceCount() OptInt32

GetRecordsWithDataSourceCount returns the value of RecordsWithDataSourceCount.

func (*SzBulkDataAnalysis) GetRecordsWithRecordIdCount 

func (s *SzBulkDataAnalysis) GetRecordsWithRecordIdCount() OptInt32

GetRecordsWithRecordIdCount returns the value of RecordsWithRecordIdCount.

func (*SzBulkDataAnalysis) GetStatus 

func (s *SzBulkDataAnalysis) GetStatus() OptSzBulkDataStatus

GetStatus returns the value of Status.

func (*SzBulkDataAnalysis) MarshalJSON 

func (s *SzBulkDataAnalysis) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzBulkDataAnalysis) SetAnalysisByDataSource 

func (s *SzBulkDataAnalysis) SetAnalysisByDataSource(val []SzDataSourceRecordAnalysis)

SetAnalysisByDataSource sets the value of AnalysisByDataSource.

func (*SzBulkDataAnalysis) SetCharacterEncoding 

func (s *SzBulkDataAnalysis) SetCharacterEncoding(val OptString)

SetCharacterEncoding sets the value of CharacterEncoding.

func (*SzBulkDataAnalysis) SetMediaType 

func (s *SzBulkDataAnalysis) SetMediaType(val OptString)

SetMediaType sets the value of MediaType.

func (*SzBulkDataAnalysis) SetRecordCount 

func (s *SzBulkDataAnalysis) SetRecordCount(val OptInt32)

SetRecordCount sets the value of RecordCount.

func (*SzBulkDataAnalysis) SetRecordsWithDataSourceCount 

func (s *SzBulkDataAnalysis) SetRecordsWithDataSourceCount(val OptInt32)

SetRecordsWithDataSourceCount sets the value of RecordsWithDataSourceCount.

func (*SzBulkDataAnalysis) SetRecordsWithRecordIdCount 

func (s *SzBulkDataAnalysis) SetRecordsWithRecordIdCount(val OptInt32)

SetRecordsWithRecordIdCount sets the value of RecordsWithRecordIdCount.

func (*SzBulkDataAnalysis) SetStatus 

func (s *SzBulkDataAnalysis) SetStatus(val OptSzBulkDataStatus)

SetStatus sets the value of Status.

func (*SzBulkDataAnalysis) UnmarshalJSON 

func (s *SzBulkDataAnalysis) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzBulkDataAnalysis) Validate 

func (s *SzBulkDataAnalysis) Validate() error

type SzBulkDataAnalysisResponse 

type SzBulkDataAnalysisResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The `SzBulkDataAnalysis` describing the analysis of the bulk records.
	Data OptSzBulkDataAnalysis `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzBulkDataAnalysisResponse

func (*SzBulkDataAnalysisResponse) Decode 

func (s *SzBulkDataAnalysisResponse) Decode(d *jx.Decoder) error

Decode decodes SzBulkDataAnalysisResponse from json.

func (*SzBulkDataAnalysisResponse) Encode 

func (s *SzBulkDataAnalysisResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzBulkDataAnalysisResponse) GetData 

func (s *SzBulkDataAnalysisResponse) GetData() OptSzBulkDataAnalysis

GetData returns the value of Data. 

func (s *SzBulkDataAnalysisResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzBulkDataAnalysisResponse) GetMeta 

func (s *SzBulkDataAnalysisResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzBulkDataAnalysisResponse) MarshalJSON 

func (s *SzBulkDataAnalysisResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzBulkDataAnalysisResponse) SetData 

func (s *SzBulkDataAnalysisResponse) SetData(val OptSzBulkDataAnalysis)

SetData sets the value of Data. 

func (s *SzBulkDataAnalysisResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzBulkDataAnalysisResponse) SetMeta 

func (s *SzBulkDataAnalysisResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzBulkDataAnalysisResponse) UnmarshalJSON 

func (s *SzBulkDataAnalysisResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzBulkDataAnalysisResponse) Validate 

func (s *SzBulkDataAnalysisResponse) Validate() error

type SzBulkDataStatus 

type SzBulkDataStatus string

Describes the status of a bulk data operation: * `NOT_STARTED` - The bulk data operation has not started. * `IN_PROGRESS` - If bulk data operation is in progress. * `ABORTED` - The bulk data operation was aborted. * `COMPLETED` - The bulk data operation completed normally. Ref: #/components/schemas/SzBulkDataStatus 

const (
	SzBulkDataStatusNOTSTARTED SzBulkDataStatus = "NOT_STARTED"
	SzBulkDataStatusINPROGRESS SzBulkDataStatus = "IN_PROGRESS"
	SzBulkDataStatusABORTED    SzBulkDataStatus = "ABORTED"
	SzBulkDataStatusCOMPLETED  SzBulkDataStatus = "COMPLETED"
)

func (SzBulkDataStatus) AllValues added in v0.9.0 

func (SzBulkDataStatus) AllValues() []SzBulkDataStatus

AllValues returns all SzBulkDataStatus values.

func (*SzBulkDataStatus) Decode 

func (s *SzBulkDataStatus) Decode(d *jx.Decoder) error

Decode decodes SzBulkDataStatus from json.

func (SzBulkDataStatus) Encode 

func (s SzBulkDataStatus) Encode(e *jx.Encoder)

Encode encodes SzBulkDataStatus as json.

func (SzBulkDataStatus) MarshalJSON 

func (s SzBulkDataStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzBulkDataStatus) MarshalText 

func (s SzBulkDataStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzBulkDataStatus) UnmarshalJSON 

func (s *SzBulkDataStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzBulkDataStatus) UnmarshalText 

func (s *SzBulkDataStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzBulkDataStatus) Validate 

func (s SzBulkDataStatus) Validate() error

type SzBulkLoadError 

type SzBulkLoadError struct {
	// The error that occurred.
	Error OptSzError `json:"error"`
	// The number of times the error occurred while loading data from the bulk data set.
	OccurrenceCount OptInt32 `json:"occurrenceCount"`
}

Describes an error and the number of times it occurred. Ref: #/components/schemas/SzBulkLoadError

func (*SzBulkLoadError) Decode 

func (s *SzBulkLoadError) Decode(d *jx.Decoder) error

Decode decodes SzBulkLoadError from json.

func (*SzBulkLoadError) Encode 

func (s *SzBulkLoadError) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzBulkLoadError) GetError 

func (s *SzBulkLoadError) GetError() OptSzError

GetError returns the value of Error.

func (*SzBulkLoadError) GetOccurrenceCount 

func (s *SzBulkLoadError) GetOccurrenceCount() OptInt32

GetOccurrenceCount returns the value of OccurrenceCount.

func (*SzBulkLoadError) MarshalJSON 

func (s *SzBulkLoadError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzBulkLoadError) SetError 

func (s *SzBulkLoadError) SetError(val OptSzError)

SetError sets the value of Error.

func (*SzBulkLoadError) SetOccurrenceCount 

func (s *SzBulkLoadError) SetOccurrenceCount(val OptInt32)

SetOccurrenceCount sets the value of OccurrenceCount.

func (*SzBulkLoadError) UnmarshalJSON 

func (s *SzBulkLoadError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzBulkLoadResponse 

type SzBulkLoadResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The `SzBulkLoadResult` describing the load statistics from loading a bulk data set.
	Data OptSzBulkLoadResult `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzBulkLoadResponse

func (*SzBulkLoadResponse) Decode 

func (s *SzBulkLoadResponse) Decode(d *jx.Decoder) error

Decode decodes SzBulkLoadResponse from json.

func (*SzBulkLoadResponse) Encode 

func (s *SzBulkLoadResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzBulkLoadResponse) GetData 

func (s *SzBulkLoadResponse) GetData() OptSzBulkLoadResult

GetData returns the value of Data. 

func (s *SzBulkLoadResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzBulkLoadResponse) GetMeta 

func (s *SzBulkLoadResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzBulkLoadResponse) MarshalJSON 

func (s *SzBulkLoadResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzBulkLoadResponse) SetData 

func (s *SzBulkLoadResponse) SetData(val OptSzBulkLoadResult)

SetData sets the value of Data. 

func (s *SzBulkLoadResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzBulkLoadResponse) SetMeta 

func (s *SzBulkLoadResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzBulkLoadResponse) UnmarshalJSON 

func (s *SzBulkLoadResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzBulkLoadResponse) Validate 

func (s *SzBulkLoadResponse) Validate() error

type SzBulkLoadResult 

type SzBulkLoadResult struct {
	// The number of records found in the bulk data set with the aggregate group.  This may not match the
	// number of "observed entities" once loaded since some records may be exact duplicates.
	RecordCount OptInt32 `json:"recordCount"`
	// The number of records successfully loaded from the bulk data set within the aggregate group.  This
	// may not match the number of "observed entities" loaded since some records may be exact duplicates.
	LoadedRecordCount OptInt32 `json:"loadedRecordCount"`
	// The number of records from the bulk data set within the aggregate group that are missing a
	// `DATA_SOURCE` value.
	IncompleteRecordCount OptInt32 `json:"incompleteRecordCount"`
	// The number of records from the bulk data set within the aggregate group that failed to load.
	FailedRecordCount OptInt32 `json:"failedRecordCount"`
	// The array of top error occurrences with the number of times they occurred when loading records
	// with the associated data source.
	TopErrors []SzBulkLoadError `json:"topErrors"`
	// The state of the bulk load.
	Status OptSzBulkDataStatus `json:"status"`
	// The character encoding used to process the bulk data.
	CharacterEncoding OptString `json:"characterEncoding"`
	// The media type of the bulk data.
	MediaType OptString `json:"mediaType"`
	// The number of records that are incomplete because they are missing the `DATA_SOURCE` field.
	MissingDataSourceCount OptInt32 `json:"missingDataSourceCount"`
	// The array of `SzDataSourceBulkDataResult` elements describing the load statistics by data source.
	ResultsByDataSource []SzDataSourceBulkLoadResult `json:"resultsByDataSource"`
}

Merged schema. Ref: #/components/schemas/SzBulkLoadResult

func (*SzBulkLoadResult) Decode 

func (s *SzBulkLoadResult) Decode(d *jx.Decoder) error

Decode decodes SzBulkLoadResult from json.

func (*SzBulkLoadResult) Encode 

func (s *SzBulkLoadResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzBulkLoadResult) GetCharacterEncoding 

func (s *SzBulkLoadResult) GetCharacterEncoding() OptString

GetCharacterEncoding returns the value of CharacterEncoding.

func (*SzBulkLoadResult) GetFailedRecordCount 

func (s *SzBulkLoadResult) GetFailedRecordCount() OptInt32

GetFailedRecordCount returns the value of FailedRecordCount.

func (*SzBulkLoadResult) GetIncompleteRecordCount 

func (s *SzBulkLoadResult) GetIncompleteRecordCount() OptInt32

GetIncompleteRecordCount returns the value of IncompleteRecordCount.

func (*SzBulkLoadResult) GetLoadedRecordCount 

func (s *SzBulkLoadResult) GetLoadedRecordCount() OptInt32

GetLoadedRecordCount returns the value of LoadedRecordCount.

func (*SzBulkLoadResult) GetMediaType 

func (s *SzBulkLoadResult) GetMediaType() OptString

GetMediaType returns the value of MediaType.

func (*SzBulkLoadResult) GetMissingDataSourceCount 

func (s *SzBulkLoadResult) GetMissingDataSourceCount() OptInt32

GetMissingDataSourceCount returns the value of MissingDataSourceCount.

func (*SzBulkLoadResult) GetRecordCount 

func (s *SzBulkLoadResult) GetRecordCount() OptInt32

GetRecordCount returns the value of RecordCount.

func (*SzBulkLoadResult) GetResultsByDataSource 

func (s *SzBulkLoadResult) GetResultsByDataSource() []SzDataSourceBulkLoadResult

GetResultsByDataSource returns the value of ResultsByDataSource.

func (*SzBulkLoadResult) GetStatus 

func (s *SzBulkLoadResult) GetStatus() OptSzBulkDataStatus

GetStatus returns the value of Status.

func (*SzBulkLoadResult) GetTopErrors 

func (s *SzBulkLoadResult) GetTopErrors() []SzBulkLoadError

GetTopErrors returns the value of TopErrors.

func (*SzBulkLoadResult) MarshalJSON 

func (s *SzBulkLoadResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzBulkLoadResult) SetCharacterEncoding 

func (s *SzBulkLoadResult) SetCharacterEncoding(val OptString)

SetCharacterEncoding sets the value of CharacterEncoding.

func (*SzBulkLoadResult) SetFailedRecordCount 

func (s *SzBulkLoadResult) SetFailedRecordCount(val OptInt32)

SetFailedRecordCount sets the value of FailedRecordCount.

func (*SzBulkLoadResult) SetIncompleteRecordCount 

func (s *SzBulkLoadResult) SetIncompleteRecordCount(val OptInt32)

SetIncompleteRecordCount sets the value of IncompleteRecordCount.

func (*SzBulkLoadResult) SetLoadedRecordCount 

func (s *SzBulkLoadResult) SetLoadedRecordCount(val OptInt32)

SetLoadedRecordCount sets the value of LoadedRecordCount.

func (*SzBulkLoadResult) SetMediaType 

func (s *SzBulkLoadResult) SetMediaType(val OptString)

SetMediaType sets the value of MediaType.

func (*SzBulkLoadResult) SetMissingDataSourceCount 

func (s *SzBulkLoadResult) SetMissingDataSourceCount(val OptInt32)

SetMissingDataSourceCount sets the value of MissingDataSourceCount.

func (*SzBulkLoadResult) SetRecordCount 

func (s *SzBulkLoadResult) SetRecordCount(val OptInt32)

SetRecordCount sets the value of RecordCount.

func (*SzBulkLoadResult) SetResultsByDataSource 

func (s *SzBulkLoadResult) SetResultsByDataSource(val []SzDataSourceBulkLoadResult)

SetResultsByDataSource sets the value of ResultsByDataSource.

func (*SzBulkLoadResult) SetStatus 

func (s *SzBulkLoadResult) SetStatus(val OptSzBulkDataStatus)

SetStatus sets the value of Status.

func (*SzBulkLoadResult) SetTopErrors 

func (s *SzBulkLoadResult) SetTopErrors(val []SzBulkLoadError)

SetTopErrors sets the value of TopErrors.

func (*SzBulkLoadResult) UnmarshalJSON 

func (s *SzBulkLoadResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzBulkLoadResult) Validate 

func (s *SzBulkLoadResult) Validate() error

type SzCandidateKey 

type SzCandidateKey struct {
	// The identifier for the candidate feature.
	FeatureId OptInt64 `json:"featureId"`
	// The feature type for the candidate feature.
	FeatureType OptString `json:"featureType"`
	// The feature value for the candidate feature.
	FeatureValue OptString `json:"featureValue"`
}

Describes a candidate key that triggered the scoring of two entities. Ref: #/components/schemas/SzCandidateKey

func (*SzCandidateKey) Decode 

func (s *SzCandidateKey) Decode(d *jx.Decoder) error

Decode decodes SzCandidateKey from json.

func (*SzCandidateKey) Encode 

func (s *SzCandidateKey) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzCandidateKey) GetFeatureId 

func (s *SzCandidateKey) GetFeatureId() OptInt64

GetFeatureId returns the value of FeatureId.

func (*SzCandidateKey) GetFeatureType 

func (s *SzCandidateKey) GetFeatureType() OptString

GetFeatureType returns the value of FeatureType.

func (*SzCandidateKey) GetFeatureValue 

func (s *SzCandidateKey) GetFeatureValue() OptString

GetFeatureValue returns the value of FeatureValue.

func (*SzCandidateKey) MarshalJSON 

func (s *SzCandidateKey) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzCandidateKey) SetFeatureId 

func (s *SzCandidateKey) SetFeatureId(val OptInt64)

SetFeatureId sets the value of FeatureId.

func (*SzCandidateKey) SetFeatureType 

func (s *SzCandidateKey) SetFeatureType(val OptString)

SetFeatureType sets the value of FeatureType.

func (*SzCandidateKey) SetFeatureValue 

func (s *SzCandidateKey) SetFeatureValue(val OptString)

SetFeatureValue sets the value of FeatureValue.

func (*SzCandidateKey) UnmarshalJSON 

func (s *SzCandidateKey) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzConfigResponse added in v0.9.0 

type SzConfigResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzConfigResponseRawData `json:"rawData"`
}

Merged schema. Ref: #/components/schemas/SzConfigResponse

func (*SzConfigResponse) Decode added in v0.9.0 

func (s *SzConfigResponse) Decode(d *jx.Decoder) error

Decode decodes SzConfigResponse from json.

func (*SzConfigResponse) Encode added in v0.9.0 

func (s *SzConfigResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler. 

func (s *SzConfigResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzConfigResponse) GetMeta added in v0.9.0 

func (s *SzConfigResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzConfigResponse) GetRawData added in v0.9.0 

func (s *SzConfigResponse) GetRawData() OptNilSzConfigResponseRawData

GetRawData returns the value of RawData.

func (*SzConfigResponse) MarshalJSON added in v0.9.0 

func (s *SzConfigResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler. 

func (s *SzConfigResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzConfigResponse) SetMeta added in v0.9.0 

func (s *SzConfigResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzConfigResponse) SetRawData added in v0.9.0 

func (s *SzConfigResponse) SetRawData(val OptNilSzConfigResponseRawData)

SetRawData sets the value of RawData.

func (*SzConfigResponse) UnmarshalJSON added in v0.9.0 

func (s *SzConfigResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzConfigResponse) Validate added in v0.9.0 

func (s *SzConfigResponse) Validate() error

type SzConfigResponseRawData added in v0.9.0 

type SzConfigResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzConfigResponseRawData) Decode added in v0.9.0 

func (s *SzConfigResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzConfigResponseRawData from json.

func (SzConfigResponseRawData) Encode added in v0.9.0 

func (s SzConfigResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzConfigResponseRawData) MarshalJSON added in v0.9.0 

func (s SzConfigResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzConfigResponseRawData) UnmarshalJSON added in v0.9.0 

func (s *SzConfigResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSource 

type SzDataSource struct {
	// The data source code.
	DataSourceCode OptString `json:"dataSourceCode"`
	// The data source ID. The value can be null when used for input in creating a data source to
	// indicate that the data source ID should be auto-generated.
	DataSourceId OptNilInt32 `json:"dataSourceId"`
}

Describes a data source. Ref: #/components/schemas/SzDataSource

func (*SzDataSource) Decode 

func (s *SzDataSource) Decode(d *jx.Decoder) error

Decode decodes SzDataSource from json.

func (*SzDataSource) Encode 

func (s *SzDataSource) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDataSource) GetDataSourceCode 

func (s *SzDataSource) GetDataSourceCode() OptString

GetDataSourceCode returns the value of DataSourceCode.

func (*SzDataSource) GetDataSourceId 

func (s *SzDataSource) GetDataSourceId() OptNilInt32

GetDataSourceId returns the value of DataSourceId.

func (*SzDataSource) MarshalJSON 

func (s *SzDataSource) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSource) SetDataSourceCode 

func (s *SzDataSource) SetDataSourceCode(val OptString)

SetDataSourceCode sets the value of DataSourceCode.

func (*SzDataSource) SetDataSourceId 

func (s *SzDataSource) SetDataSourceId(val OptNilInt32)

SetDataSourceId sets the value of DataSourceId.

func (*SzDataSource) UnmarshalJSON 

func (s *SzDataSource) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSourceBulkLoadResult 

type SzDataSourceBulkLoadResult struct {
	// The number of records found in the bulk data set with the aggregate group.  This may not match the
	// number of "observed entities" once loaded since some records may be exact duplicates.
	RecordCount OptInt32 `json:"recordCount"`
	// The number of records successfully loaded from the bulk data set within the aggregate group.  This
	// may not match the number of "observed entities" loaded since some records may be exact duplicates.
	LoadedRecordCount OptInt32 `json:"loadedRecordCount"`
	// The number of records from the bulk data set within the aggregate group that are missing a
	// `DATA_SOURCE` value.
	IncompleteRecordCount OptInt32 `json:"incompleteRecordCount"`
	// The number of records from the bulk data set within the aggregate group that failed to load.
	FailedRecordCount OptInt32 `json:"failedRecordCount"`
	// The array of top error occurrences with the number of times they occurred when loading records
	// with the associated data source.
	TopErrors []SzBulkLoadError `json:"topErrors"`
	// The data source code identifying the data source for which the load statistics are being provided.
	DataSource OptString `json:"dataSource"`
}

Merged schema. Ref: #/components/schemas/SzDataSourceBulkLoadResult

func (*SzDataSourceBulkLoadResult) Decode 

func (s *SzDataSourceBulkLoadResult) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceBulkLoadResult from json.

func (*SzDataSourceBulkLoadResult) Encode 

func (s *SzDataSourceBulkLoadResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDataSourceBulkLoadResult) GetDataSource 

func (s *SzDataSourceBulkLoadResult) GetDataSource() OptString

GetDataSource returns the value of DataSource.

func (*SzDataSourceBulkLoadResult) GetFailedRecordCount 

func (s *SzDataSourceBulkLoadResult) GetFailedRecordCount() OptInt32

GetFailedRecordCount returns the value of FailedRecordCount.

func (*SzDataSourceBulkLoadResult) GetIncompleteRecordCount 

func (s *SzDataSourceBulkLoadResult) GetIncompleteRecordCount() OptInt32

GetIncompleteRecordCount returns the value of IncompleteRecordCount.

func (*SzDataSourceBulkLoadResult) GetLoadedRecordCount 

func (s *SzDataSourceBulkLoadResult) GetLoadedRecordCount() OptInt32

GetLoadedRecordCount returns the value of LoadedRecordCount.

func (*SzDataSourceBulkLoadResult) GetRecordCount 

func (s *SzDataSourceBulkLoadResult) GetRecordCount() OptInt32

GetRecordCount returns the value of RecordCount.

func (*SzDataSourceBulkLoadResult) GetTopErrors 

func (s *SzDataSourceBulkLoadResult) GetTopErrors() []SzBulkLoadError

GetTopErrors returns the value of TopErrors.

func (*SzDataSourceBulkLoadResult) MarshalJSON 

func (s *SzDataSourceBulkLoadResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourceBulkLoadResult) SetDataSource 

func (s *SzDataSourceBulkLoadResult) SetDataSource(val OptString)

SetDataSource sets the value of DataSource.

func (*SzDataSourceBulkLoadResult) SetFailedRecordCount 

func (s *SzDataSourceBulkLoadResult) SetFailedRecordCount(val OptInt32)

SetFailedRecordCount sets the value of FailedRecordCount.

func (*SzDataSourceBulkLoadResult) SetIncompleteRecordCount 

func (s *SzDataSourceBulkLoadResult) SetIncompleteRecordCount(val OptInt32)

SetIncompleteRecordCount sets the value of IncompleteRecordCount.

func (*SzDataSourceBulkLoadResult) SetLoadedRecordCount 

func (s *SzDataSourceBulkLoadResult) SetLoadedRecordCount(val OptInt32)

SetLoadedRecordCount sets the value of LoadedRecordCount.

func (*SzDataSourceBulkLoadResult) SetRecordCount 

func (s *SzDataSourceBulkLoadResult) SetRecordCount(val OptInt32)

SetRecordCount sets the value of RecordCount.

func (*SzDataSourceBulkLoadResult) SetTopErrors 

func (s *SzDataSourceBulkLoadResult) SetTopErrors(val []SzBulkLoadError)

SetTopErrors sets the value of TopErrors.

func (*SzDataSourceBulkLoadResult) UnmarshalJSON 

func (s *SzDataSourceBulkLoadResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSourceDescriptor 

type SzDataSourceDescriptor struct {
	Type         SzDataSourceDescriptorType // switch on this field
	String       string
	SzDataSource SzDataSource
}

Describes a data source either as only its data source code or as an `SzDataSource` object. Ref: #/components/schemas/SzDataSourceDescriptor SzDataSourceDescriptor represents sum type.

func NewStringSzDataSourceDescriptor 

func NewStringSzDataSourceDescriptor(v string) SzDataSourceDescriptor

NewStringSzDataSourceDescriptor returns new SzDataSourceDescriptor from string.

func NewSzDataSourceSzDataSourceDescriptor 

func NewSzDataSourceSzDataSourceDescriptor(v SzDataSource) SzDataSourceDescriptor

NewSzDataSourceSzDataSourceDescriptor returns new SzDataSourceDescriptor from SzDataSource.

func (*SzDataSourceDescriptor) Decode 

func (s *SzDataSourceDescriptor) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceDescriptor from json.

func (SzDataSourceDescriptor) Encode 

func (s SzDataSourceDescriptor) Encode(e *jx.Encoder)

Encode encodes SzDataSourceDescriptor as json.

func (SzDataSourceDescriptor) GetString 

func (s SzDataSourceDescriptor) GetString() (v string, ok bool)

GetString returns string and true boolean if SzDataSourceDescriptor is string.

func (SzDataSourceDescriptor) GetSzDataSource 

func (s SzDataSourceDescriptor) GetSzDataSource() (v SzDataSource, ok bool)

GetSzDataSource returns SzDataSource and true boolean if SzDataSourceDescriptor is SzDataSource.

func (SzDataSourceDescriptor) IsString 

func (s SzDataSourceDescriptor) IsString() bool

IsString reports whether SzDataSourceDescriptor is string.

func (SzDataSourceDescriptor) IsSzDataSource 

func (s SzDataSourceDescriptor) IsSzDataSource() bool

IsSzDataSource reports whether SzDataSourceDescriptor is SzDataSource.

func (SzDataSourceDescriptor) MarshalJSON 

func (s SzDataSourceDescriptor) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourceDescriptor) SetString 

func (s *SzDataSourceDescriptor) SetString(v string)

SetString sets SzDataSourceDescriptor to string.

func (*SzDataSourceDescriptor) SetSzDataSource 

func (s *SzDataSourceDescriptor) SetSzDataSource(v SzDataSource)

SetSzDataSource sets SzDataSourceDescriptor to SzDataSource.

func (*SzDataSourceDescriptor) UnmarshalJSON 

func (s *SzDataSourceDescriptor) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSourceDescriptorType 

type SzDataSourceDescriptorType string

SzDataSourceDescriptorType is oneOf type of SzDataSourceDescriptor. 

const (
	StringSzDataSourceDescriptor       SzDataSourceDescriptorType = "string"
	SzDataSourceSzDataSourceDescriptor SzDataSourceDescriptorType = "SzDataSource"
)

Possible values for SzDataSourceDescriptorType.

type SzDataSourceRecordAnalysis 

type SzDataSourceRecordAnalysis struct {
	// The data source code identifying the data source for which the statistics are being provided.
	// This is `null` if the statistics pertain to those records with no data source defined in the
	// source data.
	DataSource OptNilString `json:"dataSource"`
	// The number of records having the associated data source.
	RecordCount OptInt32 `json:"recordCount"`
	// The number of records having the associated data source that include a `RECORD_ID` value.
	RecordsWithRecordIdCount OptInt32 `json:"recordsWithRecordIdCount"`
}

Provides statistics specific to a given data source of the records found in bulk data. Ref: #/components/schemas/SzDataSourceRecordAnalysis

func (*SzDataSourceRecordAnalysis) Decode 

func (s *SzDataSourceRecordAnalysis) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceRecordAnalysis from json.

func (*SzDataSourceRecordAnalysis) Encode 

func (s *SzDataSourceRecordAnalysis) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDataSourceRecordAnalysis) GetDataSource 

func (s *SzDataSourceRecordAnalysis) GetDataSource() OptNilString

GetDataSource returns the value of DataSource.

func (*SzDataSourceRecordAnalysis) GetRecordCount 

func (s *SzDataSourceRecordAnalysis) GetRecordCount() OptInt32

GetRecordCount returns the value of RecordCount.

func (*SzDataSourceRecordAnalysis) GetRecordsWithRecordIdCount 

func (s *SzDataSourceRecordAnalysis) GetRecordsWithRecordIdCount() OptInt32

GetRecordsWithRecordIdCount returns the value of RecordsWithRecordIdCount.

func (*SzDataSourceRecordAnalysis) MarshalJSON 

func (s *SzDataSourceRecordAnalysis) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourceRecordAnalysis) SetDataSource 

func (s *SzDataSourceRecordAnalysis) SetDataSource(val OptNilString)

SetDataSource sets the value of DataSource.

func (*SzDataSourceRecordAnalysis) SetRecordCount 

func (s *SzDataSourceRecordAnalysis) SetRecordCount(val OptInt32)

SetRecordCount sets the value of RecordCount.

func (*SzDataSourceRecordAnalysis) SetRecordsWithRecordIdCount 

func (s *SzDataSourceRecordAnalysis) SetRecordsWithRecordIdCount(val OptInt32)

SetRecordsWithRecordIdCount sets the value of RecordsWithRecordIdCount.

func (*SzDataSourceRecordAnalysis) UnmarshalJSON 

func (s *SzDataSourceRecordAnalysis) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSourceRecordSummary 

type SzDataSourceRecordSummary struct {
	// The data source code identifying the data source for which the record breakdown is being described.
	DataSource OptString `json:"dataSource"`
	// The number of records from the respective data source that are part of the associated resolved
	// entity.
	RecordCount OptInt32 `json:"recordCount"`
	// The optional array of string record ID's identifying the top 10 records for the associated entity
	// from the respective data source. This may be null or an empty array if the data was not available.
	TopRecordIds OptNilStringArray `json:"topRecordIds"`
}

Describes the number of records associated with a specific data source for a given resolved entity. 

Optionally, if the complete set of records has been retrieved for the associated entity, then

this may also contain the "top 10" record IDs for the associated data source. Ref: #/components/schemas/SzDataSourceRecordSummary

func (*SzDataSourceRecordSummary) Decode 

func (s *SzDataSourceRecordSummary) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceRecordSummary from json.

func (*SzDataSourceRecordSummary) Encode 

func (s *SzDataSourceRecordSummary) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDataSourceRecordSummary) GetDataSource 

func (s *SzDataSourceRecordSummary) GetDataSource() OptString

GetDataSource returns the value of DataSource.

func (*SzDataSourceRecordSummary) GetRecordCount 

func (s *SzDataSourceRecordSummary) GetRecordCount() OptInt32

GetRecordCount returns the value of RecordCount.

func (*SzDataSourceRecordSummary) GetTopRecordIds 

func (s *SzDataSourceRecordSummary) GetTopRecordIds() OptNilStringArray

GetTopRecordIds returns the value of TopRecordIds.

func (*SzDataSourceRecordSummary) MarshalJSON 

func (s *SzDataSourceRecordSummary) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourceRecordSummary) SetDataSource 

func (s *SzDataSourceRecordSummary) SetDataSource(val OptString)

SetDataSource sets the value of DataSource.

func (*SzDataSourceRecordSummary) SetRecordCount 

func (s *SzDataSourceRecordSummary) SetRecordCount(val OptInt32)

SetRecordCount sets the value of RecordCount.

func (*SzDataSourceRecordSummary) SetTopRecordIds 

func (s *SzDataSourceRecordSummary) SetTopRecordIds(val OptNilStringArray)

SetTopRecordIds sets the value of TopRecordIds.

func (*SzDataSourceRecordSummary) UnmarshalJSON 

func (s *SzDataSourceRecordSummary) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzDataSourceRecordSummary) Validate 

func (s *SzDataSourceRecordSummary) Validate() error

type SzDataSourceResponse 

type SzDataSourceResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzDataSourceResponseRawData `json:"rawData"`
	Data    OptSzDataSourceResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzDataSourceResponse

func (*SzDataSourceResponse) Decode 

func (s *SzDataSourceResponse) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceResponse from json.

func (*SzDataSourceResponse) Encode 

func (s *SzDataSourceResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDataSourceResponse) GetData 

func (s *SzDataSourceResponse) GetData() OptSzDataSourceResponseData

GetData returns the value of Data. 

func (s *SzDataSourceResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzDataSourceResponse) GetMeta 

func (s *SzDataSourceResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzDataSourceResponse) GetRawData 

func (s *SzDataSourceResponse) GetRawData() OptNilSzDataSourceResponseRawData

GetRawData returns the value of RawData.

func (*SzDataSourceResponse) MarshalJSON 

func (s *SzDataSourceResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourceResponse) SetData 

func (s *SzDataSourceResponse) SetData(val OptSzDataSourceResponseData)

SetData sets the value of Data. 

func (s *SzDataSourceResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzDataSourceResponse) SetMeta 

func (s *SzDataSourceResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzDataSourceResponse) SetRawData 

func (s *SzDataSourceResponse) SetRawData(val OptNilSzDataSourceResponseRawData)

SetRawData sets the value of RawData.

func (*SzDataSourceResponse) UnmarshalJSON 

func (s *SzDataSourceResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzDataSourceResponse) Validate 

func (s *SzDataSourceResponse) Validate() error

type SzDataSourceResponseData 

type SzDataSourceResponseData struct {
	// The requested data source as an `SzDataSource` object.
	DataSource OptSzDataSource `json:"dataSource"`
}

Describes the data associated with `SzDataSourceResponse`. Ref: #/components/schemas/SzDataSourceResponseData

func (*SzDataSourceResponseData) Decode 

func (s *SzDataSourceResponseData) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceResponseData from json.

func (*SzDataSourceResponseData) Encode 

func (s *SzDataSourceResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDataSourceResponseData) GetDataSource 

func (s *SzDataSourceResponseData) GetDataSource() OptSzDataSource

GetDataSource returns the value of DataSource.

func (*SzDataSourceResponseData) MarshalJSON 

func (s *SzDataSourceResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourceResponseData) SetDataSource 

func (s *SzDataSourceResponseData) SetDataSource(val OptSzDataSource)

SetDataSource sets the value of DataSource.

func (*SzDataSourceResponseData) UnmarshalJSON 

func (s *SzDataSourceResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSourceResponseRawData 

type SzDataSourceResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzDataSourceResponseRawData) Decode 

func (s *SzDataSourceResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzDataSourceResponseRawData from json.

func (SzDataSourceResponseRawData) Encode 

func (s SzDataSourceResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzDataSourceResponseRawData) MarshalJSON 

func (s SzDataSourceResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourceResponseRawData) UnmarshalJSON 

func (s *SzDataSourceResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSourcesResponse 

type SzDataSourcesResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzDataSourcesResponseRawData `json:"rawData"`
	Data    OptSzDataSourcesResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzDataSourcesResponse

func (*SzDataSourcesResponse) Decode 

func (s *SzDataSourcesResponse) Decode(d *jx.Decoder) error

Decode decodes SzDataSourcesResponse from json.

func (*SzDataSourcesResponse) Encode 

func (s *SzDataSourcesResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDataSourcesResponse) GetData 

func (s *SzDataSourcesResponse) GetData() OptSzDataSourcesResponseData

GetData returns the value of Data. 

func (s *SzDataSourcesResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzDataSourcesResponse) GetMeta 

func (s *SzDataSourcesResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzDataSourcesResponse) GetRawData 

func (s *SzDataSourcesResponse) GetRawData() OptNilSzDataSourcesResponseRawData

GetRawData returns the value of RawData.

func (*SzDataSourcesResponse) MarshalJSON 

func (s *SzDataSourcesResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourcesResponse) SetData 

func (s *SzDataSourcesResponse) SetData(val OptSzDataSourcesResponseData)

SetData sets the value of Data. 

func (s *SzDataSourcesResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzDataSourcesResponse) SetMeta 

func (s *SzDataSourcesResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzDataSourcesResponse) SetRawData 

func (s *SzDataSourcesResponse) SetRawData(val OptNilSzDataSourcesResponseRawData)

SetRawData sets the value of RawData.

func (*SzDataSourcesResponse) UnmarshalJSON 

func (s *SzDataSourcesResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzDataSourcesResponse) Validate 

func (s *SzDataSourcesResponse) Validate() error

type SzDataSourcesResponseData 

type SzDataSourcesResponseData struct {
	// The list of data source codes for the configured data sources.
	DataSources []string `json:"dataSources"`
	// The list of `SzDataSource` instances describing the data sources that are configured.
	DataSourceDetails OptSzDataSourcesResponseDataDataSourceDetails `json:"dataSourceDetails"`
}

Describes the data for `SzDataSourceResponse`. Ref: #/components/schemas/SzDataSourcesResponseData

func (*SzDataSourcesResponseData) Decode 

func (s *SzDataSourcesResponseData) Decode(d *jx.Decoder) error

Decode decodes SzDataSourcesResponseData from json.

func (*SzDataSourcesResponseData) Encode 

func (s *SzDataSourcesResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDataSourcesResponseData) GetDataSourceDetails 

func (s *SzDataSourcesResponseData) GetDataSourceDetails() OptSzDataSourcesResponseDataDataSourceDetails

GetDataSourceDetails returns the value of DataSourceDetails.

func (*SzDataSourcesResponseData) GetDataSources 

func (s *SzDataSourcesResponseData) GetDataSources() []string

GetDataSources returns the value of DataSources.

func (*SzDataSourcesResponseData) MarshalJSON 

func (s *SzDataSourcesResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourcesResponseData) SetDataSourceDetails 

func (s *SzDataSourcesResponseData) SetDataSourceDetails(val OptSzDataSourcesResponseDataDataSourceDetails)

SetDataSourceDetails sets the value of DataSourceDetails.

func (*SzDataSourcesResponseData) SetDataSources 

func (s *SzDataSourcesResponseData) SetDataSources(val []string)

SetDataSources sets the value of DataSources.

func (*SzDataSourcesResponseData) UnmarshalJSON 

func (s *SzDataSourcesResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSourcesResponseDataDataSourceDetails 

type SzDataSourcesResponseDataDataSourceDetails map[string]SzDataSource

The list of `SzDataSource` instances describing the data sources that are configured.

func (*SzDataSourcesResponseDataDataSourceDetails) Decode 

func (s *SzDataSourcesResponseDataDataSourceDetails) Decode(d *jx.Decoder) error

Decode decodes SzDataSourcesResponseDataDataSourceDetails from json.

func (SzDataSourcesResponseDataDataSourceDetails) Encode 

func (s SzDataSourcesResponseDataDataSourceDetails) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzDataSourcesResponseDataDataSourceDetails) MarshalJSON 

func (s SzDataSourcesResponseDataDataSourceDetails) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourcesResponseDataDataSourceDetails) UnmarshalJSON 

func (s *SzDataSourcesResponseDataDataSourceDetails) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDataSourcesResponseRawData 

type SzDataSourcesResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzDataSourcesResponseRawData) Decode 

func (s *SzDataSourcesResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzDataSourcesResponseRawData from json.

func (SzDataSourcesResponseRawData) Encode 

func (s SzDataSourcesResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzDataSourcesResponseRawData) MarshalJSON 

func (s SzDataSourcesResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDataSourcesResponseRawData) UnmarshalJSON 

func (s *SzDataSourcesResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDeleteRecordResponse 

type SzDeleteRecordResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzDeleteRecordResponseRawData `json:"rawData"`
	Data    OptSzDeleteRecordResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzDeleteRecordResponse

func (*SzDeleteRecordResponse) Decode 

func (s *SzDeleteRecordResponse) Decode(d *jx.Decoder) error

Decode decodes SzDeleteRecordResponse from json.

func (*SzDeleteRecordResponse) Encode 

func (s *SzDeleteRecordResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDeleteRecordResponse) GetData 

func (s *SzDeleteRecordResponse) GetData() OptSzDeleteRecordResponseData

GetData returns the value of Data. 

func (s *SzDeleteRecordResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzDeleteRecordResponse) GetMeta 

func (s *SzDeleteRecordResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzDeleteRecordResponse) GetRawData 

func (s *SzDeleteRecordResponse) GetRawData() OptNilSzDeleteRecordResponseRawData

GetRawData returns the value of RawData.

func (*SzDeleteRecordResponse) MarshalJSON 

func (s *SzDeleteRecordResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDeleteRecordResponse) SetData 

func (s *SzDeleteRecordResponse) SetData(val OptSzDeleteRecordResponseData)

SetData sets the value of Data. 

func (s *SzDeleteRecordResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzDeleteRecordResponse) SetMeta 

func (s *SzDeleteRecordResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzDeleteRecordResponse) SetRawData 

func (s *SzDeleteRecordResponse) SetRawData(val OptNilSzDeleteRecordResponseRawData)

SetRawData sets the value of RawData.

func (*SzDeleteRecordResponse) UnmarshalJSON 

func (s *SzDeleteRecordResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzDeleteRecordResponse) Validate 

func (s *SzDeleteRecordResponse) Validate() error

type SzDeleteRecordResponseData 

type SzDeleteRecordResponseData struct {
	// The optionally requested info associated with the load.
	Info OptSzResolutionInfo `json:"info"`
}

Describes the data segment of `SzDeleteRecordResponse`. Ref: #/components/schemas/SzDeleteRecordResponseData

func (*SzDeleteRecordResponseData) Decode 

func (s *SzDeleteRecordResponseData) Decode(d *jx.Decoder) error

Decode decodes SzDeleteRecordResponseData from json.

func (*SzDeleteRecordResponseData) Encode 

func (s *SzDeleteRecordResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDeleteRecordResponseData) GetInfo 

func (s *SzDeleteRecordResponseData) GetInfo() OptSzResolutionInfo

GetInfo returns the value of Info.

func (*SzDeleteRecordResponseData) MarshalJSON 

func (s *SzDeleteRecordResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDeleteRecordResponseData) SetInfo 

func (s *SzDeleteRecordResponseData) SetInfo(val OptSzResolutionInfo)

SetInfo sets the value of Info.

func (*SzDeleteRecordResponseData) UnmarshalJSON 

func (s *SzDeleteRecordResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDeleteRecordResponseRawData 

type SzDeleteRecordResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzDeleteRecordResponseRawData) Decode 

func (s *SzDeleteRecordResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzDeleteRecordResponseRawData from json.

func (SzDeleteRecordResponseRawData) Encode 

func (s SzDeleteRecordResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzDeleteRecordResponseRawData) MarshalJSON 

func (s SzDeleteRecordResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDeleteRecordResponseRawData) UnmarshalJSON 

func (s *SzDeleteRecordResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzDetailLevel 

type SzDetailLevel string

Describes the level of detail desired for entity data when obtained via the various endpoints that return entity data. Details for features of entities as well as the related entities of entities are controlled by other flags. Possible values are: * `BARE_MINIMAL` - The entities returned will include only their entity ID's. No record information is returned and if related entities are included, they too will only be described by their entity ID's and will **not** include any matching info. * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case of related entities being included they will also include related matching info. * `MINIMAL` - The entities returned will include at most their entity ID's as well as identifiers for their constituent records (i.e.: data source code and record ID for each record). This detail level is optimized for the fastest possible processing time. * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related entity match info when related entity match info when related entities are included. This detail level aims to maintain as much speed as possible while providing names and relationship information for rendering a graph. * `SUMMARY` - Identical to `BRIEF` except that individual record identifier information is excluded, leaving only the record summary (i.e.: a record count by data source code). This reduces the size of the JSON document for large entities with thousands of records. It may take longer to process than `BRIEF` but less data is returned as well, speeding up network transfer times. * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the original JSON data for each record, the record-level matching info, as well as formatted record data. NOTE: the record-level matching info returned via "how" and "why" is often more useful than that embedded in the entity. Further, the formatted record data, while readable, is not formatted according to locale (i.e.: address, name and date formatting may not appear as expected to a user). Ref: #/components/schemas/SzDetailLevel 

const (
	SzDetailLevelBAREMINIMAL    SzDetailLevel = "BARE_MINIMAL"
	SzDetailLevelNETWORKMINIMAL SzDetailLevel = "NETWORK_MINIMAL"
	SzDetailLevelMINIMAL        SzDetailLevel = "MINIMAL"
	SzDetailLevelBRIEF          SzDetailLevel = "BRIEF"
	SzDetailLevelSUMMARY        SzDetailLevel = "SUMMARY"
	SzDetailLevelVERBOSE        SzDetailLevel = "VERBOSE"
)

func (SzDetailLevel) AllValues added in v0.9.0 

func (SzDetailLevel) AllValues() []SzDetailLevel

AllValues returns all SzDetailLevel values.

func (SzDetailLevel) MarshalText 

func (s SzDetailLevel) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzDetailLevel) UnmarshalText 

func (s *SzDetailLevel) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzDetailLevel) Validate 

func (s SzDetailLevel) Validate() error

type SzDisclosedRelation 

type SzDisclosedRelation struct {
	// The domain of the relationship (e.g.: spouses, parent/child, employer/employee, corporate
	// hierarchy, etc...).
	Domain OptString `json:"domain"`
	// The direction of the relationship.
	Direction OptSzRelationDirection `json:"direction"`
	// The relationship roles (aka: usage types) assigned to the first entity in the relationship.
	Roles1 []string `json:"roles1"`
	// The relationship roles (aka: usage types) assigned to the second entity in the relationship.
	Roles2 []string `json:"roles2"`
	// The array of `SzRelatedFeatures` instances that the disclosed relationship is composed of.
	RelatedFeatures []SzRelatedFeatures `json:"relatedFeatures"`
}

Describes a relationship that is disclosed between two records so that the respective entities are related. Ref: #/components/schemas/SzDisclosedRelation

func (*SzDisclosedRelation) Decode 

func (s *SzDisclosedRelation) Decode(d *jx.Decoder) error

Decode decodes SzDisclosedRelation from json.

func (*SzDisclosedRelation) Encode 

func (s *SzDisclosedRelation) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzDisclosedRelation) GetDirection 

func (s *SzDisclosedRelation) GetDirection() OptSzRelationDirection

GetDirection returns the value of Direction.

func (*SzDisclosedRelation) GetDomain 

func (s *SzDisclosedRelation) GetDomain() OptString

GetDomain returns the value of Domain.

func (*SzDisclosedRelation) GetRelatedFeatures 

func (s *SzDisclosedRelation) GetRelatedFeatures() []SzRelatedFeatures

GetRelatedFeatures returns the value of RelatedFeatures.

func (*SzDisclosedRelation) GetRoles1 

func (s *SzDisclosedRelation) GetRoles1() []string

GetRoles1 returns the value of Roles1.

func (*SzDisclosedRelation) GetRoles2 

func (s *SzDisclosedRelation) GetRoles2() []string

GetRoles2 returns the value of Roles2.

func (*SzDisclosedRelation) MarshalJSON 

func (s *SzDisclosedRelation) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzDisclosedRelation) SetDirection 

func (s *SzDisclosedRelation) SetDirection(val OptSzRelationDirection)

SetDirection sets the value of Direction.

func (*SzDisclosedRelation) SetDomain 

func (s *SzDisclosedRelation) SetDomain(val OptString)

SetDomain sets the value of Domain.

func (*SzDisclosedRelation) SetRelatedFeatures 

func (s *SzDisclosedRelation) SetRelatedFeatures(val []SzRelatedFeatures)

SetRelatedFeatures sets the value of RelatedFeatures.

func (*SzDisclosedRelation) SetRoles1 

func (s *SzDisclosedRelation) SetRoles1(val []string)

SetRoles1 sets the value of Roles1.

func (*SzDisclosedRelation) SetRoles2 

func (s *SzDisclosedRelation) SetRoles2(val []string)

SetRoles2 sets the value of Roles2.

func (*SzDisclosedRelation) UnmarshalJSON 

func (s *SzDisclosedRelation) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzDisclosedRelation) Validate 

func (s *SzDisclosedRelation) Validate() error

type SzEntityData 

type SzEntityData struct {
	// The ResolvedEntity describing the primary entity.
	ResolvedEntity OptSzResolvedEntity `json:"resolvedEntity"`
	// The array of RelatedEntity instances describing the possible matches, discovered relationships,
	// and disclosed relationships.
	RelatedEntities []SzRelatedEntity `json:"relatedEntities"`
}

Describes an entity and the entities related to that entity at one degree of separation. Ref: #/components/schemas/SzEntityData

func (*SzEntityData) Decode 

func (s *SzEntityData) Decode(d *jx.Decoder) error

Decode decodes SzEntityData from json.

func (*SzEntityData) Encode 

func (s *SzEntityData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityData) GetRelatedEntities 

func (s *SzEntityData) GetRelatedEntities() []SzRelatedEntity

GetRelatedEntities returns the value of RelatedEntities.

func (*SzEntityData) GetResolvedEntity 

func (s *SzEntityData) GetResolvedEntity() OptSzResolvedEntity

GetResolvedEntity returns the value of ResolvedEntity.

func (*SzEntityData) MarshalJSON 

func (s *SzEntityData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityData) SetRelatedEntities 

func (s *SzEntityData) SetRelatedEntities(val []SzRelatedEntity)

SetRelatedEntities sets the value of RelatedEntities.

func (*SzEntityData) SetResolvedEntity 

func (s *SzEntityData) SetResolvedEntity(val OptSzResolvedEntity)

SetResolvedEntity sets the value of ResolvedEntity.

func (*SzEntityData) UnmarshalJSON 

func (s *SzEntityData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzEntityData) Validate 

func (s *SzEntityData) Validate() error

type SzEntityFeature 

type SzEntityFeature struct {
	// The internal ID for the primary feature value.
	PrimaryId OptInt64 `json:"primaryId"`
	// The primary value for the feature.
	PrimaryValue OptString `json:"primaryValue"`
	// The optional associated usage type (e.g.: "HOME" or "WORK").
	UsageType OptNilString `json:"usageType"`
	// The array of values that are close enough to the primary value for the feature that they are
	// considered to be duplicate values for the purpose of entity resolution.
	DuplicateValues []string `json:"duplicateValues"`
	// The array of `SzEntityFeatureDetail` instances describing the each of the clustered feature values
	// in detail.
	FeatureDetails []SzEntityFeatureDetail `json:"featureDetails"`
}

Describes a feature for an entity as well as including any close values for the feature that were considered to be duplicate values for entity resolution purposes. Ref: #/components/schemas/SzEntityFeature

func (*SzEntityFeature) Decode 

func (s *SzEntityFeature) Decode(d *jx.Decoder) error

Decode decodes SzEntityFeature from json.

func (*SzEntityFeature) Encode 

func (s *SzEntityFeature) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityFeature) GetDuplicateValues 

func (s *SzEntityFeature) GetDuplicateValues() []string

GetDuplicateValues returns the value of DuplicateValues.

func (*SzEntityFeature) GetFeatureDetails 

func (s *SzEntityFeature) GetFeatureDetails() []SzEntityFeatureDetail

GetFeatureDetails returns the value of FeatureDetails.

func (*SzEntityFeature) GetPrimaryId 

func (s *SzEntityFeature) GetPrimaryId() OptInt64

GetPrimaryId returns the value of PrimaryId.

func (*SzEntityFeature) GetPrimaryValue 

func (s *SzEntityFeature) GetPrimaryValue() OptString

GetPrimaryValue returns the value of PrimaryValue.

func (*SzEntityFeature) GetUsageType 

func (s *SzEntityFeature) GetUsageType() OptNilString

GetUsageType returns the value of UsageType.

func (*SzEntityFeature) MarshalJSON 

func (s *SzEntityFeature) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityFeature) SetDuplicateValues 

func (s *SzEntityFeature) SetDuplicateValues(val []string)

SetDuplicateValues sets the value of DuplicateValues.

func (*SzEntityFeature) SetFeatureDetails 

func (s *SzEntityFeature) SetFeatureDetails(val []SzEntityFeatureDetail)

SetFeatureDetails sets the value of FeatureDetails.

func (*SzEntityFeature) SetPrimaryId 

func (s *SzEntityFeature) SetPrimaryId(val OptInt64)

SetPrimaryId sets the value of PrimaryId.

func (*SzEntityFeature) SetPrimaryValue 

func (s *SzEntityFeature) SetPrimaryValue(val OptString)

SetPrimaryValue sets the value of PrimaryValue.

func (*SzEntityFeature) SetUsageType 

func (s *SzEntityFeature) SetUsageType(val OptNilString)

SetUsageType sets the value of UsageType.

func (*SzEntityFeature) UnmarshalJSON 

func (s *SzEntityFeature) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzEntityFeatureDetail 

type SzEntityFeatureDetail struct {
	// The internal ID for the feature value.
	InternalId OptInt64 `json:"internalId"`
	// The feature value.
	FeatureValue OptString `json:"featureValue"`
	// The `SzEntityFeatureStatistics` describing the statistics for the feature value.  This may be
	// `null` if the statistics were not requested.
	Statistics OptSzEntityFeatureStatistics `json:"statistics"`
}

Describes the details of an entity feature value, optionally including statistics if they have been requested. Ref: #/components/schemas/SzEntityFeatureDetail

func (*SzEntityFeatureDetail) Decode 

func (s *SzEntityFeatureDetail) Decode(d *jx.Decoder) error

Decode decodes SzEntityFeatureDetail from json.

func (*SzEntityFeatureDetail) Encode 

func (s *SzEntityFeatureDetail) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityFeatureDetail) GetFeatureValue 

func (s *SzEntityFeatureDetail) GetFeatureValue() OptString

GetFeatureValue returns the value of FeatureValue.

func (*SzEntityFeatureDetail) GetInternalId 

func (s *SzEntityFeatureDetail) GetInternalId() OptInt64

GetInternalId returns the value of InternalId.

func (*SzEntityFeatureDetail) GetStatistics 

func (s *SzEntityFeatureDetail) GetStatistics() OptSzEntityFeatureStatistics

GetStatistics returns the value of Statistics.

func (*SzEntityFeatureDetail) MarshalJSON 

func (s *SzEntityFeatureDetail) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityFeatureDetail) SetFeatureValue 

func (s *SzEntityFeatureDetail) SetFeatureValue(val OptString)

SetFeatureValue sets the value of FeatureValue.

func (*SzEntityFeatureDetail) SetInternalId 

func (s *SzEntityFeatureDetail) SetInternalId(val OptInt64)

SetInternalId sets the value of InternalId.

func (*SzEntityFeatureDetail) SetStatistics 

func (s *SzEntityFeatureDetail) SetStatistics(val OptSzEntityFeatureStatistics)

SetStatistics sets the value of Statistics.

func (*SzEntityFeatureDetail) UnmarshalJSON 

func (s *SzEntityFeatureDetail) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzEntityFeatureStatistics 

type SzEntityFeatureStatistics struct {
	// Indicates if the feature is used for finding candidates during entity resolution.
	UsedForCandidates OptBool `json:"usedForCandidates"`
	// Indicates if the feature is used for scoring during entity resolution.
	UsedForScoring OptBool `json:"usedForScoring"`
	// The number of entities having this feature value.
	EntityCount OptInt64 `json:"entityCount"`
	// Indicates if this feature value is no longer being used to find candidates because too many
	// entities share the same value.
	CandidateCapReached OptBool `json:"candidateCapReached"`
	// Indicates if this feature value is no longer being used in entity scoring because too many
	// entities share the same value.
	ScoringCapReached OptBool `json:"scoringCapReached"`
	// Indicates if this value was suppressed in favor of a more complete value.
	Suppressed OptBool `json:"suppressed"`
}

Describes the entity resolution statistics for the feature value. Ref: #/components/schemas/SzEntityFeatureStatistics

func (*SzEntityFeatureStatistics) Decode 

func (s *SzEntityFeatureStatistics) Decode(d *jx.Decoder) error

Decode decodes SzEntityFeatureStatistics from json.

func (*SzEntityFeatureStatistics) Encode 

func (s *SzEntityFeatureStatistics) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityFeatureStatistics) GetCandidateCapReached 

func (s *SzEntityFeatureStatistics) GetCandidateCapReached() OptBool

GetCandidateCapReached returns the value of CandidateCapReached.

func (*SzEntityFeatureStatistics) GetEntityCount 

func (s *SzEntityFeatureStatistics) GetEntityCount() OptInt64

GetEntityCount returns the value of EntityCount.

func (*SzEntityFeatureStatistics) GetScoringCapReached 

func (s *SzEntityFeatureStatistics) GetScoringCapReached() OptBool

GetScoringCapReached returns the value of ScoringCapReached.

func (*SzEntityFeatureStatistics) GetSuppressed 

func (s *SzEntityFeatureStatistics) GetSuppressed() OptBool

GetSuppressed returns the value of Suppressed.

func (*SzEntityFeatureStatistics) GetUsedForCandidates 

func (s *SzEntityFeatureStatistics) GetUsedForCandidates() OptBool

GetUsedForCandidates returns the value of UsedForCandidates.

func (*SzEntityFeatureStatistics) GetUsedForScoring 

func (s *SzEntityFeatureStatistics) GetUsedForScoring() OptBool

GetUsedForScoring returns the value of UsedForScoring.

func (*SzEntityFeatureStatistics) MarshalJSON 

func (s *SzEntityFeatureStatistics) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityFeatureStatistics) SetCandidateCapReached 

func (s *SzEntityFeatureStatistics) SetCandidateCapReached(val OptBool)

SetCandidateCapReached sets the value of CandidateCapReached.

func (*SzEntityFeatureStatistics) SetEntityCount 

func (s *SzEntityFeatureStatistics) SetEntityCount(val OptInt64)

SetEntityCount sets the value of EntityCount.

func (*SzEntityFeatureStatistics) SetScoringCapReached 

func (s *SzEntityFeatureStatistics) SetScoringCapReached(val OptBool)

SetScoringCapReached sets the value of ScoringCapReached.

func (*SzEntityFeatureStatistics) SetSuppressed 

func (s *SzEntityFeatureStatistics) SetSuppressed(val OptBool)

SetSuppressed sets the value of Suppressed.

func (*SzEntityFeatureStatistics) SetUsedForCandidates 

func (s *SzEntityFeatureStatistics) SetUsedForCandidates(val OptBool)

SetUsedForCandidates sets the value of UsedForCandidates.

func (*SzEntityFeatureStatistics) SetUsedForScoring 

func (s *SzEntityFeatureStatistics) SetUsedForScoring(val OptBool)

SetUsedForScoring sets the value of UsedForScoring.

func (*SzEntityFeatureStatistics) UnmarshalJSON 

func (s *SzEntityFeatureStatistics) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzEntityIdentifier 

type SzEntityIdentifier struct {
	Type       SzEntityIdentifierType // switch on this field
	Int64      int64
	SzRecordId SzRecordId
	String     string
}

Identifies an entity by either its entity ID or by the data source code and record ID of one of its constituent records. If a record ID is specified then it is either as a JSON-encoded `SzRecordId` or a delimited string where the first character is the delimiter, followed by the data source code, then the delimiter and the record ID (e.g.: `|CUSTOMERS|ABC123`). Ref: #/components/schemas/SzEntityIdentifier SzEntityIdentifier represents sum type.

func NewInt64SzEntityIdentifier 

func NewInt64SzEntityIdentifier(v int64) SzEntityIdentifier

NewInt64SzEntityIdentifier returns new SzEntityIdentifier from int64.

func NewStringSzEntityIdentifier 

func NewStringSzEntityIdentifier(v string) SzEntityIdentifier

NewStringSzEntityIdentifier returns new SzEntityIdentifier from string.

func NewSzRecordIdSzEntityIdentifier 

func NewSzRecordIdSzEntityIdentifier(v SzRecordId) SzEntityIdentifier

NewSzRecordIdSzEntityIdentifier returns new SzEntityIdentifier from SzRecordId.

func (SzEntityIdentifier) GetInt64 

func (s SzEntityIdentifier) GetInt64() (v int64, ok bool)

GetInt64 returns int64 and true boolean if SzEntityIdentifier is int64.

func (SzEntityIdentifier) GetString 

func (s SzEntityIdentifier) GetString() (v string, ok bool)

GetString returns string and true boolean if SzEntityIdentifier is string.

func (SzEntityIdentifier) GetSzRecordId 

func (s SzEntityIdentifier) GetSzRecordId() (v SzRecordId, ok bool)

GetSzRecordId returns SzRecordId and true boolean if SzEntityIdentifier is SzRecordId.

func (SzEntityIdentifier) IsInt64 

func (s SzEntityIdentifier) IsInt64() bool

IsInt64 reports whether SzEntityIdentifier is int64.

func (SzEntityIdentifier) IsString 

func (s SzEntityIdentifier) IsString() bool

IsString reports whether SzEntityIdentifier is string.

func (SzEntityIdentifier) IsSzRecordId 

func (s SzEntityIdentifier) IsSzRecordId() bool

IsSzRecordId reports whether SzEntityIdentifier is SzRecordId.

func (*SzEntityIdentifier) SetInt64 

func (s *SzEntityIdentifier) SetInt64(v int64)

SetInt64 sets SzEntityIdentifier to int64.

func (*SzEntityIdentifier) SetString 

func (s *SzEntityIdentifier) SetString(v string)

SetString sets SzEntityIdentifier to string.

func (*SzEntityIdentifier) SetSzRecordId 

func (s *SzEntityIdentifier) SetSzRecordId(v SzRecordId)

SetSzRecordId sets SzEntityIdentifier to SzRecordId.

type SzEntityIdentifierType 

type SzEntityIdentifierType string

SzEntityIdentifierType is oneOf type of SzEntityIdentifier. 

const (
	Int64SzEntityIdentifier      SzEntityIdentifierType = "int64"
	SzRecordIdSzEntityIdentifier SzEntityIdentifierType = "SzRecordId"
	StringSzEntityIdentifier     SzEntityIdentifierType = "string"
)

Possible values for SzEntityIdentifierType.

type SzEntityNetworkData 

type SzEntityNetworkData struct {
	// The array of `SzEntityPath` objects describing the paths that make up the entity network
	// (including island networks).
	EntityPaths []SzEntityPath `json:"entityPaths"`
	// The array of `SzEntityData` objects describing the entities on the path.  This may only include
	// partial information on the entities at the edge of the network.
	Entities []SzEntityData `json:"entities"`
}

Describes a network of paths between entities using the entity IDs of the entities in the path and includes the data from the actual entities in the network. Ref: #/components/schemas/SzEntityNetworkData

func (*SzEntityNetworkData) Decode 

func (s *SzEntityNetworkData) Decode(d *jx.Decoder) error

Decode decodes SzEntityNetworkData from json.

func (*SzEntityNetworkData) Encode 

func (s *SzEntityNetworkData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityNetworkData) GetEntities 

func (s *SzEntityNetworkData) GetEntities() []SzEntityData

GetEntities returns the value of Entities.

func (*SzEntityNetworkData) GetEntityPaths 

func (s *SzEntityNetworkData) GetEntityPaths() []SzEntityPath

GetEntityPaths returns the value of EntityPaths.

func (*SzEntityNetworkData) MarshalJSON 

func (s *SzEntityNetworkData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityNetworkData) SetEntities 

func (s *SzEntityNetworkData) SetEntities(val []SzEntityData)

SetEntities sets the value of Entities.

func (*SzEntityNetworkData) SetEntityPaths 

func (s *SzEntityNetworkData) SetEntityPaths(val []SzEntityPath)

SetEntityPaths sets the value of EntityPaths.

func (*SzEntityNetworkData) UnmarshalJSON 

func (s *SzEntityNetworkData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzEntityNetworkData) Validate 

func (s *SzEntityNetworkData) Validate() error

type SzEntityNetworkResponse 

type SzEntityNetworkResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzEntityNetworkResponseRawData `json:"rawData"`
	Data    OptSzEntityNetworkData               `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzEntityNetworkResponse

func (*SzEntityNetworkResponse) Decode 

func (s *SzEntityNetworkResponse) Decode(d *jx.Decoder) error

Decode decodes SzEntityNetworkResponse from json.

func (*SzEntityNetworkResponse) Encode 

func (s *SzEntityNetworkResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityNetworkResponse) GetData 

func (s *SzEntityNetworkResponse) GetData() OptSzEntityNetworkData

GetData returns the value of Data. 

func (s *SzEntityNetworkResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzEntityNetworkResponse) GetMeta 

func (s *SzEntityNetworkResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzEntityNetworkResponse) GetRawData 

func (s *SzEntityNetworkResponse) GetRawData() OptNilSzEntityNetworkResponseRawData

GetRawData returns the value of RawData.

func (*SzEntityNetworkResponse) MarshalJSON 

func (s *SzEntityNetworkResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityNetworkResponse) SetData 

func (s *SzEntityNetworkResponse) SetData(val OptSzEntityNetworkData)

SetData sets the value of Data. 

func (s *SzEntityNetworkResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzEntityNetworkResponse) SetMeta 

func (s *SzEntityNetworkResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzEntityNetworkResponse) SetRawData 

func (s *SzEntityNetworkResponse) SetRawData(val OptNilSzEntityNetworkResponseRawData)

SetRawData sets the value of RawData.

func (*SzEntityNetworkResponse) UnmarshalJSON 

func (s *SzEntityNetworkResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzEntityNetworkResponse) Validate 

func (s *SzEntityNetworkResponse) Validate() error

type SzEntityNetworkResponseRawData 

type SzEntityNetworkResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzEntityNetworkResponseRawData) Decode 

func (s *SzEntityNetworkResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzEntityNetworkResponseRawData from json.

func (SzEntityNetworkResponseRawData) Encode 

func (s SzEntityNetworkResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzEntityNetworkResponseRawData) MarshalJSON 

func (s SzEntityNetworkResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityNetworkResponseRawData) UnmarshalJSON 

func (s *SzEntityNetworkResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzEntityPath 

type SzEntityPath struct {
	// The starting entity ID for the path.
	StartEntityId OptInt64 `json:"startEntityId"`
	// The ending entity ID for the path.
	EndEntityId OptInt64 `json:"endEntityId"`
	// The array of entity IDs identifying the entities on the path in order of how are they are
	// connected on the path.  This is null if there is no path between the entities.
	EntityIds OptNilInt64Array `json:"entityIds"`
}

Describes a path between two entities using the entity IDs of the entities in the path. Ref: #/components/schemas/SzEntityPath

func (*SzEntityPath) Decode 

func (s *SzEntityPath) Decode(d *jx.Decoder) error

Decode decodes SzEntityPath from json.

func (*SzEntityPath) Encode 

func (s *SzEntityPath) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityPath) GetEndEntityId 

func (s *SzEntityPath) GetEndEntityId() OptInt64

GetEndEntityId returns the value of EndEntityId.

func (*SzEntityPath) GetEntityIds 

func (s *SzEntityPath) GetEntityIds() OptNilInt64Array

GetEntityIds returns the value of EntityIds.

func (*SzEntityPath) GetStartEntityId 

func (s *SzEntityPath) GetStartEntityId() OptInt64

GetStartEntityId returns the value of StartEntityId.

func (*SzEntityPath) MarshalJSON 

func (s *SzEntityPath) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityPath) SetEndEntityId 

func (s *SzEntityPath) SetEndEntityId(val OptInt64)

SetEndEntityId sets the value of EndEntityId.

func (*SzEntityPath) SetEntityIds 

func (s *SzEntityPath) SetEntityIds(val OptNilInt64Array)

SetEntityIds sets the value of EntityIds.

func (*SzEntityPath) SetStartEntityId 

func (s *SzEntityPath) SetStartEntityId(val OptInt64)

SetStartEntityId sets the value of StartEntityId.

func (*SzEntityPath) UnmarshalJSON 

func (s *SzEntityPath) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzEntityPath) Validate 

func (s *SzEntityPath) Validate() error

type SzEntityPathData 

type SzEntityPathData struct {
	EntityPath OptSzEntityPath `json:"entityPath"`
	// The array of `SzEntityData` objects describing the entities on the path.  This will include
	// partial information on the first-degree related entities to the entity.
	Entities []SzEntityData `json:"entities"`
}

Describes a path between two entities using the entity IDs of the entities in the path and includes the data from the actual entities on the path. Ref: #/components/schemas/SzEntityPathData

func (*SzEntityPathData) Decode 

func (s *SzEntityPathData) Decode(d *jx.Decoder) error

Decode decodes SzEntityPathData from json.

func (*SzEntityPathData) Encode 

func (s *SzEntityPathData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityPathData) GetEntities 

func (s *SzEntityPathData) GetEntities() []SzEntityData

GetEntities returns the value of Entities.

func (*SzEntityPathData) GetEntityPath 

func (s *SzEntityPathData) GetEntityPath() OptSzEntityPath

GetEntityPath returns the value of EntityPath.

func (*SzEntityPathData) MarshalJSON 

func (s *SzEntityPathData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityPathData) SetEntities 

func (s *SzEntityPathData) SetEntities(val []SzEntityData)

SetEntities sets the value of Entities.

func (*SzEntityPathData) SetEntityPath 

func (s *SzEntityPathData) SetEntityPath(val OptSzEntityPath)

SetEntityPath sets the value of EntityPath.

func (*SzEntityPathData) UnmarshalJSON 

func (s *SzEntityPathData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzEntityPathData) Validate 

func (s *SzEntityPathData) Validate() error

type SzEntityPathResponse 

type SzEntityPathResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzEntityPathResponseRawData `json:"rawData"`
	Data    OptSzEntityPathData               `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzEntityPathResponse

func (*SzEntityPathResponse) Decode 

func (s *SzEntityPathResponse) Decode(d *jx.Decoder) error

Decode decodes SzEntityPathResponse from json.

func (*SzEntityPathResponse) Encode 

func (s *SzEntityPathResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityPathResponse) GetData 

func (s *SzEntityPathResponse) GetData() OptSzEntityPathData

GetData returns the value of Data. 

func (s *SzEntityPathResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzEntityPathResponse) GetMeta 

func (s *SzEntityPathResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzEntityPathResponse) GetRawData 

func (s *SzEntityPathResponse) GetRawData() OptNilSzEntityPathResponseRawData

GetRawData returns the value of RawData.

func (*SzEntityPathResponse) MarshalJSON 

func (s *SzEntityPathResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityPathResponse) SetData 

func (s *SzEntityPathResponse) SetData(val OptSzEntityPathData)

SetData sets the value of Data. 

func (s *SzEntityPathResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzEntityPathResponse) SetMeta 

func (s *SzEntityPathResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzEntityPathResponse) SetRawData 

func (s *SzEntityPathResponse) SetRawData(val OptNilSzEntityPathResponseRawData)

SetRawData sets the value of RawData.

func (*SzEntityPathResponse) UnmarshalJSON 

func (s *SzEntityPathResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzEntityPathResponse) Validate 

func (s *SzEntityPathResponse) Validate() error

type SzEntityPathResponseRawData 

type SzEntityPathResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzEntityPathResponseRawData) Decode 

func (s *SzEntityPathResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzEntityPathResponseRawData from json.

func (SzEntityPathResponseRawData) Encode 

func (s SzEntityPathResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzEntityPathResponseRawData) MarshalJSON 

func (s SzEntityPathResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityPathResponseRawData) UnmarshalJSON 

func (s *SzEntityPathResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzEntityRecord 

type SzEntityRecord struct {
	// The data source code identifying the source from which the record was loaded.
	DataSource OptString `json:"dataSource"`
	// The identifier that uniquely identifies this record from other records from the same data source.
	// This may have been loaded with the record or automatically generated from the record's data.
	RecordId OptString `json:"recordId"`
	// The optional array of record feature references to the entity features along with the record's
	// usage type if any.
	FeatureReferences OptNilSzFeatureReferenceArray `json:"featureReferences"`
	// The timestamp that the record was most recently loaded or updated.
	LastSeenTimestamp OptDateTime `json:"lastSeenTimestamp"`
	// An array of addresses associated with the record that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "HOME: 101 Main Street").
	AddressData []string `json:"addressData"`
	// An array of characteristics associated with the record that are
	// formatted for readability.  These will be prefixed by a
	// characteristic type and optionally by a "usage type" if one was
	// provided.
	// **NOTE:** The `characteristicData` field is derived from the
	// `ATTRIBUTE_DATA` field in the "raw data" JSON.
	CharacteristicData []string `json:"characteristicData"`
	// An array of entity data associated with the record where the items are formatted for readability.
	// These will be prefixed by an identifier type and may be prefixed by a "usage type" if one was
	// provided (e.g.: "ID: 123456789" or "EMAIL: WORK: joe@nowhere.com").
	IdentifierData []string `json:"identifierData"`
	// An array of names associated with the record that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "Joe Schmoe" or "AKA: Joseph P. Schmoe").
	NameData []string `json:"nameData"`
	// An array of phone numbers associated with the record that are formatted for readability.  These
	// may be prefixed by a "usage type" if one was provided (e.g.: "HOME: 702-555-1212").
	PhoneData []string `json:"phoneData"`
	// An array of relationship data items associated with the record that describes disclosed
	// relationships.
	RelationshipData []string `json:"relationshipData"`
	// An array of associated data items that were loaded with the record but not normally recognized or
	// used for entity resolution.  This array usually contains useful information from the source system.
	OtherData []string `json:"otherData"`
	// The JSON representation of the original data record that was loaded.
	OriginalSourceData OptSzEntityRecordOriginalSourceData `json:"originalSourceData"`
}

Describes a record (aka: observed entity) that has been loaded for a particular data source. Ref: #/components/schemas/SzEntityRecord

func (*SzEntityRecord) Decode 

func (s *SzEntityRecord) Decode(d *jx.Decoder) error

Decode decodes SzEntityRecord from json.

func (*SzEntityRecord) Encode 

func (s *SzEntityRecord) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityRecord) GetAddressData 

func (s *SzEntityRecord) GetAddressData() []string

GetAddressData returns the value of AddressData.

func (*SzEntityRecord) GetCharacteristicData 

func (s *SzEntityRecord) GetCharacteristicData() []string

GetCharacteristicData returns the value of CharacteristicData.

func (*SzEntityRecord) GetDataSource 

func (s *SzEntityRecord) GetDataSource() OptString

GetDataSource returns the value of DataSource.

func (*SzEntityRecord) GetFeatureReferences 

func (s *SzEntityRecord) GetFeatureReferences() OptNilSzFeatureReferenceArray

GetFeatureReferences returns the value of FeatureReferences.

func (*SzEntityRecord) GetIdentifierData 

func (s *SzEntityRecord) GetIdentifierData() []string

GetIdentifierData returns the value of IdentifierData.

func (*SzEntityRecord) GetLastSeenTimestamp 

func (s *SzEntityRecord) GetLastSeenTimestamp() OptDateTime

GetLastSeenTimestamp returns the value of LastSeenTimestamp.

func (*SzEntityRecord) GetNameData 

func (s *SzEntityRecord) GetNameData() []string

GetNameData returns the value of NameData.

func (*SzEntityRecord) GetOriginalSourceData 

func (s *SzEntityRecord) GetOriginalSourceData() OptSzEntityRecordOriginalSourceData

GetOriginalSourceData returns the value of OriginalSourceData.

func (*SzEntityRecord) GetOtherData 

func (s *SzEntityRecord) GetOtherData() []string

GetOtherData returns the value of OtherData.

func (*SzEntityRecord) GetPhoneData 

func (s *SzEntityRecord) GetPhoneData() []string

GetPhoneData returns the value of PhoneData.

func (*SzEntityRecord) GetRecordId 

func (s *SzEntityRecord) GetRecordId() OptString

GetRecordId returns the value of RecordId.

func (*SzEntityRecord) GetRelationshipData 

func (s *SzEntityRecord) GetRelationshipData() []string

GetRelationshipData returns the value of RelationshipData.

func (*SzEntityRecord) MarshalJSON 

func (s *SzEntityRecord) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityRecord) SetAddressData 

func (s *SzEntityRecord) SetAddressData(val []string)

SetAddressData sets the value of AddressData.

func (*SzEntityRecord) SetCharacteristicData 

func (s *SzEntityRecord) SetCharacteristicData(val []string)

SetCharacteristicData sets the value of CharacteristicData.

func (*SzEntityRecord) SetDataSource 

func (s *SzEntityRecord) SetDataSource(val OptString)

SetDataSource sets the value of DataSource.

func (*SzEntityRecord) SetFeatureReferences 

func (s *SzEntityRecord) SetFeatureReferences(val OptNilSzFeatureReferenceArray)

SetFeatureReferences sets the value of FeatureReferences.

func (*SzEntityRecord) SetIdentifierData 

func (s *SzEntityRecord) SetIdentifierData(val []string)

SetIdentifierData sets the value of IdentifierData.

func (*SzEntityRecord) SetLastSeenTimestamp 

func (s *SzEntityRecord) SetLastSeenTimestamp(val OptDateTime)

SetLastSeenTimestamp sets the value of LastSeenTimestamp.

func (*SzEntityRecord) SetNameData 

func (s *SzEntityRecord) SetNameData(val []string)

SetNameData sets the value of NameData.

func (*SzEntityRecord) SetOriginalSourceData 

func (s *SzEntityRecord) SetOriginalSourceData(val OptSzEntityRecordOriginalSourceData)

SetOriginalSourceData sets the value of OriginalSourceData.

func (*SzEntityRecord) SetOtherData 

func (s *SzEntityRecord) SetOtherData(val []string)

SetOtherData sets the value of OtherData.

func (*SzEntityRecord) SetPhoneData 

func (s *SzEntityRecord) SetPhoneData(val []string)

SetPhoneData sets the value of PhoneData.

func (*SzEntityRecord) SetRecordId 

func (s *SzEntityRecord) SetRecordId(val OptString)

SetRecordId sets the value of RecordId.

func (*SzEntityRecord) SetRelationshipData 

func (s *SzEntityRecord) SetRelationshipData(val []string)

SetRelationshipData sets the value of RelationshipData.

func (*SzEntityRecord) UnmarshalJSON 

func (s *SzEntityRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzEntityRecord) Validate 

func (s *SzEntityRecord) Validate() error

type SzEntityRecordOriginalSourceData 

type SzEntityRecordOriginalSourceData map[string]jx.Raw

The JSON representation of the original data record that was loaded.

func (*SzEntityRecordOriginalSourceData) Decode 

func (s *SzEntityRecordOriginalSourceData) Decode(d *jx.Decoder) error

Decode decodes SzEntityRecordOriginalSourceData from json.

func (SzEntityRecordOriginalSourceData) Encode 

func (s SzEntityRecordOriginalSourceData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzEntityRecordOriginalSourceData) MarshalJSON 

func (s SzEntityRecordOriginalSourceData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityRecordOriginalSourceData) UnmarshalJSON 

func (s *SzEntityRecordOriginalSourceData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzEntityResponse 

type SzEntityResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzEntityResponseRawData `json:"rawData"`
	Data    OptSzEntityData               `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzEntityResponse

func (*SzEntityResponse) Decode 

func (s *SzEntityResponse) Decode(d *jx.Decoder) error

Decode decodes SzEntityResponse from json.

func (*SzEntityResponse) Encode 

func (s *SzEntityResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzEntityResponse) GetData 

func (s *SzEntityResponse) GetData() OptSzEntityData

GetData returns the value of Data. 

func (s *SzEntityResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzEntityResponse) GetMeta 

func (s *SzEntityResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzEntityResponse) GetRawData 

func (s *SzEntityResponse) GetRawData() OptNilSzEntityResponseRawData

GetRawData returns the value of RawData.

func (*SzEntityResponse) MarshalJSON 

func (s *SzEntityResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityResponse) SetData 

func (s *SzEntityResponse) SetData(val OptSzEntityData)

SetData sets the value of Data. 

func (s *SzEntityResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzEntityResponse) SetMeta 

func (s *SzEntityResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzEntityResponse) SetRawData 

func (s *SzEntityResponse) SetRawData(val OptNilSzEntityResponseRawData)

SetRawData sets the value of RawData.

func (*SzEntityResponse) UnmarshalJSON 

func (s *SzEntityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzEntityResponse) Validate 

func (s *SzEntityResponse) Validate() error

type SzEntityResponseRawData 

type SzEntityResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzEntityResponseRawData) Decode 

func (s *SzEntityResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzEntityResponseRawData from json.

func (SzEntityResponseRawData) Encode 

func (s SzEntityResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzEntityResponseRawData) MarshalJSON 

func (s SzEntityResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzEntityResponseRawData) UnmarshalJSON 

func (s *SzEntityResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzError 

type SzError struct {
	// The internal error code.
	Code OptNilString `json:"code"`
	// The message describing the error.
	Message OptString `json:"message"`
}

Describes an error. Ref: #/components/schemas/SzError

func (*SzError) Decode 

func (s *SzError) Decode(d *jx.Decoder) error

Decode decodes SzError from json.

func (*SzError) Encode 

func (s *SzError) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzError) GetCode 

func (s *SzError) GetCode() OptNilString

GetCode returns the value of Code.

func (*SzError) GetMessage 

func (s *SzError) GetMessage() OptString

GetMessage returns the value of Message.

func (*SzError) MarshalJSON 

func (s *SzError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzError) SetCode 

func (s *SzError) SetCode(val OptNilString)

SetCode sets the value of Code.

func (*SzError) SetMessage 

func (s *SzError) SetMessage(val OptString)

SetMessage sets the value of Message.

func (*SzError) UnmarshalJSON 

func (s *SzError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzErrorResponse 

type SzErrorResponse struct {
	Meta   OptSzMeta  `json:"meta"`
	Links  OptSzLinks `json:"links"`
	Errors []SzError  `json:"errors"`
}

Merged schema. Ref: #/components/schemas/SzErrorResponse

func (*SzErrorResponse) Decode 

func (s *SzErrorResponse) Decode(d *jx.Decoder) error

Decode decodes SzErrorResponse from json.

func (*SzErrorResponse) Encode 

func (s *SzErrorResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzErrorResponse) GetErrors 

func (s *SzErrorResponse) GetErrors() []SzError

GetErrors returns the value of Errors. 

func (s *SzErrorResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzErrorResponse) GetMeta 

func (s *SzErrorResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzErrorResponse) MarshalJSON 

func (s *SzErrorResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzErrorResponse) SetErrors 

func (s *SzErrorResponse) SetErrors(val []SzError)

SetErrors sets the value of Errors. 

func (s *SzErrorResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzErrorResponse) SetMeta 

func (s *SzErrorResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzErrorResponse) UnmarshalJSON 

func (s *SzErrorResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzErrorResponse) Validate 

func (s *SzErrorResponse) Validate() error

type SzFeatureMode 

type SzFeatureMode string

The method by which feature values should be included for entities returned in the response. The possible values are: * `NONE` - Do not include any feature values -- this is the fastest option from a performance perspective because feature values do not have to be retrieved. * `ENTITY_NAME_ONLY` - Same as `NONE` in that no "features" are returned, but the singular entity name value is determined will be determined and returned. * `REPRESENTATIVE` - Include only a single representative value per "unique" value of a feature. If there are multiple values that are near duplicates then only one value is included and the others are suppressed. * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate feature values and return a representative value along with its near duplicate values. * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level references attributing each feature to the record(s) that provided it for the entity along with any usage type that might have been associated with the feature at the record level. Ref: #/components/schemas/SzFeatureMode 

const (
	SzFeatureModeNONE           SzFeatureMode = "NONE"
	SzFeatureModeENTITYNAMEONLY SzFeatureMode = "ENTITY_NAME_ONLY"
	SzFeatureModeREPRESENTATIVE SzFeatureMode = "REPRESENTATIVE"
	SzFeatureModeWITHDUPLICATES SzFeatureMode = "WITH_DUPLICATES"
	SzFeatureModeATTRIBUTED     SzFeatureMode = "ATTRIBUTED"
)

func (SzFeatureMode) AllValues added in v0.9.0 

func (SzFeatureMode) AllValues() []SzFeatureMode

AllValues returns all SzFeatureMode values.

func (SzFeatureMode) MarshalText 

func (s SzFeatureMode) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzFeatureMode) UnmarshalText 

func (s *SzFeatureMode) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzFeatureMode) Validate 

func (s SzFeatureMode) Validate() error

type SzFeatureReference 

type SzFeatureReference struct {
	// The internal feature ID identifying the feature so that it might be identified and referenced.
	InternalId OptInt64 `json:"internalId"`
	// The optional associated usage type (e.g.: "HOME or "WORK).  This is the usage type with which the
	// record loaded the feature (if any). Other records in the same entity may have the same feature
	// with a different usage type.
	UsageType OptNilString `json:"usageType"`
}

Describes a record's reference to an entity feature along with the optional usage type with which the record references the feature. Ref: #/components/schemas/SzFeatureReference

func (*SzFeatureReference) Decode 

func (s *SzFeatureReference) Decode(d *jx.Decoder) error

Decode decodes SzFeatureReference from json.

func (*SzFeatureReference) Encode 

func (s *SzFeatureReference) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzFeatureReference) GetInternalId 

func (s *SzFeatureReference) GetInternalId() OptInt64

GetInternalId returns the value of InternalId.

func (*SzFeatureReference) GetUsageType 

func (s *SzFeatureReference) GetUsageType() OptNilString

GetUsageType returns the value of UsageType.

func (*SzFeatureReference) MarshalJSON 

func (s *SzFeatureReference) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzFeatureReference) SetInternalId 

func (s *SzFeatureReference) SetInternalId(val OptInt64)

SetInternalId sets the value of InternalId.

func (*SzFeatureReference) SetUsageType 

func (s *SzFeatureReference) SetUsageType(val OptNilString)

SetUsageType sets the value of UsageType.

func (*SzFeatureReference) UnmarshalJSON 

func (s *SzFeatureReference) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzFeatureScore 

type SzFeatureScore struct {
	// The feature type of the features being scored.
	FeatureType OptString `json:"featureType"`
	// The inbound feature described as an `SzScoredFeature`.
	InboundFeature OptSzScoredFeature `json:"inboundFeature"`
	// The feature that was a candidate match for the inbound feature (also described as an
	// `SzScoredFeature`).
	CandidateFeature OptSzScoredFeature `json:"candidateFeature"`
	// The integer score between the two feature values (typically from 0 to 100).  If this is a name
	// feature, then this value is the "best" value from the `SzNameScoring` instance described by
	// `nameScoringDetails` (in order of precedence the first of these values that exists: `orgNameScore`,
	//  `fullNameScore`, `surnameScore` and then `givenNameScore`).
	Score OptInt32 `json:"score"`
	// The name scoring values if this score is for a name feature.  This property is omitted if not a
	// name feature.
	NameScoringDetails OptSzNameScoring `json:"nameScoringDetails"`
	// The `SzScoringBucket` describing the meaning of the `score`.
	ScoringBucket OptSzScoringBucket `json:"scoringBucket"`
	// The `SzScoringBehavior` describing the scoring behavior for the features.
	ScoringBehavior OptSzScoringBehavior `json:"scoringBehavior"`
}

Describes the scoring between two `SzScoredFeature` instances. Ref: #/components/schemas/SzFeatureScore

func (*SzFeatureScore) Decode 

func (s *SzFeatureScore) Decode(d *jx.Decoder) error

Decode decodes SzFeatureScore from json.

func (*SzFeatureScore) Encode 

func (s *SzFeatureScore) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzFeatureScore) GetCandidateFeature 

func (s *SzFeatureScore) GetCandidateFeature() OptSzScoredFeature

GetCandidateFeature returns the value of CandidateFeature.

func (*SzFeatureScore) GetFeatureType 

func (s *SzFeatureScore) GetFeatureType() OptString

GetFeatureType returns the value of FeatureType.

func (*SzFeatureScore) GetInboundFeature 

func (s *SzFeatureScore) GetInboundFeature() OptSzScoredFeature

GetInboundFeature returns the value of InboundFeature.

func (*SzFeatureScore) GetNameScoringDetails 

func (s *SzFeatureScore) GetNameScoringDetails() OptSzNameScoring

GetNameScoringDetails returns the value of NameScoringDetails.

func (*SzFeatureScore) GetScore 

func (s *SzFeatureScore) GetScore() OptInt32

GetScore returns the value of Score.

func (*SzFeatureScore) GetScoringBehavior 

func (s *SzFeatureScore) GetScoringBehavior() OptSzScoringBehavior

GetScoringBehavior returns the value of ScoringBehavior.

func (*SzFeatureScore) GetScoringBucket 

func (s *SzFeatureScore) GetScoringBucket() OptSzScoringBucket

GetScoringBucket returns the value of ScoringBucket.

func (*SzFeatureScore) MarshalJSON 

func (s *SzFeatureScore) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzFeatureScore) SetCandidateFeature 

func (s *SzFeatureScore) SetCandidateFeature(val OptSzScoredFeature)

SetCandidateFeature sets the value of CandidateFeature.

func (*SzFeatureScore) SetFeatureType 

func (s *SzFeatureScore) SetFeatureType(val OptString)

SetFeatureType sets the value of FeatureType.

func (*SzFeatureScore) SetInboundFeature 

func (s *SzFeatureScore) SetInboundFeature(val OptSzScoredFeature)

SetInboundFeature sets the value of InboundFeature.

func (*SzFeatureScore) SetNameScoringDetails 

func (s *SzFeatureScore) SetNameScoringDetails(val OptSzNameScoring)

SetNameScoringDetails sets the value of NameScoringDetails.

func (*SzFeatureScore) SetScore 

func (s *SzFeatureScore) SetScore(val OptInt32)

SetScore sets the value of Score.

func (*SzFeatureScore) SetScoringBehavior 

func (s *SzFeatureScore) SetScoringBehavior(val OptSzScoringBehavior)

SetScoringBehavior sets the value of ScoringBehavior.

func (*SzFeatureScore) SetScoringBucket 

func (s *SzFeatureScore) SetScoringBucket(val OptSzScoringBucket)

SetScoringBucket sets the value of ScoringBucket.

func (*SzFeatureScore) UnmarshalJSON 

func (s *SzFeatureScore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzFeatureScore) Validate 

func (s *SzFeatureScore) Validate() error

type SzFlaggedEntity 

type SzFlaggedEntity struct {
	// The entity ID of the relevant entity.
	EntityId OptInt64 `json:"entityId"`
	// The number of degrees this entity is separated from the entity that was affected.
	Degrees OptInt8 `json:"degrees"`
	// The array of flags that were triggered making this entity relevant.
	Flags []string `json:"flags"`
	// An array of objects describing sample records from the relevant entity and the triggered flags for
	// that record.
	SampleRecords []SzFlaggedRecord `json:"sampleRecords"`
}

An entity that was flagged as relevant due to the resolution operation. Ref: #/components/schemas/SzFlaggedEntity

func (*SzFlaggedEntity) Decode 

func (s *SzFlaggedEntity) Decode(d *jx.Decoder) error

Decode decodes SzFlaggedEntity from json.

func (*SzFlaggedEntity) Encode 

func (s *SzFlaggedEntity) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzFlaggedEntity) GetDegrees 

func (s *SzFlaggedEntity) GetDegrees() OptInt8

GetDegrees returns the value of Degrees.

func (*SzFlaggedEntity) GetEntityId 

func (s *SzFlaggedEntity) GetEntityId() OptInt64

GetEntityId returns the value of EntityId.

func (*SzFlaggedEntity) GetFlags 

func (s *SzFlaggedEntity) GetFlags() []string

GetFlags returns the value of Flags.

func (*SzFlaggedEntity) GetSampleRecords 

func (s *SzFlaggedEntity) GetSampleRecords() []SzFlaggedRecord

GetSampleRecords returns the value of SampleRecords.

func (*SzFlaggedEntity) MarshalJSON 

func (s *SzFlaggedEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzFlaggedEntity) SetDegrees 

func (s *SzFlaggedEntity) SetDegrees(val OptInt8)

SetDegrees sets the value of Degrees.

func (*SzFlaggedEntity) SetEntityId 

func (s *SzFlaggedEntity) SetEntityId(val OptInt64)

SetEntityId sets the value of EntityId.

func (*SzFlaggedEntity) SetFlags 

func (s *SzFlaggedEntity) SetFlags(val []string)

SetFlags sets the value of Flags.

func (*SzFlaggedEntity) SetSampleRecords 

func (s *SzFlaggedEntity) SetSampleRecords(val []SzFlaggedRecord)

SetSampleRecords sets the value of SampleRecords.

func (*SzFlaggedEntity) UnmarshalJSON 

func (s *SzFlaggedEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzFlaggedRecord 

type SzFlaggedRecord struct {
	// The data source code associated with the sample record. type: string.
	DataSource OptString `json:"dataSource"`
	// The record ID identifying with the same record.
	RecordId OptString `json:"recordId"`
	// The array of flags triggered by the sample record.
	Flags []string `json:"flags"`
}

Describes a sample record from an `SzFlaggedEntity` including the triggered flags for that record. Ref: #/components/schemas/SzFlaggedRecord

func (*SzFlaggedRecord) Decode 

func (s *SzFlaggedRecord) Decode(d *jx.Decoder) error

Decode decodes SzFlaggedRecord from json.

func (*SzFlaggedRecord) Encode 

func (s *SzFlaggedRecord) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzFlaggedRecord) GetDataSource 

func (s *SzFlaggedRecord) GetDataSource() OptString

GetDataSource returns the value of DataSource.

func (*SzFlaggedRecord) GetFlags 

func (s *SzFlaggedRecord) GetFlags() []string

GetFlags returns the value of Flags.

func (*SzFlaggedRecord) GetRecordId 

func (s *SzFlaggedRecord) GetRecordId() OptString

GetRecordId returns the value of RecordId.

func (*SzFlaggedRecord) MarshalJSON 

func (s *SzFlaggedRecord) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzFlaggedRecord) SetDataSource 

func (s *SzFlaggedRecord) SetDataSource(val OptString)

SetDataSource sets the value of DataSource.

func (*SzFlaggedRecord) SetFlags 

func (s *SzFlaggedRecord) SetFlags(val []string)

SetFlags sets the value of Flags.

func (*SzFlaggedRecord) SetRecordId 

func (s *SzFlaggedRecord) SetRecordId(val OptString)

SetRecordId sets the value of RecordId.

func (*SzFlaggedRecord) UnmarshalJSON 

func (s *SzFlaggedRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzHowEntityResponse 

type SzHowEntityResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzHowEntityResponseRawData `json:"rawData"`
	// The data field is the `SzHowEntityResult` itself.
	Data OptSzHowEntityResult `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzHowEntityResponse

func (*SzHowEntityResponse) Decode 

func (s *SzHowEntityResponse) Decode(d *jx.Decoder) error

Decode decodes SzHowEntityResponse from json.

func (*SzHowEntityResponse) Encode 

func (s *SzHowEntityResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzHowEntityResponse) GetData 

func (s *SzHowEntityResponse) GetData() OptSzHowEntityResult

GetData returns the value of Data. 

func (s *SzHowEntityResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzHowEntityResponse) GetMeta 

func (s *SzHowEntityResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzHowEntityResponse) GetRawData 

func (s *SzHowEntityResponse) GetRawData() OptNilSzHowEntityResponseRawData

GetRawData returns the value of RawData.

func (*SzHowEntityResponse) MarshalJSON 

func (s *SzHowEntityResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzHowEntityResponse) SetData 

func (s *SzHowEntityResponse) SetData(val OptSzHowEntityResult)

SetData sets the value of Data. 

func (s *SzHowEntityResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzHowEntityResponse) SetMeta 

func (s *SzHowEntityResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzHowEntityResponse) SetRawData 

func (s *SzHowEntityResponse) SetRawData(val OptNilSzHowEntityResponseRawData)

SetRawData sets the value of RawData.

func (*SzHowEntityResponse) UnmarshalJSON 

func (s *SzHowEntityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzHowEntityResponse) Validate 

func (s *SzHowEntityResponse) Validate() error

type SzHowEntityResponseRawData 

type SzHowEntityResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzHowEntityResponseRawData) Decode 

func (s *SzHowEntityResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzHowEntityResponseRawData from json.

func (SzHowEntityResponseRawData) Encode 

func (s SzHowEntityResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzHowEntityResponseRawData) MarshalJSON 

func (s SzHowEntityResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzHowEntityResponseRawData) UnmarshalJSON 

func (s *SzHowEntityResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzHowEntityResult 

type SzHowEntityResult struct {
	// The array of `SzVirtualEntity` instances describing the possible final states for the entity.  If
	// there are more than one elements in the array then the entity requires reevaluation.  If there is
	// only a single element in the array, then reevaluation is not required.  This array will always
	// have at least one element.
	FinalStates []SzVirtualEntity `json:"finalStates"`
	// The map of virtual entity ID's for non-singleton virtual entities to `SzResolutionStep` instances
	// describing how the virtual entity for the respective virtual entity ID was formed.  Since
	// singleton virtual entities are base building blocks, they do not have an associated how step.
	// They are simply formed by the loading of a record to the repository.
	ResolutionSteps OptSzHowEntityResultResolutionSteps `json:"resolutionSteps"`
}

Describes the result of the "how entity" operation as a mapping of non-singleton virtual entity ID's to their corresponding `SzResolutionStep` instances as well as an array of `SzVirtualEntity` instances describing the possible final states for the entity. **NOTE**: If there are more than one possible final states then the entity requires reevaluation, while a result with a single final state does not require reevaluation. Ref: #/components/schemas/SzHowEntityResult

func (*SzHowEntityResult) Decode 

func (s *SzHowEntityResult) Decode(d *jx.Decoder) error

Decode decodes SzHowEntityResult from json.

func (*SzHowEntityResult) Encode 

func (s *SzHowEntityResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzHowEntityResult) GetFinalStates 

func (s *SzHowEntityResult) GetFinalStates() []SzVirtualEntity

GetFinalStates returns the value of FinalStates.

func (*SzHowEntityResult) GetResolutionSteps 

func (s *SzHowEntityResult) GetResolutionSteps() OptSzHowEntityResultResolutionSteps

GetResolutionSteps returns the value of ResolutionSteps.

func (*SzHowEntityResult) MarshalJSON 

func (s *SzHowEntityResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzHowEntityResult) SetFinalStates 

func (s *SzHowEntityResult) SetFinalStates(val []SzVirtualEntity)

SetFinalStates sets the value of FinalStates.

func (*SzHowEntityResult) SetResolutionSteps 

func (s *SzHowEntityResult) SetResolutionSteps(val OptSzHowEntityResultResolutionSteps)

SetResolutionSteps sets the value of ResolutionSteps.

func (*SzHowEntityResult) UnmarshalJSON 

func (s *SzHowEntityResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzHowEntityResult) Validate 

func (s *SzHowEntityResult) Validate() error

type SzHowEntityResultResolutionSteps 

type SzHowEntityResultResolutionSteps map[string]SzResolutionStep

The map of virtual entity ID's for non-singleton virtual entities to `SzResolutionStep` instances describing how the virtual entity for the respective virtual entity ID was formed. Since singleton virtual entities are base building blocks, they do not have an associated how step. They are simply formed by the loading of a record to the repository.

func (*SzHowEntityResultResolutionSteps) Decode 

func (s *SzHowEntityResultResolutionSteps) Decode(d *jx.Decoder) error

Decode decodes SzHowEntityResultResolutionSteps from json.

func (SzHowEntityResultResolutionSteps) Encode 

func (s SzHowEntityResultResolutionSteps) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzHowEntityResultResolutionSteps) MarshalJSON 

func (s SzHowEntityResultResolutionSteps) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzHowEntityResultResolutionSteps) UnmarshalJSON 

func (s *SzHowEntityResultResolutionSteps) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SzHowEntityResultResolutionSteps) Validate 

func (s SzHowEntityResultResolutionSteps) Validate() error

type SzHowMatchInfo 

type SzHowMatchInfo struct {
	// The match key indicating the components of the match.
	MatchKey OptString `json:"matchKey"`
	// The resolution rule that triggered the match.
	ResolutionRule OptNilString `json:"resolutionRule"`
	// The map of feature types to arrays of `SzFeatureScore` instances for that feature type.
	FeatureScores OptNilSzHowMatchInfoFeatureScores `json:"featureScores"`
}

The match info describing how a step in an entity's resolution completed and why the two virtual entities were resolved. Ref: #/components/schemas/SzHowMatchInfo

func (*SzHowMatchInfo) Decode 

func (s *SzHowMatchInfo) Decode(d *jx.Decoder) error

Decode decodes SzHowMatchInfo from json.

func (*SzHowMatchInfo) Encode 

func (s *SzHowMatchInfo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzHowMatchInfo) GetFeatureScores 

func (s *SzHowMatchInfo) GetFeatureScores() OptNilSzHowMatchInfoFeatureScores

GetFeatureScores returns the value of FeatureScores.

func (*SzHowMatchInfo) GetMatchKey 

func (s *SzHowMatchInfo) GetMatchKey() OptString

GetMatchKey returns the value of MatchKey.

func (*SzHowMatchInfo) GetResolutionRule 

func (s *SzHowMatchInfo) GetResolutionRule() OptNilString

GetResolutionRule returns the value of ResolutionRule.

func (*SzHowMatchInfo) MarshalJSON 

func (s *SzHowMatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzHowMatchInfo) SetFeatureScores 

func (s *SzHowMatchInfo) SetFeatureScores(val OptNilSzHowMatchInfoFeatureScores)

SetFeatureScores sets the value of FeatureScores.

func (*SzHowMatchInfo) SetMatchKey 

func (s *SzHowMatchInfo) SetMatchKey(val OptString)

SetMatchKey sets the value of MatchKey.

func (*SzHowMatchInfo) SetResolutionRule 

func (s *SzHowMatchInfo) SetResolutionRule(val OptNilString)

SetResolutionRule sets the value of ResolutionRule.

func (*SzHowMatchInfo) UnmarshalJSON 

func (s *SzHowMatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzHowMatchInfo) Validate 

func (s *SzHowMatchInfo) Validate() error

type SzHowMatchInfoFeatureScores 

type SzHowMatchInfoFeatureScores map[string][]SzFeatureScore

The map of feature types to arrays of `SzFeatureScore` instances for that feature type.

func (*SzHowMatchInfoFeatureScores) Decode 

func (s *SzHowMatchInfoFeatureScores) Decode(d *jx.Decoder) error

Decode decodes SzHowMatchInfoFeatureScores from json.

func (SzHowMatchInfoFeatureScores) Encode 

func (s SzHowMatchInfoFeatureScores) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzHowMatchInfoFeatureScores) MarshalJSON 

func (s SzHowMatchInfoFeatureScores) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzHowMatchInfoFeatureScores) UnmarshalJSON 

func (s *SzHowMatchInfoFeatureScores) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SzHowMatchInfoFeatureScores) Validate 

func (s SzHowMatchInfoFeatureScores) Validate() error

type SzHttpMethod 

type SzHttpMethod string

The HTTP method that was used for the operation. The possible values are: * `GET` - An HTTP GET operation. * `POST` - An HTTP POST operation. * `PUT` - An HTTP PUT operation. * `PATCH` - An HTTP PATCH operation. * `DELETE` - An HTTP DELETE operation. Ref: #/components/schemas/SzHttpMethod 

const (
	SzHttpMethodGET    SzHttpMethod = "GET"
	SzHttpMethodPOST   SzHttpMethod = "POST"
	SzHttpMethodPUT    SzHttpMethod = "PUT"
	SzHttpMethodPATCH  SzHttpMethod = "PATCH"
	SzHttpMethodDELETE SzHttpMethod = "DELETE"
)

func (SzHttpMethod) AllValues added in v0.9.0 

func (SzHttpMethod) AllValues() []SzHttpMethod

AllValues returns all SzHttpMethod values.

func (*SzHttpMethod) Decode 

func (s *SzHttpMethod) Decode(d *jx.Decoder) error

Decode decodes SzHttpMethod from json.

func (SzHttpMethod) Encode 

func (s SzHttpMethod) Encode(e *jx.Encoder)

Encode encodes SzHttpMethod as json.

func (SzHttpMethod) MarshalJSON 

func (s SzHttpMethod) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzHttpMethod) MarshalText 

func (s SzHttpMethod) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzHttpMethod) UnmarshalJSON 

func (s *SzHttpMethod) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzHttpMethod) UnmarshalText 

func (s *SzHttpMethod) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzHttpMethod) Validate 

func (s SzHttpMethod) Validate() error

type SzLicenseInfo 

type SzLicenseInfo struct {
	// The customer information associated with the license.
	Customer OptString `json:"customer"`
	// The contract information associated with the license.
	Contract OptString `json:"contract"`
	// The description of the type of license.
	LicenseType OptString `json:"licenseType"`
	// The description of the license level.
	LicenseLevel OptString `json:"licenseLevel"`
	// The billing information associated with the license.
	Billing OptString `json:"billing"`
	// The issuance date for the license.
	IssuanceDate OptDateTime `json:"issuanceDate"`
	// The expiration date for the license.
	ExpirationDate OptDateTime `json:"expirationDate"`
	// The record limit associated with the license.
	RecordLimit OptInt64 `json:"recordLimit"`
}

Describes the Senzing product license. Ref: #/components/schemas/SzLicenseInfo

func (*SzLicenseInfo) Decode 

func (s *SzLicenseInfo) Decode(d *jx.Decoder) error

Decode decodes SzLicenseInfo from json.

func (*SzLicenseInfo) Encode 

func (s *SzLicenseInfo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzLicenseInfo) GetBilling 

func (s *SzLicenseInfo) GetBilling() OptString

GetBilling returns the value of Billing.

func (*SzLicenseInfo) GetContract 

func (s *SzLicenseInfo) GetContract() OptString

GetContract returns the value of Contract.

func (*SzLicenseInfo) GetCustomer 

func (s *SzLicenseInfo) GetCustomer() OptString

GetCustomer returns the value of Customer.

func (*SzLicenseInfo) GetExpirationDate 

func (s *SzLicenseInfo) GetExpirationDate() OptDateTime

GetExpirationDate returns the value of ExpirationDate.

func (*SzLicenseInfo) GetIssuanceDate 

func (s *SzLicenseInfo) GetIssuanceDate() OptDateTime

GetIssuanceDate returns the value of IssuanceDate.

func (*SzLicenseInfo) GetLicenseLevel 

func (s *SzLicenseInfo) GetLicenseLevel() OptString

GetLicenseLevel returns the value of LicenseLevel.

func (*SzLicenseInfo) GetLicenseType 

func (s *SzLicenseInfo) GetLicenseType() OptString

GetLicenseType returns the value of LicenseType.

func (*SzLicenseInfo) GetRecordLimit 

func (s *SzLicenseInfo) GetRecordLimit() OptInt64

GetRecordLimit returns the value of RecordLimit.

func (*SzLicenseInfo) MarshalJSON 

func (s *SzLicenseInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzLicenseInfo) SetBilling 

func (s *SzLicenseInfo) SetBilling(val OptString)

SetBilling sets the value of Billing.

func (*SzLicenseInfo) SetContract 

func (s *SzLicenseInfo) SetContract(val OptString)

SetContract sets the value of Contract.

func (*SzLicenseInfo) SetCustomer 

func (s *SzLicenseInfo) SetCustomer(val OptString)

SetCustomer sets the value of Customer.

func (*SzLicenseInfo) SetExpirationDate 

func (s *SzLicenseInfo) SetExpirationDate(val OptDateTime)

SetExpirationDate sets the value of ExpirationDate.

func (*SzLicenseInfo) SetIssuanceDate 

func (s *SzLicenseInfo) SetIssuanceDate(val OptDateTime)

SetIssuanceDate sets the value of IssuanceDate.

func (*SzLicenseInfo) SetLicenseLevel 

func (s *SzLicenseInfo) SetLicenseLevel(val OptString)

SetLicenseLevel sets the value of LicenseLevel.

func (*SzLicenseInfo) SetLicenseType 

func (s *SzLicenseInfo) SetLicenseType(val OptString)

SetLicenseType sets the value of LicenseType.

func (*SzLicenseInfo) SetRecordLimit 

func (s *SzLicenseInfo) SetRecordLimit(val OptInt64)

SetRecordLimit sets the value of RecordLimit.

func (*SzLicenseInfo) UnmarshalJSON 

func (s *SzLicenseInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzLicenseResponse 

type SzLicenseResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzLicenseResponseRawData `json:"rawData"`
	Data    OptSzLicenseResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzLicenseResponse

func (*SzLicenseResponse) Decode 

func (s *SzLicenseResponse) Decode(d *jx.Decoder) error

Decode decodes SzLicenseResponse from json.

func (*SzLicenseResponse) Encode 

func (s *SzLicenseResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzLicenseResponse) GetData 

func (s *SzLicenseResponse) GetData() OptSzLicenseResponseData

GetData returns the value of Data. 

func (s *SzLicenseResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzLicenseResponse) GetMeta 

func (s *SzLicenseResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzLicenseResponse) GetRawData 

func (s *SzLicenseResponse) GetRawData() OptNilSzLicenseResponseRawData

GetRawData returns the value of RawData.

func (*SzLicenseResponse) MarshalJSON 

func (s *SzLicenseResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzLicenseResponse) SetData 

func (s *SzLicenseResponse) SetData(val OptSzLicenseResponseData)

SetData sets the value of Data. 

func (s *SzLicenseResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzLicenseResponse) SetMeta 

func (s *SzLicenseResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzLicenseResponse) SetRawData 

func (s *SzLicenseResponse) SetRawData(val OptNilSzLicenseResponseRawData)

SetRawData sets the value of RawData.

func (*SzLicenseResponse) UnmarshalJSON 

func (s *SzLicenseResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzLicenseResponse) Validate 

func (s *SzLicenseResponse) Validate() error

type SzLicenseResponseData 

type SzLicenseResponseData struct {
	License OptSzLicenseInfo `json:"license"`
}

Represents the data segment included with an `SzLicenseResponse`. Ref: #/components/schemas/SzLicenseResponseData

func (*SzLicenseResponseData) Decode 

func (s *SzLicenseResponseData) Decode(d *jx.Decoder) error

Decode decodes SzLicenseResponseData from json.

func (*SzLicenseResponseData) Encode 

func (s *SzLicenseResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzLicenseResponseData) GetLicense 

func (s *SzLicenseResponseData) GetLicense() OptSzLicenseInfo

GetLicense returns the value of License.

func (*SzLicenseResponseData) MarshalJSON 

func (s *SzLicenseResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzLicenseResponseData) SetLicense 

func (s *SzLicenseResponseData) SetLicense(val OptSzLicenseInfo)

SetLicense sets the value of License.

func (*SzLicenseResponseData) UnmarshalJSON 

func (s *SzLicenseResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzLicenseResponseRawData 

type SzLicenseResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzLicenseResponseRawData) Decode 

func (s *SzLicenseResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzLicenseResponseRawData from json.

func (SzLicenseResponseRawData) Encode 

func (s SzLicenseResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzLicenseResponseRawData) MarshalJSON 

func (s SzLicenseResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzLicenseResponseRawData) UnmarshalJSON 

func (s *SzLicenseResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler. 

type SzLinks struct {
	Self                 OptString `json:"self"`
	OpenApiSpecification OptString `json:"openApiSpecification"`
}

Represents the default links returned with each response. Ref: #/components/schemas/SzLinks

func (*SzLinks) Decode 

func (s *SzLinks) Decode(d *jx.Decoder) error

Decode decodes SzLinks from json.

func (*SzLinks) Encode 

func (s *SzLinks) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzLinks) GetOpenApiSpecification 

func (s *SzLinks) GetOpenApiSpecification() OptString

GetOpenApiSpecification returns the value of OpenApiSpecification.

func (*SzLinks) GetSelf 

func (s *SzLinks) GetSelf() OptString

GetSelf returns the value of Self.

func (*SzLinks) MarshalJSON 

func (s *SzLinks) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzLinks) SetOpenApiSpecification 

func (s *SzLinks) SetOpenApiSpecification(val OptString)

SetOpenApiSpecification sets the value of OpenApiSpecification.

func (*SzLinks) SetSelf 

func (s *SzLinks) SetSelf(val OptString)

SetSelf sets the value of Self.

func (*SzLinks) UnmarshalJSON 

func (s *SzLinks) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzLoadRecordResponse 

type SzLoadRecordResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzLoadRecordResponseRawData `json:"rawData"`
	Data    OptSzLoadRecordResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzLoadRecordResponse

func (*SzLoadRecordResponse) Decode 

func (s *SzLoadRecordResponse) Decode(d *jx.Decoder) error

Decode decodes SzLoadRecordResponse from json.

func (*SzLoadRecordResponse) Encode 

func (s *SzLoadRecordResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzLoadRecordResponse) GetData 

func (s *SzLoadRecordResponse) GetData() OptSzLoadRecordResponseData

GetData returns the value of Data. 

func (s *SzLoadRecordResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzLoadRecordResponse) GetMeta 

func (s *SzLoadRecordResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzLoadRecordResponse) GetRawData 

func (s *SzLoadRecordResponse) GetRawData() OptNilSzLoadRecordResponseRawData

GetRawData returns the value of RawData.

func (*SzLoadRecordResponse) MarshalJSON 

func (s *SzLoadRecordResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzLoadRecordResponse) SetData 

func (s *SzLoadRecordResponse) SetData(val OptSzLoadRecordResponseData)

SetData sets the value of Data. 

func (s *SzLoadRecordResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzLoadRecordResponse) SetMeta 

func (s *SzLoadRecordResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzLoadRecordResponse) SetRawData 

func (s *SzLoadRecordResponse) SetRawData(val OptNilSzLoadRecordResponseRawData)

SetRawData sets the value of RawData.

func (*SzLoadRecordResponse) UnmarshalJSON 

func (s *SzLoadRecordResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzLoadRecordResponse) Validate 

func (s *SzLoadRecordResponse) Validate() error

type SzLoadRecordResponseData 

type SzLoadRecordResponseData struct {
	// The record ID of the record that was loaded.
	RecordId OptString `json:"recordId"`
	// The optionally requested info associated with the load.
	Info OptSzResolutionInfo `json:"info"`
}

Describes the data segment of `SzLoadRecordResponse`. Ref: #/components/schemas/SzLoadRecordResponseData

func (*SzLoadRecordResponseData) Decode 

func (s *SzLoadRecordResponseData) Decode(d *jx.Decoder) error

Decode decodes SzLoadRecordResponseData from json.

func (*SzLoadRecordResponseData) Encode 

func (s *SzLoadRecordResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzLoadRecordResponseData) GetInfo 

func (s *SzLoadRecordResponseData) GetInfo() OptSzResolutionInfo

GetInfo returns the value of Info.

func (*SzLoadRecordResponseData) GetRecordId 

func (s *SzLoadRecordResponseData) GetRecordId() OptString

GetRecordId returns the value of RecordId.

func (*SzLoadRecordResponseData) MarshalJSON 

func (s *SzLoadRecordResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzLoadRecordResponseData) SetInfo 

func (s *SzLoadRecordResponseData) SetInfo(val OptSzResolutionInfo)

SetInfo sets the value of Info.

func (*SzLoadRecordResponseData) SetRecordId 

func (s *SzLoadRecordResponseData) SetRecordId(val OptString)

SetRecordId sets the value of RecordId.

func (*SzLoadRecordResponseData) UnmarshalJSON 

func (s *SzLoadRecordResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzLoadRecordResponseRawData 

type SzLoadRecordResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzLoadRecordResponseRawData) Decode 

func (s *SzLoadRecordResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzLoadRecordResponseRawData from json.

func (SzLoadRecordResponseRawData) Encode 

func (s SzLoadRecordResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzLoadRecordResponseRawData) MarshalJSON 

func (s SzLoadRecordResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzLoadRecordResponseRawData) UnmarshalJSON 

func (s *SzLoadRecordResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzMatchLevel 

type SzMatchLevel string

Describes the various match levels describing how two records resolve against each other. The possible values are: * `NO_MATCH` - No match was found between the records. * `RESOLVED` - The records resolved to the same entity. * `POSSIBLY_SAME` - The records were not close enough to resolve but may represent the same entity if more data was provided. * `POSSIBLY_RELATED` - The records share some attributes that suggest a relationship. * `NAME_ONLY` - The records match in name only. * `DISCLOSED` - An explicit relationship has been disclosed between the records. Ref: #/components/schemas/SzMatchLevel 

const (
	SzMatchLevelNOMATCH         SzMatchLevel = "NO_MATCH"
	SzMatchLevelRESOLVED        SzMatchLevel = "RESOLVED"
	SzMatchLevelPOSSIBLYSAME    SzMatchLevel = "POSSIBLY_SAME"
	SzMatchLevelPOSSIBLYRELATED SzMatchLevel = "POSSIBLY_RELATED"
	SzMatchLevelNAMEONLY        SzMatchLevel = "NAME_ONLY"
	SzMatchLevelDISCLOSED       SzMatchLevel = "DISCLOSED"
)

func (SzMatchLevel) AllValues added in v0.9.0 

func (SzMatchLevel) AllValues() []SzMatchLevel

AllValues returns all SzMatchLevel values.

func (*SzMatchLevel) Decode 

func (s *SzMatchLevel) Decode(d *jx.Decoder) error

Decode decodes SzMatchLevel from json.

func (SzMatchLevel) Encode 

func (s SzMatchLevel) Encode(e *jx.Encoder)

Encode encodes SzMatchLevel as json.

func (SzMatchLevel) MarshalJSON 

func (s SzMatchLevel) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzMatchLevel) MarshalText 

func (s SzMatchLevel) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzMatchLevel) UnmarshalJSON 

func (s *SzMatchLevel) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzMatchLevel) UnmarshalText 

func (s *SzMatchLevel) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzMatchLevel) Validate 

func (s SzMatchLevel) Validate() error

type SzMatchedRecord 

type SzMatchedRecord struct {
	// The data source code identifying the source from which the record was loaded.
	DataSource OptString `json:"dataSource"`
	// The identifier that uniquely identifies this record from other records from the same data source.
	// This may have been loaded with the record or automatically generated from the record's data.
	RecordId OptString `json:"recordId"`
	// The optional array of record feature references to the entity features along with the record's
	// usage type if any.
	FeatureReferences OptNilSzFeatureReferenceArray `json:"featureReferences"`
	// The timestamp that the record was most recently loaded or updated.
	LastSeenTimestamp OptDateTime `json:"lastSeenTimestamp"`
	// An array of addresses associated with the record that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "HOME: 101 Main Street").
	AddressData []string `json:"addressData"`
	// An array of characteristics associated with the record that are
	// formatted for readability.  These will be prefixed by a
	// characteristic type and optionally by a "usage type" if one was
	// provided.
	// **NOTE:** The `characteristicData` field is derived from the
	// `ATTRIBUTE_DATA` field in the "raw data" JSON.
	CharacteristicData []string `json:"characteristicData"`
	// An array of entity data associated with the record where the items are formatted for readability.
	// These will be prefixed by an identifier type and may be prefixed by a "usage type" if one was
	// provided (e.g.: "ID: 123456789" or "EMAIL: WORK: joe@nowhere.com").
	IdentifierData []string `json:"identifierData"`
	// An array of names associated with the record that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "Joe Schmoe" or "AKA: Joseph P. Schmoe").
	NameData []string `json:"nameData"`
	// An array of phone numbers associated with the record that are formatted for readability.  These
	// may be prefixed by a "usage type" if one was provided (e.g.: "HOME: 702-555-1212").
	PhoneData []string `json:"phoneData"`
	// An array of relationship data items associated with the record that describes disclosed
	// relationships.
	RelationshipData []string `json:"relationshipData"`
	// An array of associated data items that were loaded with the record but not normally recognized or
	// used for entity resolution.  This array usually contains useful information from the source system.
	OtherData []string `json:"otherData"`
	// The JSON representation of the original data record that was loaded.
	OriginalSourceData OptSzMatchedRecordOriginalSourceData `json:"originalSourceData"`
	// The match key describing what features matched between the first record in the resolved entity and
	// this record. This is blank for the first record.
	MatchKey OptString `json:"matchKey"`
	// The code identifying the resolution rule that matched this record to the first record in the
	// resolved entity.  This is blank for the first record.
	ResolutionRuleCode OptString `json:"resolutionRuleCode"`
	// The integer "match level" describing how the first record in the resolved entity matched to this
	// record.  This is zero for the first record and usually one (1) for other records.
	MatchLevel OptInt32 `json:"matchLevel"`
}

Merged schema. Ref: #/components/schemas/SzMatchedRecord

func (*SzMatchedRecord) Decode 

func (s *SzMatchedRecord) Decode(d *jx.Decoder) error

Decode decodes SzMatchedRecord from json.

func (*SzMatchedRecord) Encode 

func (s *SzMatchedRecord) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzMatchedRecord) GetAddressData 

func (s *SzMatchedRecord) GetAddressData() []string

GetAddressData returns the value of AddressData.

func (*SzMatchedRecord) GetCharacteristicData 

func (s *SzMatchedRecord) GetCharacteristicData() []string

GetCharacteristicData returns the value of CharacteristicData.

func (*SzMatchedRecord) GetDataSource 

func (s *SzMatchedRecord) GetDataSource() OptString

GetDataSource returns the value of DataSource.

func (*SzMatchedRecord) GetFeatureReferences 

func (s *SzMatchedRecord) GetFeatureReferences() OptNilSzFeatureReferenceArray

GetFeatureReferences returns the value of FeatureReferences.

func (*SzMatchedRecord) GetIdentifierData 

func (s *SzMatchedRecord) GetIdentifierData() []string

GetIdentifierData returns the value of IdentifierData.

func (*SzMatchedRecord) GetLastSeenTimestamp 

func (s *SzMatchedRecord) GetLastSeenTimestamp() OptDateTime

GetLastSeenTimestamp returns the value of LastSeenTimestamp.

func (*SzMatchedRecord) GetMatchKey 

func (s *SzMatchedRecord) GetMatchKey() OptString

GetMatchKey returns the value of MatchKey.

func (*SzMatchedRecord) GetMatchLevel 

func (s *SzMatchedRecord) GetMatchLevel() OptInt32

GetMatchLevel returns the value of MatchLevel.

func (*SzMatchedRecord) GetNameData 

func (s *SzMatchedRecord) GetNameData() []string

GetNameData returns the value of NameData.

func (*SzMatchedRecord) GetOriginalSourceData 

func (s *SzMatchedRecord) GetOriginalSourceData() OptSzMatchedRecordOriginalSourceData

GetOriginalSourceData returns the value of OriginalSourceData.

func (*SzMatchedRecord) GetOtherData 

func (s *SzMatchedRecord) GetOtherData() []string

GetOtherData returns the value of OtherData.

func (*SzMatchedRecord) GetPhoneData 

func (s *SzMatchedRecord) GetPhoneData() []string

GetPhoneData returns the value of PhoneData.

func (*SzMatchedRecord) GetRecordId 

func (s *SzMatchedRecord) GetRecordId() OptString

GetRecordId returns the value of RecordId.

func (*SzMatchedRecord) GetRelationshipData 

func (s *SzMatchedRecord) GetRelationshipData() []string

GetRelationshipData returns the value of RelationshipData.

func (*SzMatchedRecord) GetResolutionRuleCode 

func (s *SzMatchedRecord) GetResolutionRuleCode() OptString

GetResolutionRuleCode returns the value of ResolutionRuleCode.

func (*SzMatchedRecord) MarshalJSON 

func (s *SzMatchedRecord) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzMatchedRecord) SetAddressData 

func (s *SzMatchedRecord) SetAddressData(val []string)

SetAddressData sets the value of AddressData.

func (*SzMatchedRecord) SetCharacteristicData 

func (s *SzMatchedRecord) SetCharacteristicData(val []string)

SetCharacteristicData sets the value of CharacteristicData.

func (*SzMatchedRecord) SetDataSource 

func (s *SzMatchedRecord) SetDataSource(val OptString)

SetDataSource sets the value of DataSource.

func (*SzMatchedRecord) SetFeatureReferences 

func (s *SzMatchedRecord) SetFeatureReferences(val OptNilSzFeatureReferenceArray)

SetFeatureReferences sets the value of FeatureReferences.

func (*SzMatchedRecord) SetIdentifierData 

func (s *SzMatchedRecord) SetIdentifierData(val []string)

SetIdentifierData sets the value of IdentifierData.

func (*SzMatchedRecord) SetLastSeenTimestamp 

func (s *SzMatchedRecord) SetLastSeenTimestamp(val OptDateTime)

SetLastSeenTimestamp sets the value of LastSeenTimestamp.

func (*SzMatchedRecord) SetMatchKey 

func (s *SzMatchedRecord) SetMatchKey(val OptString)

SetMatchKey sets the value of MatchKey.

func (*SzMatchedRecord) SetMatchLevel 

func (s *SzMatchedRecord) SetMatchLevel(val OptInt32)

SetMatchLevel sets the value of MatchLevel.

func (*SzMatchedRecord) SetNameData 

func (s *SzMatchedRecord) SetNameData(val []string)

SetNameData sets the value of NameData.

func (*SzMatchedRecord) SetOriginalSourceData 

func (s *SzMatchedRecord) SetOriginalSourceData(val OptSzMatchedRecordOriginalSourceData)

SetOriginalSourceData sets the value of OriginalSourceData.

func (*SzMatchedRecord) SetOtherData 

func (s *SzMatchedRecord) SetOtherData(val []string)

SetOtherData sets the value of OtherData.

func (*SzMatchedRecord) SetPhoneData 

func (s *SzMatchedRecord) SetPhoneData(val []string)

SetPhoneData sets the value of PhoneData.

func (*SzMatchedRecord) SetRecordId 

func (s *SzMatchedRecord) SetRecordId(val OptString)

SetRecordId sets the value of RecordId.

func (*SzMatchedRecord) SetRelationshipData 

func (s *SzMatchedRecord) SetRelationshipData(val []string)

SetRelationshipData sets the value of RelationshipData.

func (*SzMatchedRecord) SetResolutionRuleCode 

func (s *SzMatchedRecord) SetResolutionRuleCode(val OptString)

SetResolutionRuleCode sets the value of ResolutionRuleCode.

func (*SzMatchedRecord) UnmarshalJSON 

func (s *SzMatchedRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzMatchedRecord) Validate 

func (s *SzMatchedRecord) Validate() error

type SzMatchedRecordOriginalSourceData 

type SzMatchedRecordOriginalSourceData map[string]jx.Raw

The JSON representation of the original data record that was loaded.

func (*SzMatchedRecordOriginalSourceData) Decode 

func (s *SzMatchedRecordOriginalSourceData) Decode(d *jx.Decoder) error

Decode decodes SzMatchedRecordOriginalSourceData from json.

func (SzMatchedRecordOriginalSourceData) Encode 

func (s SzMatchedRecordOriginalSourceData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzMatchedRecordOriginalSourceData) MarshalJSON 

func (s SzMatchedRecordOriginalSourceData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzMatchedRecordOriginalSourceData) UnmarshalJSON 

func (s *SzMatchedRecordOriginalSourceData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzMeta 

type SzMeta struct {
	// The descriptive name of the server that produced the response.
	Server     OptString       `json:"server"`
	HttpMethod OptSzHttpMethod `json:"httpMethod"`
	// The HTTP status response code.
	HttpStatusCode OptInt16 `json:"httpStatusCode"`
	// The timestamp of the operation's execution.
	Timestamp OptDateTime `json:"timestamp"`
	// The version number of the server.
	Version OptString `json:"version"`
	// The REST API specification version implemented by the server.
	RestApiVersion OptString `json:"restApiVersion"`
	// The version of the underlying native Senzing API product.
	NativeApiVersion OptString `json:"nativeApiVersion"`
	// The build version of the underlying native Senzing API product.
	NativeApiBuildVersion OptString `json:"nativeApiBuildVersion"`
	// The build number of the underlying native Senzing API product.
	NativeApiBuildNumber OptString `json:"nativeApiBuildNumber"`
	// The build date of the underlying native Senzing API product.
	NativeApiBuildDate OptDateTime `json:"nativeApiBuildDate"`
	// The config compatilibility version of the underlying native Senzing API product.
	ConfigCompatibilityVersion OptString `json:"configCompatibilityVersion"`
	// The timing measurements that were taken where the keys are identifying what was timed and the
	// values are the number of milliseconds.
	Timings OptNilSzMetaTimings `json:"timings"`
}

Represents the meta data returned with each response. Ref: #/components/schemas/SzMeta

func (*SzMeta) Decode 

func (s *SzMeta) Decode(d *jx.Decoder) error

Decode decodes SzMeta from json.

func (*SzMeta) Encode 

func (s *SzMeta) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzMeta) GetConfigCompatibilityVersion 

func (s *SzMeta) GetConfigCompatibilityVersion() OptString

GetConfigCompatibilityVersion returns the value of ConfigCompatibilityVersion.

func (*SzMeta) GetHttpMethod 

func (s *SzMeta) GetHttpMethod() OptSzHttpMethod

GetHttpMethod returns the value of HttpMethod.

func (*SzMeta) GetHttpStatusCode 

func (s *SzMeta) GetHttpStatusCode() OptInt16

GetHttpStatusCode returns the value of HttpStatusCode.

func (*SzMeta) GetNativeApiBuildDate 

func (s *SzMeta) GetNativeApiBuildDate() OptDateTime

GetNativeApiBuildDate returns the value of NativeApiBuildDate.

func (*SzMeta) GetNativeApiBuildNumber 

func (s *SzMeta) GetNativeApiBuildNumber() OptString

GetNativeApiBuildNumber returns the value of NativeApiBuildNumber.

func (*SzMeta) GetNativeApiBuildVersion 

func (s *SzMeta) GetNativeApiBuildVersion() OptString

GetNativeApiBuildVersion returns the value of NativeApiBuildVersion.

func (*SzMeta) GetNativeApiVersion 

func (s *SzMeta) GetNativeApiVersion() OptString

GetNativeApiVersion returns the value of NativeApiVersion.

func (*SzMeta) GetRestApiVersion 

func (s *SzMeta) GetRestApiVersion() OptString

GetRestApiVersion returns the value of RestApiVersion.

func (*SzMeta) GetServer 

func (s *SzMeta) GetServer() OptString

GetServer returns the value of Server.

func (*SzMeta) GetTimestamp 

func (s *SzMeta) GetTimestamp() OptDateTime

GetTimestamp returns the value of Timestamp.

func (*SzMeta) GetTimings 

func (s *SzMeta) GetTimings() OptNilSzMetaTimings

GetTimings returns the value of Timings.

func (*SzMeta) GetVersion 

func (s *SzMeta) GetVersion() OptString

GetVersion returns the value of Version.

func (*SzMeta) MarshalJSON 

func (s *SzMeta) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzMeta) SetConfigCompatibilityVersion 

func (s *SzMeta) SetConfigCompatibilityVersion(val OptString)

SetConfigCompatibilityVersion sets the value of ConfigCompatibilityVersion.

func (*SzMeta) SetHttpMethod 

func (s *SzMeta) SetHttpMethod(val OptSzHttpMethod)

SetHttpMethod sets the value of HttpMethod.

func (*SzMeta) SetHttpStatusCode 

func (s *SzMeta) SetHttpStatusCode(val OptInt16)

SetHttpStatusCode sets the value of HttpStatusCode.

func (*SzMeta) SetNativeApiBuildDate 

func (s *SzMeta) SetNativeApiBuildDate(val OptDateTime)

SetNativeApiBuildDate sets the value of NativeApiBuildDate.

func (*SzMeta) SetNativeApiBuildNumber 

func (s *SzMeta) SetNativeApiBuildNumber(val OptString)

SetNativeApiBuildNumber sets the value of NativeApiBuildNumber.

func (*SzMeta) SetNativeApiBuildVersion 

func (s *SzMeta) SetNativeApiBuildVersion(val OptString)

SetNativeApiBuildVersion sets the value of NativeApiBuildVersion.

func (*SzMeta) SetNativeApiVersion 

func (s *SzMeta) SetNativeApiVersion(val OptString)

SetNativeApiVersion sets the value of NativeApiVersion.

func (*SzMeta) SetRestApiVersion 

func (s *SzMeta) SetRestApiVersion(val OptString)

SetRestApiVersion sets the value of RestApiVersion.

func (*SzMeta) SetServer 

func (s *SzMeta) SetServer(val OptString)

SetServer sets the value of Server.

func (*SzMeta) SetTimestamp 

func (s *SzMeta) SetTimestamp(val OptDateTime)

SetTimestamp sets the value of Timestamp.

func (*SzMeta) SetTimings 

func (s *SzMeta) SetTimings(val OptNilSzMetaTimings)

SetTimings sets the value of Timings.

func (*SzMeta) SetVersion 

func (s *SzMeta) SetVersion(val OptString)

SetVersion sets the value of Version.

func (*SzMeta) UnmarshalJSON 

func (s *SzMeta) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzMeta) Validate 

func (s *SzMeta) Validate() error

type SzMetaTimings 

type SzMetaTimings map[string]int64

The timing measurements that were taken where the keys are identifying what was timed and the values are the number of milliseconds.

func (*SzMetaTimings) Decode 

func (s *SzMetaTimings) Decode(d *jx.Decoder) error

Decode decodes SzMetaTimings from json.

func (SzMetaTimings) Encode 

func (s SzMetaTimings) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzMetaTimings) MarshalJSON 

func (s SzMetaTimings) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzMetaTimings) UnmarshalJSON 

func (s *SzMetaTimings) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzNameScoring 

type SzNameScoring struct {
	// The full name score.  This field is omitted if there is not a full name score (e.g.: with an
	// organization name).
	FullNameScore OptInt32 `json:"fullNameScore"`
	// The surname score.  This field is omitted if there is not a surname score (e.g.: with an
	// organization name or if there were no surnames to compare).
	SurnameScore OptInt32 `json:"surnameScore"`
	// The given name score.  This field is omitted if there is not a given name score (e.g.: with an
	// organization name or if there were no given names to compare).
	GivenNameScore OptInt32 `json:"givenNameScore"`
	// The generation match score.  This field is omitted if there is not a generation match score (e.g.:
	// with an organization name or if there were no generations to compare).
	GenerationScore OptInt32 `json:"generationScore"`
	// The organization name score.  This field is omitted if there is not a organization name score (e.g.
	// : with an personal name).
	OrgNameScore OptInt32 `json:"orgNameScore"`
}

Describes the scoring details between two names. Ref: #/components/schemas/SzNameScoring

func (*SzNameScoring) Decode 

func (s *SzNameScoring) Decode(d *jx.Decoder) error

Decode decodes SzNameScoring from json.

func (*SzNameScoring) Encode 

func (s *SzNameScoring) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzNameScoring) GetFullNameScore 

func (s *SzNameScoring) GetFullNameScore() OptInt32

GetFullNameScore returns the value of FullNameScore.

func (*SzNameScoring) GetGenerationScore 

func (s *SzNameScoring) GetGenerationScore() OptInt32

GetGenerationScore returns the value of GenerationScore.

func (*SzNameScoring) GetGivenNameScore 

func (s *SzNameScoring) GetGivenNameScore() OptInt32

GetGivenNameScore returns the value of GivenNameScore.

func (*SzNameScoring) GetOrgNameScore 

func (s *SzNameScoring) GetOrgNameScore() OptInt32

GetOrgNameScore returns the value of OrgNameScore.

func (*SzNameScoring) GetSurnameScore 

func (s *SzNameScoring) GetSurnameScore() OptInt32

GetSurnameScore returns the value of SurnameScore.

func (*SzNameScoring) MarshalJSON 

func (s *SzNameScoring) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzNameScoring) SetFullNameScore 

func (s *SzNameScoring) SetFullNameScore(val OptInt32)

SetFullNameScore sets the value of FullNameScore.

func (*SzNameScoring) SetGenerationScore 

func (s *SzNameScoring) SetGenerationScore(val OptInt32)

SetGenerationScore sets the value of GenerationScore.

func (*SzNameScoring) SetGivenNameScore 

func (s *SzNameScoring) SetGivenNameScore(val OptInt32)

SetGivenNameScore sets the value of GivenNameScore.

func (*SzNameScoring) SetOrgNameScore 

func (s *SzNameScoring) SetOrgNameScore(val OptInt32)

SetOrgNameScore sets the value of OrgNameScore.

func (*SzNameScoring) SetSurnameScore 

func (s *SzNameScoring) SetSurnameScore(val OptInt32)

SetSurnameScore sets the value of SurnameScore.

func (*SzNameScoring) UnmarshalJSON 

func (s *SzNameScoring) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzRecordId 

type SzRecordId struct {
	// The data source code that uniquely identifies the data source associated with the record.
	Src OptString `json:"src"`
	// The record ID that uniquely identifies a record within the respective data source.
	ID OptString `json:"id"`
}

Identifies a record by its data source code and record identifier. This abbreviated format is used in query parameters to identify records via JSON strings. Ref: #/components/schemas/SzRecordId

func (*SzRecordId) GetID 

func (s *SzRecordId) GetID() OptString

GetID returns the value of ID.

func (*SzRecordId) GetSrc 

func (s *SzRecordId) GetSrc() OptString

GetSrc returns the value of Src.

func (*SzRecordId) SetID 

func (s *SzRecordId) SetID(val OptString)

SetID sets the value of ID.

func (*SzRecordId) SetSrc 

func (s *SzRecordId) SetSrc(val OptString)

SetSrc sets the value of Src.

type SzRecordIdentifier 

type SzRecordIdentifier struct {
	Type       SzRecordIdentifierType // switch on this field
	SzRecordId SzRecordId
	String     string
}

Identifies a record by its data source code and record ID. This is either a JSON-encoded `SzRecordId` or a delimited string where the first character is the delimiter, followed by the data source code, then the delimiter and the record ID (e.g.: `|CUSTOMERS|ABC123`). Ref: #/components/schemas/SzRecordIdentifier SzRecordIdentifier represents sum type.

func NewStringSzRecordIdentifier 

func NewStringSzRecordIdentifier(v string) SzRecordIdentifier

NewStringSzRecordIdentifier returns new SzRecordIdentifier from string.

func NewSzRecordIdSzRecordIdentifier 

func NewSzRecordIdSzRecordIdentifier(v SzRecordId) SzRecordIdentifier

NewSzRecordIdSzRecordIdentifier returns new SzRecordIdentifier from SzRecordId.

func (SzRecordIdentifier) GetString 

func (s SzRecordIdentifier) GetString() (v string, ok bool)

GetString returns string and true boolean if SzRecordIdentifier is string.

func (SzRecordIdentifier) GetSzRecordId 

func (s SzRecordIdentifier) GetSzRecordId() (v SzRecordId, ok bool)

GetSzRecordId returns SzRecordId and true boolean if SzRecordIdentifier is SzRecordId.

func (SzRecordIdentifier) IsString 

func (s SzRecordIdentifier) IsString() bool

IsString reports whether SzRecordIdentifier is string.

func (SzRecordIdentifier) IsSzRecordId 

func (s SzRecordIdentifier) IsSzRecordId() bool

IsSzRecordId reports whether SzRecordIdentifier is SzRecordId.

func (*SzRecordIdentifier) SetString 

func (s *SzRecordIdentifier) SetString(v string)

SetString sets SzRecordIdentifier to string.

func (*SzRecordIdentifier) SetSzRecordId 

func (s *SzRecordIdentifier) SetSzRecordId(v SzRecordId)

SetSzRecordId sets SzRecordIdentifier to SzRecordId.

type SzRecordIdentifierType 

type SzRecordIdentifierType string

SzRecordIdentifierType is oneOf type of SzRecordIdentifier. 

const (
	SzRecordIdSzRecordIdentifier SzRecordIdentifierType = "SzRecordId"
	StringSzRecordIdentifier     SzRecordIdentifierType = "string"
)

Possible values for SzRecordIdentifierType.

type SzRecordResponse 

type SzRecordResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzRecordResponseRawData `json:"rawData"`
	Data    OptSzRecordResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzRecordResponse

func (*SzRecordResponse) Decode 

func (s *SzRecordResponse) Decode(d *jx.Decoder) error

Decode decodes SzRecordResponse from json.

func (*SzRecordResponse) Encode 

func (s *SzRecordResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzRecordResponse) GetData 

func (s *SzRecordResponse) GetData() OptSzRecordResponseData

GetData returns the value of Data. 

func (s *SzRecordResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzRecordResponse) GetMeta 

func (s *SzRecordResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzRecordResponse) GetRawData 

func (s *SzRecordResponse) GetRawData() OptNilSzRecordResponseRawData

GetRawData returns the value of RawData.

func (*SzRecordResponse) MarshalJSON 

func (s *SzRecordResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzRecordResponse) SetData 

func (s *SzRecordResponse) SetData(val OptSzRecordResponseData)

SetData sets the value of Data. 

func (s *SzRecordResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzRecordResponse) SetMeta 

func (s *SzRecordResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzRecordResponse) SetRawData 

func (s *SzRecordResponse) SetRawData(val OptNilSzRecordResponseRawData)

SetRawData sets the value of RawData.

func (*SzRecordResponse) UnmarshalJSON 

func (s *SzRecordResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzRecordResponse) Validate 

func (s *SzRecordResponse) Validate() error

type SzRecordResponseData 

type SzRecordResponseData struct {
	// The `SzEntityRecord` describing the matching record.
	Record OptSzEntityRecord `json:"record"`
}

func (*SzRecordResponseData) Decode 

func (s *SzRecordResponseData) Decode(d *jx.Decoder) error

Decode decodes SzRecordResponseData from json.

func (*SzRecordResponseData) Encode 

func (s *SzRecordResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzRecordResponseData) GetRecord 

func (s *SzRecordResponseData) GetRecord() OptSzEntityRecord

GetRecord returns the value of Record.

func (*SzRecordResponseData) MarshalJSON 

func (s *SzRecordResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzRecordResponseData) SetRecord 

func (s *SzRecordResponseData) SetRecord(val OptSzEntityRecord)

SetRecord sets the value of Record.

func (*SzRecordResponseData) UnmarshalJSON 

func (s *SzRecordResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzRecordResponseData) Validate 

func (s *SzRecordResponseData) Validate() error

type SzRecordResponseRawData 

type SzRecordResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzRecordResponseRawData) Decode 

func (s *SzRecordResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzRecordResponseRawData from json.

func (SzRecordResponseRawData) Encode 

func (s SzRecordResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzRecordResponseRawData) MarshalJSON 

func (s SzRecordResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzRecordResponseRawData) UnmarshalJSON 

func (s *SzRecordResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzReevaluateResponse 

type SzReevaluateResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzReevaluateResponseRawData `json:"rawData"`
	Data    OptSzReevaluateResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzReevaluateResponse

func (*SzReevaluateResponse) Decode 

func (s *SzReevaluateResponse) Decode(d *jx.Decoder) error

Decode decodes SzReevaluateResponse from json.

func (*SzReevaluateResponse) Encode 

func (s *SzReevaluateResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzReevaluateResponse) GetData 

func (s *SzReevaluateResponse) GetData() OptSzReevaluateResponseData

GetData returns the value of Data. 

func (s *SzReevaluateResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzReevaluateResponse) GetMeta 

func (s *SzReevaluateResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzReevaluateResponse) GetRawData 

func (s *SzReevaluateResponse) GetRawData() OptNilSzReevaluateResponseRawData

GetRawData returns the value of RawData.

func (*SzReevaluateResponse) MarshalJSON 

func (s *SzReevaluateResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzReevaluateResponse) SetData 

func (s *SzReevaluateResponse) SetData(val OptSzReevaluateResponseData)

SetData sets the value of Data. 

func (s *SzReevaluateResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzReevaluateResponse) SetMeta 

func (s *SzReevaluateResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzReevaluateResponse) SetRawData 

func (s *SzReevaluateResponse) SetRawData(val OptNilSzReevaluateResponseRawData)

SetRawData sets the value of RawData.

func (*SzReevaluateResponse) UnmarshalJSON 

func (s *SzReevaluateResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzReevaluateResponse) Validate 

func (s *SzReevaluateResponse) Validate() error

type SzReevaluateResponseData 

type SzReevaluateResponseData struct {
	// The optionally requested info associated with the load.
	Info OptSzResolutionInfo `json:"info"`
}

Describes the data segment of `SzReevaluateResponse`. Ref: #/components/schemas/SzReevaluateResponseData

func (*SzReevaluateResponseData) Decode 

func (s *SzReevaluateResponseData) Decode(d *jx.Decoder) error

Decode decodes SzReevaluateResponseData from json.

func (*SzReevaluateResponseData) Encode 

func (s *SzReevaluateResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzReevaluateResponseData) GetInfo 

func (s *SzReevaluateResponseData) GetInfo() OptSzResolutionInfo

GetInfo returns the value of Info.

func (*SzReevaluateResponseData) MarshalJSON 

func (s *SzReevaluateResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzReevaluateResponseData) SetInfo 

func (s *SzReevaluateResponseData) SetInfo(val OptSzResolutionInfo)

SetInfo sets the value of Info.

func (*SzReevaluateResponseData) UnmarshalJSON 

func (s *SzReevaluateResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzReevaluateResponseRawData 

type SzReevaluateResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzReevaluateResponseRawData) Decode 

func (s *SzReevaluateResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzReevaluateResponseRawData from json.

func (SzReevaluateResponseRawData) Encode 

func (s SzReevaluateResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzReevaluateResponseRawData) MarshalJSON 

func (s SzReevaluateResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzReevaluateResponseRawData) UnmarshalJSON 

func (s *SzReevaluateResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzRelatedEntity 

type SzRelatedEntity struct {
	// The unique numeric ID identifying the entity.
	EntityId OptInt64 `json:"entityId"`
	// The name associated with this entity that is considered the best name among all the associated
	// names.
	EntityName OptString `json:"entityName"`
	// Usually the same as the entityName property, but this may differ if the entity was found based on
	// a name search.  In such a case, this field represents the name that most closely matches the name
	// that was searched on.
	BestName OptString `json:"bestName"`
	// The array of DataSourceRecordSummary instances describing the number of records associated with
	// each data source that contributes to this entity.
	RecordSummaries []SzDataSourceRecordSummary `json:"recordSummaries"`
	// An array of names associated with the entity that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "Joe Schmoe" or "AKA: Joseph P. Schmoe").
	NameData []string `json:"nameData"`
	// An array of characteristics associated with the entity that are formatted for readability.  These
	// will be prefixed by a characteristic type and optionally by a "usage type" if one was provided.
	// **NOTE:** The `characteristicData` field is derived from the feature data values that contribute
	// to the `ATTRIBUTE_DATA` field at the record level in the "raw data" JSON.
	CharacteristicData []string `json:"characteristicData"`
	// An array of addresses associated with the entity that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "HOME: 101 Main Street").
	AddressData []string `json:"addressData"`
	// An array of phone numbers associated with the entity that are formatted for readability.  These
	// may be prefixed by a "usage type" if one was provided (e.g.: "HOME: 702-555-1212").
	PhoneData []string `json:"phoneData"`
	// An array of entity data associated with the entity where the items are formatted for readability.
	// These will be prefixed by an identifier type and may be prefixed by a "usage type" if one was
	// provided (e.g.: "ID: 123456789" or "EMAIL: WORK: joe@nowhere.com").
	IdentifierData []string `json:"identifierData"`
	// An array of relationship data items associated with the entity that describes disclosed
	// relationships.
	RelationshipData []string `json:"relationshipData"`
	// An array of associated data items that were loaded with the entity's records but not normally
	// recognized or used for entity resolution. This array usually contains useful information from the
	// source systems.
	OtherData []string `json:"otherData"`
	// The array of `SzMatchedRecord` instances describing the records associated with this entity.
	Records []SzMatchedRecord `json:"records"`
	// The map of string feature names to arrays of SzEntityFeature instances describing the values
	// associated with each respective feature name.
	Features OptSzRelatedEntityFeatures `json:"features"`
	// If true then this `SzResolvedEntity` has complete features and records, otherwise they are not
	// provided.  Also, the recordSummary items may be missing the topRecordIds if partial is true.  This
	// can be true for partially retrieved related entities or if features are suppressed, if the detail
	// level has suppressed records or related matching info (in the case of related entities) or if the
	// force-minimal response flag has been been specified.
	Partial OptBool `json:"partial"`
	// The timestamp that the entity was last seen (i.e.: most recent record was loaded).
	LastSeenTimestamp OptDateTime `json:"lastSeenTimestamp"`
	// The integer "match level" describing how the related entity matched to the primary resolved entity.
	MatchLevel OptInt32 `json:"matchLevel"`
	// The match key describing what features matched between the primary resolved entity and the related
	// entity.
	MatchKey OptString `json:"matchKey"`
	// The code identifying the resolution rule that related this entity to the primary resolved entity.
	ResolutionRuleCode OptString `json:"resolutionRuleCode"`
	// A boolean flag indicating if this related entity represents a disclosed relationship.
	Disclosed OptBool `json:"disclosed"`
	// A boolean flag indicating if this related entity represents an ambiguous relationship.
	Ambiguous    OptBool               `json:"ambiguous"`
	RelationType OptSzRelationshipType `json:"relationType"`
}

Merged schema. Ref: #/components/schemas/SzRelatedEntity

func (*SzRelatedEntity) Decode 

func (s *SzRelatedEntity) Decode(d *jx.Decoder) error

Decode decodes SzRelatedEntity from json.

func (*SzRelatedEntity) Encode 

func (s *SzRelatedEntity) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzRelatedEntity) GetAddressData 

func (s *SzRelatedEntity) GetAddressData() []string

GetAddressData returns the value of AddressData.

func (*SzRelatedEntity) GetAmbiguous 

func (s *SzRelatedEntity) GetAmbiguous() OptBool

GetAmbiguous returns the value of Ambiguous.

func (*SzRelatedEntity) GetBestName 

func (s *SzRelatedEntity) GetBestName() OptString

GetBestName returns the value of BestName.

func (*SzRelatedEntity) GetCharacteristicData 

func (s *SzRelatedEntity) GetCharacteristicData() []string

GetCharacteristicData returns the value of CharacteristicData.

func (*SzRelatedEntity) GetDisclosed 

func (s *SzRelatedEntity) GetDisclosed() OptBool

GetDisclosed returns the value of Disclosed.

func (*SzRelatedEntity) GetEntityId 

func (s *SzRelatedEntity) GetEntityId() OptInt64

GetEntityId returns the value of EntityId.

func (*SzRelatedEntity) GetEntityName 

func (s *SzRelatedEntity) GetEntityName() OptString

GetEntityName returns the value of EntityName.

func (*SzRelatedEntity) GetFeatures 

func (s *SzRelatedEntity) GetFeatures() OptSzRelatedEntityFeatures

GetFeatures returns the value of Features.

func (*SzRelatedEntity) GetIdentifierData 

func (s *SzRelatedEntity) GetIdentifierData() []string

GetIdentifierData returns the value of IdentifierData.

func (*SzRelatedEntity) GetLastSeenTimestamp 

func (s *SzRelatedEntity) GetLastSeenTimestamp() OptDateTime

GetLastSeenTimestamp returns the value of LastSeenTimestamp.

func (*SzRelatedEntity) GetMatchKey 

func (s *SzRelatedEntity) GetMatchKey() OptString

GetMatchKey returns the value of MatchKey.

func (*SzRelatedEntity) GetMatchLevel 

func (s *SzRelatedEntity) GetMatchLevel() OptInt32

GetMatchLevel returns the value of MatchLevel.

func (*SzRelatedEntity) GetNameData 

func (s *SzRelatedEntity) GetNameData() []string

GetNameData returns the value of NameData.

func (*SzRelatedEntity) GetOtherData 

func (s *SzRelatedEntity) GetOtherData() []string

GetOtherData returns the value of OtherData.

func (*SzRelatedEntity) GetPartial 

func (s *SzRelatedEntity) GetPartial() OptBool

GetPartial returns the value of Partial.

func (*SzRelatedEntity) GetPhoneData 

func (s *SzRelatedEntity) GetPhoneData() []string

GetPhoneData returns the value of PhoneData.

func (*SzRelatedEntity) GetRecordSummaries 

func (s *SzRelatedEntity) GetRecordSummaries() []SzDataSourceRecordSummary

GetRecordSummaries returns the value of RecordSummaries.

func (*SzRelatedEntity) GetRecords 

func (s *SzRelatedEntity) GetRecords() []SzMatchedRecord

GetRecords returns the value of Records.

func (*SzRelatedEntity) GetRelationType 

func (s *SzRelatedEntity) GetRelationType() OptSzRelationshipType

GetRelationType returns the value of RelationType.

func (*SzRelatedEntity) GetRelationshipData 

func (s *SzRelatedEntity) GetRelationshipData() []string

GetRelationshipData returns the value of RelationshipData.

func (*SzRelatedEntity) GetResolutionRuleCode 

func (s *SzRelatedEntity) GetResolutionRuleCode() OptString

GetResolutionRuleCode returns the value of ResolutionRuleCode.

func (*SzRelatedEntity) MarshalJSON 

func (s *SzRelatedEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzRelatedEntity) SetAddressData 

func (s *SzRelatedEntity) SetAddressData(val []string)

SetAddressData sets the value of AddressData.

func (*SzRelatedEntity) SetAmbiguous 

func (s *SzRelatedEntity) SetAmbiguous(val OptBool)

SetAmbiguous sets the value of Ambiguous.

func (*SzRelatedEntity) SetBestName 

func (s *SzRelatedEntity) SetBestName(val OptString)

SetBestName sets the value of BestName.

func (*SzRelatedEntity) SetCharacteristicData 

func (s *SzRelatedEntity) SetCharacteristicData(val []string)

SetCharacteristicData sets the value of CharacteristicData.

func (*SzRelatedEntity) SetDisclosed 

func (s *SzRelatedEntity) SetDisclosed(val OptBool)

SetDisclosed sets the value of Disclosed.

func (*SzRelatedEntity) SetEntityId 

func (s *SzRelatedEntity) SetEntityId(val OptInt64)

SetEntityId sets the value of EntityId.

func (*SzRelatedEntity) SetEntityName 

func (s *SzRelatedEntity) SetEntityName(val OptString)

SetEntityName sets the value of EntityName.

func (*SzRelatedEntity) SetFeatures 

func (s *SzRelatedEntity) SetFeatures(val OptSzRelatedEntityFeatures)

SetFeatures sets the value of Features.

func (*SzRelatedEntity) SetIdentifierData 

func (s *SzRelatedEntity) SetIdentifierData(val []string)

SetIdentifierData sets the value of IdentifierData.

func (*SzRelatedEntity) SetLastSeenTimestamp 

func (s *SzRelatedEntity) SetLastSeenTimestamp(val OptDateTime)

SetLastSeenTimestamp sets the value of LastSeenTimestamp.

func (*SzRelatedEntity) SetMatchKey 

func (s *SzRelatedEntity) SetMatchKey(val OptString)

SetMatchKey sets the value of MatchKey.

func (*SzRelatedEntity) SetMatchLevel 

func (s *SzRelatedEntity) SetMatchLevel(val OptInt32)

SetMatchLevel sets the value of MatchLevel.

func (*SzRelatedEntity) SetNameData 

func (s *SzRelatedEntity) SetNameData(val []string)

SetNameData sets the value of NameData.

func (*SzRelatedEntity) SetOtherData 

func (s *SzRelatedEntity) SetOtherData(val []string)

SetOtherData sets the value of OtherData.

func (*SzRelatedEntity) SetPartial 

func (s *SzRelatedEntity) SetPartial(val OptBool)

SetPartial sets the value of Partial.

func (*SzRelatedEntity) SetPhoneData 

func (s *SzRelatedEntity) SetPhoneData(val []string)

SetPhoneData sets the value of PhoneData.

func (*SzRelatedEntity) SetRecordSummaries 

func (s *SzRelatedEntity) SetRecordSummaries(val []SzDataSourceRecordSummary)

SetRecordSummaries sets the value of RecordSummaries.

func (*SzRelatedEntity) SetRecords 

func (s *SzRelatedEntity) SetRecords(val []SzMatchedRecord)

SetRecords sets the value of Records.

func (*SzRelatedEntity) SetRelationType 

func (s *SzRelatedEntity) SetRelationType(val OptSzRelationshipType)

SetRelationType sets the value of RelationType.

func (*SzRelatedEntity) SetRelationshipData 

func (s *SzRelatedEntity) SetRelationshipData(val []string)

SetRelationshipData sets the value of RelationshipData.

func (*SzRelatedEntity) SetResolutionRuleCode 

func (s *SzRelatedEntity) SetResolutionRuleCode(val OptString)

SetResolutionRuleCode sets the value of ResolutionRuleCode.

func (*SzRelatedEntity) UnmarshalJSON 

func (s *SzRelatedEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzRelatedEntity) Validate 

func (s *SzRelatedEntity) Validate() error

type SzRelatedEntityFeatures 

type SzRelatedEntityFeatures map[string][]SzEntityFeature

The map of string feature names to arrays of SzEntityFeature instances describing the values associated with each respective feature name.

func (*SzRelatedEntityFeatures) Decode 

func (s *SzRelatedEntityFeatures) Decode(d *jx.Decoder) error

Decode decodes SzRelatedEntityFeatures from json.

func (SzRelatedEntityFeatures) Encode 

func (s SzRelatedEntityFeatures) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzRelatedEntityFeatures) MarshalJSON 

func (s SzRelatedEntityFeatures) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzRelatedEntityFeatures) UnmarshalJSON 

func (s *SzRelatedEntityFeatures) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SzRelatedEntityFeatures) Validate 

func (s SzRelatedEntityFeatures) Validate() error

type SzRelatedFeatures 

type SzRelatedFeatures struct {
	// The first related feature.
	Feature1 OptSzScoredFeature `json:"feature1"`
	// The second related feature.
	Feature2 OptSzScoredFeature `json:"feature2"`
}

Describes a pair of features that triggered a relationship between the respective records. Ref: #/components/schemas/SzRelatedFeatures

func (*SzRelatedFeatures) Decode 

func (s *SzRelatedFeatures) Decode(d *jx.Decoder) error

Decode decodes SzRelatedFeatures from json.

func (*SzRelatedFeatures) Encode 

func (s *SzRelatedFeatures) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzRelatedFeatures) GetFeature1 

func (s *SzRelatedFeatures) GetFeature1() OptSzScoredFeature

GetFeature1 returns the value of Feature1.

func (*SzRelatedFeatures) GetFeature2 

func (s *SzRelatedFeatures) GetFeature2() OptSzScoredFeature

GetFeature2 returns the value of Feature2.

func (*SzRelatedFeatures) MarshalJSON 

func (s *SzRelatedFeatures) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzRelatedFeatures) SetFeature1 

func (s *SzRelatedFeatures) SetFeature1(val OptSzScoredFeature)

SetFeature1 sets the value of Feature1.

func (*SzRelatedFeatures) SetFeature2 

func (s *SzRelatedFeatures) SetFeature2(val OptSzScoredFeature)

SetFeature2 sets the value of Feature2.

func (*SzRelatedFeatures) UnmarshalJSON 

func (s *SzRelatedFeatures) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzRelationDirection 

type SzRelationDirection string

The HTTP method that was used for the operation. The possible values are: * `OUTBOUND` - The relationship goes in the direction from the first entity to the second entity. * `INBOUND` - The relationship goes in the direction from the second entity to the first entity. * `BIDIRECTIONAL` - The relationship goes in both directions between the two entities. Ref: #/components/schemas/SzRelationDirection 

const (
	SzRelationDirectionINBOUND       SzRelationDirection = "INBOUND"
	SzRelationDirectionOUTBOUND      SzRelationDirection = "OUTBOUND"
	SzRelationDirectionBIDIRECTIONAL SzRelationDirection = "BIDIRECTIONAL"
)

func (SzRelationDirection) AllValues added in v0.9.0 

func (SzRelationDirection) AllValues() []SzRelationDirection

AllValues returns all SzRelationDirection values.

func (*SzRelationDirection) Decode 

func (s *SzRelationDirection) Decode(d *jx.Decoder) error

Decode decodes SzRelationDirection from json.

func (SzRelationDirection) Encode 

func (s SzRelationDirection) Encode(e *jx.Encoder)

Encode encodes SzRelationDirection as json.

func (SzRelationDirection) MarshalJSON 

func (s SzRelationDirection) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzRelationDirection) MarshalText 

func (s SzRelationDirection) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzRelationDirection) UnmarshalJSON 

func (s *SzRelationDirection) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzRelationDirection) UnmarshalText 

func (s *SzRelationDirection) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzRelationDirection) Validate 

func (s SzRelationDirection) Validate() error

type SzRelationshipMode 

type SzRelationshipMode string

Controls how to handle the first-degree related entities. The possible values are: * `NONE` - Do not include any data on first-degree related entities -- this is the fastest option from a performance perspective because related entities do not have to be retrieved. * `PARTIAL` - **(default value)** Include only partial stub information for related entities with the `partial` property of the `SzRelatedEntity` instances set to `true`. Obtaining additional information requires subsequent API calls. * `FULL` - Include full data on the first-degree related entities according to the `featureMode` and `detailLevel` **unless** `forceMinimal` is `true`. This option obtains the entity network at one degree for the requested entity and will populate up to 1000 related entities as much as possible with respect to the `featureMode` and `detailLevel`. Related entities beyond the first 1000 will be left incomplete and have their `partial` property set to `true` regardless of the `detailLevel` and `featureMode`. If this value is specified along with `forceMinimal=true` then `PARTIAL` is used instead. Ref: #/components/schemas/SzRelationshipMode 

const (
	SzRelationshipModeNONE    SzRelationshipMode = "NONE"
	SzRelationshipModePARTIAL SzRelationshipMode = "PARTIAL"
	SzRelationshipModeFULL    SzRelationshipMode = "FULL"
)

func (SzRelationshipMode) AllValues added in v0.9.0 

func (SzRelationshipMode) AllValues() []SzRelationshipMode

AllValues returns all SzRelationshipMode values.

func (SzRelationshipMode) MarshalText 

func (s SzRelationshipMode) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzRelationshipMode) UnmarshalText 

func (s *SzRelationshipMode) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzRelationshipMode) Validate 

func (s SzRelationshipMode) Validate() error

type SzRelationshipType 

type SzRelationshipType string

Describes how an entity is related to another (either a possible match, a discovered possible relationship or a disclosed relationship). Ref: #/components/schemas/SzRelationshipType 

const (
	SzRelationshipTypePOSSIBLEMATCH     SzRelationshipType = "POSSIBLE_MATCH"
	SzRelationshipTypePOSSIBLERELATION  SzRelationshipType = "POSSIBLE_RELATION"
	SzRelationshipTypeDISCLOSEDRELATION SzRelationshipType = "DISCLOSED_RELATION"
)

func (SzRelationshipType) AllValues added in v0.9.0 

func (SzRelationshipType) AllValues() []SzRelationshipType

AllValues returns all SzRelationshipType values.

func (*SzRelationshipType) Decode 

func (s *SzRelationshipType) Decode(d *jx.Decoder) error

Decode decodes SzRelationshipType from json.

func (SzRelationshipType) Encode 

func (s SzRelationshipType) Encode(e *jx.Encoder)

Encode encodes SzRelationshipType as json.

func (SzRelationshipType) MarshalJSON 

func (s SzRelationshipType) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzRelationshipType) MarshalText 

func (s SzRelationshipType) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzRelationshipType) UnmarshalJSON 

func (s *SzRelationshipType) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzRelationshipType) UnmarshalText 

func (s *SzRelationshipType) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzRelationshipType) Validate 

func (s SzRelationshipType) Validate() error

type SzResolutionInfo 

type SzResolutionInfo struct {
	// The data source for the record that was focus of the load or reevaluate operation.
	DataSource OptString `json:"dataSource"`
	// The record ID for the record that was focus of the load or reevaluate operation.
	RecordId OptString `json:"recordId"`
	// The array of entity ID's for the affected entities.
	AffectedEntities []int64 `json:"affectedEntities"`
	// The entities that were flagged as relevant due to the resolution operation.
	FlaggedEntities []SzFlaggedEntity `json:"flaggedEntities"`
}

Provides information relevant to resolution of an entity either when loading a record or reevaluating an entity. Ref: #/components/schemas/SzResolutionInfo

func (*SzResolutionInfo) Decode 

func (s *SzResolutionInfo) Decode(d *jx.Decoder) error

Decode decodes SzResolutionInfo from json.

func (*SzResolutionInfo) Encode 

func (s *SzResolutionInfo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzResolutionInfo) GetAffectedEntities 

func (s *SzResolutionInfo) GetAffectedEntities() []int64

GetAffectedEntities returns the value of AffectedEntities.

func (*SzResolutionInfo) GetDataSource 

func (s *SzResolutionInfo) GetDataSource() OptString

GetDataSource returns the value of DataSource.

func (*SzResolutionInfo) GetFlaggedEntities 

func (s *SzResolutionInfo) GetFlaggedEntities() []SzFlaggedEntity

GetFlaggedEntities returns the value of FlaggedEntities.

func (*SzResolutionInfo) GetRecordId 

func (s *SzResolutionInfo) GetRecordId() OptString

GetRecordId returns the value of RecordId.

func (*SzResolutionInfo) MarshalJSON 

func (s *SzResolutionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzResolutionInfo) SetAffectedEntities 

func (s *SzResolutionInfo) SetAffectedEntities(val []int64)

SetAffectedEntities sets the value of AffectedEntities.

func (*SzResolutionInfo) SetDataSource 

func (s *SzResolutionInfo) SetDataSource(val OptString)

SetDataSource sets the value of DataSource.

func (*SzResolutionInfo) SetFlaggedEntities 

func (s *SzResolutionInfo) SetFlaggedEntities(val []SzFlaggedEntity)

SetFlaggedEntities sets the value of FlaggedEntities.

func (*SzResolutionInfo) SetRecordId 

func (s *SzResolutionInfo) SetRecordId(val OptString)

SetRecordId sets the value of RecordId.

func (*SzResolutionInfo) UnmarshalJSON 

func (s *SzResolutionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzResolutionStep 

type SzResolutionStep struct {
	// The step number indicating the order of this step relative to other steps if the steps were
	// flattened to be linear.  However, the non-linear nature of entity resolution means that the
	// ordering of the steps is only relevant within a single branch of the resolution tree.
	StepNumber OptInt32 `json:"stepNumber"`
	// The `SzVirtualEntity` describing the inbound virtual entity.
	InboundVirtualEntity OptSzVirtualEntity `json:"inboundVirtualEntity"`
	// The `SzVirtualEntity` describing the candidate virtual entity.
	CandidateVirtualEntity OptSzVirtualEntity `json:"candidateVirtualEntity"`
	// The `SzHowMatchInfo` describing how the two virtual entities matched each other.
	MatchInfo OptSzHowMatchInfo `json:"matchInfo"`
	// The virtual entity ID identifying the virtual entity that resulted from resolving the inbound and
	// candidate virtual entities.
	ResolvedVirtualEntityId OptString `json:"resolvedVirtualEntityId"`
}

Describes a single step in describing how an entity was created. Each step consists of either the formation of a new "virtual entity" from two records, the adding of a record to an existing virtual entity to create a new virtual entity, or the resolving of two virtual entities into a new virtual entity consisting of all the records. Ref: #/components/schemas/SzResolutionStep

func (*SzResolutionStep) Decode 

func (s *SzResolutionStep) Decode(d *jx.Decoder) error

Decode decodes SzResolutionStep from json.

func (*SzResolutionStep) Encode 

func (s *SzResolutionStep) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzResolutionStep) GetCandidateVirtualEntity 

func (s *SzResolutionStep) GetCandidateVirtualEntity() OptSzVirtualEntity

GetCandidateVirtualEntity returns the value of CandidateVirtualEntity.

func (*SzResolutionStep) GetInboundVirtualEntity 

func (s *SzResolutionStep) GetInboundVirtualEntity() OptSzVirtualEntity

GetInboundVirtualEntity returns the value of InboundVirtualEntity.

func (*SzResolutionStep) GetMatchInfo 

func (s *SzResolutionStep) GetMatchInfo() OptSzHowMatchInfo

GetMatchInfo returns the value of MatchInfo.

func (*SzResolutionStep) GetResolvedVirtualEntityId 

func (s *SzResolutionStep) GetResolvedVirtualEntityId() OptString

GetResolvedVirtualEntityId returns the value of ResolvedVirtualEntityId.

func (*SzResolutionStep) GetStepNumber 

func (s *SzResolutionStep) GetStepNumber() OptInt32

GetStepNumber returns the value of StepNumber.

func (*SzResolutionStep) MarshalJSON 

func (s *SzResolutionStep) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzResolutionStep) SetCandidateVirtualEntity 

func (s *SzResolutionStep) SetCandidateVirtualEntity(val OptSzVirtualEntity)

SetCandidateVirtualEntity sets the value of CandidateVirtualEntity.

func (*SzResolutionStep) SetInboundVirtualEntity 

func (s *SzResolutionStep) SetInboundVirtualEntity(val OptSzVirtualEntity)

SetInboundVirtualEntity sets the value of InboundVirtualEntity.

func (*SzResolutionStep) SetMatchInfo 

func (s *SzResolutionStep) SetMatchInfo(val OptSzHowMatchInfo)

SetMatchInfo sets the value of MatchInfo.

func (*SzResolutionStep) SetResolvedVirtualEntityId 

func (s *SzResolutionStep) SetResolvedVirtualEntityId(val OptString)

SetResolvedVirtualEntityId sets the value of ResolvedVirtualEntityId.

func (*SzResolutionStep) SetStepNumber 

func (s *SzResolutionStep) SetStepNumber(val OptInt32)

SetStepNumber sets the value of StepNumber.

func (*SzResolutionStep) UnmarshalJSON 

func (s *SzResolutionStep) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzResolutionStep) Validate 

func (s *SzResolutionStep) Validate() error

type SzResolvedEntity 

type SzResolvedEntity struct {
	// The unique numeric ID identifying the entity.
	EntityId OptInt64 `json:"entityId"`
	// The name associated with this entity that is considered the best name among all the associated
	// names.
	EntityName OptString `json:"entityName"`
	// Usually the same as the entityName property, but this may differ if the entity was found based on
	// a name search.  In such a case, this field represents the name that most closely matches the name
	// that was searched on.
	BestName OptString `json:"bestName"`
	// The array of DataSourceRecordSummary instances describing the number of records associated with
	// each data source that contributes to this entity.
	RecordSummaries []SzDataSourceRecordSummary `json:"recordSummaries"`
	// An array of names associated with the entity that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "Joe Schmoe" or "AKA: Joseph P. Schmoe").
	NameData []string `json:"nameData"`
	// An array of characteristics associated with the entity that are formatted for readability.  These
	// will be prefixed by a characteristic type and optionally by a "usage type" if one was provided.
	// **NOTE:** The `characteristicData` field is derived from the feature data values that contribute
	// to the `ATTRIBUTE_DATA` field at the record level in the "raw data" JSON.
	CharacteristicData []string `json:"characteristicData"`
	// An array of addresses associated with the entity that are formatted for readability.  These may be
	// prefixed by a "usage type" if one was provided (e.g.: "HOME: 101 Main Street").
	AddressData []string `json:"addressData"`
	// An array of phone numbers associated with the entity that are formatted for readability.  These
	// may be prefixed by a "usage type" if one was provided (e.g.: "HOME: 702-555-1212").
	PhoneData []string `json:"phoneData"`
	// An array of entity data associated with the entity where the items are formatted for readability.
	// These will be prefixed by an identifier type and may be prefixed by a "usage type" if one was
	// provided (e.g.: "ID: 123456789" or "EMAIL: WORK: joe@nowhere.com").
	IdentifierData []string `json:"identifierData"`
	// An array of relationship data items associated with the entity that describes disclosed
	// relationships.
	RelationshipData []string `json:"relationshipData"`
	// An array of associated data items that were loaded with the entity's records but not normally
	// recognized or used for entity resolution. This array usually contains useful information from the
	// source systems.
	OtherData []string `json:"otherData"`
	// The array of `SzMatchedRecord` instances describing the records associated with this entity.
	Records []SzMatchedRecord `json:"records"`
	// The map of string feature names to arrays of SzEntityFeature instances describing the values
	// associated with each respective feature name.
	Features OptSzResolvedEntityFeatures `json:"features"`
	// If true then this `SzResolvedEntity` has complete features and records, otherwise they are not
	// provided.  Also, the recordSummary items may be missing the topRecordIds if partial is true.  This
	// can be true for partially retrieved related entities or if features are suppressed, if the detail
	// level has suppressed records or related matching info (in the case of related entities) or if the
	// force-minimal response flag has been been specified.
	Partial OptBool `json:"partial"`
	// The timestamp that the entity was last seen (i.e.: most recent record was loaded).
	LastSeenTimestamp OptDateTime `json:"lastSeenTimestamp"`
}

Describes a resolved entity that is made up of one or more SzMatchedRecord instances. Ref: #/components/schemas/SzResolvedEntity

func (*SzResolvedEntity) Decode 

func (s *SzResolvedEntity) Decode(d *jx.Decoder) error

Decode decodes SzResolvedEntity from json.

func (*SzResolvedEntity) Encode 

func (s *SzResolvedEntity) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzResolvedEntity) GetAddressData 

func (s *SzResolvedEntity) GetAddressData() []string

GetAddressData returns the value of AddressData.

func (*SzResolvedEntity) GetBestName 

func (s *SzResolvedEntity) GetBestName() OptString

GetBestName returns the value of BestName.

func (*SzResolvedEntity) GetCharacteristicData 

func (s *SzResolvedEntity) GetCharacteristicData() []string

GetCharacteristicData returns the value of CharacteristicData.

func (*SzResolvedEntity) GetEntityId 

func (s *SzResolvedEntity) GetEntityId() OptInt64

GetEntityId returns the value of EntityId.

func (*SzResolvedEntity) GetEntityName 

func (s *SzResolvedEntity) GetEntityName() OptString

GetEntityName returns the value of EntityName.

func (*SzResolvedEntity) GetFeatures 

func (s *SzResolvedEntity) GetFeatures() OptSzResolvedEntityFeatures

GetFeatures returns the value of Features.

func (*SzResolvedEntity) GetIdentifierData 

func (s *SzResolvedEntity) GetIdentifierData() []string

GetIdentifierData returns the value of IdentifierData.

func (*SzResolvedEntity) GetLastSeenTimestamp 

func (s *SzResolvedEntity) GetLastSeenTimestamp() OptDateTime

GetLastSeenTimestamp returns the value of LastSeenTimestamp.

func (*SzResolvedEntity) GetNameData 

func (s *SzResolvedEntity) GetNameData() []string

GetNameData returns the value of NameData.

func (*SzResolvedEntity) GetOtherData 

func (s *SzResolvedEntity) GetOtherData() []string

GetOtherData returns the value of OtherData.

func (*SzResolvedEntity) GetPartial 

func (s *SzResolvedEntity) GetPartial() OptBool

GetPartial returns the value of Partial.

func (*SzResolvedEntity) GetPhoneData 

func (s *SzResolvedEntity) GetPhoneData() []string

GetPhoneData returns the value of PhoneData.

func (*SzResolvedEntity) GetRecordSummaries 

func (s *SzResolvedEntity) GetRecordSummaries() []SzDataSourceRecordSummary

GetRecordSummaries returns the value of RecordSummaries.

func (*SzResolvedEntity) GetRecords 

func (s *SzResolvedEntity) GetRecords() []SzMatchedRecord

GetRecords returns the value of Records.

func (*SzResolvedEntity) GetRelationshipData 

func (s *SzResolvedEntity) GetRelationshipData() []string

GetRelationshipData returns the value of RelationshipData.

func (*SzResolvedEntity) MarshalJSON 

func (s *SzResolvedEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzResolvedEntity) SetAddressData 

func (s *SzResolvedEntity) SetAddressData(val []string)

SetAddressData sets the value of AddressData.

func (*SzResolvedEntity) SetBestName 

func (s *SzResolvedEntity) SetBestName(val OptString)

SetBestName sets the value of BestName.

func (*SzResolvedEntity) SetCharacteristicData 

func (s *SzResolvedEntity) SetCharacteristicData(val []string)

SetCharacteristicData sets the value of CharacteristicData.

func (*SzResolvedEntity) SetEntityId 

func (s *SzResolvedEntity) SetEntityId(val OptInt64)

SetEntityId sets the value of EntityId.

func (*SzResolvedEntity) SetEntityName 

func (s *SzResolvedEntity) SetEntityName(val OptString)

SetEntityName sets the value of EntityName.

func (*SzResolvedEntity) SetFeatures 

func (s *SzResolvedEntity) SetFeatures(val OptSzResolvedEntityFeatures)

SetFeatures sets the value of Features.

func (*SzResolvedEntity) SetIdentifierData 

func (s *SzResolvedEntity) SetIdentifierData(val []string)

SetIdentifierData sets the value of IdentifierData.

func (*SzResolvedEntity) SetLastSeenTimestamp 

func (s *SzResolvedEntity) SetLastSeenTimestamp(val OptDateTime)

SetLastSeenTimestamp sets the value of LastSeenTimestamp.

func (*SzResolvedEntity) SetNameData 

func (s *SzResolvedEntity) SetNameData(val []string)

SetNameData sets the value of NameData.

func (*SzResolvedEntity) SetOtherData 

func (s *SzResolvedEntity) SetOtherData(val []string)

SetOtherData sets the value of OtherData.

func (*SzResolvedEntity) SetPartial 

func (s *SzResolvedEntity) SetPartial(val OptBool)

SetPartial sets the value of Partial.

func (*SzResolvedEntity) SetPhoneData 

func (s *SzResolvedEntity) SetPhoneData(val []string)

SetPhoneData sets the value of PhoneData.

func (*SzResolvedEntity) SetRecordSummaries 

func (s *SzResolvedEntity) SetRecordSummaries(val []SzDataSourceRecordSummary)

SetRecordSummaries sets the value of RecordSummaries.

func (*SzResolvedEntity) SetRecords 

func (s *SzResolvedEntity) SetRecords(val []SzMatchedRecord)

SetRecords sets the value of Records.

func (*SzResolvedEntity) SetRelationshipData 

func (s *SzResolvedEntity) SetRelationshipData(val []string)

SetRelationshipData sets the value of RelationshipData.

func (*SzResolvedEntity) UnmarshalJSON 

func (s *SzResolvedEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzResolvedEntity) Validate 

func (s *SzResolvedEntity) Validate() error

type SzResolvedEntityFeatures 

type SzResolvedEntityFeatures map[string][]SzEntityFeature

The map of string feature names to arrays of SzEntityFeature instances describing the values associated with each respective feature name.

func (*SzResolvedEntityFeatures) Decode 

func (s *SzResolvedEntityFeatures) Decode(d *jx.Decoder) error

Decode decodes SzResolvedEntityFeatures from json.

func (SzResolvedEntityFeatures) Encode 

func (s SzResolvedEntityFeatures) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzResolvedEntityFeatures) MarshalJSON 

func (s SzResolvedEntityFeatures) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzResolvedEntityFeatures) UnmarshalJSON 

func (s *SzResolvedEntityFeatures) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SzResolvedEntityFeatures) Validate 

func (s SzResolvedEntityFeatures) Validate() error

type SzScoredFeature 

type SzScoredFeature struct {
	// The identifier uniquely identifying the feature.
	FeatureId OptInt64 `json:"featureId"`
	// The feature type of the feature.
	FeatureType OptString `json:"featureType"`
	// The value of the feature that was scored.
	FeatureValue OptString `json:"featureValue"`
	// The usage type assigned to the feature value.  This field is optional and may be excluded if the
	// value is missing.
	UsageType OptString `json:"usageType"`
}

A description of a feature that has been scored against another feature. Ref: #/components/schemas/SzScoredFeature

func (*SzScoredFeature) Decode 

func (s *SzScoredFeature) Decode(d *jx.Decoder) error

Decode decodes SzScoredFeature from json.

func (*SzScoredFeature) Encode 

func (s *SzScoredFeature) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzScoredFeature) GetFeatureId 

func (s *SzScoredFeature) GetFeatureId() OptInt64

GetFeatureId returns the value of FeatureId.

func (*SzScoredFeature) GetFeatureType 

func (s *SzScoredFeature) GetFeatureType() OptString

GetFeatureType returns the value of FeatureType.

func (*SzScoredFeature) GetFeatureValue 

func (s *SzScoredFeature) GetFeatureValue() OptString

GetFeatureValue returns the value of FeatureValue.

func (*SzScoredFeature) GetUsageType 

func (s *SzScoredFeature) GetUsageType() OptString

GetUsageType returns the value of UsageType.

func (*SzScoredFeature) MarshalJSON 

func (s *SzScoredFeature) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzScoredFeature) SetFeatureId 

func (s *SzScoredFeature) SetFeatureId(val OptInt64)

SetFeatureId sets the value of FeatureId.

func (*SzScoredFeature) SetFeatureType 

func (s *SzScoredFeature) SetFeatureType(val OptString)

SetFeatureType sets the value of FeatureType.

func (*SzScoredFeature) SetFeatureValue 

func (s *SzScoredFeature) SetFeatureValue(val OptString)

SetFeatureValue sets the value of FeatureValue.

func (*SzScoredFeature) SetUsageType 

func (s *SzScoredFeature) SetUsageType(val OptString)

SetUsageType sets the value of UsageType.

func (*SzScoredFeature) UnmarshalJSON 

func (s *SzScoredFeature) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzScoringBehavior 

type SzScoringBehavior struct {
	// The code identifying the behavior.
	Code OptString `json:"code"`
	// The number of entities that that would typically share the same value for a feature of type.  This
	// value can only be `null` if the frequency is unknown for the scoring behavior code that is
	// returned.
	Frequency OptSzScoringFrequency `json:"frequency"`
	// `true` if an entity should typically have only one value for a feature of this type (like a Social
	// Security Number, Date of Birth) and `false` if the entity can typically have multiple values for
	// the feature type (like Address or Phone Number).  This value is `null` if exclusivity is not
	// applicable to the scoring behavior such as with special scoring behaviors like `NAME`.
	Exclusive OptNilBool `json:"exclusive"`
	// `true` if the feature value for the feature type remains constant for an entity over time (like a
	// Date of Birth), and `false` if it can can change for the entity over time (like a Home Address).
	// This is `null` if the stability is not applicable to the scoring behavior such as with special
	// behaviors like `NAME`.
	Stable OptNilBool `json:"stable"`
}

Describes the scoring behavior for a feature / feature type. Ref: #/components/schemas/SzScoringBehavior

func (*SzScoringBehavior) Decode 

func (s *SzScoringBehavior) Decode(d *jx.Decoder) error

Decode decodes SzScoringBehavior from json.

func (*SzScoringBehavior) Encode 

func (s *SzScoringBehavior) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzScoringBehavior) GetCode 

func (s *SzScoringBehavior) GetCode() OptString

GetCode returns the value of Code.

func (*SzScoringBehavior) GetExclusive 

func (s *SzScoringBehavior) GetExclusive() OptNilBool

GetExclusive returns the value of Exclusive.

func (*SzScoringBehavior) GetFrequency 

func (s *SzScoringBehavior) GetFrequency() OptSzScoringFrequency

GetFrequency returns the value of Frequency.

func (*SzScoringBehavior) GetStable 

func (s *SzScoringBehavior) GetStable() OptNilBool

GetStable returns the value of Stable.

func (*SzScoringBehavior) MarshalJSON 

func (s *SzScoringBehavior) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzScoringBehavior) SetCode 

func (s *SzScoringBehavior) SetCode(val OptString)

SetCode sets the value of Code.

func (*SzScoringBehavior) SetExclusive 

func (s *SzScoringBehavior) SetExclusive(val OptNilBool)

SetExclusive sets the value of Exclusive.

func (*SzScoringBehavior) SetFrequency 

func (s *SzScoringBehavior) SetFrequency(val OptSzScoringFrequency)

SetFrequency sets the value of Frequency.

func (*SzScoringBehavior) SetStable 

func (s *SzScoringBehavior) SetStable(val OptNilBool)

SetStable sets the value of Stable.

func (*SzScoringBehavior) UnmarshalJSON 

func (s *SzScoringBehavior) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzScoringBehavior) Validate 

func (s *SzScoringBehavior) Validate() error

type SzScoringBucket 

type SzScoringBucket string

Describes the scoring bucket that a feature score falls into. The range of scores constitute different buckets depending on the feature type.. The possible values are: * `NOT_SCORED` - The respective features were not scored. * `SAME` - The two feature values are considered to be the same. * `CLOSE` - The two feature values are considered to be close. * `LIKELY` - The two feature values are similar, but not enough to be considered `CLOSE`. * `PLAUSIBLE` - It's possible that the two feature values are the same but almost just as likely that they are not. * `UNLIKELY` - It's unlikely that the two feature values represent the same value. * `NO_CHANCE` - The two feature values obviously represent different values. Ref: #/components/schemas/SzScoringBucket 

const (
	SzScoringBucketNOTSCORED SzScoringBucket = "NOT_SCORED"
	SzScoringBucketSAME      SzScoringBucket = "SAME"
	SzScoringBucketCLOSE     SzScoringBucket = "CLOSE"
	SzScoringBucketLIKELY    SzScoringBucket = "LIKELY"
	SzScoringBucketPLAUSIBLE SzScoringBucket = "PLAUSIBLE"
	SzScoringBucketUNLIKELY  SzScoringBucket = "UNLIKELY"
	SzScoringBucketNOCHANCE  SzScoringBucket = "NO_CHANCE"
)

func (SzScoringBucket) AllValues added in v0.9.0 

func (SzScoringBucket) AllValues() []SzScoringBucket

AllValues returns all SzScoringBucket values.

func (*SzScoringBucket) Decode 

func (s *SzScoringBucket) Decode(d *jx.Decoder) error

Decode decodes SzScoringBucket from json.

func (SzScoringBucket) Encode 

func (s SzScoringBucket) Encode(e *jx.Encoder)

Encode encodes SzScoringBucket as json.

func (SzScoringBucket) MarshalJSON 

func (s SzScoringBucket) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzScoringBucket) MarshalText 

func (s SzScoringBucket) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzScoringBucket) UnmarshalJSON 

func (s *SzScoringBucket) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzScoringBucket) UnmarshalText 

func (s *SzScoringBucket) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzScoringBucket) Validate 

func (s SzScoringBucket) Validate() error

type SzScoringFrequency 

type SzScoringFrequency string

Enumerates the various scoring behavior frequencies for entity features. This indicates the number of entities that would typically share the same value for a feature of this type. The possible values are: * `ALWAYS_ONE` - The feature value belongs to exactly one entity so if two records share this value they will always merge together. * `ONE` - The feature value typically belongs to one entity (like a Social Security Number, Tax ID or Drivers License Number) * `FEW` - The feature value typically belongs to at most a few entities (like an Address or Phone Number). * `MANY` - The feature value can belong to many entities (like a date of birth) * `VERY_MANY` - The feature can belong to very many entities (like a gender). * `NAME` - A special frequency used for name features since they have unique properties. Ref: #/components/schemas/SzScoringFrequency 

const (
	SzScoringFrequencyALWAYSONE SzScoringFrequency = "ALWAYS_ONE"
	SzScoringFrequencyONE       SzScoringFrequency = "ONE"
	SzScoringFrequencyFEW       SzScoringFrequency = "FEW"
	SzScoringFrequencyMANY      SzScoringFrequency = "MANY"
	SzScoringFrequencyVERYMANY  SzScoringFrequency = "VERY_MANY"
	SzScoringFrequencyNAME      SzScoringFrequency = "NAME"
)

func (SzScoringFrequency) AllValues added in v0.9.0 

func (SzScoringFrequency) AllValues() []SzScoringFrequency

AllValues returns all SzScoringFrequency values.

func (*SzScoringFrequency) Decode 

func (s *SzScoringFrequency) Decode(d *jx.Decoder) error

Decode decodes SzScoringFrequency from json.

func (SzScoringFrequency) Encode 

func (s SzScoringFrequency) Encode(e *jx.Encoder)

Encode encodes SzScoringFrequency as json.

func (SzScoringFrequency) MarshalJSON 

func (s SzScoringFrequency) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (SzScoringFrequency) MarshalText 

func (s SzScoringFrequency) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*SzScoringFrequency) UnmarshalJSON 

func (s *SzScoringFrequency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzScoringFrequency) UnmarshalText 

func (s *SzScoringFrequency) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (SzScoringFrequency) Validate 

func (s SzScoringFrequency) Validate() error

type SzSearchFeatureScore 

type SzSearchFeatureScore struct {
	// The feature type of the features being scored.
	FeatureType OptString `json:"featureType"`
	// The inbound feature value as a string.
	InboundFeature OptString `json:"inboundFeature"`
	// The feature value that was a candidate match for the inbound feature as a string.
	CandidateFeature OptString `json:"candidateFeature"`
	// The integer score between the two feature values (typically from 0 to 100).  If this is a name
	// feature, then this value is the "best" value from the `SzNameScoring` instance described by
	// `nameScoringDetails` (in order of precedence the first of these values that exists: `orgNameScore`,
	//  `fullNameScore`, `surnameScore` and then `givenNameScore`).
	Score OptInt32 `json:"score"`
	// The name scoring values if this score is for a name feature.  This property is omitted if not a
	// name feature.
	NameScoringDetails OptSzNameScoring `json:"nameScoringDetails"`
}

Describes the scoring between two search features. Ref: #/components/schemas/SzSearchFeatureScore

func (*SzSearchFeatureScore) Decode 

func (s *SzSearchFeatureScore) Decode(d *jx.Decoder) error

Decode decodes SzSearchFeatureScore from json.

func (*SzSearchFeatureScore) Encode 

func (s *SzSearchFeatureScore) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzSearchFeatureScore) GetCandidateFeature 

func (s *SzSearchFeatureScore) GetCandidateFeature() OptString

GetCandidateFeature returns the value of CandidateFeature.

func (*SzSearchFeatureScore) GetFeatureType 

func (s *SzSearchFeatureScore) GetFeatureType() OptString

GetFeatureType returns the value of FeatureType.

func (*SzSearchFeatureScore) GetInboundFeature 

func (s *SzSearchFeatureScore) GetInboundFeature() OptString

GetInboundFeature returns the value of InboundFeature.

func (*SzSearchFeatureScore) GetNameScoringDetails 

func (s *SzSearchFeatureScore) GetNameScoringDetails() OptSzNameScoring

GetNameScoringDetails returns the value of NameScoringDetails.

func (*SzSearchFeatureScore) GetScore 

func (s *SzSearchFeatureScore) GetScore() OptInt32

GetScore returns the value of Score.

func (*SzSearchFeatureScore) MarshalJSON 

func (s *SzSearchFeatureScore) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzSearchFeatureScore) SetCandidateFeature 

func (s *SzSearchFeatureScore) SetCandidateFeature(val OptString)

SetCandidateFeature sets the value of CandidateFeature.

func (*SzSearchFeatureScore) SetFeatureType 

func (s *SzSearchFeatureScore) SetFeatureType(val OptString)

SetFeatureType sets the value of FeatureType.

func (*SzSearchFeatureScore) SetInboundFeature 

func (s *SzSearchFeatureScore) SetInboundFeature(val OptString)

SetInboundFeature sets the value of InboundFeature.

func (*SzSearchFeatureScore) SetNameScoringDetails 

func (s *SzSearchFeatureScore) SetNameScoringDetails(val OptSzNameScoring)

SetNameScoringDetails sets the value of NameScoringDetails.

func (*SzSearchFeatureScore) SetScore 

func (s *SzSearchFeatureScore) SetScore(val OptInt32)

SetScore sets the value of Score.

func (*SzSearchFeatureScore) UnmarshalJSON 

func (s *SzSearchFeatureScore) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzServerInfo 

type SzServerInfo struct {
	// The number of Senzing worker threads pooled for handling requests.
	Concurrency OptInt32 `json:"concurrency"`
	// The active configuration ID being used by the API server.  This is still available if the server
	// was started with a static file configuration via the `G2CONFIGFILE` initialization property.
	ActiveConfigId OptInt32 `json:"activeConfigId"`
	// Whether or not the server will automatically pickup the latest default configuration if it changes.
	DynamicConfig OptBool `json:"dynamicConfig"`
	// Whether or not the server was started in read-only mode.  If in read-only mode then operations
	// that modify the repository (e.g.: loading records or configuring new data sources) are not allowed.
	ReadOnly OptBool `json:"readOnly"`
	// Whether or not admin features are enabled.  If admin features are not enabled then the
	// configuration cannot be modified.
	AdminEnabled OptBool `json:"adminEnabled"`
	// The maximum size for inbound text or binary messages when invoking end-points via Web Sockets
	// `ws://` protocol.
	WebSocketsMessageMaxSize OptInt32 `json:"webSocketsMessageMaxSize"`
	// Whether or not an asynchronous INFO queue has been configured for automatically sending "INFO"
	// messages when records are loaded, reevaluated or deleted.
	InfoQueueConfigured OptBool `json:"infoQueueConfigured"`
}

Provides information about which server features are enabled and which are not enabled. Ref: #/components/schemas/SzServerInfo

func (*SzServerInfo) Decode 

func (s *SzServerInfo) Decode(d *jx.Decoder) error

Decode decodes SzServerInfo from json.

func (*SzServerInfo) Encode 

func (s *SzServerInfo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzServerInfo) GetActiveConfigId 

func (s *SzServerInfo) GetActiveConfigId() OptInt32

GetActiveConfigId returns the value of ActiveConfigId.

func (*SzServerInfo) GetAdminEnabled 

func (s *SzServerInfo) GetAdminEnabled() OptBool

GetAdminEnabled returns the value of AdminEnabled.

func (*SzServerInfo) GetConcurrency 

func (s *SzServerInfo) GetConcurrency() OptInt32

GetConcurrency returns the value of Concurrency.

func (*SzServerInfo) GetDynamicConfig 

func (s *SzServerInfo) GetDynamicConfig() OptBool

GetDynamicConfig returns the value of DynamicConfig.

func (*SzServerInfo) GetInfoQueueConfigured 

func (s *SzServerInfo) GetInfoQueueConfigured() OptBool

GetInfoQueueConfigured returns the value of InfoQueueConfigured.

func (*SzServerInfo) GetReadOnly 

func (s *SzServerInfo) GetReadOnly() OptBool

GetReadOnly returns the value of ReadOnly.

func (*SzServerInfo) GetWebSocketsMessageMaxSize 

func (s *SzServerInfo) GetWebSocketsMessageMaxSize() OptInt32

GetWebSocketsMessageMaxSize returns the value of WebSocketsMessageMaxSize.

func (*SzServerInfo) MarshalJSON 

func (s *SzServerInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzServerInfo) SetActiveConfigId 

func (s *SzServerInfo) SetActiveConfigId(val OptInt32)

SetActiveConfigId sets the value of ActiveConfigId.

func (*SzServerInfo) SetAdminEnabled 

func (s *SzServerInfo) SetAdminEnabled(val OptBool)

SetAdminEnabled sets the value of AdminEnabled.

func (*SzServerInfo) SetConcurrency 

func (s *SzServerInfo) SetConcurrency(val OptInt32)

SetConcurrency sets the value of Concurrency.

func (*SzServerInfo) SetDynamicConfig 

func (s *SzServerInfo) SetDynamicConfig(val OptBool)

SetDynamicConfig sets the value of DynamicConfig.

func (*SzServerInfo) SetInfoQueueConfigured 

func (s *SzServerInfo) SetInfoQueueConfigured(val OptBool)

SetInfoQueueConfigured sets the value of InfoQueueConfigured.

func (*SzServerInfo) SetReadOnly 

func (s *SzServerInfo) SetReadOnly(val OptBool)

SetReadOnly sets the value of ReadOnly.

func (*SzServerInfo) SetWebSocketsMessageMaxSize 

func (s *SzServerInfo) SetWebSocketsMessageMaxSize(val OptInt32)

SetWebSocketsMessageMaxSize sets the value of WebSocketsMessageMaxSize.

func (*SzServerInfo) UnmarshalJSON 

func (s *SzServerInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzServerInfoResponse 

type SzServerInfoResponse struct {
	Meta  OptSzMeta       `json:"meta"`
	Links OptSzLinks      `json:"links"`
	Data  OptSzServerInfo `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzServerInfoResponse

func (*SzServerInfoResponse) Decode 

func (s *SzServerInfoResponse) Decode(d *jx.Decoder) error

Decode decodes SzServerInfoResponse from json.

func (*SzServerInfoResponse) Encode 

func (s *SzServerInfoResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzServerInfoResponse) GetData 

func (s *SzServerInfoResponse) GetData() OptSzServerInfo

GetData returns the value of Data. 

func (s *SzServerInfoResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzServerInfoResponse) GetMeta 

func (s *SzServerInfoResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzServerInfoResponse) MarshalJSON 

func (s *SzServerInfoResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzServerInfoResponse) SetData 

func (s *SzServerInfoResponse) SetData(val OptSzServerInfo)

SetData sets the value of Data. 

func (s *SzServerInfoResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzServerInfoResponse) SetMeta 

func (s *SzServerInfoResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzServerInfoResponse) UnmarshalJSON 

func (s *SzServerInfoResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzServerInfoResponse) Validate 

func (s *SzServerInfoResponse) Validate() error

type SzVersionInfo 

type SzVersionInfo struct {
	// The version of the REST API Server implementation.
	ApiServerVersion OptString `json:"apiServerVersion"`
	// The version of the REST API Specification that is implemented.
	RestApiVersion OptString `json:"restApiVersion"`
	// The version for the underlying runtime native Senzing API.
	NativeApiVersion OptString `json:"nativeApiVersion"`
	// The build version for the underlying runtime native Senzing API.
	NativeApiBuildVersion OptString `json:"nativeApiBuildVersion"`
	// The build number for the underlying runtime native Senzing API.
	NativeApiBuildNumber OptString `json:"nativeApiBuildNumber"`
	// The build date for the underlying runtime native Senzing API.
	NativeApiBuildDate OptDateTime `json:"nativeApiBuildDate"`
	// The configuration compatibility version for the underlying runtime native Senzing API.
	ConfigCompatibilityVersion OptString `json:"configCompatibilityVersion"`
}

Describes the Senzing version information. Ref: #/components/schemas/SzVersionInfo

func (*SzVersionInfo) Decode 

func (s *SzVersionInfo) Decode(d *jx.Decoder) error

Decode decodes SzVersionInfo from json.

func (*SzVersionInfo) Encode 

func (s *SzVersionInfo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzVersionInfo) GetApiServerVersion 

func (s *SzVersionInfo) GetApiServerVersion() OptString

GetApiServerVersion returns the value of ApiServerVersion.

func (*SzVersionInfo) GetConfigCompatibilityVersion 

func (s *SzVersionInfo) GetConfigCompatibilityVersion() OptString

GetConfigCompatibilityVersion returns the value of ConfigCompatibilityVersion.

func (*SzVersionInfo) GetNativeApiBuildDate 

func (s *SzVersionInfo) GetNativeApiBuildDate() OptDateTime

GetNativeApiBuildDate returns the value of NativeApiBuildDate.

func (*SzVersionInfo) GetNativeApiBuildNumber 

func (s *SzVersionInfo) GetNativeApiBuildNumber() OptString

GetNativeApiBuildNumber returns the value of NativeApiBuildNumber.

func (*SzVersionInfo) GetNativeApiBuildVersion 

func (s *SzVersionInfo) GetNativeApiBuildVersion() OptString

GetNativeApiBuildVersion returns the value of NativeApiBuildVersion.

func (*SzVersionInfo) GetNativeApiVersion 

func (s *SzVersionInfo) GetNativeApiVersion() OptString

GetNativeApiVersion returns the value of NativeApiVersion.

func (*SzVersionInfo) GetRestApiVersion 

func (s *SzVersionInfo) GetRestApiVersion() OptString

GetRestApiVersion returns the value of RestApiVersion.

func (*SzVersionInfo) MarshalJSON 

func (s *SzVersionInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzVersionInfo) SetApiServerVersion 

func (s *SzVersionInfo) SetApiServerVersion(val OptString)

SetApiServerVersion sets the value of ApiServerVersion.

func (*SzVersionInfo) SetConfigCompatibilityVersion 

func (s *SzVersionInfo) SetConfigCompatibilityVersion(val OptString)

SetConfigCompatibilityVersion sets the value of ConfigCompatibilityVersion.

func (*SzVersionInfo) SetNativeApiBuildDate 

func (s *SzVersionInfo) SetNativeApiBuildDate(val OptDateTime)

SetNativeApiBuildDate sets the value of NativeApiBuildDate.

func (*SzVersionInfo) SetNativeApiBuildNumber 

func (s *SzVersionInfo) SetNativeApiBuildNumber(val OptString)

SetNativeApiBuildNumber sets the value of NativeApiBuildNumber.

func (*SzVersionInfo) SetNativeApiBuildVersion 

func (s *SzVersionInfo) SetNativeApiBuildVersion(val OptString)

SetNativeApiBuildVersion sets the value of NativeApiBuildVersion.

func (*SzVersionInfo) SetNativeApiVersion 

func (s *SzVersionInfo) SetNativeApiVersion(val OptString)

SetNativeApiVersion sets the value of NativeApiVersion.

func (*SzVersionInfo) SetRestApiVersion 

func (s *SzVersionInfo) SetRestApiVersion(val OptString)

SetRestApiVersion sets the value of RestApiVersion.

func (*SzVersionInfo) UnmarshalJSON 

func (s *SzVersionInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzVersionResponse 

type SzVersionResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzVersionResponseRawData `json:"rawData"`
	Data    OptSzVersionInfo               `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzVersionResponse

func (*SzVersionResponse) Decode 

func (s *SzVersionResponse) Decode(d *jx.Decoder) error

Decode decodes SzVersionResponse from json.

func (*SzVersionResponse) Encode 

func (s *SzVersionResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzVersionResponse) GetData 

func (s *SzVersionResponse) GetData() OptSzVersionInfo

GetData returns the value of Data. 

func (s *SzVersionResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzVersionResponse) GetMeta 

func (s *SzVersionResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzVersionResponse) GetRawData 

func (s *SzVersionResponse) GetRawData() OptNilSzVersionResponseRawData

GetRawData returns the value of RawData.

func (*SzVersionResponse) MarshalJSON 

func (s *SzVersionResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzVersionResponse) SetData 

func (s *SzVersionResponse) SetData(val OptSzVersionInfo)

SetData sets the value of Data. 

func (s *SzVersionResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzVersionResponse) SetMeta 

func (s *SzVersionResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzVersionResponse) SetRawData 

func (s *SzVersionResponse) SetRawData(val OptNilSzVersionResponseRawData)

SetRawData sets the value of RawData.

func (*SzVersionResponse) UnmarshalJSON 

func (s *SzVersionResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzVersionResponse) Validate 

func (s *SzVersionResponse) Validate() error

type SzVersionResponseRawData 

type SzVersionResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzVersionResponseRawData) Decode 

func (s *SzVersionResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzVersionResponseRawData from json.

func (SzVersionResponseRawData) Encode 

func (s SzVersionResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzVersionResponseRawData) MarshalJSON 

func (s SzVersionResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzVersionResponseRawData) UnmarshalJSON 

func (s *SzVersionResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzVirtualEntity 

type SzVirtualEntity struct {
	// The unique identifier that distinguishes this virtual entity from all other virtual entities among
	// all steps in a "how" result.
	VirtualEntityId OptString `json:"virtualEntityId"`
	// Indicates if the virtual entity consists of a a single record or one or more effectively identical
	// records (i.e.: with the same internal ID) with a value of `true`.  If this virtual entity
	// comprises multiple distinct records then this is `false`.
	Singleton OptBool `json:"singleton"`
	// The array of `SzVirtualEntityRecords` identifying the constituent records of the virtual entity.
	// Those records in the array with the same `internalId` property are effectively identical for the
	// purposes of entity resolution.
	Records []SzVirtualEntityRecord `json:"records"`
}

Describes a virtual entity that describes an interim resolution step for an actual entity. Virtual entities that consist of a single record (or multiple "identical" records) are considered singletons and are the initial building blocks in how an entity is resolved. Those with multiple distinct records are compound virtual entities formed from resolving two virtual entities. Ref: #/components/schemas/SzVirtualEntity

func (*SzVirtualEntity) Decode 

func (s *SzVirtualEntity) Decode(d *jx.Decoder) error

Decode decodes SzVirtualEntity from json.

func (*SzVirtualEntity) Encode 

func (s *SzVirtualEntity) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzVirtualEntity) GetRecords 

func (s *SzVirtualEntity) GetRecords() []SzVirtualEntityRecord

GetRecords returns the value of Records.

func (*SzVirtualEntity) GetSingleton 

func (s *SzVirtualEntity) GetSingleton() OptBool

GetSingleton returns the value of Singleton.

func (*SzVirtualEntity) GetVirtualEntityId 

func (s *SzVirtualEntity) GetVirtualEntityId() OptString

GetVirtualEntityId returns the value of VirtualEntityId.

func (*SzVirtualEntity) MarshalJSON 

func (s *SzVirtualEntity) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzVirtualEntity) SetRecords 

func (s *SzVirtualEntity) SetRecords(val []SzVirtualEntityRecord)

SetRecords sets the value of Records.

func (*SzVirtualEntity) SetSingleton 

func (s *SzVirtualEntity) SetSingleton(val OptBool)

SetSingleton sets the value of Singleton.

func (*SzVirtualEntity) SetVirtualEntityId 

func (s *SzVirtualEntity) SetVirtualEntityId(val OptString)

SetVirtualEntityId sets the value of VirtualEntityId.

func (*SzVirtualEntity) UnmarshalJSON 

func (s *SzVirtualEntity) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzVirtualEntityData 

type SzVirtualEntityData struct {
	// The ResolvedEntity describing the primary entity.
	ResolvedEntity OptSzResolvedEntity `json:"resolvedEntity"`
}

Describes the data associated with an `SzVirtualEntityResponse` which currently includes only an `SzResolvedEntity`. Ref: #/components/schemas/SzVirtualEntityData

func (*SzVirtualEntityData) Decode 

func (s *SzVirtualEntityData) Decode(d *jx.Decoder) error

Decode decodes SzVirtualEntityData from json.

func (*SzVirtualEntityData) Encode 

func (s *SzVirtualEntityData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzVirtualEntityData) GetResolvedEntity 

func (s *SzVirtualEntityData) GetResolvedEntity() OptSzResolvedEntity

GetResolvedEntity returns the value of ResolvedEntity.

func (*SzVirtualEntityData) MarshalJSON 

func (s *SzVirtualEntityData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzVirtualEntityData) SetResolvedEntity 

func (s *SzVirtualEntityData) SetResolvedEntity(val OptSzResolvedEntity)

SetResolvedEntity sets the value of ResolvedEntity.

func (*SzVirtualEntityData) UnmarshalJSON 

func (s *SzVirtualEntityData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzVirtualEntityData) Validate 

func (s *SzVirtualEntityData) Validate() error

type SzVirtualEntityRecord 

type SzVirtualEntityRecord struct {
	// The data source code that uniquely identifies the data source associated with the record.
	DataSource OptString `json:"dataSource"`
	// The record ID that uniquely identifies a record within the respective data source.
	RecordId OptString `json:"recordId"`
	// The unique internal ID for the record.  Those records having the same value for this field are
	// effectively identical for the purpose of entity resolution and automatically bound together.
	InternalId OptString `json:"internalId"`
}

Describes a record that belongs to a virtual entity. This identifies the record as well as its internal ID to understand which records in the virtual entity are considered to be duplicates of each other. Ref: #/components/schemas/SzVirtualEntityRecord

func (*SzVirtualEntityRecord) Decode 

func (s *SzVirtualEntityRecord) Decode(d *jx.Decoder) error

Decode decodes SzVirtualEntityRecord from json.

func (*SzVirtualEntityRecord) Encode 

func (s *SzVirtualEntityRecord) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzVirtualEntityRecord) GetDataSource 

func (s *SzVirtualEntityRecord) GetDataSource() OptString

GetDataSource returns the value of DataSource.

func (*SzVirtualEntityRecord) GetInternalId 

func (s *SzVirtualEntityRecord) GetInternalId() OptString

GetInternalId returns the value of InternalId.

func (*SzVirtualEntityRecord) GetRecordId 

func (s *SzVirtualEntityRecord) GetRecordId() OptString

GetRecordId returns the value of RecordId.

func (*SzVirtualEntityRecord) MarshalJSON 

func (s *SzVirtualEntityRecord) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzVirtualEntityRecord) SetDataSource 

func (s *SzVirtualEntityRecord) SetDataSource(val OptString)

SetDataSource sets the value of DataSource.

func (*SzVirtualEntityRecord) SetInternalId 

func (s *SzVirtualEntityRecord) SetInternalId(val OptString)

SetInternalId sets the value of InternalId.

func (*SzVirtualEntityRecord) SetRecordId 

func (s *SzVirtualEntityRecord) SetRecordId(val OptString)

SetRecordId sets the value of RecordId.

func (*SzVirtualEntityRecord) UnmarshalJSON 

func (s *SzVirtualEntityRecord) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzVirtualEntityResponse 

type SzVirtualEntityResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzVirtualEntityResponseRawData `json:"rawData"`
	Data    OptSzVirtualEntityData               `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzVirtualEntityResponse

func (*SzVirtualEntityResponse) Decode 

func (s *SzVirtualEntityResponse) Decode(d *jx.Decoder) error

Decode decodes SzVirtualEntityResponse from json.

func (*SzVirtualEntityResponse) Encode 

func (s *SzVirtualEntityResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzVirtualEntityResponse) GetData 

func (s *SzVirtualEntityResponse) GetData() OptSzVirtualEntityData

GetData returns the value of Data. 

func (s *SzVirtualEntityResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzVirtualEntityResponse) GetMeta 

func (s *SzVirtualEntityResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzVirtualEntityResponse) GetRawData 

func (s *SzVirtualEntityResponse) GetRawData() OptNilSzVirtualEntityResponseRawData

GetRawData returns the value of RawData.

func (*SzVirtualEntityResponse) MarshalJSON 

func (s *SzVirtualEntityResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzVirtualEntityResponse) SetData 

func (s *SzVirtualEntityResponse) SetData(val OptSzVirtualEntityData)

SetData sets the value of Data. 

func (s *SzVirtualEntityResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzVirtualEntityResponse) SetMeta 

func (s *SzVirtualEntityResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzVirtualEntityResponse) SetRawData 

func (s *SzVirtualEntityResponse) SetRawData(val OptNilSzVirtualEntityResponseRawData)

SetRawData sets the value of RawData.

func (*SzVirtualEntityResponse) UnmarshalJSON 

func (s *SzVirtualEntityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzVirtualEntityResponse) Validate 

func (s *SzVirtualEntityResponse) Validate() error

type SzVirtualEntityResponseRawData 

type SzVirtualEntityResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzVirtualEntityResponseRawData) Decode 

func (s *SzVirtualEntityResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzVirtualEntityResponseRawData from json.

func (SzVirtualEntityResponseRawData) Encode 

func (s SzVirtualEntityResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzVirtualEntityResponseRawData) MarshalJSON 

func (s SzVirtualEntityResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzVirtualEntityResponseRawData) UnmarshalJSON 

func (s *SzVirtualEntityResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzWhyEntitiesResponse 

type SzWhyEntitiesResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzWhyEntitiesResponseRawData `json:"rawData"`
	Data    OptSzWhyEntitiesResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzWhyEntitiesResponse

func (*SzWhyEntitiesResponse) Decode 

func (s *SzWhyEntitiesResponse) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntitiesResponse from json.

func (*SzWhyEntitiesResponse) Encode 

func (s *SzWhyEntitiesResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyEntitiesResponse) GetData 

func (s *SzWhyEntitiesResponse) GetData() OptSzWhyEntitiesResponseData

GetData returns the value of Data. 

func (s *SzWhyEntitiesResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzWhyEntitiesResponse) GetMeta 

func (s *SzWhyEntitiesResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzWhyEntitiesResponse) GetRawData 

func (s *SzWhyEntitiesResponse) GetRawData() OptNilSzWhyEntitiesResponseRawData

GetRawData returns the value of RawData.

func (*SzWhyEntitiesResponse) MarshalJSON 

func (s *SzWhyEntitiesResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyEntitiesResponse) SetData 

func (s *SzWhyEntitiesResponse) SetData(val OptSzWhyEntitiesResponseData)

SetData sets the value of Data. 

func (s *SzWhyEntitiesResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzWhyEntitiesResponse) SetMeta 

func (s *SzWhyEntitiesResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzWhyEntitiesResponse) SetRawData 

func (s *SzWhyEntitiesResponse) SetRawData(val OptNilSzWhyEntitiesResponseRawData)

SetRawData sets the value of RawData.

func (*SzWhyEntitiesResponse) UnmarshalJSON 

func (s *SzWhyEntitiesResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyEntitiesResponse) Validate 

func (s *SzWhyEntitiesResponse) Validate() error

type SzWhyEntitiesResponseData 

type SzWhyEntitiesResponseData struct {
	// The `SzWhyEntitiesResult` describing why the two entities did not resolve or why they related.
	WhyResult OptSzWhyEntitiesResult `json:"whyResult"`
	// The array of `SzEntityData` objects describing the entities involved in the response.  This will
	// include partial information on the first-degree related entities to the entity.
	Entities []SzEntityData `json:"entities"`
}

func (*SzWhyEntitiesResponseData) Decode 

func (s *SzWhyEntitiesResponseData) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntitiesResponseData from json.

func (*SzWhyEntitiesResponseData) Encode 

func (s *SzWhyEntitiesResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyEntitiesResponseData) GetEntities 

func (s *SzWhyEntitiesResponseData) GetEntities() []SzEntityData

GetEntities returns the value of Entities.

func (*SzWhyEntitiesResponseData) GetWhyResult 

func (s *SzWhyEntitiesResponseData) GetWhyResult() OptSzWhyEntitiesResult

GetWhyResult returns the value of WhyResult.

func (*SzWhyEntitiesResponseData) MarshalJSON 

func (s *SzWhyEntitiesResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyEntitiesResponseData) SetEntities 

func (s *SzWhyEntitiesResponseData) SetEntities(val []SzEntityData)

SetEntities sets the value of Entities.

func (*SzWhyEntitiesResponseData) SetWhyResult 

func (s *SzWhyEntitiesResponseData) SetWhyResult(val OptSzWhyEntitiesResult)

SetWhyResult sets the value of WhyResult.

func (*SzWhyEntitiesResponseData) UnmarshalJSON 

func (s *SzWhyEntitiesResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyEntitiesResponseData) Validate 

func (s *SzWhyEntitiesResponseData) Validate() error

type SzWhyEntitiesResponseRawData 

type SzWhyEntitiesResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzWhyEntitiesResponseRawData) Decode 

func (s *SzWhyEntitiesResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntitiesResponseRawData from json.

func (SzWhyEntitiesResponseRawData) Encode 

func (s SzWhyEntitiesResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzWhyEntitiesResponseRawData) MarshalJSON 

func (s SzWhyEntitiesResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyEntitiesResponseRawData) UnmarshalJSON 

func (s *SzWhyEntitiesResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzWhyEntitiesResult 

type SzWhyEntitiesResult struct {
	// The entity ID of the first entity.
	EntityId1 OptInt64 `json:"entityId1"`
	// The entity ID of the second entity.
	EntityId2 OptInt64 `json:"entityId2"`
	// The `SzWhyMatchInfo` providing the details of the result.
	MatchInfo OptSzWhyMatchInfo `json:"matchInfo"`
}

Describes why two entities did not resolve or why they related. Ref: #/components/schemas/SzWhyEntitiesResult

func (*SzWhyEntitiesResult) Decode 

func (s *SzWhyEntitiesResult) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntitiesResult from json.

func (*SzWhyEntitiesResult) Encode 

func (s *SzWhyEntitiesResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyEntitiesResult) GetEntityId1 

func (s *SzWhyEntitiesResult) GetEntityId1() OptInt64

GetEntityId1 returns the value of EntityId1.

func (*SzWhyEntitiesResult) GetEntityId2 

func (s *SzWhyEntitiesResult) GetEntityId2() OptInt64

GetEntityId2 returns the value of EntityId2.

func (*SzWhyEntitiesResult) GetMatchInfo 

func (s *SzWhyEntitiesResult) GetMatchInfo() OptSzWhyMatchInfo

GetMatchInfo returns the value of MatchInfo.

func (*SzWhyEntitiesResult) MarshalJSON 

func (s *SzWhyEntitiesResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyEntitiesResult) SetEntityId1 

func (s *SzWhyEntitiesResult) SetEntityId1(val OptInt64)

SetEntityId1 sets the value of EntityId1.

func (*SzWhyEntitiesResult) SetEntityId2 

func (s *SzWhyEntitiesResult) SetEntityId2(val OptInt64)

SetEntityId2 sets the value of EntityId2.

func (*SzWhyEntitiesResult) SetMatchInfo 

func (s *SzWhyEntitiesResult) SetMatchInfo(val OptSzWhyMatchInfo)

SetMatchInfo sets the value of MatchInfo.

func (*SzWhyEntitiesResult) UnmarshalJSON 

func (s *SzWhyEntitiesResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyEntitiesResult) Validate 

func (s *SzWhyEntitiesResult) Validate() error

type SzWhyEntityResponse 

type SzWhyEntityResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzWhyEntityResponseRawData `json:"rawData"`
	Data    OptSzWhyEntityResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzWhyEntityResponse

func (*SzWhyEntityResponse) Decode 

func (s *SzWhyEntityResponse) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntityResponse from json.

func (*SzWhyEntityResponse) Encode 

func (s *SzWhyEntityResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyEntityResponse) GetData 

func (s *SzWhyEntityResponse) GetData() OptSzWhyEntityResponseData

GetData returns the value of Data. 

func (s *SzWhyEntityResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzWhyEntityResponse) GetMeta 

func (s *SzWhyEntityResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzWhyEntityResponse) GetRawData 

func (s *SzWhyEntityResponse) GetRawData() OptNilSzWhyEntityResponseRawData

GetRawData returns the value of RawData.

func (*SzWhyEntityResponse) MarshalJSON 

func (s *SzWhyEntityResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyEntityResponse) SetData 

func (s *SzWhyEntityResponse) SetData(val OptSzWhyEntityResponseData)

SetData sets the value of Data. 

func (s *SzWhyEntityResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzWhyEntityResponse) SetMeta 

func (s *SzWhyEntityResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzWhyEntityResponse) SetRawData 

func (s *SzWhyEntityResponse) SetRawData(val OptNilSzWhyEntityResponseRawData)

SetRawData sets the value of RawData.

func (*SzWhyEntityResponse) UnmarshalJSON 

func (s *SzWhyEntityResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyEntityResponse) Validate 

func (s *SzWhyEntityResponse) Validate() error

type SzWhyEntityResponseData 

type SzWhyEntityResponseData struct {
	// The array of `SzWhyEntityResult` instances describing why from each evaluated perspective within
	// the entity.
	WhyResults []SzWhyEntityResult `json:"whyResults"`
	// The array of `SzEntityData` objects describing the entities involved in the response.  This will
	// include partial information on the first-degree related entities to the entity.
	Entities []SzEntityData `json:"entities"`
}

func (*SzWhyEntityResponseData) Decode 

func (s *SzWhyEntityResponseData) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntityResponseData from json.

func (*SzWhyEntityResponseData) Encode 

func (s *SzWhyEntityResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyEntityResponseData) GetEntities 

func (s *SzWhyEntityResponseData) GetEntities() []SzEntityData

GetEntities returns the value of Entities.

func (*SzWhyEntityResponseData) GetWhyResults 

func (s *SzWhyEntityResponseData) GetWhyResults() []SzWhyEntityResult

GetWhyResults returns the value of WhyResults.

func (*SzWhyEntityResponseData) MarshalJSON 

func (s *SzWhyEntityResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyEntityResponseData) SetEntities 

func (s *SzWhyEntityResponseData) SetEntities(val []SzEntityData)

SetEntities sets the value of Entities.

func (*SzWhyEntityResponseData) SetWhyResults 

func (s *SzWhyEntityResponseData) SetWhyResults(val []SzWhyEntityResult)

SetWhyResults sets the value of WhyResults.

func (*SzWhyEntityResponseData) UnmarshalJSON 

func (s *SzWhyEntityResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyEntityResponseData) Validate 

func (s *SzWhyEntityResponseData) Validate() error

type SzWhyEntityResponseRawData 

type SzWhyEntityResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzWhyEntityResponseRawData) Decode 

func (s *SzWhyEntityResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntityResponseRawData from json.

func (SzWhyEntityResponseRawData) Encode 

func (s SzWhyEntityResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzWhyEntityResponseRawData) MarshalJSON 

func (s SzWhyEntityResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyEntityResponseRawData) UnmarshalJSON 

func (s *SzWhyEntityResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzWhyEntityResult 

type SzWhyEntityResult struct {
	// The `SzWhyPerspective` identifying and describing the perspective for this why result.
	Perspective SzWhyPerspective `json:"perspective"`
	// The `SzWhyMatchInfo` providing the details of the result.
	MatchInfo OptSzWhyMatchInfo `json:"matchInfo"`
}

Describes why an entity resolved. Ref: #/components/schemas/SzWhyEntityResult

func (*SzWhyEntityResult) Decode 

func (s *SzWhyEntityResult) Decode(d *jx.Decoder) error

Decode decodes SzWhyEntityResult from json.

func (*SzWhyEntityResult) Encode 

func (s *SzWhyEntityResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyEntityResult) GetMatchInfo 

func (s *SzWhyEntityResult) GetMatchInfo() OptSzWhyMatchInfo

GetMatchInfo returns the value of MatchInfo.

func (*SzWhyEntityResult) GetPerspective 

func (s *SzWhyEntityResult) GetPerspective() SzWhyPerspective

GetPerspective returns the value of Perspective.

func (*SzWhyEntityResult) MarshalJSON 

func (s *SzWhyEntityResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyEntityResult) SetMatchInfo 

func (s *SzWhyEntityResult) SetMatchInfo(val OptSzWhyMatchInfo)

SetMatchInfo sets the value of MatchInfo.

func (*SzWhyEntityResult) SetPerspective 

func (s *SzWhyEntityResult) SetPerspective(val SzWhyPerspective)

SetPerspective sets the value of Perspective.

func (*SzWhyEntityResult) UnmarshalJSON 

func (s *SzWhyEntityResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyEntityResult) Validate 

func (s *SzWhyEntityResult) Validate() error

type SzWhyMatchInfo 

type SzWhyMatchInfo struct {
	// The why key indicating the components of the match (similar to the match key).
	WhyKey OptString `json:"whyKey"`
	// The match level describing how the records relate to each other.
	MatchLevel OptSzMatchLevel `json:"matchLevel"`
	// The resolution rule that triggered the match.
	ResolutionRule OptNilString `json:"resolutionRule"`
	// The map of feature types to arrays of `SzCandidateKey` instances for that feature type.
	CandidateKeys OptNilSzWhyMatchInfoCandidateKeys `json:"candidateKeys"`
	// The map of feature types to arrays of `SzFeatureScore` instances for that feature type.
	FeatureScores OptNilSzWhyMatchInfoFeatureScores `json:"featureScores"`
	// The list of `SzDisclosedRelation` instances describing any disclosed relationships between two
	// entities.  If the match info pertains to a single entity or if there are no disclosed relations
	// between the two entities then this property is absent.
	DisclosedRelations OptNilSzDisclosedRelationArray `json:"disclosedRelations"`
}

The match info describing why two entities (or records) resolve or relate to one another. Ref: #/components/schemas/SzWhyMatchInfo

func (*SzWhyMatchInfo) Decode 

func (s *SzWhyMatchInfo) Decode(d *jx.Decoder) error

Decode decodes SzWhyMatchInfo from json.

func (*SzWhyMatchInfo) Encode 

func (s *SzWhyMatchInfo) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyMatchInfo) GetCandidateKeys 

func (s *SzWhyMatchInfo) GetCandidateKeys() OptNilSzWhyMatchInfoCandidateKeys

GetCandidateKeys returns the value of CandidateKeys.

func (*SzWhyMatchInfo) GetDisclosedRelations 

func (s *SzWhyMatchInfo) GetDisclosedRelations() OptNilSzDisclosedRelationArray

GetDisclosedRelations returns the value of DisclosedRelations.

func (*SzWhyMatchInfo) GetFeatureScores 

func (s *SzWhyMatchInfo) GetFeatureScores() OptNilSzWhyMatchInfoFeatureScores

GetFeatureScores returns the value of FeatureScores.

func (*SzWhyMatchInfo) GetMatchLevel 

func (s *SzWhyMatchInfo) GetMatchLevel() OptSzMatchLevel

GetMatchLevel returns the value of MatchLevel.

func (*SzWhyMatchInfo) GetResolutionRule 

func (s *SzWhyMatchInfo) GetResolutionRule() OptNilString

GetResolutionRule returns the value of ResolutionRule.

func (*SzWhyMatchInfo) GetWhyKey 

func (s *SzWhyMatchInfo) GetWhyKey() OptString

GetWhyKey returns the value of WhyKey.

func (*SzWhyMatchInfo) MarshalJSON 

func (s *SzWhyMatchInfo) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyMatchInfo) SetCandidateKeys 

func (s *SzWhyMatchInfo) SetCandidateKeys(val OptNilSzWhyMatchInfoCandidateKeys)

SetCandidateKeys sets the value of CandidateKeys.

func (*SzWhyMatchInfo) SetDisclosedRelations 

func (s *SzWhyMatchInfo) SetDisclosedRelations(val OptNilSzDisclosedRelationArray)

SetDisclosedRelations sets the value of DisclosedRelations.

func (*SzWhyMatchInfo) SetFeatureScores 

func (s *SzWhyMatchInfo) SetFeatureScores(val OptNilSzWhyMatchInfoFeatureScores)

SetFeatureScores sets the value of FeatureScores.

func (*SzWhyMatchInfo) SetMatchLevel 

func (s *SzWhyMatchInfo) SetMatchLevel(val OptSzMatchLevel)

SetMatchLevel sets the value of MatchLevel.

func (*SzWhyMatchInfo) SetResolutionRule 

func (s *SzWhyMatchInfo) SetResolutionRule(val OptNilString)

SetResolutionRule sets the value of ResolutionRule.

func (*SzWhyMatchInfo) SetWhyKey 

func (s *SzWhyMatchInfo) SetWhyKey(val OptString)

SetWhyKey sets the value of WhyKey.

func (*SzWhyMatchInfo) UnmarshalJSON 

func (s *SzWhyMatchInfo) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyMatchInfo) Validate 

func (s *SzWhyMatchInfo) Validate() error

type SzWhyMatchInfoCandidateKeys 

type SzWhyMatchInfoCandidateKeys map[string][]SzCandidateKey

The map of feature types to arrays of `SzCandidateKey` instances for that feature type.

func (*SzWhyMatchInfoCandidateKeys) Decode 

func (s *SzWhyMatchInfoCandidateKeys) Decode(d *jx.Decoder) error

Decode decodes SzWhyMatchInfoCandidateKeys from json.

func (SzWhyMatchInfoCandidateKeys) Encode 

func (s SzWhyMatchInfoCandidateKeys) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzWhyMatchInfoCandidateKeys) MarshalJSON 

func (s SzWhyMatchInfoCandidateKeys) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyMatchInfoCandidateKeys) UnmarshalJSON 

func (s *SzWhyMatchInfoCandidateKeys) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SzWhyMatchInfoCandidateKeys) Validate 

func (s SzWhyMatchInfoCandidateKeys) Validate() error

type SzWhyMatchInfoFeatureScores 

type SzWhyMatchInfoFeatureScores map[string][]SzFeatureScore

The map of feature types to arrays of `SzFeatureScore` instances for that feature type.

func (*SzWhyMatchInfoFeatureScores) Decode 

func (s *SzWhyMatchInfoFeatureScores) Decode(d *jx.Decoder) error

Decode decodes SzWhyMatchInfoFeatureScores from json.

func (SzWhyMatchInfoFeatureScores) Encode 

func (s SzWhyMatchInfoFeatureScores) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzWhyMatchInfoFeatureScores) MarshalJSON 

func (s SzWhyMatchInfoFeatureScores) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyMatchInfoFeatureScores) UnmarshalJSON 

func (s *SzWhyMatchInfoFeatureScores) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (SzWhyMatchInfoFeatureScores) Validate 

func (s SzWhyMatchInfoFeatureScores) Validate() error

type SzWhyPerspective 

type SzWhyPerspective jx.Raw

func (*SzWhyPerspective) Decode 

func (s *SzWhyPerspective) Decode(d *jx.Decoder) error

Decode decodes SzWhyPerspective from json.

func (SzWhyPerspective) Encode 

func (s SzWhyPerspective) Encode(e *jx.Encoder)

Encode encodes SzWhyPerspective as json.

func (SzWhyPerspective) MarshalJSON 

func (s SzWhyPerspective) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyPerspective) UnmarshalJSON 

func (s *SzWhyPerspective) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzWhyRecordsResponse 

type SzWhyRecordsResponse struct {
	Meta  OptSzMeta  `json:"meta"`
	Links OptSzLinks `json:"links"`
	// The RAW result from the underlying native API function.
	RawData OptNilSzWhyRecordsResponseRawData `json:"rawData"`
	Data    OptSzWhyRecordsResponseData       `json:"data"`
}

Merged schema. Ref: #/components/schemas/SzWhyRecordsResponse

func (*SzWhyRecordsResponse) Decode 

func (s *SzWhyRecordsResponse) Decode(d *jx.Decoder) error

Decode decodes SzWhyRecordsResponse from json.

func (*SzWhyRecordsResponse) Encode 

func (s *SzWhyRecordsResponse) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyRecordsResponse) GetData 

func (s *SzWhyRecordsResponse) GetData() OptSzWhyRecordsResponseData

GetData returns the value of Data. 

func (s *SzWhyRecordsResponse) GetLinks() OptSzLinks

GetLinks returns the value of Links.

func (*SzWhyRecordsResponse) GetMeta 

func (s *SzWhyRecordsResponse) GetMeta() OptSzMeta

GetMeta returns the value of Meta.

func (*SzWhyRecordsResponse) GetRawData 

func (s *SzWhyRecordsResponse) GetRawData() OptNilSzWhyRecordsResponseRawData

GetRawData returns the value of RawData.

func (*SzWhyRecordsResponse) MarshalJSON 

func (s *SzWhyRecordsResponse) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyRecordsResponse) SetData 

func (s *SzWhyRecordsResponse) SetData(val OptSzWhyRecordsResponseData)

SetData sets the value of Data. 

func (s *SzWhyRecordsResponse) SetLinks(val OptSzLinks)

SetLinks sets the value of Links.

func (*SzWhyRecordsResponse) SetMeta 

func (s *SzWhyRecordsResponse) SetMeta(val OptSzMeta)

SetMeta sets the value of Meta.

func (*SzWhyRecordsResponse) SetRawData 

func (s *SzWhyRecordsResponse) SetRawData(val OptNilSzWhyRecordsResponseRawData)

SetRawData sets the value of RawData.

func (*SzWhyRecordsResponse) UnmarshalJSON 

func (s *SzWhyRecordsResponse) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyRecordsResponse) Validate 

func (s *SzWhyRecordsResponse) Validate() error

type SzWhyRecordsResponseData 

type SzWhyRecordsResponseData struct {
	// The `SzWhyRecordsResult` describing why from for the specified records.
	WhyResult OptSzWhyRecordsResult `json:"whyResult"`
	// The array of `SzEntityData` objects describing the entities involved in the response.  This will
	// include partial information on the first-degree related entities to the entity.
	Entities []SzEntityData `json:"entities"`
}

func (*SzWhyRecordsResponseData) Decode 

func (s *SzWhyRecordsResponseData) Decode(d *jx.Decoder) error

Decode decodes SzWhyRecordsResponseData from json.

func (*SzWhyRecordsResponseData) Encode 

func (s *SzWhyRecordsResponseData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyRecordsResponseData) GetEntities 

func (s *SzWhyRecordsResponseData) GetEntities() []SzEntityData

GetEntities returns the value of Entities.

func (*SzWhyRecordsResponseData) GetWhyResult 

func (s *SzWhyRecordsResponseData) GetWhyResult() OptSzWhyRecordsResult

GetWhyResult returns the value of WhyResult.

func (*SzWhyRecordsResponseData) MarshalJSON 

func (s *SzWhyRecordsResponseData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyRecordsResponseData) SetEntities 

func (s *SzWhyRecordsResponseData) SetEntities(val []SzEntityData)

SetEntities sets the value of Entities.

func (*SzWhyRecordsResponseData) SetWhyResult 

func (s *SzWhyRecordsResponseData) SetWhyResult(val OptSzWhyRecordsResult)

SetWhyResult sets the value of WhyResult.

func (*SzWhyRecordsResponseData) UnmarshalJSON 

func (s *SzWhyRecordsResponseData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyRecordsResponseData) Validate 

func (s *SzWhyRecordsResponseData) Validate() error

type SzWhyRecordsResponseRawData 

type SzWhyRecordsResponseRawData map[string]jx.Raw

The RAW result from the underlying native API function.

func (*SzWhyRecordsResponseRawData) Decode 

func (s *SzWhyRecordsResponseRawData) Decode(d *jx.Decoder) error

Decode decodes SzWhyRecordsResponseRawData from json.

func (SzWhyRecordsResponseRawData) Encode 

func (s SzWhyRecordsResponseRawData) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SzWhyRecordsResponseRawData) MarshalJSON 

func (s SzWhyRecordsResponseRawData) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyRecordsResponseRawData) UnmarshalJSON 

func (s *SzWhyRecordsResponseRawData) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SzWhyRecordsResult 

type SzWhyRecordsResult struct {
	// The `SzWhyPerspective` identifying and describing the perspective from the first record.
	Perspective1 SzWhyPerspective `json:"perspective1"`
	// The `SzWhyPerspective` identifying and describing the perspective from the second record.
	Perspective2 SzWhyPerspective `json:"perspective2"`
	// The `SzWhyMatchInfo` providing the details of the result.
	MatchInfo OptSzWhyMatchInfo `json:"matchInfo"`
}

Describes why two records might resolve. Ref: #/components/schemas/SzWhyRecordsResult

func (*SzWhyRecordsResult) Decode 

func (s *SzWhyRecordsResult) Decode(d *jx.Decoder) error

Decode decodes SzWhyRecordsResult from json.

func (*SzWhyRecordsResult) Encode 

func (s *SzWhyRecordsResult) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*SzWhyRecordsResult) GetMatchInfo 

func (s *SzWhyRecordsResult) GetMatchInfo() OptSzWhyMatchInfo

GetMatchInfo returns the value of MatchInfo.

func (*SzWhyRecordsResult) GetPerspective1 

func (s *SzWhyRecordsResult) GetPerspective1() SzWhyPerspective

GetPerspective1 returns the value of Perspective1.

func (*SzWhyRecordsResult) GetPerspective2 

func (s *SzWhyRecordsResult) GetPerspective2() SzWhyPerspective

GetPerspective2 returns the value of Perspective2.

func (*SzWhyRecordsResult) MarshalJSON 

func (s *SzWhyRecordsResult) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SzWhyRecordsResult) SetMatchInfo 

func (s *SzWhyRecordsResult) SetMatchInfo(val OptSzWhyMatchInfo)

SetMatchInfo sets the value of MatchInfo.

func (*SzWhyRecordsResult) SetPerspective1 

func (s *SzWhyRecordsResult) SetPerspective1(val SzWhyPerspective)

SetPerspective1 sets the value of Perspective1.

func (*SzWhyRecordsResult) SetPerspective2 

func (s *SzWhyRecordsResult) SetPerspective2(val SzWhyPerspective)

SetPerspective2 sets the value of Perspective2.

func (*SzWhyRecordsResult) UnmarshalJSON 

func (s *SzWhyRecordsResult) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*SzWhyRecordsResult) Validate 

func (s *SzWhyRecordsResult) Validate() error

type UnimplementedHandler 

type UnimplementedHandler struct{}

UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.

func (UnimplementedHandler) AddDataSources 

func (UnimplementedHandler) AddDataSources(ctx context.Context, req AddDataSourcesReq, params AddDataSourcesParams) (r AddDataSourcesRes, _ error)

AddDataSources implements addDataSources operation.

Obtains the current default configuration, adds the specified data sources and sets the modified configuration as the new default configuration -- returning the set of all configured data sources. **NOTE:** This operation may not be allowed. Some conditions that might cause this operation to be forbidden are: 1. The server does not have administrative functions enabled. 2. The server is running in "read-only" mode. 3. The server is started with a file-based configuration specified by `G2CONFIGFILE` property in the initialziation parameters. 4. The server is started with a specific configuration ID and therefore cannot modify the configuration and change to a new configuration.

POST /data-sources

func (UnimplementedHandler) AddRecord 

func (UnimplementedHandler) AddRecord(ctx context.Context, req AddRecordReq, params AddRecordParams) (r AddRecordRes, _ error)

AddRecord implements addRecord operation.

This operation loads a single record using the data source identified by the data source code in the request path. The record will be identified uniquely within the data source by the record ID provided in the request path. The provided record in the request body is described in JSON using the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). The provided JSON record may omit the `RECORD_ID`, but if it contains a `RECORD_ID` then it **must** match the record ID provided on the request path. The record ID is returned as part of the response. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the load. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value.

PUT /data-sources/{dataSourceCode}/records/{recordId}

func (UnimplementedHandler) AddRecordWithReturnedRecordId 

func (UnimplementedHandler) AddRecordWithReturnedRecordId(ctx context.Context, req AddRecordWithReturnedRecordIdReq, params AddRecordWithReturnedRecordIdParams) (r AddRecordWithReturnedRecordIdRes, _ error)

AddRecordWithReturnedRecordId implements addRecordWithReturnedRecordId operation.

This operation loads a single record using the data source identified by the data source code in the request path. The provided record in the request body is described in JSON using the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). The provided record may contain a `RECORD_ID` to identify it uniquely among other records in the same data source, but if it does not then a record ID will be automatically generated. The record ID is returned as part of the response. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the load. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value.

POST /data-sources/{dataSourceCode}/records

func (UnimplementedHandler) AnalyzeBulkRecords 

func (UnimplementedHandler) AnalyzeBulkRecords(ctx context.Context, req AnalyzeBulkRecordsReq, params AnalyzeBulkRecordsParams) (r AnalyzeBulkRecordsRes, _ error)

AnalyzeBulkRecords implements analyzeBulkRecords operation.

Provides a means to analyze a bulk data file of records prior to loading it. The records are encoded as a JSON array of JSON objects, a single JSON object per line in JSON-lines file format, or as a CSV with one record per row. The data should be in pre-mapped format using JSON property names or CSV column names as described by the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). **SCALABILITY NOTE:** This operation can be invoked in three ways. In order of increasingly better scalability these are listed below: 1. Standard HTTP Request/Response 2. HTTP Request with SSE Response (see below) 3. HTTP Upgrade Request for Web Sockets (see below) Standard HTTP Request/Response (method 1) has the worst scalability because a long-running operation will tie up a Web Server thread **and** continue until complete even if the client aborts the operation since no data is written back to the client until complete and therefore the terminated connection will not be detected. SSE (method 2) mitigates the problem of detecting when a client has aborted the operation because periodic progress responses are written to the client and therefore a terminated connection will be detected. However, the best way to invoke this operation is via Web Sockets (method 3) which not only can detect disconnection of the client, but it also upgrades the request to use its own thread outside the Web Server thread pool. **SSE NOTE:** This end-point supports "Server-sent Events" (SSE) via the `text/event-stream` media type. This support is activated by adding the `Accept: text/event-stream` header to a request to override the default `application/json` media type. Further, the end-point will behave similarly to its standard operation but will produce `progress` events at regular intervals that are equivalent to its `200` response schema. Upon success, the final event will be `completed` with the same response schema as a `200` response. Upon failure, the final event will be `failed` with same `SzErrorResponse` schema as the `4xx` or `5xx`. **WEB SOCKETS NOTE**: If invoking via Web Sockets then the client may send text or binary chunks of the JSON, JSON-Lines or CSV bulk data file as messages. In Web Sockets, text messages are *always* sent as UTF-8. If the file's character encoding is unknown then the client should send binary messages and the server will attempt to auto-detect the character encoding. Each message should adhere to the maximum message size specified by the `webSocketsMessageMaxSize` property returned by the `GET /server-info` end-point. The end of file is detected when the number of seconds specified by the `eofSendTimeout` query parameter have elapsed without a new message being received.

POST /bulk-data/analyze

func (UnimplementedHandler) DeleteRecord 

func (UnimplementedHandler) DeleteRecord(ctx context.Context, params DeleteRecordParams) (r DeleteRecordRes, _ error)

DeleteRecord implements deleteRecord operation.

This operation deletes a single record identified by the data source code and record ID in the request path. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the delete. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value.

DELETE /data-sources/{dataSourceCode}/records/{recordId}

func (UnimplementedHandler) FindEntityNetwork 

func (UnimplementedHandler) FindEntityNetwork(ctx context.Context, params FindEntityNetworkParams) (r FindEntityNetworkRes, _ error)

FindEntityNetwork implements findEntityNetwork operation.

This operation finds the entity network around one or more entities. This attempts to find paths between the specified entities. If no paths exist, then island networks are returned with each island network containing up to a specified number of related entities. The entities are identified by their entity IDs or by data source code and record ID pairs for constituent records of those entities. **NOTE:** If the first entity is identified by entity ID then the subsequent entities must also be identified entity ID. Similarly, if the first entity is identified by the data source code and record ID of a consistuent record then the subsequent entities must also be identified by the data source code and record ID of constituent records. **ALSO NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve.

GET /entity-networks

func (UnimplementedHandler) FindEntityPath 

func (UnimplementedHandler) FindEntityPath(ctx context.Context, params FindEntityPathParams) (r FindEntityPathRes, _ error)

FindEntityPath implements findEntityPath operation.

This operation finds the path between two entities and returns a description of that entity path (if any) or a response indicating that there is no path between the entities. The subject entities are either identfieid by entity ID or by data source code and record ID pairs for constituent records of those entities. **NOTE:** If the first entity is identified by entity ID then the second must also be identified an entity ID. Similarly, if the first entity is identified by data source code and record ID then the second must also be identified by data source code and record ID. **ALSO NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve.

GET /entity-paths

func (UnimplementedHandler) GetActiveConfig 

func (UnimplementedHandler) GetActiveConfig(ctx context.Context) (r GetActiveConfigRes, _ error)

GetActiveConfig implements getActiveConfig operation.

This operation returns the JSON configuration that is currently being used by the native Senzing API initialized by the running server. No processing or interpretation is performed on the JSON. This may differ from the registered "default configuration" which the server would use if no other configuration were provided.

GET /configs/active

func (UnimplementedHandler) GetAttributeType 

func (UnimplementedHandler) GetAttributeType(ctx context.Context, params GetAttributeTypeParams) (r GetAttributeTypeRes, _ error)

GetAttributeType implements getAttributeType operation.

This operation will provide a description of a single attribute type for the specified attribute type code.

GET /attribute-types/{attributeCode}

func (UnimplementedHandler) GetAttributeTypes 

func (UnimplementedHandler) GetAttributeTypes(ctx context.Context, params GetAttributeTypesParams) (r GetAttributeTypesRes, _ error)

GetAttributeTypes implements getAttributeTypes operation.

This operation will provide a list of attribute types that are configured. The client can filter the returned list of attribute types using various query parameters.

GET /attribute-types

func (UnimplementedHandler) GetDataSource 

func (UnimplementedHandler) GetDataSource(ctx context.Context, params GetDataSourceParams) (r GetDataSourceRes, _ error)

GetDataSource implements getDataSource operation.

This operation provides details on a specific data source identified by the data source code in the requested path.

GET /data-sources/{dataSourceCode}

func (UnimplementedHandler) GetDataSources 

func (UnimplementedHandler) GetDataSources(ctx context.Context, params GetDataSourcesParams) (r GetDataSourcesRes, _ error)

GetDataSources implements getDataSources operation.

This operation will provide a list of data source codes as well as a list of detailed descriptions of each data source.

GET /data-sources

func (UnimplementedHandler) GetEntityByEntityId 

func (UnimplementedHandler) GetEntityByEntityId(ctx context.Context, params GetEntityByEntityIdParams) (r GetEntityByEntityIdRes, _ error)

GetEntityByEntityId implements getEntityByEntityId operation.

Gets the details on a resolved entity that is identified by the entity ID specified in the request path. **NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve. An alternative way to identify an entity is by one of its constituent records using `GET /data-sources/{dataSourceCode}/records/{recordId}/entity`.

GET /entities/{entityId}

func (UnimplementedHandler) GetEntityByRecordId 

func (UnimplementedHandler) GetEntityByRecordId(ctx context.Context, params GetEntityByRecordIdParams) (r GetEntityByRecordIdRes, _ error)

GetEntityByRecordId implements getEntityByRecordId operation.

Gets the details on a resolved entity that contains the record identified by the data source code and record ID in the specified request path.

GET /data-sources/{dataSourceCode}/records/{recordId}/entity

func (UnimplementedHandler) GetRecord 

func (UnimplementedHandler) GetRecord(ctx context.Context, params GetRecordParams) (r GetRecordRes, _ error)

GetRecord implements getRecord operation.

Gets details on a specific entity record identified by the data source code and record ID specified in the request path.

GET /data-sources/{dataSourceCode}/records/{recordId}

func (UnimplementedHandler) GetServerInfo 

func (UnimplementedHandler) GetServerInfo(ctx context.Context) (r GetServerInfoRes, _ error)

GetServerInfo implements getServerInfo operation.

This operation will provides server information describing the options with which the server was started. This can be used to determine if the admin operations are enabled or if only read operations may be invoked. This also allows the client to know the maximum message size for Web Sockets communication.

GET /server-info

func (UnimplementedHandler) GetTemplateConfig 

func (UnimplementedHandler) GetTemplateConfig(ctx context.Context) (r GetTemplateConfigRes, _ error)

GetTemplateConfig implements getTemplateConfig operation.

This operation returns a template base JSON configuration that can be modified or customized by the caller. The returned template is according to the underlying native Senzing API and may change between version upgrades to Senzing. No processing or interpretation is performed on the JSON. This will likely differ from the registered "default configuration" or currently "active configuration" being used by the running API server.

GET /configs/template

func (UnimplementedHandler) GetVirtualEntityByRecordIds 

func (UnimplementedHandler) GetVirtualEntityByRecordIds(ctx context.Context, params GetVirtualEntityByRecordIdsParams) (r GetVirtualEntityByRecordIdsRes, _ error)

GetVirtualEntityByRecordIds implements getVirtualEntityByRecordIds operation.

This operation simulates the resolution of the one or more specified records into a single entity and returns the simulated "virtual" entity. The subject records are identified by data source code and record ID pairs.

GET /virtual-entities

func (UnimplementedHandler) Heartbeat 

func (UnimplementedHandler) Heartbeat(ctx context.Context) (r *SzBaseResponse, _ error)

Heartbeat implements heartbeat operation.

The heartbeat operation can be used to ensure that the HTTP server is indeed running, but this operation does not call upon the underlying native Senzing API and therefore does not ensure the Senzing initialization or configuration is valid.

GET /heartbeat

func (UnimplementedHandler) HowEntityByEntityID 

func (UnimplementedHandler) HowEntityByEntityID(ctx context.Context, params HowEntityByEntityIDParams) (r HowEntityByEntityIDRes, _ error)

HowEntityByEntityID implements howEntityByEntityID operation.

This operation provides an anlysis of how the records in an entity resolved. The subject entity is identified by the entity ID in the request path. **NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve. An alternative way to identify an entity is by one of its constituent records using `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/how`.

GET /entities/{entityId}/how

func (UnimplementedHandler) HowEntityByRecordID 

func (UnimplementedHandler) HowEntityByRecordID(ctx context.Context, params HowEntityByRecordIDParams) (r HowEntityByRecordIDRes, _ error)

HowEntityByRecordID implements howEntityByRecordID operation.

This operation provides an anlysis of how the records in an entity resolved. The subject entity is the one containing the record identified by the data source code and record ID in the request path.

GET /data-sources/{dataSourceCode}/records/{recordId}/entity/how

func (UnimplementedHandler) License 

func (UnimplementedHandler) License(ctx context.Context, params LicenseParams) (r LicenseRes, _ error)

License implements license operation.

This operation will obtain license information for the underlying native Senzing API.

GET /license

func (UnimplementedHandler) LoadBulkRecords 

func (UnimplementedHandler) LoadBulkRecords(ctx context.Context, req LoadBulkRecordsReq, params LoadBulkRecordsParams) (r LoadBulkRecordsRes, _ error)

LoadBulkRecords implements loadBulkRecords operation.

Provides a means to load a bulk data file of records. The records are encoded as a JSON array of JSON objects, a single JSON object per line in JSON-lines file format, or as a CSV with one record per row. The data should be in pre-mapped format using JSON property names or CSV column names as described by the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). **SCALABILITY NOTE:** This operation can be invoked in three ways. In order of increasingly better scalability these are listed below: 1. Standard HTTP Request/Response 2. HTTP Request with SSE Response (see below) 3. HTTP Upgrade Request for Web Sockets (see below) Standard HTTP Request/Response (method 1) has the worst scalability because a long-running operation will tie up a Web Server thread **and** continue until complete even if the client aborts the operation since no data is written back to the client until complete and therefore the terminated connection will not be detected. SSE (method 2) mitigates the problem of detecting when a client has aborted the operation because periodic progress responses are written to the client and therefore a terminated connection will be detected. However, the best way to invoke this operation is via Web Sockets (method 3) which not only can detect disconnection of the client, but it also upgrades the request to use its own thread outside the Web Server thread pool. **SSE NOTE:** This end-point supports "Server-sent Events" (SSE) via the `text/event-stream` media type. This support is activated by adding the `Accept: text/event-stream` header to a request to override the default `application/json` media type. Further, the end-point will behave similarly to its standard operation but will produce `progress` events at regular intervals that are equivalent to its `200` response schema. Upon success, the final event will be `completed` with the same response schema as a `200` response. Upon failure, the final event will be `failed` with same `SzErrorResponse` schema as the `4xx` or `5xx`. **WEB SOCKETS NOTE**: If invoking via Web Sockets then the client may send text or binary chunks of the JSON, JSON-Lines or CSV bulk data file as messages. In Web Sockets, text messages are *always* sent as UTF-8. If the file's character encoding is unknown then the client should send binary messages and the server will attempt to auto-detect the character encoding. Each message should adhere to the maximum message size specified by the `webSocketsMessageMaxSize` property returned by the `GET /server-info` end-point. The end of file is detected when the number of seconds specified by the `eofSendTimeout` query parameter have elapsed without a new message being received.

POST /bulk-data/load

func (UnimplementedHandler) OpenAPISpecification added in v0.9.4 

func (UnimplementedHandler) OpenAPISpecification(ctx context.Context) (r OpenAPISpecificationOKDefault, _ error)

OpenAPISpecification implements openAPISpecification operation.

This operation can be used to obtain the Open API specification in JSON format. The specification can either be the `data` field of a standard response (i.e.: a response with a `meta`, `links` and `data` field) or as raw format where the root JSON document is the Open API specification JSON.

GET /specifications/open-api

func (UnimplementedHandler) ReevaluateEntity 

func (UnimplementedHandler) ReevaluateEntity(ctx context.Context, params ReevaluateEntityParams) (r ReevaluateEntityRes, _ error)

ReevaluateEntity implements reevaluateEntity operation.

Reevaluates an entity identified by the entity ID specified via the `entityId` query parameter. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the reevaluation. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value. **ALSO NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve.

POST /reevaluate-entity

func (UnimplementedHandler) ReevaluateRecord 

func (UnimplementedHandler) ReevaluateRecord(ctx context.Context, params ReevaluateRecordParams) (r ReevaluateRecordRes, _ error)

ReevaluateRecord implements reevaluateRecord operation.

This operation reevaluates a single record identified by the data source code and record ID in the request path. **NOTE:** The `withInfo` parameter will return the entity resolution info pertaining to the reevaluation. This can be used to update a search index or external data mart. Additionally, Senzing API Server provides a means to have the "raw" entity resolution info (from the underlying native Senzing API) automatically sent to a messaging service such as those provided by Amazon SQS, Rabbit MQ or Kafka regardless of the `withInfo` query parameter value.

POST /data-sources/{dataSourceCode}/records/{recordId}/reevaluate

func (UnimplementedHandler) Root 

func (UnimplementedHandler) Root(ctx context.Context) (r *SzBaseResponse, _ error)

Root implements root operation.

The root operation can be used to ensure that the HTTP server is indeed running, but this operation does not call upon the underlying native Senzing API and therefore does not ensure the Senzing initialization or configuration is valid.

GET /

func (UnimplementedHandler) SearchEntitiesByGet 

func (UnimplementedHandler) SearchEntitiesByGet(ctx context.Context, params SearchEntitiesByGetParams) (r SearchEntitiesByGetRes, _ error)

SearchEntitiesByGet implements searchEntitiesByGet operation.

This operation finds all entities that would resolve or relate to the search candidate features specified by the `attr` and/or `attrs` query parameters. The search candidate features are treated as if they belonged to an inbound record being loaded, thus the attribute names are given by the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). If including the search candidate features as query parameters presents privacy concerns due to sensitivity of the data, they can alternately be sent in the request body using the `POST /search-entities` endpoint. **NOTE:** This operation differs from a keyword search in that it uses deterministic entity resolution rules to determine the result set. This means that features that are considered "generic" (i.e.: overly common) will be ignored just as they are during entity resolution and will not yield search results. For example, searching on a gender by itself will return no results rather than half of all entities. Similarly, a phone number such as `555-1212` may yield no results.

GET /entities

func (UnimplementedHandler) SearchEntitiesByPost 

func (UnimplementedHandler) SearchEntitiesByPost(ctx context.Context, req SearchEntitiesByPostReq, params SearchEntitiesByPostParams) (r SearchEntitiesByPostRes, _ error)

SearchEntitiesByPost implements searchEntitiesByPost operation.

This operation finds all entities that would resolve or relate to the search candidate features specified in JSON request body. The search candidate features are treated as if they belonged to an inbound record being loaded. The JSON format of the request body is defined by the [Senzing Generic Entity Specification](https://senzing.zendesk. com/hc/en-us/articles/231925448-Generic-Entity-Specification). This operation is similar to the `GET /entities` endpoint in function except that it provides a means to avoid specifying potentially sensitive data in query parameters, but instead in the request body. **NOTE:** This operation differs from a keyword search in that it uses deterministic entity resolution rules to determine the result set. This means that features that are considered "generic" (i.e.: overly common) will be ignored just as they are during entity resolution and will not yield search results. For example, searching on a gender by itself will return no results rather than half of all entities. Similarly, a phone number such as `555-1212` may yield no results.

POST /search-entities

func (UnimplementedHandler) Version 

func (UnimplementedHandler) Version(ctx context.Context, params VersionParams) (r VersionRes, _ error)

Version implements version operation.

This operation will obtain the full version information for the server. Much of the same information is available in the `meta` segment of every JSON response.

GET /version

func (UnimplementedHandler) WhyEntities 

func (UnimplementedHandler) WhyEntities(ctx context.Context, params WhyEntitiesParams) (r WhyEntitiesRes, _ error)

WhyEntities implements whyEntities operation.

This operation provides an anlysis of why two entities related, did not relate or did not resolve. The entities are identified either by entity ID's or by data source code and record ID pairs for constituent records of those entities. **NOTE:** If the first entity is identified by entity ID then the second must also be identified an entity ID. Similarly, if the first entity is identified by data source code and record ID then the second must also be identified by data source code and record ID. **ALSO NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve.

GET /why/entities

func (UnimplementedHandler) WhyEntityByEntityID 

func (UnimplementedHandler) WhyEntityByEntityID(ctx context.Context, params WhyEntityByEntityIDParams) (r WhyEntityByEntityIDRes, _ error)

WhyEntityByEntityID implements whyEntityByEntityID operation.

This operation provides an anlysis of why the records in an entity resolved. The subject entity is identified by the entity ID in the request path. **NOTE:** Bear in mind that entity ID's are transient and may be recycled or repurposed as new records are loaded and entities resolve, unresolve and re-resolve. An alternative way to identify an entity is by one of its constituent records using `GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why`.

GET /entities/{entityId}/why

func (UnimplementedHandler) WhyEntityByRecordID 

func (UnimplementedHandler) WhyEntityByRecordID(ctx context.Context, params WhyEntityByRecordIDParams) (r WhyEntityByRecordIDRes, _ error)

WhyEntityByRecordID implements whyEntityByRecordID operation.

This operation provides an anlysis of why the records in an entity resolved. The subject entity is the one containing the record identified by the data source code and record ID in the request path.

GET /data-sources/{dataSourceCode}/records/{recordId}/entity/why

func (UnimplementedHandler) WhyRecords 

func (UnimplementedHandler) WhyRecords(ctx context.Context, params WhyRecordsParams) (r WhyRecordsRes, _ error)

WhyRecords implements whyRecords operation.

This operation provides an anlysis of two records identified by data source code and record ID in respective qeury parameters resolved or did not resolve.

GET /why/records

type VersionOKDefault 

type VersionOKDefault struct {
	Data io.Reader
}

The response containing the version information. Ref: #/components/schemas/SzVersionResponse

func (VersionOKDefault) Read 

func (s VersionOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type VersionParams 

type VersionParams struct {
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

VersionParams is parameters of version operation.

type VersionRes 

type VersionRes interface {
	// contains filtered or unexported methods
}

type WhyEntitiesApplicationJSONInternalServerError 

type WhyEntitiesApplicationJSONInternalServerError SzErrorResponse

func (*WhyEntitiesApplicationJSONInternalServerError) Decode 

func (s *WhyEntitiesApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes WhyEntitiesApplicationJSONInternalServerError from json.

func (*WhyEntitiesApplicationJSONInternalServerError) Encode 

func (s *WhyEntitiesApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes WhyEntitiesApplicationJSONInternalServerError as json.

func (*WhyEntitiesApplicationJSONInternalServerError) MarshalJSON 

func (s *WhyEntitiesApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WhyEntitiesApplicationJSONInternalServerError) UnmarshalJSON 

func (s *WhyEntitiesApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*WhyEntitiesApplicationJSONInternalServerError) Validate 

func (s *WhyEntitiesApplicationJSONInternalServerError) Validate() error

type WhyEntitiesApplicationJSONNotFound 

type WhyEntitiesApplicationJSONNotFound SzErrorResponse

func (*WhyEntitiesApplicationJSONNotFound) Decode 

func (s *WhyEntitiesApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes WhyEntitiesApplicationJSONNotFound from json.

func (*WhyEntitiesApplicationJSONNotFound) Encode 

func (s *WhyEntitiesApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes WhyEntitiesApplicationJSONNotFound as json.

func (*WhyEntitiesApplicationJSONNotFound) MarshalJSON 

func (s *WhyEntitiesApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WhyEntitiesApplicationJSONNotFound) UnmarshalJSON 

func (s *WhyEntitiesApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*WhyEntitiesApplicationJSONNotFound) Validate 

func (s *WhyEntitiesApplicationJSONNotFound) Validate() error

type WhyEntitiesNotFoundDefault 

type WhyEntitiesNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (WhyEntitiesNotFoundDefault) Read 

func (s WhyEntitiesNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type WhyEntitiesOKDefault 

type WhyEntitiesOKDefault struct {
	Data io.Reader
}

The response describing the result of "why entities" operation. Ref: #/components/schemas/SzWhyEntitiesResponse

func (WhyEntitiesOKDefault) Read 

func (s WhyEntitiesOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type WhyEntitiesParams 

type WhyEntitiesParams struct {
	// The `SzEntityIdentifier` for the first entity as an entity ID or an encoded `SzRecordId` for the
	// constituent record.  Whatever format is used for the "entity1" parameter must match the format of
	// the "entity2" parameter.  NOTE: An encoded `SzRecordId` can EITHER be encoded as JSON or as a
	// delimited string where the first character is the delimiter and the remainder is parsed as a data
	// source prefix (up to the second occurrence of the delimiter) and a record ID suffix (all
	// characters after the second occurrence of the delimiter).  For example: `{"src":"PEOPLE",
	// "id":"12345ABC"}` or `:PEOPLE:12345ABC`.
	Entity1 string
	// The `SzEntityIdentifier` for the second entity as an entity ID or an encoded `SzRecordId` for the
	// constituent record.  Whatever format is used for the "entity2" parameter must match the format of
	// the "entity1" parameter.  NOTE: An encoded `SzRecordId` can EITHER be encoded as JSON or as a
	// delimited string where the first character is the delimiter and the remainder is parsed as a data
	// source prefix (up to the second occurrence of the delimiter) and a record ID suffix (all
	// characters after the second occurrence of the delimiter).  For example: `{"src":"PEOPLE",
	// "id":"12345ABC"}` or `:PEOPLE:12345ABC`.
	Entity2 string
	// Set to `true` to include partial information of related entities for the returned entities.  This
	// defaults to `false`.
	WithRelationships OptBool
	// Set to `false` to suppress resolution statistics for features.  This defaults to `true` for why
	// operations.
	WithFeatureStats OptBool
	// Set to `false` to suppress "expressed" features that are derived composite keys such as
	// `FULL_NAME` + `DATE_OF_BIRTH`.  This defaults to `true` for why operations.
	WithInternalFeatures OptBool
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

WhyEntitiesParams is parameters of whyEntities operation.

type WhyEntitiesRes 

type WhyEntitiesRes interface {
	// contains filtered or unexported methods
}

type WhyEntityByEntityIDApplicationJSONInternalServerError 

type WhyEntityByEntityIDApplicationJSONInternalServerError SzErrorResponse

func (*WhyEntityByEntityIDApplicationJSONInternalServerError) Decode 

func (s *WhyEntityByEntityIDApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes WhyEntityByEntityIDApplicationJSONInternalServerError from json.

func (*WhyEntityByEntityIDApplicationJSONInternalServerError) Encode 

func (s *WhyEntityByEntityIDApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes WhyEntityByEntityIDApplicationJSONInternalServerError as json.

func (*WhyEntityByEntityIDApplicationJSONInternalServerError) MarshalJSON 

func (s *WhyEntityByEntityIDApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WhyEntityByEntityIDApplicationJSONInternalServerError) UnmarshalJSON 

func (s *WhyEntityByEntityIDApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*WhyEntityByEntityIDApplicationJSONInternalServerError) Validate 

func (s *WhyEntityByEntityIDApplicationJSONInternalServerError) Validate() error

type WhyEntityByEntityIDApplicationJSONNotFound 

type WhyEntityByEntityIDApplicationJSONNotFound SzErrorResponse

func (*WhyEntityByEntityIDApplicationJSONNotFound) Decode 

func (s *WhyEntityByEntityIDApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes WhyEntityByEntityIDApplicationJSONNotFound from json.

func (*WhyEntityByEntityIDApplicationJSONNotFound) Encode 

func (s *WhyEntityByEntityIDApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes WhyEntityByEntityIDApplicationJSONNotFound as json.

func (*WhyEntityByEntityIDApplicationJSONNotFound) MarshalJSON 

func (s *WhyEntityByEntityIDApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WhyEntityByEntityIDApplicationJSONNotFound) UnmarshalJSON 

func (s *WhyEntityByEntityIDApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*WhyEntityByEntityIDApplicationJSONNotFound) Validate 

func (s *WhyEntityByEntityIDApplicationJSONNotFound) Validate() error

type WhyEntityByEntityIDNotFoundDefault 

type WhyEntityByEntityIDNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (WhyEntityByEntityIDNotFoundDefault) Read 

func (s WhyEntityByEntityIDNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type WhyEntityByEntityIDOKDefault 

type WhyEntityByEntityIDOKDefault struct {
	Data io.Reader
}

The response describing the result of "why" operation. Ref: #/components/schemas/SzWhyEntityResponse

func (WhyEntityByEntityIDOKDefault) Read 

func (s WhyEntityByEntityIDOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type WhyEntityByEntityIDParams 

type WhyEntityByEntityIDParams struct {
	// The unique numeric ID that identifies that entity being requested.
	EntityId int64
	// Set to `true` to include partial information of related entities for the returned entities.  This
	// defaults to `false`.
	WithRelationships OptBool
	// Set to `false` to suppress resolution statistics for features.  This defaults to `true` for why
	// operations.
	WithFeatureStats OptBool
	// Set to `false` to suppress "expressed" features that are derived composite keys such as
	// `FULL_NAME` + `DATE_OF_BIRTH`.  This defaults to `true` for why operations.
	WithInternalFeatures OptBool
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

WhyEntityByEntityIDParams is parameters of whyEntityByEntityID operation.

type WhyEntityByEntityIDRes 

type WhyEntityByEntityIDRes interface {
	// contains filtered or unexported methods
}

type WhyEntityByRecordIDApplicationJSONInternalServerError 

type WhyEntityByRecordIDApplicationJSONInternalServerError SzErrorResponse

func (*WhyEntityByRecordIDApplicationJSONInternalServerError) Decode 

func (s *WhyEntityByRecordIDApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes WhyEntityByRecordIDApplicationJSONInternalServerError from json.

func (*WhyEntityByRecordIDApplicationJSONInternalServerError) Encode 

func (s *WhyEntityByRecordIDApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes WhyEntityByRecordIDApplicationJSONInternalServerError as json.

func (*WhyEntityByRecordIDApplicationJSONInternalServerError) MarshalJSON 

func (s *WhyEntityByRecordIDApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WhyEntityByRecordIDApplicationJSONInternalServerError) UnmarshalJSON 

func (s *WhyEntityByRecordIDApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*WhyEntityByRecordIDApplicationJSONInternalServerError) Validate 

func (s *WhyEntityByRecordIDApplicationJSONInternalServerError) Validate() error

type WhyEntityByRecordIDApplicationJSONNotFound 

type WhyEntityByRecordIDApplicationJSONNotFound SzErrorResponse

func (*WhyEntityByRecordIDApplicationJSONNotFound) Decode 

func (s *WhyEntityByRecordIDApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes WhyEntityByRecordIDApplicationJSONNotFound from json.

func (*WhyEntityByRecordIDApplicationJSONNotFound) Encode 

func (s *WhyEntityByRecordIDApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes WhyEntityByRecordIDApplicationJSONNotFound as json.

func (*WhyEntityByRecordIDApplicationJSONNotFound) MarshalJSON 

func (s *WhyEntityByRecordIDApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WhyEntityByRecordIDApplicationJSONNotFound) UnmarshalJSON 

func (s *WhyEntityByRecordIDApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*WhyEntityByRecordIDApplicationJSONNotFound) Validate 

func (s *WhyEntityByRecordIDApplicationJSONNotFound) Validate() error

type WhyEntityByRecordIDNotFoundDefault 

type WhyEntityByRecordIDNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (WhyEntityByRecordIDNotFoundDefault) Read 

func (s WhyEntityByRecordIDNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type WhyEntityByRecordIDOKDefault 

type WhyEntityByRecordIDOKDefault struct {
	Data io.Reader
}

The response describing the result of "why" operation. Ref: #/components/schemas/SzWhyEntityResponse

func (WhyEntityByRecordIDOKDefault) Read 

func (s WhyEntityByRecordIDOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type WhyEntityByRecordIDParams 

type WhyEntityByRecordIDParams struct {
	// The data source code identifying the data source.
	DataSourceCode string
	// The identifier that uniquely identifies the requested record within a given data source.  This may
	// have been specified when the record was loaded or generated automatically.
	RecordId string
	// Set to `true` to include partial information of related entities for the returned entities.  This
	// defaults to `false`.
	WithRelationships OptBool
	// Set to `false` to suppress resolution statistics for features.  This defaults to `true` for why
	// operations.
	WithFeatureStats OptBool
	// Set to `false` to suppress "expressed" features that are derived composite keys such as
	// `FULL_NAME` + `DATE_OF_BIRTH`.  This defaults to `true` for why operations.
	WithInternalFeatures OptBool
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

WhyEntityByRecordIDParams is parameters of whyEntityByRecordID operation.

type WhyEntityByRecordIDRes 

type WhyEntityByRecordIDRes interface {
	// contains filtered or unexported methods
}

type WhyRecordsApplicationJSONInternalServerError 

type WhyRecordsApplicationJSONInternalServerError SzErrorResponse

func (*WhyRecordsApplicationJSONInternalServerError) Decode 

func (s *WhyRecordsApplicationJSONInternalServerError) Decode(d *jx.Decoder) error

Decode decodes WhyRecordsApplicationJSONInternalServerError from json.

func (*WhyRecordsApplicationJSONInternalServerError) Encode 

func (s *WhyRecordsApplicationJSONInternalServerError) Encode(e *jx.Encoder)

Encode encodes WhyRecordsApplicationJSONInternalServerError as json.

func (*WhyRecordsApplicationJSONInternalServerError) MarshalJSON 

func (s *WhyRecordsApplicationJSONInternalServerError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WhyRecordsApplicationJSONInternalServerError) UnmarshalJSON 

func (s *WhyRecordsApplicationJSONInternalServerError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*WhyRecordsApplicationJSONInternalServerError) Validate 

func (s *WhyRecordsApplicationJSONInternalServerError) Validate() error

type WhyRecordsApplicationJSONNotFound 

type WhyRecordsApplicationJSONNotFound SzErrorResponse

func (*WhyRecordsApplicationJSONNotFound) Decode 

func (s *WhyRecordsApplicationJSONNotFound) Decode(d *jx.Decoder) error

Decode decodes WhyRecordsApplicationJSONNotFound from json.

func (*WhyRecordsApplicationJSONNotFound) Encode 

func (s *WhyRecordsApplicationJSONNotFound) Encode(e *jx.Encoder)

Encode encodes WhyRecordsApplicationJSONNotFound as json.

func (*WhyRecordsApplicationJSONNotFound) MarshalJSON 

func (s *WhyRecordsApplicationJSONNotFound) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*WhyRecordsApplicationJSONNotFound) UnmarshalJSON 

func (s *WhyRecordsApplicationJSONNotFound) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*WhyRecordsApplicationJSONNotFound) Validate 

func (s *WhyRecordsApplicationJSONNotFound) Validate() error

type WhyRecordsNotFoundDefault 

type WhyRecordsNotFoundDefault struct {
	Data io.Reader
}

The response describing an error that occurred. Ref: #/components/schemas/SzErrorResponse

func (WhyRecordsNotFoundDefault) Read 

func (s WhyRecordsNotFoundDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type WhyRecordsOKDefault 

type WhyRecordsOKDefault struct {
	Data io.Reader
}

The response describing the result of "why" operation. Ref: #/components/schemas/SzWhyRecordsResponse

func (WhyRecordsOKDefault) Read 

func (s WhyRecordsOKDefault) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type WhyRecordsParams 

type WhyRecordsParams struct {
	// The data source for the first record.
	DataSource1 string
	// The record ID for the first record.
	RecordId1 string
	// The data source for the second record.
	DataSource2 string
	// The data source for the second record.
	RecordId2 string
	// Set to `true` to include partial information of related entities for the returned entities.  This
	// defaults to `false`.
	WithRelationships OptBool
	// Set to `false` to suppress resolution statistics for features.  This defaults to `true` for why
	// operations.
	WithFeatureStats OptBool
	// Set to `false` to suppress "expressed" features that are derived composite keys such as
	// `FULL_NAME` + `DATE_OF_BIRTH`.  This defaults to `true` for why operations.
	WithInternalFeatures OptBool
	// Specifies the level of detail desired for the entity data.  Details for features of entities as
	// well as the related entities of entities are controlled by `featureMode`, `withInternalFeatures`,
	// and `withFeatureStats`.  If not specified the value defaults to `VERBOSE`. Possible values are:
	// * `BARE_MINIMAL` - The entities returned will include only their
	// entity ID's.  No record information is returned
	// and if related entities are included, they too will
	// only be described by their entity ID's and will
	// **not** include any matching info.
	// * `NETWORK_MINIMAL` - Identical to `BARE_MINIMAL` except in the case
	// of related entities being included they will
	// also include related matching info.
	// * `MINIMAL` - The entities returned will include at most their
	// entity ID's as well as identifiers for their
	// constituent records (i.e.: data source code and record
	// ID for each record).  This detail level is optimized for
	// the fastest possible processing time.
	// * `BRIEF` - Builds upon `MINIMAL` to add the entity name and related
	// entity match info when related entity match info when
	// related entities are included.  This detail level aims to
	// maintain as much speed as possible while providing names
	// and relationship information for rendering a graph.
	// * `SUMMARY` - Identical to `BRIEF` except that individual record
	// identifier information is excluded, leaving only the
	// record summary (i.e.: a record count by data source
	// code).  This reduces the size of the JSON document for
	// large entities with thousands of records.  It may take
	// longer to process than `BRIEF` but less data is
	// returned as well, speeding up network transfer times.
	// * `VERBOSE` - Combines `BRIEF` and `SUMMARY` and then adds the
	// original JSON data for each record, the record-level
	// matching info, as well as formatted record data.  NOTE:
	// the record-level matching info returned via "how" and
	// "why" is often more useful than that embedded in the
	// entity.  Further, the formatted record data, while
	// readable, is not formatted according to locale (i.e.:
	// address, name and date formatting may not appear as
	// expected to a user).
	DetailLevel OptSzDetailLevel
	// The method by which feature values should be included for entities returned in the response.  The
	// possible values are:
	// * `NONE` - Do not include any feature values -- this is the fastest
	// option from a performance perspective because feature
	// values do not have to be retrieved.
	// * `REPRESENTATIVE` - Include only a single representative value per
	// "unique" value of a feature.  If there are
	// multiple values that are near duplicates then
	// only one value is included and the others are
	// suppressed.
	// * `WITH_DUPLICATES` - ** (default value) ** Group near-duplicate
	// feature values and return a representative value
	// along with its near duplicate values.
	// * `ATTRIBUTED` - Same as `WITH_DUPLICATES` but with record-level
	// references attributing each feature to the record(s)
	// that provided it for the entity along with any
	// usage type that might have been associated with the
	// feature at the record level.
	FeatureMode OptSzFeatureMode
	// Whether (or not) to force the minimum entity detail in the response which will consist of nothing
	// more than an entity ID and record identifying information (i.e.: data source code and record ID)
	// for each constituent record of an entity.  Unlike `detailLevel=MINIMAL` setting this to `true`
	// precludes the addition of feature information via other parameters.  Setting this to `true`
	// provides the fastest response to an entity query operation because no additional data needs to be
	// retrieved other than what is directly accessible.  Setting this parameter to `true` overrules
	// other parameters governing the retrieval of features or related entities.
	ForceMinimal OptBool
	// Whether or not to include the raw JSON response from the underlying native API.  This raw response
	// may include additional details but lack some of the abstraction the standard response provides.
	// If true, then the 'rawData' field in the response will be a non-null value and contain the
	// additional details.
	WithRaw OptBool
}

WhyRecordsParams is parameters of whyRecords operation.

type WhyRecordsRes 

type WhyRecordsRes interface {
	// contains filtered or unexported methods
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.