tfe

package module

Go to main page

Versions in this module

v1

v1.29.2

Jul 12, 2023

Changes in this version

+ const ContentTypeJSONAPI

+ const DefaultRegistryPath

+ const PingEndpoint

+ var ErrAgentTokenDescription = errors.New("agent token description can't be blank")

+ var ErrCommentBody = errors.New("comment body is required")

+ var ErrEmptyTeamName = errors.New("team name can not be empty")

+ var ErrInvalidAccessTeamID = errors.New("invalid value for team access ID")

+ var ErrInvalidAgentID = errors.New("invalid value for Agent ID")

+ var ErrInvalidAgentPoolID = errors.New("invalid value for agent pool ID")

+ var ErrInvalidAgentTokenID = errors.New("invalid value for agent token ID")

+ var ErrInvalidApplyID = errors.New("invalid value for apply ID")

+ var ErrInvalidArch = errors.New("invalid value for arch")

+ var ErrInvalidAsciiArmor = errors.New("ASCII Armor is invalid")

+ var ErrInvalidCategory = errors.New("category must be policy-set")

+ var ErrInvalidCommentBody = errors.New("invalid value for comment body")

+ var ErrInvalidCommentID = errors.New("invalid value for comment ID")

+ var ErrInvalidConfigVersionID = errors.New("invalid value for configuration version ID")

+ var ErrInvalidCostEstimateID = errors.New("invalid value for cost estimate ID")

+ var ErrInvalidEmail = errors.New("email is invalid")

+ var ErrInvalidIncludeValue = errors.New(`invalid value for "include" field`)

+ var ErrInvalidKeyID = errors.New("invalid value for key-id")

+ var ErrInvalidMembership = errors.New("invalid value for membership")

+ var ErrInvalidMembershipIDs = errors.New("invalid value for organization membership ids")

+ var ErrInvalidModuleID = errors.New("invalid value for module ID")

+ var ErrInvalidName = errors.New("invalid value for name")

+ var ErrInvalidNamespace = errors.New("invalid value for namespace")

+ var ErrInvalidNotificationConfigID = errors.New("invalid value for notification configuration ID")

+ var ErrInvalidNotificationTrigger = errors.New("invalid value for notification trigger")

+ var ErrInvalidOS = errors.New("invalid value for OS")

+ var ErrInvalidOauthClientID = errors.New("invalid value for OAuth client ID")

+ var ErrInvalidOauthTokenID = errors.New("invalid value for OAuth token ID")

+ var ErrInvalidOrg = errors.New("invalid value for organization")

+ var ErrInvalidOutputID = errors.New("invalid value for state version output ID")

+ var ErrInvalidPagination = errors.New("invalid value for page size or number")

+ var ErrInvalidParamID = errors.New("invalid value for parameter ID")

+ var ErrInvalidPlanExportID = errors.New("invalid value for plan export ID")

+ var ErrInvalidPlanID = errors.New("invalid value for plan ID")

+ var ErrInvalidPolicies = errors.New("must provide at least one policy")

+ var ErrInvalidPolicyCheckID = errors.New("invalid value for policy check ID")

+ var ErrInvalidPolicyEvaluationID = errors.New("invalid value for policy evaluation ID")

+ var ErrInvalidPolicyID = errors.New("invalid value for policy ID")

+ var ErrInvalidPolicySetID = errors.New("invalid value for policy set ID")

+ var ErrInvalidPolicySetOutcomeID = errors.New("invalid value for policy set outcome ID")

+ var ErrInvalidProjectID = errors.New("invalid value for project ID")

+ var ErrInvalidProvider = errors.New("invalid value for provider")

+ var ErrInvalidRegistryName = errors.New(`invalid value for registry-name. It must be either "private" or "public"`)

+ var ErrInvalidRequestBody = errors.New("go-tfe bug: DELETE/PATCH/POST body must be nil, ptr, or ptr slice")

+ var ErrInvalidRunEventID = errors.New("invalid value for run event ID")

+ var ErrInvalidRunID = errors.New("invalid value for run ID")

+ var ErrInvalidRunTaskCategory = errors.New(`category must be "task"`)

+ var ErrInvalidRunTaskID = errors.New("invalid value for run task ID")

+ var ErrInvalidRunTaskURL = errors.New("invalid url for run task URL")

+ var ErrInvalidRunTriggerID = errors.New("invalid value for run trigger ID")

+ var ErrInvalidRunTriggerType = errors.New(...)

+ var ErrInvalidSHHKeyID = errors.New("invalid value for SSH key ID")

+ var ErrInvalidSMTPAuth = errors.New("invalid smtp auth type")

+ var ErrInvalidStateVerID = errors.New("invalid value for state version ID")

+ var ErrInvalidStructFormat = errors.New("go-tfe bug: struct can't use both json and jsonapi attributes")

+ var ErrInvalidTag = errors.New("invalid tag id")

+ var ErrInvalidTaskResultID = errors.New("invalid value for task result ID")

+ var ErrInvalidTaskStageID = errors.New("invalid value for task stage ID")

+ var ErrInvalidTeamID = errors.New("invalid value for team ID")

+ var ErrInvalidTeamProjectAccessID = errors.New("invalid value for team project access ID")

+ var ErrInvalidTeamProjectAccessType = errors.New("invalid type for team project access")

+ var ErrInvalidTerraformVersionID = errors.New("invalid value for terraform version ID")

+ var ErrInvalidTerraformVersionType = errors.New("invalid type for terraform version. Please use 'terraform-version'")

+ var ErrInvalidTokenID = errors.New("invalid value for token ID")

+ var ErrInvalidUserID = errors.New("invalid value for user ID")

+ var ErrInvalidUserValue = errors.New("invalid value for user")

+ var ErrInvalidUsernames = errors.New("invalid value for usernames")

+ var ErrInvalidVariableID = errors.New("invalid value for variable ID")

+ var ErrInvalidVariableSetID = errors.New("invalid variable set ID")

+ var ErrInvalidVersion = errors.New("invalid value for version")

+ var ErrInvalidWorkspaceID = errors.New("invalid value for workspace ID")

+ var ErrInvalidWorkspaceRunTaskID = errors.New("invalid value for workspace run task ID")

+ var ErrInvalidWorkspaceRunTaskType = errors.New(`invalid value for type, please use "workspace-tasks"`)

+ var ErrInvalidWorkspaceValue = errors.New("invalid value for workspace")

+ var ErrItemsMustBeSlice = errors.New(`model field "Items" must be a slice`)

+ var ErrMissingDirectory = errors.New("path needs to be an existing directory")

+ var ErrMissingTagIdentifier = errors.New("must specify at least one tag by ID or name")

+ var ErrNamespaceNotAuthorized = errors.New("namespace not authorized")

+ var ErrRequiredAPIURL = errors.New("API URL is required")

+ var ErrRequiredAccess = errors.New("access is required")

+ var ErrRequiredAgentMode = errors.New("specifying an agent pool ID requires 'agent' execution mode")

+ var ErrRequiredAgentPoolID = errors.New("'agent' execution mode requires an agent pool ID to be specified")

+ var ErrRequiredArch = errors.New("arch is required")

+ var ErrRequiredCategory = errors.New("category is required")

+ var ErrRequiredDataType = errors.New("data type is required")

+ var ErrRequiredDestinationType = errors.New("destination type is required")

+ var ErrRequiredDisplayIdentifier = errors.New("display identifier is required")

+ var ErrRequiredEmail = errors.New("email is required")

+ var ErrRequiredEnabled = errors.New("enabled is required")

+ var ErrRequiredEnforce = errors.New("enforce is required")

+ var ErrRequiredEnforcementMode = errors.New("enforcement mode is required")

+ var ErrRequiredEnforcementPath = errors.New("enforcement path is required")

+ var ErrRequiredFilename = errors.New("filename is required")

+ var ErrRequiredGlobalFlag = errors.New("global flag is required")

+ var ErrRequiredHTTPURL = errors.New("HTTP URL is required")

+ var ErrRequiredIdentifier = errors.New("identifier is required")

+ var ErrRequiredKey = errors.New("key is required")

+ var ErrRequiredM5 = errors.New("MD5 is required")

+ var ErrRequiredName = errors.New("name is required")

+ var ErrRequiredNamespace = errors.New("namespace is required for public registry")

+ var ErrRequiredOS = errors.New("OS is required")

+ var ErrRequiredOauthToken = errors.New("OAuth token is required")

+ var ErrRequiredOauthTokenOrGithubAppInstallationID = errors.New("either oauth token ID or github app installation ID is required")

+ var ErrRequiredOnlyOneField = errors.New("only one of usernames or organization membership ids can be provided")

+ var ErrRequiredOrg = errors.New("organization is required")

+ var ErrRequiredPlan = errors.New("plan is required")

+ var ErrRequiredPolicies = errors.New("policies is required")

+ var ErrRequiredPrivateRegistry = errors.New("only private registry is allowed")

+ var ErrRequiredProject = errors.New("project is required")

+ var ErrRequiredProjectID = errors.New("project ID is required")

+ var ErrRequiredProvider = errors.New("provider is required")

+ var ErrRequiredQuery = errors.New("query cannot be empty")

+ var ErrRequiredRawState = errors.New("RawState is required")

+ var ErrRequiredRegistryModule = errors.New("registry module is required")

+ var ErrRequiredRunTriggerListOps = errors.New("RunTriggerListOptions is required")

+ var ErrRequiredSHHKeyID = errors.New("SSH key ID is required")

+ var ErrRequiredSerial = errors.New("serial is required")

+ var ErrRequiredServiceProvider = errors.New("service provider is required")

+ var ErrRequiredSha = errors.New("sha is required")

+ var ErrRequiredShasum = errors.New("shasum is required")

+ var ErrRequiredSourceable = errors.New("sourceable is required")

+ var ErrRequiredState = errors.New("state is required")

+ var ErrRequiredStateVerListOps = errors.New("StateVersionListOptions is required")

+ var ErrRequiredTFVerCreateOps = errors.New("version, URL and sha is required for AdminTerraformVersionCreateOptions")

+ var ErrRequiredTagID = errors.New("you must specify at least one tag id to remove")

+ var ErrRequiredTagWorkspaceID = errors.New("you must specify at least one workspace to add tag to")

+ var ErrRequiredTeam = errors.New("team is required")

+ var ErrRequiredTeamAccessListOps = errors.New("TeamAccessListOptions is required")

+ var ErrRequiredTeamProjectAccessListOps = errors.New("TeamProjectAccessListOptions is required")

+ var ErrRequiredTestNumber = errors.New("TestNumber is required")

+ var ErrRequiredURL = errors.New("url is required")

+ var ErrRequiredUsernameOrMembershipIds = errors.New("usernames or organization membership ids are required")

+ var ErrRequiredVCSRepo = errors.New("vcs repo is required")

+ var ErrRequiredValue = errors.New("value is required")

+ var ErrRequiredVersion = errors.New("version is required")

+ var ErrRequiredWorkspace = errors.New("workspace is required")

+ var ErrRequiredWorkspaceID = errors.New("workspace ID is required")

+ var ErrRequiredWorkspacesList = errors.New("no workspaces list provided")

+ var ErrStateMustBeOmitted = errors.New(...)

+ var ErrStateVersionUploadNotSupported = errors.New("upload not supported by this version of Terraform Enterprise")

+ var ErrTerraformVersionValidForPlanOnly = errors.New("setting terraform-version is only valid when plan-only is set to true")

+ var ErrUnsupportedBothNamespaceAndPrivateRegistryName = errors.New(`"Namespace" cannot be populated when "RegistryName" is "private"`)

+ var ErrUnsupportedBothTagsRegexAndFileTriggersEnabled = errors.New(`"TagsRegex" cannot be populated when "FileTriggersEnabled" is true`)

+ var ErrUnsupportedBothTagsRegexAndTriggerPatterns = errors.New(`"TagsRegex" and "TriggerPrefixes" cannot be populated at the same time`)

+ var ErrUnsupportedBothTagsRegexAndTriggerPrefixes = errors.New(`"TagsRegex" and "TriggerPatterns" cannot be populated at the same time`)

+ var ErrUnsupportedBothTriggerPatternsAndPrefixes = errors.New(`"TriggerPatterns" and "TriggerPrefixes" cannot be populated at the same time`)

+ var ErrUnsupportedOperations = errors.New("operations is deprecated and cannot be specified when execution mode is used")

+ var ErrUnsupportedPrivateKey = errors.New("private Key can only be present with Azure DevOps Server service provider")

+ var ErrUnsupportedRunTriggerType = errors.New(`"RunTriggerType" must be "inbound" when requesting "include" query params`)

+ var ErrWorkspaceLocked = errors.New("workspace already locked")

+ var ErrWorkspaceLockedByRun = errors.New("unable to unlock workspace locked by run")

+ var ErrWorkspaceLockedCannotDelete = errors.New(...)

+ var ErrWorkspaceMinLimit = errors.New("must provide at least one workspace")

+ var ErrWorkspaceNotLocked = errors.New("workspace already unlocked")

+ var ErrWorkspaceNotSafeToDelete = errors.New(...)

+ var ErrWorkspaceStillProcessing = errors.New("conflict\nworkspace is still being processed to discover resources")

+ var ErrWorkspacesRequired = errors.New("workspaces is required")

+ func ContextWithResponseHeaderHook(parentCtx context.Context, cb func(status int, header http.Header)) context.Context

type AccessType

+ const AccessCustom

+ const AccessPlan

+ type Actions struct

+ IsOverridable *bool

+ type AddWorkspacesToTagOptions struct

+ WorkspaceIDs []string

+ type Admin struct

+ Organizations AdminOrganizations

+ Runs AdminRuns

+ Settings *AdminSettings

+ TerraformVersions AdminTerraformVersions

+ Users AdminUsers

+ Workspaces AdminWorkspaces

+ type AdminCostEstimationSetting struct

+ AWSAccessKey string

+ AWSAccessKeyID string

+ AWSEnabled bool

+ AWSInstanceProfileEnabled bool

+ AzureClientID string

+ AzureClientSecret string

+ AzureEnabled bool

+ AzureSubscriptionID string

+ AzureTenantID string

+ Enabled bool

+ GCPCredentials string

+ GCPEnabled bool

+ ID string

+ type AdminCostEstimationSettingOptions struct

+ AWSAccessKey *string

+ AWSAccessKeyID *string

+ AzureClientID *string

+ AzureClientSecret *string

+ AzureSubscriptionID *string

+ AzureTenantID *string

+ Enabled *bool

+ GCPCredentials *string

+ type AdminCustomizationSetting struct

+ Error string

+ Footer string

+ ID string

+ LoginHelp string

+ NewUser string

+ SupportEmail string

+ type AdminCustomizationSettingsUpdateOptions struct

+ Error *string

+ Footer *string

+ LoginHelp *string

+ NewUser *string

+ SupportEmail *string

+ type AdminGeneralSetting struct

+ APIRateLimit int

+ APIRateLimitingEnabled bool

