data

Documentation

Overview

This package contains the internal data structures used by the client in order to generate and parse the JSON documents used by in the AWX API.

Index

• type AuthTokenPostRequest
• type AuthTokenPostResponse
• type Job
• type JobGetResponse
• type JobTemplate
• type JobTemplateGetResponse
• type JobTemplateLaunchGetResponse
• type JobTemplateLaunchPostRequest
• type JobTemplateLaunchPostResponse
• type JobTemplatesGetResponse
• type JobsGetResponse
• type ListGetResponse
• type PATPostRequest
• type PATPostResponse
• type Project
• type ProjectGetResponse
• type ProjectsGetResponse

Types

type AuthTokenPostRequest

type AuthTokenPostRequest struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
}

type AuthTokenPostResponse

type AuthTokenPostResponse struct {
	Token   string    `json:"token,omitempty"`
	Expires time.Time `json:"expires,omitempty"`
}

type Job

type Job struct {
	Id     int    `json:"id,omitempty"`
	Status string `json:"status,omitempty"`
}

type JobGetResponse

type JobGetResponse struct {
	Job
}

type JobTemplate

type JobTemplate struct {
	Id               int    `json:"id,omitempty"`
	Name             string `json:"name,omitempty"`
	AskLimitOnLaunch bool   `json:"ask_limit_on_launch,omitempty"`
	AskVarsOnLaunch  bool   `json:"ask_variables_on_launch,omitempty"`
}

type JobTemplateGetResponse

type JobTemplateGetResponse struct {
	JobTemplate
}

type JobTemplateLaunchGetResponse

type JobTemplateLaunchGetResponse struct {
	JobTemplateData *JobTemplateGetResponse `json:"job_template_data,omitempty"`
}

type JobTemplateLaunchPostRequest

type JobTemplateLaunchPostRequest struct {
	ExtraVars string `json:"extra_vars,omitempty"`
	Limit     string `json:"limit,omitempty"`
}

type JobTemplateLaunchPostResponse

type JobTemplateLaunchPostResponse struct {
	Job int `json:"job,omitempty"`
}

type JobTemplatesGetResponse

type JobTemplatesGetResponse struct {
	ListGetResponse

	Results []*JobTemplate `json:"results,omitempty"`
}

type JobsGetResponse

type JobsGetResponse struct {
	ListGetResponse

	Results []*Job `json:"results,omitempty"`
}

type ListGetResponse

type ListGetResponse struct {
	Count    int    `json:"count,omitempty"`
	Next     string `json:"next,omitempty"`
	Previous string `json:"previous,omitempty"`
}

type PATPostRequest

type PATPostRequest struct {
	Description string  `json:"description,omitempty"`
	Application *string `json:"application"` // Must be "null" in a PAT request
	Scope       string  `json:"scope,omitempty"`
}

Personal Access Token, user token in OAuth2

type PATPostResponse

type PATPostResponse struct {
	Token   string    `json:"token,omitempty"`
	Expires time.Time `json:"expires,omitempty"`
}

type Project

type Project struct {
	Id        int    `json:"id,omitempty"`
	Name      string `json:"name,omitempty"`
	SCMType   string `json:"scm_type,omitempty"`
	SCMURL    string `json:"scm_url,omitempty"`
	SCMBranch string `json:"scm_branch,omitempty"`
}

type ProjectGetResponse

type ProjectGetResponse struct {
	Project
}

type ProjectsGetResponse

type ProjectsGetResponse struct {
	ListGetResponse

	Results []*Project `json:"results,omitempty"`
}