viya

package module

Go to main page

Versions in this module

v0

v0.5.0

May 9, 2026

v0.4.0

May 7, 2026

Changes in this version

type Client

+ func (c *Client) PatchIdentitiesLDAPUser(ctx context.Context, updates map[string]any) (bool, error)

+ type ErrInvalidParameter struct

+ Parameter string

+ Reason string

+ func (e *ErrInvalidParameter) Error() string

+ func (e *ErrInvalidParameter) Unwrap() error

type Option

+ func ParseURL(baseURL string) (Option, error)

+ func WithAuthMiddleware(mw resty.RequestMiddleware) Option

+ func WithBaseURL(u *url.URL) Option

v0.3.0

Apr 30, 2026

Changes in this version

+ type BatchJobInputRequest struct

+ Input []string

+ Version int

+ type BatchJobOutput struct

+ Errors []string

+ Output []string

+ Version int

+ type BatchServer struct

+ ContextID string

+ CreatedBy string

+ CreationTimeStamp time.Time

+ HostName string

+ ID string

+ IsPermanent bool

+ Links []Link

+ ModifiedBy string

+ ModifiedTimeStamp time.Time

+ ProcessID string

+ QueueName string

+ RuleID string

+ RunServerAs string

+ State string

+ Version int

+ type BatchServersResponse = ListResponse[BatchServer]

+ type CASLib struct

+ Description string

+ Links []Link

+ Name string

+ Type string

+ Version int

+ type CASLibsResponse = ListResponse[CASLib]

+ type CASServer struct

+ Description string

+ ID string

+ Links []Link

+ Name string

+ Version int

+ type CASServersResponse = ListResponse[CASServer]

+ type CASTable struct

+ CaslibName string

+ ColumnCount int

+ Links []Link

+ Name string

+ RowCount int64

+ Scope string

+ SourceName string

+ Version int

+ type CASTableColumn struct

+ Format string

+ Index int

+ Label string

+ Length int

+ Name string

+ RawLength int

+ Type string

+ type CASTableColumnsResponse = ListResponse[CASTableColumn]

+ type CASTableRowsResponse struct

+ Columns []string

+ Count int

+ Limit int

+ Rows []map[string]any

+ Start int

+ type CASTablesResponse = ListResponse[CASTable]

type Client

+ func (c *Client) CancelBatchJob(ctx context.Context, jobId string) (err error)

+ func (c *Client) CancelComputeJob(ctx context.Context, sessionId string, jobId string, ifMatch string) (state string, err error)

+ func (c *Client) CancelComputeSession(ctx context.Context, sessionId string, ifMatch string) (state string, err error)

+ func (c *Client) CancelJobExecutionJob(ctx context.Context, jobID string) (err error)

+ func (c *Client) CreateComputeJob(ctx context.Context, sessionId string, req CreateComputeJobRequest) (resp ComputeJob, err error)

+ func (c *Client) CreateComputeSession(ctx context.Context, contextId string, req CreateComputeSessionRequest) (resp ComputeSession, err error)

+ func (c *Client) DeleteBatchServer(ctx context.Context, serverId string) (err error)

+ func (c *Client) DeleteComputeJob(ctx context.Context, sessionId string, jobId string) (err error)

+ func (c *Client) DeleteComputeSession(ctx context.Context, sessionId string) (err error)

+ func (c *Client) DownloadFile(ctx context.Context, fileID string) (content []byte, err error)

+ func (c *Client) GetBatchContextByName(ctx context.Context, name string) (resp BatchContext, err error)

+ func (c *Client) GetBatchJobOutput(ctx context.Context, jobId string) (resp BatchJobOutput, err error)

+ func (c *Client) GetBatchJobState(ctx context.Context, jobId string) (state string, err error)

+ func (c *Client) GetBatchServerInfo(ctx context.Context, serverId string) (resp BatchServer, err error)

+ func (c *Client) GetBatchServersList(ctx context.Context) (resp BatchServersResponse, err error)

