catalog

package
v1.12.0-beta.7 Latest Latest
Warning

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

Go to latest
Published: Feb 10, 2022 License: Apache-2.0 Imports: 5 Imported by: 2

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Action

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

Action : A complete action as rendered in POST, PATCH, and GET responses.

func MakeActionFromAliasAction

func MakeActionFromAliasAction(f AliasAction) Action

MakeActionFromAliasAction creates a new Action from an instance of AliasAction

func MakeActionFromAutoKvAction

func MakeActionFromAutoKvAction(f AutoKvAction) Action

MakeActionFromAutoKvAction creates a new Action from an instance of AutoKvAction

func MakeActionFromEvalAction

func MakeActionFromEvalAction(f EvalAction) Action

MakeActionFromEvalAction creates a new Action from an instance of EvalAction

func MakeActionFromLookupAction

func MakeActionFromLookupAction(f LookupAction) Action

MakeActionFromLookupAction creates a new Action from an instance of LookupAction

func MakeActionFromRawInterface

func MakeActionFromRawInterface(f interface{}) Action

MakeActionFromRawInterface creates a new Action from a raw interface{}

func MakeActionFromRegexAction

func MakeActionFromRegexAction(f RegexAction) Action

MakeActionFromRegexAction creates a new Action from an instance of RegexAction

func (Action) AliasAction

func (m Action) AliasAction() *AliasAction

AliasAction returns AliasAction if IsAliasAction() is true, nil otherwise

func (Action) AutoKvAction

func (m Action) AutoKvAction() *AutoKvAction

AutoKvAction returns AutoKvAction if IsAutoKvAction() is true, nil otherwise

func (Action) EvalAction

func (m Action) EvalAction() *EvalAction

EvalAction returns EvalAction if IsEvalAction() is true, nil otherwise

func (Action) IsAliasAction

func (m Action) IsAliasAction() bool

IsAliasAction checks if the Action is a AliasAction

func (Action) IsAutoKvAction

func (m Action) IsAutoKvAction() bool

IsAutoKvAction checks if the Action is a AutoKvAction

func (Action) IsEvalAction

func (m Action) IsEvalAction() bool

IsEvalAction checks if the Action is a EvalAction

func (Action) IsLookupAction

func (m Action) IsLookupAction() bool

IsLookupAction checks if the Action is a LookupAction

func (Action) IsRawInterface

func (m Action) IsRawInterface() bool

IsRawInterface checks if the Action is an interface{} (unknown type)

func (Action) IsRegexAction

func (m Action) IsRegexAction() bool

IsRegexAction checks if the Action is a RegexAction

func (Action) LookupAction

func (m Action) LookupAction() *LookupAction

LookupAction returns LookupAction if IsLookupAction() is true, nil otherwise

func (Action) MarshalJSON

func (m Action) MarshalJSON() ([]byte, error)

MarshalJSON marshals Action using the appropriate struct field

func (Action) RawInterface

func (m Action) RawInterface() interface{}

RawInterface returns interface{} if IsRawInterface() is true (unknown type), nil otherwise

func (Action) RegexAction

func (m Action) RegexAction() *RegexAction

RegexAction returns RegexAction if IsRegexAction() is true, nil otherwise

func (*Action) UnmarshalJSON

func (m *Action) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals Action using the "kind" property

type ActionCommon

