environments

package
v2.87.0 Latest Latest
Warning

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

Go to latest
Published: Nov 10, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Get

func Get(client newclient.Client, spaceID string, environmentsQuery EnvironmentQuery) (*resources.Resources[*Environment], error)

Get returns a collection of environments based on the criteria defined by its input query parameter. If an error occurs, an empty collection is returned along with the associated error.

Types

type Environment

type Environment struct {
	ID               string   `json:"Id"`
	Name             string   `json:"Name"`
	SpaceID          string   `json:"SpaceId"`
	Slug             string   `json:"Slug"`
	Description      string   `json:"Description,omitempty"`
	Type             string   `json:"Type"`
	SortOrder        int      `json:"SortOrder"`
	UseGuidedFailure bool     `json:"UseGuidedFailure"`
	EnvironmentTags  []string `json:"EnvironmentTags,omitempty"`

	// Fields for Static environments
	AllowDynamicInfrastructure *bool                          `json:"AllowDynamicInfrastructure,omitempty"`
	ExtensionSettings          []extensions.ExtensionSettings `json:"ExtensionSettings,omitempty"`

	// Fields for Ephemeral environments
	ParentEnvironmentId string `json:"ParentEnvironmentId,omitempty"`
}

type EnvironmentQuery

type EnvironmentQuery struct {
	Ids         []string `uri:"ids,omitempty" url:"ids,omitempty"`
	PartialName string   `uri:"partialName,omitempty" url:"partialName,omitempty"`
	Skip        int      `uri:"skip" url:"skip"`
	Take        int      `uri:"take" url:"take"`
	Type        []string `uri:"type,omitempty" url:"type,omitempty"`
}

Jump to

Keyboard shortcuts

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