+ func (c *Client) GetCASLibs(ctx context.Context, serverID string, opts ListOptions) (resp CASLibsResponse, err error)

+ func (c *Client) GetCASServers(ctx context.Context, opts ListOptions) (resp CASServersResponse, err error)

+ func (c *Client) GetCASTableColumns(ctx context.Context, serverID string, caslibName string, tableName string, ...) (resp CASTableColumnsResponse, err error)

+ func (c *Client) GetCASTableDataColumns(ctx context.Context, serverID string, caslibName string, tableName string, ...) (resp CASTableColumnsResponse, err error)

+ func (c *Client) GetCASTableInfo(ctx context.Context, serverID string, caslibName string, tableName string) (resp CASTable, err error)

+ func (c *Client) GetCASTableRows(ctx context.Context, serverID string, caslibName string, tableName string, ...) (resp CASTableRowsResponse, err error)

+ func (c *Client) GetCASTables(ctx context.Context, serverID string, caslibName string, opts ListOptions) (resp CASTablesResponse, err error)

+ func (c *Client) GetComputeContextInfo(ctx context.Context, contextId string) (resp ComputeContext, err error)

+ func (c *Client) GetComputeContexts(ctx context.Context) (resp ComputeContextsResponse, err error)

+ func (c *Client) GetComputeJobInfo(ctx context.Context, sessionId string, jobId string) (resp ComputeJob, err error)

+ func (c *Client) GetComputeJobListing(ctx context.Context, sessionId string, jobId string) (resp ComputeLogLinesResponse, err error)

+ func (c *Client) GetComputeJobListingText(ctx context.Context, sessionId string, jobId string) (text string, err error)

+ func (c *Client) GetComputeJobLog(ctx context.Context, sessionId string, jobId string) (resp ComputeLogLinesResponse, err error)

+ func (c *Client) GetComputeJobLogText(ctx context.Context, sessionId string, jobId string) (text string, err error)

+ func (c *Client) GetComputeJobState(ctx context.Context, sessionId string, jobId string) (state string, err error)

+ func (c *Client) GetComputeJobsList(ctx context.Context, sessionId string) (resp ComputeJobsResponse, err error)

+ func (c *Client) GetComputeSessionInfo(ctx context.Context, sessionId string) (resp ComputeSession, err error)

+ func (c *Client) GetComputeSessionState(ctx context.Context, sessionId string) (state string, err error)

+ func (c *Client) GetComputeSessionsList(ctx context.Context) (resp ComputeSessionsResponse, err error)

+ func (c *Client) GetFiles(ctx context.Context, opts FileListOptions) (resp ViyaFilesResponse, err error)

+ func (c *Client) GetJobExecutionJob(ctx context.Context, jobID string) (resp JobExecutionJob, err error)

+ func (c *Client) GetJobExecutionJobLog(ctx context.Context, jobID string) (string, error)

+ func (c *Client) GetJobExecutionJobs(ctx context.Context, opts ListOptions) (resp JobExecutionJobsResponse, err error)

+ func (c *Client) LoadCASTableToMemory(ctx context.Context, serverID string, caslibName string, tableName string, ...) error

+ func (c *Client) PromoteCASTable(ctx context.Context, serverID string, caslibName string, tableName string) (resp CASTable, err error)

+ func (c *Client) SendBatchJobInput(ctx context.Context, jobId string, input []string) (err error)

+ func (c *Client) SetComputeJobState(ctx context.Context, sessionId string, jobId string, state string, ...) (newState string, err error)

+ func (c *Client) SetComputeSessionState(ctx context.Context, sessionId string, state string, ifMatch string) (newState string, err error)

+ func (c *Client) SubmitJobExecutionCode(ctx context.Context, req SubmitJobExecutionCodeRequest) (resp JobExecutionJob, err error)

+ func (c *Client) UnloadCASTableFromMemory(ctx context.Context, serverID string, caslibName string, tableName string) error