+ AllowSpeculativePlansOnPR bool

+ DefaultOrgsPerUserCeiling int

+ DefaultRemoteStateAccess bool

+ DefaultWorkspacesPerOrgCeiling int

+ FairRunQueuingEnabled bool

+ ID string

+ LimitOrgsPerUser bool

+ LimitUserOrganizationCreation bool

+ LimitWorkspacesPerOrg bool

+ RequireTwoFactorForAdmin bool

+ SendPassingStatusesEnabled bool

+ TerraformBuildWorkerApplyTimeout string

+ TerraformBuildWorkerPlanTimeout string

+ type AdminGeneralSettingsUpdateOptions struct

+ APIRateLimit *int

+ APIRateLimitingEnabled *bool

+ AllowSpeculativePlansOnPR *bool

+ DefaultRemoteStateAccess *bool

+ LimitUserOrgCreation *bool

+ SendPassingStatusUntriggeredPlans *bool

+ type AdminOrgIncludeOpt string

+ const AdminOrgOwners

+ type AdminOrganization struct

+ AccessBetaTools bool

+ ExternalID string

+ GlobalModuleSharing *bool

+ IsDisabled bool

+ Name string

+ NotificationEmail string

+ Owners []*User

+ SsoEnabled bool

+ TerraformBuildWorkerApplyTimeout string

+ TerraformBuildWorkerPlanTimeout string

+ TerraformWorkerSudoEnabled bool

+ WorkspaceLimit *int

+ type AdminOrganizationID struct

+ ID string

+ type AdminOrganizationList struct

+ Items []*AdminOrganization

+ type AdminOrganizationListModuleConsumersOptions struct

+ type AdminOrganizationListOptions struct

+ Include []AdminOrgIncludeOpt

+ Query string

+ type AdminOrganizationUpdateOptions struct

+ AccessBetaTools *bool

+ GlobalModuleSharing *bool

+ IsDisabled *bool

+ TerraformBuildWorkerApplyTimeout *string

+ TerraformBuildWorkerPlanTimeout *string

+ TerraformWorkerSudoEnabled bool

+ WorkspaceLimit *int

+ type AdminOrganizations interface

+ Delete func(ctx context.Context, organization string) error

+ List func(ctx context.Context, options *AdminOrganizationListOptions) (*AdminOrganizationList, error)

+ ListModuleConsumers func(ctx context.Context, organization string, ...) (*AdminOrganizationList, error)

+ Read func(ctx context.Context, organization string) (*AdminOrganization, error)

+ Update func(ctx context.Context, organization string, ...) (*AdminOrganization, error)

+ UpdateModuleConsumers func(ctx context.Context, organization string, consumerOrganizations []string) error

+ type AdminRun struct

+ CreatedAt time.Time

+ HasChanges bool

+ ID string

+ Organization *AdminOrganization

+ Status RunStatus

+ StatusTimestamps *RunStatusTimestamps

+ Workspace *AdminWorkspace

+ type AdminRunForceCancelOptions struct

+ Comment *string

+ type AdminRunIncludeOpt string

+ const AdminRunWorkspace

+ const AdminRunWorkspaceOrg

+ const AdminRunWorkspaceOrgOwners

+ type AdminRuns interface

+ ForceCancel func(ctx context.Context, runID string, options AdminRunForceCancelOptions) error

+ List func(ctx context.Context, options *AdminRunsListOptions) (*AdminRunsList, error)

+ type AdminRunsList struct

+ Items []*AdminRun

+ type AdminRunsListOptions struct

+ Include []AdminRunIncludeOpt

+ Query string

+ RunStatus string

+ type AdminSAMLSetting struct

+ ACSConsumerURL string

+ AttrGroups string

+ AttrSiteAdmin string

+ AttrUsername string

+ AuthnRequestsSigned bool

+ Certificate string

+ Debug bool

+ Enabled bool

+ ID string

+ IDPCert string

+ MetadataURL string

+ OldIDPCert string

+ PrivateKey string

+ SLOEndpointURL string

+ SSOAPITokenSessionTimeout int

+ SSOEndpointURL string

+ SiteAdminRole string

+ TeamManagementEnabled bool

+ WantAssertionsSigned bool

+ type AdminSAMLSettingsUpdateOptions struct

+ AttrGroups *string

+ AttrSiteAdmin *string

+ AttrUsername *string

+ Debug *bool

+ Enabled *bool

+ IDPCert *string

+ SLOEndpointURL *string

+ SSOAPITokenSessionTimeout *int

+ SSOEndpointURL *string

+ SiteAdminRole *string

+ type AdminSMTPSetting struct

+ Auth SMTPAuthType

+ Enabled bool

+ Host string

+ ID string

+ Port int

+ Sender string

+ Username string

+ type AdminSMTPSettingsUpdateOptions struct

+ Auth *SMTPAuthType

+ Enabled *bool

+ Host *string

+ Password *string

+ Port *int

+ Sender *string

+ TestEmailAddress *string

+ Username *string

+ type AdminSettings struct

+ CostEstimation CostEstimationSettings

+ Customization CustomizationSettings

+ General GeneralSettings

+ OIDC OIDCSettings

+ SAML SAMLSettings

+ SMTP SMTPSettings

+ Twilio TwilioSettings

+ type AdminTerraformVersion struct

+ Beta bool

+ CreatedAt time.Time

+ Deprecated bool

+ DeprecatedReason *string

+ Enabled bool

+ ID string

+ Official bool

+ Sha string

+ URL string

+ Usage int

+ Version string

+ type AdminTerraformVersionCreateOptions struct

+ Beta *bool

+ Deprecated *bool

+ DeprecatedReason *string

+ Enabled *bool

+ Official *bool

+ Sha *string

+ Type string

+ URL *string

+ Version *string

+ type AdminTerraformVersionUpdateOptions struct

+ Beta *bool

+ Deprecated *bool

+ DeprecatedReason *string

+ Enabled *bool

+ Official *bool

+ Sha *string

+ Type string

+ URL *string

+ Version *string

+ type AdminTerraformVersions interface

+ Create func(ctx context.Context, options AdminTerraformVersionCreateOptions) (*AdminTerraformVersion, error)

+ Delete func(ctx context.Context, id string) error

+ List func(ctx context.Context, options *AdminTerraformVersionsListOptions) (*AdminTerraformVersionsList, error)

+ Read func(ctx context.Context, id string) (*AdminTerraformVersion, error)

+ Update func(ctx context.Context, id string, options AdminTerraformVersionUpdateOptions) (*AdminTerraformVersion, error)

+ type AdminTerraformVersionsList struct

+ Items []*AdminTerraformVersion

+ type AdminTerraformVersionsListOptions struct

+ Filter string

+ Search string

+ type AdminTwilioSetting struct

+ AccountSid string

+ Enabled bool

+ FromNumber string

+ ID string

+ type AdminTwilioSettingsUpdateOptions struct

+ AccountSid *string

+ AuthToken *string

+ Enabled *bool

+ FromNumber *string

+ type AdminTwilioSettingsVerifyOptions struct

+ TestNumber *string

+ type AdminUser struct

+ AvatarURL string

+ Email string

+ ID string

+ IsAdmin bool

+ IsServiceAccount bool

+ IsSuspended bool

+ Organizations []*Organization

+ TwoFactor *TwoFactor

+ Username string

+ type AdminUserIncludeOpt string

+ const AdminUserOrgs

+ type AdminUserList struct

+ Items []*AdminUser

+ type AdminUserListOptions struct

+ Administrators string

+ Include []AdminUserIncludeOpt

+ Query string

+ SuspendedUsers string

+ type AdminUsers interface

+ Delete func(ctx context.Context, userID string) error

+ Disable2FA func(ctx context.Context, userID string) (*AdminUser, error)

+ GrantAdmin func(ctx context.Context, userID string) (*AdminUser, error)

+ List func(ctx context.Context, options *AdminUserListOptions) (*AdminUserList, error)

+ RevokeAdmin func(ctx context.Context, userID string) (*AdminUser, error)

+ Suspend func(ctx context.Context, userID string) (*AdminUser, error)

+ Unsuspend func(ctx context.Context, userID string) (*AdminUser, error)

+ type AdminVCSRepo struct

+ Identifier string

+ type AdminWorkspace struct

+ CurrentRun *Run

+ ID string

+ Locked bool

+ Name string

+ Organization *Organization

+ VCSRepo *AdminVCSRepo

+ type AdminWorkspaceIncludeOpt string

+ const AdminWorkspaceCurrentRun

+ const AdminWorkspaceOrg

+ const AdminWorkspaceOrgOwners

+ type AdminWorkspaceList struct

+ Items []*AdminWorkspace

+ type AdminWorkspaceListOptions struct

+ Filter string

+ Include []AdminWorkspaceIncludeOpt

+ Query string

+ Sort string

+ type AdminWorkspaces interface

+ Delete func(ctx context.Context, workspaceID string) error

+ List func(ctx context.Context, options *AdminWorkspaceListOptions) (*AdminWorkspaceList, error)

+ Read func(ctx context.Context, workspaceID string) (*AdminWorkspace, error)

+ type Agent struct

+ ID string

+ IP string

+ LastPingAt string

+ Name string

+ Status string

+ type AgentList struct

+ Items []*Agent

+ type AgentListOptions struct

+ LastPingSince time.Time

+ type AgentPool struct

+ AgentCount int

+ AllowedWorkspaces []*Workspace

+ ID string

+ Name string

+ Organization *Organization

+ OrganizationScoped bool

+ Workspaces []*Workspace

+ type AgentPoolAllowedWorkspacesUpdateOptions struct

+ AllowedWorkspaces []*Workspace

+ Type string

+ type AgentPoolCreateOptions struct

+ AllowedWorkspaces []*Workspace

+ Name *string

+ OrganizationScoped *bool

+ Type string

+ type AgentPoolIncludeOpt string

+ const AgentPoolWorkspaces

+ type AgentPoolList struct

+ Items []*AgentPool

+ type AgentPoolListOptions struct

+ AllowedWorkspacesName string

+ Include []AgentPoolIncludeOpt

+ Query string

+ type AgentPoolReadOptions struct

+ Include []AgentPoolIncludeOpt

+ type AgentPoolUpdateOptions struct

+ AllowedWorkspaces []*Workspace

+ Name *string

+ OrganizationScoped *bool

+ Type string

+ type AgentPools interface

+ Create func(ctx context.Context, organization string, options AgentPoolCreateOptions) (*AgentPool, error)

+ Delete func(ctx context.Context, agentPoolID string) error

+ List func(ctx context.Context, organization string, options *AgentPoolListOptions) (*AgentPoolList, error)

+ Read func(ctx context.Context, agentPoolID string) (*AgentPool, error)

+ ReadWithOptions func(ctx context.Context, agentPoolID string, options *AgentPoolReadOptions) (*AgentPool, error)

+ Update func(ctx context.Context, agentPool string, options AgentPoolUpdateOptions) (*AgentPool, error)

+ UpdateAllowedWorkspaces func(ctx context.Context, agentPool string, ...) (*AgentPool, error)

+ type AgentToken struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type AgentTokenCreateOptions struct

+ Description *string

+ Type string

+ type AgentTokenList struct

+ Items []*AgentToken

+ type AgentTokens interface

+ Create func(ctx context.Context, agentPoolID string, options AgentTokenCreateOptions) (*AgentToken, error)

+ Delete func(ctx context.Context, agentTokenID string) error

+ List func(ctx context.Context, agentPoolID string) (*AgentTokenList, error)

+ Read func(ctx context.Context, agentTokenID string) (*AgentToken, error)

+ type Agents interface

+ List func(ctx context.Context, agentPoolID string, options *AgentListOptions) (*AgentList, error)

+ Read func(ctx context.Context, agentID string) (*Agent, error)

type Apply

+ ResourceImports int

+ type AuditTrail struct

+ Auth AuditTrailAuth

+ ID string

+ Request AuditTrailRequest

+ Resource AuditTrailResource

+ Timestamp time.Time

+ Type string

+ Version string

+ type AuditTrailAuth struct

+ AccessorID string

+ Description string

+ ImpersonatorID *string

+ OrganizationID string

+ Type string

+ type AuditTrailList struct

+ Items []*AuditTrail

+ type AuditTrailListOptions struct

+ Since time.Time

+ type AuditTrailPagination struct

+ CurrentPage int

+ NextPage int

+ PreviousPage int

+ TotalCount int

+ TotalPages int

+ type AuditTrailRequest struct

+ ID string

+ type AuditTrailResource struct

+ Action string

+ ID string

+ Meta map[string]interface{}

+ Type string

+ type AuditTrails interface

+ List func(ctx context.Context, options *AuditTrailListOptions) (*AuditTrailList, error)

type CVStatusTimestamps

+ ArchivedAt time.Time

+ FetchingAt time.Time

type CategoryType

+ const CategoryPolicySet

type Client

+ Admin Admin

+ AgentPools AgentPools

+ AgentTokens AgentTokens

+ Agents Agents

+ AuditTrails AuditTrails

+ Comments Comments

+ CostEstimates CostEstimates

+ GHAInstallations GHAInstallations

+ GPGKeys GPGKeys

+ Meta Meta

+ NotificationConfigurations NotificationConfigurations

+ OrganizationMemberships OrganizationMemberships

+ OrganizationTags OrganizationTags

+ PlanExports PlanExports

+ PolicyEvaluations PolicyEvaluations

+ PolicySetOutcomes PolicySetOutcomes

+ PolicySetParameters PolicySetParameters

+ PolicySetVersions PolicySetVersions

+ PolicySets PolicySets

+ Projects Projects

+ RegistryModules RegistryModules

+ RegistryNoCodeModules RegistryNoCodeModules

+ RegistryProviderPlatforms RegistryProviderPlatforms

+ RegistryProviderVersions RegistryProviderVersions

+ RegistryProviders RegistryProviders

+ RunEvents RunEvents

+ RunTasks RunTasks

+ RunTriggers RunTriggers

+ StateVersionOutputs StateVersionOutputs

+ TaskResults TaskResults

+ TaskStages TaskStages

+ TeamProjectAccess TeamProjectAccesses

+ UserTokens UserTokens

+ VariableSetVariables VariableSetVariables

+ VariableSets VariableSets

+ WorkspaceRunTasks WorkspaceRunTasks

+ func (c *Client) NewRequest(method, path string, reqAttr any) (*ClientRequest, error)

+ func (c *Client) NewRequestWithAdditionalQueryParams(method, path string, reqAttr any, additionalQueryParams map[string][]string) (*ClientRequest, error)

+ func (c *Client) RetryServerErrors(retry bool)

+ func (c *Client) SetFakeRemoteAPIVersion(fakeAPIVersion string)

+ func (c Client) BaseRegistryURL() url.URL

+ func (c Client) BaseURL() url.URL

+ func (c Client) IsCloud() bool

+ func (c Client) IsEnterprise() bool

+ func (c Client) RemoteAPIVersion() string

