client

package
v1.0.100 Latest Latest
Warning

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

Go to latest
Published: May 29, 2025 License: MIT Imports: 59 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DefaultHost is the default Host
	// found in Meta (info) section of spec file
	DefaultHost string = "http-api.cycloid.io"
	// DefaultBasePath is the default BasePath
	// found in Meta (info) section of spec file
	DefaultBasePath string = "/"
)

Variables

View Source
var Default = NewHTTPClient(nil)

Default API HTTP client.

View Source
var DefaultSchemes = []string{"https"}

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

Functions

This section is empty.

Types

type API

type API struct {
	Appearance appearance.ClientService

	Authentications authentications.ClientService

	CloudProviders cloud_providers.ClientService

	CodeGeneration code_generation.ClientService

	ComponentPipelineResources component_pipeline_resources.ClientService

	ComponentPipelineResourcesVersions component_pipeline_resources_versions.ClientService

	ComponentPipelines component_pipelines.ClientService

	ComponentPipelinesJobs component_pipelines_jobs.ClientService

	ComponentPipelinesJobsBuilds component_pipelines_jobs_builds.ClientService

	CostEstimation cost_estimation.ClientService

	Cycloid cycloid.ClientService

	EnvironmentPipelines environment_pipelines.ClientService

	OrganizationAPIKeys organization_api_keys.ClientService

	OrganizationAppearances organization_appearances.ClientService

	OrganizationAuthentications organization_authentications.ClientService

	OrganizationChildren organization_children.ClientService

	OrganizationCloudCostManagement organization_cloud_cost_management.ClientService

	OrganizationCloudCostManagementAccounts organization_cloud_cost_management_accounts.ClientService

	OrganizationCloudCostManagementDashboard organization_cloud_cost_management_dashboard.ClientService

	OrganizationCloudCostManagementFilterVaules organization_cloud_cost_management_filter_vaules.ClientService

	OrganizationCloudCostManagementProjectsDashboard organization_cloud_cost_management_projects_dashboard.ClientService

	OrganizationCloudCostManagementProviderDetails organization_cloud_cost_management_provider_details.ClientService

	OrganizationCloudCostManagementProviderHistograms organization_cloud_cost_management_provider_histograms.ClientService

	OrganizationCloudCostManagementTagMappings organization_cloud_cost_management_tag_mappings.ClientService

	OrganizationComponents organization_components.ClientService

	OrganizationConfigRepositories organization_config_repositories.ClientService

	OrganizationCredentials organization_credentials.ClientService

	OrganizationEnvironments organization_environments.ClientService

	OrganizationExternalBackends organization_external_backends.ClientService

	OrganizationForms organization_forms.ClientService

	OrganizationInfraImports organization_infra_imports.ClientService

	OrganizationInfrastructure organization_infrastructure.ClientService

	OrganizationInfrastructurePolicies organization_infrastructure_policies.ClientService

	OrganizationInventory organization_inventory.ClientService

	OrganizationInventoryPlan organization_inventory_plan.ClientService

	OrganizationkpIs organization_k_p_is.ClientService

	OrganizationLicence organization_licence.ClientService

	OrganizationLogs organization_logs.ClientService

	OrganizationMembers organization_members.ClientService

	OrganizationPipelines organization_pipelines.ClientService

	OrganizationProjects organization_projects.ClientService

	OrganizationQuotas organization_quotas.ClientService

	OrganizationResourcePools organization_resource_pools.ClientService

	OrganizationRoles organization_roles.ClientService

	OrganizationServiceCatalogSources organization_service_catalog_sources.ClientService

	OrganizationSubscriptions organization_subscriptions.ClientService

	OrganizationTeamMembers organization_team_members.ClientService

	OrganizationTeams organization_teams.ClientService

	OrganizationWorkers organization_workers.ClientService

	Organizations organizations.ClientService

	Policies policies.ClientService

	ProjectkpIs project_k_p_is.ClientService

	ProjectPipelines project_pipelines.ClientService

	SamL2 s_a_m_l2.ClientService

	ServiceCatalogs service_catalogs.ClientService

	User user.ClientService

	Transport runtime.ClientTransport
}

API is a client for API

func New

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

New creates a new API client

func NewHTTPClient

func NewHTTPClient(formats strfmt.Registry) *API

NewHTTPClient creates a new API HTTP client.

func NewHTTPClientWithConfig

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

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

func (*API) SetTransport

func (c *API) 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.

Jump to

Keyboard shortcuts

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