jobcontrol

package
v0.5.0 Latest Latest
Warning

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

Go to latest
Published: Feb 17, 2025 License: MIT Imports: 20 Imported by: 0

README

Go API client for jobcontrol

Saviynt Job Control API Spec

Overview

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

  • API version: 1.0
  • Package version: 1.0.0
  • Generator version: 7.10.0
  • Build package: org.openapitools.codegen.languages.GoClientCodegen

Installation

Install the following dependencies:

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

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

import jobcontrol "github.com/GIT_USER_ID/GIT_REPO_ID"

To use a proxy, set the environment variable HTTP_PROXY:

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

Configuration of Server URL

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

Select Server Configuration

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

ctx := context.WithValue(context.Background(), jobcontrol.ContextServerIndex, 1)
Templated Server URL

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

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

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

URLs Configuration per Operation

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

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

Documentation for API Endpoints

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

Class Method HTTP request Description
JobControlAPI CheckJobStatus Post /ECM/api/v5/checkJobStatus Check Job Status
JobControlAPI CreateTriggers Post /ECM/api/v5/createTriggers Create Triggers
JobControlAPI CreateUpdateTrigger Post /ECM/api/v5/createUpdateTrigger Create and Update Trigger
JobControlAPI DeleteTrigger Post /ECM/api/v5/deleteTrigger Delete Trigger
JobControlAPI FetchJobMetadata Post /ECM/api/v5/fetchJobMetadata Fetch Job Metadata
JobControlAPI ResumePauseJobs Post /ECM/api/v5/resumePauseJobs Resume Pause Jobs
JobControlAPI RunJobTrigger Post /ECM/api/v5/runJobTrigger Run Job Trigger

Documentation For Models

Documentation For Authorization

Endpoints do not require authorization.

Documentation for Utility Methods

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

  • PtrBool
  • PtrInt
  • PtrInt32
  • PtrInt64
  • PtrFloat
  • PtrFloat32
  • PtrFloat64
  • PtrString
  • PtrTime

Author