+ func (c Client) RemoteTFEVersion() string

+ type ClientRequest struct

+ Header http.Header

+ func (r *ClientRequest) DoJSON(ctx context.Context, model any) error

+ func (r ClientRequest) Do(ctx context.Context, model interface{}) error

+ type Comment struct

+ Body string

+ ID string

+ type CommentCreateOptions struct

+ Body string

+ Type string

+ type CommentList struct

+ Items []*Comment

+ type Comments interface

+ Create func(ctx context.Context, runID string, options CommentCreateOptions) (*Comment, error)

+ List func(ctx context.Context, runID string) (*CommentList, error)

+ Read func(ctx context.Context, commentID string) (*Comment, error)

type Config

+ RegistryBasePath string

+ RetryLogHook RetryLogHook

+ RetryServerErrors bool

+ type ConfigVerIncludeOpt string

+ const ConfigVerIngressAttributes

+ const ConfigVerRun

type ConfigurationSource

+ const ConfigurationSourceAdo

type ConfigurationStatus

+ const ConfigurationArchived

+ const ConfigurationFetching

type ConfigurationVersion

+ IngressAttributes *IngressAttributes

type ConfigurationVersionCreateOptions

+ Type string

type ConfigurationVersionListOptions

+ Include []ConfigVerIncludeOpt

+ type ConfigurationVersionReadOptions struct

+ Include []ConfigVerIncludeOpt

type ConfigurationVersions

+ Archive func(ctx context.Context, cvID string) error

+ Download func(ctx context.Context, cvID string) ([]byte, error)

+ ReadWithOptions func(ctx context.Context, cvID string, options *ConfigurationVersionReadOptions) (*ConfigurationVersion, error)

+ UploadTarGzip func(ctx context.Context, url string, archive io.Reader) error

+ type CostEstimate struct

+ DeltaMonthlyCost string

+ ErrorMessage string

+ ID string

+ MatchedResourcesCount int

+ PriorMonthlyCost string

+ ProposedMonthlyCost string

+ ResourcesCount int

+ Status CostEstimateStatus

+ StatusTimestamps *CostEstimateStatusTimestamps

+ UnmatchedResourcesCount int

+ type CostEstimateStatus string

+ const CostEstimateCanceled

+ const CostEstimateErrored

+ const CostEstimateFinished

+ const CostEstimatePending

+ const CostEstimateQueued

+ const CostEstimateSkippedDueToTargeting

+ type CostEstimateStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ PendingAt time.Time

+ QueuedAt time.Time

+ SkippedDueToTargetingAt time.Time

+ type CostEstimates interface

+ Logs func(ctx context.Context, costEstimateID string) (io.Reader, error)

+ Read func(ctx context.Context, costEstimateID string) (*CostEstimate, error)

+ type CostEstimationSettings interface

+ Read func(ctx context.Context) (*AdminCostEstimationSetting, error)

+ Update func(ctx context.Context, options AdminCostEstimationSettingOptions) (*AdminCostEstimationSetting, error)

+ type CustomizationSettings interface

+ Read func(ctx context.Context) (*AdminCustomizationSetting, error)

+ Update func(ctx context.Context, options AdminCustomizationSettingsUpdateOptions) (*AdminCustomizationSetting, error)

+ type DeliveryResponse struct

+ Body string

+ Code string

+ Headers map[string][]string

+ SentAt time.Time

+ Successful string

+ URL string

type EnforcementLevel

+ const EnforcementMandatory

+ type Entitlements struct

+ Agents bool

+ AuditLogging bool

+ CostEstimation bool

+ ID string

+ Operations bool

+ PrivateModuleRegistry bool

+ RunTasks bool

+ SSO bool

+ Sentinel bool

+ StateStorage bool

+ Teams bool

+ VCSIntegrations bool

+ type GHAInstallation struct

+ ID *string

+ InstallationID *int

+ Name *string

+ type GHAInstallationList struct

+ Items []*GHAInstallation

+ type GHAInstallationListOptions struct

+ type GHAInstallations interface

+ List func(ctx context.Context, options *GHAInstallationListOptions) (*GHAInstallationList, error)

+ Read func(ctx context.Context, GHAInstallationID string) (*GHAInstallation, error)

+ type GPGKey struct

+ AsciiArmor string

+ CreatedAt time.Time

+ ID string

+ KeyID string

+ Namespace string

+ Source string

+ SourceURL *string

+ TrustSignature string

+ UpdatedAt time.Time

+ type GPGKeyCreateOptions struct

+ AsciiArmor string

+ Namespace string

+ Type string

+ type GPGKeyID struct

+ KeyID string

+ Namespace string

+ RegistryName RegistryName

+ type GPGKeyList struct

+ Items []*GPGKey

+ type GPGKeyListOptions struct

+ Namespaces []string

+ type GPGKeyUpdateOptions struct

+ Namespace string

+ Type string

+ type GPGKeys interface

+ Create func(ctx context.Context, registryName RegistryName, options GPGKeyCreateOptions) (*GPGKey, error)

+ Delete func(ctx context.Context, keyID GPGKeyID) error

+ ListPrivate func(ctx context.Context, options GPGKeyListOptions) (*GPGKeyList, error)

+ Read func(ctx context.Context, keyID GPGKeyID) (*GPGKey, error)

+ Update func(ctx context.Context, keyID GPGKeyID, options GPGKeyUpdateOptions) (*GPGKey, error)

+ type GeneralSettings interface

+ Read func(ctx context.Context) (*AdminGeneralSetting, error)

+ Update func(ctx context.Context, options AdminGeneralSettingsUpdateOptions) (*AdminGeneralSetting, error)

+ type IPRange struct

+ API []string

+ Notifications []string

+ Sentinel []string

+ VCS []string

+ type IPRanges interface

+ Read func(ctx context.Context, modifiedSince string) (*IPRange, error)

+ type IngressAttributes struct

+ Branch string

+ CloneURL string

+ CommitMessage string

+ CommitSHA string

+ CommitURL string

+ CompareURL string

+ ID string

+ Identifier string

+ IsPullRequest bool

+ Links map[string]interface{}

+ OnDefaultBranch bool

+ PullRequestBody string

+ PullRequestNumber int

+ PullRequestTitle string

+ PullRequestURL string

+ SenderAvatarURL string

+ SenderHTMLURL string

+ SenderUsername string

+ Tag string

+ type Meta struct

+ IPRanges IPRanges

+ type NoCodeVariableOption struct

+ Options []string

+ Type string

+ VariableName string

+ VariableType string

+ type NotificationConfiguration struct

+ CreatedAt time.Time

+ DeliveryResponses []*DeliveryResponse

+ DestinationType NotificationDestinationType

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled bool

+ ID string

+ Name string

+ Subscribable *Workspace

+ Token string

+ Triggers []string

+ URL string

+ UpdatedAt time.Time

+ type NotificationConfigurationCreateOptions struct

+ DestinationType *NotificationDestinationType

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled *bool

+ Name *string

+ Token *string

+ Triggers []NotificationTriggerType

+ Type string

+ URL *string

+ type NotificationConfigurationList struct

+ Items []*NotificationConfiguration

+ type NotificationConfigurationListOptions struct

+ type NotificationConfigurationUpdateOptions struct

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled *bool

+ Name *string

+ Token *string

+ Triggers []NotificationTriggerType

+ Type string

+ URL *string

+ type NotificationConfigurations interface

+ Create func(ctx context.Context, workspaceID string, ...) (*NotificationConfiguration, error)

+ Delete func(ctx context.Context, notificationConfigurationID string) error

+ List func(ctx context.Context, workspaceID string, ...) (*NotificationConfigurationList, error)

+ Read func(ctx context.Context, notificationConfigurationID string) (*NotificationConfiguration, error)

+ Update func(ctx context.Context, notificationConfigurationID string, ...) (*NotificationConfiguration, error)

+ Verify func(ctx context.Context, notificationConfigurationID string) (*NotificationConfiguration, error)

+ type NotificationDestinationType string

+ const NotificationDestinationTypeEmail

+ const NotificationDestinationTypeGeneric

+ const NotificationDestinationTypeMicrosoftTeams

+ const NotificationDestinationTypeSlack

+ func NotificationDestination(v NotificationDestinationType) *NotificationDestinationType

+ type NotificationTriggerType string

+ const NotificationTriggerApplying

+ const NotificationTriggerAssessmentCheckFailed

+ const NotificationTriggerAssessmentDrifted

+ const NotificationTriggerAssessmentFailed

+ const NotificationTriggerCompleted

+ const NotificationTriggerCreated

+ const NotificationTriggerErrored

+ const NotificationTriggerNeedsAttention

+ const NotificationTriggerPlanning

type OAuthClient

+ Name *string

+ Secret string

type OAuthClientCreateOptions

+ Name *string

+ PrivateKey *string

+ RSAPublicKey *string

+ Type string

+ type OAuthClientIncludeOpt string

+ const OauthClientOauthTokens

type OAuthClientListOptions

+ Include []OAuthClientIncludeOpt

+ type OAuthClientUpdateOptions struct

+ Key *string

+ Name *string

+ OAuthToken *string

+ RSAPublicKey *string

+ Secret *string

+ Type string

type OAuthClients

+ Update func(ctx context.Context, oAuthClientID string, options OAuthClientUpdateOptions) (*OAuthClient, error)

type OAuthTokenUpdateOptions

+ Type string

+ type OIDCSettings interface

+ RotateKey func(ctx context.Context) error

+ TrimKey func(ctx context.Context) error

+ type OrgMembershipIncludeOpt string

+ const OrgMembershipTeam

+ const OrgMembershipUser

type Organization

+ AllowForceDeleteWorkspaces bool

+ AssessmentsEnforced bool

+ CostEstimationEnabled bool

+ DefaultProject *Project

+ ExternalID string

+ OwnersTeamSAMLRoleID string

+ SendPassingStatusesForUntriggeredSpeculativePlans bool

+ type OrganizationAccess struct

+ ManageMembership bool

+ ManageModules bool

+ ManagePolicies bool

+ ManagePolicyOverrides bool

+ ManageProjects bool

+ ManageProviders bool

+ ManageRunTasks bool

+ ManageVCSSettings bool

+ ManageWorkspaces bool

+ ReadProjects bool

+ ReadWorkspaces bool

+ type OrganizationAccessOptions struct

+ ManageMembership *bool

+ ManageModules *bool

+ ManagePolicies *bool

+ ManagePolicyOverrides *bool

+ ManageProjects *bool

+ ManageProviders *bool

+ ManageRunTasks *bool

+ ManageVCSSettings *bool

+ ManageWorkspaces *bool

+ ReadProjects *bool

+ ReadWorkspaces *bool

type OrganizationCreateOptions

+ AllowForceDeleteWorkspaces *bool

+ AssessmentsEnforced *bool

+ CollaboratorAuthPolicy *AuthPolicyType

+ CostEstimationEnabled *bool

+ OwnersTeamSAMLRoleID *string

+ SendPassingStatusesForUntriggeredSpeculativePlans *bool

+ SessionRemember *int

+ SessionTimeout *int

+ Type string

+ type OrganizationIncludeOpt string

+ const OrganizationDefaultProject

type OrganizationListOptions

+ Query string

+ type OrganizationMembership struct

+ Email string

+ ID string

+ Organization *Organization

+ Status OrganizationMembershipStatus

+ Teams []*Team

+ User *User

+ type OrganizationMembershipCreateOptions struct

+ Email *string

+ Type string

+ type OrganizationMembershipList struct

+ Items []*OrganizationMembership

+ type OrganizationMembershipListOptions struct

+ Emails []string

+ Include []OrgMembershipIncludeOpt

+ Query string

+ Status OrganizationMembershipStatus

+ type OrganizationMembershipReadOptions struct

+ Include []OrgMembershipIncludeOpt

+ type OrganizationMembershipStatus string

+ const OrganizationMembershipActive

+ const OrganizationMembershipInvited

+ type OrganizationMemberships interface

+ Create func(ctx context.Context, organization string, ...) (*OrganizationMembership, error)

+ Delete func(ctx context.Context, organizationMembershipID string) error

+ List func(ctx context.Context, organization string, ...) (*OrganizationMembershipList, error)

+ Read func(ctx context.Context, organizationMembershipID string) (*OrganizationMembership, error)

+ ReadWithOptions func(ctx context.Context, organizationMembershipID string, ...) (*OrganizationMembership, error)

type OrganizationPermissions

+ CanManageRunTasks bool

+ type OrganizationReadOptions struct

+ Include []OrganizationIncludeOpt

+ type OrganizationTag struct

+ ID string

+ InstanceCount int

+ Name string

+ Organization *Organization

+ type OrganizationTags interface

+ AddWorkspaces func(ctx context.Context, tag string, options AddWorkspacesToTagOptions) error

+ Delete func(ctx context.Context, organization string, ...) error

+ List func(ctx context.Context, organization string, options *OrganizationTagsListOptions) (*OrganizationTagsList, error)

+ type OrganizationTagsDeleteOptions struct

+ IDs []string

+ type OrganizationTagsList struct

+ Items []*OrganizationTag

+ type OrganizationTagsListOptions struct

+ Filter string

+ Query string

type OrganizationToken

+ ExpiredAt time.Time

+ type OrganizationTokenCreateOptions struct

+ ExpiredAt *time.Time

type OrganizationTokens

+ Create func(ctx context.Context, organization string) (*OrganizationToken, error)

+ CreateWithOptions func(ctx context.Context, organization string, ...) (*OrganizationToken, error)

type OrganizationUpdateOptions

+ AllowForceDeleteWorkspaces *bool

+ AssessmentsEnforced *bool

+ CostEstimationEnabled *bool

+ OwnersTeamSAMLRoleID *string

+ SendPassingStatusesForUntriggeredSpeculativePlans *bool

+ Type string

type Organizations

+ ReadCapacity func(ctx context.Context, organization string) (*Capacity, error)

+ ReadEntitlements func(ctx context.Context, organization string) (*Entitlements, error)

+ ReadRunQueue func(ctx context.Context, organization string, options ReadRunQueueOptions) (*RunQueue, error)

+ ReadWithOptions func(ctx context.Context, organization string, options OrganizationReadOptions) (*Organization, error)

+ type Outcome struct

+ Description string

+ EnforcementLevel EnforcementLevel

+ PolicyName string

+ Query string

+ Status string

+ type Permissions struct

+ CanOverride *bool

+ CanOverridePolicy *bool

+ CanOverrideTasks *bool

type Plan

+ Exports []*PlanExport

+ GeneratedConfiguration bool

+ ResourceImports int

+ type PlanExport struct

+ DataType PlanExportDataType

+ ID string

+ Status PlanExportStatus

+ StatusTimestamps *PlanExportStatusTimestamps

+ type PlanExportCreateOptions struct

+ DataType *PlanExportDataType

+ Plan *Plan

+ Type string

+ type PlanExportDataType string

+ const PlanExportSentinelMockBundleV0