+ func (c *Client) UploadBatchFileFromReader(ctx context.Context, fileSetId string, fileName string, r io.Reader) (err error)

+ func (c *Client) UploadCSVToCASTable(ctx context.Context, serverID string, caslibName string, tableName string, ...) (resp CASTable, err error)

+ func (c *Client) UploadCSVToCASTableFromReader(ctx context.Context, serverID string, caslibName string, tableName string, ...) (resp CASTable, err error)

+ func (c *Client) UploadFile(ctx context.Context, fileName string, contentType string, content []byte) (resp ViyaFile, err error)

+ func (c *Client) UploadFileFromReader(ctx context.Context, fileName string, contentType string, r io.Reader) (resp ViyaFile, err error)

+ type ComputeContext struct

+ Attributes map[string]any

+ CreatedBy string

+ CreationTime time.Time

+ Description string

+ Environment *ComputeEnvironment

+ ID string

+ LaunchContext map[string]any

+ LaunchType string

+ Links []Link

+ MediaTypeMap map[string]string

+ ModifiedBy string

+ ModifiedTime time.Time

+ Name string

+ QueueName string

+ Resources []ComputeExternalResource

+ Version int

+ type ComputeContextsResponse = ListResponse[ComputeContext]

+ type ComputeEnvironment struct

+ InitCode []string

+ Options []string

+ type ComputeExternalResource struct

+ Name string

+ Options map[string]any

+ Scope string

+ Type string

+ URI string

+ type ComputeJob struct

+ CompletedTime time.Time

+ CreationTime time.Time

+ Description string

+ ID string

+ JobConditionCode int

+ Links []Link

+ ListingStatistics *ComputeOutputStatistics

+ LogStatistics *ComputeOutputStatistics

+ Name string

+ SessionID string

+ State string

+ Version int

+ type ComputeJobsResponse = ListResponse[ComputeJob]

+ type ComputeLogLine struct

+ Line string

+ Type string

+ type ComputeLogLinesResponse = ListResponse[ComputeLogLine]

+ type ComputeOutputStatistics struct

+ LineCount int

+ ModifiedTimeStamp time.Time

+ type ComputeSession struct

+ Attributes map[string]any

+ CreationTimeStamp time.Time

+ Description string

+ Environment *ComputeEnvironment

+ ID string

+ Links []Link

+ ListingStatistics *ComputeOutputStatistics

+ LogStatistics *ComputeOutputStatistics

+ Name string

+ Owner string

+ Resources []ComputeExternalResource

+ ServerID string

+ ServiceAPIVersion int

+ SessionConditionCode int

+ State string

+ StateElapsedTime int

+ Version int

+ type ComputeSessionsResponse = ListResponse[ComputeSession]

+ type CreateComputeJobRequest struct

+ Attributes map[string]any

+ Code []string

+ CodeURI string

+ Description string

+ Environment *ComputeEnvironment

+ Name string

+ Resources []ComputeExternalResource

+ Variables map[string]any

+ Version int

+ type CreateComputeSessionRequest struct

+ Attributes map[string]any

+ Description string

+ Environment *ComputeEnvironment

+ Name string

+ Resources []ComputeExternalResource

+ Version int

+ type FileListOptions struct

+ FilterName string

+ Limit int

+ Start int

+ type JobExecutionError struct

+ Code string

+ Message string

+ type JobExecutionJob struct

+ CreatedBy string

+ CreationTimeStamp time.Time

+ Error *JobExecutionError

+ ID string

+ Links []Link

+ ModifiedBy string

+ ModifiedTimeStamp time.Time

+ Name string

+ Results map[string]string

+ State string

+ Version int

+ type JobExecutionJobsResponse = ListResponse[JobExecutionJob]

+ type ListOptions struct

+ Limit int

+ Start int

+ type SubmitJobExecutionCodeRequest struct

+ Code string

+ ContextName string

+ Name string

+ type ViyaFile struct

+ ContentType string

+ CreatedBy string

+ CreationTimeStamp time.Time