type ActionCommon struct {
	// A unique action ID.
	Id *string `json:"id,omitempty"`
	// The rule that this action is part of.
	Ruleid *string `json:"ruleid,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Properties common across all action kinds as rendered in POST, PATCH, and GET responses and alos for creating a new action using a POST request.

type ActionPatch

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

ActionPatch : Property values to be set in an existing action using a PATCH request. ActionPatch is AliasActionPatch, AutoKvActionPatch, EvalActionPatch, LookupActionPatch, RegexActionPatch, (or interface{} if no matches are found)

func MakeActionPatchFromAliasActionPatch

func MakeActionPatchFromAliasActionPatch(f AliasActionPatch) ActionPatch

MakeActionPatchFromAliasActionPatch creates a new ActionPatch from an instance of AliasActionPatch

func MakeActionPatchFromAutoKvActionPatch

func MakeActionPatchFromAutoKvActionPatch(f AutoKvActionPatch) ActionPatch

MakeActionPatchFromAutoKvActionPatch creates a new ActionPatch from an instance of AutoKvActionPatch

func MakeActionPatchFromEvalActionPatch

func MakeActionPatchFromEvalActionPatch(f EvalActionPatch) ActionPatch

MakeActionPatchFromEvalActionPatch creates a new ActionPatch from an instance of EvalActionPatch

func MakeActionPatchFromLookupActionPatch

func MakeActionPatchFromLookupActionPatch(f LookupActionPatch) ActionPatch

MakeActionPatchFromLookupActionPatch creates a new ActionPatch from an instance of LookupActionPatch

func MakeActionPatchFromRawInterface

func MakeActionPatchFromRawInterface(f interface{}) ActionPatch

MakeActionPatchFromRawInterface creates a new ActionPatch from a raw interface{}

func MakeActionPatchFromRegexActionPatch

func MakeActionPatchFromRegexActionPatch(f RegexActionPatch) ActionPatch

MakeActionPatchFromRegexActionPatch creates a new ActionPatch from an instance of RegexActionPatch

func (ActionPatch) AliasActionPatch

func (m ActionPatch) AliasActionPatch() *AliasActionPatch

AliasActionPatch returns AliasActionPatch if IsAliasActionPatch() is true, nil otherwise

func (ActionPatch) AutoKvActionPatch

func (m ActionPatch) AutoKvActionPatch() *AutoKvActionPatch

AutoKvActionPatch returns AutoKvActionPatch if IsAutoKvActionPatch() is true, nil otherwise

func (ActionPatch) EvalActionPatch

func (m ActionPatch) EvalActionPatch() *EvalActionPatch

EvalActionPatch returns EvalActionPatch if IsEvalActionPatch() is true, nil otherwise

func (ActionPatch) IsAliasActionPatch

func (m ActionPatch) IsAliasActionPatch() bool

IsAliasActionPatch checks if the ActionPatch is a AliasActionPatch

func (ActionPatch) IsAutoKvActionPatch

func (m ActionPatch) IsAutoKvActionPatch() bool

IsAutoKvActionPatch checks if the ActionPatch is a AutoKvActionPatch

func (ActionPatch) IsEvalActionPatch

func (m ActionPatch) IsEvalActionPatch() bool

IsEvalActionPatch checks if the ActionPatch is a EvalActionPatch

func (ActionPatch) IsLookupActionPatch

func (m ActionPatch) IsLookupActionPatch() bool

IsLookupActionPatch checks if the ActionPatch is a LookupActionPatch

func (ActionPatch) IsRawInterface

func (m ActionPatch) IsRawInterface() bool

IsRawInterface checks if the ActionPatch is an interface{} (unknown type)

func (ActionPatch) IsRegexActionPatch

func (m ActionPatch) IsRegexActionPatch() bool

IsRegexActionPatch checks if the ActionPatch is a RegexActionPatch

func (ActionPatch) LookupActionPatch

func (m ActionPatch) LookupActionPatch() *LookupActionPatch

LookupActionPatch returns LookupActionPatch if IsLookupActionPatch() is true, nil otherwise

func (ActionPatch) MarshalJSON

func (m ActionPatch) MarshalJSON() ([]byte, error)

MarshalJSON marshals ActionPatch using ActionPatch.ActionPatch

func (ActionPatch) RawInterface

func (m ActionPatch) RawInterface() interface{}

RawInterface returns interface{} if IsRawInterface() is true (unknown type), nil otherwise

func (ActionPatch) RegexActionPatch

func (m ActionPatch) RegexActionPatch() *RegexActionPatch

RegexActionPatch returns RegexActionPatch if IsRegexActionPatch() is true, nil otherwise

func (*ActionPatch) UnmarshalJSON

func (m *ActionPatch) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals ActionPatch into AliasActionPatch, AutoKvActionPatch, EvalActionPatch, LookupActionPatch, RegexActionPatch, or interface{} if no matches are found

type ActionPatchCommon

type ActionPatchCommon struct {
	// The name of the user who owns this action. This value is obtained from the bearer token if not present.
	Owner *string `json:"owner,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Property values common across action kinds for setting existing actions using a PATCH request.

type ActionPost

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

ActionPost : Initial property values for creating a new action using a POST request.

func MakeActionPostFromAliasActionPost

func MakeActionPostFromAliasActionPost(f AliasActionPost) ActionPost

MakeActionPostFromAliasActionPost creates a new ActionPost from an instance of AliasActionPost

func MakeActionPostFromAutoKvActionPost

func MakeActionPostFromAutoKvActionPost(f AutoKvActionPost) ActionPost

MakeActionPostFromAutoKvActionPost creates a new ActionPost from an instance of AutoKvActionPost

func MakeActionPostFromEvalActionPost

func MakeActionPostFromEvalActionPost(f EvalActionPost) ActionPost

MakeActionPostFromEvalActionPost creates a new ActionPost from an instance of EvalActionPost

func MakeActionPostFromLookupActionPost

func MakeActionPostFromLookupActionPost(f LookupActionPost) ActionPost

MakeActionPostFromLookupActionPost creates a new ActionPost from an instance of LookupActionPost

func MakeActionPostFromRawInterface

func MakeActionPostFromRawInterface(f interface{}) ActionPost

MakeActionPostFromRawInterface creates a new ActionPost from a raw interface{}

func MakeActionPostFromRegexActionPost

func MakeActionPostFromRegexActionPost(f RegexActionPost) ActionPost

MakeActionPostFromRegexActionPost creates a new ActionPost from an instance of RegexActionPost

func (ActionPost) AliasActionPost

func (m ActionPost) AliasActionPost() *AliasActionPost

AliasActionPost returns AliasActionPost if IsAliasActionPost() is true, nil otherwise

func (ActionPost) AutoKvActionPost

func (m ActionPost) AutoKvActionPost() *AutoKvActionPost

AutoKvActionPost returns AutoKvActionPost if IsAutoKvActionPost() is true, nil otherwise

func (ActionPost) EvalActionPost

func (m ActionPost) EvalActionPost() *EvalActionPost

EvalActionPost returns EvalActionPost if IsEvalActionPost() is true, nil otherwise

func (ActionPost) IsAliasActionPost

func (m ActionPost) IsAliasActionPost() bool

IsAliasActionPost checks if the ActionPost is a AliasActionPost

func (ActionPost) IsAutoKvActionPost

func (m ActionPost) IsAutoKvActionPost() bool

IsAutoKvActionPost checks if the ActionPost is a AutoKvActionPost

func (ActionPost) IsEvalActionPost

func (m ActionPost) IsEvalActionPost() bool

IsEvalActionPost checks if the ActionPost is a EvalActionPost

func (ActionPost) IsLookupActionPost

func (m ActionPost) IsLookupActionPost() bool

IsLookupActionPost checks if the ActionPost is a LookupActionPost

func (ActionPost) IsRawInterface

func (m ActionPost) IsRawInterface() bool

IsRawInterface checks if the ActionPost is an interface{} (unknown type)

func (ActionPost) IsRegexActionPost

func (m ActionPost) IsRegexActionPost() bool

IsRegexActionPost checks if the ActionPost is a RegexActionPost

func (ActionPost) LookupActionPost

func (m ActionPost) LookupActionPost() *LookupActionPost

LookupActionPost returns LookupActionPost if IsLookupActionPost() is true, nil otherwise

func (ActionPost) MarshalJSON

func (m ActionPost) MarshalJSON() ([]byte, error)

MarshalJSON marshals ActionPost using the appropriate struct field

func (ActionPost) RawInterface

func (m ActionPost) RawInterface() interface{}

RawInterface returns interface{} if IsRawInterface() is true (unknown type), nil otherwise

func (ActionPost) RegexActionPost

func (m ActionPost) RegexActionPost() *RegexActionPost

RegexActionPost returns RegexActionPost if IsRegexActionPost() is true, nil otherwise

func (*ActionPost) UnmarshalJSON

func (m *ActionPost) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals ActionPost using the "kind" property

type AliasAction

type AliasAction struct {
	// The alias name.
	Alias string `json:"alias"`
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// The name of the field to be aliased.
	Field string `json:"field"`
	// A unique action ID.
	Id   string          `json:"id"`
	Kind AliasActionKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The rule that this action is part of.
	Ruleid string `json:"ruleid"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete alias action as rendered in POST, PATCH, and GET responses.

type AliasActionKind

type AliasActionKind string

AliasActionKind : The alias action kind.

const (
	AliasActionKindAlias AliasActionKind = "ALIAS"
)

List of AliasActionKind

type AliasActionPatch

type AliasActionPatch struct {
	// The alias name.
	Alias *string `json:"alias,omitempty"`
	// The name of the field to be aliased.
	Field *string          `json:"field,omitempty"`
	Kind  *AliasActionKind `json:"kind,omitempty"`
	// The name of the user who owns this action. This value is obtained from the bearer token if not present.
	Owner *string `json:"owner,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Property values for setting existing alias actions using a PATCH request.

type AliasActionPost

type AliasActionPost struct {
	// The alias name.
	Alias string `json:"alias"`
	// The name of the field to be aliased.
	Field string          `json:"field"`
	Kind  AliasActionKind `json:"kind"`
	// A unique action ID.
	Id *string `json:"id,omitempty"`
	// The rule that this action is part of.
	Ruleid *string `json:"ruleid,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Initial property values for creating a new alias action using a POST request.

type AliasActionProperties

type AliasActionProperties struct {
	// The alias name.
	Alias *string `json:"alias,omitempty"`
	// The name of the field to be aliased.
	Field *string          `json:"field,omitempty"`
	Kind  *AliasActionKind `json:"kind,omitempty"`
}

Properties of alias actions which may be read, set, and changed through the API. Implementation detail of ActionPOST, ActionPOST, and Action, do not use directly.

type Annotation

type Annotation map[string]interface{}

type AnnotationPost

type AnnotationPost map[string]interface{}

type AnnotationTypeResourceName

type AnnotationTypeResourceName string

The resource name of an AnnotationType. For the default module, the resource name format is annotationTypeName. Otherwise, the resource name format is module.annotationTypeName.

type AnnotationsProperties

type AnnotationsProperties struct {
	// The annotation type ID.
	Annotationtypeid *string `json:"annotationtypeid,omitempty"`
	// The dashboard ID.
	Dashboardid *string `json:"dashboardid,omitempty"`
	// The dataset ID. Null if not annotating a dataset.
	Datasetid *string `json:"datasetid,omitempty"`
	// The field ID. Null if not annotating a field.
	Fieldid *string `json:"fieldid,omitempty"`
	// The relationship ID. Null if not annotating a relationship.
	Relationshipid *string `json:"relationshipid,omitempty"`
}

Properties of annotations which are read through the API.

type AppClientIdProperties added in v1.7.0

type AppClientIdProperties struct {
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
}

Appclientidcreatedby, appclientidmodifiedby app clientid properties for inclusion in othert objects.

type AutoKvAction

type AutoKvAction struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// A unique action ID.
	Id   string           `json:"id"`
	Kind AutoKvActionKind `json:"kind"`
	// The autokv action mode.
	Mode string `json:"mode"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The rule that this action is part of.
	Ruleid string `json:"ruleid"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete autokv action as rendered in POST, PATCH, and GET responses.

type AutoKvActionKind

type AutoKvActionKind string

AutoKvActionKind : The autokv action kind.

const (
	AutoKvActionKindAutokv AutoKvActionKind = "AUTOKV"
)

List of AutoKVActionKind

type AutoKvActionPatch

type AutoKvActionPatch struct {
	Kind *AutoKvActionKind `json:"kind,omitempty"`
	// The autokv action mode.
	Mode *string `json:"mode,omitempty"`
	// The name of the user who owns this action. This value is obtained from the bearer token if not present.
	Owner *string `json:"owner,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Property values for setting existing autokv actions using a PATCH request.

type AutoKvActionPost

type AutoKvActionPost struct {
	Kind AutoKvActionKind `json:"kind"`
	// The autokv action mode.
	Mode string `json:"mode"`
	// A unique action ID.
	Id *string `json:"id,omitempty"`
	// The rule that this action is part of.
	Ruleid *string `json:"ruleid,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Initial property values for creating a new autokv action using a POST request.

type AutoKvActionProperties

type AutoKvActionProperties struct {
	Kind *AutoKvActionKind `json:"kind,omitempty"`
	// The autokv action mode.
	Mode *string `json:"mode,omitempty"`
}

Properties of auto kv actions which may be read, set, and changed through the API. Implementation detail of ActionPOST, ActionPOST, and Action, do not use directly.

type CatalogDataset added in v1.8.0

type CatalogDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// A unique dataset ID.
	Id   string             `json:"id"`
	Kind CatalogDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// Internal use only.
	Url *string `json:"url,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete catalog dataset as rendered in POST, PATCH, and GET responses.

type CatalogDatasetKind added in v1.8.0

type CatalogDatasetKind string

CatalogDatasetKind : The dataset kind.

const (
	CatalogDatasetKindCatalog CatalogDatasetKind = "catalog"
)

List of CatalogDatasetKind

type CatalogDatasetProperties added in v1.8.0

type CatalogDatasetProperties struct {
	Kind *CatalogDatasetKind `json:"kind,omitempty"`
	// Internal use only.
	Url *string `json:"url,omitempty"`
}

Properties of catalog datasets which can be read, set, and changed through the API.

type Dashboard

type Dashboard struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// The JSON dashboard definition.
	Definition string `json:"definition"`
	// A unique dashboard ID. Random ID used if not provided.
	Id string `json:"id"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The module that contains the dashboard.
	Module string `json:"module"`
	// The dashboard name. Dashboard names must be unique within each tenant.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Whether the dashboard is active or not.
	Isactive *bool `json:"isactive,omitempty"`
	// The version of the dashboard.
	Version *int32 `json:"version,omitempty"`
}

A complete dashboard as rendered in POST, PATCH, and GET responses.

type DashboardMutable

type DashboardMutable struct {
	// The JSON dashboard definition.
	Definition *string `json:"definition,omitempty"`
	// Whether the dashboard is active or not.
	Isactive *bool `json:"isactive,omitempty"`
	// The module that contains the dashboard.
	Module *string `json:"module,omitempty"`
	// The dashboard name. Dashboard names must be unique within each tenant.
	Name *string `json:"name,omitempty"`
	// The version of the dashboard.
	Version *int32 `json:"version,omitempty"`
}

A list of the mutable dashboard fields.

type DashboardPatch

type DashboardPatch struct {
	// The JSON dashboard definition.
	Definition *string `json:"definition,omitempty"`
	// Whether the dashboard is active or not.
	Isactive *bool `json:"isactive,omitempty"`
	// The module that contains the dashboard.
	Module *string `json:"module,omitempty"`
	// The dashboard name. Dashboard names must be unique within each tenant.
	Name *string `json:"name,omitempty"`
	// The version of the dashboard.
	Version *int32 `json:"version,omitempty"`
}

Values for updating a dashboard using a PATCH request.

type DashboardPost

type DashboardPost struct {
	// The JSON dashboard definition.
	Definition string `json:"definition"`
	// The module that contains the dashboard.
	Module string `json:"module"`
	// The dashboard name. Dashboard names must be unique within each tenant.
	Name string `json:"name"`
	// A unique dashboard ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// Whether the dashboard is active or not.
	Isactive *bool `json:"isactive,omitempty"`
	// The version of the dashboard.
	Version *int32 `json:"version,omitempty"`
}

Initial values for creating a new dashboard using a POST request.

type Dataset

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

Dataset : A complete dataset as rendered in POST, PATCH responses.

func MakeDatasetFromFederatedDataset

func MakeDatasetFromFederatedDataset(f FederatedDataset) Dataset

MakeDatasetFromFederatedDataset creates a new Dataset from an instance of FederatedDataset

func MakeDatasetFromImportDataset

func MakeDatasetFromImportDataset(f ImportDataset) Dataset

MakeDatasetFromImportDataset creates a new Dataset from an instance of ImportDataset

func MakeDatasetFromIndexDataset

func MakeDatasetFromIndexDataset(f IndexDataset) Dataset

MakeDatasetFromIndexDataset creates a new Dataset from an instance of IndexDataset

func MakeDatasetFromKvCollectionDataset

func MakeDatasetFromKvCollectionDataset(f KvCollectionDataset) Dataset

MakeDatasetFromKvCollectionDataset creates a new Dataset from an instance of KvCollectionDataset

func MakeDatasetFromLookupDataset

func MakeDatasetFromLookupDataset(f LookupDataset) Dataset

MakeDatasetFromLookupDataset creates a new Dataset from an instance of LookupDataset

func MakeDatasetFromMetricDataset

func MakeDatasetFromMetricDataset(f MetricDataset) Dataset

MakeDatasetFromMetricDataset creates a new Dataset from an instance of MetricDataset

func MakeDatasetFromRawInterface

func MakeDatasetFromRawInterface(f interface{}) Dataset

MakeDatasetFromRawInterface creates a new Dataset from a raw interface{}

func MakeDatasetFromViewDataset

func MakeDatasetFromViewDataset(f ViewDataset) Dataset

MakeDatasetFromViewDataset creates a new Dataset from an instance of ViewDataset

func (Dataset) FederatedDataset

func (m Dataset) FederatedDataset() *FederatedDataset

FederatedDataset returns FederatedDataset if IsFederatedDataset() is true, nil otherwise

func (Dataset) ImportDataset

func (m Dataset) ImportDataset() *ImportDataset

ImportDataset returns ImportDataset if IsImportDataset() is true, nil otherwise

func (Dataset) IndexDataset

func (m Dataset) IndexDataset() *IndexDataset

IndexDataset returns IndexDataset if IsIndexDataset() is true, nil otherwise

func (Dataset) IsFederatedDataset

func (m Dataset) IsFederatedDataset() bool

IsFederatedDataset checks if the Dataset is a FederatedDataset

func (Dataset) IsImportDataset

func (m Dataset) IsImportDataset() bool

IsImportDataset checks if the Dataset is a ImportDataset

func (Dataset) IsIndexDataset

func (m Dataset) IsIndexDataset() bool

IsIndexDataset checks if the Dataset is a IndexDataset

func (Dataset) IsKvCollectionDataset

func (m Dataset) IsKvCollectionDataset() bool

IsKvCollectionDataset checks if the Dataset is a KvCollectionDataset

func (Dataset) IsLookupDataset

func (m Dataset) IsLookupDataset() bool

IsLookupDataset checks if the Dataset is a LookupDataset

func (Dataset) IsMetricDataset

func (m Dataset) IsMetricDataset() bool

IsMetricDataset checks if the Dataset is a MetricDataset

func (Dataset) IsRawInterface

func (m Dataset) IsRawInterface() bool

IsRawInterface checks if the Dataset is an interface{} (unknown type)

func (Dataset) IsViewDataset

func (m Dataset) IsViewDataset() bool

IsViewDataset checks if the Dataset is a ViewDataset

func (Dataset) KvCollectionDataset

func (m Dataset) KvCollectionDataset() *KvCollectionDataset

KvCollectionDataset returns KvCollectionDataset if IsKvCollectionDataset() is true, nil otherwise

func (Dataset) LookupDataset

func (m Dataset) LookupDataset() *LookupDataset

LookupDataset returns LookupDataset if IsLookupDataset() is true, nil otherwise

func (Dataset) MarshalJSON

func (m Dataset) MarshalJSON() ([]byte, error)

MarshalJSON marshals Dataset using the appropriate struct field

func (Dataset) MetricDataset

func (m Dataset) MetricDataset() *MetricDataset

MetricDataset returns MetricDataset if IsMetricDataset() is true, nil otherwise

func (Dataset) RawInterface

func (m Dataset) RawInterface() interface{}

RawInterface returns interface{} if IsRawInterface() is true (unknown type), nil otherwise

func (*Dataset) UnmarshalJSON

func (m *Dataset) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals Dataset using the "kind" property

func (Dataset) ViewDataset

func (m Dataset) ViewDataset() *ViewDataset

ViewDataset returns ViewDataset if IsViewDataset() is true, nil otherwise

type DatasetCommon

type DatasetCommon struct {
	// A unique dataset ID.
	Id string `json:"id"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Properties that are common across all Dataset kinds rendered in POST, PATCH, and GET responses.

type DatasetGet added in v1.8.0

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

DatasetGet : A complete dataset as rendered in GET responses.

func MakeDatasetGetFromCatalogDataset added in v1.8.0

func MakeDatasetGetFromCatalogDataset(f CatalogDataset) DatasetGet

MakeDatasetGetFromCatalogDataset creates a new DatasetGet from an instance of CatalogDataset

func MakeDatasetGetFromFederatedDataset

func MakeDatasetGetFromFederatedDataset(f FederatedDataset) DatasetGet

MakeDatasetGetFromFederatedDataset creates a new DatasetGet from an instance of FederatedDataset

func MakeDatasetGetFromImportDataset added in v1.8.0

func MakeDatasetGetFromImportDataset(f ImportDataset) DatasetGet

MakeDatasetGetFromImportDataset creates a new DatasetGet from an instance of ImportDataset

func MakeDatasetGetFromIndexDataset added in v1.8.0

func MakeDatasetGetFromIndexDataset(f IndexDataset) DatasetGet

MakeDatasetGetFromIndexDataset creates a new DatasetGet from an instance of IndexDataset

func MakeDatasetGetFromJobDatasetGet added in v1.9.0

func MakeDatasetGetFromJobDatasetGet(f JobDatasetGet) DatasetGet

MakeDatasetGetFromJobDatasetGet creates a new DatasetGet from an instance of JobDatasetGet

func MakeDatasetGetFromKvCollectionDataset added in v1.8.0

func MakeDatasetGetFromKvCollectionDataset(f KvCollectionDataset) DatasetGet

MakeDatasetGetFromKvCollectionDataset creates a new DatasetGet from an instance of KvCollectionDataset

func MakeDatasetGetFromLookupDataset added in v1.8.0

func MakeDatasetGetFromLookupDataset(f LookupDataset) DatasetGet

MakeDatasetGetFromLookupDataset creates a new DatasetGet from an instance of LookupDataset

func MakeDatasetGetFromMetricDataset added in v1.8.0

func MakeDatasetGetFromMetricDataset(f MetricDataset) DatasetGet

MakeDatasetGetFromMetricDataset creates a new DatasetGet from an instance of MetricDataset

func MakeDatasetGetFromRawInterface added in v1.8.0

func MakeDatasetGetFromRawInterface(f interface{}) DatasetGet

MakeDatasetGetFromRawInterface creates a new DatasetGet from a raw interface{}

func MakeDatasetGetFromSplv1sinkDataset added in v1.8.0

func MakeDatasetGetFromSplv1sinkDataset(f Splv1sinkDataset) DatasetGet

MakeDatasetGetFromSplv1sinkDataset creates a new DatasetGet from an instance of Splv1sinkDataset

func MakeDatasetGetFromViewDataset added in v1.8.0

func MakeDatasetGetFromViewDataset(f ViewDataset) DatasetGet

MakeDatasetGetFromViewDataset creates a new DatasetGet from an instance of ViewDataset

func (DatasetGet) CatalogDataset added in v1.8.0

func (m DatasetGet) CatalogDataset() *CatalogDataset

CatalogDataset returns CatalogDataset if IsCatalogDataset() is true, nil otherwise

func (DatasetGet) FederatedDataset

func (m DatasetGet) FederatedDataset() *FederatedDataset

FederatedDataset returns FederatedDataset if IsFederatedDataset() is true, nil otherwise

func (DatasetGet) ImportDataset added in v1.8.0

func (m DatasetGet) ImportDataset() *ImportDataset

ImportDataset returns ImportDataset if IsImportDataset() is true, nil otherwise

func (DatasetGet) IndexDataset added in v1.8.0

func (m DatasetGet) IndexDataset() *IndexDataset

IndexDataset returns IndexDataset if IsIndexDataset() is true, nil otherwise

func (DatasetGet) IsCatalogDataset added in v1.8.0

func (m DatasetGet) IsCatalogDataset() bool

IsCatalogDataset checks if the DatasetGet is a CatalogDataset

func (DatasetGet) IsFederatedDataset

func (m DatasetGet) IsFederatedDataset() bool

IsFederatedDataset checks if the DatasetGet is a FederatedDataset

func (DatasetGet) IsImportDataset added in v1.8.0

func (m DatasetGet) IsImportDataset() bool

IsImportDataset checks if the DatasetGet is a ImportDataset

func (DatasetGet) IsIndexDataset added in v1.8.0

func (m DatasetGet) IsIndexDataset() bool

IsIndexDataset checks if the DatasetGet is a IndexDataset

func (DatasetGet) IsJobDatasetGet added in v1.9.0

func (m DatasetGet) IsJobDatasetGet() bool

IsJobDatasetGet checks if the DatasetGet is a JobDatasetGet

func (DatasetGet) IsKvCollectionDataset added in v1.8.0

func (m DatasetGet) IsKvCollectionDataset() bool

IsKvCollectionDataset checks if the DatasetGet is a KvCollectionDataset

func (DatasetGet) IsLookupDataset added in v1.8.0

func (m DatasetGet) IsLookupDataset() bool

IsLookupDataset checks if the DatasetGet is a LookupDataset

func (DatasetGet) IsMetricDataset added in v1.8.0

func (m DatasetGet) IsMetricDataset() bool

IsMetricDataset checks if the DatasetGet is a MetricDataset

func (DatasetGet) IsRawInterface added in v1.8.0

func (m DatasetGet) IsRawInterface() bool

IsRawInterface checks if the DatasetGet is an interface{} (unknown type)

func (DatasetGet) IsSplv1sinkDataset added in v1.8.0

func (m DatasetGet) IsSplv1sinkDataset() bool

IsSplv1sinkDataset checks if the DatasetGet is a Splv1sinkDataset

func (DatasetGet) IsViewDataset added in v1.8.0

func (m DatasetGet) IsViewDataset() bool

IsViewDataset checks if the DatasetGet is a ViewDataset

func (DatasetGet) JobDatasetGet added in v1.9.0

func (m DatasetGet) JobDatasetGet() *JobDatasetGet

JobDatasetGet returns JobDatasetGet if IsJobDatasetGet() is true, nil otherwise

func (DatasetGet) KvCollectionDataset added in v1.8.0

func (m DatasetGet) KvCollectionDataset() *KvCollectionDataset

KvCollectionDataset returns KvCollectionDataset if IsKvCollectionDataset() is true, nil otherwise

func (DatasetGet) LookupDataset added in v1.8.0

func (m DatasetGet) LookupDataset() *LookupDataset

LookupDataset returns LookupDataset if IsLookupDataset() is true, nil otherwise

func (DatasetGet) MarshalJSON added in v1.8.0

func (m DatasetGet) MarshalJSON() ([]byte, error)

MarshalJSON marshals DatasetGet using the appropriate struct field

func (DatasetGet) MetricDataset added in v1.8.0

func (m DatasetGet) MetricDataset() *MetricDataset

MetricDataset returns MetricDataset if IsMetricDataset() is true, nil otherwise

func (DatasetGet) RawInterface added in v1.8.0

func (m DatasetGet) RawInterface() interface{}

RawInterface returns interface{} if IsRawInterface() is true (unknown type), nil otherwise

func (DatasetGet) Splv1sinkDataset added in v1.8.0

func (m DatasetGet) Splv1sinkDataset() *Splv1sinkDataset

Splv1sinkDataset returns Splv1sinkDataset if IsSplv1sinkDataset() is true, nil otherwise

func (*DatasetGet) UnmarshalJSON added in v1.8.0

func (m *DatasetGet) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals DatasetGet using the "kind" property

func (DatasetGet) ViewDataset added in v1.8.0

func (m DatasetGet) ViewDataset() *ViewDataset

ViewDataset returns ViewDataset if IsViewDataset() is true, nil otherwise

type DatasetImportedBy

type DatasetImportedBy struct {
	// The module that is importing the dataset.
	Module string `json:"module"`
	// The dataset owner.
	Owner string `json:"owner"`
	// The dataset name.
	Name *string `json:"name,omitempty"`
}

type DatasetPatch

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

DatasetPatch : Property values to be set in an existing dataset using a PATCH request. DatasetPatch is FederatedDatasetPatch, ImportDatasetPatch, IndexDatasetPatch, KvCollectionDatasetPatch, LookupDatasetPatch, MetricDatasetPatch, ViewDatasetPatch, (or interface{} if no matches are found)

func MakeDatasetPatchFromFederatedDatasetPatch

func MakeDatasetPatchFromFederatedDatasetPatch(f FederatedDatasetPatch) DatasetPatch

MakeDatasetPatchFromFederatedDatasetPatch creates a new DatasetPatch from an instance of FederatedDatasetPatch

func MakeDatasetPatchFromImportDatasetPatch

func MakeDatasetPatchFromImportDatasetPatch(f ImportDatasetPatch) DatasetPatch

MakeDatasetPatchFromImportDatasetPatch creates a new DatasetPatch from an instance of ImportDatasetPatch

func MakeDatasetPatchFromIndexDatasetPatch

func MakeDatasetPatchFromIndexDatasetPatch(f IndexDatasetPatch) DatasetPatch

MakeDatasetPatchFromIndexDatasetPatch creates a new DatasetPatch from an instance of IndexDatasetPatch

func MakeDatasetPatchFromKvCollectionDatasetPatch

func MakeDatasetPatchFromKvCollectionDatasetPatch(f KvCollectionDatasetPatch) DatasetPatch

MakeDatasetPatchFromKvCollectionDatasetPatch creates a new DatasetPatch from an instance of KvCollectionDatasetPatch

func MakeDatasetPatchFromLookupDatasetPatch

func MakeDatasetPatchFromLookupDatasetPatch(f LookupDatasetPatch) DatasetPatch

MakeDatasetPatchFromLookupDatasetPatch creates a new DatasetPatch from an instance of LookupDatasetPatch

func MakeDatasetPatchFromMetricDatasetPatch

func MakeDatasetPatchFromMetricDatasetPatch(f MetricDatasetPatch) DatasetPatch

MakeDatasetPatchFromMetricDatasetPatch creates a new DatasetPatch from an instance of MetricDatasetPatch

func MakeDatasetPatchFromRawInterface

func MakeDatasetPatchFromRawInterface(f interface{}) DatasetPatch

MakeDatasetPatchFromRawInterface creates a new DatasetPatch from a raw interface{}

func MakeDatasetPatchFromViewDatasetPatch

func MakeDatasetPatchFromViewDatasetPatch(f ViewDatasetPatch) DatasetPatch

MakeDatasetPatchFromViewDatasetPatch creates a new DatasetPatch from an instance of ViewDatasetPatch

func (DatasetPatch) FederatedDatasetPatch

func (m DatasetPatch) FederatedDatasetPatch() *FederatedDatasetPatch

FederatedDatasetPatch returns FederatedDatasetPatch if IsFederatedDatasetPatch() is true, nil otherwise

func (DatasetPatch) ImportDatasetPatch

func (m DatasetPatch) ImportDatasetPatch() *ImportDatasetPatch

ImportDatasetPatch returns ImportDatasetPatch if IsImportDatasetPatch() is true, nil otherwise

func (DatasetPatch) IndexDatasetPatch

func (m DatasetPatch) IndexDatasetPatch() *IndexDatasetPatch

IndexDatasetPatch returns IndexDatasetPatch if IsIndexDatasetPatch() is true, nil otherwise

func (DatasetPatch) IsFederatedDatasetPatch

func (m DatasetPatch) IsFederatedDatasetPatch() bool

IsFederatedDatasetPatch checks if the DatasetPatch is a FederatedDatasetPatch

func (DatasetPatch) IsImportDatasetPatch

func (m DatasetPatch) IsImportDatasetPatch() bool

IsImportDatasetPatch checks if the DatasetPatch is a ImportDatasetPatch

func (DatasetPatch) IsIndexDatasetPatch

func (m DatasetPatch) IsIndexDatasetPatch() bool

IsIndexDatasetPatch checks if the DatasetPatch is a IndexDatasetPatch

func (DatasetPatch) IsKvCollectionDatasetPatch

func (m DatasetPatch) IsKvCollectionDatasetPatch() bool

IsKvCollectionDatasetPatch checks if the DatasetPatch is a KvCollectionDatasetPatch

func (DatasetPatch) IsLookupDatasetPatch

func (m DatasetPatch) IsLookupDatasetPatch() bool

IsLookupDatasetPatch checks if the DatasetPatch is a LookupDatasetPatch

func (DatasetPatch) IsMetricDatasetPatch

func (m DatasetPatch) IsMetricDatasetPatch() bool

IsMetricDatasetPatch checks if the DatasetPatch is a MetricDatasetPatch

func (DatasetPatch) IsRawInterface

func (m DatasetPatch) IsRawInterface() bool

IsRawInterface checks if the DatasetPatch is an interface{} (unknown type)

func (DatasetPatch) IsViewDatasetPatch

func (m DatasetPatch) IsViewDatasetPatch() bool

IsViewDatasetPatch checks if the DatasetPatch is a ViewDatasetPatch

func (DatasetPatch) KvCollectionDatasetPatch

func (m DatasetPatch) KvCollectionDatasetPatch() *KvCollectionDatasetPatch

KvCollectionDatasetPatch returns KvCollectionDatasetPatch if IsKvCollectionDatasetPatch() is true, nil otherwise

func (DatasetPatch) LookupDatasetPatch

func (m DatasetPatch) LookupDatasetPatch() *LookupDatasetPatch

LookupDatasetPatch returns LookupDatasetPatch if IsLookupDatasetPatch() is true, nil otherwise

func (DatasetPatch) MarshalJSON

func (m DatasetPatch) MarshalJSON() ([]byte, error)

MarshalJSON marshals DatasetPatch using DatasetPatch.DatasetPatch

func (DatasetPatch) MetricDatasetPatch

func (m DatasetPatch) MetricDatasetPatch() *MetricDatasetPatch

MetricDatasetPatch returns MetricDatasetPatch if IsMetricDatasetPatch() is true, nil otherwise

func (DatasetPatch) RawInterface

func (m DatasetPatch) RawInterface() interface{}

RawInterface returns interface{} if IsRawInterface() is true (unknown type), nil otherwise

func (*DatasetPatch) UnmarshalJSON

func (m *DatasetPatch) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals DatasetPatch into FederatedDatasetPatch, ImportDatasetPatch, IndexDatasetPatch, KvCollectionDatasetPatch, LookupDatasetPatch, MetricDatasetPatch, ViewDatasetPatch, or interface{} if no matches are found

func (DatasetPatch) ViewDatasetPatch

func (m DatasetPatch) ViewDatasetPatch() *ViewDatasetPatch

ViewDatasetPatch returns ViewDatasetPatch if IsViewDatasetPatch() is true, nil otherwise

type DatasetPatchCommon

type DatasetPatchCommon struct {
	// The name of module to reassign dataset into.
	Module *string `json:"module,omitempty"`
	// The dataset name. Dataset names must be unique within each module.
	Name *string `json:"name,omitempty"`
	// The name of the dataset owner. This value is obtained from the bearer token.
	Owner *string `json:"owner,omitempty"`
}

Properties that are common across all Dataset kinds to be set in an existing dataset using a PATCH request.

type DatasetPost

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

DatasetPost : Initial property values for creating a new action using a POST request.

func MakeDatasetPostFromFederatedDatasetPost

func MakeDatasetPostFromFederatedDatasetPost(f FederatedDatasetPost) DatasetPost

MakeDatasetPostFromFederatedDatasetPost creates a new DatasetPost from an instance of FederatedDatasetPost

func MakeDatasetPostFromImportDatasetPost

func MakeDatasetPostFromImportDatasetPost(f ImportDatasetPost) DatasetPost

MakeDatasetPostFromImportDatasetPost creates a new DatasetPost from an instance of ImportDatasetPost

func MakeDatasetPostFromIndexDatasetPost

func MakeDatasetPostFromIndexDatasetPost(f IndexDatasetPost) DatasetPost

MakeDatasetPostFromIndexDatasetPost creates a new DatasetPost from an instance of IndexDatasetPost

func MakeDatasetPostFromKvCollectionDatasetPost

func MakeDatasetPostFromKvCollectionDatasetPost(f KvCollectionDatasetPost) DatasetPost

MakeDatasetPostFromKvCollectionDatasetPost creates a new DatasetPost from an instance of KvCollectionDatasetPost

func MakeDatasetPostFromLookupDatasetPost

func MakeDatasetPostFromLookupDatasetPost(f LookupDatasetPost) DatasetPost

MakeDatasetPostFromLookupDatasetPost creates a new DatasetPost from an instance of LookupDatasetPost

func MakeDatasetPostFromMetricDatasetPost

func MakeDatasetPostFromMetricDatasetPost(f MetricDatasetPost) DatasetPost

MakeDatasetPostFromMetricDatasetPost creates a new DatasetPost from an instance of MetricDatasetPost

func MakeDatasetPostFromRawInterface

func MakeDatasetPostFromRawInterface(f interface{}) DatasetPost

MakeDatasetPostFromRawInterface creates a new DatasetPost from a raw interface{}

func MakeDatasetPostFromViewDatasetPost

func MakeDatasetPostFromViewDatasetPost(f ViewDatasetPost) DatasetPost

MakeDatasetPostFromViewDatasetPost creates a new DatasetPost from an instance of ViewDatasetPost

func (DatasetPost) FederatedDatasetPost

func (m DatasetPost) FederatedDatasetPost() *FederatedDatasetPost

FederatedDatasetPost returns FederatedDatasetPost if IsFederatedDatasetPost() is true, nil otherwise

func (DatasetPost) ImportDatasetPost

func (m DatasetPost) ImportDatasetPost() *ImportDatasetPost

ImportDatasetPost returns ImportDatasetPost if IsImportDatasetPost() is true, nil otherwise

func (DatasetPost) IndexDatasetPost

func (m DatasetPost) IndexDatasetPost() *IndexDatasetPost

IndexDatasetPost returns IndexDatasetPost if IsIndexDatasetPost() is true, nil otherwise

func (DatasetPost) IsFederatedDatasetPost

func (m DatasetPost) IsFederatedDatasetPost() bool

IsFederatedDatasetPost checks if the DatasetPost is a FederatedDatasetPost

func (DatasetPost) IsImportDatasetPost

func (m DatasetPost) IsImportDatasetPost() bool

IsImportDatasetPost checks if the DatasetPost is a ImportDatasetPost

func (DatasetPost) IsIndexDatasetPost

func (m DatasetPost) IsIndexDatasetPost() bool

IsIndexDatasetPost checks if the DatasetPost is a IndexDatasetPost

func (DatasetPost) IsKvCollectionDatasetPost

func (m DatasetPost) IsKvCollectionDatasetPost() bool

IsKvCollectionDatasetPost checks if the DatasetPost is a KvCollectionDatasetPost

func (DatasetPost) IsLookupDatasetPost

func (m DatasetPost) IsLookupDatasetPost() bool

IsLookupDatasetPost checks if the DatasetPost is a LookupDatasetPost

func (DatasetPost) IsMetricDatasetPost

func (m DatasetPost) IsMetricDatasetPost() bool

IsMetricDatasetPost checks if the DatasetPost is a MetricDatasetPost

func (DatasetPost) IsRawInterface

func (m DatasetPost) IsRawInterface() bool

IsRawInterface checks if the DatasetPost is an interface{} (unknown type)

func (DatasetPost) IsViewDatasetPost

func (m DatasetPost) IsViewDatasetPost() bool

IsViewDatasetPost checks if the DatasetPost is a ViewDatasetPost

func (DatasetPost) KvCollectionDatasetPost

func (m DatasetPost) KvCollectionDatasetPost() *KvCollectionDatasetPost

KvCollectionDatasetPost returns KvCollectionDatasetPost if IsKvCollectionDatasetPost() is true, nil otherwise

func (DatasetPost) LookupDatasetPost

func (m DatasetPost) LookupDatasetPost() *LookupDatasetPost

LookupDatasetPost returns LookupDatasetPost if IsLookupDatasetPost() is true, nil otherwise

func (DatasetPost) MarshalJSON

func (m DatasetPost) MarshalJSON() ([]byte, error)

MarshalJSON marshals DatasetPost using the appropriate struct field

func (DatasetPost) MetricDatasetPost

func (m DatasetPost) MetricDatasetPost() *MetricDatasetPost

MetricDatasetPost returns MetricDatasetPost if IsMetricDatasetPost() is true, nil otherwise

func (DatasetPost) RawInterface

func (m DatasetPost) RawInterface() interface{}

RawInterface returns interface{} if IsRawInterface() is true (unknown type), nil otherwise

func (*DatasetPost) UnmarshalJSON

func (m *DatasetPost) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals DatasetPost using the "kind" property

func (DatasetPost) ViewDatasetPost

func (m DatasetPost) ViewDatasetPost() *ViewDatasetPost

ViewDatasetPost returns ViewDatasetPost if IsViewDatasetPost() is true, nil otherwise

type DatasetPostCommon

type DatasetPostCommon struct {
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Properties that are common across all Dataset kinds for creating a new dataset using a POST request.

type DateMetadataProperties

type DateMetadataProperties struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The date and time object was modified.
	Modified string `json:"modified"`
}

Created and Modified date-time properties for inclusion in other objects.

type EvalAction

type EvalAction struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// The EVAL expression that calculates the field.
	Expression string `json:"expression"`
	// The name of the field that is added or modified by the EVAL expression.
	Field string `json:"field"`
	// A unique action ID.
	Id   string         `json:"id"`
	Kind EvalActionKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The rule that this action is part of.
	Ruleid string `json:"ruleid"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete eval action as rendered in POST, PATCH, and GET responses.

type EvalActionKind

type EvalActionKind string

EvalActionKind : The eval action kind.

const (
	EvalActionKindEval EvalActionKind = "EVAL"
)

List of EvalActionKind

type EvalActionPatch

type EvalActionPatch struct {
	// The EVAL expression that calculates the field.
	Expression *string `json:"expression,omitempty"`
	// The name of the field that is added or modified by the EVAL expression.
	Field *string         `json:"field,omitempty"`
	Kind  *EvalActionKind `json:"kind,omitempty"`
	// The name of the user who owns this action. This value is obtained from the bearer token if not present.
	Owner *string `json:"owner,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Property values for setting existing eval actions using a PATCH request.

type EvalActionPost

type EvalActionPost struct {
	// The EVAL expression that calculates the field.
	Expression string `json:"expression"`
	// The name of the field that is added or modified by the EVAL expression.
	Field string         `json:"field"`
	Kind  EvalActionKind `json:"kind"`
	// A unique action ID.
	Id *string `json:"id,omitempty"`
	// The rule that this action is part of.
	Ruleid *string `json:"ruleid,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Initial property values for creating a new eval action using a POST request.

type EvalActionProperties

type EvalActionProperties struct {
	// The EVAL expression that calculates the field.
	Expression *string `json:"expression,omitempty"`
	// The name of the field that is added or modified by the EVAL expression.
	Field *string         `json:"field,omitempty"`
	Kind  *EvalActionKind `json:"kind,omitempty"`
}

Properties of eval actions which may be read, set, and changed through the API. Implementation detail of ActionPOST, ActionPOST, and Action, do not use directly.

type FederatedDataset

type FederatedDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// Connection information to connect to remote federated connection.
	FederatedConnection string `json:"federatedConnection"`
	// Dataset information in the remote instance.
	FederatedDataset string `json:"federatedDataset"`
	// Dataset kind information in the remote instance.
	FederatedDatasetKind string `json:"federatedDatasetKind"`
	// A unique dataset ID.
	Id   string               `json:"id"`
	Kind FederatedDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete federated dataset as rendered in POST, PATCH, and GET responses.

type FederatedDatasetKind

type FederatedDatasetKind string

FederatedDatasetKind : The dataset kind.

const (
	FederatedDatasetKindFederated FederatedDatasetKind = "federated"
)

List of FederatedDatasetKind

type FederatedDatasetPatch

type FederatedDatasetPatch struct {
	// Connection information to connect to remote federated connection.
	FederatedConnection *string `json:"federatedConnection,omitempty"`
	// Dataset information in the remote instance.
	FederatedDataset *string `json:"federatedDataset,omitempty"`
	// Dataset kind information in the remote instance.
	FederatedDatasetKind *string               `json:"federatedDatasetKind,omitempty"`
	Kind                 *FederatedDatasetKind `json:"kind,omitempty"`
	// The name of module to reassign dataset into.
	Module *string `json:"module,omitempty"`
	// The dataset name. Dataset names must be unique within each module.
	Name *string `json:"name,omitempty"`
	// The name of the dataset owner. This value is obtained from the bearer token.
	Owner *string `json:"owner,omitempty"`
}

Property values to be set in an existing federated dataset using a PATCH request.

type FederatedDatasetPost

type FederatedDatasetPost struct {
	// Connection information to connect to remote federated connection.
	FederatedConnection string `json:"federatedConnection"`
	// Dataset information in the remote instance.
	FederatedDataset string `json:"federatedDataset"`
	// Dataset kind information in the remote instance.
	FederatedDatasetKind string               `json:"federatedDatasetKind"`
	Kind                 FederatedDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Initial property values for creating a new federated dataset using a POST request.

type FederatedDatasetProperties

type FederatedDatasetProperties struct {
	// Connection information to connect to remote federated connection.
	FederatedConnection *string `json:"federatedConnection,omitempty"`
	// Dataset information in the remote instance.
	FederatedDataset *string `json:"federatedDataset,omitempty"`
	// Dataset kind information in the remote instance.
	FederatedDatasetKind *string               `json:"federatedDatasetKind,omitempty"`
	Kind                 *FederatedDatasetKind `json:"kind,omitempty"`
}

Properties of job datasets which may be read, set, and changed through the API. Implementation detail of DatasetPOST, DatasetPATCH, and Dataset, do not use directly.

type Field

type Field struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The dataset that the field is part of.
	Datasetid string        `json:"datasetid"`
	Datatype  FieldDataType `json:"datatype"`
	Fieldtype FieldType     `json:"fieldtype"`
	// The unique ID of this field.
	Id string `json:"id"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The field name.
	Name       string          `json:"name"`
	Prevalence FieldPrevalence `json:"prevalence"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// The field description.
	Description *string `json:"description,omitempty"`
	// Whether or not the field has been indexed.
	Indexed *bool `json:"indexed,omitempty"`
	// The field summary.
	Summary *string `json:"summary,omitempty"`
	// The field title.
	Title *string `json:"title,omitempty"`
}

A complete field as rendered in POST, PATCH, and GET responses.

type FieldDataType

type FieldDataType string

FieldDataType : The type of data in the field. Must be one of the valid values.

const (
	FieldDataTypeDate     FieldDataType = "DATE"
	FieldDataTypeNumber   FieldDataType = "NUMBER"
	FieldDataTypeObjectId FieldDataType = "OBJECT_ID"
	FieldDataTypeString   FieldDataType = "STRING"
	FieldDataTypeUnknown  FieldDataType = "UNKNOWN"
)

List of FieldDataType

type FieldPatch

type FieldPatch struct {
	Datatype *FieldDataType `json:"datatype,omitempty"`
	// The field description.
	Description *string    `json:"description,omitempty"`
	Fieldtype   *FieldType `json:"fieldtype,omitempty"`
	// Whether or not the field has been indexed.
	Indexed *bool `json:"indexed,omitempty"`
	// The field name.
	Name       *string          `json:"name,omitempty"`
	Prevalence *FieldPrevalence `json:"prevalence,omitempty"`
	// The field summary.
	Summary *string `json:"summary,omitempty"`
	// The field title.
	Title *string `json:"title,omitempty"`
}

Property values to be set in an existing field using a PATCH request.

type FieldPost

type FieldPost struct {
	// The field name.
	Name     string         `json:"name"`
	Datatype *FieldDataType `json:"datatype,omitempty"`
	// The field description.
	Description *string    `json:"description,omitempty"`
	Fieldtype   *FieldType `json:"fieldtype,omitempty"`
	// Whether or not the field has been indexed.
	Indexed    *bool            `json:"indexed,omitempty"`
	Prevalence *FieldPrevalence `json:"prevalence,omitempty"`
	// The field summary.
	Summary *string `json:"summary,omitempty"`
	// The field title.
	Title *string `json:"title,omitempty"`
}

Initial property values for creating a new field using a POST request.

type FieldPrevalence

type FieldPrevalence string

FieldPrevalence : How frequent the field appears in the dataset. Must be one of the valid values.

const (
	FieldPrevalenceAll     FieldPrevalence = "ALL"
	FieldPrevalenceSome    FieldPrevalence = "SOME"
	FieldPrevalenceUnknown FieldPrevalence = "UNKNOWN"
)

List of FieldPrevalence

type FieldProperties

type FieldProperties struct {
	Datatype *FieldDataType `json:"datatype,omitempty"`
	// The field description.
	Description *string    `json:"description,omitempty"`
	Fieldtype   *FieldType `json:"fieldtype,omitempty"`
	// Whether or not the field has been indexed.
	Indexed *bool `json:"indexed,omitempty"`
	// The field name.
	Name       *string          `json:"name,omitempty"`
	Prevalence *FieldPrevalence `json:"prevalence,omitempty"`
	// The field summary.
	Summary *string `json:"summary,omitempty"`
	// The field title.
	Title *string `json:"title,omitempty"`
}

Properties of fields which can be read, set, and changed through the API. Implementation detail of FieldPOST, FieldPATCH, and Field, do not use directly.

type FieldType

type FieldType string

FieldType : The type of field. Must be one of the valid values.

const (
	FieldTypeDimension FieldType = "DIMENSION"
	FieldTypeMeasure   FieldType = "MEASURE"
	FieldTypeUnknown   FieldType = "UNKNOWN"
)

List of FieldType

type GetDatasetQueryParams

type GetDatasetQueryParams struct {
	// Maxstale : The number of seconds beyond which we will refresh index metadata.
	Maxstale *int32 `key:"maxstale"`
}

GetDatasetQueryParams represents valid query parameters for the GetDataset operation For convenience GetDatasetQueryParams can be formed in a single statement, for example:

`v := GetDatasetQueryParams{}.SetMaxstale(...)`

func (GetDatasetQueryParams) SetMaxstale

type ImportDataset

type ImportDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// A unique dataset ID.
	Id   string            `json:"id"`
	Kind ImportDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// The dataset module being imported.
	SourceModule string `json:"sourceModule"`
	// The dataset name being imported.
	SourceName string `json:"sourceName"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete import dataset as rendered in POST, PATCH, and GET responses.

type ImportDatasetByIdPost

type ImportDatasetByIdPost struct {
	Kind ImportDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The dataset ID being imported.
	SourceId string `json:"sourceId"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Initial property values for creating a new import dataset by sourceId using a POST request.

type ImportDatasetByIdProperties

type ImportDatasetByIdProperties struct {
	Kind *ImportDatasetKind `json:"kind,omitempty"`
	// The dataset ID being imported.
	SourceId *string `json:"sourceId,omitempty"`
}

Initial property values for creating a new import dataset by sourceId using a POST request.

type ImportDatasetByNamePost

type ImportDatasetByNamePost struct {
	Kind ImportDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The dataset module being imported.
	SourceModule string `json:"sourceModule"`
	// The dataset name being imported.
	SourceName string `json:"sourceName"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Initial property values for creating a new import dataset by sourceName and sourceModule using a POST request.

type ImportDatasetByNameProperties

type ImportDatasetByNameProperties struct {
	Kind *ImportDatasetKind `json:"kind,omitempty"`
	// The dataset module being imported.
	SourceModule *string `json:"sourceModule,omitempty"`
	// The dataset name being imported.
	SourceName *string `json:"sourceName,omitempty"`
}

Properties of import datasets which may be read, set, and changed through the API. Implementation detail of DatasetPOST, DatasetPATCH, and Dataset, do not use directly.

type ImportDatasetKind

type ImportDatasetKind string

ImportDatasetKind : The dataset kind.

const (
	ImportDatasetKindModelImport ImportDatasetKind = "import"
)

List of ImportDatasetKind

type ImportDatasetPatch

type ImportDatasetPatch struct {
	// The name of module to reassign dataset into.
	Module *string `json:"module,omitempty"`
	// The dataset name. Dataset names must be unique within each module.
	Name *string `json:"name,omitempty"`
	// The name of the dataset owner. This value is obtained from the bearer token.
	Owner *string `json:"owner,omitempty"`
}

Property values to be set in an existing import dataset using a PATCH request.

type ImportDatasetPost

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

ImportDatasetPost : Initial property values for creating a new import dataset using a POST request. ImportDatasetPost is ImportDatasetByIdPost, ImportDatasetByNamePost, (or interface{} if no matches are found)

func MakeImportDatasetPostFromImportDatasetByIdPost

func MakeImportDatasetPostFromImportDatasetByIdPost(f ImportDatasetByIdPost) ImportDatasetPost

MakeImportDatasetPostFromImportDatasetByIdPost creates a new ImportDatasetPost from an instance of ImportDatasetByIdPost

func MakeImportDatasetPostFromImportDatasetByNamePost

func MakeImportDatasetPostFromImportDatasetByNamePost(f ImportDatasetByNamePost) ImportDatasetPost

MakeImportDatasetPostFromImportDatasetByNamePost creates a new ImportDatasetPost from an instance of ImportDatasetByNamePost

func MakeImportDatasetPostFromRawInterface

func MakeImportDatasetPostFromRawInterface(f interface{}) ImportDatasetPost

MakeImportDatasetPostFromRawInterface creates a new ImportDatasetPost from a raw interface{}

func (ImportDatasetPost) ImportDatasetByIdPost

func (m ImportDatasetPost) ImportDatasetByIdPost() *ImportDatasetByIdPost

ImportDatasetByIdPost returns ImportDatasetByIdPost if IsImportDatasetByIdPost() is true, nil otherwise

func (ImportDatasetPost) ImportDatasetByNamePost

func (m ImportDatasetPost) ImportDatasetByNamePost() *ImportDatasetByNamePost

ImportDatasetByNamePost returns ImportDatasetByNamePost if IsImportDatasetByNamePost() is true, nil otherwise

func (ImportDatasetPost) IsImportDatasetByIdPost

func (m ImportDatasetPost) IsImportDatasetByIdPost() bool

IsImportDatasetByIdPost checks if the ImportDatasetPost is a ImportDatasetByIdPost

func (ImportDatasetPost) IsImportDatasetByNamePost

func (m ImportDatasetPost) IsImportDatasetByNamePost() bool

IsImportDatasetByNamePost checks if the ImportDatasetPost is a ImportDatasetByNamePost

func (ImportDatasetPost) IsRawInterface

func (m ImportDatasetPost) IsRawInterface() bool

IsRawInterface checks if the ImportDatasetPost is an interface{} (unknown type)

func (ImportDatasetPost) MarshalJSON

func (m ImportDatasetPost) MarshalJSON() ([]byte, error)

MarshalJSON marshals ImportDatasetPost using ImportDatasetPost.ImportDatasetPost

func (ImportDatasetPost) RawInterface

func (m ImportDatasetPost) RawInterface() interface{}

RawInterface returns interface{} if IsRawInterface() is true (unknown type), nil otherwise

func (*ImportDatasetPost) UnmarshalJSON

func (m *ImportDatasetPost) UnmarshalJSON(b []byte) (err error)

UnmarshalJSON unmarshals ImportDatasetPost into ImportDatasetByIdPost, ImportDatasetByNamePost, or interface{} if no matches are found

type IndexDataset

type IndexDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// Specifies whether or not the Splunk index is disabled.
	Disabled bool `json:"disabled"`
	// A unique dataset ID.
	Id   string           `json:"id"`
	Kind IndexDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The timestamp, in seconds, of the earliest event. The timestamp is in UNIX time.
	EarliestEventTime *string `json:"earliestEventTime,omitempty"`
	// The earliest index time for any of the events in this index.
	EarliestIngestTime *string `json:"earliestIngestTime,omitempty"`
	// The frozenTimePeriodInSecs to use for the index
	FrozenTimePeriodInSecs *int32 `json:"frozenTimePeriodInSecs,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// The timestamp, in seconds, of the latest event. The timestamp is in UNIX time.
	LatestEventTime *string `json:"latestEventTime,omitempty"`
	// The latest index time for any of the events in this index.
	LatestIngestTime *string `json:"latestIngestTime,omitempty"`
	// The latest time that the index metadata was refreshed.
	LatestMetadataUpdateTime *string `json:"latestMetadataUpdateTime,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// The number of events in the index.
	TotalEventCount *int64 `json:"totalEventCount,omitempty"`
	// The raw size, in bytes, of the uncompressed data in the indexers.
	TotalSize *int64 `json:"totalSize,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete index dataset as rendered in POST, PATCH, and GET responses.

type IndexDatasetKind

type IndexDatasetKind string

IndexDatasetKind : The dataset kind.

const (
	IndexDatasetKindIndex IndexDatasetKind = "index"
)

List of IndexDatasetKind

type IndexDatasetPatch

type IndexDatasetPatch struct {
	// Specifies whether or not the Splunk index is disabled.
	Disabled *bool `json:"disabled,omitempty"`
	// The frozenTimePeriodInSecs to use for the index
	FrozenTimePeriodInSecs *int32            `json:"frozenTimePeriodInSecs,omitempty"`
	Kind                   *IndexDatasetKind `json:"kind,omitempty"`
	// The name of module to reassign dataset into.
	Module *string `json:"module,omitempty"`
	// The dataset name. Dataset names must be unique within each module.
	Name *string `json:"name,omitempty"`
	// The name of the dataset owner. This value is obtained from the bearer token.
	Owner *string `json:"owner,omitempty"`
}

Property values to be set in an existing index dataset using a PATCH request.

type IndexDatasetPost

type IndexDatasetPost struct {
	// Specifies whether or not the Splunk index is disabled.
	Disabled bool             `json:"disabled"`
	Kind     IndexDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// The frozenTimePeriodInSecs to use for the index
	FrozenTimePeriodInSecs *int32 `json:"frozenTimePeriodInSecs,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Initial property values for creating a new index dataset using a POST request.

type IndexDatasetProperties

type IndexDatasetProperties struct {
	// Specifies whether or not the Splunk index is disabled.
	Disabled *bool `json:"disabled,omitempty"`
	// The frozenTimePeriodInSecs to use for the index
	FrozenTimePeriodInSecs *int32            `json:"frozenTimePeriodInSecs,omitempty"`
	Kind                   *IndexDatasetKind `json:"kind,omitempty"`
}

Properties of job datasets which may be read, set, and changed through the API. Implementation detail of DatasetPOST, DatasetPATCH, and Dataset, do not use directly.

type IndexDatasetReadOnlyProperties

type IndexDatasetReadOnlyProperties struct {
	// The timestamp, in seconds, of the earliest event. The timestamp is in UNIX time.
	EarliestEventTime *string `json:"earliestEventTime,omitempty"`
	// The earliest index time for any of the events in this index.
	EarliestIngestTime *string           `json:"earliestIngestTime,omitempty"`
	Kind               *IndexDatasetKind `json:"kind,omitempty"`
	// The timestamp, in seconds, of the latest event. The timestamp is in UNIX time.
	LatestEventTime *string `json:"latestEventTime,omitempty"`
	// The latest index time for any of the events in this index.
	LatestIngestTime *string `json:"latestIngestTime,omitempty"`
	// The latest time that the index metadata was refreshed.
	LatestMetadataUpdateTime *string `json:"latestMetadataUpdateTime,omitempty"`
	// The number of events in the index.
	TotalEventCount *int64 `json:"totalEventCount,omitempty"`
	// The raw size, in bytes, of the uncompressed data in the indexers.
	TotalSize *int64 `json:"totalSize,omitempty"`
}

Properties of index datasets which can only be read through the API.

type JobDatasetEventSummaryAvailableStatus

type JobDatasetEventSummaryAvailableStatus string

JobDatasetEventSummaryAvailableStatus : Availability of event summary.

const (
	JobDatasetEventSummaryAvailableStatusTrue    JobDatasetEventSummaryAvailableStatus = "true"
	JobDatasetEventSummaryAvailableStatusFalse   JobDatasetEventSummaryAvailableStatus = "false"
	JobDatasetEventSummaryAvailableStatusUnknown JobDatasetEventSummaryAvailableStatus = "UNKNOWN"
)

List of JobDatasetEventSummaryAvailableStatus

type JobDatasetFieldSummaryAvailableStatus

type JobDatasetFieldSummaryAvailableStatus string

JobDatasetFieldSummaryAvailableStatus : Availability of field summary.

const (
	JobDatasetFieldSummaryAvailableStatusTrue    JobDatasetFieldSummaryAvailableStatus = "true"
	JobDatasetFieldSummaryAvailableStatusFalse   JobDatasetFieldSummaryAvailableStatus = "false"
	JobDatasetFieldSummaryAvailableStatusUnknown JobDatasetFieldSummaryAvailableStatus = "UNKNOWN"
)

List of JobDatasetFieldSummaryAvailableStatus

type JobDatasetGet added in v1.9.0

type JobDatasetGet struct {
	// Time that the job was completed
	CompletionTime string `json:"completionTime"`
	// The time the dataset will be available in S3.
	DeleteTime string `json:"deleteTime"`
	// Time that the job was dispatched
	DispatchTime string         `json:"dispatchTime"`
	Kind         JobDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// Parameters for the search job, mainly earliest, latest, timezone, and relativeTimeAnchor.
	Parameters map[string]interface{} `json:"parameters"`
	// The SPL query string for the search job.
	Query string `json:"query"`
	// Resolved earliest time for the job
	ResolvedEarliest string `json:"resolvedEarliest"`
	// Resolved latest time for the job
	ResolvedLatest string `json:"resolvedLatest"`
	// The ID assigned to the search job.
	Sid string `json:"sid"`
	// Was the event summary requested for this searhc job?
	CollectEventSummary *bool `json:"collectEventSummary,omitempty"`
	// Was the field summary requested for this searhc job?
	CollectFieldSummary *bool `json:"collectFieldSummary,omitempty"`
	// Were the time bucketes requested for this searhc job?
	CollectTimeBuckets *bool `json:"collectTimeBuckets,omitempty"`
	// Specifies whether a search is allowed to collect preview results during the runtime, internal search service use only.
	EnablePreview *bool `json:"enablePreview,omitempty"`
	// The runtime of the search in seconds.
	ExecutionTime *float32 `json:"executionTime,omitempty"`
	// Should the search produce all fields (including those not explicity mentioned in the SPL)?
	ExtractAllFields *bool `json:"extractAllFields,omitempty"`
	// The fields to extract. Valid values are all, none, or indexed.
	ExtractFields *string `json:"extractFields,omitempty"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// Did the SPL query cause any side effects on a dataset?
	HasSideEffects *bool `json:"hasSideEffects,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The maximum number of seconds to run this search before finishing.
	MaxTime *int32 `json:"maxTime,omitempty"`
	// Array of json objects to store critical search job messages.
	Messages []map[string]interface{} `json:"messages,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
	// The parent's ID of the search job.
	Parent *string `json:"parent,omitempty"`
	// An estimate of how complete the search job is.
	PercentComplete *int32 `json:"percentComplete,omitempty"`
	// The instantaneous number of results produced by the search job.
	ResultsAvailable *int32 `json:"resultsAvailable,omitempty"`
	// The search head that started this search job.
	SearchHead *string `json:"searchHead,omitempty"`
	// The SPLv2 version of the search job query string.
	Spl *string `json:"spl,omitempty"`
	// The current status of the search job.
	Status           *string                               `json:"status,omitempty"`
	TimelineMetadata *JobDatasetPropertiesTimelineMetadata `json:"timelineMetadata,omitempty"`
}

Job dataset as rendered in POST response for dataset API endpoint.

type JobDatasetKind

type JobDatasetKind string

JobDatasetKind : The dataset kind.

const (
	JobDatasetKindJob JobDatasetKind = "job"
)

List of JobDatasetKind

type JobDatasetProperties

type JobDatasetProperties struct {
	// Was the event summary requested for this searhc job?
	CollectEventSummary *bool `json:"collectEventSummary,omitempty"`
	// Was the field summary requested for this searhc job?
	CollectFieldSummary *bool `json:"collectFieldSummary,omitempty"`
	// Were the time bucketes requested for this searhc job?
	CollectTimeBuckets *bool `json:"collectTimeBuckets,omitempty"`
	// Time that the job was completed
	CompletionTime *string `json:"completionTime,omitempty"`
	// The time the dataset will be available in S3.
	DeleteTime *string `json:"deleteTime,omitempty"`
	// Time that the job was dispatched
	DispatchTime *string `json:"dispatchTime,omitempty"`
	// Specifies whether a search is allowed to collect preview results during the runtime, internal search service use only.
	EnablePreview *bool `json:"enablePreview,omitempty"`
	// The runtime of the search in seconds.
	ExecutionTime *float32 `json:"executionTime,omitempty"`
	// Should the search produce all fields (including those not explicity mentioned in the SPL)?
	ExtractAllFields *bool `json:"extractAllFields,omitempty"`
	// The fields to extract. Valid values are all, none, or indexed.
	ExtractFields *string `json:"extractFields,omitempty"`
	// Did the SPL query cause any side effects on a dataset?
	HasSideEffects *bool           `json:"hasSideEffects,omitempty"`
	Kind           *JobDatasetKind `json:"kind,omitempty"`
	// The maximum number of seconds to run this search before finishing.
	MaxTime *int32 `json:"maxTime,omitempty"`
	// Array of json objects to store critical search job messages.
	Messages []map[string]interface{} `json:"messages,omitempty"`
	// Parameters for the search job, mainly earliest, latest, timezone, and relativeTimeAnchor.
	Parameters map[string]interface{} `json:"parameters,omitempty"`
	// The parent's ID of the search job.
	Parent *string `json:"parent,omitempty"`
	// An estimate of how complete the search job is.
	PercentComplete *int32 `json:"percentComplete,omitempty"`
	// The SPL query string for the search job.
	Query *string `json:"query,omitempty"`
	// Resolved earliest time for the job
	ResolvedEarliest *string `json:"resolvedEarliest,omitempty"`
	// Resolved latest time for the job
	ResolvedLatest *string `json:"resolvedLatest,omitempty"`
	// The instantaneous number of results produced by the search job.
	ResultsAvailable *int32 `json:"resultsAvailable,omitempty"`
	// The search head that started this search job.
	SearchHead *string `json:"searchHead,omitempty"`
	// The ID assigned to the search job.
	Sid *string `json:"sid,omitempty"`
	// The SPLv2 version of the search job query string.
	Spl *string `json:"spl,omitempty"`
	// The current status of the search job.
	Status           *string                               `json:"status,omitempty"`
	TimelineMetadata *JobDatasetPropertiesTimelineMetadata `json:"timelineMetadata,omitempty"`
}

Properties of job datasets which may be read, set, and changed through the API. Implementation detail of DatasetPOST, DatasetPATCH, and Dataset, do not use directly.

type JobDatasetPropertiesTimelineMetadata

type JobDatasetPropertiesTimelineMetadata struct {
	Auto *JobDatasetPropertiesTimelineMetadataAuto `json:"auto,omitempty"`
}

Availability of timeline metadata artifacts.

type JobDatasetPropertiesTimelineMetadataAuto

type JobDatasetPropertiesTimelineMetadataAuto struct {
	EventSummaryAvailable *JobDatasetEventSummaryAvailableStatus `json:"eventSummaryAvailable,omitempty"`
	FieldSummaryAvailable *JobDatasetFieldSummaryAvailableStatus `json:"fieldSummaryAvailable,omitempty"`
	TimeBucketsAvailable  *JobDatasetTimeBucketsAvailableStatus  `json:"timeBucketsAvailable,omitempty"`
}

Availability of automatic timeline metadata artifacts.

type JobDatasetTimeBucketsAvailableStatus

type JobDatasetTimeBucketsAvailableStatus string

JobDatasetTimeBucketsAvailableStatus : Availability of time buckets (histogram of events).

const (
	JobDatasetTimeBucketsAvailableStatusTrue    JobDatasetTimeBucketsAvailableStatus = "true"
	JobDatasetTimeBucketsAvailableStatusFalse   JobDatasetTimeBucketsAvailableStatus = "false"
	JobDatasetTimeBucketsAvailableStatusUnknown JobDatasetTimeBucketsAvailableStatus = "UNKNOWN"
)

List of JobDatasetTimeBucketsAvailableStatus

type KvCollectionDataset

type KvCollectionDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// A unique dataset ID.
	Id   string                  `json:"id"`
	Kind KvCollectionDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete kvcollection dataset as rendered in POST, PATCH, and GET responses.

type KvCollectionDatasetKind

type KvCollectionDatasetKind string

KvCollectionDatasetKind : The dataset kind.

const (
	KvCollectionDatasetKindKvcollection KvCollectionDatasetKind = "kvcollection"
)

List of KVCollectionDatasetKind

type KvCollectionDatasetPatch

type KvCollectionDatasetPatch struct {
	Kind *KvCollectionDatasetKind `json:"kind,omitempty"`
	// The name of module to reassign dataset into.
	Module *string `json:"module,omitempty"`
	// The dataset name. Dataset names must be unique within each module.
	Name *string `json:"name,omitempty"`
	// The name of the dataset owner. This value is obtained from the bearer token.
	Owner *string `json:"owner,omitempty"`
}

Property values to be set in an existing kvcollection dataset using a PATCH request.

type KvCollectionDatasetPost

type KvCollectionDatasetPost struct {
	Kind KvCollectionDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Initial property values for creating a new kvcollection dataset using a POST request.

type KvCollectionDatasetProperties

type KvCollectionDatasetProperties struct {
	Kind *KvCollectionDatasetKind `json:"kind,omitempty"`
}

Properties of kvcollection datasets which may be read, set, and changed through the API. Implementation detail of DatasetPOST, DatasetPATCH, and Dataset, do not use directly.

type ListActionsForRuleQueryParams

type ListActionsForRuleQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the results list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Offset : The number of results to skip before the first one returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by.  You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc.  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListActionsForRuleQueryParams represents valid query parameters for the ListActionsForRule operation For convenience ListActionsForRuleQueryParams can be formed in a single statement, for example:

`v := ListActionsForRuleQueryParams{}.SetCount(...).SetFilter(...).SetOffset(...).SetOrderby(...)`

func (ListActionsForRuleQueryParams) SetCount

func (ListActionsForRuleQueryParams) SetFilter

func (ListActionsForRuleQueryParams) SetOffset

func (ListActionsForRuleQueryParams) SetOrderby

type ListAnnotationsForDashboardQueryParams

type ListAnnotationsForDashboardQueryParams struct {
	// Filter : A filter query to apply to the annotations.
	Filter string `key:"filter"`
}

ListAnnotationsForDashboardQueryParams represents valid query parameters for the ListAnnotationsForDashboard operation For convenience ListAnnotationsForDashboardQueryParams can be formed in a single statement, for example:

`v := ListAnnotationsForDashboardQueryParams{}.SetFilter(...)`

func (ListAnnotationsForDashboardQueryParams) SetFilter

type ListAnnotationsForDatasetQueryParams

type ListAnnotationsForDatasetQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the results list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Offset : The number of results to skip before the first one returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by.  You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc.  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListAnnotationsForDatasetQueryParams represents valid query parameters for the ListAnnotationsForDataset operation For convenience ListAnnotationsForDatasetQueryParams can be formed in a single statement, for example:

`v := ListAnnotationsForDatasetQueryParams{}.SetCount(...).SetFilter(...).SetOffset(...).SetOrderby(...)`

func (ListAnnotationsForDatasetQueryParams) SetCount

func (ListAnnotationsForDatasetQueryParams) SetFilter

func (ListAnnotationsForDatasetQueryParams) SetOffset

func (ListAnnotationsForDatasetQueryParams) SetOrderby

type ListAnnotationsQueryParams

type ListAnnotationsQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the results list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Offset : The number of results to skip before the first one returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by.  You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc.  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListAnnotationsQueryParams represents valid query parameters for the ListAnnotations operation For convenience ListAnnotationsQueryParams can be formed in a single statement, for example:

`v := ListAnnotationsQueryParams{}.SetCount(...).SetFilter(...).SetOffset(...).SetOrderby(...)`

func (ListAnnotationsQueryParams) SetCount

func (ListAnnotationsQueryParams) SetFilter

func (ListAnnotationsQueryParams) SetOffset

func (ListAnnotationsQueryParams) SetOrderby

type ListDashboardsQueryParams

type ListDashboardsQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the results list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Offset : The number of results to skip before the first one returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by.  You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc.  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListDashboardsQueryParams represents valid query parameters for the ListDashboards operation For convenience ListDashboardsQueryParams can be formed in a single statement, for example:

`v := ListDashboardsQueryParams{}.SetCount(...).SetFilter(...).SetOffset(...).SetOrderby(...)`

func (ListDashboardsQueryParams) SetCount

func (ListDashboardsQueryParams) SetFilter

func (ListDashboardsQueryParams) SetOffset

func (ListDashboardsQueryParams) SetOrderby

type ListDatasetsQueryParams

type ListDatasetsQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the dataset list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Maxstale : The number of seconds beyond which we will refresh index metadata.
	Maxstale *int32 `key:"maxstale"`
	// Offset : The number of results to skip before the first result is returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by.  You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc\".  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListDatasetsQueryParams represents valid query parameters for the ListDatasets operation For convenience ListDatasetsQueryParams can be formed in a single statement, for example:

`v := ListDatasetsQueryParams{}.SetCount(...).SetFilter(...).SetMaxstale(...).SetOffset(...).SetOrderby(...)`

func (ListDatasetsQueryParams) SetCount

func (ListDatasetsQueryParams) SetFilter

func (ListDatasetsQueryParams) SetMaxstale

func (ListDatasetsQueryParams) SetOffset

func (ListDatasetsQueryParams) SetOrderby

type ListFieldsForDatasetQueryParams

type ListFieldsForDatasetQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the dataset list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Offset : The number of results to skip before the first one returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by. You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc.  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListFieldsForDatasetQueryParams represents valid query parameters for the ListFieldsForDataset operation For convenience ListFieldsForDatasetQueryParams can be formed in a single statement, for example:

`v := ListFieldsForDatasetQueryParams{}.SetCount(...).SetFilter(...).SetOffset(...).SetOrderby(...)`

func (ListFieldsForDatasetQueryParams) SetCount

func (ListFieldsForDatasetQueryParams) SetFilter

func (ListFieldsForDatasetQueryParams) SetOffset

func (ListFieldsForDatasetQueryParams) SetOrderby

type ListFieldsQueryParams

type ListFieldsQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the dataset list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Offset : The number of results to skip before the first one returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by.  You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc.  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListFieldsQueryParams represents valid query parameters for the ListFields operation For convenience ListFieldsQueryParams can be formed in a single statement, for example:

`v := ListFieldsQueryParams{}.SetCount(...).SetFilter(...).SetOffset(...).SetOrderby(...)`

func (ListFieldsQueryParams) SetCount

func (ListFieldsQueryParams) SetFilter

func (ListFieldsQueryParams) SetOffset

func (ListFieldsQueryParams) SetOrderby

type ListModulesQueryParams

type ListModulesQueryParams struct {
	// Filter : A filter to apply to the modules.
	Filter string `key:"filter"`
}

ListModulesQueryParams represents valid query parameters for the ListModules operation For convenience ListModulesQueryParams can be formed in a single statement, for example:

`v := ListModulesQueryParams{}.SetFilter(...)`

func (ListModulesQueryParams) SetFilter

type ListRelationshipsQueryParams

type ListRelationshipsQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the results list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Offset : The number of results to skip before the first one returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by.  You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc.  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListRelationshipsQueryParams represents valid query parameters for the ListRelationships operation For convenience ListRelationshipsQueryParams can be formed in a single statement, for example:

`v := ListRelationshipsQueryParams{}.SetCount(...).SetFilter(...).SetOffset(...).SetOrderby(...)`

func (ListRelationshipsQueryParams) SetCount

func (ListRelationshipsQueryParams) SetFilter

func (ListRelationshipsQueryParams) SetOffset

func (ListRelationshipsQueryParams) SetOrderby

type ListRulesQueryParams

type ListRulesQueryParams struct {
	// Count : The maximum number of results to return.
	Count *int32 `key:"count"`
	// Filter : A filter to apply to the results list. The filter must be a SPL predicate expression.
	Filter string `key:"filter"`
	// Offset : The number of results to skip before the first one returned.
	Offset *int32 `key:"offset"`
	// Orderby : A list of fields to order the results by.  You can specify either ascending or descending order using \"<field> asc\" or \"<field> desc.  Ascending order is the default.
	Orderby []string `key:"orderby"`
}

ListRulesQueryParams represents valid query parameters for the ListRules operation For convenience ListRulesQueryParams can be formed in a single statement, for example:

`v := ListRulesQueryParams{}.SetCount(...).SetFilter(...).SetOffset(...).SetOrderby(...)`

func (ListRulesQueryParams) SetCount

func (ListRulesQueryParams) SetFilter

func (ListRulesQueryParams) SetOffset

func (ListRulesQueryParams) SetOrderby

type LookupAction

type LookupAction struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// The lookup body.
	Expression string `json:"expression"`
	// A unique action ID.
	Id   string           `json:"id"`
	Kind LookupActionKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The rule that this action is part of.
	Ruleid string `json:"ruleid"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete lookup action as rendered in POST, PATCH, and GET responses.

type LookupActionKind

type LookupActionKind string

LookupActionKind : The lookup action kind.

const (
	LookupActionKindLookup LookupActionKind = "LOOKUP"
)

List of LookupActionKind

type LookupActionPatch

type LookupActionPatch struct {
	// The lookup body.
	Expression *string           `json:"expression,omitempty"`
	Kind       *LookupActionKind `json:"kind,omitempty"`
	// The name of the user who owns this action. This value is obtained from the bearer token if not present.
	Owner *string `json:"owner,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Property values for setting existing lookup actions using a PATCH request.

type LookupActionPost

type LookupActionPost struct {
	// The lookup body.
	Expression string           `json:"expression"`
	Kind       LookupActionKind `json:"kind"`
	// A unique action ID.
	Id *string `json:"id,omitempty"`
	// The rule that this action is part of.
	Ruleid *string `json:"ruleid,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Initial property values for creating a new lookup action using a POST request.

type LookupActionProperties

type LookupActionProperties struct {
	// The lookup body.
	Expression *string           `json:"expression,omitempty"`
	Kind       *LookupActionKind `json:"kind,omitempty"`
}

Properties of lookup actions which may be read, set, and changed through the API. Implementation detail of ActionPOST, ActionPOST, and Action, do not use directly.

type LookupDataset

type LookupDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby    string                    `json:"createdby"`
	ExternalKind LookupDatasetExternalKind `json:"externalKind"`
	// The name of the external lookup.
	ExternalName string `json:"externalName"`
	// A unique dataset ID.
	Id   string            `json:"id"`
	Kind LookupDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Match case-sensitively against the lookup.
	CaseSensitiveMatch *bool `json:"caseSensitiveMatch,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// A query that filters results out of the lookup before those results are returned.
	Filter *string `json:"filter,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete lookup dataset as rendered in POST, PATCH, and GET responses.

type LookupDatasetExternalKind

type LookupDatasetExternalKind string

LookupDatasetExternalKind : The type of the external lookup.

const (
	LookupDatasetExternalKindKvcollection LookupDatasetExternalKind = "kvcollection"
)

List of LookupDatasetExternalKind

type LookupDatasetKind

type LookupDatasetKind string

LookupDatasetKind : The dataset kind.

const (
	LookupDatasetKindLookup LookupDatasetKind = "lookup"
)

List of LookupDatasetKind

type LookupDatasetPatch

type LookupDatasetPatch struct {
	// Match case-sensitively against the lookup.
	CaseSensitiveMatch *bool                      `json:"caseSensitiveMatch,omitempty"`
	ExternalKind       *LookupDatasetExternalKind `json:"externalKind,omitempty"`
	// The name of the external lookup.
	ExternalName *string `json:"externalName,omitempty"`
	// A query that filters results out of the lookup before those results are returned.
	Filter *string            `json:"filter,omitempty"`
	Kind   *LookupDatasetKind `json:"kind,omitempty"`
	// The name of module to reassign dataset into.
	Module *string `json:"module,omitempty"`
	// The dataset name. Dataset names must be unique within each module.
	Name *string `json:"name,omitempty"`
	// The name of the dataset owner. This value is obtained from the bearer token.
	Owner *string `json:"owner,omitempty"`
}

Property values to be set in an existing lookup dataset using a PATCH request.

type LookupDatasetPost

type LookupDatasetPost struct {
	ExternalKind LookupDatasetExternalKind `json:"externalKind"`
	// The name of the external lookup.
	ExternalName string            `json:"externalName"`
	Kind         LookupDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// Match case-sensitively against the lookup.
	CaseSensitiveMatch *bool `json:"caseSensitiveMatch,omitempty"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// A query that filters results out of the lookup before those results are returned.
	Filter *string `json:"filter,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Initial property values for creating a new lookup dataset using a POST request.

type LookupDatasetProperties

type LookupDatasetProperties struct {
	// Match case-sensitively against the lookup.
	CaseSensitiveMatch *bool                      `json:"caseSensitiveMatch,omitempty"`
	ExternalKind       *LookupDatasetExternalKind `json:"externalKind,omitempty"`
	// The name of the external lookup.
	ExternalName *string `json:"externalName,omitempty"`
	// A query that filters results out of the lookup before those results are returned.
	Filter *string            `json:"filter,omitempty"`
	Kind   *LookupDatasetKind `json:"kind,omitempty"`
}

Properties of lookup datasets which may be read, set, and changed through the API. Implementation detail of DatasetPOST, DatasetPATCH, and Dataset, do not use directly.

type MetadataProperties

type MetadataProperties struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the object's owner.
	Owner string `json:"owner"`
}

Created, createdby, modified, modifiedby, and owner properties for inclusion in other objects.

type MetricDataset

type MetricDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// Specifies whether or not the Splunk index is disabled.
	Disabled bool `json:"disabled"`
	// A unique dataset ID.
	Id   string            `json:"id"`
	Kind MetricDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The timestamp, in seconds, of the earliest measure. The timestamp is in UNIX time.
	EarliestEventTime *string `json:"earliestEventTime,omitempty"`
	// The earliest index time for any of the measures in this index.
	EarliestIngestTime *string `json:"earliestIngestTime,omitempty"`
	// The frozenTimePeriodInSecs to use for the index
	FrozenTimePeriodInSecs *int32 `json:"frozenTimePeriodInSecs,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// The timestamp, in seconds, of the latest measure. The timestamp is in UNIX time.
	LatestEventTime *string `json:"latestEventTime,omitempty"`
	// The earliest index time for any of the measures in this index.
	LatestIngestTime *string `json:"latestIngestTime,omitempty"`
	// The latest time that the metric index metadata was refreshed.
	LatestMetadataUpdateTime *string `json:"latestMetadataUpdateTime,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// THe number of measures in the metric index.
	TotalEventCount *int32 `json:"totalEventCount,omitempty"`
	// For metrics indexes, the totalSize is set to 0.
	TotalSize *int32 `json:"totalSize,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete metric dataset as rendered in POST, PATCH, and GET responses.

type MetricDatasetKind

type MetricDatasetKind string

MetricDatasetKind : The dataset kind.

const (
	MetricDatasetKindMetric MetricDatasetKind = "metric"
)

List of MetricDatasetKind

type MetricDatasetPatch

type MetricDatasetPatch struct {
	// Specifies whether or not the Splunk index is disabled.
	Disabled *bool `json:"disabled,omitempty"`
	// The frozenTimePeriodInSecs to use for the index
	FrozenTimePeriodInSecs *int32             `json:"frozenTimePeriodInSecs,omitempty"`
	Kind                   *MetricDatasetKind `json:"kind,omitempty"`
	// The name of module to reassign dataset into.
	Module *string `json:"module,omitempty"`
	// The dataset name. Dataset names must be unique within each module.
	Name *string `json:"name,omitempty"`
	// The name of the dataset owner. This value is obtained from the bearer token.
	Owner *string `json:"owner,omitempty"`
}

Property values to be set in an existing metric dataset using a PATCH request.

type MetricDatasetPost

type MetricDatasetPost struct {
	// Specifies whether or not the Splunk index is disabled.
	Disabled bool              `json:"disabled"`
	Kind     MetricDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// The frozenTimePeriodInSecs to use for the index
	FrozenTimePeriodInSecs *int32 `json:"frozenTimePeriodInSecs,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Initial property values for creating a new metric dataset using a POST request.

type MetricDatasetProperties

type MetricDatasetProperties struct {
	// Specifies whether or not the Splunk index is disabled.
	Disabled *bool `json:"disabled,omitempty"`
	// The frozenTimePeriodInSecs to use for the index
	FrozenTimePeriodInSecs *int32             `json:"frozenTimePeriodInSecs,omitempty"`
	Kind                   *MetricDatasetKind `json:"kind,omitempty"`
}

Properties of metric datasets which may be read, set, and changed through the API. Implementation detail of DatasetPOST, DatasetPATCH, and Dataset, do not use directly.

type MetricDatasetReadOnlyProperties

type MetricDatasetReadOnlyProperties struct {
	// The timestamp, in seconds, of the earliest measure. The timestamp is in UNIX time.
	EarliestEventTime *string `json:"earliestEventTime,omitempty"`
	// The earliest index time for any of the measures in this index.
	EarliestIngestTime *string            `json:"earliestIngestTime,omitempty"`
	Kind               *MetricDatasetKind `json:"kind,omitempty"`
	// The timestamp, in seconds, of the latest measure. The timestamp is in UNIX time.
	LatestEventTime *string `json:"latestEventTime,omitempty"`
	// The earliest index time for any of the measures in this index.
	LatestIngestTime *string `json:"latestIngestTime,omitempty"`
	// The latest time that the metric index metadata was refreshed.
	LatestMetadataUpdateTime *string `json:"latestMetadataUpdateTime,omitempty"`
	// THe number of measures in the metric index.
	TotalEventCount *int32 `json:"totalEventCount,omitempty"`
	// For metrics indexes, the totalSize is set to 0.
	TotalSize *int32 `json:"totalSize,omitempty"`
}

Properties of metric datasets which can only be read through the API.

type Module

type Module struct {
	Name *string `json:"name,omitempty"`
}

The name of a module.

type RegexAction

type RegexAction struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// Name of the field that is matched against the regular expression.
	Field string `json:"field"`
	// A unique action ID.
	Id   string          `json:"id"`
	Kind RegexActionKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// A regular expression that includes named capture groups for the purpose of field extraction.
	Pattern string `json:"pattern"`
	// The rule that this action is part of.
	Ruleid string `json:"ruleid"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// The maximum number of times per event to attempt to match fields with the regular expression.
	Limit *int32 `json:"limit,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete regex action as rendered in POST, PATCH, and GET responses.

type RegexActionKind

type RegexActionKind string

RegexActionKind : The regex action kind.

const (
	RegexActionKindRegex RegexActionKind = "REGEX"
)

List of RegexActionKind

type RegexActionPatch

type RegexActionPatch struct {
	// Name of the field that is matched against the regular expression.
	Field *string          `json:"field,omitempty"`
	Kind  *RegexActionKind `json:"kind,omitempty"`
	// The maximum number of times per event to attempt to match fields with the regular expression.
	Limit *int32 `json:"limit,omitempty"`
	// The name of the user who owns this action. This value is obtained from the bearer token if not present.
	Owner *string `json:"owner,omitempty"`
	// A regular expression that includes named capture groups for the purpose of field extraction.
	Pattern *string `json:"pattern,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Property values for setting existing regex actions using a PATCH request.

type RegexActionPost

type RegexActionPost struct {
	// Name of the field that is matched against the regular expression.
	Field string          `json:"field"`
	Kind  RegexActionKind `json:"kind"`
	// A regular expression that includes named capture groups for the purpose of field extraction.
	Pattern string `json:"pattern"`
	// A unique action ID.
	Id *string `json:"id,omitempty"`
	// The maximum number of times per event to attempt to match fields with the regular expression.
	Limit *int32 `json:"limit,omitempty"`
	// The rule that this action is part of.
	Ruleid *string `json:"ruleid,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Initial property values for creating a new regex action using a POST request.

type RegexActionProperties

type RegexActionProperties struct {
	// Name of the field that is matched against the regular expression.
	Field *string          `json:"field,omitempty"`
	Kind  *RegexActionKind `json:"kind,omitempty"`
	// The maximum number of times per event to attempt to match fields with the regular expression.
	Limit *int32 `json:"limit,omitempty"`
	// A regular expression that includes named capture groups for the purpose of field extraction.
	Pattern *string `json:"pattern,omitempty"`
}

Properties of regex actions which may be read, set, and changed through the API. Implementation detail of ActionPOST, ActionPOST, and Action, do not use directly.

type Relationship

type Relationship struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// The relationship fields associated with the relationship.
	Fields []RelationshipField `json:"fields"`
	// A unique relationship ID.
	Id   string           `json:"id"`
	Kind RelationshipKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The module that contains the relationship.
	Module string `json:"module"`
	// The relationship name.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// A unique source dataset ID. Either the sourceid or sourceresourcename property must be specified.
	Sourceid string `json:"sourceid"`
	// A unique target dataset ID. Either the targetid or targetresourcename property must be specified.
	Targetid string `json:"targetid"`
	// The Catalog version.
	Version int32 `json:"version"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// The source dataset name qualified by module name. Either the sourceid or sourceresourcename property must be specified.
	Sourceresourcename *string `json:"sourceresourcename,omitempty"`
	// The target dataset name qualified by module name. Either the targetid or targetresourcename property must be specified.
	Targetresourcename *string `json:"targetresourcename,omitempty"`
}

A complete relationship as rendered in POST, PATCH, and GET responses.

type RelationshipField

type RelationshipField struct {
	// The date and time object was created.
	Created string                `json:"created"`
	Kind    RelationshipFieldKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// A unique source dataset ID.
	Sourceid string `json:"sourceid"`
	// A unique target dataset ID.
	Targetid string `json:"targetid"`
	// A unique relationship ID.
	Relationshipid *string `json:"relationshipid,omitempty"`
}

A complete relationship field as rendered in POST, PATCH, and GET responses.

type RelationshipFieldKind

type RelationshipFieldKind string

RelationshipFieldKind : The type of match between the fields. Must be one of the valid values. The LATEST_BEFORE match type specifies that the datetime field in one dataset binds to the latest time before the datetime field in another dataset.

const (
	RelationshipFieldKindExact        RelationshipFieldKind = "EXACT"
	RelationshipFieldKindLatestBefore RelationshipFieldKind = "LATEST_BEFORE"
)

List of RelationshipFieldKind

type RelationshipFieldPost

type RelationshipFieldPost struct {
	Kind RelationshipFieldKind `json:"kind"`
	// A unique source dataset ID.
	Sourceid string `json:"sourceid"`
	// A unique target dataset ID.
	Targetid string `json:"targetid"`
	// A unique relationship ID.
	Relationshipid *string `json:"relationshipid,omitempty"`
}

The properties required to create a new relationship field using a relationship POST request.

type RelationshipFieldProperties

type RelationshipFieldProperties struct {
	Kind *RelationshipFieldKind `json:"kind,omitempty"`
	// A unique relationship ID.
	Relationshipid *string `json:"relationshipid,omitempty"`
	// A unique source dataset ID.
	Sourceid *string `json:"sourceid,omitempty"`
	// A unique target dataset ID.
	Targetid *string `json:"targetid,omitempty"`
}

Properties of relationship fields which are read through the API. Implementation detail of RelationshipFieldPOST. Do not use directly.

type RelationshipKind

type RelationshipKind string

RelationshipKind : The relationship type. Must be one of the valid values.

const (
	RelationshipKindOne        RelationshipKind = "ONE"
	RelationshipKindMany       RelationshipKind = "MANY"
	RelationshipKindDependency RelationshipKind = "DEPENDENCY"
)

List of RelationshipKind

type RelationshipPatch

type RelationshipPatch struct {
	// The name of the relationship.
	Name *string `json:"name,omitempty"`
	// The user who is the owner of the relationship.
	Owner *string `json:"owner,omitempty"`
}

type RelationshipPost

type RelationshipPost struct {
	Kind RelationshipKind `json:"kind"`
	// The relationship name.
	Name string `json:"name"`
	// The fields associated with this relationship.
	Fields []RelationshipFieldPost `json:"fields,omitempty"`
	// A unique relationship ID. If not specified, an auto generated ID is created.
	Id *string `json:"id,omitempty"`
	// The module that contains the relationship.
	Module *string `json:"module,omitempty"`
	// A unique source dataset ID. Either the sourceid or sourceresourcename property must be specified.
	Sourceid *string `json:"sourceid,omitempty"`
	// The source dataset name qualified by module name. Either the sourceid or sourceresourcename property must be specified.
	Sourceresourcename *string `json:"sourceresourcename,omitempty"`
	// A unique target dataset ID. Either the targetid or targetresourcename property must be specified.
	Targetid *string `json:"targetid,omitempty"`
	// The target dataset name qualified by module name. Either the targetid or targetresourcename property must be specified.
	Targetresourcename *string `json:"targetresourcename,omitempty"`
	// The Catalog version.
	Version *int32 `json:"version,omitempty"`
}

The properties required to create a new relationship using a POST request.

type RelationshipProperties

type RelationshipProperties struct {
	Kind *RelationshipKind `json:"kind,omitempty"`
	// The module that contains the relationship.
	Module *string `json:"module,omitempty"`
	// The relationship name.
	Name *string `json:"name,omitempty"`
	// A unique source dataset ID. Either the sourceid or sourceresourcename property must be specified.
	Sourceid *string `json:"sourceid,omitempty"`
	// The source dataset name qualified by module name. Either the sourceid or sourceresourcename property must be specified.
	Sourceresourcename *string `json:"sourceresourcename,omitempty"`
	// A unique target dataset ID. Either the targetid or targetresourcename property must be specified.
	Targetid *string `json:"targetid,omitempty"`
	// The target dataset name qualified by module name. Either the targetid or targetresourcename property must be specified.
	Targetresourcename *string `json:"targetresourcename,omitempty"`
	// The Catalog version.
	Version *int32 `json:"version,omitempty"`
}

Properties of relationships which are read through the API. Implementation detail of RelationshipPOST, RelationshipPATCH and Relationship. Do not use directly.

type Rule

type Rule struct {
	// The actions associated with the rule.
	Actions []Action `json:"actions"`
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// A unique Rule ID.
	Id string `json:"id"`
	// The rule match type.
	Match string `json:"match"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The module containing the rule.
	Module string `json:"module"`
	// The rule name.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The rule name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete rule as rendered in POST, PATCH, and GET responses.

type RulePatch

type RulePatch struct {
	// The rule match type.
	Match *string `json:"match,omitempty"`
	// The module containing the rule.
	Module *string `json:"module,omitempty"`
	// The rule name.
	Name *string `json:"name,omitempty"`
	// The name of the user who owns the rule.
	Owner *string `json:"owner,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

type RulePost

type RulePost struct {
	// The rule match type.
	Match string `json:"match"`
	// The rule name.
	Name string `json:"name"`
	// The actions to be associated with this rule.
	Actions []ActionPost `json:"actions,omitempty"`
	// A unique rule ID. The newly created rule object will use this ID value if provided.
	Id *string `json:"id,omitempty"`
	// The module containing the rule.
	Module *string `json:"module,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Initial property values for creating a new rule using a POST request.

type RuleProperties

type RuleProperties struct {
	// The rule match type.
	Match *string `json:"match,omitempty"`
	// The module containing the rule.
	Module *string `json:"module,omitempty"`
	// The rule name.
	Name *string `json:"name,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

Properties of rules which may be read, set, and changed through the API. Implementation detail of RulePOST, RulePATCH, and Rule, do not use directly.

type Service

type Service services.BaseService

func NewService

func NewService(iClient services.IClient) *Service

NewService creates a new catalog service client from the given Config

func (*Service) CreateActionForRule

func (s *Service) CreateActionForRule(ruleresource string, actionPost ActionPost, resp ...*http.Response) (*Action, error)

CreateActionForRule - catalog service endpoint Creates a new action for the specified rule by rule id or resource name. Parameters:

ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
actionPost: The JSON representation of the action to be persisted.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateAnnotationForDashboard

func (s *Service) CreateAnnotationForDashboard(dashboardresource string, requestBody map[string]string, resp ...*http.Response) (*Annotation, error)

CreateAnnotationForDashboard - catalog service endpoint Creates a new annotation for the specified dashboard. Parameters:

dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
requestBody: The JSON representation of the annotation to be persisted.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateAnnotationForDataset

func (s *Service) CreateAnnotationForDataset(datasetresource string, requestBody map[string]string, resp ...*http.Response) (*Annotation, error)

CreateAnnotationForDataset - catalog service endpoint Creates a new annotation for the specified dataset. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
requestBody: The JSON representation of the annotation to be persisted.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateDashboard

func (s *Service) CreateDashboard(dashboardPost DashboardPost, resp ...*http.Response) (*Dashboard, error)

CreateDashboard - catalog service endpoint Creates a new dashboard. Parameters:

dashboardPost: The JSON representation of the Dashboard to be persisted.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateDataset

func (s *Service) CreateDataset(datasetPost DatasetPost, resp ...*http.Response) (*Dataset, error)

CreateDataset - catalog service endpoint Creates a new dataset. Parameters:

datasetPost: JSON representation of the DatasetInfo to be persisted
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateDatasetImport

func (s *Service) CreateDatasetImport(datasetresource string, datasetImportedBy DatasetImportedBy, resp ...*http.Response) (*DatasetImportedBy, error)

CreateDatasetImport - catalog service endpoint Creates a new dataset import using the ID or resource name of the imported dataset. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
datasetImportedBy
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateFieldForDataset

func (s *Service) CreateFieldForDataset(datasetresource string, fieldPost FieldPost, resp ...*http.Response) (*Field, error)

CreateFieldForDataset - catalog service endpoint Adds a new field to the dataset with the specified ID or resource name. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
fieldPost: The JSON representation of the field to be persisted.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateRelationship

func (s *Service) CreateRelationship(relationshipPost RelationshipPost, resp ...*http.Response) (*Relationship, error)

CreateRelationship - catalog service endpoint Creates a new relationship. Parameters:

relationshipPost: The JSON representation of the relationship to persist.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) CreateRule

func (s *Service) CreateRule(rulePost RulePost, resp ...*http.Response) (*Rule, error)

CreateRule - catalog service endpoint Creates a new rule. Parameters:

rulePost: The JSON representation of the rule to be persisted.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteActionByIdForRule

func (s *Service) DeleteActionByIdForRule(ruleresource string, actionid string, resp ...*http.Response) error

DeleteActionByIdForRule - catalog service endpoint Deletes the action with the specified ID that is associated with the specified rule. Parameters:

ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
actionid: ID of an Action.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteAnnotationOfDashboard

func (s *Service) DeleteAnnotationOfDashboard(dashboardresource string, annotationid string, resp ...*http.Response) error

DeleteAnnotationOfDashboard - catalog service endpoint Deletes the annotation with the speciifed ID that is associted with the specified dashboard. Parameters:

dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
annotationid: ID of a annotation.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteAnnotationOfDataset

func (s *Service) DeleteAnnotationOfDataset(datasetresource string, annotationid string, resp ...*http.Response) error

DeleteAnnotationOfDataset - catalog service endpoint Deletes the annotation with the specified ID that is associated with the specified dataset. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
annotationid: ID of a annotation.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteDashboard

func (s *Service) DeleteDashboard(dashboardresource string, resp ...*http.Response) error

DeleteDashboard - catalog service endpoint Deletes the dashboard with the specified ID or resource name. Parameters:

dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteDataset

func (s *Service) DeleteDataset(datasetresource string, resp ...*http.Response) error

DeleteDataset - catalog service endpoint Deletes the dataset with the specified ID or resource name. Deleting a dataset also deletes its dependent objects, such as fields. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteFieldByIdForDataset

func (s *Service) DeleteFieldByIdForDataset(datasetresource string, fieldid string, resp ...*http.Response) error

DeleteFieldByIdForDataset - catalog service endpoint Deletes the field with the specified ID that is part of the specified dataset. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
fieldid: ID of a Field.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteRelationshipById

func (s *Service) DeleteRelationshipById(relationshipid string, resp ...*http.Response) error

DeleteRelationshipById - catalog service endpoint Deletes the relationship with the specified relationship ID. Deleting a relationship also deletes any objects that are dependents of that relationship, such as relationship fields. Parameters:

relationshipid: ID of a relationship.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) DeleteRule

func (s *Service) DeleteRule(ruleresource string, resp ...*http.Response) error

DeleteRule - catalog service endpoint Deletes the rule with the specfied ID or resource name. Deleting a rule also deleletes any objects that are dependents of that rule, such as rule actions. Parameters:

ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetActionByIdForRule

func (s *Service) GetActionByIdForRule(ruleresource string, actionid string, resp ...*http.Response) (*Action, error)

GetActionByIdForRule - catalog service endpoint Returns information about the action with the specified ID that is associated with the specified rule. Parameters:

ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
actionid: ID of an Action.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetDashboard

func (s *Service) GetDashboard(dashboardresource string, resp ...*http.Response) (*Dashboard, error)

GetDashboard - catalog service endpoint Returns information about the dashboard with the specified ID or resource name. Parameters:

dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetDataset

func (s *Service) GetDataset(datasetresource string, query *GetDatasetQueryParams, resp ...*http.Response) (*DatasetGet, error)

GetDataset - catalog service endpoint Returns information about the dataset with the specified ID or resource name. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetFieldById

func (s *Service) GetFieldById(fieldid string, resp ...*http.Response) (*Field, error)

GetFieldById - catalog service endpoint Returns the field with the specified ID. Parameters:

fieldid: ID of a Field.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetFieldByIdForDataset

func (s *Service) GetFieldByIdForDataset(datasetresource string, fieldid string, resp ...*http.Response) (*Field, error)

GetFieldByIdForDataset - catalog service endpoint Returns the field with the specified ID that is part of the specified dataset. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
fieldid: ID of a Field.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetRelationshipById

func (s *Service) GetRelationshipById(relationshipid string, resp ...*http.Response) (*Relationship, error)

GetRelationshipById - catalog service endpoint Returns the relationship with the specified relationship ID. Parameters:

relationshipid: ID of a relationship.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) GetRule

func (s *Service) GetRule(ruleresource string, resp ...*http.Response) (*Rule, error)

GetRule - catalog service endpoint Returns information about rule with the specified rule ID or resource name. Parameters:

ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ImportDataset

func (s *Service) ImportDataset(datasetresource string, datasetImportedBy DatasetImportedBy, resp ...*http.Response) (*DatasetImportedBy, error)

ImportDataset - catalog service endpoint Creates a new dataset import using the ID or resource name of the imported dataset. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
datasetImportedBy
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListActionsForRule

func (s *Service) ListActionsForRule(ruleresource string, query *ListActionsForRuleQueryParams, resp ...*http.Response) ([]Action, error)

ListActionsForRule - catalog service endpoint Returns the set of actions that are part of the specified rule. Parameters:

ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListAnnotations

func (s *Service) ListAnnotations(query *ListAnnotationsQueryParams, resp ...*http.Response) ([]Annotation, error)

ListAnnotations - catalog service endpoint Returns the set of annotations across all objects. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListAnnotationsForDashboard

func (s *Service) ListAnnotationsForDashboard(dashboardresource string, query *ListAnnotationsForDashboardQueryParams, resp ...*http.Response) ([]Annotation, error)

ListAnnotationsForDashboard - catalog service endpoint Returns the set of annotations that are associated with the specified dashboard. Parameters:

dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListAnnotationsForDataset

func (s *Service) ListAnnotationsForDataset(datasetresource string, query *ListAnnotationsForDatasetQueryParams, resp ...*http.Response) ([]Annotation, error)

ListAnnotationsForDataset - catalog service endpoint Returns the set of annotations that are associated with the specified dataset. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListDashboards

func (s *Service) ListDashboards(query *ListDashboardsQueryParams, resp ...*http.Response) ([]Dashboard, error)

ListDashboards - catalog service endpoint Returns a list of dashboards. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListDatasets

func (s *Service) ListDatasets(query *ListDatasetsQueryParams, resp ...*http.Response) ([]DatasetGet, error)

ListDatasets - catalog service endpoint Returns a list of all datasets. Use a filter to return a specific list of datasets. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListFields

func (s *Service) ListFields(query *ListFieldsQueryParams, resp ...*http.Response) ([]Field, error)

ListFields - catalog service endpoint Returns a list of all of the fields in the Metadata Catalog. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListFieldsForDataset

func (s *Service) ListFieldsForDataset(datasetresource string, query *ListFieldsForDatasetQueryParams, resp ...*http.Response) ([]Field, error)

ListFieldsForDataset - catalog service endpoint Returns the set of fields for the dataset with the specified ID or resource name. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListModules

func (s *Service) ListModules(query *ListModulesQueryParams, resp ...*http.Response) ([]Module, error)

ListModules - catalog service endpoint Returns a list of all modules. Use a filter to return a specific list of modules. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListRelationships

func (s *Service) ListRelationships(query *ListRelationshipsQueryParams, resp ...*http.Response) ([]Relationship, error)

ListRelationships - catalog service endpoint Returns a list of all relationships. Use a filter to return a specific list of relationships. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) ListRules

func (s *Service) ListRules(query *ListRulesQueryParams, resp ...*http.Response) ([]Rule, error)

ListRules - catalog service endpoint Returns a list of rules that match a filter, if specified, otherwise returns all rules. Parameters:

query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) UpdateActionByIdForRule

func (s *Service) UpdateActionByIdForRule(ruleresource string, actionid string, actionPatch ActionPatch, resp ...*http.Response) (*Action, error)

UpdateActionByIdForRule - catalog service endpoint Modifies the action with the specified ID that is associated with the specified rule. Parameters:

ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
actionid: ID of an Action.
actionPatch: The properties to update in the specified action.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) UpdateDashboard

func (s *Service) UpdateDashboard(dashboardresource string, dashboardPatch DashboardPatch, resp ...*http.Response) (*Dashboard, error)

UpdateDashboard - catalog service endpoint Modifies the dashboard with the specified ID or resource name. Parameters:

dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
dashboardPatch: An updated representation of the dashboard to be persisted.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) UpdateDataset

func (s *Service) UpdateDataset(datasetresource string, datasetPatch DatasetPatch, resp ...*http.Response) (*Dataset, error)

UpdateDataset - catalog service endpoint Modifies the dataset with the specified Dataset ID or Resource Name. For the default module, the resource name format is datasetName, otherwise, the resource name format is module.datasetName. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
datasetPatch: An updated representation of the dataset to be persisted.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) UpdateFieldByIdForDataset

func (s *Service) UpdateFieldByIdForDataset(datasetresource string, fieldid string, fieldPatch FieldPatch, resp ...*http.Response) (*Field, error)

UpdateFieldByIdForDataset - catalog service endpoint Modifies the field with the specified ID that is part of the specified dataset. Parameters:

datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
fieldid: ID of a Field.
fieldPatch: The properties to update in the specified field, or the requesting user lacks catalog.datasets.read permission for them.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) UpdateRelationshipById

func (s *Service) UpdateRelationshipById(relationshipid string, relationshipPatch RelationshipPatch, resp ...*http.Response) (*Relationship, error)

UpdateRelationshipById - catalog service endpoint Modifies the relationship with the specified relationship ID. Parameters:

relationshipid: ID of a relationship.
relationshipPatch: The properties to update in the specified relationship.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

func (*Service) UpdateRule

func (s *Service) UpdateRule(ruleresource string, rulePatch RulePatch, resp ...*http.Response) (*Rule, error)

UpdateRule - catalog service endpoint Modifies the rule with the specified rule ID or resource name. Parameters:

ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
rulePatch: The properties to update in the specified rule.
resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided

type Servicer

type Servicer interface {
	//interfaces that are auto-generated in interface_generated.go
	ServicerGenerated
}

Servicer represents the interface for implementing all endpoints for this service

type ServicerGenerated added in v1.10.0

type ServicerGenerated interface {
	/*
		CreateActionForRule - catalog service endpoint
		Creates a new action for the specified rule by rule id or resource name.
		Parameters:
			ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
			actionPost: The JSON representation of the action to be persisted.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateActionForRule(ruleresource string, actionPost ActionPost, resp ...*http.Response) (*Action, error)
	/*
		CreateAnnotationForDashboard - catalog service endpoint
		Creates a new annotation for the specified dashboard.
		Parameters:
			dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
			requestBody: The JSON representation of the annotation to be persisted.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateAnnotationForDashboard(dashboardresource string, requestBody map[string]string, resp ...*http.Response) (*Annotation, error)
	/*
		CreateAnnotationForDataset - catalog service endpoint
		Creates a new annotation for the specified dataset.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			requestBody: The JSON representation of the annotation to be persisted.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateAnnotationForDataset(datasetresource string, requestBody map[string]string, resp ...*http.Response) (*Annotation, error)
	/*
		CreateDashboard - catalog service endpoint
		Creates a new dashboard.
		Parameters:
			dashboardPost: The JSON representation of the Dashboard to be persisted.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateDashboard(dashboardPost DashboardPost, resp ...*http.Response) (*Dashboard, error)
	/*
		CreateDataset - catalog service endpoint
		Creates a new dataset.
		Parameters:
			datasetPost: JSON representation of the DatasetInfo to be persisted
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateDataset(datasetPost DatasetPost, resp ...*http.Response) (*Dataset, error)
	/*
		CreateDatasetImport - catalog service endpoint
		Creates a new dataset import using the ID or resource name of the imported dataset.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			datasetImportedBy
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateDatasetImport(datasetresource string, datasetImportedBy DatasetImportedBy, resp ...*http.Response) (*DatasetImportedBy, error)
	/*
		CreateFieldForDataset - catalog service endpoint
		Adds a new field to the dataset with the specified ID or resource name.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			fieldPost: The JSON representation of the field to be persisted.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateFieldForDataset(datasetresource string, fieldPost FieldPost, resp ...*http.Response) (*Field, error)
	/*
		CreateRelationship - catalog service endpoint
		Creates a new relationship.
		Parameters:
			relationshipPost: The JSON representation of the relationship to persist.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateRelationship(relationshipPost RelationshipPost, resp ...*http.Response) (*Relationship, error)
	/*
		CreateRule - catalog service endpoint
		Creates a new rule.
		Parameters:
			rulePost: The JSON representation of the rule to be persisted.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	CreateRule(rulePost RulePost, resp ...*http.Response) (*Rule, error)
	/*
		DeleteActionByIdForRule - catalog service endpoint
		Deletes the action with the specified ID that is associated with the specified rule.
		Parameters:
			ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
			actionid: ID of an Action.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteActionByIdForRule(ruleresource string, actionid string, resp ...*http.Response) error
	/*
		DeleteAnnotationOfDashboard - catalog service endpoint
		Deletes the annotation with the speciifed ID that is associted with the specified dashboard.
		Parameters:
			dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
			annotationid: ID of a annotation.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteAnnotationOfDashboard(dashboardresource string, annotationid string, resp ...*http.Response) error
	/*
		DeleteAnnotationOfDataset - catalog service endpoint
		Deletes the annotation with the specified ID that is associated with the specified dataset.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			annotationid: ID of a annotation.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteAnnotationOfDataset(datasetresource string, annotationid string, resp ...*http.Response) error
	/*
		DeleteDashboard - catalog service endpoint
		Deletes the dashboard with the specified ID or resource name.
		Parameters:
			dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteDashboard(dashboardresource string, resp ...*http.Response) error
	/*
		DeleteDataset - catalog service endpoint
		Deletes the dataset with the specified ID or resource name. Deleting a dataset also deletes its dependent objects, such as fields.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteDataset(datasetresource string, resp ...*http.Response) error
	/*
		DeleteFieldByIdForDataset - catalog service endpoint
		Deletes the field with the specified ID that is part of the specified dataset.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			fieldid: ID of a Field.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteFieldByIdForDataset(datasetresource string, fieldid string, resp ...*http.Response) error
	/*
		DeleteRelationshipById - catalog service endpoint
		Deletes the relationship with the specified relationship ID. Deleting a relationship also deletes any objects that are dependents of that relationship, such as relationship fields.
		Parameters:
			relationshipid: ID of a relationship.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteRelationshipById(relationshipid string, resp ...*http.Response) error
	/*
		DeleteRule - catalog service endpoint
		Deletes the rule with the specfied ID or resource name. Deleting a rule also deleletes any objects that are dependents of that rule, such as rule actions.
		Parameters:
			ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	DeleteRule(ruleresource string, resp ...*http.Response) error
	/*
		GetActionByIdForRule - catalog service endpoint
		Returns information about the action with the specified ID that is associated with the specified rule.
		Parameters:
			ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
			actionid: ID of an Action.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetActionByIdForRule(ruleresource string, actionid string, resp ...*http.Response) (*Action, error)
	/*
		GetDashboard - catalog service endpoint
		Returns information about the dashboard with the specified ID or resource name.
		Parameters:
			dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetDashboard(dashboardresource string, resp ...*http.Response) (*Dashboard, error)
	/*
		GetDataset - catalog service endpoint
		Returns information about the dataset with the specified ID or resource name. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetDataset(datasetresource string, query *GetDatasetQueryParams, resp ...*http.Response) (*DatasetGet, error)
	/*
		GetFieldById - catalog service endpoint
		Returns the field with the specified ID.
		Parameters:
			fieldid: ID of a Field.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetFieldById(fieldid string, resp ...*http.Response) (*Field, error)
	/*
		GetFieldByIdForDataset - catalog service endpoint
		Returns the field with the specified ID that is part of the specified dataset.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			fieldid: ID of a Field.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetFieldByIdForDataset(datasetresource string, fieldid string, resp ...*http.Response) (*Field, error)
	/*
		GetRelationshipById - catalog service endpoint
		Returns the relationship with the specified relationship ID.
		Parameters:
			relationshipid: ID of a relationship.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetRelationshipById(relationshipid string, resp ...*http.Response) (*Relationship, error)
	/*
		GetRule - catalog service endpoint
		Returns information about rule with the specified rule ID or resource name.
		Parameters:
			ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	GetRule(ruleresource string, resp ...*http.Response) (*Rule, error)
	/*
		ImportDataset - catalog service endpoint
		Creates a new dataset import using the ID or resource name of the imported dataset.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			datasetImportedBy
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ImportDataset(datasetresource string, datasetImportedBy DatasetImportedBy, resp ...*http.Response) (*DatasetImportedBy, error)
	/*
		ListActionsForRule - catalog service endpoint
		Returns the set of actions that are part of the specified rule.
		Parameters:
			ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListActionsForRule(ruleresource string, query *ListActionsForRuleQueryParams, resp ...*http.Response) ([]Action, error)
	/*
		ListAnnotations - catalog service endpoint
		Returns the set of annotations across all objects.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListAnnotations(query *ListAnnotationsQueryParams, resp ...*http.Response) ([]Annotation, error)
	/*
		ListAnnotationsForDashboard - catalog service endpoint
		Returns the set of annotations that are associated with the specified dashboard.
		Parameters:
			dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListAnnotationsForDashboard(dashboardresource string, query *ListAnnotationsForDashboardQueryParams, resp ...*http.Response) ([]Annotation, error)
	/*
		ListAnnotationsForDataset - catalog service endpoint
		Returns the set of annotations that are associated with the specified dataset.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListAnnotationsForDataset(datasetresource string, query *ListAnnotationsForDatasetQueryParams, resp ...*http.Response) ([]Annotation, error)
	/*
		ListDashboards - catalog service endpoint
		Returns a list of dashboards.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListDashboards(query *ListDashboardsQueryParams, resp ...*http.Response) ([]Dashboard, error)
	/*
		ListDatasets - catalog service endpoint
		Returns a list of all datasets. Use a filter to return a specific list of datasets.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListDatasets(query *ListDatasetsQueryParams, resp ...*http.Response) ([]DatasetGet, error)
	/*
		ListFields - catalog service endpoint
		Returns a list of all of the fields in the Metadata Catalog.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListFields(query *ListFieldsQueryParams, resp ...*http.Response) ([]Field, error)
	/*
		ListFieldsForDataset - catalog service endpoint
		Returns the set of fields for the dataset with the specified ID or resource name.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListFieldsForDataset(datasetresource string, query *ListFieldsForDatasetQueryParams, resp ...*http.Response) ([]Field, error)
	/*
		ListModules - catalog service endpoint
		Returns a list of all modules. Use a filter to return a specific list of modules.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListModules(query *ListModulesQueryParams, resp ...*http.Response) ([]Module, error)
	/*
		ListRelationships - catalog service endpoint
		Returns a list of all relationships. Use a filter to return a specific list of relationships.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRelationships(query *ListRelationshipsQueryParams, resp ...*http.Response) ([]Relationship, error)
	/*
		ListRules - catalog service endpoint
		Returns a list of rules that match a filter, if specified, otherwise returns all rules.
		Parameters:
			query: a struct pointer of valid query parameters for the endpoint, nil to send no query parameters
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	ListRules(query *ListRulesQueryParams, resp ...*http.Response) ([]Rule, error)
	/*
		UpdateActionByIdForRule - catalog service endpoint
		Modifies the action with the specified ID that is associated with the specified rule.
		Parameters:
			ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
			actionid: ID of an Action.
			actionPatch: The properties to update in the specified action.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateActionByIdForRule(ruleresource string, actionid string, actionPatch ActionPatch, resp ...*http.Response) (*Action, error)
	/*
		UpdateDashboard - catalog service endpoint
		Modifies the dashboard with the specified ID or resource name.
		Parameters:
			dashboardresource: ID or the resource name of a dashvboard. The resource name format is module.dashboardname.
			dashboardPatch: An updated representation of the dashboard to be persisted.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateDashboard(dashboardresource string, dashboardPatch DashboardPatch, resp ...*http.Response) (*Dashboard, error)
	/*
		UpdateDataset - catalog service endpoint
		Modifies the dataset with the specified Dataset ID or Resource Name. For the default module, the resource name format is datasetName, otherwise, the resource name format is module.datasetName.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			datasetPatch: An updated representation of the dataset to be persisted.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateDataset(datasetresource string, datasetPatch DatasetPatch, resp ...*http.Response) (*Dataset, error)
	/*
		UpdateFieldByIdForDataset - catalog service endpoint
		Modifies the field with the specified ID that is part of the specified dataset.
		Parameters:
			datasetresource: ID of a Dataset or the resource name of a dataset. For the default module, the resource name format is datasetName. Otherwise, the resource name format is module.datasetName.
			fieldid: ID of a Field.
			fieldPatch: The properties to update in the specified field, or the requesting user lacks catalog.datasets.read permission for them.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateFieldByIdForDataset(datasetresource string, fieldid string, fieldPatch FieldPatch, resp ...*http.Response) (*Field, error)
	/*
		UpdateRelationshipById - catalog service endpoint
		Modifies the relationship with the specified relationship ID.
		Parameters:
			relationshipid: ID of a relationship.
			relationshipPatch: The properties to update in the specified relationship.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateRelationshipById(relationshipid string, relationshipPatch RelationshipPatch, resp ...*http.Response) (*Relationship, error)
	/*
		UpdateRule - catalog service endpoint
		Modifies the rule with the specified rule ID or resource name.
		Parameters:
			ruleresource: The ID or resource name of a rule. For the default module, the resource name format is ruleName. Otherwise, the resource name format is module.ruleName.
			rulePatch: The properties to update in the specified rule.
			resp: an optional pointer to a http.Response to be populated by this method. NOTE: only the first resp pointer will be used if multiple are provided
	*/
	UpdateRule(ruleresource string, rulePatch RulePatch, resp ...*http.Response) (*Rule, error)
}

ServicerGenerated represents the interface for implementing all endpoints for this service

type Splv1sinkDataset added in v1.8.0

type Splv1sinkDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// A unique dataset ID.
	Id   string               `json:"id"`
	Kind Splv1sinkDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// Internal use by common-ast, contains the converted SPL for a SPL2 search query.
	Splv1 string `json:"splv1"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete catalog dataset as rendered in GET responses.

type Splv1sinkDatasetKind added in v1.8.0

type Splv1sinkDatasetKind string

Splv1sinkDatasetKind : The dataset kind.

const (
	Splv1sinkDatasetKindSplv1sink Splv1sinkDatasetKind = "splv1sink"
)

List of Splv1sinkDatasetKind

type Splv1sinkDatasetProperties added in v1.8.0

type Splv1sinkDatasetProperties struct {
	Kind *Splv1sinkDatasetKind `json:"kind,omitempty"`
	// Internal use by common-ast, contains the converted SPL for a SPL2 search query.
	Splv1 *string `json:"splv1,omitempty"`
}

Properties of splv1sink datasets which can be read through the API.

type UserMetadataProperties

type UserMetadataProperties struct {
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the object's owner.
	Owner string `json:"owner"`
}

Owner, createdby, and modifiedby user name properties for inclusion in other objects.

type ViewDataset

type ViewDataset struct {
	// The date and time object was created.
	Created string `json:"created"`
	// The name of the user who created the object. This value is obtained from the bearer token and may not be changed.
	Createdby string `json:"createdby"`
	// A unique dataset ID.
	Id   string          `json:"id"`
	Kind ViewDatasetKind `json:"kind"`
	// The date and time object was modified.
	Modified string `json:"modified"`
	// The name of the user who most recently modified the object.
	Modifiedby string `json:"modifiedby"`
	// The name of the module that contains the dataset.
	Module string `json:"module"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// The name of the object's owner.
	Owner string `json:"owner"`
	// The dataset name qualified by the module name.
	Resourcename string `json:"resourcename"`
	// A valid SPL-defined search.
	Search string `json:"search"`
	// AppClinetId of the creator app of the dataset.
	Appclientidcreatedby *string `json:"appclientidcreatedby,omitempty"`
	// AppClinetId of the modifier app of the dataset.
	Appclientidmodifiedby *string `json:"appclientidmodifiedby,omitempty"`
	// Detailed description of the dataset.
	Description *string `json:"description,omitempty"`
	// The dataset name qualified by the module name, primarily used to distinguish between index/metric versus other datasets. Index/metric datasets have a distinct underscore separator (_____) between name and module. Internal use only.
	Internalname *string `json:"internalname,omitempty"`
	// Summary of the dataset's purpose.
	Summary *string `json:"summary,omitempty"`
	// The title of the dataset.  Does not have to be unique.
	Title *string `json:"title,omitempty"`
	// The catalog version.
	Version *int32 `json:"version,omitempty"`
}

A complete view dataset as rendered in POST, PATCH, and GET responses.

type ViewDatasetKind

type ViewDatasetKind string

ViewDatasetKind : The dataset kind.

const (
	ViewDatasetKindView ViewDatasetKind = "view"
)

List of ViewDatasetKind

type ViewDatasetPatch

type ViewDatasetPatch struct {
	Kind *ViewDatasetKind `json:"kind,omitempty"`
	// The name of module to reassign dataset into.
	Module *string `json:"module,omitempty"`
	// The dataset name. Dataset names must be unique within each module.
	Name *string `json:"name,omitempty"`
	// The name of the dataset owner. This value is obtained from the bearer token.
	Owner *string `json:"owner,omitempty"`
	// A valid SPL-defined search.
	Search *string `json:"search,omitempty"`
}

Property values to be set in an existing view dataset using a PATCH request.

type ViewDatasetPost

type ViewDatasetPost struct {
	Kind ViewDatasetKind `json:"kind"`
	// The dataset name. Dataset names must be unique within each module.
	Name string `json:"name"`
	// A valid SPL-defined search.
	Search string `json:"search"`
	// The fields to be associated with this dataset.
	Fields []FieldPost `json:"fields,omitempty"`
	// A unique dataset ID. Random ID used if not provided.
	Id *string `json:"id,omitempty"`
	// The name of the module to create the new dataset in.
	Module *string `json:"module,omitempty"`
}

Initial property values for creating a new view dataset using a POST request.

type ViewDatasetProperties

type ViewDatasetProperties struct {
	Kind *ViewDatasetKind `json:"kind,omitempty"`
	// A valid SPL-defined search.
	Search *string `json:"search,omitempty"`
}

Properties of job datasets which may be read, set, and changed through the API. Implementation detail of DatasetPOST, DatasetPATCH, and Dataset, do not use directly.

Jump to

Keyboard shortcuts

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