+ func PlanExportType(v PlanExportDataType) *PlanExportDataType

+ type PlanExportStatus string

+ const PlanExportCanceled

+ const PlanExportErrored

+ const PlanExportExpired

+ const PlanExportFinished

+ const PlanExportPending

+ const PlanExportQueued

+ type PlanExportStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ ExpiredAt time.Time

+ FinishedAt time.Time

+ QueuedAt time.Time

+ type PlanExports interface

+ Create func(ctx context.Context, options PlanExportCreateOptions) (*PlanExport, error)

+ Delete func(ctx context.Context, planExportID string) error

+ Download func(ctx context.Context, planExportID string) ([]byte, error)

+ Read func(ctx context.Context, planExportID string) (*PlanExport, error)

type Plans

+ ReadJSONOutput func(ctx context.Context, planID string) ([]byte, error)

type Policy

+ Description string

+ Kind PolicyKind

+ Organization *Organization

+ PolicySetCount int

+ Query *string

+ type PolicyAttachable struct

+ ID string

+ Type string

type PolicyCheck

+ Run *Run

+ type PolicyCheckIncludeOpt string

+ const PolicyCheckRun

+ const PolicyCheckRunWorkspace

type PolicyCheckListOptions

+ Include []PolicyCheckIncludeOpt

type PolicyCreateOptions

+ Description *string

+ Kind PolicyKind

+ Query *string

+ Type string

+ type PolicyEvaluation struct

+ CreatedAt time.Time

+ ID string

+ PolicyKind PolicyKind

+ ResultCount *PolicyResultCount

+ Status PolicyEvaluationStatus

+ StatusTimestamps PolicyEvaluationStatusTimestamps

+ TaskStage *PolicyAttachable

+ UpdatedAt time.Time

+ type PolicyEvaluationList struct

+ Items []*PolicyEvaluation

+ type PolicyEvaluationListOptions struct

+ type PolicyEvaluationStatus string

+ const PolicyEvaluationCanceled

+ const PolicyEvaluationErrored

+ const PolicyEvaluationFailed

+ const PolicyEvaluationOverridden

+ const PolicyEvaluationPassed

+ const PolicyEvaluationPending

+ const PolicyEvaluationRunning

+ const PolicyEvaluationUnreachable

+ type PolicyEvaluationStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FailedAt time.Time

+ PassedAt time.Time

+ RunningAt time.Time

+ type PolicyEvaluations interface

+ List func(ctx context.Context, taskStageID string, options *PolicyEvaluationListOptions) (*PolicyEvaluationList, error)

+ type PolicyKind string

+ const OPA

+ const Sentinel

type PolicyListOptions

+ Kind PolicyKind

+ Search string

+ type PolicyResultCount struct

+ AdvisoryFailed int

+ Errored int

+ MandatoryFailed int

+ Passed int

+ type PolicySet struct

+ CreatedAt time.Time

+ CurrentVersion *PolicySetVersion

+ Description string

+ Global bool

+ ID string

+ Kind PolicyKind

+ Name string

+ NewestVersion *PolicySetVersion

+ Organization *Organization

+ Overridable *bool

+ Policies []*Policy

+ PoliciesPath string

+ PolicyCount int

+ UpdatedAt time.Time

+ VCSRepo *VCSRepo

+ WorkspaceCount int

+ Workspaces []*Workspace

+ type PolicySetAddPoliciesOptions struct

+ Policies []*Policy

+ type PolicySetAddWorkspacesOptions struct

+ Workspaces []*Workspace

+ type PolicySetCreateOptions struct

+ Description *string

+ Global *bool

+ Kind PolicyKind

+ Name *string

+ Overridable *bool

+ Policies []*Policy

+ PoliciesPath *string

+ Type string

+ VCSRepo *VCSRepoOptions

+ Workspaces []*Workspace

+ type PolicySetIncludeOpt string

+ const PolicySetCurrentVersion

+ const PolicySetNewestVersion

+ const PolicySetPolicies

+ const PolicySetWorkspaces

+ type PolicySetList struct

+ Items []*PolicySet

+ type PolicySetListOptions struct

+ Include []PolicySetIncludeOpt

+ Kind PolicyKind

+ Search string

+ type PolicySetOutcome struct

+ Error string

+ ID string

+ Outcomes []Outcome

+ Overridable *bool

+ PolicyEvaluation *PolicyEvaluation

+ PolicySetDescription string

+ PolicySetName string

+ ResultCount PolicyResultCount

+ type PolicySetOutcomeList struct

+ Items []*PolicySetOutcome

+ type PolicySetOutcomeListFilter struct

+ EnforcementLevel string

+ Status string

+ type PolicySetOutcomeListOptions struct

+ Filter map[string]PolicySetOutcomeListFilter

+ type PolicySetOutcomes interface

+ List func(ctx context.Context, policyEvaluationID string, ...) (*PolicySetOutcomeList, error)

+ Read func(ctx context.Context, policySetOutcomeID string) (*PolicySetOutcome, error)

+ type PolicySetParameter struct

+ Category CategoryType

+ ID string

+ Key string

+ PolicySet *PolicySet

+ Sensitive bool

+ Value string

+ type PolicySetParameterCreateOptions struct

+ Category *CategoryType

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type PolicySetParameterList struct

+ Items []*PolicySetParameter

+ type PolicySetParameterListOptions struct

+ type PolicySetParameterUpdateOptions struct

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type PolicySetParameters interface

+ Create func(ctx context.Context, policySetID string, ...) (*PolicySetParameter, error)

+ Delete func(ctx context.Context, policySetID string, parameterID string) error

+ List func(ctx context.Context, policySetID string, ...) (*PolicySetParameterList, error)

+ Read func(ctx context.Context, policySetID string, parameterID string) (*PolicySetParameter, error)

+ Update func(ctx context.Context, policySetID string, parameterID string, ...) (*PolicySetParameter, error)

+ type PolicySetReadOptions struct

+ Include []PolicySetIncludeOpt

+ type PolicySetRemovePoliciesOptions struct

+ Policies []*Policy

+ type PolicySetRemoveWorkspacesOptions struct

+ Workspaces []*Workspace

+ type PolicySetUpdateOptions struct

+ Description *string

+ Global *bool

+ Name *string

+ Overridable *bool

+ PoliciesPath *string

+ Type string

+ VCSRepo *VCSRepoOptions

+ type PolicySetVersion struct

+ CreatedAt time.Time

+ Error string

+ ErrorMessage string

+ ID string

+ Links map[string]interface{}

+ PolicySet *PolicySet

+ Source PolicySetVersionSource

+ Status PolicySetVersionStatus

+ StatusTimestamps PolicySetVersionStatusTimestamps

+ UpdatedAt time.Time

+ type PolicySetVersionSource string

+ const PolicySetVersionSourceADO

+ const PolicySetVersionSourceAPI

+ const PolicySetVersionSourceBitBucket

+ const PolicySetVersionSourceGitHub

+ const PolicySetVersionSourceGitLab

+ type PolicySetVersionStatus string

+ const PolicySetVersionErrored

+ const PolicySetVersionIngressing

+ const PolicySetVersionPending

+ const PolicySetVersionReady

+ type PolicySetVersionStatusTimestamps struct

+ ErroredAt time.Time

+ IngressingAt time.Time

+ PendingAt time.Time

+ ReadyAt time.Time

+ type PolicySetVersions interface

+ Create func(ctx context.Context, policySetID string) (*PolicySetVersion, error)

+ Read func(ctx context.Context, policySetVersionID string) (*PolicySetVersion, error)

+ Upload func(ctx context.Context, psv PolicySetVersion, path string) error

+ type PolicySets interface

+ AddPolicies func(ctx context.Context, policySetID string, options PolicySetAddPoliciesOptions) error

+ AddWorkspaces func(ctx context.Context, policySetID string, options PolicySetAddWorkspacesOptions) error

+ Create func(ctx context.Context, organization string, options PolicySetCreateOptions) (*PolicySet, error)

+ Delete func(ctx context.Context, policyID string) error

+ List func(ctx context.Context, organization string, options *PolicySetListOptions) (*PolicySetList, error)

+ Read func(ctx context.Context, policySetID string) (*PolicySet, error)

+ ReadWithOptions func(ctx context.Context, policySetID string, options *PolicySetReadOptions) (*PolicySet, error)

+ RemovePolicies func(ctx context.Context, policySetID string, ...) error

+ RemoveWorkspaces func(ctx context.Context, policySetID string, ...) error

+ Update func(ctx context.Context, policySetID string, options PolicySetUpdateOptions) (*PolicySet, error)

type PolicyStatus

+ const PolicyCanceled

type PolicyUpdateOptions

+ Description *string

+ Query *string

+ Type string

+ type Project struct

+ ID string

+ Name string

+ Organization *Organization

+ type ProjectCreateOptions struct

+ Name string

+ Type string

+ type ProjectList struct

+ Items []*Project

+ type ProjectListOptions struct

+ Name string

+ type ProjectUpdateOptions struct

+ Name *string

+ Type string

+ type Projects interface

+ Create func(ctx context.Context, organization string, options ProjectCreateOptions) (*Project, error)

+ Delete func(ctx context.Context, projectID string) error

+ List func(ctx context.Context, organization string, options *ProjectListOptions) (*ProjectList, error)

+ Read func(ctx context.Context, projectID string) (*Project, error)

+ Update func(ctx context.Context, projectID string, options ProjectUpdateOptions) (*Project, error)

+ type ProviderData struct

+ NullResource int

+ TerraformRemoteState int

+ type ReadRunQueueOptions struct

+ type RegistryModule struct

+ CreatedAt string

+ ID string

+ Name string

+ Namespace string

+ NoCode bool

+ Organization *Organization

+ Permissions *RegistryModulePermissions

+ Provider string

+ RegistryName RegistryName

+ Status RegistryModuleStatus

+ UpdatedAt string

+ VCSRepo *VCSRepo

+ VersionStatuses []RegistryModuleVersionStatuses

+ type RegistryModuleCreateOptions struct

+ Name *string

+ Namespace string

+ NoCode *bool

+ Provider *string

+ RegistryName RegistryName

+ Type string

+ type RegistryModuleCreateVersionOptions struct

+ Type string

+ Version *string

+ type RegistryModuleCreateWithVCSConnectionOptions struct

+ Type string

+ VCSRepo *RegistryModuleVCSRepoOptions

+ type RegistryModuleID struct

+ Name string

+ Namespace string

+ Organization string

+ Provider string

+ RegistryName RegistryName

+ type RegistryModuleList struct

+ Items []*RegistryModule

+ type RegistryModuleListOptions struct

+ type RegistryModulePermissions struct

+ CanDelete bool

+ CanResync bool

+ CanRetry bool

+ type RegistryModuleStatus string

+ const RegistryModuleStatusNoVersionTags

+ const RegistryModuleStatusPending

+ const RegistryModuleStatusSetupComplete

+ const RegistryModuleStatusSetupFailed

+ type RegistryModuleUpdateOptions struct

+ NoCode *bool

+ Type string

+ type RegistryModuleVCSRepoOptions struct

+ DisplayIdentifier *string

+ GHAInstallationID *string

+ Identifier *string

+ OAuthTokenID *string

+ OrganizationName *string

+ type RegistryModuleVersion struct

+ CreatedAt string

+ ID string

+ Links map[string]interface{}

+ RegistryModule *RegistryModule

+ Source string

+ Status RegistryModuleVersionStatus

+ UpdatedAt string

+ Version string

+ type RegistryModuleVersionStatus string

+ const RegistryModuleVersionStatusCloneFailed

+ const RegistryModuleVersionStatusCloning

+ const RegistryModuleVersionStatusOk

+ const RegistryModuleVersionStatusPending

+ const RegistryModuleVersionStatusRegIngressFailed

+ const RegistryModuleVersionStatusRegIngressReqFailed

+ const RegistryModuleVersionStatusRegIngressing

+ type RegistryModuleVersionStatuses struct

+ Error string

+ Status RegistryModuleVersionStatus

+ Version string

+ type RegistryModules interface

+ Create func(ctx context.Context, organization string, options RegistryModuleCreateOptions) (*RegistryModule, error)

+ CreateVersion func(ctx context.Context, moduleID RegistryModuleID, ...) (*RegistryModuleVersion, error)

+ CreateWithVCSConnection func(ctx context.Context, options RegistryModuleCreateWithVCSConnectionOptions) (*RegistryModule, error)

+ Delete func(ctx context.Context, organization string, name string) error

+ DeleteProvider func(ctx context.Context, moduleID RegistryModuleID) error

+ DeleteVersion func(ctx context.Context, moduleID RegistryModuleID, version string) error

+ List func(ctx context.Context, organization string, options *RegistryModuleListOptions) (*RegistryModuleList, error)

+ Read func(ctx context.Context, moduleID RegistryModuleID) (*RegistryModule, error)

+ Update func(ctx context.Context, moduleID RegistryModuleID, ...) (*RegistryModule, error)

+ Upload func(ctx context.Context, rmv RegistryModuleVersion, path string) error

+ UploadTarGzip func(ctx context.Context, url string, r io.Reader) error

+ type RegistryName string

+ const PrivateRegistry

+ const PublicRegistry

+ type RegistryNoCodeModule struct

+ Enabled bool

+ ID string

+ Organization *Organization

+ RegistryModule *RegistryModule

+ VariableOptions []*NoCodeVariableOption

+ VersionPin string

+ type RegistryNoCodeModuleCreateOptions struct

+ Enabled *bool

+ RegistryModule *RegistryModule

+ Type string

+ VariableOptions []*NoCodeVariableOption

+ VersionPin string

+ type RegistryNoCodeModuleIncludeOpt string

+ var RegistryNoCodeIncludeVariableOptions RegistryNoCodeModuleIncludeOpt = "variable-options"

+ type RegistryNoCodeModuleReadOptions struct

+ Include []RegistryNoCodeModuleIncludeOpt

+ Type string

+ type RegistryNoCodeModuleUpdateOptions struct

+ Enabled *bool

+ RegistryModule *RegistryModule

+ Type string

+ VariableOptions []*NoCodeVariableOption

+ VersionPin string

+ type RegistryNoCodeModules interface

+ Create func(ctx context.Context, organization string, ...) (*RegistryNoCodeModule, error)

+ Delete func(ctx context.Context, ID string) error

+ Read func(ctx context.Context, noCodeModuleID string, ...) (*RegistryNoCodeModule, error)

+ Update func(ctx context.Context, noCodeModuleID string, ...) (*RegistryNoCodeModule, error)

+ type RegistryProvider struct

+ CreatedAt string

+ ID string

+ Links map[string]interface{}

+ Name string

+ Namespace string

+ Organization *Organization

+ Permissions RegistryProviderPermissions

+ RegistryName RegistryName

+ RegistryProviderVersions []*RegistryProviderVersion

+ UpdatedAt string

+ type RegistryProviderCreateOptions struct

+ Name string

+ Namespace string

+ RegistryName RegistryName

