client

Documentation

Index

• Constants
• Variables
• type AnsibleTower
  • func New(transport runtime.ClientTransport, formats strfmt.Registry) *AnsibleTower
  • func NewHTTPClient(formats strfmt.Registry) *AnsibleTower
  • func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *AnsibleTower
  • func (c *AnsibleTower) SetTransport(transport runtime.ClientTransport)
• type TransportConfig
  • func DefaultTransportConfig() *TransportConfig
  • func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig
  • func (cfg *TransportConfig) WithHost(host string) *TransportConfig
  • func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

Constants

const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "localhost"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/"
)

Variables

var Default = NewHTTPClient(nil)

Default ansible tower HTTP client.

var DefaultSchemes = []string{"https"}

DefaultSchemes are the default schemes found in Meta (info) section of spec file

Types

type AnsibleTower

type AnsibleTower struct {
	ActivityStreams activity_streams.ClientService

	AdHocCommandEvents ad_hoc_command_events.ClientService

	AdHocCommands ad_hoc_commands.ClientService

	Authentication authentication.ClientService

	CredentialInputSources credential_input_sources.ClientService

	CredentialTypes credential_types.ClientService

	Credentials credentials.ClientService

	CustomInventoryScripts custom_inventory_scripts.ClientService

	Dashboard dashboard.ClientService

	Groups groups.ClientService

	Hosts hosts.ClientService

	InstanceGroups instance_groups.ClientService

	Instances instances.ClientService

	Inventories inventories.ClientService

	InventorySources inventory_sources.ClientService

	InventoryUpdates inventory_updates.ClientService

	JobEvents job_events.ClientService

	JobHostSummaries job_host_summaries.ClientService

	JobTemplates job_templates.ClientService

	Jobs jobs.ClientService

	Labels labels.ClientService

	Metrics metrics.ClientService

	NotificationTemplates notification_templates.ClientService

	Notifications notifications.ClientService

	Organizations organizations.ClientService

	ProjectUpdates project_updates.ClientService

	Projects projects.ClientService

	Roles roles.ClientService

	Schedules schedules.ClientService

	Settings settings.ClientService

	SystemConfiguration system_configuration.ClientService

	SystemJobTemplates system_job_templates.ClientService

	SystemJobs system_jobs.ClientService

	Teams teams.ClientService

	UnifiedJobTemplates unified_job_templates.ClientService

	UnifiedJobs unified_jobs.ClientService

	Users users.ClientService

	Versioning versioning.ClientService

	WorkflowApprovalTemplates workflow_approval_templates.ClientService

	WorkflowApprovals workflow_approvals.ClientService

	WorkflowJobNodes workflow_job_nodes.ClientService

	WorkflowJobTemplateNodes workflow_job_template_nodes.ClientService

	WorkflowJobTemplates workflow_job_templates.ClientService

	WorkflowJobs workflow_jobs.ClientService

	Transport runtime.ClientTransport
}

AnsibleTower is a client for ansible tower

func New

func New(transport runtime.ClientTransport, formats strfmt.Registry) *AnsibleTower

New creates a new ansible tower client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *AnsibleTower

NewHTTPClient creates a new ansible tower HTTP client.

func NewHTTPClientWithConfig

func NewHTTPClientWithConfig(formats strfmt.Registry, cfg *TransportConfig) *AnsibleTower

NewHTTPClientWithConfig creates a new ansible tower HTTP client, using a customizable transport config.

func (*AnsibleTower) SetTransport

func (c *AnsibleTower) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client and all its subresources

type TransportConfig

type TransportConfig struct {
	Host     string
	BasePath string
	Schemes  []string
}

TransportConfig contains the transport related info, found in the meta section of the spec file.

func DefaultTransportConfig

func DefaultTransportConfig() *TransportConfig

DefaultTransportConfig creates a TransportConfig with the default settings taken from the meta section of the spec file.

func (*TransportConfig) WithBasePath

func (cfg *TransportConfig) WithBasePath(basePath string) *TransportConfig

WithBasePath overrides the default basePath, provided by the meta section of the spec file.

func (*TransportConfig) WithHost

func (cfg *TransportConfig) WithHost(host string) *TransportConfig

WithHost overrides the default host, provided by the meta section of the spec file.

func (*TransportConfig) WithSchemes

func (cfg *TransportConfig) WithSchemes(schemes []string) *TransportConfig

WithSchemes overrides the default schemes, provided by the meta section of the spec file.