https://github.com/saviynt

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	JsonCheck = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?json)`)
	XmlCheck  = regexp.MustCompile(`(?i:(?:application|text)/(?:[^;]+\+)?xml)`)
)
View Source
var (
	// ContextServerIndex uses a server configuration from the index.
	ContextServerIndex = contextKey("serverIndex")

	// ContextOperationServerIndices uses a server configuration from the index mapping.
	ContextOperationServerIndices = contextKey("serverOperationIndices")

	// ContextServerVariables overrides a server configuration variables.
	ContextServerVariables = contextKey("serverVariables")

	// ContextOperationServerVariables overrides a server configuration variables using operation specific values.
	ContextOperationServerVariables = contextKey("serverOperationVariables")
)

Functions

func CacheExpires

func CacheExpires(r *http.Response) time.Time

CacheExpires helper function to determine remaining time before repeating a request.

func IsNil

func IsNil(i interface{}) bool

IsNil checks if an input is nil

func PtrBool

func PtrBool(v bool) *bool

PtrBool is a helper routine that returns a pointer to given boolean value.

func PtrFloat32

func PtrFloat32(v float32) *float32

PtrFloat32 is a helper routine that returns a pointer to given float value.

func PtrFloat64

func PtrFloat64(v float64) *float64

PtrFloat64 is a helper routine that returns a pointer to given float value.

func PtrInt

func PtrInt(v int) *int

PtrInt is a helper routine that returns a pointer to given integer value.

func PtrInt32

func PtrInt32(v int32) *int32

PtrInt32 is a helper routine that returns a pointer to given integer value.

func PtrInt64

func PtrInt64(v int64) *int64

PtrInt64 is a helper routine that returns a pointer to given integer value.

func PtrString

func PtrString(v string) *string

PtrString is a helper routine that returns a pointer to given string value.

func PtrTime

func PtrTime(v time.Time) *time.Time

PtrTime is helper routine that returns a pointer to given Time value.

Types

type APIClient

type APIClient struct {
	JobControlAPI *JobControlAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Saviynt Job Control API API v1.0 In most cases there should be only one, shared, APIClient.

func NewAPIClient

func NewAPIClient(cfg *Configuration) *APIClient

NewAPIClient creates a new API client. Requires a userAgent string describing your application. optionally a custom http.Client to allow for advanced features such as caching.

func (*APIClient) GetConfig

func (c *APIClient) GetConfig() *Configuration

Allow modification of underlying config for alternate implementations and testing Caution: modifying the configuration while live can cause data races and potentially unwanted behavior

type APIKey

type APIKey struct {
	Key    string
	Prefix string
}

APIKey provides API key based authentication to a request passed via context using ContextAPIKey

type APIResponse

type APIResponse struct {
	*http.Response `json:"-"`
	Message        string `json:"message,omitempty"`
	// Operation is the name of the OpenAPI operation.
	Operation string `json:"operation,omitempty"`
	// RequestURL is the request URL. This value is always available, even if the
	// embedded *http.Response is nil.
	RequestURL string `json:"url,omitempty"`
	// Method is the HTTP method used for the request.  This value is always
	// available, even if the embedded *http.Response is nil.
	Method string `json:"method,omitempty"`
	// Payload holds the contents of the response body (which may be nil or empty).
	// This is provided here as the raw response.Body() reader will have already
	// been drained.
	Payload []byte `json:"-"`
}

APIResponse stores the API response returned by the server.

func NewAPIResponse

func NewAPIResponse(r *http.Response) *APIResponse

NewAPIResponse returns a new APIResponse object.

func NewAPIResponseWithError

func NewAPIResponseWithError(errorMessage string) *APIResponse

NewAPIResponseWithError returns a new APIResponse object with the provided error message.

type ApiCheckJobStatusRequest

type ApiCheckJobStatusRequest struct {
	ApiService *JobControlAPIService
	// contains filtered or unexported fields
}

func (ApiCheckJobStatusRequest) Execute

func (ApiCheckJobStatusRequest) Jobgroup

func (ApiCheckJobStatusRequest) Jobname

type ApiCreateTriggersRequest

type ApiCreateTriggersRequest struct {
	ApiService *JobControlAPIService
	// contains filtered or unexported fields
}

func (ApiCreateTriggersRequest) Execute

func (r ApiCreateTriggersRequest) Execute() (*http.Response, error)

type ApiCreateUpdateTriggerRequest

type ApiCreateUpdateTriggerRequest struct {
	ApiService *JobControlAPIService
	// contains filtered or unexported fields
}

func (ApiCreateUpdateTriggerRequest) Execute

type ApiDeleteTriggerRequest

type ApiDeleteTriggerRequest struct {
	ApiService *JobControlAPIService
	// contains filtered or unexported fields
}

func (ApiDeleteTriggerRequest) Execute

func (r ApiDeleteTriggerRequest) Execute() (*http.Response, error)

type ApiFetchJobMetadataRequest

type ApiFetchJobMetadataRequest struct {
	ApiService *JobControlAPIService
	// contains filtered or unexported fields
}

func (ApiFetchJobMetadataRequest) Execute

func (ApiFetchJobMetadataRequest) FetchJobMetadataRequest

func (r ApiFetchJobMetadataRequest) FetchJobMetadataRequest(fetchJobMetadataRequest FetchJobMetadataRequest) ApiFetchJobMetadataRequest

type ApiResumePauseJobsRequest

type ApiResumePauseJobsRequest struct {
	ApiService *JobControlAPIService
	// contains filtered or unexported fields
}

func (ApiResumePauseJobsRequest) Execute

func (ApiResumePauseJobsRequest) ResumePauseJobsRequest

func (r ApiResumePauseJobsRequest) ResumePauseJobsRequest(resumePauseJobsRequest ResumePauseJobsRequest) ApiResumePauseJobsRequest

type ApiRunJobTriggerRequest

type ApiRunJobTriggerRequest struct {
	ApiService *JobControlAPIService
	// contains filtered or unexported fields
}

func (ApiRunJobTriggerRequest) Execute

func (r ApiRunJobTriggerRequest) Execute() (*http.Response, error)

type BasicAuth

type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth

type CheckJobStatusResponse

type CheckJobStatusResponse struct {
	Msg       *string `json:"msg,omitempty"`
	ErrorCode *string `json:"errorCode,omitempty"`
}

CheckJobStatusResponse struct for CheckJobStatusResponse

func NewCheckJobStatusResponse

func NewCheckJobStatusResponse() *CheckJobStatusResponse

NewCheckJobStatusResponse instantiates a new CheckJobStatusResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewCheckJobStatusResponseWithDefaults

func NewCheckJobStatusResponseWithDefaults() *CheckJobStatusResponse

NewCheckJobStatusResponseWithDefaults instantiates a new CheckJobStatusResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*CheckJobStatusResponse) GetErrorCode

func (o *CheckJobStatusResponse) GetErrorCode() string

GetErrorCode returns the ErrorCode field value if set, zero value otherwise.

func (*CheckJobStatusResponse) GetErrorCodeOk

func (o *CheckJobStatusResponse) GetErrorCodeOk() (*string, bool)

GetErrorCodeOk returns a tuple with the ErrorCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckJobStatusResponse) GetMsg

func (o *CheckJobStatusResponse) GetMsg() string

GetMsg returns the Msg field value if set, zero value otherwise.

func (*CheckJobStatusResponse) GetMsgOk

func (o *CheckJobStatusResponse) GetMsgOk() (*string, bool)

GetMsgOk returns a tuple with the Msg field value if set, nil otherwise and a boolean to check if the value has been set.

func (*CheckJobStatusResponse) HasErrorCode

func (o *CheckJobStatusResponse) HasErrorCode() bool

HasErrorCode returns a boolean if a field has been set.

func (*CheckJobStatusResponse) HasMsg

func (o *CheckJobStatusResponse) HasMsg() bool

HasMsg returns a boolean if a field has been set.

func (CheckJobStatusResponse) MarshalJSON

func (o CheckJobStatusResponse) MarshalJSON() ([]byte, error)

func (*CheckJobStatusResponse) SetErrorCode

func (o *CheckJobStatusResponse) SetErrorCode(v string)

SetErrorCode gets a reference to the given string and assigns it to the ErrorCode field.

func (*CheckJobStatusResponse) SetMsg

func (o *CheckJobStatusResponse) SetMsg(v string)

SetMsg gets a reference to the given string and assigns it to the Msg field.

func (CheckJobStatusResponse) ToMap

func (o CheckJobStatusResponse) ToMap() (map[string]interface{}, error)

type Configuration

type Configuration struct {
	Host             string            `json:"host,omitempty"`
	Scheme           string            `json:"scheme,omitempty"`
	DefaultHeader    map[string]string `json:"defaultHeader,omitempty"`
	UserAgent        string            `json:"userAgent,omitempty"`
	Debug            bool              `json:"debug,omitempty"`
	Servers          ServerConfigurations
	OperationServers map[string]ServerConfigurations
	HTTPClient       *http.Client
}

Configuration stores the configuration of the API client

func NewConfiguration

func NewConfiguration() *Configuration

NewConfiguration returns a new Configuration object

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

func (*Configuration) ServerURL

func (c *Configuration) ServerURL(index int, variables map[string]string) (string, error)

ServerURL returns URL based on server settings

func (*Configuration) ServerURLWithContext

func (c *Configuration) ServerURLWithContext(ctx context.Context, endpoint string) (string, error)

ServerURLWithContext returns a new server URL given an endpoint

type DeleteTriggerRequest

type DeleteTriggerRequest struct {
	Jobname     string  `json:"jobname"`
	Triggername *string `json:"triggername,omitempty"`
	Jobgroup    *string `json:"jobgroup,omitempty"`
}

DeleteTriggerRequest struct for DeleteTriggerRequest

func NewDeleteTriggerRequest

func NewDeleteTriggerRequest(jobname string) *DeleteTriggerRequest

NewDeleteTriggerRequest instantiates a new DeleteTriggerRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDeleteTriggerRequestWithDefaults

func NewDeleteTriggerRequestWithDefaults() *DeleteTriggerRequest

NewDeleteTriggerRequestWithDefaults instantiates a new DeleteTriggerRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DeleteTriggerRequest) GetJobgroup

func (o *DeleteTriggerRequest) GetJobgroup() string

GetJobgroup returns the Jobgroup field value if set, zero value otherwise.

func (*DeleteTriggerRequest) GetJobgroupOk

func (o *DeleteTriggerRequest) GetJobgroupOk() (*string, bool)

GetJobgroupOk returns a tuple with the Jobgroup field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteTriggerRequest) GetJobname

func (o *DeleteTriggerRequest) GetJobname() string

GetJobname returns the Jobname field value

func (*DeleteTriggerRequest) GetJobnameOk

func (o *DeleteTriggerRequest) GetJobnameOk() (*string, bool)

GetJobnameOk returns a tuple with the Jobname field value and a boolean to check if the value has been set.

func (*DeleteTriggerRequest) GetTriggername

func (o *DeleteTriggerRequest) GetTriggername() string

GetTriggername returns the Triggername field value if set, zero value otherwise.

func (*DeleteTriggerRequest) GetTriggernameOk

func (o *DeleteTriggerRequest) GetTriggernameOk() (*string, bool)

GetTriggernameOk returns a tuple with the Triggername field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteTriggerRequest) HasJobgroup

func (o *DeleteTriggerRequest) HasJobgroup() bool

HasJobgroup returns a boolean if a field has been set.

func (*DeleteTriggerRequest) HasTriggername

func (o *DeleteTriggerRequest) HasTriggername() bool

HasTriggername returns a boolean if a field has been set.

func (DeleteTriggerRequest) MarshalJSON

func (o DeleteTriggerRequest) MarshalJSON() ([]byte, error)

func (*DeleteTriggerRequest) SetJobgroup

func (o *DeleteTriggerRequest) SetJobgroup(v string)

SetJobgroup gets a reference to the given string and assigns it to the Jobgroup field.

func (*DeleteTriggerRequest) SetJobname

func (o *DeleteTriggerRequest) SetJobname(v string)

SetJobname sets field value

func (*DeleteTriggerRequest) SetTriggername

func (o *DeleteTriggerRequest) SetTriggername(v string)

SetTriggername gets a reference to the given string and assigns it to the Triggername field.

func (DeleteTriggerRequest) ToMap

func (o DeleteTriggerRequest) ToMap() (map[string]interface{}, error)

func (*DeleteTriggerRequest) UnmarshalJSON

func (o *DeleteTriggerRequest) UnmarshalJSON(data []byte) (err error)

type DeleteTriggerResponse

type DeleteTriggerResponse struct {
	Msg       *string `json:"msg,omitempty"`
	ErrorCode *string `json:"errorCode,omitempty"`
}

DeleteTriggerResponse struct for DeleteTriggerResponse

func NewDeleteTriggerResponse

func NewDeleteTriggerResponse() *DeleteTriggerResponse

NewDeleteTriggerResponse instantiates a new DeleteTriggerResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewDeleteTriggerResponseWithDefaults

func NewDeleteTriggerResponseWithDefaults() *DeleteTriggerResponse

NewDeleteTriggerResponseWithDefaults instantiates a new DeleteTriggerResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*DeleteTriggerResponse) GetErrorCode

func (o *DeleteTriggerResponse) GetErrorCode() string

GetErrorCode returns the ErrorCode field value if set, zero value otherwise.

func (*DeleteTriggerResponse) GetErrorCodeOk

func (o *DeleteTriggerResponse) GetErrorCodeOk() (*string, bool)

GetErrorCodeOk returns a tuple with the ErrorCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteTriggerResponse) GetMsg

func (o *DeleteTriggerResponse) GetMsg() string

GetMsg returns the Msg field value if set, zero value otherwise.

func (*DeleteTriggerResponse) GetMsgOk

func (o *DeleteTriggerResponse) GetMsgOk() (*string, bool)

GetMsgOk returns a tuple with the Msg field value if set, nil otherwise and a boolean to check if the value has been set.

func (*DeleteTriggerResponse) HasErrorCode

func (o *DeleteTriggerResponse) HasErrorCode() bool

HasErrorCode returns a boolean if a field has been set.

func (*DeleteTriggerResponse) HasMsg

func (o *DeleteTriggerResponse) HasMsg() bool

HasMsg returns a boolean if a field has been set.

func (DeleteTriggerResponse) MarshalJSON

func (o DeleteTriggerResponse) MarshalJSON() ([]byte, error)

func (*DeleteTriggerResponse) SetErrorCode

func (o *DeleteTriggerResponse) SetErrorCode(v string)

SetErrorCode gets a reference to the given string and assigns it to the ErrorCode field.

func (*DeleteTriggerResponse) SetMsg

func (o *DeleteTriggerResponse) SetMsg(v string)

SetMsg gets a reference to the given string and assigns it to the Msg field.

func (DeleteTriggerResponse) ToMap

func (o DeleteTriggerResponse) ToMap() (map[string]interface{}, error)

type FetchJobMetadataRequest

type FetchJobMetadataRequest struct {
	Jobname     string  `json:"jobname"`
	Triggername *string `json:"triggername,omitempty"`
	Jobgroup    *string `json:"jobgroup,omitempty"`
}

FetchJobMetadataRequest

func NewFetchJobMetadataRequest

func NewFetchJobMetadataRequest(jobname string) *FetchJobMetadataRequest

NewFetchJobMetadataRequest instantiates a new FetchJobMetadataRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFetchJobMetadataRequestWithDefaults

func NewFetchJobMetadataRequestWithDefaults() *FetchJobMetadataRequest

NewFetchJobMetadataRequestWithDefaults instantiates a new FetchJobMetadataRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*FetchJobMetadataRequest) GetJobgroup

func (o *FetchJobMetadataRequest) GetJobgroup() string

GetJobgroup returns the Jobgroup field value if set, zero value otherwise.

func (*FetchJobMetadataRequest) GetJobgroupOk

func (o *FetchJobMetadataRequest) GetJobgroupOk() (*string, bool)

GetJobgroupOk returns a tuple with the Jobgroup field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FetchJobMetadataRequest) GetJobname

func (o *FetchJobMetadataRequest) GetJobname() string

GetJobname returns the Jobname field value

func (*FetchJobMetadataRequest) GetJobnameOk

func (o *FetchJobMetadataRequest) GetJobnameOk() (*string, bool)

GetJobnameOk returns a tuple with the Jobname field value and a boolean to check if the value has been set.

func (*FetchJobMetadataRequest) GetTriggername

func (o *FetchJobMetadataRequest) GetTriggername() string

GetTriggername returns the Triggername field value if set, zero value otherwise.

func (*FetchJobMetadataRequest) GetTriggernameOk

func (o *FetchJobMetadataRequest) GetTriggernameOk() (*string, bool)

GetTriggernameOk returns a tuple with the Triggername field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FetchJobMetadataRequest) HasJobgroup

func (o *FetchJobMetadataRequest) HasJobgroup() bool

HasJobgroup returns a boolean if a field has been set.

func (*FetchJobMetadataRequest) HasTriggername

func (o *FetchJobMetadataRequest) HasTriggername() bool

HasTriggername returns a boolean if a field has been set.

func (FetchJobMetadataRequest) MarshalJSON

func (o FetchJobMetadataRequest) MarshalJSON() ([]byte, error)

func (*FetchJobMetadataRequest) SetJobgroup

func (o *FetchJobMetadataRequest) SetJobgroup(v string)

SetJobgroup gets a reference to the given string and assigns it to the Jobgroup field.

func (*FetchJobMetadataRequest) SetJobname

func (o *FetchJobMetadataRequest) SetJobname(v string)

SetJobname sets field value

func (*FetchJobMetadataRequest) SetTriggername

func (o *FetchJobMetadataRequest) SetTriggername(v string)

SetTriggername gets a reference to the given string and assigns it to the Triggername field.

func (FetchJobMetadataRequest) ToMap

func (o FetchJobMetadataRequest) ToMap() (map[string]interface{}, error)

func (*FetchJobMetadataRequest) UnmarshalJSON

func (o *FetchJobMetadataRequest) UnmarshalJSON(data []byte) (err error)

type FetchJobMetadataResponse

type FetchJobMetadataResponse struct {
	Msg       *string                `json:"msg,omitempty"`
	ErrorCode *int32                 `json:"errorCode,omitempty"`
	Result    map[string]interface{} `json:"result,omitempty"`
}

FetchJobMetadataResponse struct for FetchJobMetadataResponse

func NewFetchJobMetadataResponse

func NewFetchJobMetadataResponse() *FetchJobMetadataResponse

NewFetchJobMetadataResponse instantiates a new FetchJobMetadataResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewFetchJobMetadataResponseWithDefaults

func NewFetchJobMetadataResponseWithDefaults() *FetchJobMetadataResponse

NewFetchJobMetadataResponseWithDefaults instantiates a new FetchJobMetadataResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*FetchJobMetadataResponse) GetErrorCode

func (o *FetchJobMetadataResponse) GetErrorCode() int32

GetErrorCode returns the ErrorCode field value if set, zero value otherwise.

func (*FetchJobMetadataResponse) GetErrorCodeOk

func (o *FetchJobMetadataResponse) GetErrorCodeOk() (*int32, bool)

GetErrorCodeOk returns a tuple with the ErrorCode field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FetchJobMetadataResponse) GetMsg

func (o *FetchJobMetadataResponse) GetMsg() string

GetMsg returns the Msg field value if set, zero value otherwise.

func (*FetchJobMetadataResponse) GetMsgOk

func (o *FetchJobMetadataResponse) GetMsgOk() (*string, bool)

GetMsgOk returns a tuple with the Msg field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FetchJobMetadataResponse) GetResult

func (o *FetchJobMetadataResponse) GetResult() map[string]interface{}

GetResult returns the Result field value if set, zero value otherwise.

func (*FetchJobMetadataResponse) GetResultOk

func (o *FetchJobMetadataResponse) GetResultOk() (map[string]interface{}, bool)

GetResultOk returns a tuple with the Result field value if set, nil otherwise and a boolean to check if the value has been set.

func (*FetchJobMetadataResponse) HasErrorCode

func (o *FetchJobMetadataResponse) HasErrorCode() bool

HasErrorCode returns a boolean if a field has been set.

func (*FetchJobMetadataResponse) HasMsg

func (o *FetchJobMetadataResponse) HasMsg() bool

HasMsg returns a boolean if a field has been set.

func (*FetchJobMetadataResponse) HasResult

func (o *FetchJobMetadataResponse) HasResult() bool

HasResult returns a boolean if a field has been set.

func (FetchJobMetadataResponse) MarshalJSON

func (o FetchJobMetadataResponse) MarshalJSON() ([]byte, error)

func (*FetchJobMetadataResponse) SetErrorCode

func (o *FetchJobMetadataResponse) SetErrorCode(v int32)

SetErrorCode gets a reference to the given int32 and assigns it to the ErrorCode field.

func (*FetchJobMetadataResponse) SetMsg

func (o *FetchJobMetadataResponse) SetMsg(v string)

SetMsg gets a reference to the given string and assigns it to the Msg field.

func (*FetchJobMetadataResponse) SetResult

func (o *FetchJobMetadataResponse) SetResult(v map[string]interface{})

SetResult gets a reference to the given map[string]interface{} and assigns it to the Result field.

func (FetchJobMetadataResponse) ToMap

func (o FetchJobMetadataResponse) ToMap() (map[string]interface{}, error)

type GenericOpenAPIError

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

GenericOpenAPIError Provides access to the body, error and model on returned errors.

func (GenericOpenAPIError) Body

func (e GenericOpenAPIError) Body() []byte

Body returns the raw bytes of the response

func (GenericOpenAPIError) Error

func (e GenericOpenAPIError) Error() string

Error returns non-empty string if there was an error.

func (GenericOpenAPIError) Model

func (e GenericOpenAPIError) Model() interface{}

Model returns the unpacked model of the error

type JobControlAPIService

type JobControlAPIService service

JobControlAPIService JobControlAPI service

func (*JobControlAPIService) CheckJobStatus

CheckJobStatus Check Job Status

This API is used to fetch the status of any job other than Data Import Job.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCheckJobStatusRequest

func (*JobControlAPIService) CheckJobStatusExecute

Execute executes the request

@return CheckJobStatusResponse

func (*JobControlAPIService) CreateTriggers

CreateTriggers Create Triggers

This API is used to create job triggers.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateTriggersRequest

func (*JobControlAPIService) CreateTriggersExecute

func (a *JobControlAPIService) CreateTriggersExecute(r ApiCreateTriggersRequest) (*http.Response, error)

Execute executes the request

func (*JobControlAPIService) CreateUpdateTrigger

CreateUpdateTrigger Create and Update Trigger

This API call can be used to create and update a trigger for a particular `jobgroup` in Saviynt.

Starting with Release v24.7, a new `analysistypes` parameter has been introduced for the **Recommendations** job. To execute an analysis type using this API, you can use the `analysistypes` parameter and specify the following values in its request:

* 0 – Run All Steps * 1 – Run Attribute Discovery * 2 – Generate Correlation Rules * 3 – Rule Consolidation for Access * 4 – Rule Consolidation for Apps * 5 – Compute Access Confidence * 6 – Compute Model Performance Statistics * 7 – Incremental Rule Creation

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiCreateUpdateTriggerRequest

func (*JobControlAPIService) CreateUpdateTriggerExecute

func (a *JobControlAPIService) CreateUpdateTriggerExecute(r ApiCreateUpdateTriggerRequest) (*http.Response, error)

Execute executes the request

func (*JobControlAPIService) DeleteTrigger

DeleteTrigger Delete Trigger

This API call can be used to delete a trigger for a particular "jobgroup" in Saviynt.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiDeleteTriggerRequest

func (*JobControlAPIService) DeleteTriggerExecute

func (a *JobControlAPIService) DeleteTriggerExecute(r ApiDeleteTriggerRequest) (*http.Response, error)

Execute executes the request

func (*JobControlAPIService) FetchJobMetadata

FetchJobMetadata Fetch Job Metadata

This API call return job metadata for the last run of a job in Saviynt.

Note: The structure of the result param in response can change based upon the Job History saved in Saviynt

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiFetchJobMetadataRequest

func (*JobControlAPIService) FetchJobMetadataExecute

Execute executes the request

@return FetchJobMetadataResponse

func (*JobControlAPIService) ResumePauseJobs

ResumePauseJobs Resume Pause Jobs

Starting with Release v23.10, the `resumePauseJobs` API enables you to pause jobs based on their job type and job name.

When a job is paused, its status is displayed as Paused on the Job Control Panel page.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiResumePauseJobsRequest

func (*JobControlAPIService) ResumePauseJobsExecute

func (a *JobControlAPIService) ResumePauseJobsExecute(r ApiResumePauseJobsRequest) (string, *http.Response, error)

Execute executes the request

@return string

func (*JobControlAPIService) RunJobTrigger

RunJobTrigger Run Job Trigger

This API call can be used to run a job trigger in Saviynt.

The following cases illustrate different scenarios on the usage of the `analyticsAdvanceQuery` parameter in the API:

* Case 1: When you configure the `analyticsAdvanceQuery` within the payload, set the `defaultActionForAnalytics` as `"true"`, and then execute the control from the API, it overrides the default action and the advanced query configuration within the job trigger. * Case 2: When you configure the `analyticsAdvanceQuery` within the payload, set the `defaultActionForAnalytics` as `"false"`, and then execute the control from the API without performing the default actions configured in the control, it overrides the default action and the advanced query configuration within the job trigger. * Case 3: When you do not configure both the `analyticsAdvanceQuery` and the `defaultActionForAnalytics`x, the default action will depend on the configuration provided in the analytics job trigger.

The following cases illustrate different scenarios on the usage of the `analyticsCategories` parameter in the API:

* Case 1: When you set the "defaultActionForAnalytics" as "true" to perform default actions for analytics controls by executing the control from job API, it will override the default action configuration within the job trigger. * Case 2: When you set the "defaultActionForAnalytics" as "false" to not perform default actions for analytics controls by executing the control from job API, it will override the default action configuration within the job trigger. * Case 3: When the defaultActionForAnalytics parameter is not set in the payload, the default action will depend on the configuration provided in the analytics job trigger.

@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
@return ApiRunJobTriggerRequest

func (*JobControlAPIService) RunJobTriggerExecute

func (a *JobControlAPIService) RunJobTriggerExecute(r ApiRunJobTriggerRequest) (*http.Response, error)

Execute executes the request

type MappedNullable

type MappedNullable interface {
	ToMap() (map[string]interface{}, error)
}

type NullableBool

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

func NewNullableBool

func NewNullableBool(val *bool) *NullableBool

func (NullableBool) Get

func (v NullableBool) Get() *bool

func (NullableBool) IsSet

func (v NullableBool) IsSet() bool

func (NullableBool) MarshalJSON

func (v NullableBool) MarshalJSON() ([]byte, error)

func (*NullableBool) Set

func (v *NullableBool) Set(val *bool)

func (*NullableBool) UnmarshalJSON

func (v *NullableBool) UnmarshalJSON(src []byte) error

func (*NullableBool) Unset

func (v *NullableBool) Unset()

type NullableCheckJobStatusResponse

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

func (NullableCheckJobStatusResponse) Get

func (NullableCheckJobStatusResponse) IsSet

func (NullableCheckJobStatusResponse) MarshalJSON

func (v NullableCheckJobStatusResponse) MarshalJSON() ([]byte, error)

func (*NullableCheckJobStatusResponse) Set

func (*NullableCheckJobStatusResponse) UnmarshalJSON

func (v *NullableCheckJobStatusResponse) UnmarshalJSON(src []byte) error

func (*NullableCheckJobStatusResponse) Unset

func (v *NullableCheckJobStatusResponse) Unset()

type NullableDeleteTriggerRequest

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

func NewNullableDeleteTriggerRequest

func NewNullableDeleteTriggerRequest(val *DeleteTriggerRequest) *NullableDeleteTriggerRequest

func (NullableDeleteTriggerRequest) Get

func (NullableDeleteTriggerRequest) IsSet

func (NullableDeleteTriggerRequest) MarshalJSON

func (v NullableDeleteTriggerRequest) MarshalJSON() ([]byte, error)

func (*NullableDeleteTriggerRequest) Set

func (*NullableDeleteTriggerRequest) UnmarshalJSON

func (v *NullableDeleteTriggerRequest) UnmarshalJSON(src []byte) error

func (*NullableDeleteTriggerRequest) Unset

func (v *NullableDeleteTriggerRequest) Unset()

type NullableDeleteTriggerResponse

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

func (NullableDeleteTriggerResponse) Get

func (NullableDeleteTriggerResponse) IsSet

func (NullableDeleteTriggerResponse) MarshalJSON

func (v NullableDeleteTriggerResponse) MarshalJSON() ([]byte, error)

func (*NullableDeleteTriggerResponse) Set

func (*NullableDeleteTriggerResponse) UnmarshalJSON

func (v *NullableDeleteTriggerResponse) UnmarshalJSON(src []byte) error

func (*NullableDeleteTriggerResponse) Unset

func (v *NullableDeleteTriggerResponse) Unset()

type NullableFetchJobMetadataRequest

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

func (NullableFetchJobMetadataRequest) Get

func (NullableFetchJobMetadataRequest) IsSet

func (NullableFetchJobMetadataRequest) MarshalJSON

func (v NullableFetchJobMetadataRequest) MarshalJSON() ([]byte, error)

func (*NullableFetchJobMetadataRequest) Set

func (*NullableFetchJobMetadataRequest) UnmarshalJSON

func (v *NullableFetchJobMetadataRequest) UnmarshalJSON(src []byte) error

func (*NullableFetchJobMetadataRequest) Unset

type NullableFetchJobMetadataResponse

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

func (NullableFetchJobMetadataResponse) Get

func (NullableFetchJobMetadataResponse) IsSet

func (NullableFetchJobMetadataResponse) MarshalJSON

func (v NullableFetchJobMetadataResponse) MarshalJSON() ([]byte, error)

func (*NullableFetchJobMetadataResponse) Set

func (*NullableFetchJobMetadataResponse) UnmarshalJSON

func (v *NullableFetchJobMetadataResponse) UnmarshalJSON(src []byte) error

func (*NullableFetchJobMetadataResponse) Unset

type NullableFloat32

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

func NewNullableFloat32

func NewNullableFloat32(val *float32) *NullableFloat32

func (NullableFloat32) Get

func (v NullableFloat32) Get() *float32

func (NullableFloat32) IsSet

func (v NullableFloat32) IsSet() bool

func (NullableFloat32) MarshalJSON

func (v NullableFloat32) MarshalJSON() ([]byte, error)

func (*NullableFloat32) Set

func (v *NullableFloat32) Set(val *float32)

func (*NullableFloat32) UnmarshalJSON

func (v *NullableFloat32) UnmarshalJSON(src []byte) error

func (*NullableFloat32) Unset

func (v *NullableFloat32) Unset()

type NullableFloat64

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

func NewNullableFloat64

func NewNullableFloat64(val *float64) *NullableFloat64

func (NullableFloat64) Get

func (v NullableFloat64) Get() *float64

func (NullableFloat64) IsSet

func (v NullableFloat64) IsSet() bool

func (NullableFloat64) MarshalJSON

func (v NullableFloat64) MarshalJSON() ([]byte, error)

func (*NullableFloat64) Set

func (v *NullableFloat64) Set(val *float64)

func (*NullableFloat64) UnmarshalJSON

func (v *NullableFloat64) UnmarshalJSON(src []byte) error

func (*NullableFloat64) Unset

func (v *NullableFloat64) Unset()

type NullableInt

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

func NewNullableInt

func NewNullableInt(val *int) *NullableInt

func (NullableInt) Get

func (v NullableInt) Get() *int

func (NullableInt) IsSet

func (v NullableInt) IsSet() bool

func (NullableInt) MarshalJSON

func (v NullableInt) MarshalJSON() ([]byte, error)

func (*NullableInt) Set

func (v *NullableInt) Set(val *int)

func (*NullableInt) UnmarshalJSON

func (v *NullableInt) UnmarshalJSON(src []byte) error

func (*NullableInt) Unset

func (v *NullableInt) Unset()

type NullableInt32

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

func NewNullableInt32

func NewNullableInt32(val *int32) *NullableInt32

func (NullableInt32) Get

func (v NullableInt32) Get() *int32

func (NullableInt32) IsSet

func (v NullableInt32) IsSet() bool

func (NullableInt32) MarshalJSON

func (v NullableInt32) MarshalJSON() ([]byte, error)

func (*NullableInt32) Set

func (v *NullableInt32) Set(val *int32)

func (*NullableInt32) UnmarshalJSON

func (v *NullableInt32) UnmarshalJSON(src []byte) error

func (*NullableInt32) Unset

func (v *NullableInt32) Unset()

type NullableInt64

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

func NewNullableInt64

func NewNullableInt64(val *int64) *NullableInt64

func (NullableInt64) Get

func (v NullableInt64) Get() *int64

func (NullableInt64) IsSet

func (v NullableInt64) IsSet() bool

func (NullableInt64) MarshalJSON

func (v NullableInt64) MarshalJSON() ([]byte, error)

func (*NullableInt64) Set

func (v *NullableInt64) Set(val *int64)

func (*NullableInt64) UnmarshalJSON

func (v *NullableInt64) UnmarshalJSON(src []byte) error

func (*NullableInt64) Unset

func (v *NullableInt64) Unset()

type NullableResumePauseJobsRequest

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

func (NullableResumePauseJobsRequest) Get

func (NullableResumePauseJobsRequest) IsSet

func (NullableResumePauseJobsRequest) MarshalJSON

func (v NullableResumePauseJobsRequest) MarshalJSON() ([]byte, error)

func (*NullableResumePauseJobsRequest) Set

func (*NullableResumePauseJobsRequest) UnmarshalJSON

func (v *NullableResumePauseJobsRequest) UnmarshalJSON(src []byte) error

func (*NullableResumePauseJobsRequest) Unset

func (v *NullableResumePauseJobsRequest) Unset()

type NullableResumePauseJobsResponse

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

func (NullableResumePauseJobsResponse) Get

func (NullableResumePauseJobsResponse) IsSet

func (NullableResumePauseJobsResponse) MarshalJSON

func (v NullableResumePauseJobsResponse) MarshalJSON() ([]byte, error)

func (*NullableResumePauseJobsResponse) Set

func (*NullableResumePauseJobsResponse) UnmarshalJSON

func (v *NullableResumePauseJobsResponse) UnmarshalJSON(src []byte) error

func (*NullableResumePauseJobsResponse) Unset

type NullableString

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

func NewNullableString

func NewNullableString(val *string) *NullableString

func (NullableString) Get

func (v NullableString) Get() *string

func (NullableString) IsSet

func (v NullableString) IsSet() bool

func (NullableString) MarshalJSON

func (v NullableString) MarshalJSON() ([]byte, error)

func (*NullableString) Set

func (v *NullableString) Set(val *string)

func (*NullableString) UnmarshalJSON

func (v *NullableString) UnmarshalJSON(src []byte) error

func (*NullableString) Unset

func (v *NullableString) Unset()

type NullableTime

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

func NewNullableTime

func NewNullableTime(val *time.Time) *NullableTime

func (NullableTime) Get

func (v NullableTime) Get() *time.Time

func (NullableTime) IsSet

func (v NullableTime) IsSet() bool

func (NullableTime) MarshalJSON

func (v NullableTime) MarshalJSON() ([]byte, error)

func (*NullableTime) Set

func (v *NullableTime) Set(val *time.Time)

func (*NullableTime) UnmarshalJSON

func (v *NullableTime) UnmarshalJSON(src []byte) error

func (*NullableTime) Unset

func (v *NullableTime) Unset()

type ResumePauseJobsRequest

type ResumePauseJobsRequest struct {
	Action      string  `json:"action"`
	Triggername *string `json:"triggername,omitempty"`
	Jobname     *string `json:"jobname,omitempty"`
}

ResumePauseJobsRequest struct for ResumePauseJobsRequest

func NewResumePauseJobsRequest

func NewResumePauseJobsRequest(action string) *ResumePauseJobsRequest

NewResumePauseJobsRequest instantiates a new ResumePauseJobsRequest object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewResumePauseJobsRequestWithDefaults

func NewResumePauseJobsRequestWithDefaults() *ResumePauseJobsRequest

NewResumePauseJobsRequestWithDefaults instantiates a new ResumePauseJobsRequest object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ResumePauseJobsRequest) GetAction

func (o *ResumePauseJobsRequest) GetAction() string

GetAction returns the Action field value

func (*ResumePauseJobsRequest) GetActionOk

func (o *ResumePauseJobsRequest) GetActionOk() (*string, bool)

GetActionOk returns a tuple with the Action field value and a boolean to check if the value has been set.

func (*ResumePauseJobsRequest) GetJobname

func (o *ResumePauseJobsRequest) GetJobname() string

GetJobname returns the Jobname field value if set, zero value otherwise.

func (*ResumePauseJobsRequest) GetJobnameOk

func (o *ResumePauseJobsRequest) GetJobnameOk() (*string, bool)

GetJobnameOk returns a tuple with the Jobname field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ResumePauseJobsRequest) GetTriggername

func (o *ResumePauseJobsRequest) GetTriggername() string

GetTriggername returns the Triggername field value if set, zero value otherwise.

func (*ResumePauseJobsRequest) GetTriggernameOk

func (o *ResumePauseJobsRequest) GetTriggernameOk() (*string, bool)

GetTriggernameOk returns a tuple with the Triggername field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ResumePauseJobsRequest) HasJobname

func (o *ResumePauseJobsRequest) HasJobname() bool

HasJobname returns a boolean if a field has been set.

func (*ResumePauseJobsRequest) HasTriggername

func (o *ResumePauseJobsRequest) HasTriggername() bool

HasTriggername returns a boolean if a field has been set.

func (ResumePauseJobsRequest) MarshalJSON

func (o ResumePauseJobsRequest) MarshalJSON() ([]byte, error)

func (*ResumePauseJobsRequest) SetAction

func (o *ResumePauseJobsRequest) SetAction(v string)

SetAction sets field value

func (*ResumePauseJobsRequest) SetJobname

func (o *ResumePauseJobsRequest) SetJobname(v string)

SetJobname gets a reference to the given string and assigns it to the Jobname field.

func (*ResumePauseJobsRequest) SetTriggername

func (o *ResumePauseJobsRequest) SetTriggername(v string)

SetTriggername gets a reference to the given string and assigns it to the Triggername field.

func (ResumePauseJobsRequest) ToMap

func (o ResumePauseJobsRequest) ToMap() (map[string]interface{}, error)

func (*ResumePauseJobsRequest) UnmarshalJSON

func (o *ResumePauseJobsRequest) UnmarshalJSON(data []byte) (err error)

type ResumePauseJobsResponse

type ResumePauseJobsResponse struct {
	Id *string `json:"id,omitempty"`
}

ResumePauseJobsResponse struct for ResumePauseJobsResponse

func NewResumePauseJobsResponse

func NewResumePauseJobsResponse() *ResumePauseJobsResponse

NewResumePauseJobsResponse instantiates a new ResumePauseJobsResponse object This constructor will assign default values to properties that have it defined, and makes sure properties required by API are set, but the set of arguments will change when the set of required properties is changed

func NewResumePauseJobsResponseWithDefaults

func NewResumePauseJobsResponseWithDefaults() *ResumePauseJobsResponse

NewResumePauseJobsResponseWithDefaults instantiates a new ResumePauseJobsResponse object This constructor will only assign default values to properties that have it defined, but it doesn't guarantee that properties required by API are set

func (*ResumePauseJobsResponse) GetId

func (o *ResumePauseJobsResponse) GetId() string

GetId returns the Id field value if set, zero value otherwise.

func (*ResumePauseJobsResponse) GetIdOk

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

GetIdOk returns a tuple with the Id field value if set, nil otherwise and a boolean to check if the value has been set.

func (*ResumePauseJobsResponse) HasId

func (o *ResumePauseJobsResponse) HasId() bool

HasId returns a boolean if a field has been set.

func (ResumePauseJobsResponse) MarshalJSON

func (o ResumePauseJobsResponse) MarshalJSON() ([]byte, error)

func (*ResumePauseJobsResponse) SetId

func (o *ResumePauseJobsResponse) SetId(v string)

SetId gets a reference to the given string and assigns it to the Id field.

func (ResumePauseJobsResponse) ToMap

func (o ResumePauseJobsResponse) ToMap() (map[string]interface{}, error)

type ServerConfiguration

type ServerConfiguration struct {
	URL         string
	Description string
	Variables   map[string]ServerVariable
}

ServerConfiguration stores the information about a server

type ServerConfigurations

type ServerConfigurations []ServerConfiguration

ServerConfigurations stores multiple ServerConfiguration items

func (ServerConfigurations) URL

func (sc ServerConfigurations) URL(index int, variables map[string]string) (string, error)

URL formats template on a index using given variables

type ServerVariable

type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

ServerVariable stores the information about a server variable

Jump to

Keyboard shortcuts

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