+ Type string

+ type RegistryProviderID struct

+ Name string

+ Namespace string

+ OrganizationName string

+ RegistryName RegistryName

+ type RegistryProviderIncludeOps string

+ const RegistryProviderVersionsInclude

+ type RegistryProviderList struct

+ Items []*RegistryProvider

+ type RegistryProviderListOptions struct

+ Include *[]RegistryProviderIncludeOps

+ OrganizationName string

+ RegistryName RegistryName

+ Search string

+ type RegistryProviderPermissions struct

+ CanDelete bool

+ type RegistryProviderPlatform struct

+ Arch string

+ Filename string

+ ID string

+ Links map[string]interface{}

+ OS string

+ ProviderBinaryUploaded bool

+ RegistryProviderVersion *RegistryProviderVersion

+ Shasum string

+ type RegistryProviderPlatformCreateOptions struct

+ Arch string

+ Filename string

+ OS string

+ Shasum string

+ type RegistryProviderPlatformID struct

+ Arch string

+ OS string

+ type RegistryProviderPlatformList struct

+ Items []*RegistryProviderPlatform

+ type RegistryProviderPlatformListOptions struct

+ type RegistryProviderPlatforms interface

+ Create func(ctx context.Context, versionID RegistryProviderVersionID, ...) (*RegistryProviderPlatform, error)

+ Delete func(ctx context.Context, platformID RegistryProviderPlatformID) error

+ List func(ctx context.Context, versionID RegistryProviderVersionID, ...) (*RegistryProviderPlatformList, error)

+ Read func(ctx context.Context, platformID RegistryProviderPlatformID) (*RegistryProviderPlatform, error)

+ type RegistryProviderReadOptions struct

+ Include []RegistryProviderIncludeOps

+ type RegistryProviderVersion struct

+ CreatedAt string

+ ID string

+ KeyID string

+ Links map[string]interface{}

+ Permissions RegistryProviderVersionPermissions

+ Protocols []string

+ RegistryProvider *RegistryProvider

+ RegistryProviderPlatforms []*RegistryProviderPlatform

+ ShasumsSigUploaded bool

+ ShasumsUploaded bool

+ UpdatedAt string

+ Version string

+ func (v *RegistryProviderVersion) ShasumsDownloadURL() (string, error)

+ func (v *RegistryProviderVersion) ShasumsSigDownloadURL() (string, error)

+ func (v *RegistryProviderVersion) ShasumsSigUploadURL() (string, error)

+ func (v *RegistryProviderVersion) ShasumsUploadURL() (string, error)

+ type RegistryProviderVersionCreateOptions struct

+ KeyID string

+ Protocols []string

+ Version string

+ type RegistryProviderVersionID struct

+ Version string

+ type RegistryProviderVersionList struct

+ Items []*RegistryProviderVersion

+ type RegistryProviderVersionListOptions struct

+ type RegistryProviderVersionPermissions struct

+ CanDelete bool

+ CanUploadAsset bool

+ type RegistryProviderVersions interface

+ Create func(ctx context.Context, providerID RegistryProviderID, ...) (*RegistryProviderVersion, error)

+ Delete func(ctx context.Context, versionID RegistryProviderVersionID) error

+ List func(ctx context.Context, providerID RegistryProviderID, ...) (*RegistryProviderVersionList, error)

+ Read func(ctx context.Context, versionID RegistryProviderVersionID) (*RegistryProviderVersion, error)

+ type RegistryProviders interface

+ Create func(ctx context.Context, organization string, ...) (*RegistryProvider, error)

+ Delete func(ctx context.Context, providerID RegistryProviderID) error

+ List func(ctx context.Context, organization string, options *RegistryProviderListOptions) (*RegistryProviderList, error)

+ Read func(ctx context.Context, providerID RegistryProviderID, ...) (*RegistryProvider, error)

+ type RemoteStateConsumersListOptions struct

+ type RetryLogHook func(attemptNum int, resp *http.Response)

type Run

+ AllowConfigGeneration *bool

+ AllowEmptyApply bool

+ AutoApply bool

+ Comments []*Comment

+ CostEstimate *CostEstimate

+ CreatedBy *User

+ PlanOnly bool

+ Refresh bool

+ RefreshOnly bool

+ ReplaceAddrs []string

+ SavePlan bool

+ TargetAddrs []string

+ TaskStages []*TaskStage

+ TerraformVersion string

+ Variables []*RunVariableAttr

type RunCreateOptions

+ AllowConfigGeneration *bool

+ AllowEmptyApply *bool

+ AutoApply *bool

+ PlanOnly *bool

+ Refresh *bool

+ RefreshOnly *bool

+ ReplaceAddrs []string

+ SavePlan *bool

+ TargetAddrs []string

+ TerraformVersion *string

+ Type string

+ Variables []*RunVariable

+ type RunEvent struct

+ Action string

+ Actor *User

+ Comment *Comment

+ CreatedAt time.Time

+ Description string

+ ID string

+ type RunEventIncludeOpt string

+ const RunEventActor

+ const RunEventComment

+ type RunEventList struct

+ Items []*RunEvent

+ type RunEventListOptions struct

+ Include []RunEventIncludeOpt

+ type RunEventReadOptions struct

+ Include []RunEventIncludeOpt

+ type RunEvents interface

+ List func(ctx context.Context, runID string, options *RunEventListOptions) (*RunEventList, error)

+ Read func(ctx context.Context, runEventID string) (*RunEvent, error)

+ ReadWithOptions func(ctx context.Context, runEventID string, options *RunEventReadOptions) (*RunEvent, error)

+ type RunIncludeOpt string

+ const RunApply

+ const RunConfigVer

+ const RunConfigVerIngress

+ const RunCostEstimate

+ const RunCreatedBy

+ const RunPlan

+ const RunTaskStages

+ const RunWorkspace

type RunListOptions

+ Commit string

+ Include []RunIncludeOpt

+ Operation string

+ Search string

+ Source string

+ Status string

+ User string

+ type RunOperation string

+ const RunOperationDestroy

+ const RunOperationEmptyApply

+ const RunOperationPlanApply

+ const RunOperationPlanOnly

+ const RunOperationRefreshOnly

+ const RunOperationSavePlan

+ type RunReadOptions struct

+ Include []RunIncludeOpt

type RunStatus

+ const RunApplyQueued

+ const RunCostEstimated

+ const RunCostEstimating

+ const RunFetching

+ const RunFetchingCompleted

+ const RunPlanQueued

+ const RunPlannedAndSaved

+ const RunPostPlanAwaitingDecision

+ const RunPostPlanCompleted

+ const RunPostPlanRunning

+ const RunPreApplyCompleted

+ const RunPreApplyRunning

+ const RunPrePlanCompleted

+ const RunPrePlanRunning

+ const RunQueuing

+ const RunQueuingApply

type RunStatusTimestamps

+ AppliedAt time.Time

+ ApplyQueuedAt time.Time

+ ApplyingAt time.Time

+ CanceledAt time.Time

+ ConfirmedAt time.Time

+ CostEstimatedAt time.Time

+ CostEstimatingAt time.Time

+ DiscardedAt time.Time

+ FetchedAt time.Time

+ FetchingAt time.Time

+ ForceCanceledAt time.Time

+ PlanQueueableAt time.Time

+ PlanQueuedAt time.Time

+ PlannedAndFinishedAt time.Time

+ PlannedAndSavedAt time.Time

+ PlannedAt time.Time

+ PlanningAt time.Time

+ PolicyCheckedAt time.Time

+ PolicySoftFailedAt time.Time

+ PostPlanCompletedAt time.Time

+ PostPlanRunningAt time.Time

+ PrePlanCompletedAt time.Time

+ PrePlanRunningAt time.Time

+ QueuingAt time.Time

+ type RunTask struct

+ Category string

+ Description string

+ Enabled bool

+ HMACKey *string

+ ID string

+ Name string

+ Organization *Organization

+ URL string

+ WorkspaceRunTasks []*WorkspaceRunTask

+ type RunTaskCreateOptions struct

+ Category string

+ Description *string

+ Enabled *bool

+ HMACKey *string

+ Name string

+ Type string

+ URL string

+ type RunTaskIncludeOpt string

+ const RunTaskWorkspace

+ const RunTaskWorkspaceTasks

+ type RunTaskList struct

+ Items []*RunTask

+ type RunTaskListOptions struct

+ Include []RunTaskIncludeOpt

+ type RunTaskReadOptions struct

+ Include []RunTaskIncludeOpt

+ type RunTaskUpdateOptions struct

+ Category *string

+ Description *string

+ Enabled *bool

+ HMACKey *string

+ Name *string

+ Type string

+ URL *string

+ type RunTasks interface

+ AttachToWorkspace func(ctx context.Context, workspaceID string, runTaskID string, ...) (*WorkspaceRunTask, error)

+ Create func(ctx context.Context, organization string, options RunTaskCreateOptions) (*RunTask, error)

+ Delete func(ctx context.Context, runTaskID string) error

+ List func(ctx context.Context, organization string, options *RunTaskListOptions) (*RunTaskList, error)

+ Read func(ctx context.Context, runTaskID string) (*RunTask, error)

+ ReadWithOptions func(ctx context.Context, runTaskID string, options *RunTaskReadOptions) (*RunTask, error)

+ Update func(ctx context.Context, runTaskID string, options RunTaskUpdateOptions) (*RunTask, error)

+ type RunTrigger struct

+ CreatedAt time.Time

+ ID string

+ Sourceable *Workspace

+ SourceableName string

+ Workspace *Workspace

+ WorkspaceName string

+ type RunTriggerCreateOptions struct

+ Sourceable *Workspace

+ Type string

+ type RunTriggerFilterOp string

+ const RunTriggerInbound

+ const RunTriggerOutbound

+ type RunTriggerIncludeOpt string

+ const RunTriggerSourceable

+ const RunTriggerWorkspace

+ type RunTriggerList struct

+ Items []*RunTrigger

+ type RunTriggerListOptions struct

+ Include []RunTriggerIncludeOpt

+ RunTriggerType RunTriggerFilterOp

+ type RunTriggers interface

+ Create func(ctx context.Context, workspaceID string, options RunTriggerCreateOptions) (*RunTrigger, error)

+ Delete func(ctx context.Context, RunTriggerID string) error

+ List func(ctx context.Context, workspaceID string, options *RunTriggerListOptions) (*RunTriggerList, error)

+ Read func(ctx context.Context, RunTriggerID string) (*RunTrigger, error)

+ type RunVariable struct

+ Key string

+ Value string

+ type RunVariableAttr struct

+ Key string

+ Value string

type Runs

+ ForceExecute func(ctx context.Context, runID string) error

+ ReadWithOptions func(ctx context.Context, runID string, options *RunReadOptions) (*Run, error)

+ type RunsPermissionType string

+ const RunsPermissionApply

+ const RunsPermissionPlan

+ const RunsPermissionRead

+ func RunsPermission(v RunsPermissionType) *RunsPermissionType

+ type SAMLSettings interface

+ Read func(ctx context.Context) (*AdminSAMLSetting, error)

+ RevokeIdpCert func(ctx context.Context) (*AdminSAMLSetting, error)

+ Update func(ctx context.Context, options AdminSAMLSettingsUpdateOptions) (*AdminSAMLSetting, error)

+ type SMTPAuthType string

+ const SMTPAuthLogin

+ const SMTPAuthNone

+ const SMTPAuthPlain

+ func SMTPAuthValue(v SMTPAuthType) *SMTPAuthType

+ type SMTPSettings interface

+ Read func(ctx context.Context) (*AdminSMTPSetting, error)

+ Update func(ctx context.Context, options AdminSMTPSettingsUpdateOptions) (*AdminSMTPSetting, error)

type SSHKeyCreateOptions

+ Type string

+ type SentinelMocksPermissionType string

+ const SentinelMocksPermissionNone

+ const SentinelMocksPermissionRead

+ func SentinelMocksPermission(v SentinelMocksPermissionType) *SentinelMocksPermissionType

type ServiceProviderType

+ const ServiceProviderAzureDevOpsServer

+ const ServiceProviderAzureDevOpsServices

+ const ServiceProviderBitbucketServerLegacy

+ type Stage string

+ const PostPlan

+ const PreApply

+ const PrePlan

type StateVersion

+ JSONDownloadURL string

+ JSONUploadURL string

+ Modules *StateVersionModules

+ Outputs []*StateVersionOutput

+ Providers *StateVersionProviders

+ Resources []*StateVersionResources

+ ResourcesProcessed bool

+ StateVersion int

+ Status StateVersionStatus

+ TerraformVersion string

+ UploadURL string

type StateVersionCreateOptions

+ Force *bool

+ JSONState *string

+ JSONStateOutputs *string

+ Type string

+ type StateVersionCurrentOptions struct

+ Include []StateVersionIncludeOpt

+ type StateVersionIncludeOpt string

+ const SVcreatedby

+ const SVoutputs

+ const SVrun

+ const SVrunConfigurationVersion

+ const SVrunCreatedBy

+ type StateVersionModuleRoot struct

+ NullResource int

+ TerraformRemoteState int

+ type StateVersionModules struct

+ Root StateVersionModuleRoot

+ type StateVersionOutput struct

+ DetailedType interface{}

+ ID string

+ Name string

+ Sensitive bool

+ Type string

+ Value interface{}

+ type StateVersionOutputs interface

+ Read func(ctx context.Context, outputID string) (*StateVersionOutput, error)

+ ReadCurrent func(ctx context.Context, workspaceID string) (*StateVersionOutputsList, error)

+ type StateVersionOutputsList struct

+ Items []*StateVersionOutput

+ type StateVersionOutputsListOptions struct

+ type StateVersionProviders struct

+ Data ProviderData

+ type StateVersionReadOptions struct

+ Include []StateVersionIncludeOpt

+ type StateVersionResources struct

+ Count string

+ Module string

+ Name string

+ Provider string

+ Type int

+ type StateVersionStatus string

+ const StateVersionDiscarded

+ const StateVersionFinalized

+ const StateVersionPending

+ type StateVersionUploadOptions struct

+ RawJSONState []byte

+ RawState []byte

type StateVersions

+ ListOutputs func(ctx context.Context, svID string, options *StateVersionOutputsListOptions) (*StateVersionOutputsList, error)

+ ReadCurrent func(ctx context.Context, workspaceID string) (*StateVersion, error)

+ ReadCurrentWithOptions func(ctx context.Context, workspaceID string, options *StateVersionCurrentOptions) (*StateVersion, error)

+ ReadWithOptions func(ctx context.Context, svID string, options *StateVersionReadOptions) (*StateVersion, error)

+ Upload func(ctx context.Context, workspaceID string, options StateVersionUploadOptions) (*StateVersion, error)

+ type StateVersionsPermissionType string

+ const StateVersionsPermissionNone

+ const StateVersionsPermissionRead

+ const StateVersionsPermissionReadOutputs

+ const StateVersionsPermissionWrite