+ ID string

+ Links []Link

+ ModifiedBy string

+ ModifiedTimeStamp time.Time

+ Name string

+ Size int64

+ Version int

+ type ViyaFilesResponse = ListResponse[ViyaFile]

v0.2.0

Apr 25, 2026

Changes in this version

+ var ErrDefaultClientNotSet = errors.New("viya default client is not set")

type Client

+ func MustGetDefaultClient() *Client

v0.1.0

Apr 25, 2026

Changes in this version

+ const CAS_SERVER_NAME

+ var ErrViyaAuthFailed = errors.New("viya authentication failed")

+ func SetDefaultClient(client *Client)

+ type AuthCodeTokenProvider struct

+ func (p *AuthCodeTokenProvider) Token(ctx context.Context) (string, error)

+ type BatchContext struct

+ CreatedBy string

+ CreationTimeStamp time.Time

+ Description string

+ ID string

+ IsMultiServer bool

+ LauncherContextID string

+ Links []Link

+ MaxServers int

+ MinServers int

+ ModifiedBy string

+ ModifiedTimeStamp time.Time

+ Name string

+ ProviderOptions string

+ QueueName string

+ RequiredResources string

+ RunServerAs string

+ SASOptions string

+ ServerTimeout int

+ State string

+ Version int

+ type BatchContextsResponse = ListResponse[BatchContext]

+ type BatchFile struct

+ CreatedBy string

+ CreationTimeStamp time.Time

+ FileSetID string

+ Links []Link

+ ModifiedBy string

+ ModifiedTimeStamp time.Time

+ Name string

+ Size int64

+ Version int

+ type BatchFileResponse = ListResponse[BatchFile]

+ type BatchFileSet struct

+ ContextID string

+ CreatedBy string

+ CreationTimeStamp time.Time

+ ID string

+ Links []Link

+ ModifiedBy string

+ ModifiedTimeStamp time.Time

+ Version int

+ type BatchFileSetsResponse = ListResponse[BatchFileSet]

+ type BatchJob struct

+ ContextID string

+ CreatedBy string

+ CreationTimeStamp time.Time

+ EndedTimeStamp time.Time

+ ExecutionHost string

+ FileSetID string

+ ID string

+ Links []Link

+ LogFile string

+ ModifiedBy string

+ ModifiedTimeStamp time.Time

+ Name string

+ ProcessID string

+ ReturnCode int

+ StartedTimeStamp time.Time

+ State string

+ SubmittedTimeStamp time.Time

+ Version int

+ WorkloadJobID string

+ type BatchJobsResponse = ListResponse[BatchJob]

+ type Client struct

+ func GetDefaultClient() *Client

+ func NewClient(ctx context.Context, baseURL string, opts ...Option) *Client

+ func (c *Client) CreateBatchFileSet(ctx context.Context, contextId string) (resp BatchFileSet, err error)

+ func (c *Client) CreateBatchJob(ctx context.Context, req SubmitBatchJobRequest) (resp BatchJob, err error)

+ func (c *Client) DeleteBatchFileSet(ctx context.Context, fileSetId string) (err error)

+ func (c *Client) DeleteBatchJob(ctx context.Context, jobId string) (err error)

+ func (c *Client) DownloadBatchFile(ctx context.Context, fileSetId string, fileName string) (content []byte, err error)

+ func (c *Client) GetBatchContexts(ctx context.Context) (resp BatchContextsResponse, err error)

+ func (c *Client) GetBatchFile(ctx context.Context, fileSetId string) (resp BatchFileResponse, err error)

+ func (c *Client) GetBatchFileInfo(ctx context.Context, fileSetId string, fileName string) (resp BatchFile, err error)

+ func (c *Client) GetBatchFileSetsInfo(ctx context.Context, id string) (resp BatchFileSet, err error)

+ func (c *Client) GetBatchFileSetsList(ctx context.Context) (resp BatchFileSetsResponse, err error)

