tasks

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 tasks

Saviynt Tasks API

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 tasks "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 tasks.ContextServerIndex of type int.

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

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

ctx := context.WithValue(context.Background(), tasks.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 tasks.ContextOperationServerIndices and tasks.ContextOperationServerVariables context maps.

ctx := context.WithValue(context.Background(), tasks.ContextOperationServerIndices, map[string]int{
	"{classname}Service.{nickname}": 2,
})
ctx = context.WithValue(context.Background(), tasks.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
TasksAPI CheckTaskStatus Post /ECM/api/v5/checkTaskStatus Check Task Status
TasksAPI UpdateTasks Post /ECM/api/v5/updateTasks Update Tasks

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 {
	TasksAPI *TasksAPIService
	// contains filtered or unexported fields
}

APIClient manages communication with the Saviynt Tasks 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 ApiCheckTaskStatusRequest 

type ApiCheckTaskStatusRequest struct {
	ApiService *TasksAPIService
	// contains filtered or unexported fields
}

func (ApiCheckTaskStatusRequest) Execute 

func (r ApiCheckTaskStatusRequest) Execute() (*CheckTaskStatusResponse, *http.Response, error)

func (ApiCheckTaskStatusRequest) Taskid 

func (r ApiCheckTaskStatusRequest) Taskid(taskid string) ApiCheckTaskStatusRequest

type ApiUpdateTasksRequest 

type ApiUpdateTasksRequest struct {
	ApiService *TasksAPIService
	// contains filtered or unexported fields
}

func (ApiUpdateTasksRequest) Execute 

func (r ApiUpdateTasksRequest) Execute() (*map[string]UpdateTaskResponseInfo, *http.Response, error)

func (ApiUpdateTasksRequest) UpdateTasksRequest 

func (r ApiUpdateTasksRequest) UpdateTasksRequest(updateTasksRequest UpdateTasksRequest) ApiUpdateTasksRequest

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 CheckTaskStatusResponse 

type CheckTaskStatusResponse struct {
	// Can be null or one of the following:  1. `New` 2. `In Progress` 3. `Complete` 4. `Discontinued` 5. `Pending Create` 6. `Pending Provision` 7. `Provisioning Failed` 8. `Error` 9. `No Action Required`
	Status               *string                `json:"Status,omitempty"`
	UpdateDate           *string                `json:"UpdateDate,omitempty"`
	Comments             *string                `json:"Comments,omitempty"`
	ProvisioningComments *string                `json:"ProvisioningComments,omitempty"`
	UpdateUser           *string                `json:"UpdateUser,omitempty"`
	ProvisioningMetadata map[string]interface{} `json:"ProvisioningMetadata,omitempty"`
}

CheckTaskStatusResponse

func NewCheckTaskStatusResponse 

func NewCheckTaskStatusResponse() *CheckTaskStatusResponse

NewCheckTaskStatusResponse instantiates a new CheckTaskStatusResponse 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 NewCheckTaskStatusResponseWithDefaults 

func NewCheckTaskStatusResponseWithDefaults() *CheckTaskStatusResponse

NewCheckTaskStatusResponseWithDefaults instantiates a new CheckTaskStatusResponse 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 (*CheckTaskStatusResponse) GetComments 

func (o *CheckTaskStatusResponse) GetComments() string

GetComments returns the Comments field value if set, zero value otherwise.

func (*CheckTaskStatusResponse) GetCommentsOk 

func (o *CheckTaskStatusResponse) GetCommentsOk() (*string, bool)

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

func (*CheckTaskStatusResponse) GetProvisioningComments 

func (o *CheckTaskStatusResponse) GetProvisioningComments() string

GetProvisioningComments returns the ProvisioningComments field value if set, zero value otherwise.

func (*CheckTaskStatusResponse) GetProvisioningCommentsOk 

func (o *CheckTaskStatusResponse) GetProvisioningCommentsOk() (*string, bool)

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

func (*CheckTaskStatusResponse) GetProvisioningMetadata 

func (o *CheckTaskStatusResponse) GetProvisioningMetadata() map[string]interface{}

GetProvisioningMetadata returns the ProvisioningMetadata field value if set, zero value otherwise.

func (*CheckTaskStatusResponse) GetProvisioningMetadataOk 

func (o *CheckTaskStatusResponse) GetProvisioningMetadataOk() (map[string]interface{}, bool)

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

func (*CheckTaskStatusResponse) GetStatus 

func (o *CheckTaskStatusResponse) GetStatus() string

GetStatus returns the Status field value if set, zero value otherwise.

func (*CheckTaskStatusResponse) GetStatusOk 

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

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

func (*CheckTaskStatusResponse) GetUpdateDate 

func (o *CheckTaskStatusResponse) GetUpdateDate() string

GetUpdateDate returns the UpdateDate field value if set, zero value otherwise.

func (*CheckTaskStatusResponse) GetUpdateDateOk 

func (o *CheckTaskStatusResponse) GetUpdateDateOk() (*string, bool)

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

func (*CheckTaskStatusResponse) GetUpdateUser 

func (o *CheckTaskStatusResponse) GetUpdateUser() string

GetUpdateUser returns the UpdateUser field value if set, zero value otherwise.

func (*CheckTaskStatusResponse) GetUpdateUserOk 

func (o *CheckTaskStatusResponse) GetUpdateUserOk() (*string, bool)

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

func (*CheckTaskStatusResponse) HasComments 

func (o *CheckTaskStatusResponse) HasComments() bool

HasComments returns a boolean if a field has been set.

func (*CheckTaskStatusResponse) HasProvisioningComments 

func (o *CheckTaskStatusResponse) HasProvisioningComments() bool

HasProvisioningComments returns a boolean if a field has been set.

func (*CheckTaskStatusResponse) HasProvisioningMetadata 

func (o *CheckTaskStatusResponse) HasProvisioningMetadata() bool

HasProvisioningMetadata returns a boolean if a field has been set.

func (*CheckTaskStatusResponse) HasStatus 

func (o *CheckTaskStatusResponse) HasStatus() bool

HasStatus returns a boolean if a field has been set.

func (*CheckTaskStatusResponse) HasUpdateDate 

func (o *CheckTaskStatusResponse) HasUpdateDate() bool

HasUpdateDate returns a boolean if a field has been set.

func (*CheckTaskStatusResponse) HasUpdateUser 

func (o *CheckTaskStatusResponse) HasUpdateUser() bool

HasUpdateUser returns a boolean if a field has been set.

func (CheckTaskStatusResponse) MarshalJSON 

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

func (*CheckTaskStatusResponse) SetComments 

func (o *CheckTaskStatusResponse) SetComments(v string)

SetComments gets a reference to the given string and assigns it to the Comments field.

func (*CheckTaskStatusResponse) SetProvisioningComments 

func (o *CheckTaskStatusResponse) SetProvisioningComments(v string)

SetProvisioningComments gets a reference to the given string and assigns it to the ProvisioningComments field.

func (*CheckTaskStatusResponse) SetProvisioningMetadata 

func (o *CheckTaskStatusResponse) SetProvisioningMetadata(v map[string]interface{})

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

func (*CheckTaskStatusResponse) SetStatus 

func (o *CheckTaskStatusResponse) SetStatus(v string)

SetStatus gets a reference to the given string and assigns it to the Status field.

func (*CheckTaskStatusResponse) SetUpdateDate 

func (o *CheckTaskStatusResponse) SetUpdateDate(v string)

SetUpdateDate gets a reference to the given string and assigns it to the UpdateDate field.

func (*CheckTaskStatusResponse) SetUpdateUser 

func (o *CheckTaskStatusResponse) SetUpdateUser(v string)

SetUpdateUser gets a reference to the given string and assigns it to the UpdateUser field.

func (CheckTaskStatusResponse) ToMap 

func (o CheckTaskStatusResponse) 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 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 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 NullableCheckTaskStatusResponse 

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

func NewNullableCheckTaskStatusResponse 

func NewNullableCheckTaskStatusResponse(val *CheckTaskStatusResponse) *NullableCheckTaskStatusResponse

func (NullableCheckTaskStatusResponse) Get 

func (v NullableCheckTaskStatusResponse) Get() *CheckTaskStatusResponse

func (NullableCheckTaskStatusResponse) IsSet 

func (v NullableCheckTaskStatusResponse) IsSet() bool

func (NullableCheckTaskStatusResponse) MarshalJSON 

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

func (*NullableCheckTaskStatusResponse) Set 

func (v *NullableCheckTaskStatusResponse) Set(val *CheckTaskStatusResponse)

func (*NullableCheckTaskStatusResponse) UnmarshalJSON 

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

func (*NullableCheckTaskStatusResponse) Unset 

func (v *NullableCheckTaskStatusResponse) 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 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 NullableUpdateTaskRequestInfo 

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

func NewNullableUpdateTaskRequestInfo 

func NewNullableUpdateTaskRequestInfo(val *UpdateTaskRequestInfo) *NullableUpdateTaskRequestInfo

func (NullableUpdateTaskRequestInfo) Get 

func (v NullableUpdateTaskRequestInfo) Get() *UpdateTaskRequestInfo

func (NullableUpdateTaskRequestInfo) IsSet 

func (v NullableUpdateTaskRequestInfo) IsSet() bool

func (NullableUpdateTaskRequestInfo) MarshalJSON 

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

func (*NullableUpdateTaskRequestInfo) Set 

func (v *NullableUpdateTaskRequestInfo) Set(val *UpdateTaskRequestInfo)

func (*NullableUpdateTaskRequestInfo) UnmarshalJSON 

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

func (*NullableUpdateTaskRequestInfo) Unset 

func (v *NullableUpdateTaskRequestInfo) Unset()

type NullableUpdateTaskResponseInfo 

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

func NewNullableUpdateTaskResponseInfo 

func NewNullableUpdateTaskResponseInfo(val *UpdateTaskResponseInfo) *NullableUpdateTaskResponseInfo

func (NullableUpdateTaskResponseInfo) Get 

func (v NullableUpdateTaskResponseInfo) Get() *UpdateTaskResponseInfo

func (NullableUpdateTaskResponseInfo) IsSet 

func (v NullableUpdateTaskResponseInfo) IsSet() bool

func (NullableUpdateTaskResponseInfo) MarshalJSON 

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

func (*NullableUpdateTaskResponseInfo) Set 

func (v *NullableUpdateTaskResponseInfo) Set(val *UpdateTaskResponseInfo)

func (*NullableUpdateTaskResponseInfo) UnmarshalJSON 

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

func (*NullableUpdateTaskResponseInfo) Unset 

func (v *NullableUpdateTaskResponseInfo) Unset()

type NullableUpdateTasksRequest 

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

func NewNullableUpdateTasksRequest 

func NewNullableUpdateTasksRequest(val *UpdateTasksRequest) *NullableUpdateTasksRequest

func (NullableUpdateTasksRequest) Get 

func (v NullableUpdateTasksRequest) Get() *UpdateTasksRequest

func (NullableUpdateTasksRequest) IsSet 

func (v NullableUpdateTasksRequest) IsSet() bool

func (NullableUpdateTasksRequest) MarshalJSON 

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

func (*NullableUpdateTasksRequest) Set 

func (v *NullableUpdateTasksRequest) Set(val *UpdateTasksRequest)

func (*NullableUpdateTasksRequest) UnmarshalJSON 

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

func (*NullableUpdateTasksRequest) Unset 

func (v *NullableUpdateTasksRequest) Unset()

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

type TasksAPIService 

type TasksAPIService service

TasksAPIService TasksAPI service

func (*TasksAPIService) CheckTaskStatus 

func (a *TasksAPIService) CheckTaskStatus(ctx context.Context) ApiCheckTaskStatusRequest

CheckTaskStatus Check Task Status

This API can be used to check the task status. Response can return task status as “New/Complete/In Progress/Discontinued”. 

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

func (*TasksAPIService) CheckTaskStatusExecute 

func (a *TasksAPIService) CheckTaskStatusExecute(r ApiCheckTaskStatusRequest) (*CheckTaskStatusResponse, *http.Response, error)

Execute executes the request 

@return CheckTaskStatusResponse

func (*TasksAPIService) UpdateTasks 

func (a *TasksAPIService) UpdateTasks(ctx context.Context) ApiUpdateTasksRequest

UpdateTasks Update Tasks

It can update certain params of a task as well as complete a task. 

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

func (*TasksAPIService) UpdateTasksExecute 

func (a *TasksAPIService) UpdateTasksExecute(r ApiUpdateTasksRequest) (*map[string]UpdateTaskResponseInfo, *http.Response, error)

Execute executes the request 

@return map[string]UpdateTaskResponseInfo

type UpdateTaskRequestInfo 

type UpdateTaskRequestInfo struct {
	Taskid string `json:"taskid"`
	// Use the following numeric status codes to represent the following status. These string status values are returned in the `checkTaskStatus` endpoint. 1: New 2: In Progress 3: Complete 4: Discontinued 5: Pending Create 6: Pending Provision 7: Provisioning Failed 8: Error 9: No Action Required
	Status string `json:"status"`
}

UpdateTaskRequestInfo 1. `updatetype` (if this is set to \"completetask\" then refer completetask api and pass appropriate params as well), 1. `comments` 1. `provisioningComments` 1. `provisioningMetadata` 1. `password` 1. `status` 1. `ticketId` 1. `taskownerusergroup` 1. `taskowneruser` 1. `updateuser` - username of user who is updating the task, 1. `completeassociatedtasks` - true / false, 1. `emailto` 1. `notify` - to pick up data from the task, supported values - \"notify\":[\"USER\",\"requestor\",\"MANAGER\"], 1. `from` 1. `subject` 1. `emailbody`

func NewUpdateTaskRequestInfo 

func NewUpdateTaskRequestInfo(taskid string, status string) *UpdateTaskRequestInfo

NewUpdateTaskRequestInfo instantiates a new UpdateTaskRequestInfo 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 NewUpdateTaskRequestInfoWithDefaults 

func NewUpdateTaskRequestInfoWithDefaults() *UpdateTaskRequestInfo

NewUpdateTaskRequestInfoWithDefaults instantiates a new UpdateTaskRequestInfo 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 (*UpdateTaskRequestInfo) GetStatus 

func (o *UpdateTaskRequestInfo) GetStatus() string

GetStatus returns the Status field value

func (*UpdateTaskRequestInfo) GetStatusOk 

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

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

func (*UpdateTaskRequestInfo) GetTaskid 

func (o *UpdateTaskRequestInfo) GetTaskid() string

GetTaskid returns the Taskid field value

func (*UpdateTaskRequestInfo) GetTaskidOk 

func (o *UpdateTaskRequestInfo) GetTaskidOk() (*string, bool)

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

func (UpdateTaskRequestInfo) MarshalJSON 

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

func (*UpdateTaskRequestInfo) SetStatus 

func (o *UpdateTaskRequestInfo) SetStatus(v string)

SetStatus sets field value

func (*UpdateTaskRequestInfo) SetTaskid 

func (o *UpdateTaskRequestInfo) SetTaskid(v string)

SetTaskid sets field value

func (UpdateTaskRequestInfo) ToMap 

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

func (*UpdateTaskRequestInfo) UnmarshalJSON 

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

type UpdateTaskResponseInfo 

type UpdateTaskResponseInfo struct {
	Msg       string `json:"msg"`
	ErrorCode string `json:"errorCode"`
}

UpdateTaskResponseInfo struct for UpdateTaskResponseInfo

func NewUpdateTaskResponseInfo 

func NewUpdateTaskResponseInfo(msg string, errorCode string) *UpdateTaskResponseInfo

NewUpdateTaskResponseInfo instantiates a new UpdateTaskResponseInfo 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 NewUpdateTaskResponseInfoWithDefaults 

func NewUpdateTaskResponseInfoWithDefaults() *UpdateTaskResponseInfo

NewUpdateTaskResponseInfoWithDefaults instantiates a new UpdateTaskResponseInfo 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 (*UpdateTaskResponseInfo) GetErrorCode 

func (o *UpdateTaskResponseInfo) GetErrorCode() string

GetErrorCode returns the ErrorCode field value

func (*UpdateTaskResponseInfo) GetErrorCodeOk 

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

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

func (*UpdateTaskResponseInfo) GetMsg 

func (o *UpdateTaskResponseInfo) GetMsg() string

GetMsg returns the Msg field value

func (*UpdateTaskResponseInfo) GetMsgOk 

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

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

func (UpdateTaskResponseInfo) MarshalJSON 

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

func (*UpdateTaskResponseInfo) SetErrorCode 

func (o *UpdateTaskResponseInfo) SetErrorCode(v string)

SetErrorCode sets field value

func (*UpdateTaskResponseInfo) SetMsg 

func (o *UpdateTaskResponseInfo) SetMsg(v string)

SetMsg sets field value

func (UpdateTaskResponseInfo) ToMap 

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

func (*UpdateTaskResponseInfo) UnmarshalJSON 

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

type UpdateTasksRequest 

type UpdateTasksRequest struct {
	TaskKeyToUpdate []UpdateTaskRequestInfo `json:"taskKeyToUpdate"`
	Updateuser      *string                 `json:"updateuser,omitempty"`
}

UpdateTasksRequest

func NewUpdateTasksRequest 

func NewUpdateTasksRequest(taskKeyToUpdate []UpdateTaskRequestInfo) *UpdateTasksRequest

NewUpdateTasksRequest instantiates a new UpdateTasksRequest 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 NewUpdateTasksRequestWithDefaults 

func NewUpdateTasksRequestWithDefaults() *UpdateTasksRequest

NewUpdateTasksRequestWithDefaults instantiates a new UpdateTasksRequest 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 (*UpdateTasksRequest) GetTaskKeyToUpdate 

func (o *UpdateTasksRequest) GetTaskKeyToUpdate() []UpdateTaskRequestInfo

GetTaskKeyToUpdate returns the TaskKeyToUpdate field value

func (*UpdateTasksRequest) GetTaskKeyToUpdateOk 

func (o *UpdateTasksRequest) GetTaskKeyToUpdateOk() ([]UpdateTaskRequestInfo, bool)

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

func (*UpdateTasksRequest) GetUpdateuser 

func (o *UpdateTasksRequest) GetUpdateuser() string

GetUpdateuser returns the Updateuser field value if set, zero value otherwise.

func (*UpdateTasksRequest) GetUpdateuserOk 

func (o *UpdateTasksRequest) GetUpdateuserOk() (*string, bool)

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

func (*UpdateTasksRequest) HasUpdateuser 

func (o *UpdateTasksRequest) HasUpdateuser() bool

HasUpdateuser returns a boolean if a field has been set.

func (UpdateTasksRequest) MarshalJSON 

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

func (*UpdateTasksRequest) SetTaskKeyToUpdate 

func (o *UpdateTasksRequest) SetTaskKeyToUpdate(v []UpdateTaskRequestInfo)

SetTaskKeyToUpdate sets field value

func (*UpdateTasksRequest) SetUpdateuser 

func (o *UpdateTasksRequest) SetUpdateuser(v string)

SetUpdateuser gets a reference to the given string and assigns it to the Updateuser field.

func (UpdateTasksRequest) ToMap 

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

func (*UpdateTasksRequest) UnmarshalJSON 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.