+ func StateVersionsPermission(v StateVersionsPermissionType) *StateVersionsPermissionType

+ type Tag struct

+ ID string

+ Name string

+ type TagList struct

+ Items []*Tag

+ type TaskEnforcementLevel string

+ const Advisory

+ const Mandatory

+ type TaskResult struct

+ CreatedAt time.Time

+ ID string

+ Message string

+ Status TaskResultStatus

+ StatusTimestamps TaskResultStatusTimestamps

+ TaskID string

+ TaskName string

+ TaskStage *TaskStage

+ TaskURL string

+ URL string

+ UpdatedAt time.Time

+ WorkspaceTaskEnforcementLevel TaskEnforcementLevel

+ WorkspaceTaskID string

+ type TaskResultStatus string

+ const TaskErrored

+ const TaskFailed

+ const TaskPassed

+ const TaskPending

+ const TaskRunning

+ const TaskUnreachable

+ type TaskResultStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FailedAt time.Time

+ PassedAt time.Time

+ RunningAt time.Time

+ type TaskResults interface

+ Read func(ctx context.Context, taskResultID string) (*TaskResult, error)

+ type TaskStage struct

+ Actions *Actions

+ CreatedAt time.Time

+ ID string

+ Permissions *Permissions

+ PolicyEvaluations []*PolicyEvaluation

+ Run *Run

+ Stage Stage

+ Status TaskStageStatus

+ StatusTimestamps TaskStageStatusTimestamps

+ TaskResults []*TaskResult

+ UpdatedAt time.Time

+ type TaskStageIncludeOpt string

+ const PolicyEvaluationsTaskResults

+ const TaskStageTaskResults

+ type TaskStageList struct

+ Items []*TaskStage

+ type TaskStageListOptions struct

+ type TaskStageOverrideOptions struct

+ Comment *string

+ type TaskStageReadOptions struct

+ Include []TaskStageIncludeOpt

+ type TaskStageStatus string

+ const TaskStageAwaitingOverride

+ const TaskStageCanceled

+ const TaskStageErrored

+ const TaskStageFailed

+ const TaskStagePassed

+ const TaskStagePending

+ const TaskStageRunning

+ const TaskStageUnreachable

+ type TaskStageStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FailedAt time.Time

+ PassedAt time.Time

+ RunningAt time.Time

+ type TaskStages interface

+ List func(ctx context.Context, runID string, options *TaskStageListOptions) (*TaskStageList, error)

+ Override func(ctx context.Context, taskStageID string, options TaskStageOverrideOptions) (*TaskStage, error)

+ Read func(ctx context.Context, taskStageID string, options *TaskStageReadOptions) (*TaskStage, error)

type Team

+ OrganizationAccess *OrganizationAccess

+ OrganizationMemberships []*OrganizationMembership

+ SSOTeamID string

+ Visibility string

type TeamAccess

+ RunTasks bool

+ Runs RunsPermissionType

+ SentinelMocks SentinelMocksPermissionType

+ StateVersions StateVersionsPermissionType

+ Variables VariablesPermissionType

+ WorkspaceLocking bool

type TeamAccessAddOptions

+ RunTasks *bool

+ Runs *RunsPermissionType

+ SentinelMocks *SentinelMocksPermissionType

+ StateVersions *StateVersionsPermissionType

+ Type string

+ Variables *VariablesPermissionType

+ WorkspaceLocking *bool

+ type TeamAccessUpdateOptions struct

+ Access *AccessType

+ RunTasks *bool

+ Runs *RunsPermissionType

+ SentinelMocks *SentinelMocksPermissionType

+ StateVersions *StateVersionsPermissionType

+ Type string

+ Variables *VariablesPermissionType

+ WorkspaceLocking *bool

type TeamAccesses

+ Update func(ctx context.Context, teamAccessID string, options TeamAccessUpdateOptions) (*TeamAccess, error)

type TeamCreateOptions

+ OrganizationAccess *OrganizationAccessOptions

+ SSOTeamID *string

+ Type string

+ Visibility *string

+ type TeamIncludeOpt string

+ const TeamOrganizationMemberships

+ const TeamUsers

type TeamListOptions

+ Include []TeamIncludeOpt

+ Names []string

type TeamMemberAddOptions

+ OrganizationMembershipIDs []string

type TeamMemberRemoveOptions

+ OrganizationMembershipIDs []string

type TeamMembers

+ ListOrganizationMemberships func(ctx context.Context, teamID string) ([]*OrganizationMembership, error)

+ ListUsers func(ctx context.Context, teamID string) ([]*User, error)

+ type TeamProjectAccess struct

+ Access TeamProjectAccessType

+ ID string

+ Project *Project

+ Team *Team

+ type TeamProjectAccessAddOptions struct

+ Access TeamProjectAccessType

+ Project *Project

+ Team *Team

+ Type string

+ type TeamProjectAccessList struct

+ Items []*TeamProjectAccess

+ type TeamProjectAccessListOptions struct

+ ProjectID string

+ type TeamProjectAccessType string

+ const TeamProjectAccessAdmin

+ const TeamProjectAccessMaintain

+ const TeamProjectAccessRead

+ const TeamProjectAccessWrite

+ func ProjectAccess(v TeamProjectAccessType) *TeamProjectAccessType

+ type TeamProjectAccessUpdateOptions struct

+ Access *TeamProjectAccessType

+ Type string

+ type TeamProjectAccesses interface

+ Add func(ctx context.Context, options TeamProjectAccessAddOptions) (*TeamProjectAccess, error)

+ List func(ctx context.Context, options TeamProjectAccessListOptions) (*TeamProjectAccessList, error)

+ Read func(ctx context.Context, teamProjectAccessID string) (*TeamProjectAccess, error)

+ Remove func(ctx context.Context, teamProjectAccessID string) error

+ Update func(ctx context.Context, teamProjectAccessID string, ...) (*TeamProjectAccess, error)

type TeamToken

+ ExpiredAt time.Time

+ type TeamTokenCreateOptions struct

+ ExpiredAt *time.Time

type TeamTokens

+ Create func(ctx context.Context, teamID string) (*TeamToken, error)

+ CreateWithOptions func(ctx context.Context, teamID string, options TeamTokenCreateOptions) (*TeamToken, error)

+ type TeamUpdateOptions struct

+ Name *string

+ OrganizationAccess *OrganizationAccessOptions

+ SSOTeamID *string

+ Type string

+ Visibility *string

type Teams

+ Update func(ctx context.Context, teamID string, options TeamUpdateOptions) (*Team, error)

+ type TwilioSettings interface

+ Read func(ctx context.Context) (*AdminTwilioSetting, error)

+ Update func(ctx context.Context, options AdminTwilioSettingsUpdateOptions) (*AdminTwilioSetting, error)

+ Verify func(ctx context.Context, options AdminTwilioSettingsVerifyOptions) error

type User

+ IsSiteAdmin *bool

+ IsSsoLogin *bool

+ Permissions *UserPermissions

+ type UserPermissions struct

+ CanChangeEmail bool

+ CanChangeUsername bool

+ CanCreateOrganizations bool

+ CanManageHcpAccount bool

+ CanManageUserTokens bool

+ CanView2FaSettings bool

+ type UserToken struct

+ CreatedAt time.Time

+ Description string

+ ExpiredAt time.Time

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type UserTokenCreateOptions struct

+ Description string

+ ExpiredAt *time.Time

+ type UserTokenList struct

+ Items []*UserToken

+ type UserTokens interface

+ Create func(ctx context.Context, userID string, options UserTokenCreateOptions) (*UserToken, error)

+ Delete func(ctx context.Context, tokenID string) error

+ List func(ctx context.Context, userID string) (*UserTokenList, error)

+ Read func(ctx context.Context, tokenID string) (*UserToken, error)

type UserUpdateOptions

+ Type string

type Users

+ UpdateCurrent func(ctx context.Context, options UserUpdateOptions) (*User, error)

type VCSRepo

+ DisplayIdentifier string

+ GHAInstallationID string

+ RepositoryHTTPURL string

+ ServiceProvider string

+ TagsRegex string

+ WebhookURL string

type VCSRepoOptions

+ GHAInstallationID *string

+ TagsRegex *string

type Variable

+ Description string

+ VersionID string

type VariableCreateOptions

+ Description *string

+ Type string

+ type VariableSet struct

+ Description string

+ Global bool

+ ID string

+ Name string

+ Organization *Organization

+ Projects []*Project

+ Variables []*VariableSetVariable

+ Workspaces []*Workspace

+ type VariableSetApplyToProjectsOptions struct

+ Projects []*Project

+ type VariableSetApplyToWorkspacesOptions struct

+ Workspaces []*Workspace

+ type VariableSetCreateOptions struct

+ Description *string

+ Global *bool

+ Name *string

+ Type string

+ type VariableSetIncludeOpt string

+ const VariableSetProjects

+ const VariableSetVars

+ const VariableSetWorkspaces

+ type VariableSetList struct

+ Items []*VariableSet

+ type VariableSetListOptions struct

+ Include string

+ type VariableSetReadOptions struct

+ Include *[]VariableSetIncludeOpt

+ type VariableSetRemoveFromProjectsOptions struct

+ Projects []*Project

+ type VariableSetRemoveFromWorkspacesOptions struct

+ Workspaces []*Workspace

+ type VariableSetUpdateOptions struct

+ Description *string

+ Global *bool

+ Name *string

+ Type string

+ type VariableSetUpdateWorkspacesOptions struct

+ Type string

+ Workspaces []*Workspace

+ type VariableSetVariable struct

+ Category CategoryType

+ Description string

+ HCL bool

+ ID string

+ Key string

+ Sensitive bool

+ Value string

+ VariableSet *VariableSet

+ VersionID string

+ type VariableSetVariableCreateOptions struct

+ Category *CategoryType

+ Description *string

+ HCL *bool

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type VariableSetVariableList struct

+ Items []*VariableSetVariable

+ type VariableSetVariableListOptions struct

+ type VariableSetVariableUpdateOptions struct

+ Description *string

+ HCL *bool

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type VariableSetVariables interface

+ Create func(ctx context.Context, variableSetID string, ...) (*VariableSetVariable, error)

+ Delete func(ctx context.Context, variableSetID string, variableID string) error

+ List func(ctx context.Context, variableSetID string, ...) (*VariableSetVariableList, error)

+ Read func(ctx context.Context, variableSetID string, variableID string) (*VariableSetVariable, error)

+ Update func(ctx context.Context, variableSetID string, variableID string, ...) (*VariableSetVariable, error)

+ type VariableSets interface

+ ApplyToProjects func(ctx context.Context, variableSetID string, ...) error

+ ApplyToWorkspaces func(ctx context.Context, variableSetID string, ...) error

+ Create func(ctx context.Context, organization string, options *VariableSetCreateOptions) (*VariableSet, error)

+ Delete func(ctx context.Context, variableSetID string) error

+ List func(ctx context.Context, organization string, options *VariableSetListOptions) (*VariableSetList, error)

+ ListForProject func(ctx context.Context, projectID string, options *VariableSetListOptions) (*VariableSetList, error)

+ ListForWorkspace func(ctx context.Context, workspaceID string, options *VariableSetListOptions) (*VariableSetList, error)

+ Read func(ctx context.Context, variableSetID string, options *VariableSetReadOptions) (*VariableSet, error)

+ RemoveFromProjects func(ctx context.Context, variableSetID string, ...) error

+ RemoveFromWorkspaces func(ctx context.Context, variableSetID string, ...) error

+ Update func(ctx context.Context, variableSetID string, options *VariableSetUpdateOptions) (*VariableSet, error)

+ UpdateWorkspaces func(ctx context.Context, variableSetID string, ...) (*VariableSet, error)

type VariableUpdateOptions

+ Description *string

+ Type string

+ type VariablesPermissionType string

+ const VariablesPermissionNone

+ const VariablesPermissionRead

+ const VariablesPermissionWrite

+ func VariablesPermission(v VariablesPermissionType) *VariablesPermissionType

+ type WSIncludeOpt string

+ const WSCurrentConfigVer

+ const WSCurrentConfigVerIngress

+ const WSCurrentRun

+ const WSCurrentRunConfigVer

+ const WSCurrentRunPlan

+ const WSCurrentStateVer

+ const WSCurrentrunConfigVerIngress

+ const WSLockedBy

+ const WSOrganization

+ const WSOutputs

+ const WSProject

+ const WSReadme

type Workspace

+ AgentPool *AgentPool

+ AgentPoolID string

+ AllowDestroyPlan bool

+ ApplyDurationAverage time.Duration

+ AssessmentsEnabled bool

+ CurrentStateVersion *StateVersion

+ Description string

+ ExecutionMode string

+ FileTriggersEnabled bool

+ GlobalRemoteState bool

+ Links map[string]interface{}

+ Operations bool

+ Outputs []*WorkspaceOutputs

+ PlanDurationAverage time.Duration

+ PolicyCheckFailures int

+ Project *Project

+ QueueAllRuns bool

+ ResourceCount int

+ RunFailures int

+ RunsCount int

+ SourceModuleID string

+ SourceName string

+ SourceURL string

+ SpeculativeEnabled bool

+ StructuredRunOutputEnabled bool

+ TagNames []string

+ Tags []*Tag

+ TriggerPatterns []string

+ TriggerPrefixes []string

+ UpdatedAt time.Time

+ type WorkspaceAddRemoteStateConsumersOptions struct

+ Workspaces []*Workspace

+ type WorkspaceAddTagsOptions struct

+ Tags []*Tag

type WorkspaceAssignSSHKeyOptions

+ Type string

type WorkspaceCreateOptions

+ AgentPoolID *string

+ AllowDestroyPlan *bool

+ AssessmentsEnabled *bool

+ Description *string

+ ExecutionMode *string

+ FileTriggersEnabled *bool

+ GlobalRemoteState *bool

+ Operations *bool

+ Project *Project

+ QueueAllRuns *bool

+ SourceModuleID *string

+ SourceName *string

+ SourceURL *string

+ SpeculativeEnabled *bool

+ StructuredRunOutputEnabled *bool

+ Tags []*Tag

+ TriggerPatterns []string

+ TriggerPrefixes []string

+ Type string

type WorkspaceListOptions

+ ExcludeTags string

+ Include []WSIncludeOpt

+ ProjectID string

+ Tags string

+ WildcardName string

+ type WorkspaceOutputs struct

+ ID string

+ Name string

+ Sensitive bool

+ Type string

+ Value interface{}

type WorkspacePermissions

+ CanForceDelete *bool

+ CanForceUnlock bool

+ CanManageRunTasks bool

+ CanQueueApply bool

+ CanUnlock bool

+ type WorkspaceReadOptions struct

+ Include []WSIncludeOpt

+ type WorkspaceRemoveRemoteStateConsumersOptions struct

+ Workspaces []*Workspace

+ type WorkspaceRemoveTagsOptions struct

+ Tags []*Tag

+ type WorkspaceRunTask struct

+ EnforcementLevel TaskEnforcementLevel