+ func (c *Client) GetBatchJobInfo(ctx context.Context, jobId string) (resp BatchJob, err error)

+ func (c *Client) GetBatchJobsList(ctx context.Context) (resp BatchJobsResponse, err error)

+ func (c *Client) GetConfiguration(ctx context.Context, definitionName string) (string, error)

+ func (c *Client) GetIdentitiesLDAPUser(ctx context.Context) (map[string]any, error)

+ func (c *Client) GetIdentitiesUsers(ctx context.Context) (identitiesUserResp IdentitiesUsersResp, err error)

+ func (c *Client) LoadCasLibTableToMemory(ctx context.Context, casLibName, table string, replace bool, scope string) error

+ func (c *Client) PatchIdentitiesLDAPGroup(ctx context.Context, updates map[string]any) (bool, error)

+ func (c *Client) RefreshIdentitiesCache(ctx context.Context) (success bool, err error)

+ func (c *Client) TokenURL() string

+ func (c *Client) UnLoadCasLibTableInMemory(ctx context.Context, casLibName, table string) error

+ func (c *Client) UpdateIdentitiesLDAPObjectFilter(ctx context.Context, usernames []string) (bool, error)

+ func (c *Client) UploadBatchFile(ctx context.Context, fileSetId string, fileName string, content []byte) (err error)

+ func (c *Client) WaitBatchJobCompleted(ctx context.Context, jobId string, interval time.Duration) (jobInfo BatchJob, err error)

+ type ClientCredentialsTokenProvider struct

+ func NewClientCredentialsTokenProvider(baseURL, clientID, clientSecret string) (*ClientCredentialsTokenProvider, error)

+ func (p *ClientCredentialsTokenProvider) Token(ctx context.Context) (string, error)

+ type ConfigurationsResp = ListResponse[map[string]any]

+ type ErrorResponse struct

+ Accept string

+ Details []string

+ ErrorInfo ...

+ HTTPStatusCode int

+ Message string

+ Version int

+ func (e ErrorResponse) Error() string

+ type IdentitiesUsers struct

+ Description string

+ ID string

+ Name string

+ ProviderId string

+ State string

+ Type string

+ type IdentitiesUsersResp = ListResponse[IdentitiesUsers]

+ type LauncherOptions struct

+ BatchContextID string

+ JobName string

+ RequiredResources string

+ WorkloadQueueName string

+ type Link struct

+ Href string

+ Method string

+ Rel string

+ Type string

+ URI string

+ type ListResponse struct

+ Accept string

+ Count int

+ Items []T

+ Limit int

+ Links []Link

+ Start int

+ Version int

+ type Metadata struct

+ CreatedBy string

+ CreationTimeStamp string

+ IsDefault bool

+ MediaType string

+ ModifiedBy string

+ ModifiedTimeStamp string

+ Services []string

+ type Option func(*clientOptions)

+ func WithRoundTripper(rt http.RoundTripper) Option

+ func WithTokenProvider(provider TokenProvider) Option

+ type PasswordTokenProvider struct

+ func (p *PasswordTokenProvider) Token(ctx context.Context) (string, error)

+ type SubmitBatchJobRequest struct

+ FileSetID string

+ LauncherOptions LauncherOptions

+ ListFile string

+ LogFile string

+ OutputDir string

+ RestartType string

+ SASOptions string

+ SASProgramName string

+ Version int

+ WatchOutput bool

+ type TokenProvider interface

+ Token func(ctx context.Context) (string, error)

+ func NewAuthCodeTokenProvider(baseURL, code string, opts ...TokenProviderOption) (TokenProvider, error)

+ func NewPasswordTokenProvider(baseURL, username, password string, opts ...TokenProviderOption) (TokenProvider, error)

+ type TokenProviderOption func(*tokenProviderOptions)

+ func WithOAuthClient(clientID, clientSecret string) TokenProviderOption

+ func WithOAuthClientProvider(provider *ClientCredentialsTokenProvider) TokenProviderOption

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