+ ID string

+ RunTask *RunTask

+ Stage Stage

+ Workspace *Workspace

+ type WorkspaceRunTaskCreateOptions struct

+ EnforcementLevel TaskEnforcementLevel

+ RunTask *RunTask

+ Stage *Stage

+ Type string

+ type WorkspaceRunTaskList struct

+ Items []*WorkspaceRunTask

+ type WorkspaceRunTaskListOptions struct

+ type WorkspaceRunTaskUpdateOptions struct

+ EnforcementLevel TaskEnforcementLevel

+ Stage *Stage

+ Type string

+ type WorkspaceRunTasks interface

+ Create func(ctx context.Context, workspaceID string, options WorkspaceRunTaskCreateOptions) (*WorkspaceRunTask, error)

+ Delete func(ctx context.Context, workspaceID string, workspaceTaskID string) error

+ List func(ctx context.Context, workspaceID string, options *WorkspaceRunTaskListOptions) (*WorkspaceRunTaskList, error)

+ Read func(ctx context.Context, workspaceID string, workspaceTaskID string) (*WorkspaceRunTask, error)

+ Update func(ctx context.Context, workspaceID string, workspaceTaskID string, ...) (*WorkspaceRunTask, error)

+ type WorkspaceTagListOptions struct

+ Query *string

type WorkspaceUpdateOptions

+ AgentPoolID *string

+ AllowDestroyPlan *bool

+ AssessmentsEnabled *bool

+ Description *string

+ ExecutionMode *string

+ FileTriggersEnabled *bool

+ GlobalRemoteState *bool

+ Operations *bool

+ Project *Project

+ QueueAllRuns *bool

+ SpeculativeEnabled *bool

+ StructuredRunOutputEnabled *bool

+ TriggerPatterns []string

+ TriggerPrefixes []string

+ Type string

+ type WorkspaceUpdateRemoteStateConsumersOptions struct

+ Workspaces []*Workspace

type Workspaces

+ AddRemoteStateConsumers func(ctx context.Context, workspaceID string, ...) error

+ AddTags func(ctx context.Context, workspaceID string, options WorkspaceAddTagsOptions) error

+ DeleteByID func(ctx context.Context, workspaceID string) error

+ ForceUnlock func(ctx context.Context, workspaceID string) (*Workspace, error)

+ ListRemoteStateConsumers func(ctx context.Context, workspaceID string, ...) (*WorkspaceList, error)

+ ListTags func(ctx context.Context, workspaceID string, options *WorkspaceTagListOptions) (*TagList, error)

+ ReadByID func(ctx context.Context, workspaceID string) (*Workspace, error)

+ ReadByIDWithOptions func(ctx context.Context, workspaceID string, options *WorkspaceReadOptions) (*Workspace, error)

+ ReadWithOptions func(ctx context.Context, organization string, workspace string, ...) (*Workspace, error)

+ Readme func(ctx context.Context, workspaceID string) (io.Reader, error)

+ RemoveRemoteStateConsumers func(ctx context.Context, workspaceID string, ...) error

+ RemoveTags func(ctx context.Context, workspaceID string, options WorkspaceRemoveTagsOptions) error

+ RemoveVCSConnection func(ctx context.Context, organization, workspace string) (*Workspace, error)

+ RemoveVCSConnectionByID func(ctx context.Context, workspaceID string) (*Workspace, error)

+ SafeDelete func(ctx context.Context, organization string, workspace string) error

+ SafeDeleteByID func(ctx context.Context, workspaceID string) error

+ UpdateByID func(ctx context.Context, workspaceID string, options WorkspaceUpdateOptions) (*Workspace, error)

+ UpdateRemoteStateConsumers func(ctx context.Context, workspaceID string, ...) error

v0

v0.2.6

Oct 23, 2018

Changes in this version

type ApplyStatus

+ const ApplyUnreachable

type PlanStatus

+ const PlanUnreachable

type PolicyStatus

+ const PolicyUnreachable

type RunStatus

+ const RunPlannedAndFinished

+ const RunPolicySoftFailed

v0.2.5

Oct 15, 2018

Changes in this version

type Config

+ Headers http.Header

v0.2.4

Oct 11, 2018

Changes in this version

+ type Capacity struct

+ Organization string

+ Pending int

+ Running int

type Organizations

+ Capacity func(ctx context.Context, organization string) (*Capacity, error)

+ RunQueue func(ctx context.Context, organization string, options RunQueueOptions) (*RunQueue, error)

type Run

+ ForceCancelAvailableAt time.Time

+ PositionInQueue int

type RunActions

+ IsForceCancelable bool

+ type RunForceCancelOptions struct

+ Comment *string

type RunPermissions

+ CanForceCancel bool

+ type RunQueue struct

+ Items []*Run

+ type RunQueueOptions struct

type Runs

+ ForceCancel func(ctx context.Context, runID string, options RunForceCancelOptions) error

type Workspace

+ CurrentRun *Run

v0.2.3

Sep 20, 2018

Changes in this version

+ type Applies interface

+ Logs func(ctx context.Context, applyID string) (io.Reader, error)

+ Read func(ctx context.Context, applyID string) (*Apply, error)

+ type Apply struct

+ ID string

+ LogReadURL string

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

+ Status ApplyStatus

+ StatusTimestamps *ApplyStatusTimestamps

+ type ApplyStatus string

+ const ApplyCanceled

+ const ApplyCreated

+ const ApplyErrored

+ const ApplyFinished

+ const ApplyMFAWaiting

+ const ApplyPending

+ const ApplyQueued

+ const ApplyRunning

+ type ApplyStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ ForceCanceledAt time.Time

+ QueuedAt time.Time

+ StartedAt time.Time

type Client

+ Applies Applies

type Plan

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

type PlanStatusTimestamps

+ ForceCanceledAt time.Time

+ StartedAt time.Time

type PolicyChecks

+ Logs func(ctx context.Context, policyCheckID string) (io.Reader, error)

+ Read func(ctx context.Context, policyCheckID string) (*PolicyCheck, error)

type Run

+ Apply *Apply

+ PolicyChecks []*PolicyCheck

type RunActions

+ IsConfirmable bool

v0.2.2

Sep 14, 2018

Changes in this version

type OAuthClient

+ OAuthTokens []*OAuthToken

type OAuthClientCreateOptions

+ OAuthToken *string

+ type OAuthClientList struct

+ Items []*OAuthClient

+ type OAuthClientListOptions struct

type OAuthClients

+ Delete func(ctx context.Context, oAuthClientID string) error

+ List func(ctx context.Context, organization string, options OAuthClientListOptions) (*OAuthClientList, error)

+ Read func(ctx context.Context, oAuthClientID string) (*OAuthClient, error)

+ type OAuthTokenUpdateOptions struct

+ ID string

+ PrivateSSHKey *string

type OAuthTokens

+ Delete func(ctx context.Context, oAuthTokenID string) error

+ Read func(ctx context.Context, oAuthTokenID string) (*OAuthToken, error)

+ Update func(ctx context.Context, oAuthTokenID string, options OAuthTokenUpdateOptions) (*OAuthToken, error)

type Variables

+ Read func(ctx context.Context, variableID string) (*Variable, error)

v0.2.1

Sep 8, 2018

Changes in this version

type WorkspaceListOptions

+ Search *string

v0.2.0

Sep 7, 2018

Changes in this version

+ type ConfigurationVersionList struct

+ Items []*ConfigurationVersion

+ type OAuthTokenList struct

+ Items []*OAuthToken

+ type OAuthTokenListOptions struct

+ type OrganizationList struct

+ Items []*Organization

+ type Pagination struct

+ CurrentPage int

+ NextPage int

+ PreviousPage int

+ TotalCount int

+ TotalPages int

+ type PolicyCheckList struct

+ Items []*PolicyCheck

+ type PolicyList struct

+ Items []*Policy

+ type RunList struct

+ Items []*Run

+ type SSHKeyList struct

+ Items []*SSHKey

type StateVersionCreateOptions

+ Run *Run

+ type StateVersionList struct

+ Items []*StateVersion

+ type TeamAccessList struct

+ Items []*TeamAccess

+ type TeamList struct

+ Items []*Team

+ type VariableList struct

+ Items []*Variable

+ type WorkspaceList struct

+ Items []*Workspace

v0.1.2

Aug 9, 2018

Changes in this version

+ func Int(v int) *int

+ type AccessType string

+ const AccessAdmin

+ const AccessRead

+ const AccessWrite

type OrganizationTokens

+ Read func(ctx context.Context, organization string) (*OrganizationToken, error)

type Policies

+ Download func(ctx context.Context, policyID string) ([]byte, error)

type Team

+ Users []*User

type TeamMembers

+ List func(ctx context.Context, teamID string) ([]*User, error)

type TeamTokens

+ Read func(ctx context.Context, teamID string) (*TeamToken, error)

type VCSRepo

+ IngressSubmodules bool

type VCSRepoOptions

+ IngressSubmodules *bool

v0.1.1

Aug 1, 2018

Changes in this version

type Client

+ Plans Plans

type ConfigurationVersion

+ Speculative bool

type ConfigurationVersionCreateOptions

+ Speculative *bool

+ type LogReader struct

+ func (r *LogReader) Read(l []byte) (int, error)

+ type Plan struct

+ HasChanges bool

+ ID string

+ LogReadURL string

+ Status PlanStatus

+ StatusTimestamps *PlanStatusTimestamps

+ type PlanStatus string

+ const PlanCanceled

+ const PlanCreated

+ const PlanErrored

+ const PlanFinished

+ const PlanMFAWaiting

+ const PlanPending

+ const PlanQueued

+ const PlanRunning

+ type PlanStatusTimestamps struct

+ CanceledAt time.Time

+ CreatedAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ MFAWaitingAt time.Time

+ PendingAt time.Time

+ QueuedAt time.Time

+ RunningAt time.Time

+ type Plans interface

+ Logs func(ctx context.Context, planID string) (io.Reader, error)

+ Read func(ctx context.Context, planID string) (*Plan, error)

type Run

+ Plan *Plan

type StateVersions

+ Current func(ctx context.Context, workspaceID string) (*StateVersion, error)

v0.1.0

Jul 13, 2018

Changes in this version

+ const DefaultAddress

+ const DefaultBasePath

+ var ErrResourceNotFound = errors.New("resource not found")

+ var ErrUnauthorized = errors.New("unauthorized")

+ func Bool(v bool) *bool

+ func Int64(v int64) *int64

+ func String(v string) *string

+ type AuthPolicyType string

+ const AuthPolicyPassword

+ const AuthPolicyTwoFactor

+ func AuthPolicy(v AuthPolicyType) *AuthPolicyType

+ type CVStatusTimestamps struct

+ FinishedAt time.Time

+ QueuedAt time.Time

+ StartedAt time.Time

+ type CategoryType string

+ const CategoryEnv

+ const CategoryTerraform

+ func Category(v CategoryType) *CategoryType

+ type Client struct

+ ConfigurationVersions *ConfigurationVersions

+ OAuthClients *OAuthClients

+ OAuthTokens *OAuthTokens

+ OrganizationTokens *OrganizationTokens

+ Organizations *Organizations

+ Policies *Policies

+ PolicyChecks *PolicyChecks

+ Runs *Runs

+ SSHKeys *SSHKeys

+ StateVersions *StateVersions

+ TeamAccess *TeamAccesses

+ TeamMembers *TeamMembers

+ TeamTokens *TeamTokens

+ Teams *Teams

+ Users *Users

+ Variables *Variables

+ Workspaces *Workspaces

+ func NewClient(cfg *Config) (*Client, error)

+ type Config struct

+ Address string

+ BasePath string

+ HTTPClient *http.Client

+ Token string

+ func DefaultConfig() *Config

+ type ConfigurationSource string

+ const ConfigurationSourceAPI

+ const ConfigurationSourceBitbucket

+ const ConfigurationSourceGithub

+ const ConfigurationSourceGitlab

+ const ConfigurationSourceTerraform

+ type ConfigurationStatus string

+ const ConfigurationErrored

+ const ConfigurationPending

+ const ConfigurationUploaded

+ type ConfigurationVersion struct

+ AutoQueueRuns bool

+ Error string

+ ErrorMessage string

+ ID string

+ Source ConfigurationSource

+ Status ConfigurationStatus

+ StatusTimestamps *CVStatusTimestamps

+ UploadURL string

+ type ConfigurationVersionCreateOptions struct

+ AutoQueueRuns *bool

+ ID string

+ type ConfigurationVersionListOptions struct

+ type ConfigurationVersions struct

+ func (s *ConfigurationVersions) Create(ctx context.Context, workspaceID string, ...) (*ConfigurationVersion, error)

+ func (s *ConfigurationVersions) List(ctx context.Context, workspaceID string, ...) ([]*ConfigurationVersion, error)

+ func (s *ConfigurationVersions) Read(ctx context.Context, cvID string) (*ConfigurationVersion, error)

+ func (s *ConfigurationVersions) Upload(ctx context.Context, url, path string) error

+ type Enforcement struct

+ Mode EnforcementLevel

+ Path string

+ type EnforcementLevel string

+ const EnforcementAdvisory

+ const EnforcementHard

+ const EnforcementSoft

+ func EnforcementMode(v EnforcementLevel) *EnforcementLevel

+ type EnforcementOptions struct

+ Mode *EnforcementLevel

+ Path *string

+ type EnterprisePlanType string

+ const EnterprisePlanDisabled

+ const EnterprisePlanPremium

+ const EnterprisePlanPro

+ const EnterprisePlanTrial

+ type ListOptions struct

+ PageNumber int

+ PageSize int

+ type OAuthClient struct

+ APIURL string

+ CallbackURL string

+ ConnectPath string

+ CreatedAt time.Time

+ HTTPURL string

+ ID string

+ Key string

+ OAuthToken []*OAuthToken

+ Organization *Organization

+ RSAPublicKey string

+ ServiceProvider ServiceProviderType

+ ServiceProviderName string

+ type OAuthClientCreateOptions struct

+ APIURL *string

+ HTTPURL *string

+ ID string

+ Key *string

+ Secret *string

+ ServiceProvider *ServiceProviderType

+ type OAuthClients struct

+ func (s *OAuthClients) Create(ctx context.Context, organization string, options OAuthClientCreateOptions) (*OAuthClient, error)

+ type OAuthToken struct

+ CreatedAt time.Time

+ HasSSHKey bool

+ ID string

+ OAuthClient *OAuthClient

+ ServiceProviderUser string

+ UID string

+ type OAuthTokens struct

+ func (s *OAuthTokens) List(ctx context.Context, organization string) ([]*OAuthToken, error)

+ type Organization struct

+ CollaboratorAuthPolicy AuthPolicyType

+ CreatedAt time.Time

+ Email string

+ EnterprisePlan EnterprisePlanType

+ Name string

+ OwnersTeamSamlRoleID string

+ Permissions *OrganizationPermissions

+ SAMLEnabled bool

+ SessionRemember int

+ SessionTimeout int

+ TrialExpiresAt time.Time

+ TwoFactorConformant bool

+ type OrganizationCreateOptions struct

+ Email *string

+ ID string

+ Name *string

+ type OrganizationListOptions struct

+ type OrganizationPermissions struct

+ CanCreateTeam bool

+ CanCreateWorkspace bool

+ CanCreateWorkspaceMigration bool

+ CanDestroy bool

+ CanTraverse bool

+ CanUpdate bool

+ CanUpdateAPIToken bool

+ CanUpdateOAuth bool

+ CanUpdateSentinel bool

+ type OrganizationToken struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type OrganizationTokens struct

+ func (s *OrganizationTokens) Delete(ctx context.Context, organization string) error

+ func (s *OrganizationTokens) Generate(ctx context.Context, organization string) (*OrganizationToken, error)

+ type OrganizationUpdateOptions struct

+ CollaboratorAuthPolicy *AuthPolicyType

+ Email *string

+ ID string

+ Name *string

+ SessionRemember *int

+ SessionTimeout *int

+ type Organizations struct

+ func (s *Organizations) Create(ctx context.Context, options OrganizationCreateOptions) (*Organization, error)

+ func (s *Organizations) Delete(ctx context.Context, name string) error

+ func (s *Organizations) List(ctx context.Context, options OrganizationListOptions) ([]*Organization, error)

+ func (s *Organizations) Read(ctx context.Context, name string) (*Organization, error)

+ func (s *Organizations) Update(ctx context.Context, name string, options OrganizationUpdateOptions) (*Organization, error)

+ type Policies struct

+ func (s *Policies) Create(ctx context.Context, organization string, options PolicyCreateOptions) (*Policy, error)

+ func (s *Policies) Delete(ctx context.Context, policyID string) error

+ func (s *Policies) List(ctx context.Context, organization string, options PolicyListOptions) ([]*Policy, error)

+ func (s *Policies) Read(ctx context.Context, policyID string) (*Policy, error)

+ func (s *Policies) Update(ctx context.Context, policyID string, options PolicyUpdateOptions) (*Policy, error)

+ func (s *Policies) Upload(ctx context.Context, policyID string, content []byte) error

+ type Policy struct

+ Enforce []*Enforcement

+ ID string

+ Name string

+ UpdatedAt time.Time

+ type PolicyActions struct

+ IsOverridable bool

+ type PolicyCheck struct

+ Actions *PolicyActions

+ ID string

+ Permissions *PolicyPermissions

+ Result *PolicyResult

+ Scope PolicyScope

+ Status PolicyStatus

+ StatusTimestamps *PolicyStatusTimestamps

+ type PolicyCheckListOptions struct

+ type PolicyChecks struct

+ func (s *PolicyChecks) List(ctx context.Context, runID string, options PolicyCheckListOptions) ([]*PolicyCheck, error)

+ func (s *PolicyChecks) Override(ctx context.Context, policyCheckID string) (*PolicyCheck, error)

+ type PolicyCreateOptions struct

+ Enforce []*EnforcementOptions

+ ID string

+ Name *string

+ type PolicyListOptions struct

+ type PolicyPermissions struct

+ CanOverride bool

+ type PolicyResult struct

+ AdvisoryFailed int

+ Duration int

+ HardFailed int

+ Passed int

+ Result bool

+ SoftFailed int

+ TotalFailed int

+ type PolicyScope string

+ const PolicyScopeOrganization

+ const PolicyScopeWorkspace

+ type PolicyStatus string

+ const PolicyErrored

+ const PolicyHardFailed

+ const PolicyOverridden

+ const PolicyPasses

+ const PolicyPending

+ const PolicyQueued

+ const PolicySoftFailed

+ type PolicyStatusTimestamps struct

+ ErroredAt time.Time

+ HardFailedAt time.Time

+ PassedAt time.Time

+ QueuedAt time.Time

+ SoftFailedAt time.Time

+ type PolicyUpdateOptions struct

+ Enforce []*EnforcementOptions

+ ID string

+ type Run struct

+ Actions *RunActions

+ ConfigurationVersion *ConfigurationVersion

+ CreatedAt time.Time

+ HasChanges bool

+ ID string

+ IsDestroy bool

+ Message string

+ Permissions *RunPermissions

+ Source RunSource

+ Status RunStatus

+ StatusTimestamps *RunStatusTimestamps

+ Workspace *Workspace

+ type RunActions struct

+ IsCancelable bool

+ IsComfirmable bool

+ IsDiscardable bool

+ type RunApplyOptions struct

+ Comment *string

+ type RunCancelOptions struct

+ Comment *string

+ type RunCreateOptions struct

+ ConfigurationVersion *ConfigurationVersion

+ ID string

+ IsDestroy *bool

+ Message *string

+ Workspace *Workspace

+ type RunDiscardOptions struct

+ Comment *string

+ type RunListOptions struct

+ type RunPermissions struct

+ CanApply bool

+ CanCancel bool

+ CanDiscard bool

+ CanForceExecute bool

+ type RunSource string

+ const RunSourceAPI

+ const RunSourceConfigurationVersion

+ const RunSourceUI

+ type RunStatus string

+ const RunApplied

+ const RunApplying

+ const RunCanceled

+ const RunConfirmed

+ const RunDiscarded

+ const RunErrored

+ const RunPending

+ const RunPlanned

+ const RunPlanning

+ const RunPolicyChecked

+ const RunPolicyChecking

+ const RunPolicyOverride

+ type RunStatusTimestamps struct

+ ErroredAt time.Time

+ FinishedAt time.Time

+ QueuedAt time.Time

+ StartedAt time.Time

+ type Runs struct

+ func (s *Runs) Apply(ctx context.Context, runID string, options RunApplyOptions) error

+ func (s *Runs) Cancel(ctx context.Context, runID string, options RunCancelOptions) error

+ func (s *Runs) Create(ctx context.Context, options RunCreateOptions) (*Run, error)

+ func (s *Runs) Discard(ctx context.Context, runID string, options RunDiscardOptions) error

+ func (s *Runs) List(ctx context.Context, workspaceID string, options RunListOptions) ([]*Run, error)

+ func (s *Runs) Read(ctx context.Context, runID string) (*Run, error)

+ type SSHKey struct

+ ID string

+ Name string

+ type SSHKeyCreateOptions struct

+ ID string

+ Name *string

+ Value *string

+ type SSHKeyListOptions struct

+ type SSHKeyUpdateOptions struct

+ ID string

+ Name *string

+ Value *string

+ type SSHKeys struct

+ func (s *SSHKeys) Create(ctx context.Context, organization string, options SSHKeyCreateOptions) (*SSHKey, error)

+ func (s *SSHKeys) Delete(ctx context.Context, sshKeyID string) error

+ func (s *SSHKeys) List(ctx context.Context, organization string, options SSHKeyListOptions) ([]*SSHKey, error)

+ func (s *SSHKeys) Read(ctx context.Context, sshKeyID string) (*SSHKey, error)

+ func (s *SSHKeys) Update(ctx context.Context, sshKeyID string, options SSHKeyUpdateOptions) (*SSHKey, error)

+ type ServiceProviderType string

+ const ServiceProviderBitbucket

+ const ServiceProviderBitbucketServer

+ const ServiceProviderGithub

+ const ServiceProviderGithubEE

+ const ServiceProviderGitlab

+ const ServiceProviderGitlabCE

+ const ServiceProviderGitlabEE

+ func ServiceProvider(v ServiceProviderType) *ServiceProviderType

+ type StateVersion struct

+ CreatedAt time.Time

+ DownloadURL string

+ ID string

+ Run *Run

+ Serial int

+ VCSCommitSHA string

+ VCSCommitURL string

+ type StateVersionCreateOptions struct

+ ID string

+ Lineage *string

+ MD5 *string

+ Serial *int64

+ State *string

+ type StateVersionListOptions struct

+ Organization *string

+ Workspace *string

+ type StateVersions struct

+ func (s *StateVersions) Create(ctx context.Context, workspaceID string, options StateVersionCreateOptions) (*StateVersion, error)

+ func (s *StateVersions) Download(ctx context.Context, url string) ([]byte, error)

+ func (s *StateVersions) List(ctx context.Context, options StateVersionListOptions) ([]*StateVersion, error)

+ func (s *StateVersions) Read(ctx context.Context, svID string) (*StateVersion, error)

+ type Team struct

+ ID string

+ Name string

+ Permissions *TeamPermissions

+ UserCount int

+ type TeamAccess struct

+ Access TeamAccessType

+ ID string

+ Team *Team

+ Workspace *Workspace

+ type TeamAccessAddOptions struct

+ Access *TeamAccessType

+ ID string

+ Team *Team

+ Workspace *Workspace

+ type TeamAccessListOptions struct

+ WorkspaceID *string

+ type TeamAccessType string

+ const TeamAccessAdmin

+ const TeamAccessRead

+ const TeamAccessWrite

+ func Access(v TeamAccessType) *TeamAccessType

+ type TeamAccesses struct

+ func (s *TeamAccesses) Add(ctx context.Context, options TeamAccessAddOptions) (*TeamAccess, error)

+ func (s *TeamAccesses) List(ctx context.Context, options TeamAccessListOptions) ([]*TeamAccess, error)

+ func (s *TeamAccesses) Read(ctx context.Context, teamAccessID string) (*TeamAccess, error)

+ func (s *TeamAccesses) Remove(ctx context.Context, teamAccessID string) error

+ type TeamCreateOptions struct

+ ID string

+ Name *string

+ type TeamListOptions struct

+ type TeamMemberAddOptions struct

+ Usernames []string

+ type TeamMemberRemoveOptions struct

+ Usernames []string

+ type TeamMembers struct

+ func (s *TeamMembers) Add(ctx context.Context, teamID string, options TeamMemberAddOptions) error

+ func (s *TeamMembers) Remove(ctx context.Context, teamID string, options TeamMemberRemoveOptions) error

+ type TeamPermissions struct

+ CanDestroy bool

+ CanUpdateMembership bool

+ type TeamToken struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type TeamTokens struct

+ func (s *TeamTokens) Delete(ctx context.Context, teamID string) error

+ func (s *TeamTokens) Generate(ctx context.Context, teamID string) (*TeamToken, error)

+ type Teams struct

+ func (s *Teams) Create(ctx context.Context, organization string, options TeamCreateOptions) (*Team, error)

+ func (s *Teams) Delete(ctx context.Context, teamID string) error

+ func (s *Teams) List(ctx context.Context, organization string, options TeamListOptions) ([]*Team, error)

+ func (s *Teams) Read(ctx context.Context, teamID string) (*Team, error)

+ type TwoFactor struct

+ Enabled bool

+ Verified bool

+ type User struct

+ AvatarURL string

+ Email string

+ ID string

+ IsServiceAccount bool

+ TwoFactor *TwoFactor

+ UnconfirmedEmail string

+ Username string

+ V2Only bool

+ type UserUpdateOptions struct

+ Email *string

+ ID string

+ Username *string

+ type Users struct

+ func (s *Users) ReadCurrent(ctx context.Context) (*User, error)

+ func (s *Users) Update(ctx context.Context, options UserUpdateOptions) (*User, error)

+ type VCSRepo struct

+ Branch string

+ Identifier string

+ IncludeSubmodules bool

+ OAuthTokenID string

+ type VCSRepoOptions struct

+ Branch *string

+ Identifier *string

+ IncludeSubmodules *bool

+ OAuthTokenID *string

+ type Variable struct

+ Category CategoryType

+ HCL bool

+ ID string

+ Key string

+ Sensitive bool

+ Value string

+ Workspace *Workspace

+ type VariableCreateOptions struct

+ Category *CategoryType

+ HCL *bool

+ ID string

+ Key *string

+ Sensitive *bool

+ Value *string

+ Workspace *Workspace

+ type VariableListOptions struct

+ Organization *string

+ Workspace *string

+ type VariableUpdateOptions struct

+ Category *CategoryType

+ HCL *bool

+ ID string

+ Key *string

+ Sensitive *bool

+ Value *string

+ type Variables struct

+ func (s *Variables) Create(ctx context.Context, options VariableCreateOptions) (*Variable, error)

+ func (s *Variables) Delete(ctx context.Context, variableID string) error

+ func (s *Variables) List(ctx context.Context, options VariableListOptions) ([]*Variable, error)

+ func (s *Variables) Update(ctx context.Context, variableID string, options VariableUpdateOptions) (*Variable, error)

+ type Workspace struct

+ Actions *WorkspaceActions

+ AutoApply bool

+ CanQueueDestroyPlan bool

+ CreatedAt time.Time

+ Environment string

+ ID string

+ Locked bool

+ MigrationEnvironment string

+ Name string

+ Organization *Organization

+ Permissions *WorkspacePermissions

+ SSHKey *SSHKey

+ TerraformVersion string

+ VCSRepo *VCSRepo

+ WorkingDirectory string

+ type WorkspaceActions struct

+ IsDestroyable bool

+ type WorkspaceAssignSSHKeyOptions struct

+ ID string

+ SSHKeyID *string

+ type WorkspaceCreateOptions struct

+ AutoApply *bool

+ ID string

+ MigrationEnvironment *string

+ Name *string

+ TerraformVersion *string

+ VCSRepo *VCSRepoOptions

+ WorkingDirectory *string

+ type WorkspaceListOptions struct

+ type WorkspaceLockOptions struct

+ Reason *string

+ type WorkspacePermissions struct

+ CanDestroy bool

+ CanLock bool

+ CanQueueDestroy bool

+ CanQueueRun bool

+ CanReadSettings bool

+ CanUpdate bool

+ CanUpdateVariable bool

+ type WorkspaceUpdateOptions struct

+ AutoApply *bool

+ ID string

+ Name *string

+ TerraformVersion *string

+ VCSRepo *VCSRepoOptions

+ WorkingDirectory *string

+ type Workspaces struct

+ func (s *Workspaces) AssignSSHKey(ctx context.Context, workspaceID string, options WorkspaceAssignSSHKeyOptions) (*Workspace, error)

+ func (s *Workspaces) Create(ctx context.Context, organization string, options WorkspaceCreateOptions) (*Workspace, error)

+ func (s *Workspaces) Delete(ctx context.Context, organization, workspace string) error

+ func (s *Workspaces) List(ctx context.Context, organization string, options WorkspaceListOptions) ([]*Workspace, error)

+ func (s *Workspaces) Lock(ctx context.Context, workspaceID string, options WorkspaceLockOptions) (*Workspace, error)

+ func (s *Workspaces) Read(ctx context.Context, organization, workspace string) (*Workspace, error)

+ func (s *Workspaces) UnassignSSHKey(ctx context.Context, workspaceID string) (*Workspace, error)

+ func (s *Workspaces) Unlock(ctx context.Context, workspaceID string) (*Workspace, error)

+ func (s *Workspaces) Update(ctx context.Context, organization, workspace string, ...) (*Workspace, error)

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