tfe

Sep 29, 2026

Changes in this version

type Run

+ MinimalRefresh bool

type RunCreateOptions

+ MinimalRefresh *bool

Sep 17, 2026

Changes in this version

type NotificationConfigurationSubscribableChoice

+ Stack *Stack

Aug 20, 2026

Changes in this version

+ var ErrInvalidTagSelectorMatchingLogic = errors.New(`tag selector matching logic must be "any" or "all"`)

type PolicySet

+ TagSelectorMatchingLogic *string

type PolicySetCreateOptions

+ TagSelectorMatchingLogic *string

type PolicySetUpdateOptions

+ TagSelectorMatchingLogic *string

Jul 27, 2026

Changes in this version

+ var ErrInvalidExplorerFilterField = errors.New("explorer filter field is required")

+ var ErrInvalidExplorerFilterOperator = errors.New("explorer filter operator is required")

+ var ErrInvalidExplorerViewType = errors.New("explorer query type is required")

+ type AgentTokenListOptions struct

type AgentTokens

+ ListWithOptions func(ctx context.Context, agentPoolID string, options *AgentTokenListOptions) (*AgentTokenList, error)

type Client

+ Explorer Explorer

+ type Explorer interface

+ ExportCSV func(ctx context.Context, organization string, options ExplorerQueryOptions) ([]byte, error)

+ Query func(ctx context.Context, organization string, options ExplorerQueryOptions) (*ExplorerQueryResult, error)

+ type ExplorerFilter struct

+ Field string

+ Operator ExplorerOperator

+ Values []string

+ type ExplorerOperator string

+ const ExplorerOpContains

+ const ExplorerOpDoesNotContain

+ const ExplorerOpGreaterThan

+ const ExplorerOpGreaterThanOrEqual

+ const ExplorerOpIs

+ const ExplorerOpIsAfter

+ const ExplorerOpIsBefore

+ const ExplorerOpIsEmpty

+ const ExplorerOpIsNot

+ const ExplorerOpIsNotEmpty

+ const ExplorerOpLessThan

+ const ExplorerOpLessThanOrEqual

+ type ExplorerQueryOptions struct

+ Fields []string

+ Filters []ExplorerFilter

+ Sort string

+ Type ExplorerViewType

+ type ExplorerQueryResult struct

+ Items []*ExplorerRecord

+ type ExplorerRecord struct

+ Attributes map[string]any

+ ID string

+ Type string

+ type ExplorerViewType string

+ const ExplorerViewModules

+ const ExplorerViewProviders

+ const ExplorerViewTerraformVersions

+ const ExplorerViewWorkspaces

type PolicyEvaluationStatus

+ const PolicyEvaluationQueued

Jun 11, 2026

Changes in this version

+ var ErrRequiredProviderSetID = errors.New("provider set ID is required")

type NotificationConfigurationSubscribableChoice

+ Project *Project

type ProviderSets

+ ReadByName func(ctx context.Context, organization string, name string) (*ProviderSet, error)

Jun 3, 2026

Changes in this version

+ var ErrInvalidTFPolicyEvaluationID = errors.New("invalid value for tfpolicy evaluation ID")

+ var ErrRequiredTagSelectors = errors.New("tag selectors is required")

+ var ErrTagSelectorMinLimit = errors.New("must provide at least one tag selector")

type Client

+ TFPolicyEvaluationOutcomes TFPolicyEvaluationOutcomes

type Entitlements

+ Infragraph bool

+ InfragraphWithNRTU bool

type PolicyKind

+ const TFPolicy

type PolicySet

+ TagSelectors []*PolicySetTagSelectorAttr

+ type PolicySetAddTagSelectorsOptions struct

+ TagSelectors []*PolicySetTagSelector

type PolicySetCreateOptions

+ TagSelectors []*PolicySetTagSelector

+ type PolicySetRemoveTagSelectorsOptions struct

+ TagSelectors []*PolicySetTagSelector

+ type PolicySetTagSelector struct

+ IsExclude bool

+ Key string

+ Value *string

+ type PolicySetTagSelectorAttr struct

+ IsExclude bool

+ Key string

+ Value *string

type PolicySets

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

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

type Run

+ TFPolicyEvaluations []*TFPolicyEvaluation

type RunIncludeOpt

+ const RunTFPolicyEvaluation

+ type TFPolicyEvaluation struct

+ Actions *TFPolicyEvaluationActions

+ Error *TFPolicyEvaluationError

+ ID string

+ Links map[string]interface{}

+ OrganizedLog bool

+ Permissions *TFPolicyEvaluationPermissions

+ ResultCount *TFPolicyEvaluationResultCount

+ Run *Run

+ StageType TFPolicyEvaluationStageType

+ Status TFPolicyEvaluationStatus

+ StatusTimestamps *TFPolicyEvaluationStatusTimestamps

+ TFPolicyEvaluationOutcomes []*TFPolicySetOutcome

+ type TFPolicyEvaluationActions struct

+ IsOverridable bool

+ type TFPolicyEvaluationError struct

+ Detail string

+ Summary string

+ Type TFPolicyEvaluationErrorType

+ type TFPolicyEvaluationErrorType string

+ const TFPolicyEvaluationErrorTypeIncompatibleAgentVersion

+ const TFPolicyEvaluationErrorTypeSetupError

+ type TFPolicyEvaluationListOptions struct

+ EnforcementLevel string

+ Status string

+ type TFPolicyEvaluationOutcomeEnforcementLevel string

+ const TFPolicyEvaluationOutcomeEnforcementLevelAdvisory

+ const TFPolicyEvaluationOutcomeEnforcementLevelMandatory

+ const TFPolicyEvaluationOutcomeEnforcementLevelMandatoryOverridable

+ type TFPolicyEvaluationOutcomeList struct

+ Items []*TFPolicySetOutcome

+ type TFPolicyEvaluationOutcomeStatus string

+ type TFPolicyEvaluationOutcomes interface

+ List func(ctx context.Context, tfPolicyEvaluationID string, ...) (*TFPolicyEvaluationOutcomeList, error)

+ type TFPolicyEvaluationPermissions struct

+ CanOverride bool

+ type TFPolicyEvaluationResultCount struct

+ AdvisoryFailed int

+ Errored int

+ MandatoryFailed int

+ Passed int

+ Unknown int

+ type TFPolicyEvaluationStageType string

+ const TFPolicyEvaluationStageTypeApply

+ const TFPolicyEvaluationStageTypeInit

+ const TFPolicyEvaluationStageTypePlan

+ type TFPolicyEvaluationStatus string

+ const TFPolicyEvaluationStatusAwaitingOverride

+ const TFPolicyEvaluationStatusCanceled

+ const TFPolicyEvaluationStatusErrored

+ const TFPolicyEvaluationStatusFailed

+ const TFPolicyEvaluationStatusOverridden

+ const TFPolicyEvaluationStatusPassed

+ const TFPolicyEvaluationStatusPending

+ const TFPolicyEvaluationStatusQueued

+ const TFPolicyEvaluationStatusRunning

+ const TFPolicyEvaluationStatusUnreachable

+ type TFPolicyEvaluationStatusTimestamps struct

+ AwaitingOverrideAt time.Time

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FailedAt time.Time

+ OverriddenAt time.Time

+ PassedAt time.Time

+ PendingAt time.Time

+ QueuedAt time.Time

+ RunningAt time.Time

+ type TFPolicySetOutcome struct

+ Error *TFPolicyEvaluationError

+ ID string

+ Outcomes []*TFPolicySetPolicyOutcome

+ Overridable bool

+ PolicySetDescription string

+ PolicySetName string

+ ResultCount *TFPolicyEvaluationResultCount

+ TFPolicyEvaluation *TFPolicyEvaluation

+ type TFPolicySetOutcomeDiagnostic struct

+ Code string

+ Context string

+ ErrorMessage string

+ Resources []*TFPolicySetOutcomeResource

+ StartLine int

+ Summary string

+ type TFPolicySetOutcomeResource struct

+ Code string

+ Context string

+ ErrorMessage string

+ FileName string

+ InfoMessage string

+ InfoMessages []string

+ ResourceName string

+ Start int

+ StartLine int

+ Values []...

+ type TFPolicySetPolicyOutcome struct

+ Description string

+ Diagnostics []*TFPolicySetOutcomeDiagnostic

+ EnforcementLevel TFPolicyEvaluationOutcomeEnforcementLevel

+ FileName string

+ PassedResources []*TFPolicySetOutcomeResource

+ PolicyName string

+ Status string

May 26, 2026

Changes in this version

+ var ErrInvalidProviderSetID = errors.New("invalid value for provider set ID")

+ var ErrProviderSetGlobalRelationships = errors.New("global provider set cannot be assigned to workspace or project")

+ var ErrRequiredConfigurationHcl = errors.New("configuration HCL is required")

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

type Client

+ ProviderSets ProviderSets

+ type ProviderSet struct

+ ConfigurationHcl string

+ Description string

+ Global bool

+ ID string

+ Name string

+ Organization *Organization

+ Projects []*Project

+ ProviderSource string

+ Workspaces []*Workspace

+ type ProviderSetCreateOptions struct

+ ConfigurationHcl string

+ Description *string

+ Global *bool

+ Name string

+ Projects []*Project

+ ProviderSource string

+ Type string

+ Workspaces []*Workspace

+ type ProviderSetUpdateOptions struct

+ ConfigurationHcl *string

+ Description *string

+ Global *bool

+ Name *string

+ Projects []*Project

+ ProviderSource *string

+ Workspaces []*Workspace

+ type ProviderSets interface

+ Create func(ctx context.Context, organization string, options ProviderSetCreateOptions) (*ProviderSet, error)

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

+ Read func(ctx context.Context, providerSetID string) (*ProviderSet, error)

+ Update func(ctx context.Context, providerSetID string, options ProviderSetUpdateOptions) (*ProviderSet, error)

type RegistryProviderID

+ ID string

type Workspace

+ SourceModuleID string

May 12, 2026

Changes in this version

+ func NullString() jsonapi.NullableAttr[string]

+ func NullableString(v string) jsonapi.NullableAttr[string]

type AdminUser

+ IsSCIMManaged *bool

+ SCIMUpdatedAt *time.Time

+ SCIMUsername *string

type Team

+ SCIMGroupName *string

+ SCIMLinked *bool

+ SCIMSyncPaused *bool

+ SCIMUpdatedAt *time.Time

type User

+ IsSCIMManaged *bool

+ SCIMUpdatedAt *time.Time

+ SCIMUsername *string

May 7, 2026

Changes in this version

+ const AdminSCIMGroupMappingPath

+ var ErrInvalidRegistryComponentID = errors.New("invalid value for registry component ID")

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

+ var ErrInvalidRegistryProviderID = errors.New("invalid value for registry provider ID")

+ var ErrInvalidSCIMGroupID = errors.New("invalid value for SCIM group ID")

+ var ErrRequiredRegistryComponentCreateOps = errors.New("type and name is required for RegistryComponentCreateOptions")

+ var ErrRequiredSCIMGroupMappingCreateOps = errors.New("Create Options are required to create a SCIM Group Mapping")

+ var ErrRequiredSCIMGroupMappingUpdateOps = errors.New("Update Options are required to update SCIM Group Mapping")

+ var ErrSCIMGroupMappingOwnersTeam = errors.New("unprocessable entity\n\nOwners team SCIM linking is not yet supported")

+ var ErrSCIMGroupMappingSiteAdminGroup = errors.New("unprocessable entity\n\nThe site admin group cannot be linked to a team")

+ var ErrSCIMGroupMappingTeamNotLinked = errors.New("conflict\n\nTeam is not linked to a SCIM group")

+ var ErrSCIMSyncPausedNil = errors.New("SCIM Sync can either be paused or unpaused, can not be nil")

+ var ErrSCIMTeamAlreadyMapped = errors.New("conflict\n\nTeam is already linked to a SCIM group")

+ type AdminSCIMGroupMappingCreateOptions struct

+ SCIMGroupID string

+ Type string

+ type AdminSCIMGroupMappingUpdateOptions struct

+ SCIMSyncPaused *bool

+ Type string

+ type AdminSCIMGroupMappings interface

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

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

+ Update func(ctx context.Context, teamID string, ...) error

type Client

+ OrganizationTokenTTLPolicies OrganizationTokenTTLPolicies

+ RegistryComponents RegistryComponents

type Organization

+ MaxTTLEnabled bool

type OrganizationCreateOptions

+ MaxTTLEnabled *bool

+ type OrganizationTokenTTLPolicies interface

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

+ Update func(ctx context.Context, organization string, ...) ([]*OrganizationTokenTTLPolicy, error)

+ type OrganizationTokenTTLPolicy struct

+ CreatedAt time.Time

+ ID string

+ MaxTTLMs int64

+ TokenType TokenType

+ UpdatedAt time.Time

+ type OrganizationTokenTTLPolicyList struct

+ Items []*OrganizationTokenTTLPolicy

+ type OrganizationTokenTTLPolicyListOptions struct

+ type OrganizationTokenTTLPolicyUpdateItem struct

+ MaxTTLMs int64

+ TokenType TokenType

+ type OrganizationTokenTTLPolicyUpdateOptions struct

+ Policies []OrganizationTokenTTLPolicyUpdateItem

+ Type string

type OrganizationUpdateOptions

+ MaxTTLEnabled *bool

type Outcome

+ Output []OutcomeOutput

+ type OutcomeOutput struct

+ Print string

type QueryRun

+ GenerateConfigOut bool

type QueryRunCreateOptions

+ GenerateConfigOut *bool

+ type RegistryComponent struct

+ CreatedAt string

+ Description string

+ ID string

+ Links map[string]interface{}

+ Name string

+ Namespace string

+ Organization *Organization

+ Status string

+ TagBindings []*TagBinding

+ UpdatedAt string

+ VCSRepo *VCSRepo

+ VersionStatuses []RegistryComponentVersionStatuses

+ type RegistryComponentCreateOptions struct

+ Name string

+ Type string

+ type RegistryComponentUpdateOptions struct

+ TagBindings []*TagBinding

+ type RegistryComponentVersionStatuses struct

+ Status string

+ Version string

+ type RegistryComponents interface

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

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

+ ListTagBindings func(ctx context.Context, componentID string) ([]*TagBinding, error)

+ Update func(ctx context.Context, componentID string, ...) (*RegistryComponent, error)

type RegistryModule

+ TagBindings []*TagBinding

type RegistryModuleUpdateOptions

+ TagBindings []*TagBinding

type RegistryModules

+ ListTagBindings func(ctx context.Context, moduleID string) ([]*TagBinding, error)

type RegistryProvider

+ TagBindings []*TagBinding

+ type RegistryProviderUpdateOptions struct

+ TagBindings []*TagBinding

type RegistryProviders

+ ListTagBindings func(ctx context.Context, providerID string) ([]*TagBinding, error)

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

type RunStatus

+ const RunPostApplyCompleted

+ const RunPostApplyRunning

type SCIMResource

+ SCIMGroupMappings AdminSCIMGroupMappings

type TokenType

+ const TokenTypeAuditTrails

+ const TokenTypeOrganization

+ const TokenTypeTeam

+ const TokenTypeUser

type WorkspacePermissions

+ CanReadStateVersions bool

+ CanReadVariable bool

May 1, 2026

Changes in this version

+ const AdminSCIMGroupsPath

+ const AdminSCIMTokensPath

+ var ErrInvalidSAMLProviderType = errors.New("invalid SAML provider type")

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

+ func Ptr[T any](v T) *T

type AdminSAMLSetting

+ ProviderType SAMLProviderType

type AdminSAMLSettingsUpdateOptions

+ ProviderType *SAMLProviderType

+ type AdminSCIMGroup struct

+ ID string

+ Name string

+ type AdminSCIMGroupList struct

+ Items []*AdminSCIMGroup

+ type AdminSCIMGroupListOptions struct

+ Query string

+ type AdminSCIMGroups interface

+ List func(ctx context.Context, options *AdminSCIMGroupListOptions) (*AdminSCIMGroupList, error)

+ type AdminSCIMSetting struct

+ Enabled bool

+ ID string

+ Paused bool

+ SiteAdminGroupDisplayName string

+ SiteAdminGroupSCIMID string

+ type AdminSCIMSettingUpdateOptions struct

+ Enabled *bool

+ Paused *bool

+ SiteAdminGroupSCIMID *string

+ type AdminSCIMToken struct

+ CreatedAt time.Time

+ Description string

+ ExpiredAt time.Time

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type AdminSCIMTokenCreateOptions struct

+ Description *string

+ ExpiredAt *time.Time

+ type AdminSCIMTokenList struct

+ Items []*AdminSCIMToken

+ type AdminSCIMTokens interface

+ Create func(ctx context.Context, description string) (*AdminSCIMToken, error)

+ CreateWithOptions func(ctx context.Context, options AdminSCIMTokenCreateOptions) (*AdminSCIMToken, error)

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

+ List func(ctx context.Context) (*AdminSCIMTokenList, error)

+ Read func(ctx context.Context, scimTokenID string) (*AdminSCIMToken, error)

type AdminSettings

+ SCIM *SCIMResource

type OrganizationAccess

+ DelegatePolicyOverrides bool

type OrganizationAccessOptions

+ DelegatePolicyOverrides *bool

type PolicySet

+ PolicyUpdatePatterns []string

type PolicySetCreateOptions

+ PolicyUpdatePatterns []string

type PolicySetUpdateOptions

+ PolicyUpdatePatterns []string

type RegistryNoCodeModuleCreateWorkspaceOptions

+ TerraformVersion *string

+ type SAMLProviderType string

+ const SAMLProviderTypeEntra

+ const SAMLProviderTypeGeneric

+ const SAMLProviderTypeOkta

+ const SAMLProviderTypeUnknown

+ func SAMLProvider(v SAMLProviderType) *SAMLProviderType

+ type SCIMResource struct

+ Groups AdminSCIMGroups

+ Tokens AdminSCIMTokens

+ type SCIMSettings interface

+ Delete func(ctx context.Context) error

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

+ Update func(ctx context.Context, options AdminSCIMSettingUpdateOptions) (*AdminSCIMSetting, error)

type Stack

+ TriggerPatterns []string

+ WorkingDirectory string

type StackCreateOptions

+ TriggerPatterns []string

+ WorkingDirectory *string

type StackUpdateOptions

+ TriggerPatterns []string

+ WorkingDirectory *string

type TeamAccess

+ PolicyOverrides bool

type TeamAccessAddOptions

+ PolicyOverrides *bool

type TeamAccessUpdateOptions

+ PolicyOverrides *bool

type TeamProjectAccessWorkspacePermissions

+ WorkspacePolicyOverridesPermission bool

type TeamProjectAccessWorkspacePermissionsOptions

+ PolicyOverrides *bool

Mar 27, 2026

Changes in this version

type PolicySet

+ ProjectExclusions []*Project

+ type PolicySetAddProjectExclusionsOptions struct

+ ProjectExclusions []*Project

type PolicySetCreateOptions

+ ProjectExclusions []*Project

type PolicySetIncludeOpt

+ const PolicySetProjectExclusions

+ type PolicySetRemoveProjectExclusionsOptions struct

+ ProjectExclusions []*Project

type PolicySets

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

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

Mar 24, 2026

Changes in this version

type StateVersion

+ Size int64

Feb 10, 2026

Changes in this version

type RegistryModuleCreateWithVCSConnectionOptions

+ Name *string

+ Provider *string

type StackCreateOptions

+ SpeculativeEnabled *bool

type StackUpdateOptions

+ SpeculativeEnabled *bool

Feb 3, 2026

Changes in this version

+ type RunTriggerReadOptions struct

+ Include []RunTriggerIncludeOpt

type RunTriggers

+ ReadWithOptions func(ctx context.Context, runID string, options *RunTriggerReadOptions) (*RunTrigger, error)

Jan 7, 2026

Changes in this version

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

type Stack

+ CreationSource string

type StackCreateOptions

+ Migration *bool

type Workspace

+ ProjectRemoteState bool

type WorkspaceCreateOptions

+ ProjectRemoteState *bool

type WorkspaceUpdateOptions

+ ProjectRemoteState *bool

Dec 18, 2025

Changes in this version

type DeploymentGroupStatus

+ func (s DeploymentGroupStatus) String() string

+ type DeploymentRunStatus string

+ const DeploymentRunStatusAbandoned

+ const DeploymentRunStatusAcquiringLock

+ const DeploymentRunStatusDeploying

+ const DeploymentRunStatusDeployingPendingOperator

+ const DeploymentRunStatusFailed

+ const DeploymentRunStatusPending

+ const DeploymentRunStatusPreDeploying

+ const DeploymentRunStatusPreDeployingPendingOperator

+ const DeploymentRunStatusSucceeded

+ func (s DeploymentRunStatus) String() string

+ type DeploymentStepStatus string

+ const DeploymentStepStatusAbandoned

+ const DeploymentStepStatusBlocked

+ const DeploymentStepStatusCompleted

+ const DeploymentStepStatusFailed

+ const DeploymentStepStatusPendingOperator

+ const DeploymentStepStatusQueued

+ const DeploymentStepStatusRunning

+ func (s DeploymentStepStatus) String() string

type Organization

+ UserTokensEnabled *bool

type OrganizationCreateOptions

+ UserTokensEnabled *bool

type OrganizationUpdateOptions

+ UserTokensEnabled *bool

type StackConfigurationStatus

+ const StackConfigurationStatusFailed

Dec 2, 2025

Changes in this version

+ var ErrRequiredStackID = errors.New("stack ID is required")

+ var ErrRequiredStacksList = errors.New("no stacks list provided")

type VariableSet

+ Stacks []*Stack

+ type VariableSetApplyToStacksOptions struct

+ Stacks []*Stack

type VariableSetIncludeOpt

+ const VariableSetStacks

+ type VariableSetRemoveFromStacksOptions struct

+ Stacks []*Stack

+ type VariableSetUpdateStacksOptions struct

+ Stacks []*Stack

+ Type string

type VariableSets

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

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

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

Nov 19, 2025

Changes in this version

type Client

+ func (c Client) RemoteTFENumericVersion() string

type StackDeploymentStep

+ OperationType string

Oct 14, 2025

Changes in this version

+ var ErrInvalidStackID = errors.New("invalid value for stack ID")

type AgentListOptions

+ Sort string

type AgentPoolListOptions

+ Sort string

type Client

+ StackDiagnostics StackDiagnostics

+ StackStates StackStates

type ClientRequest

+ func (r *ClientRequest) DoRaw(ctx context.Context) (io.ReadCloser, error)

+ type DiagnosticSnippet struct

+ Code string

+ Context *string

+ HighlightEndOffset int

+ HighlightStartOffset int

+ StartLine int

+ Values []string

type Organization

+ StacksEnabled bool

type OrganizationPermissions

+ CanCreateProject bool

+ CanEnableStacks bool

type StackConfigurations

+ Diagnostics func(ctx context.Context, stackConfigurationID string) (*StackDiagnosticsList, error)

type StackDeployment

+ LatestDeploymentRun *StackDeploymentRun

+ Stack *Stack

+ type StackDeploymentList struct

+ Items []*StackDeployment

+ type StackDeploymentListOptions struct

+ type StackDeploymentStepArtifactType string

+ const StackDeploymentStepArtifactApplyDebugLog

+ const StackDeploymentStepArtifactApplyDescription

+ const StackDeploymentStepArtifactPlanDebugLog

+ const StackDeploymentStepArtifactPlanDescription

type StackDeploymentSteps

+ Artifacts func(ctx context.Context, stackDeploymentStepID string, ...) (io.ReadCloser, error)

+ Diagnostics func(ctx context.Context, stackConfigurationID string) (*StackDiagnosticsList, error)

type StackDeployments

+ List func(ctx context.Context, stackID string, opts *StackDeploymentListOptions) (*StackDeploymentList, error)

type StackDiagnostic

+ ID string

+ type StackDiagnosticSummary struct

+ Detail string

+ Origin string

+ Range *DiagnosticRange

+ Severity string

+ Snippet *DiagnosticSnippet

+ Summary string

+ type StackDiagnostics interface

+ Acknowledge func(ctx context.Context, stackDiagnosticID string) error

+ Read func(ctx context.Context, stackConfigurationID string) (*StackDiagnostic, error)

+ type StackDiagnosticsList struct

+ Items []*StackDiagnostic

type StackState

+ Links map[string]interface{}

+ type StackStateList struct

+ Items []*StackState

+ type StackStateListOptions struct

+ type StackStates interface

+ Description func(ctx context.Context, stackStateID string) (io.ReadCloser, error)

+ List func(ctx context.Context, stackID string, opts *StackStateListOptions) (*StackStateList, error)

+ Read func(ctx context.Context, stackStateID string) (*StackState, error)

Oct 8, 2025

Changes in this version

type Run

+ InvokeActionAddrs []string

type RunCreateOptions

+ InvokeActionAddrs []string

Sep 23, 2025

Changes in this version

+ const OIDCConfigPathFormat

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

+ var ErrInvalidHYOK = errors.New("invalid value for HYOK configuration ID")

+ var ErrInvalidHYOKCustomerKeyVersion = errors.New("invalid value for HYOK Customer key version ID")

+ var ErrInvalidHYOKEncryptedDataKey = errors.New("invalid value for HYOK encrypted data key ID")

+ var ErrInvalidOIDC = errors.New("invalid value for OIDC configuration ID")

+ var ErrRequiredAgentPool = errors.New("agent-pool is required for HYOK configuration")

+ var ErrRequiredClientID = errors.New("client-id is required for Azure OIDC configuration")

+ var ErrRequiredKEKID = errors.New("kek-id is required for HYOK configuration")

+ var ErrRequiredKMSOptions = errors.New("kms-options is required for HYOK configuration")

+ var ErrRequiredKMSOptionsKeyLocation = errors.New("kms-options.key-location is required for HYOK configuration with GCP OIDC")

+ var ErrRequiredKMSOptionsKeyRegion = errors.New("kms-options.key-region is required for HYOK configuration with AWS OIDC")

+ var ErrRequiredKMSOptionsKeyRingID = errors.New("kms-options.key-ring-id is required for HYOK configuration with GCP OIDC")

+ var ErrRequiredOIDCConfiguration = errors.New("oidc-configuration is required for HYOK configuration")

+ var ErrRequiredProjectNumber = errors.New("project-number is required for GCP OIDC configuration")

+ var ErrRequiredRoleARN = errors.New("role-arn is required for AWS OIDC configuration")

+ var ErrRequiredRoleName = errors.New("role is required for Vault OIDC configuration")

+ var ErrRequiredServiceAccountEmail = errors.New("service-account-email is required for GCP OIDC configuration")

+ var ErrRequiredSubscriptionID = errors.New("subscription-id is required for Azure OIDC configuration")

+ var ErrRequiredTenantID = errors.New("tenant-id is required for Azure OIDC configuration")

+ var ErrRequiredVaultAddress = errors.New("address is required for Vault OIDC configuration")

+ var ErrRequiredWorkloadProviderName = errors.New("workload-provider-name is required for GCP OIDC configuration")

+ var ErrSanitizedStateUploadURLMissing = errors.New("sanitized state upload URL is missing")

+ type AWSOIDCConfiguration struct

+ ID string

+ Organization *Organization

+ RoleARN string

+ type AWSOIDCConfigurationCreateOptions struct

+ RoleARN string

+ Type string

+ type AWSOIDCConfigurationUpdateOptions struct

+ RoleARN string

+ Type string

+ type AWSOIDCConfigurations interface

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

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

+ Read func(ctx context.Context, oidcID string) (*AWSOIDCConfiguration, error)

+ Update func(ctx context.Context, oidcID string, options AWSOIDCConfigurationUpdateOptions) (*AWSOIDCConfiguration, error)

type AgentPool

+ HYOKConfigurations []*HYOKConfiguration

type AgentPoolIncludeOpt

+ const AgentPoolHYOKConfigurations

+ type AzureOIDCConfiguration struct

+ ClientID string

+ ID string

+ Organization *Organization

+ SubscriptionID string

+ TenantID string

+ type AzureOIDCConfigurationCreateOptions struct

+ ClientID string

+ SubscriptionID string

+ TenantID string

+ Type string

+ type AzureOIDCConfigurationUpdateOptions struct

+ ClientID *string

+ SubscriptionID *string

+ TenantID *string

+ Type string

+ type AzureOIDCConfigurations interface

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

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

+ Read func(ctx context.Context, oidcID string) (*AzureOIDCConfiguration, error)

+ Update func(ctx context.Context, oidcID string, ...) (*AzureOIDCConfiguration, error)

type Client

+ AWSOIDCConfigurations AWSOIDCConfigurations

+ AzureOIDCConfigurations AzureOIDCConfigurations

+ GCPOIDCConfigurations GCPOIDCConfigurations

+ HYOKConfigurations HYOKConfigurations

+ HYOKCustomerKeyVersions HYOKCustomerKeyVersions

+ HYOKEncryptedDataKeys HYOKEncryptedDataKeys

+ StackDeploymentGroupSummaries StackDeploymentGroupSummaries

+ VaultOIDCConfigurations VaultOIDCConfigurations

type DeploymentGroupStatus

+ const DeploymentGroupStatusAcquiringLock

+ const DeploymentGroupStatusPreDeploying

+ const DeploymentGroupStatusPreDeployingPendingOperator

+ type GCPOIDCConfiguration struct

+ ID string

+ Organization *Organization

+ ProjectNumber string

+ ServiceAccountEmail string

+ WorkloadProviderName string

+ type GCPOIDCConfigurationCreateOptions struct

+ ProjectNumber string

+ ServiceAccountEmail string

+ Type string

+ WorkloadProviderName string

+ type GCPOIDCConfigurationUpdateOptions struct

+ ProjectNumber *string

+ ServiceAccountEmail *string

+ Type string

+ WorkloadProviderName *string

+ type GCPOIDCConfigurations interface

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

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

+ Read func(ctx context.Context, oidcID string) (*GCPOIDCConfiguration, error)

+ Update func(ctx context.Context, oidcID string, options GCPOIDCConfigurationUpdateOptions) (*GCPOIDCConfiguration, error)

+ type HYOKConfiguration struct

+ AgentPool *AgentPool

+ Error *string

+ ID string

+ KEKID string

+ KMSOptions *KMSOptions

+ KeyVersions []*HYOKCustomerKeyVersion

+ Name string

+ OIDCConfiguration *OIDCConfigurationTypeChoice

+ Organization *Organization

+ Primary bool

+ Status HYOKConfigurationStatus

+ type HYOKConfigurationStatus string

+ const HYOKConfigurationAvailable

+ const HYOKConfigurationErrored

+ const HYOKConfigurationRevoked

+ const HYOKConfigurationRevoking

+ const HYOKConfigurationTestFailed

+ const HYOKConfigurationTesting

+ const HYOKConfigurationUntested

+ type HYOKConfigurations interface

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

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

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

+ Read func(ctx context.Context, hyokID string, options *HYOKConfigurationsReadOptions) (*HYOKConfiguration, error)

+ Revoke func(ctx context.Context, hyokID string) error

+ Test func(ctx context.Context, hyokID string) error

+ Update func(ctx context.Context, hyokID string, options HYOKConfigurationsUpdateOptions) (*HYOKConfiguration, error)

+ type HYOKConfigurationsCreateOptions struct

+ AgentPool *AgentPool

+ KEKID string

+ KMSOptions *KMSOptions

+ Name string

+ OIDCConfiguration *OIDCConfigurationTypeChoice

+ Type string

+ type HYOKConfigurationsIncludeOpt string

+ const HYOKConfigurationsIncludeHYOKCustomerKeyVersions

+ const HYOKConfigurationsIncludeOIDCConfiguration

+ type HYOKConfigurationsList struct

+ Items []*HYOKConfiguration

+ type HYOKConfigurationsListOptions struct

+ Include []HYOKConfigurationsIncludeOpt

+ SearchQuery string

+ type HYOKConfigurationsReadOptions struct

+ Include []HYOKConfigurationsIncludeOpt

+ type HYOKConfigurationsUpdateOptions struct

+ AgentPool *AgentPool

+ KEKID *string

+ KMSOptions *KMSOptions

+ Name *string

+ Primary *bool

+ Type string

+ type HYOKCustomerKeyVersion struct

+ CreatedAt time.Time

+ Error string

+ HYOKConfiguration *HYOKConfiguration

+ ID string

+ KeyVersion string

+ Status HYOKKeyVersionStatus

+ WorkspacesSecured int

+ type HYOKCustomerKeyVersionList struct

+ Items []*HYOKCustomerKeyVersion

+ type HYOKCustomerKeyVersionListOptions struct

+ Refresh bool

+ type HYOKCustomerKeyVersions interface

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

+ List func(ctx context.Context, hyokConfigurationID string, ...) (*HYOKCustomerKeyVersionList, error)

+ Read func(ctx context.Context, hyokCustomerKeyVersionID string) (*HYOKCustomerKeyVersion, error)

+ Revoke func(ctx context.Context, hyokCustomerKeyVersionID string) error

+ type HYOKEncryptedDataKey struct

+ CreatedAt time.Time

+ CustomerKeyName string

+ EncryptedDEK string

+ ID string

+ KeyVersion *HYOKCustomerKeyVersion

+ type HYOKEncryptedDataKeys interface

+ Read func(ctx context.Context, hyokEncryptedDataKeyID string) (*HYOKEncryptedDataKey, error)

+ type HYOKKeyVersionStatus string

+ const KeyVersionStatusAvailable

+ const KeyVersionStatusRevocationFailed

+ const KeyVersionStatusRevoked

+ const KeyVersionStatusRevoking

+ type KMSOptions struct

+ KeyLocation string

+ KeyRegion string

+ KeyRingID string

+ type OIDCConfigurationTypeChoice struct

+ AWSOIDCConfiguration *AWSOIDCConfiguration

+ AzureOIDCConfiguration *AzureOIDCConfiguration

+ GCPOIDCConfiguration *GCPOIDCConfiguration

+ VaultOIDCConfiguration *VaultOIDCConfiguration

type Organization

+ EnforceHYOK bool

+ PrimaryHYOKConfiguration *HYOKConfiguration

type OrganizationCreateOptions

+ EnforceHYOK *bool

type OrganizationPermissions

+ CanUpdateHYOKConfiguration bool

+ CanViewHYOKFeatureInfo bool

type OrganizationUpdateOptions

+ EnforceHYOK *bool

type Plan

+ HYOKEncryptedDataKey *HYOKEncryptedDataKey

+ Links map[string]interface{}

type Stack

+ DownstreamCount int

+ InputsCount int

+ OutputsCount int

+ UpstreamCount int

type StackComponent

+ Removed bool

type StackConfiguration

+ IngressAttributes *IngressAttributes

+ PreparingEventStreamURL string

+ Speculative bool

type StackConfigurations

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

+ type StackDeploymentGroupStatusCounts struct

+ Abandoned int

+ AcquiringLock int

+ Deploying int

+ Failed int

+ Pending int

+ PreDeploying int

+ PreDeployingPendingOperator int

+ Succeeded int

+ type StackDeploymentGroupSummaries interface

+ List func(ctx context.Context, configurationID string, ...) (*StackDeploymentGroupSummaryList, error)

+ type StackDeploymentGroupSummary struct

+ ID string

+ Name string

+ StackDeploymentGroup *StackDeploymentGroup

+ Status string

+ StatusCounts *StackDeploymentGroupStatusCounts

+ type StackDeploymentGroupSummaryList struct

+ Items []*StackDeploymentGroupSummary

+ type StackDeploymentGroupSummaryListOptions struct

type StackDiagnostic

+ Acknowledged bool

+ AcknowledgedAt *time.Time

+ AcknowledgedBy *User

+ CreatedAt *time.Time

+ Diags *DiagnosticRange

+ StackConfiguration *StackConfiguration

+ StackDeploymentStep *StackDeploymentStep

type StackState

+ Components string

+ Deployment string

+ Description string

+ Generation int

+ IsCurrent bool

+ ResourceInstanceCount int

+ Stack *Stack

+ StackDeploymentRun *StackDeploymentRun

+ Status string

type Stacks

+ FetchLatestFromVcs func(ctx context.Context, stackID string) (*Stack, error)

type StateVersion

+ EncryptedStateDownloadURL *string

+ HYOKEncryptedDataKey *HYOKEncryptedDataKey

+ SanitizedStateDownloadURL *string

+ SanitizedStateUploadURL *string

type StateVersions

+ UploadSanitizedState func(ctx context.Context, sanitizedStateUploadURL *string, sanitizedState []byte) error

+ type VaultOIDCConfiguration struct

+ Address string

+ ID string

+ JWTAuthPath string

+ Namespace string

+ Organization *Organization

+ RoleName string

+ TLSCACertificate string

+ type VaultOIDCConfigurationCreateOptions struct

+ Address string

+ JWTAuthPath string

+ Namespace string

+ RoleName string

+ TLSCACertificate string

+ Type string

+ type VaultOIDCConfigurationUpdateOptions struct

+ Address *string

+ JWTAuthPath *string

+ Namespace *string

+ RoleName *string

+ TLSCACertificate *string

+ Type string

+ type VaultOIDCConfigurations interface

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

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

+ Read func(ctx context.Context, oidcID string) (*VaultOIDCConfiguration, error)

+ Update func(ctx context.Context, oidcID string, ...) (*VaultOIDCConfiguration, error)

type Workspace

+ HYOKEnabled *bool

+ HYOKEncryptedDataKey *HYOKEncryptedDataKey

type WorkspaceCreateOptions

+ HYOKEnabled *bool

type WorkspacePermissions

+ CanManageHYOK bool

type WorkspaceUpdateOptions

+ HYOKEnabled *bool

Sep 11, 2025

Changes in this version

+ var ErrAgentPoolNotRequiredForRemoteExecution = errors.New("'remote' execution mode does not support agent pool IDs")

+ type AgentExecutionMode string

+ const AgentExecutionModeAgent

+ const AgentExecutionModeRemote

+ func AgentExecutionModePtr(v AgentExecutionMode) *AgentExecutionMode

+ func (a *AgentExecutionMode) UnmarshalText(text []byte) error

+ func (a AgentExecutionMode) MarshalText() ([]byte, error)

type Client

+ StackConfigurationSummaries StackConfigurationSummaries

type RegistryModuleTestConfigOptions

+ AgentExecutionMode *AgentExecutionMode

+ AgentPoolID *string

type Stack

+ AgentPool *AgentPool

+ type StackConfigurationSummaries interface

+ List func(ctx context.Context, stackID string, ...) (*StackConfigurationSummaryList, error)

+ type StackConfigurationSummary struct

+ ID string

+ SequenceNumber int

+ Status string

+ type StackConfigurationSummaryList struct

+ Items []*StackConfigurationSummary

+ type StackConfigurationSummaryListOptions struct

type StackCreateOptions

+ AgentPool *AgentPool

type StackUpdateOptions

+ AgentPool *AgentPool

type TestConfig

+ AgentExecutionMode *string

+ AgentPoolID *string

Aug 26, 2025

Changes in this version

type StackDeploymentRun

+ CreatedAt time.Time

+ UpdatedAt time.Time

Aug 22, 2025

Changes in this version

type AgentPool

+ AllowedProjects []*Project

+ CreatedAt time.Time

+ ExcludedWorkspaces []*Workspace

+ type AgentPoolAllowedProjectsUpdateOptions struct

+ AllowedProjects []*Project

+ Type string

type AgentPoolCreateOptions

+ AllowedProjects []*Project

+ ExcludedWorkspaces []*Workspace

+ type AgentPoolExcludedWorkspacesUpdateOptions struct

+ ExcludedWorkspaces []*Workspace

+ Type string

type AgentPoolListOptions

+ AllowedProjectsName string

type AgentPoolUpdateOptions

+ AllowedProjects []*Project

+ ExcludedWorkspaces []*Workspace

type AgentPools

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

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

type AgentToken

+ CreatedBy *User

type GHAInstallation

+ IconURL *string

+ InstallationType *string

+ InstallationURL *string

type Project

+ DefaultAgentPool *AgentPool

+ DefaultExecutionMode string

+ SettingOverwrites *ProjectSettingOverwrites

type ProjectCreateOptions

+ DefaultAgentPoolID *string

+ DefaultExecutionMode *string

+ SettingOverwrites *ProjectSettingOverwrites

+ type ProjectSettingOverwrites struct

+ AgentPool *bool

+ ExecutionMode *bool

type ProjectUpdateOptions

+ DefaultAgentPoolID *string

+ DefaultExecutionMode *string

+ SettingOverwrites *ProjectSettingOverwrites

type QueryRun

+ LogReadURL string

+ type QueryRunStatus string

+ const QueryRunCanceled

+ const QueryRunErrored

+ const QueryRunFinished

+ const QueryRunPending

+ const QueryRunQueued

+ const QueryRunRunning

type QueryRuns

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

type Run

+ CanceledAt time.Time

+ RunEvents []*RunEvent

+ TriggerReason string

type Workspace

+ Source WorkspaceSource

+ type WorkspaceSource string

+ const WorkspaceSourceAPI

+ const WorkspaceSourceModule

+ const WorkspaceSourceTerraform

+ const WorkspaceSourceUI

Aug 13, 2025

Changes in this version

+ var ErrInvalidQueryRunID = errors.New("invalid value for query run id")

type Client

+ QueryRuns QueryRuns

+ type CreateStackConfigurationOptions struct

+ SelectedDeployments []string

+ SpeculativeEnabled *bool

type OrganizationCreateOptions

+ RegistryMonorepoSupportEnabled *bool

type OrganizationUpdateOptions

+ RegistryMonorepoSupportEnabled *bool

+ type PolicySetIngressAttributes struct

+ CommitSHA string

+ CommitURL string

+ Identifier string

+ type QueryRun struct

+ CanceledBy *User

+ ConfigurationVersion *ConfigurationVersion

+ CreatedAt time.Time

+ CreatedBy *User

+ ID string

+ Source RunSource

+ Status RunStatus

+ StatusTimestamps *RunStatusTimestamps

+ TerraformVersion string

+ Variables []*RunVariableAttr

+ Workspace *Workspace

+ type QueryRunCreateOptions struct

+ ConfigurationVersion *ConfigurationVersion

+ Source QueryRunSource

+ TerraformVersion *string

+ Type string

+ Variables []*RunVariable

+ Workspace *Workspace

+ type QueryRunIncludeOpt string

+ const QueryRunConfigVer

+ const QueryRunCreatedBy

+ type QueryRunList struct

+ Items []*QueryRun

+ type QueryRunListOptions struct

+ Include []QueryRunIncludeOpt

+ type QueryRunReadOptions struct

+ Include []QueryRunIncludeOpt

+ type QueryRunSource string

+ const QueryRunSourceAPI

+ type QueryRunStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ ForceCanceledAt time.Time

+ QueuingAt time.Time

+ RunningAt time.Time

+ type QueryRuns interface

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

+ Create func(ctx context.Context, options QueryRunCreateOptions) (*QueryRun, error)

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

+ List func(ctx context.Context, workspaceID string, options *QueryRunListOptions) (*QueryRunList, error)

+ Read func(ctx context.Context, queryRunID string) (*QueryRun, error)

+ ReadWithOptions func(ctx context.Context, queryRunID string, options *QueryRunReadOptions) (*QueryRun, error)

type RegistryModuleListOptions

+ OrganizationName string

+ Provider string

+ RegistryName RegistryName

+ Search string

type RegistryModuleVCSRepoOptions

+ SourceDirectory *string

+ TagPrefix *string

type RegistryModuleVCSRepoUpdateOptions

+ SourceDirectory *string

+ TagPrefix *string

type StackConfigurations

+ CreateAndUpload func(ctx context.Context, stackID string, path string, ...) (*StackConfiguration, error)

+ type StackDeploymentGroupRerunOptions struct

+ Deployments []string

type StackDeploymentGroups

+ ReadByName func(ctx context.Context, stackConfigurationID, stackDeploymentName string) (*StackDeploymentGroup, error)

+ Rerun func(ctx context.Context, stackDeploymentGroupID string, ...) error

type VCSRepo

+ SourceDirectory string

+ TagPrefix string

Aug 6, 2025

Changes in this version

type StackConfiguration

+ CreatedAt time.Time

+ UpdatedAt time.Time

type StackDeploymentRuns

+ Cancel func(ctx context.Context, stackDeploymentRunID string) error

type StackDeploymentStep

+ Links map[string]interface{}

type StackDeploymentSteps

+ Advance func(ctx context.Context, stackDeploymentStepID string) error

Jul 29, 2025

Changes in this version

type Client

+ OrganizationAuditConfigurations OrganizationAuditConfigurations

+ type OrganizationAuditConfigAuditStreaming struct

+ Enabled bool

+ OrganizationID string

+ UseDefaultOrganization bool

+ type OrganizationAuditConfigAuditTrails struct

+ Enabled bool

+ type OrganizationAuditConfigPermissions struct

+ CanEnableHCPAuditLogStreaming bool

+ CanSetHCPAuditLogStreamingOrganization bool

+ CanUseDefaultAuditLogStreamingOrganization bool

+ type OrganizationAuditConfigTimestamps struct

+ AuditTrailsDisabledAt *time.Time

+ AuditTrailsEnabledAt *time.Time

+ AuditTrailsLastFailure *time.Time

+ AuditTrailsLastSuccess *time.Time

+ HCPAuditLogStreamingDisabledAt *time.Time

+ HCPAuditLogStreamingEnabledAt *time.Time

+ HCPAuditLogStreamingLastFailure *time.Time

+ HCPAuditLogStreamingLastSuccess *time.Time

+ type OrganizationAuditConfiguration struct

+ AuditTrails *OrganizationAuditConfigAuditTrails

+ HCPAuditLogStreaming *OrganizationAuditConfigAuditStreaming

+ ID string

+ Organization *Organization

+ Permissions *OrganizationAuditConfigPermissions

+ Timestamps *OrganizationAuditConfigTimestamps

+ UpdatedAt time.Time

+ type OrganizationAuditConfigurationOptions struct

+ AuditTrails *OrganizationAuditConfigAuditTrails

+ HCPAuditLogStreaming *OrganizationAuditConfigAuditStreaming

+ type OrganizationAuditConfigurationTest struct

+ RequestID *string

+ type OrganizationAuditConfigurations interface

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

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

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

type OrganizationPermissions

+ CanManageAuditing bool

type StackConfigurationStatus

+ const StackConfigurationStatusCompleted

Jul 11, 2025

Changes in this version

+ type SDRIncludeOpt string

+ const SDRDeploymentGroup

type StackDeploymentRunListOptions

+ Include []SDRIncludeOpt

+ type StackDeploymentRunReadOptions struct

+ Include []SDRIncludeOpt

type StackDeploymentRuns

+ ReadWithOptions func(ctx context.Context, stackDeploymentRunID string, ...) (*StackDeploymentRun, error)

Jul 2, 2025

Changes in this version

+ var ErrInvalidReservedTagKeyID = errors.New("invalid value for reserved tag key ID")

type Client

+ ReservedTagKeys ReservedTagKeys

+ type ReservedTagKey struct

+ CreatedAt time.Time

+ DisableOverrides bool

+ ID string

+ Key string

+ UpdatedAt time.Time

+ type ReservedTagKeyCreateOptions struct

+ DisableOverrides *bool

+ Key string

+ Type string

+ type ReservedTagKeyList struct

+ Items []*ReservedTagKey

+ type ReservedTagKeyListOptions struct

+ type ReservedTagKeyUpdateOptions struct

+ DisableOverrides *bool

+ Key *string

+ Type string

+ type ReservedTagKeys interface

+ Create func(ctx context.Context, organization string, options ReservedTagKeyCreateOptions) (*ReservedTagKey, error)

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

+ List func(ctx context.Context, organization string, options *ReservedTagKeyListOptions) (*ReservedTagKeyList, error)

+ Update func(ctx context.Context, reservedTagKeyID string, ...) (*ReservedTagKey, error)

Jun 20, 2025

Changes in this version

type Client

+ StackDeploymentRuns StackDeploymentRuns

+ StackDeploymentSteps StackDeploymentSteps

type StackConfiguration

+ Stack *Stack

+ type StackConfigurationList struct

+ Items []*StackConfiguration

+ Pagination *Pagination

+ type StackConfigurationListOptions struct

type StackConfigurations

+ List func(ctx context.Context, stackID string, options *StackConfigurationListOptions) (*StackConfigurationList, error)

type StackDeploymentGroups

+ ApproveAllPlans func(ctx context.Context, stackDeploymentGroupID string) error

+ type StackDeploymentRun struct

+ CompletedAt time.Time

+ ID string

+ StackDeploymentGroup *StackDeploymentGroup

+ StartedAt time.Time

+ Status string

+ type StackDeploymentRunList struct

+ Items []*StackDeploymentRun

+ type StackDeploymentRunListOptions struct

+ type StackDeploymentRuns interface

+ ApproveAllPlans func(ctx context.Context, deploymentRunID string) error

+ List func(ctx context.Context, deploymentGroupID string, ...) (*StackDeploymentRunList, error)

+ Read func(ctx context.Context, stackDeploymentRunID string) (*StackDeploymentRun, error)

+ type StackDeploymentStep struct

+ CreatedAt time.Time

+ ID string

+ StackDeploymentRun *StackDeploymentRun

+ Status string

+ UpdatedAt time.Time

+ type StackDeploymentStepList struct

+ Items []*StackDeploymentStep

+ type StackDeploymentSteps interface

+ List func(ctx context.Context, stackDeploymentRunID string, ...) (*StackDeploymentStepList, error)

+ Read func(ctx context.Context, stackDeploymentStepID string) (*StackDeploymentStep, error)

+ type StackDeploymentStepsListOptions struct

Jun 17, 2025

Changes in this version

type Client

+ StackDeploymentGroups StackDeploymentGroups

+ type DeploymentGroupStatus string

+ const DeploymentGroupStatusAbandoned

+ const DeploymentGroupStatusDeploying

+ const DeploymentGroupStatusFailed

+ const DeploymentGroupStatusPending

+ const DeploymentGroupStatusSucceeded

type Entitlements

+ PrivateRunTasks bool

type RunTask

+ AgentPool *AgentPool

type RunTaskCreateOptions

+ AgentPool *AgentPool

type RunTaskUpdateOptions

+ AgentPool *AgentPool

+ type StackDeploymentGroup struct

+ CreatedAt string

+ ID string

+ Name string

+ StackConfiguration StackConfiguration

+ Status DeploymentGroupStatus

+ UpdatedAt string

+ type StackDeploymentGroupList struct

+ Items []*StackDeploymentGroup

+ type StackDeploymentGroupListOptions struct

+ type StackDeploymentGroups interface

+ List func(ctx context.Context, stackConfigID string, ...) (*StackDeploymentGroupList, error)

+ Read func(ctx context.Context, stackDeploymentGroupID string) (*StackDeploymentGroup, error)

type TaskResult

+ AgentPoolID *string

type Variables

+ ListAll func(ctx context.Context, workspaceID string, options *VariableListOptions) (*VariableList, error)

Jun 11, 2025

Changes in this version

type CreateStackSourceOptions

+ SpeculativeEnabled *bool

+ type TeamTokenList struct

+ Items []*TeamToken

+ type TeamTokenListOptions struct

+ Query string

+ Sort string

type TeamTokens

+ List func(ctx context.Context, organizationID string, options *TeamTokenListOptions) (*TeamTokenList, error)

May 21, 2025

Changes in this version

type PolicySetVersion

+ IngressAttributes *IngressAttributes

type Run

+ ConfirmedBy *User

May 14, 2025

Changes in this version

type Run

+ PolicyPaths []string

type RunCreateOptions

+ PolicyPaths []string

May 7, 2025

Changes in this version

+ var ErrRequiredArchsOrURLAndSha = errors.New("valid archs or url and sha are required")

type AdminOPAVersion

+ Archs []*ToolVersionArchitecture

type AdminOPAVersionCreateOptions

+ Archs []*ToolVersionArchitecture

type AdminOPAVersionUpdateOptions

+ Archs []*ToolVersionArchitecture

type AdminSentinelVersion

+ Archs []*ToolVersionArchitecture

type AdminSentinelVersionCreateOptions

+ Archs []*ToolVersionArchitecture

type AdminSentinelVersionUpdateOptions

+ Archs []*ToolVersionArchitecture

type OAuthClientUpdateOptions

+ AgentPool *AgentPool

Apr 17, 2025

Changes in this version

type EffectiveTagBinding

+ Links map[string]interface{}

+ type ProjectReadOptions struct

+ Include []ProjectIncludeOpt

type Projects

+ ReadWithOptions func(ctx context.Context, projectID string, options ProjectReadOptions) (*Project, error)

Apr 15, 2025

Changes in this version

+ const AuthenticationTokensPath

+ var ErrInvalidDescriptionConflict = errors.New("invalid attributes\n\nValidation failed: Description has already been taken")

+ type OrganizationRunList struct

+ Items []*Run

+ type PaginationNextPrev struct

+ CurrentPage int

+ NextPage int

+ PreviousPage int

type TeamToken

+ Team *Team

type TeamTokenCreateOptions

+ Description string

type TeamTokens

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

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

Feb 26, 2025

Changes in this version

type AdminTerraformVersion

+ Archs []*ToolVersionArchitecture

type AdminTerraformVersionUpdateOptions

+ Archs []*ToolVersionArchitecture

+ type Input struct

+ Default string

+ Description string

+ Name string

+ Required bool

+ Type string

type OrganizationUpdateOptions

+ DefaultProject jsonapi.NullableRelationship[*Project]

+ type Output struct

+ Description string

+ Name string

+ type ProviderDependency struct

+ Name string

+ Namespace string

+ Source string

+ Version string

type RegistryModules

+ ReadTerraformRegistryModule func(ctx context.Context, moduleID RegistryModuleID, version string) (*TerraformRegistryModule, error)

+ type Resource struct

+ Name string

+ Type string

+ type Root struct

+ Empty bool

+ Inputs []Input

+ Name string

+ Outputs []Output

+ Path string

+ ProviderDependencies []ProviderDependency

+ Readme string

+ Resources []Resource

+ type RunListForOrganizationOptions struct

+ AgentPoolNames string

+ Basic string

+ Commit string

+ Include []RunIncludeOpt

+ Operation string

+ Source string

+ Status string

+ StatusGroup string

+ Timeframe string

+ User string

+ WorkspaceNames string

type Runs

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

+ type TerraformRegistryModule struct

+ Description string

+ Downloads int

+ ID string

+ Name string

+ Namespace string

+ Owner string

+ Provider string

+ ProviderLogoURL string

+ Providers []string

+ PublishedAt string

+ Root Root

+ Source string

+ Tag string

+ Verified bool

+ Version string

+ Versions []string

Jan 29, 2025

Changes in this version

type Project

+ EffectiveTagBindings []*EffectiveTagBinding

+ type ProjectIncludeOpt string

+ const ProjectEffectiveTagBindings

type ProjectListOptions

+ Include []ProjectIncludeOpt

type WSIncludeOpt

+ const WSEffectiveTagBindings

type Workspace

+ EffectiveTagBindings []*EffectiveTagBinding

Jan 21, 2025

Changes in this version

type TestRunCreateOptions

+ Parallelism *int

Jan 15, 2025

Changes in this version

+ type ProjectVariableSetsPermissionType string

+ const ProjectVariableSetsPermissionNone

+ const ProjectVariableSetsPermissionRead

+ const ProjectVariableSetsPermissionWrite

+ func ProjectVariableSetsPermission(v ProjectVariableSetsPermissionType) *ProjectVariableSetsPermissionType

+ type StackVCSRepoOptions struct

+ Branch string

+ GHAInstallationID string

+ Identifier string

+ OAuthTokenID string

type TeamProjectAccessProjectPermissions

+ ProjectVariableSetsPermission ProjectVariableSetsPermissionType

type TeamProjectAccessProjectPermissionsOptions

+ VariableSets *ProjectVariableSetsPermissionType

Jan 10, 2025

Changes in this version

+ type ToolVersionArchitectureOptions struct

+ Arch string

+ OS string

+ Sha string

+ URL string

Jan 8, 2025

Changes in this version

type NotificationConfiguration

+ SubscribableChoice *NotificationConfigurationSubscribableChoice

type NotificationConfigurationCreateOptions

+ SubscribableChoice *NotificationConfigurationSubscribableChoice

type NotificationConfigurationListOptions

+ SubscribableChoice *NotificationConfigurationSubscribableChoice

+ type NotificationConfigurationSubscribableChoice struct

+ Team *Team

+ Workspace *Workspace

type NotificationTriggerType

+ const NotificationTriggerChangeRequestCreated

Jan 7, 2025

Changes in this version

+ var ErrRequiredArchOrURLAndSha = errors.New("valid arch or url and sha is required")

type AdminTerraformVersionCreateOptions

+ Archs []*ToolVersionArchitecture

type Project

+ AutoDestroyActivityDuration jsonapi.NullableAttr[string]

type ProjectCreateOptions

+ AutoDestroyActivityDuration jsonapi.NullableAttr[string]

type ProjectUpdateOptions

+ AutoDestroyActivityDuration jsonapi.NullableAttr[string]

type Projects

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

+ type ToolVersionArchitecture struct

+ Arch string

+ OS string

+ Sha string

+ URL string

type Workspace

+ InheritsProjectAutoDestroy bool

type WorkspaceCreateOptions

+ InheritsProjectAutoDestroy *bool

type WorkspaceUpdateOptions

+ InheritsProjectAutoDestroy *bool

type Workspaces

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

Nov 27, 2024

Changes in this version

+ type EffectiveTagBinding struct

+ ID string

+ Key string

+ Value string

type Projects

+ ListEffectiveTagBindings func(ctx context.Context, workspaceID string) ([]*EffectiveTagBinding, error)

type RegistryModule

+ RegistryNoCodeModule []*RegistryNoCodeModule

+ type RegistryModuleListIncludeOpt string

+ const IncludeNoCodeModules

type RegistryModuleListOptions

+ Include []RegistryModuleListIncludeOpt

type Workspaces

+ ListEffectiveTagBindings func(ctx context.Context, workspaceID string) ([]*EffectiveTagBinding, error)

Oct 26, 2024

Changes in this version

+ var ErrRequiredTagBindings = errors.New("TagBindings are required")

+ type ProjectAddTagBindingsOptions struct

+ TagBindings []*TagBinding

type Projects

+ AddTagBindings func(ctx context.Context, projectID string, options ProjectAddTagBindingsOptions) ([]*TagBinding, error)

+ type WorkspaceAddTagBindingsOptions struct

+ TagBindings []*TagBinding

type Workspaces

+ AddTagBindings func(ctx context.Context, workspaceID string, ...) ([]*TagBinding, error)

Oct 25, 2024

Changes in this version

+ type CreateStackSourceOptions struct

+ SelectedDeployments []string

type Organization

+ SpeculativePlanManagementEnabled bool

type OrganizationCreateOptions

+ SpeculativePlanManagementEnabled *bool

type OrganizationUpdateOptions

+ SpeculativePlanManagementEnabled *bool

+ StacksEnabled *bool

+ type Parent struct

+ Organization *Organization

+ Project *Project

type ProjectCreateOptions

+ TagBindings []*TagBinding

type ProjectListOptions

+ TagBindings []*TagBinding

type ProjectUpdateOptions

+ TagBindings []*TagBinding

type Projects

+ ListTagBindings func(ctx context.Context, projectID string) ([]*TagBinding, error)

type RegistryModuleID

+ ID string

+ type TagBinding struct

+ ID string

+ Key string

+ Value string

type VariableSet

+ Parent *Parent

type VariableSetCreateOptions

+ Parent *Parent

type Workspace

+ TagBindings []*TagBinding

type WorkspaceCreateOptions

+ TagBindings []*TagBinding

type WorkspaceListOptions

+ TagBindings []*TagBinding

type WorkspaceUpdateOptions

+ TagBindings []*TagBinding

type Workspaces

+ ListTagBindings func(ctx context.Context, workspaceID string) ([]*TagBinding, error)

Oct 2, 2024

Changes in this version

type Entitlements

+ WaypointActions bool

+ WaypointTemplatesAndAddons bool

+ type RegistryModuleVariable struct

+ Description string

+ HasGlobal bool

+ ID string

+ Name string

+ Options []string

+ Required bool

+ Sensitive bool

+ VariableType string

+ type RegistryModuleVariableList struct

+ Items []*RegistryModuleVariable

+ type RegistryNoCodeModuleReadVariablesOptions struct

+ Type string

type RegistryNoCodeModules

+ ReadVariables func(ctx context.Context, noCodeModuleID, noCodeModuleVersion string, ...) (*RegistryModuleVariableList, error)

Sep 24, 2024

Changes in this version

+ var ErrWorkspaceLockedStateVersionStillPending = errors.New("unable to unlock workspace while state version upload is still pending")

Sep 17, 2024

Changes in this version

+ var ErrWorkspaceLockedByTeam = errors.New("unable to unlock workspace locked by team")

+ var ErrWorkspaceLockedByUser = errors.New("unable to unlock workspace locked by user")

type StateVersion

+ BillableRUMCount *uint32

Sep 10, 2024

Changes in this version

type Stacks

+ ForceDelete func(ctx context.Context, stackID string) error

+ type WorkspaceUpgrade struct

+ Message string

+ PlanURL string

+ Status string

Aug 27, 2024

Changes in this version

type OrganizationPermissions

+ CanDeployNoCodeModules bool

+ CanManageNoCodeModules bool

Aug 20, 2024

Changes in this version

type OrganizationTokenCreateOptions

+ TokenType *TokenType

+ type OrganizationTokenDeleteOptions struct

+ TokenType *TokenType

+ type OrganizationTokenReadOptions struct

+ TokenType *TokenType

type OrganizationTokens

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

+ ReadWithOptions func(ctx context.Context, organization string, options OrganizationTokenReadOptions) (*OrganizationToken, error)

+ type StackIncludeOpt string

+ const StackIncludeLatestStackConfiguration

+ const StackIncludeOrganization

+ const StackIncludeProject

+ const StackIncludeStackDiagnostics

type StackListOptions

+ Include []StackIncludeOpt

+ type StackReadOptions struct

+ Include []StackIncludeOpt

+ type TokenType string

+ const AuditTrailToken

Aug 14, 2024

Changes in this version

type Client

+ StackSources StackSources

+ type DiagnosticPos struct

+ Byte int

+ Column int

+ Line int

+ type DiagnosticRange struct

+ End DiagnosticPos

+ Filename string

+ Source string

+ Start DiagnosticPos

type OrganizationCreateOptions

+ StacksEnabled *bool

type Stack

+ SpeculativeEnabled bool

type StackConfiguration

+ Diagnostics []*StackDiagnostic

+ type StackConfigurationStatus string

+ const StackConfigurationStatusCanceled

+ const StackConfigurationStatusConverged

+ const StackConfigurationStatusConverging

+ const StackConfigurationStatusEnqueueing

+ const StackConfigurationStatusErrored

+ const StackConfigurationStatusPending

+ const StackConfigurationStatusPreparing

+ const StackConfigurationStatusQueued

+ func (s StackConfigurationStatus) String() string

type StackConfigurations

+ AwaitCompleted func(ctx context.Context, stackConfigurationID string) <-chan WaitForStatusResult

+ AwaitStatus func(ctx context.Context, stackConfigurationID string, ...) <-chan WaitForStatusResult

+ type StackDiagnostic struct

+ Detail string

+ Range *DiagnosticRange

+ Severity string

+ Summary string

+ type StackPlanStatus string

+ const StackPlanStatusCanceled

+ const StackPlanStatusCreated

+ const StackPlanStatusDiscarded

+ const StackPlanStatusErrored

+ const StackPlanStatusFinished

+ const StackPlanStatusFinishedApplied

+ const StackPlanStatusFinishedNoChanges

+ const StackPlanStatusFinishedPlanned

+ const StackPlanStatusRunning

+ const StackPlanStatusRunningApplying

+ const StackPlanStatusRunningPlanning

+ const StackPlanStatusRunningQueued

+ func (s StackPlanStatus) String() string

type StackPlans

+ AwaitRunning func(ctx context.Context, stackPlanID string) <-chan WaitForStatusResult

+ AwaitTerminal func(ctx context.Context, stackPlanID string) <-chan WaitForStatusResult

+ type StackSource struct

+ ID string

+ Stack *Stack

+ StackConfiguration *StackConfiguration

+ UploadURL *string

+ type StackSources interface

+ CreateAndUpload func(ctx context.Context, stackID string, path string) (*StackSource, error)

+ Read func(ctx context.Context, stackSourceID string) (*StackSource, error)

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

+ type WaitForStatusResult struct

+ Error error

+ ID string

+ Quit bool

+ ReadAttempts int

+ Status string

Aug 7, 2024

Changes in this version

type AdminGeneralSetting

+ ApplyTimeout string

+ PlanTimeout string

type AdminGeneralSettingsUpdateOptions

+ ApplyTimeout *string

+ PlanTimeout *string

type AdminOrganization

+ ApplyTimeout string

+ PlanTimeout string

type AdminOrganizationUpdateOptions

+ ApplyTimeout *string

+ PlanTimeout *string

+ type Change struct

+ Actions []ChangeAction

+ After json.RawMessage

+ AfterSensitive json.RawMessage

+ AfterUnknown json.RawMessage

+ Before json.RawMessage

+ BeforeSensitive json.RawMessage

+ Importing *JSONImporting

+ ReplacePaths json.RawMessage

+ type ChangeAction string

type Client

+ StackPlanOperations StackPlanOperations

+ type JSONChangeDesc struct

+ Applyable bool

+ Components []JSONComponent

+ DeferredResourceInstances []JSONResourceInstanceDeferral

+ FormatVersion uint64

+ Interim bool

+ Outputs map[string]JSONOutput

+ PlanMode string

+ ResourceInstances []JSONResourceInstance

+ type JSONComponent struct

+ Actions []ChangeAction

+ Address string

+ Complete bool

+ ComponentAddress string

+ ComponentCorrelator string

+ InstanceCorrelator string

+ type JSONDeferred struct

+ Reason string

+ type JSONImporting struct

+ GeneratedConfig string

+ ID string

+ Unknown bool

+ type JSONOutput struct

+ Change json.RawMessage

+ type JSONResourceInstance struct

+ ActionReason string

+ Address string

+ Change Change

+ ComponentInstanceAddress string

+ ComponentInstanceCorrelator string

+ DeposedKey string

+ Index json.RawMessage

+ IndexUnknown bool

+ ModuleAddr string

+ PreviousAddress string

+ PreviousComponentInstanceAddress string

+ ProviderAddr string

+ ResourceMode string

+ ResourceName string

+ ResourceType string

+ type JSONResourceInstanceDeferral struct

+ Deferred JSONDeferred

+ ResourceInstance JSONResourceInstance

type StackConfigurations

+ JSONSchemas func(ctx context.Context, stackConfigurationID string) ([]byte, error)

type StackPlan

+ StackPlanOperations []*StackPlanOperation

+ type StackPlanOperation struct

+ Diagnostics string

+ EventStreamURL string

+ ID string

+ StackPlan *StackPlan

+ Status string

+ Type string

+ type StackPlanOperations interface

+ DownloadEventStream func(ctx context.Context, stackPlanOperationID string) ([]byte, error)

+ Read func(ctx context.Context, stackPlanOperationID string) (*StackPlanOperation, error)

type StackPlans

+ PlanDescription func(ctx context.Context, stackPlanID string) (*JSONChangeDesc, error)

+ type StackPlansIncludeOpt string

+ const StackPlansIncludeOperations

type StackPlansListOptions

+ Include []StackPlansIncludeOpt

type Team

+ AllowMemberTokenManagement bool

type TeamCreateOptions

+ AllowMemberTokenManagement *bool

type TeamUpdateOptions

+ AllowMemberTokenManagement *bool

Jul 30, 2024

Changes in this version

+ type RegistryNoCodeModuleCreateWorkspaceOptions struct

+ AgentPoolID *string

+ AutoApply *bool

+ Description *string

+ ExecutionMode *string

+ Name string

+ Project *Project

+ SourceName *string

+ SourceURL *string

+ Type string

+ Variables []*Variable

+ type RegistryNoCodeModuleUpgradeWorkspaceOptions struct

+ Type string

+ Variables []*Variable

+ type RegistryNoCodeModuleWorkspace struct

type RegistryNoCodeModules

+ CreateWorkspace func(ctx context.Context, noCodeModuleID string, ...) (*RegistryNoCodeModuleWorkspace, error)

+ UpgradeWorkspace func(ctx context.Context, noCodeModuleID string, workspaceID string, ...) (*RegistryNoCodeModuleWorkspace, error)

type Workspace

+ NoCodeUpgradeAvailable bool

Jul 23, 2024

Changes in this version

type Client

+ StackConfigurations StackConfigurations

+ StackDeployments StackDeployments

+ StackPlans StackPlans

+ type PlanChanges struct

+ Add int

+ Change int

+ Import int

+ Remove int

+ Total int

type Stack

+ LatestStackConfiguration *StackConfiguration

+ type StackComponent struct

+ Correlator string

+ Expanded bool

+ Name string

+ type StackConfiguration struct

+ Components []*StackComponent

+ ConvergedDeployments []string

+ DeploymentNames []string

+ ErrorMessage *string

+ EventStreamURL string

+ ID string

+ SequenceNumber int

+ Status string

+ StatusTimestamps *StackConfigurationStatusTimestamps

+ type StackConfigurationStatusTimestamps struct

+ CanceledAt *time.Time

+ CompletedAt *time.Time

+ EnqueueingAt *time.Time

+ ErroredAt *time.Time

+ PreparingAt *time.Time

+ QueuedAt *time.Time

+ type StackConfigurations interface

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

+ type StackDeployment struct

+ CurrentStackState *StackState

+ DeployedAt time.Time

+ ErrorsCount int

+ ID string

+ Name string

+ PausedCount int

+ Status string

+ WarningsCount int

+ type StackDeployments interface

+ Read func(ctx context.Context, stackID, deployment string) (*StackDeployment, error)

+ type StackPlan struct

+ Changes *PlanChanges

+ Deployment string

+ ID string

+ IsPlanned bool

+ PlanMode string

+ PlanNumber string

+ Stack *Stack

+ StackConfiguration *StackConfiguration

+ Status string

+ StatusTimestamps *StackPlanStatusTimestamps

+ type StackPlanList struct

+ Items []*StackPlan

+ type StackPlanStatusTimestamps struct

+ CreatedAt time.Time

+ FinishedAt time.Time

+ PausedAt time.Time

+ RunningAt time.Time

+ type StackPlans interface

+ Approve func(ctx context.Context, stackPlanID string) error

+ Cancel func(ctx context.Context, stackPlanID string) error

+ Discard func(ctx context.Context, stackPlanID string) error

+ ListByConfiguration func(ctx context.Context, stackConfigurationID string, ...) (*StackPlanList, error)

+ Read func(ctx context.Context, stackPlanID string) (*StackPlan, error)

+ type StackPlansListOptions struct

+ Deployment string

+ Status StackPlansStatusFilter

+ type StackPlansStatusFilter string

+ const StackPlansStatusFilterCanceled

+ const StackPlansStatusFilterCreated

+ const StackPlansStatusFilterDiscarded

+ const StackPlansStatusFilterErrored

+ const StackPlansStatusFilterFinished

+ const StackPlansStatusFilterPaused

+ const StackPlansStatusFilterRunning

+ type StackState struct

+ ID string

type Stacks

+ UpdateConfiguration func(ctx context.Context, stackID string) (*Stack, error)

Jul 9, 2024

Changes in this version

+ var ErrInvalidAccessToken = errors.New("invalid value for access token")

+ var ErrInvalidCallbackURL = errors.New("invalid value for callback URL")

+ var ErrInvalidTaskResultsCallbackStatus = fmt.Errorf("invalid value for task result status. Must be either `%s`, `%s`, or `%s`", ...)

type Client

+ RunTasksIntegration RunTasksIntegration

+ type RunTaskRequest struct

+ AccessToken string

+ Capabilitites RunTaskRequestCapabilitites

+ ConfigurationVersionDownloadURL string

+ ConfigurationVersionID string

+ IsSpeculative bool

+ OrganizationName string

+ PayloadVersion int

+ PlanJSONAPIURL string

+ RunAppURL string

+ RunCreatedAt time.Time

+ RunCreatedBy string

+ RunID string

+ RunMessage string

+ Stage string

+ TaskResultCallbackURL string

+ TaskResultEnforcementLevel string

+ TaskResultID string

+ VcsBranch string

+ VcsCommitURL string

+ VcsPullRequestURL string

+ VcsRepoURL string

+ WorkspaceAppURL string

+ WorkspaceID string

+ WorkspaceName string

+ WorkspaceWorkingDirectory string

+ type RunTaskRequestCapabilitites struct

+ Outcomes bool

+ type RunTasksIntegration interface

+ Callback func(ctx context.Context, callbackURL string, accessToken string, ...) error

+ type TaskResultCallbackRequestOptions struct

+ Message string

+ Outcomes []*TaskResultOutcome

+ Status TaskResultStatus

+ Type string

+ URL string

+ type TaskResultOutcome struct

+ Body string

+ Description string

+ OutcomeID string

+ Tags map[string][]*TaskResultTag

+ Type string

+ URL string

+ type TaskResultTag struct

+ Label string

+ Level string

Jul 2, 2024

Changes in this version

type Client

+ Stacks Stacks

+ type Stack struct

+ CreatedAt time.Time

+ DeploymentNames []string

+ Description string

+ ErrorsCount int

+ ID string

+ Name string

+ Project *Project

+ UpdatedAt time.Time

+ VCSRepo *StackVCSRepo

+ WarningsCount int

+ type StackCreateOptions struct

+ Description *string

+ Name string

+ Project *Project

+ Type string

+ VCSRepo *StackVCSRepo

+ type StackList struct

+ Items []*Stack

+ type StackListOptions struct

+ ProjectID string

+ SearchByName string

+ Sort StackSortColumn

+ type StackSortColumn string

+ const StackSortByName

+ const StackSortByNameDesc

+ const StackSortByUpdatedAt

+ const StackSortByUpdatedAtDesc

+ type StackUpdateOptions struct

+ Description *string

+ Name *string

+ VCSRepo *StackVCSRepo

+ type StackVCSRepo struct

+ Branch string

+ GHAInstallationID string

+ Identifier string

+ OAuthTokenID string

+ type Stacks interface

+ Create func(ctx context.Context, options StackCreateOptions) (*Stack, error)

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

+ List func(ctx context.Context, organization string, options *StackListOptions) (*StackList, error)

+ Read func(ctx context.Context, stackID string) (*Stack, error)

+ Update func(ctx context.Context, stackID string, options StackUpdateOptions) (*Stack, error)

Jun 25, 2024

Changes in this version

type AdminRunsListOptions

+ CreatedAfter string

+ CreatedBefore string

type NotificationTriggerType

+ const NotificationTriggerWorkspaceAutoDestroyReminder

+ const NotificationTriggerWorkspaceAutoDestroyRunResults

type Organization

+ IsUnified bool

type Project

+ IsUnified bool

type Team

+ IsUnified bool

Jun 12, 2024

Changes in this version

type OrganizationAccess

+ ManageAgentPools bool

type OrganizationAccessOptions

+ ManageAgentPools *bool

Jun 5, 2024

Changes in this version

type WorkspaceListOptions

+ CurrentRunStatus string

May 28, 2024

Changes in this version

type User

+ IsAdmin *bool

type Workspace

+ AutoDestroyActivityDuration jsonapi.NullableAttr[string]

type WorkspaceCreateOptions

+ AutoDestroyActivityDuration jsonapi.NullableAttr[string]

type WorkspaceUpdateOptions

+ AutoDestroyActivityDuration jsonapi.NullableAttr[string]

May 7, 2024

Changes in this version

type OrganizationAccess

+ AccessSecretTeams bool

+ ManageOrganizationAccess bool

+ ManageTeams bool

type OrganizationAccessOptions

+ AccessSecretTeams *bool

+ ManageOrganizationAccess *bool

+ ManageTeams *bool

Apr 30, 2024

Changes in this version

+ var ErrConflictingEnforceEnforcementLevel = errors.New("enforce and enforcement-level may not both be specified together")

type Policy

+ EnforcementLevel EnforcementLevel

type PolicyCreateOptions

+ EnforcementLevel *EnforcementLevel

type PolicyUpdateOptions

+ EnforcementLevel *EnforcementLevel

Apr 23, 2024

Changes in this version

type OrganizationMembershipCreateOptions

+ Teams []*Team

Apr 17, 2024

Changes in this version

type Entitlements

+ GlobalRunTasks bool

+ type GlobalRunTask struct

+ Enabled bool

+ EnforcementLevel TaskEnforcementLevel

+ Stages []Stage

+ type GlobalRunTaskOptions struct

+ Enabled *bool

+ EnforcementLevel *TaskEnforcementLevel

+ Stages *[]Stage

type RunTask

+ Global *GlobalRunTask

type RunTaskCreateOptions

+ Global *GlobalRunTaskOptions

type RunTaskUpdateOptions

+ Global *GlobalRunTaskOptions

type ServiceProviderType

+ const ServiceProviderBitbucketDataCenter

type VariableSetListOptions

+ Query string

type WorkspaceRunTask

+ Stages []Stage

type WorkspaceRunTaskCreateOptions

+ Stages *[]Stage

type WorkspaceRunTaskUpdateOptions

+ Stages *[]Stage

Apr 2, 2024

Changes in this version

type Stage

+ const PostApply

Mar 26, 2024

Changes in this version

+ type DataRetentionPolicyChoice struct

+ DataRetentionPolicy *DataRetentionPolicy

+ DataRetentionPolicyDeleteOlder *DataRetentionPolicyDeleteOlder

+ DataRetentionPolicyDontDelete *DataRetentionPolicyDontDelete

+ func (d *DataRetentionPolicyChoice) ConvertToLegacyStruct() *DataRetentionPolicy

+ func (d DataRetentionPolicyChoice) IsPopulated() bool

+ type DataRetentionPolicyDeleteOlder struct

+ DeleteOlderThanNDays int

+ ID string

+ type DataRetentionPolicyDeleteOlderSetOptions struct

+ DeleteOlderThanNDays int

+ Type string

+ type DataRetentionPolicyDontDelete struct

+ ID string

+ type DataRetentionPolicyDontDeleteSetOptions struct

+ Type string

type Organization

+ DataRetentionPolicyChoice *DataRetentionPolicyChoice

type Organizations

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

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

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

type Workspace

+ DataRetentionPolicyChoice *DataRetentionPolicyChoice

+ Variables []*Variable

type Workspaces

+ ReadDataRetentionPolicyChoice func(ctx context.Context, workspaceID string) (*DataRetentionPolicyChoice, error)

+ SetDataRetentionPolicyDeleteOlder func(ctx context.Context, workspaceID string, ...) (*DataRetentionPolicyDeleteOlder, error)

+ SetDataRetentionPolicyDontDelete func(ctx context.Context, workspaceID string, ...) (*DataRetentionPolicyDontDelete, error)

Mar 5, 2024

Changes in this version

type Project

+ Description string

type ProjectCreateOptions

+ Description *string

type ProjectUpdateOptions

+ Description *string

type TestVariables

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

Feb 28, 2024

Changes in this version

type OAuthClient

+ AgentPool *AgentPool

type OAuthClientCreateOptions

+ AgentPool *AgentPool

type ProjectListOptions

+ Query string

type TeamListOptions

+ Query string

type WorkspaceListOptions

+ Sort string

Feb 15, 2024

Changes in this version

type Client

+ func (c Client) AppName() string

type RegistryModuleID

+ func NewPrivateRegistryModuleID(organization, name, provider string) RegistryModuleID

+ func NewPublicRegistryModuleID(organization, namespace, name, provider string) RegistryModuleID

type RegistryModules

+ DeleteByName func(ctx context.Context, module RegistryModuleID) error

Jan 31, 2024

Changes in this version

+ func NullBool() jsonapi.NullableAttr[bool]

+ func NullTime() jsonapi.NullableAttr[time.Time]

+ func NullableBool(v bool) jsonapi.NullableAttr[bool]

+ func NullableTime(v time.Time) jsonapi.NullableAttr[time.Time]

type PolicySet

+ AgentEnabled bool

+ PolicyToolVersion string

type PolicySetCreateOptions

+ AgentEnabled *bool

+ PolicyToolVersion *string

type PolicySetUpdateOptions

+ AgentEnabled *bool

+ PolicyToolVersion *string

type Workspace

+ AutoDestroyAt jsonapi.NullableAttr[time.Time]

type WorkspaceCreateOptions

+ AutoDestroyAt jsonapi.NullableAttr[time.Time]

type WorkspaceUpdateOptions

+ AutoDestroyAt jsonapi.NullableAttr[time.Time]

Jan 23, 2024

Changes in this version

type AdminOrganization

+ GlobalProviderSharing *bool

type AdminOrganizationUpdateOptions

+ GlobalProviderSharing *bool

type Organization

+ AggregatedCommitStatusEnabled bool

type OrganizationCreateOptions

+ AggregatedCommitStatusEnabled *bool

type OrganizationUpdateOptions

+ AggregatedCommitStatusEnabled *bool

Jan 2, 2024

Changes in this version

+ var ErrInvalidOPAVersionID = errors.New("invalid value for OPA version ID")

+ var ErrInvalidSentinelVersionID = errors.New("invalid value for Sentinel version ID")

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

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

type Admin

+ OPAVersions AdminOPAVersions

+ SentinelVersions AdminSentinelVersions

+ type AdminOPAVersion 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 AdminOPAVersionCreateOptions struct

+ Beta *bool

+ Deprecated *bool

+ DeprecatedReason *string

+ Enabled *bool

+ Official *bool

+ SHA string

+ Type string

+ URL string

+ Version string

+ type AdminOPAVersionUpdateOptions struct

+ Beta *bool

+ Deprecated *bool

+ DeprecatedReason *string

+ Enabled *bool

+ Official *bool

+ SHA *string

+ Type string

+ URL *string

+ Version *string

+ type AdminOPAVersions interface

+ Create func(ctx context.Context, options AdminOPAVersionCreateOptions) (*AdminOPAVersion, error)

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

+ List func(ctx context.Context, options *AdminOPAVersionsListOptions) (*AdminOPAVersionsList, error)

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

+ Update func(ctx context.Context, id string, options AdminOPAVersionUpdateOptions) (*AdminOPAVersion, error)

+ type AdminOPAVersionsList struct

+ Items []*AdminOPAVersion

+ type AdminOPAVersionsListOptions struct

+ Filter string

+ Search string

+ type AdminSentinelVersion 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 AdminSentinelVersionCreateOptions struct

+ Beta *bool

+ Deprecated *bool

+ DeprecatedReason *string

+ Enabled *bool

+ Official *bool

+ SHA string

+ Type string

+ URL string

+ Version string

+ type AdminSentinelVersionUpdateOptions struct

+ Beta *bool

+ Deprecated *bool

+ DeprecatedReason *string

+ Enabled *bool

+ Official *bool

+ SHA *string

+ Type string

+ URL *string

+ Version *string

+ type AdminSentinelVersions interface

+ Create func(ctx context.Context, options AdminSentinelVersionCreateOptions) (*AdminSentinelVersion, error)

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

+ List func(ctx context.Context, options *AdminSentinelVersionsListOptions) (*AdminSentinelVersionsList, error)

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

+ Update func(ctx context.Context, id string, options AdminSentinelVersionUpdateOptions) (*AdminSentinelVersion, error)

+ type AdminSentinelVersionsList struct

+ Items []*AdminSentinelVersion

+ type AdminSentinelVersionsListOptions struct

+ Filter string

+ Search string

+ type CreatedByChoice struct

+ Organization *Organization

+ Team *Team

+ User *User

+ type LockedByChoice struct

+ Run *Run

+ Team *Team

+ User *User

type OrganizationToken

+ CreatedBy *CreatedByChoice

type PolicyResult

+ Sentinel any

type RunTrigger

+ SourceableChoice *SourceableChoice

+ type SourceableChoice struct

+ Workspace *Workspace

type TeamToken

+ CreatedBy *CreatedByChoice

type UserToken

+ CreatedBy *CreatedByChoice

type Workspace

+ LockedBy *LockedByChoice

Dec 6, 2023

Changes in this version

+ type DataRetentionPolicy struct

+ DeleteOlderThanNDays int

+ ID string

+ type DataRetentionPolicySetOptions struct

+ DeleteOlderThanNDays int

+ Type string

type Organization

+ DataRetentionPolicy *DataRetentionPolicy

type Organizations

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

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

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

type Workspace

+ DataRetentionPolicy *DataRetentionPolicy

type Workspaces

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

+ ReadDataRetentionPolicy func(ctx context.Context, workspaceID string) (*DataRetentionPolicy, error)

+ SetDataRetentionPolicy func(ctx context.Context, workspaceID string, options DataRetentionPolicySetOptions) (*DataRetentionPolicy, error)

Nov 22, 2023

Changes in this version

type Client

+ WorkspaceResources WorkspaceResources

type OAuthClient

+ OrganizationScoped bool

+ Projects []*Project

+ type OAuthClientAddProjectsOptions struct

+ Projects []*Project

type OAuthClientCreateOptions

+ OrganizationScoped *bool

+ Projects []*Project

type OAuthClientIncludeOpt

+ const OauthClientProjects

+ type OAuthClientReadOptions struct

+ Include []OAuthClientIncludeOpt

+ type OAuthClientRemoveProjectsOptions struct

+ Projects []*Project

type OAuthClientUpdateOptions

+ OrganizationScoped *bool

type OAuthClients

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

+ ReadWithOptions func(ctx context.Context, oAuthClientID string, options *OAuthClientReadOptions) (*OAuthClient, error)

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

+ type WorkspaceResource struct

+ Address string

+ CreatedAt string

+ ID string

+ ModifiedByStateVersionID string

+ Module string

+ Name string

+ NameIndex *string

+ Provider string

+ ProviderType string

+ UpdatedAt string

+ type WorkspaceResourceListOptions struct

+ type WorkspaceResources interface

+ List func(ctx context.Context, workspaceID string, options *WorkspaceResourceListOptions) (*WorkspaceResourcesList, error)

+ type WorkspaceResourcesList struct

+ Items []*WorkspaceResource

Nov 7, 2023

Changes in this version

+ var ErrBranchMustBeEmptyWhenTagsEnabled = errors.New("VCS branch must be empty to enable tags")

type ConfigurationVersions

+ PermanentlyDeleteBackingData func(ctx context.Context, svID string) error

+ RestoreBackingData func(ctx context.Context, svID string) error

+ SoftDeleteBackingData func(ctx context.Context, svID string) error

type Organization

+ DefaultAgentPool *AgentPool

+ DefaultExecutionMode string

type OrganizationCreateOptions

+ DefaultExecutionMode *string

type OrganizationUpdateOptions

+ DefaultAgentPool *AgentPool

+ DefaultExecutionMode *string

type RegistryModuleVCSRepoOptions

+ Tags *bool

type StateVersions

+ PermanentlyDeleteBackingData func(ctx context.Context, svID string) error

+ RestoreBackingData func(ctx context.Context, svID string) error

+ SoftDeleteBackingData func(ctx context.Context, svID string) error

type Workspace

+ AutoApplyRunTrigger bool

+ SettingOverwrites *WorkspaceSettingOverwrites

type WorkspaceCreateOptions

+ AutoApplyRunTrigger *bool

+ SettingOverwrites *WorkspaceSettingOverwritesOptions

+ type WorkspaceSettingOverwrites struct

+ AgentPool *bool

+ ExecutionMode *bool

+ type WorkspaceSettingOverwritesOptions struct

+ AgentPool *bool

+ ExecutionMode *bool

type WorkspaceUpdateOptions

+ AutoApplyRunTrigger *bool

+ SettingOverwrites *WorkspaceSettingOverwritesOptions

Oct 30, 2023

Changes in this version

type VariableSet

+ Priority bool

type VariableSetCreateOptions

+ Priority *bool

type VariableSetUpdateOptions

+ Priority *bool

Oct 23, 2023

Changes in this version

type VCSRepo

+ Tags bool

Oct 12, 2023

Changes in this version

type Client

+ TestVariables TestVariables

type Organization

+ RemainingTestableCount int

+ type TestVariables interface

+ Create func(ctx context.Context, moduleID RegistryModuleID, options VariableCreateOptions) (*Variable, error)

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

+ List func(ctx context.Context, moduleID RegistryModuleID, options *VariableListOptions) (*VariableList, error)

+ Update func(ctx context.Context, moduleID RegistryModuleID, variableID string, ...) (*Variable, error)

Oct 9, 2023

Changes in this version

+ var ErrRequiredBranchWhenTestsEnabled = errors.New("VCS branch is required when enabling tests")

+ type PublishingMechanism string

+ const PublishingMechanismBranch

+ const PublishingMechanismTag

type RegistryModule

+ PublishingMechanism PublishingMechanism

+ TestConfig *TestConfig

type RegistryModuleCreateWithVCSConnectionOptions

+ TestConfig *RegistryModuleTestConfigOptions

+ type RegistryModuleTestConfigOptions struct

+ TestsEnabled *bool

type RegistryModuleUpdateOptions

+ TestConfig *RegistryModuleTestConfigOptions

+ VCSRepo *RegistryModuleVCSRepoUpdateOptions

+ type RegistryModuleVCSRepoUpdateOptions struct

+ Branch *string

+ Tags *string

+ type TestConfig struct

+ TestsEnabled bool

type VariableSet

+ Enforced bool

type VariableSetCreateOptions

+ Enforced *bool

type VariableSetUpdateOptions

+ Enforced *bool

Sep 11, 2023

Changes in this version

+ var ErrInvalidTestRunID = errors.New("invalid value for test run id")

type Client

+ TestRuns TestRuns

type ConfigurationVersions

+ CreateForRegistryModule func(ctx context.Context, moduleID RegistryModuleID) (*ConfigurationVersion, error)

type RegistryModuleCreateWithVCSConnectionOptions

+ InitialVersion *string

type RegistryModuleVCSRepoOptions

+ Branch *string

+ type TestRun struct

+ ConfigurationVersion *ConfigurationVersion

+ ID string

+ LogReadURL string

+ RegistryModule *RegistryModule

+ Status TestRunStatus

+ StatusTimestamps TestRunStatusTimestamps

+ TestStatus TestStatus

+ TestsErrored int

+ TestsFailed int

+ TestsPassed int

+ TestsSkipped int

+ type TestRunCreateOptions struct

+ ConfigurationVersion *ConfigurationVersion

+ Filters []string

+ RegistryModule *RegistryModule

+ TestDirectory *string

+ Type string

+ Variables []*RunVariable

+ Verbose *bool

+ type TestRunList struct

+ Items []*TestRun

+ type TestRunListOptions struct

+ type TestRunStatus string

+ const TestRunCanceled

+ const TestRunErrored

+ const TestRunFinished

+ const TestRunPending

+ const TestRunQueued

+ const TestRunRunning

+ type TestRunStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ ForceCanceledAt time.Time

+ QueuedAt time.Time

+ StartedAt time.Time

+ type TestRuns interface

+ Cancel func(ctx context.Context, moduleID RegistryModuleID, testRunID string) error

+ Create func(ctx context.Context, options TestRunCreateOptions) (*TestRun, error)

+ ForceCancel func(ctx context.Context, moduleID RegistryModuleID, testRunID string) error

+ List func(ctx context.Context, moduleID RegistryModuleID, options *TestRunListOptions) (*TestRunList, error)

+ Logs func(ctx context.Context, moduleID RegistryModuleID, testRunID string) (io.Reader, error)

+ Read func(ctx context.Context, moduleID RegistryModuleID, testRunID string) (*TestRun, error)

+ type TestStatus string

+ const TestError

+ const TestFail

+ const TestPass

+ const TestPending

+ const TestSkip

Sep 5, 2023

Changes in this version

type PolicySet

+ WorkspaceExclusions []*Workspace

+ type PolicySetAddWorkspaceExclusionsOptions struct

+ WorkspaceExclusions []*Workspace

type PolicySetCreateOptions

+ WorkspaceExclusions []*Workspace

type PolicySetIncludeOpt

+ const PolicySetWorkspaceExclusions

+ type PolicySetRemoveWorkspaceExclusionsOptions struct

+ WorkspaceExclusions []*Workspace

type PolicySets

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

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

Aug 18, 2023

Changes in this version

+ type Commit struct

+ Author string

+ AuthorAvatarURL string

+ AuthorHTMLURL string

+ Date string

+ ID string

+ Message string

+ Sha string

+ URL string

+ type CommitList struct

+ Items []*Commit

type RegistryModuleCreateVersionOptions

+ CommitSHA *string

type RegistryModules

+ ListCommits func(ctx context.Context, moduleID RegistryModuleID) (*CommitList, error)

+ ReadVersion func(ctx context.Context, moduleID RegistryModuleID, version string) (*RegistryModuleVersion, error)

Aug 7, 2023

Changes in this version

type ConfigurationVersion

+ Provisional bool

type ConfigurationVersionCreateOptions

+ Provisional *bool

+ type ProjectSettingsPermissionType string

+ const ProjectSettingsPermissionDelete

+ const ProjectSettingsPermissionRead

+ const ProjectSettingsPermissionUpdate

+ func ProjectSettingsPermission(v ProjectSettingsPermissionType) *ProjectSettingsPermissionType

+ type ProjectTeamsPermissionType string

+ const ProjectTeamsPermissionManage

+ const ProjectTeamsPermissionNone

+ const ProjectTeamsPermissionRead

+ func ProjectTeamsPermission(v ProjectTeamsPermissionType) *ProjectTeamsPermissionType

type TeamProjectAccess

+ ProjectAccess *TeamProjectAccessProjectPermissions

+ WorkspaceAccess *TeamProjectAccessWorkspacePermissions

type TeamProjectAccessAddOptions

+ ProjectAccess *TeamProjectAccessProjectPermissionsOptions

+ WorkspaceAccess *TeamProjectAccessWorkspacePermissionsOptions

+ type TeamProjectAccessProjectPermissions struct

+ ProjectSettingsPermission ProjectSettingsPermissionType

+ ProjectTeamsPermission ProjectTeamsPermissionType

+ type TeamProjectAccessProjectPermissionsOptions struct

+ Settings *ProjectSettingsPermissionType

+ Teams *ProjectTeamsPermissionType

type TeamProjectAccessType

+ const TeamProjectAccessCustom

type TeamProjectAccessUpdateOptions

+ ProjectAccess *TeamProjectAccessProjectPermissionsOptions

+ WorkspaceAccess *TeamProjectAccessWorkspacePermissionsOptions

+ type TeamProjectAccessWorkspacePermissions struct

+ WorkspaceCreatePermission bool

+ WorkspaceDeletePermission bool

+ WorkspaceLockingPermission bool

+ WorkspaceMovePermission bool

+ WorkspaceRunTasksPermission bool

+ WorkspaceRunsPermission WorkspaceRunsPermissionType

+ WorkspaceSentinelMocksPermission WorkspaceSentinelMocksPermissionType

+ WorkspaceStateVersionsPermission WorkspaceStateVersionsPermissionType

+ WorkspaceVariablesPermission WorkspaceVariablesPermissionType

+ type TeamProjectAccessWorkspacePermissionsOptions struct

+ Create *bool

+ Delete *bool

+ Locking *bool

+ Move *bool

+ RunTasks *bool

+ Runs *WorkspaceRunsPermissionType

+ SentinelMocks *WorkspaceSentinelMocksPermissionType

+ StateVersions *WorkspaceStateVersionsPermissionType

+ Variables *WorkspaceVariablesPermissionType

type Workspace

+ CurrentConfigurationVersion *ConfigurationVersion

+ type WorkspaceRunsPermissionType string

+ const WorkspaceRunsPermissionApply

+ const WorkspaceRunsPermissionPlan

+ const WorkspaceRunsPermissionRead

+ func WorkspaceRunsPermission(v WorkspaceRunsPermissionType) *WorkspaceRunsPermissionType

+ type WorkspaceSentinelMocksPermissionType string

+ const WorkspaceSentinelMocksPermissionNone

+ const WorkspaceSentinelMocksPermissionRead

+ func WorkspaceSentinelMocksPermission(v WorkspaceSentinelMocksPermissionType) *WorkspaceSentinelMocksPermissionType

+ type WorkspaceStateVersionsPermissionType string

+ const WorkspaceStateVersionsPermissionNone

+ const WorkspaceStateVersionsPermissionRead

+ const WorkspaceStateVersionsPermissionReadOutputs

+ const WorkspaceStateVersionsPermissionWrite

+ func WorkspaceStateVersionsPermission(v WorkspaceStateVersionsPermissionType) *WorkspaceStateVersionsPermissionType

+ type WorkspaceVariablesPermissionType string

+ const WorkspaceVariablesPermissionNone

+ const WorkspaceVariablesPermissionRead

+ const WorkspaceVariablesPermissionWrite

+ func WorkspaceVariablesPermission(v WorkspaceVariablesPermissionType) *WorkspaceVariablesPermissionType

Jul 21, 2023

Changes in this version

+ var ErrProjectMinLimit = errors.New("must provide at least one project")

type PolicySet

+ ProjectCount int

+ Projects []*Project

+ type PolicySetAddProjectsOptions struct

+ Projects []*Project

type PolicySetCreateOptions

+ Projects []*Project

type PolicySetIncludeOpt

+ const PolicySetProjects

+ type PolicySetRemoveProjectsOptions struct

+ Projects []*Project

type PolicySets

+ AddProjects func(ctx context.Context, policySetID string, options PolicySetAddProjectsOptions) error

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

Jul 13, 2023

Changes in this version

type AdminSAMLSetting

+ SignatureDigestMethod string

+ SignatureSigningMethod string

type AdminSAMLSettingsUpdateOptions

+ AuthnRequestsSigned *bool

+ Certificate *string

+ PrivateKey *string

+ SignatureDigestMethod *string

+ SignatureSigningMethod *string

+ TeamManagementEnabled *bool

+ WantAssertionsSigned *bool

Jun 28, 2023

Changes in this version

type Run

+ SavePlan bool

type RunCreateOptions

+ SavePlan *bool

type RunOperation

+ const RunOperationSavePlan

type RunStatus

+ const RunPlannedAndSaved

+ const RunPreApplyCompleted

type RunStatusTimestamps

+ PlannedAndSavedAt time.Time

Jun 20, 2023

Changes in this version

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

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

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

type ClientRequest

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

type OrganizationTagsListOptions

+ Query string

type StateVersion

+ JSONDownloadURL string

+ JSONUploadURL string

+ Status StateVersionStatus

+ UploadURL string

+ type StateVersionStatus string

+ const StateVersionDiscarded

+ const StateVersionFinalized

+ const StateVersionPending

+ type StateVersionUploadOptions struct

+ RawJSONState []byte

+ RawState []byte

type StateVersions

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

type WSIncludeOpt

+ const WSProject

Jun 9, 2023

Changes in this version

+ type AgentPoolAllowedWorkspacesUpdateOptions struct

+ AllowedWorkspaces []*Workspace

+ Type string

type AgentPools

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

type RunStatus

+ const RunPreApplyRunning

+ const RunQueuingApply

May 30, 2023

Changes in this version

type Apply

+ ResourceImports int

type Plan

+ GeneratedConfiguration bool

+ ResourceImports int

type Run

+ AllowConfigGeneration *bool

type RunCreateOptions

+ AllowConfigGeneration *bool

May 23, 2023

Changes in this version

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

May 22, 2023

Changes in this version

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

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

May 15, 2023

Changes in this version

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

type OrganizationToken

+ ExpiredAt time.Time

+ type OrganizationTokenCreateOptions struct

+ ExpiredAt *time.Time

type OrganizationTokens

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

type TeamToken

+ ExpiredAt time.Time

+ type TeamTokenCreateOptions struct

+ ExpiredAt *time.Time

type TeamTokens

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

type UserToken

+ ExpiredAt time.Time

type UserTokenCreateOptions

+ ExpiredAt *time.Time

type Variable

+ VersionID string

type VariableSetVariable

+ VersionID string

Apr 28, 2023

Changes in this version

type AgentPoolCreateOptions

+ AllowedWorkspaces []*Workspace

+ OrganizationScoped *bool

type AgentPoolListOptions

+ AllowedWorkspacesName string

Apr 17, 2023

Changes in this version

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

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

type Client

+ RegistryNoCodeModules RegistryNoCodeModules

+ type NoCodeVariableOption struct

+ Options []string

+ Type string

+ VariableName string

+ VariableType string

+ 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)

Apr 11, 2023

Changes in this version

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

type AdminSettings

+ OIDC OIDCSettings

type Client

+ RunEvents RunEvents

+ func (c Client) IsCloud() bool

+ func (c Client) IsEnterprise() bool

+ type OIDCSettings interface

+ RotateKey func(ctx context.Context) error

+ TrimKey func(ctx context.Context) error

type OrganizationAccess

+ ManageMembership bool

type OrganizationAccessOptions

+ ManageMembership *bool

type ProjectListOptions

+ Name string

+ 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 User

+ IsSiteAdmin *bool

+ IsSsoLogin *bool

+ Permissions *UserPermissions

+ type UserPermissions struct

+ CanChangeEmail bool

+ CanChangeUsername bool

+ CanCreateOrganizations bool

+ CanManageHcpAccount bool

+ CanManageUserTokens bool

+ CanView2FaSettings bool

type VariableSet

+ Projects []*Project

+ type VariableSetApplyToProjectsOptions struct

+ Projects []*Project

type VariableSetIncludeOpt

+ const VariableSetProjects

+ type VariableSetRemoveFromProjectsOptions struct

+ Projects []*Project

type VariableSets

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

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

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

type WorkspaceListOptions

+ ProjectID string

Mar 21, 2023

Changes in this version

type TeamProjectAccessType

+ const TeamProjectAccessMaintain

+ const TeamProjectAccessWrite

Mar 9, 2023

Changes in this version

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

type AdminWorkspaceListOptions

+ Filter string

+ Sort string

type Client

+ GHAInstallations GHAInstallations

+ 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 RegistryModuleVCSRepoOptions

+ GHAInstallationID *string

+ OrganizationName *string

type VCSRepo

+ GHAInstallationID string

type VCSRepoOptions

+ GHAInstallationID *string

Feb 7, 2023

Changes in this version

type Client

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

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

type OrganizationAccess

+ ReadProjects bool

+ ReadWorkspaces bool

type OrganizationAccessOptions

+ ReadProjects *bool

+ ReadWorkspaces *bool

Jan 12, 2023

Changes in this version

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

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

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

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

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

type AgentPool

+ AgentCount int

type Client

+ TeamProjectAccess TeamProjectAccesses

type ConfigurationVersions

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

type OrganizationAccess

+ ManageProjects bool

type OrganizationAccessOptions

+ ManageProjects *bool

type RegistryModules

+ UploadTarGzip func(ctx context.Context, url string, r io.Reader) 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 TeamProjectAccessRead

+ 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 Workspace

+ Links map[string]interface{}

Dec 8, 2022

Changes in this version

+ type GPGKeyList struct

+ Items []*GPGKey

+ type GPGKeyListOptions struct

+ Namespaces []string

type GPGKeys

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

type RegistryProviderPlatform

+ ProviderBinaryUploaded bool

Dec 5, 2022

Changes in this version

+ const ContentTypeJSONAPI

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

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

type Client

+ Projects Projects

type Organization

+ DefaultProject *Project

+ type OrganizationIncludeOpt string

+ const OrganizationDefaultProject

+ type OrganizationReadOptions struct

+ Include []OrganizationIncludeOpt

type Organizations

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

+ type Project struct

+ ID string

+ Name string

+ Organization *Organization

+ type ProjectCreateOptions struct

+ Name string

+ Type string

+ type ProjectList struct

+ Items []*Project

+ type ProjectListOptions struct

+ 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 Workspace

+ Project *Project

type WorkspaceCreateOptions

+ Project *Project

type WorkspaceUpdateOptions

+ Project *Project

Nov 28, 2022

Changes in this version

type PolicySetUpdateOptions

+ Overridable *bool

type TaskStageStatus

+ const TaskStageCanceled

+ const TaskStageErrored

+ const TaskStageUnreachable

Nov 15, 2022

Changes in this version

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

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

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

+ type Actions struct

+ IsOverridable *bool

+ type AuditTrailPagination struct

+ CurrentPage int

+ NextPage int

+ PreviousPage int

+ TotalCount int

+ TotalPages int

type Client

+ PolicyEvaluations PolicyEvaluations

+ PolicySetOutcomes PolicySetOutcomes

+ func (c *Client) NewRequestWithAdditionalQueryParams(method, path string, reqAttr interface{}, ...) (*ClientRequest, error)

type EnforcementLevel

+ const EnforcementMandatory

+ type Outcome struct

+ Description string

+ EnforcementLevel EnforcementLevel

+ PolicyName string

+ Query string

+ Status string

+ type Permissions struct

+ CanOverride *bool

+ CanOverridePolicy *bool

+ CanOverrideTasks *bool

type Policy

+ Kind PolicyKind

+ Query *string

+ type PolicyAttachable struct

+ ID string

+ Type string

type PolicyCreateOptions

+ Kind PolicyKind

+ Query *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 PolicyListOptions

+ Kind PolicyKind

+ type PolicyResultCount struct

+ AdvisoryFailed int

+ Errored int

+ MandatoryFailed int

+ Passed int

+ 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 PolicyUpdateOptions

+ Query *string

type RegistryModule

+ NoCode bool

type RegistryModuleCreateOptions

+ NoCode bool

+ type RegistryModuleUpdateOptions struct

+ NoCode *bool

+ Type string

type RegistryModules

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

type RunStatus

+ const RunPostPlanAwaitingDecision

type TaskResultStatus

+ const TaskErrored

type TaskStage

+ Actions *Actions

+ Permissions *Permissions

+ PolicyEvaluations []*PolicyEvaluation

+ Status TaskStageStatus

type TaskStageIncludeOpt

+ const PolicyEvaluationsTaskResults

+ type TaskStageOverrideOptions struct

+ Comment *string

+ type TaskStageStatus string

+ const TaskStageAwaitingOverride

+ const TaskStageFailed

+ const TaskStagePassed

+ const TaskStagePending

+ const TaskStageRunning

type TaskStages

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

Nov 2, 2022

Changes in this version

type Client

+ func (c *Client) RemoteTFEVersion() string

type NotificationTriggerType

+ const NotificationTriggerAssessmentCheckFailed

type Organization

+ AllowForceDeleteWorkspaces bool

type OrganizationCreateOptions

+ AllowForceDeleteWorkspaces *bool

type OrganizationUpdateOptions

+ AllowForceDeleteWorkspaces *bool

+ type PolicyKind string

+ const OPA

+ const Sentinel

type PolicySet

+ Kind PolicyKind

+ Overridable *bool

type PolicySetCreateOptions

+ Kind PolicyKind

+ Overridable *bool

type PolicySetListOptions

+ Kind PolicyKind

type Runs

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

type WorkspaceListOptions

+ WildcardName string

type WorkspacePermissions

+ CanForceDelete *bool

type Workspaces

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

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

Oct 17, 2022

Changes in this version

type NotificationTriggerType

+ const NotificationTriggerAssessmentDrifted

+ const NotificationTriggerAssessmentFailed

type OrganizationMembershipListOptions

+ Query string

+ Status OrganizationMembershipStatus

+ type RunVariableAttr struct

+ Key string

+ Value string

type VariableSets

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

Sep 14, 2022

Changes in this version

type Organization

+ AssessmentsEnforced bool

type OrganizationCreateOptions

+ AssessmentsEnforced *bool

type OrganizationListOptions

+ Query string

type OrganizationUpdateOptions

+ AssessmentsEnforced *bool

type Stage

+ const PreApply

type Workspace

+ AssessmentsEnabled bool

type WorkspaceCreateOptions

+ AssessmentsEnabled *bool

type WorkspaceUpdateOptions

+ AssessmentsEnabled *bool

Aug 30, 2022

Changes in this version

type RunListOptions

+ Search string

+ User string

type StateVersionCreateOptions

+ JSONState *string

Aug 16, 2022

Changes in this version

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

+ 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 Agents interface

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

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

type Client

+ Agents Agents

type PolicySetListOptions

+ Include []PolicySetIncludeOpt

Aug 10, 2022

Changes in this version

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

+ type ProviderData struct

+ NullResource int

+ TerraformRemoteState int

type Run

+ AllowEmptyApply bool

+ PlanOnly bool

+ TerraformVersion string

type RunCreateOptions

+ AllowEmptyApply *bool

+ PlanOnly *bool

+ TerraformVersion *string

type RunStatus

+ const RunFetchingCompleted

+ const RunPrePlanCompleted

+ const RunPrePlanRunning

+ const RunQueuing

type RunStatusTimestamps

+ PostPlanCompletedAt time.Time

+ PostPlanRunningAt time.Time

+ PrePlanCompletedAt time.Time

+ PrePlanRunningAt time.Time

+ QueuingAt time.Time

type Stage

+ const PrePlan

type StateVersion

+ Modules *StateVersionModules

+ Providers *StateVersionProviders

+ Resources []*StateVersionResources

+ ResourcesProcessed bool

+ StateVersion int

+ TerraformVersion string

+ type StateVersionModuleRoot struct

+ NullResource int

+ TerraformRemoteState int

+ type StateVersionModules struct

+ Root StateVersionModuleRoot

+ type StateVersionProviders struct

+ Data ProviderData

+ type StateVersionResources struct

+ Count string

+ Module string

+ Name string

+ Provider string

+ Type int

type WorkspaceRunTask

+ Stage Stage

type WorkspaceRunTaskCreateOptions

+ Stage *Stage

type WorkspaceRunTaskUpdateOptions

+ Stage *Stage

Jul 25, 2022

Changes in this version

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

type ConfigurationSource

+ const ConfigurationSourceAdo

type OAuthClient

+ Name *string

type RegistryModuleCreateOptions

+ Namespace string

+ RegistryName RegistryName

type RunTask

+ Description string

type RunTaskCreateOptions

+ Description *string

type RunTaskUpdateOptions

+ Description *string

type StateVersionOutput

+ DetailedType interface{}

Jul 14, 2022

Changes in this version

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

+ 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`)

type AgentPool

+ AllowedWorkspaces []*Workspace

+ OrganizationScoped bool

type AgentPoolListOptions

+ Query string

type AgentPoolUpdateOptions

+ AllowedWorkspaces []*Workspace

+ OrganizationScoped *bool

type RegistryModule

+ Namespace string

+ RegistryName RegistryName

type RegistryModuleID

+ Namespace string

+ RegistryName RegistryName

type VCSRepo

+ TagsRegex string

type VCSRepoOptions

+ TagsRegex *string

Jul 6, 2022

Changes in this version

+ const DefaultRegistryPath

+ var ErrInvalidAsciiArmor = errors.New("ascii armor is invalid")

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

type AdminOrganization

+ WorkspaceLimit *int

type AdminOrganizationUpdateOptions

+ WorkspaceLimit *int

type Client

+ GPGKeys GPGKeys

+ func (c *Client) NewRequest(method, path string, reqAttr interface{}) (*ClientRequest, error)

+ type ClientRequest struct

+ Header http.Header

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

type Config

+ RegistryBasePath string

+ RetryServerErrors bool

+ 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 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

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

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

type RunListOptions

+ Commit string

+ Name string

+ Operation string

+ Source string

+ Status string

+ type RunOperation string

+ const RunOperationDestroy

+ const RunOperationEmptyApply

+ const RunOperationPlanApply

+ const RunOperationPlanOnly

+ const RunOperationRefreshOnly

type StateVersionCreateOptions

+ JSONStateOutputs *string

type WorkspaceListOptions

+ ExcludeTags string

Jun 10, 2022

Changes in this version

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

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

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

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

+ var ErrInvalidRegistryName = errors.New("invalid value for registry-name")

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

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

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

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

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

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

+ 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 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 Client

+ AuditTrails AuditTrails

+ RegistryProviderPlatforms RegistryProviderPlatforms

+ RegistryProviderVersions RegistryProviderVersions

+ RegistryProviders RegistryProviders

type NotificationDestinationType

+ const NotificationDestinationTypeMicrosoftTeams

+ type RegistryModuleList struct

+ Items []*RegistryModule

+ type RegistryModuleListOptions struct

type RegistryModules

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

+ type RegistryName string

+ const PrivateRegistry

+ const PublicRegistry

+ 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

+ 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 StateVersionCreateOptions

+ ExtState json.RawMessage

type VCSRepo

+ WebhookURL string

type Workspace

+ TriggerPatterns []string

type WorkspaceCreateOptions

+ TriggerPatterns []string

type WorkspaceUpdateOptions

+ TriggerPatterns []string

May 5, 2022

Changes in this version

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

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

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

type Entitlements

+ RunTasks bool

type OrganizationAccess

+ ManageRunTasks bool

type OrganizationAccessOptions

+ ManageRunTasks *bool

type OrganizationMembershipListOptions

+ Emails []string

type OrganizationPermissions

+ CanManageRunTasks bool

type RunTask

+ Enabled bool

type RunTaskCreateOptions

+ Enabled *bool

type RunTaskUpdateOptions

+ Enabled *bool

type StateVersionOutputs

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

type TeamAccess

+ RunTasks bool

type TeamAccessAddOptions

+ RunTasks *bool

type TeamAccessUpdateOptions

+ RunTasks *bool

type TeamListOptions

+ Names []string

+ type VariableSetApplyToWorkspacesOptions struct

+ Workspaces []*Workspace

+ type VariableSetRemoveFromWorkspacesOptions struct

+ Workspaces []*Workspace

type VariableSets

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

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

type WorkspacePermissions

+ CanManageRunTasks bool

Mar 25, 2022

Changes in this version

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

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

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

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

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

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

type Client

+ Comments Comments

+ VariableSetVariables VariableSetVariables

+ VariableSets VariableSets

+ 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 Run

+ Comments []*Comment

type Team

+ SSOTeamID *string

type TeamCreateOptions

+ SSOTeamID *string

type TeamUpdateOptions

+ SSOTeamID *string

+ type VariableSet struct

+ Description string

+ Global bool

+ ID string

+ Name string

+ Organization *Organization

+ Variables []*VariableSetVariable

+ Workspaces []*Workspace

+ type VariableSetCreateOptions struct

+ Description *string

+ Global *bool

+ Name *string

+ Type string

+ type VariableSetIncludeOpt string

+ const VariableSetVars

+ const VariableSetWorkspaces

+ type VariableSetList struct

+ Items []*VariableSet

+ type VariableSetListOptions struct

+ Include string

+ type VariableSetReadOptions struct

+ Include *[]VariableSetIncludeOpt

+ 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

+ 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

+ 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)

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

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

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

Mar 17, 2022

Changes in this version

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

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

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

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

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

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

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

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

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

+ 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 ErrInvalidPolicyID = errors.New("invalid value for policy ID")

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

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

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

+ 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 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 ErrInvalidTeamID = errors.New("invalid value for team ID")

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

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

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

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

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

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

+ 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 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 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 ErrRequiredOauthToken = errors.New("OAuth token is required")

+ var ErrRequiredOauthTokenID = errors.New("oauth token 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 ErrRequiredProvider = errors.New("provider 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 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 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 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`)

+ type AdminOrgIncludeOpt string

+ const AdminOrgOwners

+ type AdminRunIncludeOpt string

+ const AdminRunWorkspace

+ const AdminRunWorkspaceOrg

+ const AdminRunWorkspaceOrgOwners

+ type AdminUserIncludeOpt string

+ const AdminUserOrgs

+ type AdminWorkspaceIncludeOpt string

+ const AdminWorkspaceCurrentRun

+ const AdminWorkspaceOrg

+ const AdminWorkspaceOrgOwners

type AgentPool

+ Workspaces []*Workspace

+ type AgentPoolIncludeOpt string

+ const AgentPoolWorkspaces

type AgentPoolListOptions

+ Include []AgentPoolIncludeOpt

+ type AgentPoolReadOptions struct

+ Include []AgentPoolIncludeOpt

type AgentPools

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

+ type AgentTokenCreateOptions struct

+ Description *string

+ Type string

type AgentTokens

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

type CVStatusTimestamps

+ ArchivedAt time.Time

+ FetchingAt time.Time

+ type ConfigVerIncludeOpt string

+ const ConfigVerIngressAttributes

+ const ConfigVerRun

type ConfigurationStatus

+ const ConfigurationArchived

+ const ConfigurationFetching

type ConfigurationVersions

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

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

+ type NotificationTriggerType string

+ type OAuthClientIncludeOpt string

+ const OauthClientOauthTokens

type OAuthClientListOptions

+ Include []OAuthClientIncludeOpt

+ type OrgMembershipIncludeOpt string

+ const OrgMembershipTeam

+ const OrgMembershipUser

type OrganizationTokens

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

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)

type Plans

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

+ type PolicyCheckIncludeOpt string

+ const PolicyCheckRun

+ const PolicyCheckRunWorkspace

type PolicyCheckListOptions

+ Include []PolicyCheckIncludeOpt

+ type PolicySetIncludeOpt string

+ const PolicySetCurrentVersion

+ const PolicySetNewestVersion

+ const PolicySetPolicies

+ const PolicySetWorkspaces

+ type ReadRunQueueOptions struct

type RegistryModuleCreateWithVCSConnectionOptions

+ Type string

+ type RegistryModuleID struct

+ Name string

+ Organization string

+ Provider string

+ type RunIncludeOpt string

+ const RunApply

+ const RunConfigVer

+ const RunConfigVerIngress

+ const RunCostEstimate

+ const RunCreatedBy

+ const RunPlan

+ const RunTaskStages

+ const RunWorkspace

type RunStatus

+ const RunFetching

type RunStatusTimestamps

+ FetchedAt time.Time

+ FetchingAt time.Time

+ type RunTaskIncludeOpt string

+ type RunTriggerFilterOp string

+ const RunTriggerInbound

+ const RunTriggerOutbound

+ type RunTriggerIncludeOpt string

+ const RunTriggerSourceable

+ const RunTriggerWorkspace

type RunTriggerListOptions

+ Include []RunTriggerIncludeOpt

+ type StateVersionIncludeOpt string

+ const SVcreatedby

+ const SVoutputs

+ const SVrun

+ const SVrunConfigurationVersion

+ const SVrunCreatedBy

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)

+ type TaskStageIncludeOpt string

+ type TeamIncludeOpt string

+ const TeamOrganizationMemberships

+ const TeamUsers

type TeamTokens

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

+ type UserTokenCreateOptions struct

+ Description string

type UserTokens

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

type Users

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

+ type WSIncludeOpt string

+ const WSCurrentConfigVer

+ const WSCurrentConfigVerIngress

+ const WSCurrentRun

+ const WSCurrentRunConfigVer

+ const WSCurrentRunPlan

+ const WSCurrentStateVer

+ const WSCurrentrunConfigVerIngress

+ const WSLockedBy

+ const WSOrganization

+ const WSOutputs

+ const WSReadme

type Workspaces

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

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

Feb 16, 2022

Changes in this version

+ const Advisory

+ const Mandatory

+ const TaskFailed

+ const TaskPassed

+ const TaskPending

+ const TaskRunning

+ const TaskUnreachable

+ 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 ErrInvalidTaskResultID = errors.New("invalid value for task result ID")

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

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

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

type Client

+ RunTasks RunTasks

+ TaskResults TaskResults

+ TaskStages TaskStages

+ WorkspaceRunTasks WorkspaceRunTasks

type Run

+ TaskStages []*TaskStage

type RunStatus

+ const RunPostPlanCompleted

+ const RunPostPlanRunning

+ type RunTask struct

+ Category string

+ HMACKey *string

+ ID string

+ Name string

+ Organization *Organization

+ URL string

+ WorkspaceRunTasks []*WorkspaceRunTask

+ type RunTaskCreateOptions struct

+ Category string

+ HMACKey *string

+ Name string

+ Type string

+ URL string

+ type RunTaskIncludeOps string

+ const RunTaskWorkspace

+ const RunTaskWorkspaceTasks

+ type RunTaskList struct

+ Items []*RunTask

+ type RunTaskListOptions struct

+ Include []RunTaskIncludeOps

+ type RunTaskReadOptions struct

+ Include []RunTaskIncludeOps

+ type RunTaskUpdateOptions struct

+ Category *string

+ 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 Stage string

+ const PostPlan

+ type TaskEnforcementLevel string

+ 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

+ 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

+ CreatedAt time.Time

+ ID string

+ Run *Run

+ Stage Stage

+ StatusTimestamps TaskStageStatusTimestamps

+ TaskResults []*TaskResult

+ UpdatedAt time.Time

+ type TaskStageIncludeOps string

+ const TaskStageTaskResults

+ type TaskStageList struct

+ Items []*TaskStage

+ type TaskStageListOptions struct

+ type TaskStageReadOptions struct

+ Include []TaskStageIncludeOps

+ 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)

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

+ type WorkspaceRunTask struct

+ EnforcementLevel TaskEnforcementLevel

+ ID string

+ RunTask *RunTask

+ Workspace *Workspace

+ type WorkspaceRunTaskCreateOptions struct

+ EnforcementLevel TaskEnforcementLevel

+ RunTask *RunTask

+ Type string

+ type WorkspaceRunTaskList struct

+ Items []*WorkspaceRunTask

+ type WorkspaceRunTaskListOptions struct

+ type WorkspaceRunTaskUpdateOptions struct

+ EnforcementLevel TaskEnforcementLevel

+ 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)

Feb 11, 2022

Changes in this version

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

type AdminOrganization

+ GlobalModuleSharing *bool

type AdminOrganizationUpdateOptions

+ GlobalModuleSharing *bool

type OrganizationAccess

+ ManageModules bool

+ ManageProviders bool

type OrganizationAccessOptions

+ ManageModules *bool

+ ManageProviders *bool

Jan 21, 2022

Changes in this version

type AdminTerraformVersion

+ Deprecated bool

+ DeprecatedReason *string

type AdminTerraformVersionCreateOptions

+ Deprecated *bool

+ DeprecatedReason *string

type AdminTerraformVersionUpdateOptions

+ Deprecated *bool

+ DeprecatedReason *string

type AdminTerraformVersionsListOptions

+ Filter *string

+ Search *string

Jan 19, 2022

Changes in this version

type Workspace

+ CurrentStateVersion *StateVersion

Jan 5, 2022

Changes in this version

+ type AdminOrganizationID struct

+ ID string

+ type AdminOrganizationListModuleConsumersOptions struct

type AdminOrganizations

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

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

Dec 9, 2021

Changes in this version

+ type AddWorkspacesToTagOptions struct

+ WorkspaceIDs []string

type Client

+ OrganizationTags OrganizationTags

type OAuthClient

+ Secret string

type OAuthClientCreateOptions

+ Name *string

+ RSAPublicKey *string

+ 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 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

type Run

+ Variables []*RunVariable

type RunCreateOptions

+ Variables []*RunVariable

+ type RunVariable struct

+ Key string

+ Value string

Oct 22, 2021

Changes in this version

+ type MockAdminOrganizations struct

+ func NewMockAdminOrganizations(ctrl *gomock.Controller) *MockAdminOrganizations

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

+ func (m *MockAdminOrganizations) EXPECT() *MockAdminOrganizationsMockRecorder

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

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

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

+ type MockAdminOrganizationsMockRecorder struct

+ func (mr *MockAdminOrganizationsMockRecorder) Delete(ctx, organization interface{}) *gomock.Call

+ func (mr *MockAdminOrganizationsMockRecorder) List(ctx, options interface{}) *gomock.Call

+ func (mr *MockAdminOrganizationsMockRecorder) Read(ctx, organization interface{}) *gomock.Call

+ func (mr *MockAdminOrganizationsMockRecorder) Update(ctx, organization, options interface{}) *gomock.Call

+ type MockAdminRuns struct

+ func NewMockAdminRuns(ctrl *gomock.Controller) *MockAdminRuns

+ func (m *MockAdminRuns) EXPECT() *MockAdminRunsMockRecorder

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

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

+ type MockAdminRunsMockRecorder struct

+ func (mr *MockAdminRunsMockRecorder) ForceCancel(ctx, runID, options interface{}) *gomock.Call

+ func (mr *MockAdminRunsMockRecorder) List(ctx, options interface{}) *gomock.Call

+ type MockAdminTerraformVersions struct

+ func NewMockAdminTerraformVersions(ctrl *gomock.Controller) *MockAdminTerraformVersions

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

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

+ func (m *MockAdminTerraformVersions) EXPECT() *MockAdminTerraformVersionsMockRecorder

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

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

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

+ type MockAdminTerraformVersionsMockRecorder struct

+ func (mr *MockAdminTerraformVersionsMockRecorder) Create(ctx, options interface{}) *gomock.Call

+ func (mr *MockAdminTerraformVersionsMockRecorder) Delete(ctx, id interface{}) *gomock.Call

+ func (mr *MockAdminTerraformVersionsMockRecorder) List(ctx, options interface{}) *gomock.Call

+ func (mr *MockAdminTerraformVersionsMockRecorder) Read(ctx, id interface{}) *gomock.Call

+ func (mr *MockAdminTerraformVersionsMockRecorder) Update(ctx, id, options interface{}) *gomock.Call

+ type MockAdminUsers struct

+ func NewMockAdminUsers(ctrl *gomock.Controller) *MockAdminUsers

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

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

+ func (m *MockAdminUsers) EXPECT() *MockAdminUsersMockRecorder

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

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

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

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

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

+ type MockAdminUsersMockRecorder struct

+ func (mr *MockAdminUsersMockRecorder) Delete(ctx, userID interface{}) *gomock.Call

+ func (mr *MockAdminUsersMockRecorder) Disable2FA(ctx, userID interface{}) *gomock.Call

+ func (mr *MockAdminUsersMockRecorder) GrantAdmin(ctx, userID interface{}) *gomock.Call

+ func (mr *MockAdminUsersMockRecorder) List(ctx, options interface{}) *gomock.Call

+ func (mr *MockAdminUsersMockRecorder) RevokeAdmin(ctx, userID interface{}) *gomock.Call

+ func (mr *MockAdminUsersMockRecorder) Suspend(ctx, userID interface{}) *gomock.Call

+ func (mr *MockAdminUsersMockRecorder) Unsuspend(ctx, userID interface{}) *gomock.Call

+ type MockAdminWorkspaces struct

+ func NewMockAdminWorkspaces(ctrl *gomock.Controller) *MockAdminWorkspaces

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

+ func (m *MockAdminWorkspaces) EXPECT() *MockAdminWorkspacesMockRecorder

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

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

+ type MockAdminWorkspacesMockRecorder struct

+ func (mr *MockAdminWorkspacesMockRecorder) Delete(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockAdminWorkspacesMockRecorder) List(ctx, options interface{}) *gomock.Call

+ func (mr *MockAdminWorkspacesMockRecorder) Read(ctx, workspaceID interface{}) *gomock.Call

+ type MockAgentPools struct

+ func NewMockAgentPools(ctrl *gomock.Controller) *MockAgentPools

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

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

+ func (m *MockAgentPools) EXPECT() *MockAgentPoolsMockRecorder

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

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

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

+ type MockAgentPoolsMockRecorder struct

+ func (mr *MockAgentPoolsMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockAgentPoolsMockRecorder) Delete(ctx, agentPoolID interface{}) *gomock.Call

+ func (mr *MockAgentPoolsMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockAgentPoolsMockRecorder) Read(ctx, agentPoolID interface{}) *gomock.Call

+ func (mr *MockAgentPoolsMockRecorder) Update(ctx, agentPool, options interface{}) *gomock.Call

+ type MockAgentTokens struct

+ func NewMockAgentTokens(ctrl *gomock.Controller) *MockAgentTokens

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

+ func (m *MockAgentTokens) EXPECT() *MockAgentTokensMockRecorder

+ func (m *MockAgentTokens) Generate(ctx context.Context, agentPoolID string, options AgentTokenGenerateOptions) (*AgentToken, error)

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

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

+ type MockAgentTokensMockRecorder struct

+ func (mr *MockAgentTokensMockRecorder) Delete(ctx, agentTokenID interface{}) *gomock.Call

+ func (mr *MockAgentTokensMockRecorder) Generate(ctx, agentPoolID, options interface{}) *gomock.Call

+ func (mr *MockAgentTokensMockRecorder) List(ctx, agentPoolID interface{}) *gomock.Call

+ func (mr *MockAgentTokensMockRecorder) Read(ctx, agentTokenID interface{}) *gomock.Call

+ type MockApplies struct

+ func NewMockApplies(ctrl *gomock.Controller) *MockApplies

+ func (m *MockApplies) EXPECT() *MockAppliesMockRecorder

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

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

+ type MockAppliesMockRecorder struct

+ func (mr *MockAppliesMockRecorder) Logs(ctx, applyID interface{}) *gomock.Call

+ func (mr *MockAppliesMockRecorder) Read(ctx, applyID interface{}) *gomock.Call

+ type MockConfigurationVersions struct

+ func NewMockConfigurationVersions(ctrl *gomock.Controller) *MockConfigurationVersions

+ func (m *MockConfigurationVersions) Create(ctx context.Context, workspaceID string, ...) (*ConfigurationVersion, error)

+ func (m *MockConfigurationVersions) EXPECT() *MockConfigurationVersionsMockRecorder

+ func (m *MockConfigurationVersions) List(ctx context.Context, workspaceID string, ...) (*ConfigurationVersionList, error)

+ func (m *MockConfigurationVersions) Read(ctx context.Context, cvID string) (*ConfigurationVersion, error)

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

+ func (m *MockConfigurationVersions) Upload(ctx context.Context, url, path string) error

+ type MockConfigurationVersionsMockRecorder struct

+ func (mr *MockConfigurationVersionsMockRecorder) Create(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockConfigurationVersionsMockRecorder) List(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockConfigurationVersionsMockRecorder) Read(ctx, cvID interface{}) *gomock.Call

+ func (mr *MockConfigurationVersionsMockRecorder) ReadWithOptions(ctx, cvID, options interface{}) *gomock.Call

+ func (mr *MockConfigurationVersionsMockRecorder) Upload(ctx, url, path interface{}) *gomock.Call

+ type MockCostEstimates struct

+ func NewMockCostEstimates(ctrl *gomock.Controller) *MockCostEstimates

+ func (m *MockCostEstimates) EXPECT() *MockCostEstimatesMockRecorder

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

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

+ type MockCostEstimatesMockRecorder struct

+ func (mr *MockCostEstimatesMockRecorder) Logs(ctx, costEstimateID interface{}) *gomock.Call

+ func (mr *MockCostEstimatesMockRecorder) Read(ctx, costEstimateID interface{}) *gomock.Call

+ type MockCostEstimationSettings struct

+ func NewMockCostEstimationSettings(ctrl *gomock.Controller) *MockCostEstimationSettings

+ func (m *MockCostEstimationSettings) EXPECT() *MockCostEstimationSettingsMockRecorder

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

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

+ type MockCostEstimationSettingsMockRecorder struct

+ func (mr *MockCostEstimationSettingsMockRecorder) Read(ctx interface{}) *gomock.Call

+ func (mr *MockCostEstimationSettingsMockRecorder) Update(ctx, options interface{}) *gomock.Call

+ type MockCustomizationSettings struct

+ func NewMockCustomizationSettings(ctrl *gomock.Controller) *MockCustomizationSettings

+ func (m *MockCustomizationSettings) EXPECT() *MockCustomizationSettingsMockRecorder

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

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

+ type MockCustomizationSettingsMockRecorder struct

+ func (mr *MockCustomizationSettingsMockRecorder) Read(ctx interface{}) *gomock.Call

+ func (mr *MockCustomizationSettingsMockRecorder) Update(ctx, options interface{}) *gomock.Call

+ type MockGeneralSettings struct

+ func NewMockGeneralSettings(ctrl *gomock.Controller) *MockGeneralSettings

+ func (m *MockGeneralSettings) EXPECT() *MockGeneralSettingsMockRecorder

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

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

+ type MockGeneralSettingsMockRecorder struct

+ func (mr *MockGeneralSettingsMockRecorder) Read(ctx interface{}) *gomock.Call

+ func (mr *MockGeneralSettingsMockRecorder) Update(ctx, options interface{}) *gomock.Call

+ type MockIPRanges struct

+ func NewMockIPRanges(ctrl *gomock.Controller) *MockIPRanges

+ func (m *MockIPRanges) EXPECT() *MockIPRangesMockRecorder

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

+ type MockIPRangesMockRecorder struct

+ func (mr *MockIPRangesMockRecorder) Read(ctx, modifiedSince interface{}) *gomock.Call

+ type MockNotificationConfigurations struct

+ func NewMockNotificationConfigurations(ctrl *gomock.Controller) *MockNotificationConfigurations

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

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

+ func (m *MockNotificationConfigurations) EXPECT() *MockNotificationConfigurationsMockRecorder

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

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

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

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

+ type MockNotificationConfigurationsMockRecorder struct

+ func (mr *MockNotificationConfigurationsMockRecorder) Create(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockNotificationConfigurationsMockRecorder) Delete(ctx, notificationConfigurationID interface{}) *gomock.Call

+ func (mr *MockNotificationConfigurationsMockRecorder) List(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockNotificationConfigurationsMockRecorder) Read(ctx, notificationConfigurationID interface{}) *gomock.Call

+ func (mr *MockNotificationConfigurationsMockRecorder) Update(ctx, notificationConfigurationID, options interface{}) *gomock.Call

+ func (mr *MockNotificationConfigurationsMockRecorder) Verify(ctx, notificationConfigurationID interface{}) *gomock.Call

+ type MockOAuthClients struct

+ func NewMockOAuthClients(ctrl *gomock.Controller) *MockOAuthClients

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

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

+ func (m *MockOAuthClients) EXPECT() *MockOAuthClientsMockRecorder

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

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

+ type MockOAuthClientsMockRecorder struct

+ func (mr *MockOAuthClientsMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockOAuthClientsMockRecorder) Delete(ctx, oAuthClientID interface{}) *gomock.Call

+ func (mr *MockOAuthClientsMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockOAuthClientsMockRecorder) Read(ctx, oAuthClientID interface{}) *gomock.Call

+ type MockOAuthTokens struct

+ func NewMockOAuthTokens(ctrl *gomock.Controller) *MockOAuthTokens

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

+ func (m *MockOAuthTokens) EXPECT() *MockOAuthTokensMockRecorder

+ func (m *MockOAuthTokens) List(ctx context.Context, organization string, options OAuthTokenListOptions) (*OAuthTokenList, error)

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

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

+ type MockOAuthTokensMockRecorder struct

+ func (mr *MockOAuthTokensMockRecorder) Delete(ctx, oAuthTokenID interface{}) *gomock.Call

+ func (mr *MockOAuthTokensMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockOAuthTokensMockRecorder) Read(ctx, oAuthTokenID interface{}) *gomock.Call

+ func (mr *MockOAuthTokensMockRecorder) Update(ctx, oAuthTokenID, options interface{}) *gomock.Call

+ type MockOrganizationMemberships struct

+ func NewMockOrganizationMemberships(ctrl *gomock.Controller) *MockOrganizationMemberships

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

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

+ func (m *MockOrganizationMemberships) EXPECT() *MockOrganizationMembershipsMockRecorder

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

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

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

+ type MockOrganizationMembershipsMockRecorder struct

+ func (mr *MockOrganizationMembershipsMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockOrganizationMembershipsMockRecorder) Delete(ctx, organizationMembershipID interface{}) *gomock.Call

+ func (mr *MockOrganizationMembershipsMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockOrganizationMembershipsMockRecorder) Read(ctx, organizationMembershipID interface{}) *gomock.Call

+ func (mr *MockOrganizationMembershipsMockRecorder) ReadWithOptions(ctx, organizationMembershipID, options interface{}) *gomock.Call

+ type MockOrganizationTokens struct

+ func NewMockOrganizationTokens(ctrl *gomock.Controller) *MockOrganizationTokens

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

+ func (m *MockOrganizationTokens) EXPECT() *MockOrganizationTokensMockRecorder

+ func (m *MockOrganizationTokens) Generate(ctx context.Context, organization string) (*OrganizationToken, error)

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

+ type MockOrganizationTokensMockRecorder struct

+ func (mr *MockOrganizationTokensMockRecorder) Delete(ctx, organization interface{}) *gomock.Call

+ func (mr *MockOrganizationTokensMockRecorder) Generate(ctx, organization interface{}) *gomock.Call

+ func (mr *MockOrganizationTokensMockRecorder) Read(ctx, organization interface{}) *gomock.Call

+ type MockOrganizations struct

+ func NewMockOrganizations(ctrl *gomock.Controller) *MockOrganizations

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

+ func (m *MockOrganizations) Create(ctx context.Context, options OrganizationCreateOptions) (*Organization, error)

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

+ func (m *MockOrganizations) EXPECT() *MockOrganizationsMockRecorder

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

+ func (m *MockOrganizations) List(ctx context.Context, options OrganizationListOptions) (*OrganizationList, error)

+ func (m *MockOrganizations) Read(ctx context.Context, organization string) (*Organization, error)

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

+ func (m *MockOrganizations) Update(ctx context.Context, organization string, options OrganizationUpdateOptions) (*Organization, error)

+ type MockOrganizationsMockRecorder struct

+ func (mr *MockOrganizationsMockRecorder) Capacity(ctx, organization interface{}) *gomock.Call

+ func (mr *MockOrganizationsMockRecorder) Create(ctx, options interface{}) *gomock.Call

+ func (mr *MockOrganizationsMockRecorder) Delete(ctx, organization interface{}) *gomock.Call

+ func (mr *MockOrganizationsMockRecorder) Entitlements(ctx, organization interface{}) *gomock.Call

+ func (mr *MockOrganizationsMockRecorder) List(ctx, options interface{}) *gomock.Call

+ func (mr *MockOrganizationsMockRecorder) Read(ctx, organization interface{}) *gomock.Call

+ func (mr *MockOrganizationsMockRecorder) RunQueue(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockOrganizationsMockRecorder) Update(ctx, organization, options interface{}) *gomock.Call

+ type MockPlanExports struct

+ func NewMockPlanExports(ctrl *gomock.Controller) *MockPlanExports

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

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

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

+ func (m *MockPlanExports) EXPECT() *MockPlanExportsMockRecorder

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

+ type MockPlanExportsMockRecorder struct

+ func (mr *MockPlanExportsMockRecorder) Create(ctx, options interface{}) *gomock.Call

+ func (mr *MockPlanExportsMockRecorder) Delete(ctx, planExportID interface{}) *gomock.Call

+ func (mr *MockPlanExportsMockRecorder) Download(ctx, planExportID interface{}) *gomock.Call

+ func (mr *MockPlanExportsMockRecorder) Read(ctx, planExportID interface{}) *gomock.Call

+ type MockPlans struct

+ func NewMockPlans(ctrl *gomock.Controller) *MockPlans

+ func (m *MockPlans) EXPECT() *MockPlansMockRecorder

+ func (m *MockPlans) JSONOutput(ctx context.Context, planID string) ([]byte, error)

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

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

+ type MockPlansMockRecorder struct

+ func (mr *MockPlansMockRecorder) JSONOutput(ctx, planID interface{}) *gomock.Call

+ func (mr *MockPlansMockRecorder) Logs(ctx, planID interface{}) *gomock.Call

+ func (mr *MockPlansMockRecorder) Read(ctx, planID interface{}) *gomock.Call

+ type MockPolicies struct

+ func NewMockPolicies(ctrl *gomock.Controller) *MockPolicies

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

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

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

+ func (m *MockPolicies) EXPECT() *MockPoliciesMockRecorder

+ func (m *MockPolicies) List(ctx context.Context, organization string, options PolicyListOptions) (*PolicyList, error)

+ func (m *MockPolicies) Read(ctx context.Context, policyID string) (*Policy, error)

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

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

+ type MockPoliciesMockRecorder struct

+ func (mr *MockPoliciesMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockPoliciesMockRecorder) Delete(ctx, policyID interface{}) *gomock.Call

+ func (mr *MockPoliciesMockRecorder) Download(ctx, policyID interface{}) *gomock.Call

+ func (mr *MockPoliciesMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockPoliciesMockRecorder) Read(ctx, policyID interface{}) *gomock.Call

+ func (mr *MockPoliciesMockRecorder) Update(ctx, policyID, options interface{}) *gomock.Call

+ func (mr *MockPoliciesMockRecorder) Upload(ctx, policyID, content interface{}) *gomock.Call

+ type MockPolicyChecks struct

+ func NewMockPolicyChecks(ctrl *gomock.Controller) *MockPolicyChecks

+ func (m *MockPolicyChecks) EXPECT() *MockPolicyChecksMockRecorder

+ func (m *MockPolicyChecks) List(ctx context.Context, runID string, options PolicyCheckListOptions) (*PolicyCheckList, error)

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

+ func (m *MockPolicyChecks) Override(ctx context.Context, policyCheckID string) (*PolicyCheck, error)

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

+ type MockPolicyChecksMockRecorder struct

+ func (mr *MockPolicyChecksMockRecorder) List(ctx, runID, options interface{}) *gomock.Call

+ func (mr *MockPolicyChecksMockRecorder) Logs(ctx, policyCheckID interface{}) *gomock.Call

+ func (mr *MockPolicyChecksMockRecorder) Override(ctx, policyCheckID interface{}) *gomock.Call

+ func (mr *MockPolicyChecksMockRecorder) Read(ctx, policyCheckID interface{}) *gomock.Call

+ type MockPolicySetParameters struct

+ func NewMockPolicySetParameters(ctrl *gomock.Controller) *MockPolicySetParameters

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

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

+ func (m *MockPolicySetParameters) EXPECT() *MockPolicySetParametersMockRecorder

+ func (m *MockPolicySetParameters) List(ctx context.Context, policySetID string, options PolicySetParameterListOptions) (*PolicySetParameterList, error)

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

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

+ type MockPolicySetParametersMockRecorder struct

+ func (mr *MockPolicySetParametersMockRecorder) Create(ctx, policySetID, options interface{}) *gomock.Call

+ func (mr *MockPolicySetParametersMockRecorder) Delete(ctx, policySetID, parameterID interface{}) *gomock.Call

+ func (mr *MockPolicySetParametersMockRecorder) List(ctx, policySetID, options interface{}) *gomock.Call

+ func (mr *MockPolicySetParametersMockRecorder) Read(ctx, policySetID, parameterID interface{}) *gomock.Call

+ func (mr *MockPolicySetParametersMockRecorder) Update(ctx, policySetID, parameterID, options interface{}) *gomock.Call

+ type MockPolicySetVersions struct

+ func NewMockPolicySetVersions(ctrl *gomock.Controller) *MockPolicySetVersions

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

+ func (m *MockPolicySetVersions) EXPECT() *MockPolicySetVersionsMockRecorder

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

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

+ type MockPolicySetVersionsMockRecorder struct

+ func (mr *MockPolicySetVersionsMockRecorder) Create(ctx, policySetID interface{}) *gomock.Call

+ func (mr *MockPolicySetVersionsMockRecorder) Read(ctx, policySetVersionID interface{}) *gomock.Call

+ func (mr *MockPolicySetVersionsMockRecorder) Upload(ctx, psv, path interface{}) *gomock.Call

+ type MockPolicySets struct

+ func NewMockPolicySets(ctrl *gomock.Controller) *MockPolicySets

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

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

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

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

+ func (m *MockPolicySets) EXPECT() *MockPolicySetsMockRecorder

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

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

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

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

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

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

+ type MockPolicySetsMockRecorder struct

+ func (mr *MockPolicySetsMockRecorder) AddPolicies(ctx, policySetID, options interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) AddWorkspaces(ctx, policySetID, options interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) Delete(ctx, policyID interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) Read(ctx, policySetID interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) ReadWithOptions(ctx, policySetID, options interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) RemovePolicies(ctx, policySetID, options interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) RemoveWorkspaces(ctx, policySetID, options interface{}) *gomock.Call

+ func (mr *MockPolicySetsMockRecorder) Update(ctx, policySetID, options interface{}) *gomock.Call

+ type MockRegistryModules struct

+ func NewMockRegistryModules(ctrl *gomock.Controller) *MockRegistryModules

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

+ func (m *MockRegistryModules) CreateVersion(ctx context.Context, organization, name, provider string, ...) (*RegistryModuleVersion, error)

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

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

+ func (m *MockRegistryModules) DeleteProvider(ctx context.Context, organization, name, provider string) error

+ func (m *MockRegistryModules) DeleteVersion(ctx context.Context, organization, name, provider, version string) error

+ func (m *MockRegistryModules) EXPECT() *MockRegistryModulesMockRecorder

+ func (m *MockRegistryModules) Read(ctx context.Context, organization, name, provider string) (*RegistryModule, error)

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

+ type MockRegistryModulesMockRecorder struct

+ func (mr *MockRegistryModulesMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockRegistryModulesMockRecorder) CreateVersion(ctx, organization, name, provider, options interface{}) *gomock.Call

+ func (mr *MockRegistryModulesMockRecorder) CreateWithVCSConnection(ctx, options interface{}) *gomock.Call

+ func (mr *MockRegistryModulesMockRecorder) Delete(ctx, organization, name interface{}) *gomock.Call

+ func (mr *MockRegistryModulesMockRecorder) DeleteProvider(ctx, organization, name, provider interface{}) *gomock.Call

+ func (mr *MockRegistryModulesMockRecorder) DeleteVersion(ctx, organization, name, provider, version interface{}) *gomock.Call

+ func (mr *MockRegistryModulesMockRecorder) Read(ctx, organization, name, provider interface{}) *gomock.Call

+ func (mr *MockRegistryModulesMockRecorder) Upload(ctx, rmv, path interface{}) *gomock.Call

+ type MockRunTriggers struct

+ func NewMockRunTriggers(ctrl *gomock.Controller) *MockRunTriggers

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

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

+ func (m *MockRunTriggers) EXPECT() *MockRunTriggersMockRecorder

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

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

+ type MockRunTriggersMockRecorder struct

+ func (mr *MockRunTriggersMockRecorder) Create(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockRunTriggersMockRecorder) Delete(ctx, RunTriggerID interface{}) *gomock.Call

+ func (mr *MockRunTriggersMockRecorder) List(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockRunTriggersMockRecorder) Read(ctx, RunTriggerID interface{}) *gomock.Call

+ type MockRuns struct

+ func NewMockRuns(ctrl *gomock.Controller) *MockRuns

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

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

+ func (m *MockRuns) Create(ctx context.Context, options RunCreateOptions) (*Run, error)

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

+ func (m *MockRuns) EXPECT() *MockRunsMockRecorder

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

+ func (m *MockRuns) List(ctx context.Context, workspaceID string, options RunListOptions) (*RunList, error)

+ func (m *MockRuns) Read(ctx context.Context, runID string) (*Run, error)

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

+ type MockRunsMockRecorder struct

+ func (mr *MockRunsMockRecorder) Apply(ctx, runID, options interface{}) *gomock.Call

+ func (mr *MockRunsMockRecorder) Cancel(ctx, runID, options interface{}) *gomock.Call

+ func (mr *MockRunsMockRecorder) Create(ctx, options interface{}) *gomock.Call

+ func (mr *MockRunsMockRecorder) Discard(ctx, runID, options interface{}) *gomock.Call

+ func (mr *MockRunsMockRecorder) ForceCancel(ctx, runID, options interface{}) *gomock.Call

+ func (mr *MockRunsMockRecorder) List(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockRunsMockRecorder) Read(ctx, runID interface{}) *gomock.Call

+ func (mr *MockRunsMockRecorder) ReadWithOptions(ctx, runID, options interface{}) *gomock.Call

+ type MockSAMLSettings struct

+ func NewMockSAMLSettings(ctrl *gomock.Controller) *MockSAMLSettings

+ func (m *MockSAMLSettings) EXPECT() *MockSAMLSettingsMockRecorder

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

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

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

+ type MockSAMLSettingsMockRecorder struct

+ func (mr *MockSAMLSettingsMockRecorder) Read(ctx interface{}) *gomock.Call

+ func (mr *MockSAMLSettingsMockRecorder) RevokeIdpCert(ctx interface{}) *gomock.Call

+ func (mr *MockSAMLSettingsMockRecorder) Update(ctx, options interface{}) *gomock.Call

+ type MockSMTPSettings struct

+ func NewMockSMTPSettings(ctrl *gomock.Controller) *MockSMTPSettings

+ func (m *MockSMTPSettings) EXPECT() *MockSMTPSettingsMockRecorder

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

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

+ type MockSMTPSettingsMockRecorder struct

+ func (mr *MockSMTPSettingsMockRecorder) Read(ctx interface{}) *gomock.Call

+ func (mr *MockSMTPSettingsMockRecorder) Update(ctx, options interface{}) *gomock.Call

+ type MockSSHKeys struct

+ func NewMockSSHKeys(ctrl *gomock.Controller) *MockSSHKeys

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

+ func (m *MockSSHKeys) Delete(ctx context.Context, sshKeyID string) error

+ func (m *MockSSHKeys) EXPECT() *MockSSHKeysMockRecorder

+ func (m *MockSSHKeys) List(ctx context.Context, organization string, options SSHKeyListOptions) (*SSHKeyList, error)

+ func (m *MockSSHKeys) Read(ctx context.Context, sshKeyID string) (*SSHKey, error)

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

+ type MockSSHKeysMockRecorder struct

+ func (mr *MockSSHKeysMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockSSHKeysMockRecorder) Delete(ctx, sshKeyID interface{}) *gomock.Call

+ func (mr *MockSSHKeysMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockSSHKeysMockRecorder) Read(ctx, sshKeyID interface{}) *gomock.Call

+ func (mr *MockSSHKeysMockRecorder) Update(ctx, sshKeyID, options interface{}) *gomock.Call

+ type MockStateVersionOutputs struct

+ func NewMockStateVersionOutputs(ctrl *gomock.Controller) *MockStateVersionOutputs

+ func (m *MockStateVersionOutputs) EXPECT() *MockStateVersionOutputsMockRecorder

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

+ type MockStateVersionOutputsMockRecorder struct

+ func (mr *MockStateVersionOutputsMockRecorder) Read(ctx, outputID interface{}) *gomock.Call

+ type MockStateVersions struct

+ func NewMockStateVersions(ctrl *gomock.Controller) *MockStateVersions

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

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

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

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

+ func (m *MockStateVersions) EXPECT() *MockStateVersionsMockRecorder

+ func (m *MockStateVersions) List(ctx context.Context, options StateVersionListOptions) (*StateVersionList, error)

+ func (m *MockStateVersions) Outputs(ctx context.Context, svID string, options StateVersionOutputsListOptions) ([]*StateVersionOutput, error)

+ func (m *MockStateVersions) Read(ctx context.Context, svID string) (*StateVersion, error)

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

+ type MockStateVersionsMockRecorder struct

+ func (mr *MockStateVersionsMockRecorder) Create(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockStateVersionsMockRecorder) Current(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockStateVersionsMockRecorder) CurrentWithOptions(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockStateVersionsMockRecorder) Download(ctx, url interface{}) *gomock.Call

+ func (mr *MockStateVersionsMockRecorder) List(ctx, options interface{}) *gomock.Call

+ func (mr *MockStateVersionsMockRecorder) Outputs(ctx, svID, options interface{}) *gomock.Call

+ func (mr *MockStateVersionsMockRecorder) Read(ctx, svID interface{}) *gomock.Call

+ func (mr *MockStateVersionsMockRecorder) ReadWithOptions(ctx, svID, options interface{}) *gomock.Call

+ type MockTeamAccesses struct

+ func NewMockTeamAccesses(ctrl *gomock.Controller) *MockTeamAccesses

+ func (m *MockTeamAccesses) Add(ctx context.Context, options TeamAccessAddOptions) (*TeamAccess, error)

+ func (m *MockTeamAccesses) EXPECT() *MockTeamAccessesMockRecorder

+ func (m *MockTeamAccesses) List(ctx context.Context, options TeamAccessListOptions) (*TeamAccessList, error)

+ func (m *MockTeamAccesses) Read(ctx context.Context, teamAccessID string) (*TeamAccess, error)

+ func (m *MockTeamAccesses) Remove(ctx context.Context, teamAccessID string) error

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

+ type MockTeamAccessesMockRecorder struct

+ func (mr *MockTeamAccessesMockRecorder) Add(ctx, options interface{}) *gomock.Call

+ func (mr *MockTeamAccessesMockRecorder) List(ctx, options interface{}) *gomock.Call

+ func (mr *MockTeamAccessesMockRecorder) Read(ctx, teamAccessID interface{}) *gomock.Call

+ func (mr *MockTeamAccessesMockRecorder) Remove(ctx, teamAccessID interface{}) *gomock.Call

+ func (mr *MockTeamAccessesMockRecorder) Update(ctx, teamAccessID, options interface{}) *gomock.Call

+ type MockTeamMembers struct

+ func NewMockTeamMembers(ctrl *gomock.Controller) *MockTeamMembers

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

+ func (m *MockTeamMembers) EXPECT() *MockTeamMembersMockRecorder

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

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

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

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

+ type MockTeamMembersMockRecorder struct

+ func (mr *MockTeamMembersMockRecorder) Add(ctx, teamID, options interface{}) *gomock.Call

+ func (mr *MockTeamMembersMockRecorder) List(ctx, teamID interface{}) *gomock.Call

+ func (mr *MockTeamMembersMockRecorder) ListOrganizationMemberships(ctx, teamID interface{}) *gomock.Call

+ func (mr *MockTeamMembersMockRecorder) ListUsers(ctx, teamID interface{}) *gomock.Call

+ func (mr *MockTeamMembersMockRecorder) Remove(ctx, teamID, options interface{}) *gomock.Call

+ type MockTeamTokens struct

+ func NewMockTeamTokens(ctrl *gomock.Controller) *MockTeamTokens

+ func (m *MockTeamTokens) Delete(ctx context.Context, teamID string) error

+ func (m *MockTeamTokens) EXPECT() *MockTeamTokensMockRecorder

+ func (m *MockTeamTokens) Generate(ctx context.Context, teamID string) (*TeamToken, error)

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

+ type MockTeamTokensMockRecorder struct

+ func (mr *MockTeamTokensMockRecorder) Delete(ctx, teamID interface{}) *gomock.Call

+ func (mr *MockTeamTokensMockRecorder) Generate(ctx, teamID interface{}) *gomock.Call

+ func (mr *MockTeamTokensMockRecorder) Read(ctx, teamID interface{}) *gomock.Call

+ type MockTeams struct

+ func NewMockTeams(ctrl *gomock.Controller) *MockTeams

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

+ func (m *MockTeams) Delete(ctx context.Context, teamID string) error

+ func (m *MockTeams) EXPECT() *MockTeamsMockRecorder

+ func (m *MockTeams) List(ctx context.Context, organization string, options TeamListOptions) (*TeamList, error)

+ func (m *MockTeams) Read(ctx context.Context, teamID string) (*Team, error)

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

+ type MockTeamsMockRecorder struct

+ func (mr *MockTeamsMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockTeamsMockRecorder) Delete(ctx, teamID interface{}) *gomock.Call

+ func (mr *MockTeamsMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockTeamsMockRecorder) Read(ctx, teamID interface{}) *gomock.Call

+ func (mr *MockTeamsMockRecorder) Update(ctx, teamID, options interface{}) *gomock.Call

+ type MockTwilioSettings struct

+ func NewMockTwilioSettings(ctrl *gomock.Controller) *MockTwilioSettings

+ func (m *MockTwilioSettings) EXPECT() *MockTwilioSettingsMockRecorder

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

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

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

+ type MockTwilioSettingsMockRecorder struct

+ func (mr *MockTwilioSettingsMockRecorder) Read(ctx interface{}) *gomock.Call

+ func (mr *MockTwilioSettingsMockRecorder) Update(ctx, options interface{}) *gomock.Call

+ func (mr *MockTwilioSettingsMockRecorder) Verify(ctx, options interface{}) *gomock.Call

+ type MockUserTokens struct

+ func NewMockUserTokens(ctrl *gomock.Controller) *MockUserTokens

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

+ func (m *MockUserTokens) EXPECT() *MockUserTokensMockRecorder

+ func (m *MockUserTokens) Generate(ctx context.Context, userID string, options UserTokenGenerateOptions) (*UserToken, error)

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

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

+ type MockUserTokensMockRecorder struct

+ func (mr *MockUserTokensMockRecorder) Delete(ctx, tokenID interface{}) *gomock.Call

+ func (mr *MockUserTokensMockRecorder) Generate(ctx, userID, options interface{}) *gomock.Call

+ func (mr *MockUserTokensMockRecorder) List(ctx, userID interface{}) *gomock.Call

+ func (mr *MockUserTokensMockRecorder) Read(ctx, tokenID interface{}) *gomock.Call

+ type MockUsers struct

+ func NewMockUsers(ctrl *gomock.Controller) *MockUsers

+ func (m *MockUsers) EXPECT() *MockUsersMockRecorder

+ func (m *MockUsers) ReadCurrent(ctx context.Context) (*User, error)

+ func (m *MockUsers) Update(ctx context.Context, options UserUpdateOptions) (*User, error)

+ type MockUsersMockRecorder struct

+ func (mr *MockUsersMockRecorder) ReadCurrent(ctx interface{}) *gomock.Call

+ func (mr *MockUsersMockRecorder) Update(ctx, options interface{}) *gomock.Call

+ type MockVariables struct

+ func NewMockVariables(ctrl *gomock.Controller) *MockVariables

+ func (m *MockVariables) Create(ctx context.Context, workspaceID string, options VariableCreateOptions) (*Variable, error)

+ func (m *MockVariables) Delete(ctx context.Context, workspaceID, variableID string) error

+ func (m *MockVariables) EXPECT() *MockVariablesMockRecorder

+ func (m *MockVariables) List(ctx context.Context, workspaceID string, options VariableListOptions) (*VariableList, error)

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

+ func (m *MockVariables) Update(ctx context.Context, workspaceID, variableID string, ...) (*Variable, error)

+ type MockVariablesMockRecorder struct

+ func (mr *MockVariablesMockRecorder) Create(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockVariablesMockRecorder) Delete(ctx, workspaceID, variableID interface{}) *gomock.Call

+ func (mr *MockVariablesMockRecorder) List(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockVariablesMockRecorder) Read(ctx, workspaceID, variableID interface{}) *gomock.Call

+ func (mr *MockVariablesMockRecorder) Update(ctx, workspaceID, variableID, options interface{}) *gomock.Call

+ type MockWorkspaces struct

+ func NewMockWorkspaces(ctrl *gomock.Controller) *MockWorkspaces

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

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

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

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

+ func (m *MockWorkspaces) Delete(ctx context.Context, organization, workspace string) error

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

+ func (m *MockWorkspaces) EXPECT() *MockWorkspacesMockRecorder

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

+ func (m *MockWorkspaces) List(ctx context.Context, organization string, options WorkspaceListOptions) (*WorkspaceList, error)

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

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

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

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

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

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

+ func (m *MockWorkspaces) RemoteStateConsumers(ctx context.Context, workspaceID string, ...) (*WorkspaceList, error)

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

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

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

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

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

+ func (m *MockWorkspaces) UnassignSSHKey(ctx context.Context, workspaceID string) (*Workspace, error)

+ func (m *MockWorkspaces) Unlock(ctx context.Context, workspaceID string) (*Workspace, error)

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

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

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

+ type MockWorkspacesMockRecorder struct

+ func (mr *MockWorkspacesMockRecorder) AddRemoteStateConsumers(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) AddTags(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) AssignSSHKey(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) Create(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) Delete(ctx, organization, workspace interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) DeleteByID(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) ForceUnlock(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) List(ctx, organization, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) Lock(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) Read(ctx, organization, workspace interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) ReadByID(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) ReadByIDWithOptions(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) ReadWithOptions(ctx, organization, workspace, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) Readme(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) RemoteStateConsumers(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) RemoveRemoteStateConsumers(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) RemoveTags(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) RemoveVCSConnection(ctx, organization, workspace interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) RemoveVCSConnectionByID(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) Tags(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) UnassignSSHKey(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) Unlock(ctx, workspaceID interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) Update(ctx, organization, workspace, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) UpdateByID(ctx, workspaceID, options interface{}) *gomock.Call

+ func (mr *MockWorkspacesMockRecorder) UpdateRemoteStateConsumers(ctx, workspaceID, options interface{}) *gomock.Call

type Organization

+ SendPassingStatusesForUntriggeredSpeculativePlans bool

type OrganizationCreateOptions

+ SendPassingStatusesForUntriggeredSpeculativePlans *bool

type OrganizationUpdateOptions

+ SendPassingStatusesForUntriggeredSpeculativePlans *bool

Sep 20, 2021

Changes in this version

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

type IngressAttributes

+ CommitSHA string

+ type RemoteStateConsumersListOptions struct

type Run

+ AutoApply bool

type RunCreateOptions

+ AutoApply *bool

+ type Tag struct

+ ID string

+ Name string

+ type TagList struct

+ Items []*Tag

type Workspace

+ Outputs []*WorkspaceOutputs

+ TagNames []string

+ Tags []*Tag

+ type WorkspaceAddTagsOptions struct

+ Tags []*Tag

type WorkspaceCreateOptions

+ Tags []*Tag

type WorkspaceListOptions

+ Tags *string

+ type WorkspaceOutputs struct

+ ID string

+ Name string

+ Sensitive bool

+ Type string

+ Value interface{}

+ type WorkspaceRemoveTagsOptions struct

+ Tags []*Tag

+ type WorkspaceTagListOptions struct

+ Query *string

type Workspaces

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

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

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

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

Aug 20, 2021

Changes in this version

+ type StateVersionOutputsList struct

+ Items []*StateVersionOutput

+ type StateVersionOutputsListOptions struct

type StateVersions

+ Outputs func(ctx context.Context, svID string, options StateVersionOutputsListOptions) ([]*StateVersionOutput, error)

Jun 18, 2021

Changes in this version

type PolicySet

+ CurrentVersion *PolicySetVersion

+ NewestVersion *PolicySetVersion

+ type PolicySetReadOptions struct

+ Include string

type PolicySets

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

type Workspace

+ StructuredRunOutputEnabled bool

type WorkspaceCreateOptions

+ StructuredRunOutputEnabled *bool

type WorkspaceUpdateOptions

+ StructuredRunOutputEnabled *bool

Jun 11, 2021

Changes in this version

type Client

+ PolicySetVersions PolicySetVersions

type ConfigurationVersion

+ IngressAttributes *IngressAttributes

type ConfigurationVersionListOptions

+ Include *string

+ type ConfigurationVersionReadOptions struct

+ Include string

type ConfigurationVersions

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

+ type IngressAttributes struct

+ Branch string

+ CloneURL string

+ CommitMessage 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 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 RunStatusTimestamps

+ ApplyQueuedAt time.Time

+ CanceledAt time.Time

+ ConfirmedAt time.Time

+ CostEstimatedAt time.Time

+ CostEstimatingAt time.Time

+ DiscardedAt time.Time

+ ForceCanceledAt time.Time

+ PlanQueueableAt time.Time

+ PlanQueuedAt time.Time

+ PolicyCheckedAt time.Time

+ PolicySoftFailedAt time.Time

type Workspace

+ SourceName string

+ SourceURL string

type WorkspaceCreateOptions

+ SourceName *string

+ SourceURL *string

+ type WorkspaceReadOptions struct

+ Include string

type Workspaces

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

May 18, 2021

Changes in this version

type RegistryModuleVersion

+ Links map[string]interface{}

type RegistryModules

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

type Run

+ Refresh bool

+ RefreshOnly bool

+ ReplaceAddrs []string

type RunCreateOptions

+ Refresh *bool

+ RefreshOnly *bool

+ ReplaceAddrs []string

Apr 20, 2021

Changes in this version

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

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

type AdminGeneralSetting

+ DefaultRemoteStateAccess bool

type AdminGeneralSettingsUpdateOptions

+ DefaultRemoteStateAccess *bool

type OrganizationAccess

+ ManagePolicyOverrides bool

type OrganizationAccessOptions

+ ManagePolicyOverrides *bool

type Plans

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

type Workspace

+ GlobalRemoteState bool

+ type WorkspaceAddRemoteStateConsumersOptions struct

+ Workspaces []*Workspace

type WorkspaceCreateOptions

+ GlobalRemoteState *bool

+ type WorkspaceRemoveRemoteStateConsumersOptions struct

+ Workspaces []*Workspace

type WorkspaceUpdateOptions

+ GlobalRemoteState *bool

+ type WorkspaceUpdateRemoteStateConsumersOptions struct

+ Workspaces []*Workspace

type Workspaces

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

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

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

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

Mar 23, 2021

Changes in this version

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

+ 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 ErrInvalidConfigVersionID = errors.New("invalid value for configuration version ID")

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

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

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

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

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

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

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

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

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

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

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

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

+ 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

+ 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

+ LimitUserOrgCreation *bool

+ SendPassingStatusUntriggeredPlans *bool

+ type AdminOrganization struct

+ AccessBetaTools bool

+ ExternalID string

+ IsDisabled bool

+ Name string

+ NotificationEmail string

+ Owners []*User

+ SsoEnabled bool

+ TerraformBuildWorkerApplyTimeout string

+ TerraformBuildWorkerPlanTimeout string

+ TerraformWorkerSudoEnabled bool

+ type AdminOrganizationList struct

+ Items []*AdminOrganization

+ type AdminOrganizationListOptions struct

+ Include *string

+ Query *string

+ type AdminOrganizationUpdateOptions struct

+ AccessBetaTools *bool

+ IsDisabled *bool

+ TerraformBuildWorkerApplyTimeout *string

+ TerraformBuildWorkerPlanTimeout *string

+ TerraformWorkerSudoEnabled bool

+ type AdminOrganizations interface

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

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

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

+ Update func(ctx context.Context, organization string, ...) (*AdminOrganization, 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 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 *string

+ 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

+ SAML SAMLSettings

+ SMTP SMTPSettings

+ Twilio TwilioSettings

+ type AdminTerraformVersion struct

+ Beta bool

+ CreatedAt time.Time

+ Enabled bool

+ ID string

+ Official bool

+ Sha string

+ URL string

+ Usage int

+ Version string

+ type AdminTerraformVersionCreateOptions struct

+ Beta *bool

+ Enabled *bool

+ Official *bool

+ Sha *string

+ Type string

+ URL *string

+ Version *string

+ type AdminTerraformVersionUpdateOptions struct

+ Beta *bool

+ 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

+ 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 AdminUserList struct

+ Items []*AdminUser

+ type AdminUserListOptions struct

+ Administrators *string

+ Include *string

+ 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 AdminWorkspaceList struct

+ Items []*AdminWorkspace

+ type AdminWorkspaceListOptions struct

+ Include *string

+ Query *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 AgentPoolCreateOptions

+ Type string

type AgentPoolUpdateOptions

+ Type string

type AgentTokenGenerateOptions

+ Type string

type Client

+ Admin Admin

type ConfigurationVersionCreateOptions

+ Type string

+ 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 GeneralSettings interface

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

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

type NotificationConfigurationCreateOptions

+ Type string

type NotificationConfigurationUpdateOptions

+ Type string

type OAuthClientCreateOptions

+ Type string

type OAuthTokenUpdateOptions

+ Type string

type OrganizationCreateOptions

+ Type string

type OrganizationMembershipCreateOptions

+ Type string

type OrganizationUpdateOptions

+ Type string

type PlanExportCreateOptions

+ Type string

type PolicyCreateOptions

+ Type string

type PolicySetCreateOptions

+ Type string

type PolicySetParameterCreateOptions

+ Type string

type PolicySetParameterUpdateOptions

+ Type string

type PolicySetUpdateOptions

+ Type string

type PolicyUpdateOptions

+ Type string

type RegistryModuleCreateOptions

+ Type string

type RegistryModuleCreateVersionOptions

+ Type string

type RunCreateOptions

+ Type string

type RunTriggerCreateOptions

+ Type string

+ 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 StateVersionCreateOptions

+ Type string

type TeamAccessAddOptions

+ Type string

type TeamAccessUpdateOptions

+ Type string

type TeamCreateOptions

+ Type string

type TeamUpdateOptions

+ Type string

+ 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 UserUpdateOptions

+ Type string

type VCSRepo

+ RepositoryHTTPURL string

+ ServiceProvider string

type VariableCreateOptions

+ Type string

type VariableUpdateOptions

+ Type string

type Workspace

+ ApplyDurationAverage time.Duration

+ PlanDurationAverage time.Duration

+ PolicyCheckFailures int

+ ResourceCount int

+ RunFailures int

+ RunsCount int

+ UpdatedAt time.Time

type WorkspaceAssignSSHKeyOptions

+ Type string

type WorkspaceCreateOptions

+ Type string

type WorkspaceUpdateOptions

+ Type string

type Workspaces

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

Feb 9, 2021

Changes in this version

type Workspace

+ Description string

type WorkspaceCreateOptions

+ Description *string

type WorkspaceUpdateOptions

+ Description *string

Jan 20, 2021

Changes in this version

+ type AgentToken struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type AgentTokenGenerateOptions struct

+ Description *string

+ ID string

+ type AgentTokenList struct

+ Items []*AgentToken

+ type AgentTokens interface

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

+ Generate func(ctx context.Context, agentPoolID string, options AgentTokenGenerateOptions) (*AgentToken, error)

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

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

type Client

+ AgentTokens AgentTokens

+ Meta Meta

+ UserTokens UserTokens

type Entitlements

+ Agents bool

+ AuditLogging bool

+ CostEstimation bool

+ SSO bool

+ type IPRange struct

+ API []string

+ Notifications []string

+ Sentinel []string

+ VCS []string

+ type IPRanges interface

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

+ type Meta struct

+ IPRanges IPRanges

type PolicyCheck

+ Run *Run

type RegistryModuleCreateWithVCSConnectionOptions

+ ID string

type Run

+ CreatedBy *User

type RunListOptions

+ Include *string

+ type RunReadOptions struct

+ Include string

type Runs

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

+ type UserToken struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type UserTokenGenerateOptions struct

+ Description string

+ type UserTokenList struct

+ Items []*UserToken

+ type UserTokens interface

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

+ Generate func(ctx context.Context, userID string, options UserTokenGenerateOptions) (*UserToken, error)

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

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

Nov 20, 2020

Changes in this version

type Workspace

+ AllowDestroyPlan bool

type WorkspaceCreateOptions

+ AllowDestroyPlan *bool

type WorkspaceUpdateOptions

+ AllowDestroyPlan *bool

Nov 19, 2020

Changes in this version

+ type AgentPool struct

+ ID string

+ Name string

+ Organization *Organization

+ type AgentPoolCreateOptions struct

+ ID string

+ Name *string

+ type AgentPoolList struct

+ Items []*AgentPool

+ type AgentPoolListOptions struct

+ type AgentPoolUpdateOptions struct

+ ID string

+ Name *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)

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

type Client

+ AgentPools AgentPools

+ StateVersionOutputs StateVersionOutputs

type StateVersion

+ Outputs []*StateVersionOutput

+ type StateVersionCurrentOptions struct

+ Include string

+ type StateVersionOutput struct

+ ID string

+ Name string

+ Sensitive bool

+ Type string

+ Value string

+ type StateVersionOutputs interface

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

+ type StateVersionReadOptions struct

+ Include string

type StateVersions

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

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

type Workspace

+ AgentPool *AgentPool

+ AgentPoolID string

+ ExecutionMode string

type WorkspaceCreateOptions

+ AgentPoolID *string

+ ExecutionMode *string

type WorkspaceListOptions

+ Include *string

type WorkspaceUpdateOptions

+ AgentPoolID *string

+ ExecutionMode *string

Sep 23, 2020

Changes in this version

type Workspace

+ SpeculativeEnabled bool

type WorkspaceCreateOptions

+ SpeculativeEnabled *bool

type WorkspaceUpdateOptions

+ SpeculativeEnabled *bool

Jul 15, 2020

Changes in this version

type Client

+ RegistryModules RegistryModules

type NotificationConfiguration

+ EmailAddresses []string

+ EmailUsers []*User

type NotificationConfigurationCreateOptions

+ EmailAddresses []string

+ EmailUsers []*User

type NotificationConfigurationUpdateOptions

+ EmailAddresses []string

+ EmailUsers []*User

type NotificationDestinationType

+ const NotificationDestinationTypeEmail

type Organization

+ ExternalID string

+ type RegistryModule struct

+ CreatedAt string

+ ID string

+ Name string

+ Organization *Organization

+ Permissions *RegistryModulePermissions

+ Provider string

+ Status RegistryModuleStatus

+ UpdatedAt string

+ VCSRepo *VCSRepo

+ VersionStatuses []RegistryModuleVersionStatuses

+ type RegistryModuleCreateOptions struct

+ ID string

+ Name *string

+ Provider *string

+ type RegistryModuleCreateVersionOptions struct

+ ID string

+ Version *string

+ type RegistryModuleCreateWithVCSConnectionOptions struct

+ VCSRepo *RegistryModuleVCSRepoOptions

+ type RegistryModulePermissions struct

+ CanDelete bool

+ CanResync bool

+ CanRetry bool

+ type RegistryModuleStatus string

+ const RegistryModuleStatusNoVersionTags

+ const RegistryModuleStatusPending

+ const RegistryModuleStatusSetupComplete

+ const RegistryModuleStatusSetupFailed

+ type RegistryModuleVCSRepoOptions struct

+ DisplayIdentifier *string

+ Identifier *string

+ OAuthTokenID *string

+ type RegistryModuleVersion struct

+ CreatedAt string

+ ID string

+ 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, organization string, name string, provider string, ...) (*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, organization string, name string, provider string) error

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

+ Read func(ctx context.Context, organization string, name string, provider string) (*RegistryModule, error)

type TeamListOptions

+ Include string

type VCSRepo

+ DisplayIdentifier string

Jun 15, 2020

Changes in this version

+ const AccessCustom

+ const RunsPermissionApply

+ const RunsPermissionPlan

+ const RunsPermissionRead

+ const SentinelMocksPermissionNone

+ const SentinelMocksPermissionRead

+ const StateVersionsPermissionNone

+ const StateVersionsPermissionRead

+ const StateVersionsPermissionReadOutputs

+ const StateVersionsPermissionWrite

+ const VariablesPermissionNone

+ const VariablesPermissionRead

+ const VariablesPermissionWrite

+ type RunsPermissionType string

+ func RunsPermission(v RunsPermissionType) *RunsPermissionType

+ type SentinelMocksPermissionType string

+ func SentinelMocksPermission(v SentinelMocksPermissionType) *SentinelMocksPermissionType

+ type StateVersionsPermissionType string

+ func StateVersionsPermission(v StateVersionsPermissionType) *StateVersionsPermissionType

type TeamAccess

+ Runs RunsPermissionType

+ SentinelMocks SentinelMocksPermissionType

+ StateVersions StateVersionsPermissionType

+ Variables VariablesPermissionType

+ WorkspaceLocking bool

type TeamAccessAddOptions

+ Runs *RunsPermissionType

+ SentinelMocks *SentinelMocksPermissionType

+ StateVersions *StateVersionsPermissionType

+ Variables *VariablesPermissionType

+ WorkspaceLocking *bool

+ type TeamAccessUpdateOptions struct

+ Access *AccessType

+ ID string

+ Runs *RunsPermissionType

+ SentinelMocks *SentinelMocksPermissionType

+ StateVersions *StateVersionsPermissionType

+ Variables *VariablesPermissionType

+ WorkspaceLocking *bool

type TeamAccesses

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

+ type VariablesPermissionType string

+ func VariablesPermission(v VariablesPermissionType) *VariablesPermissionType

+ type WorkspaceLockingPermissionType bool

May 29, 2020

Changes in this version

type NotificationConfiguration

+ Subscribable *Workspace

May 19, 2020

Changes in this version

type Client

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

type CostEstimateStatus

+ const CostEstimateSkippedDueToTargeting

type CostEstimateStatusTimestamps

+ SkippedDueToTargetingAt time.Time

May 15, 2020

Changes in this version

type Client

+ func (c *Client) RemoteAPIVersion() string

type PolicySetUpdateOptions

+ PoliciesPath *string

+ VCSRepo *VCSRepoOptions

type Run

+ TargetAddrs []string

type RunCreateOptions

+ TargetAddrs []string

Apr 23, 2020

Changes in this version

type Team

+ Visibility string

type TeamCreateOptions

+ Visibility *string

type TeamUpdateOptions

+ Visibility *string

Apr 8, 2020

Changes in this version

type OrganizationMembership

+ Email string

type Team

+ OrganizationMemberships []*OrganizationMembership

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 TestAccountDetails struct

+ Email string

+ ID string

+ Username string

+ func FetchTestAccountDetails(t *testing.T, client *Client) *TestAccountDetails

Feb 18, 2020

Changes in this version

type Client

+ RunTriggers RunTriggers

+ type RunTrigger struct

+ CreatedAt time.Time

+ ID string

+ Sourceable *Workspace

+ SourceableName string

+ Workspace *Workspace

+ WorkspaceName string

+ type RunTriggerCreateOptions struct

+ ID string

+ Sourceable *Workspace

+ type RunTriggerList struct

+ Items []*RunTrigger

+ type RunTriggerListOptions struct

+ RunTriggerType *string

+ 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)

Feb 3, 2020

Changes in this version

type CategoryType

+ const CategoryPolicySet

type Client

+ PolicySetParameters PolicySetParameters

+ type PolicySetParameter struct

+ Category CategoryType

+ ID string

+ Key string

+ PolicySet *PolicySet

+ Sensitive bool

+ Value string

+ type PolicySetParameterCreateOptions struct

+ Category *CategoryType

+ ID string

+ Key *string

+ Sensitive *bool

+ Value *string

+ type PolicySetParameterList struct

+ Items []*PolicySetParameter

+ type PolicySetParameterListOptions struct

+ type PolicySetParameterUpdateOptions struct

+ ID string

+ Key *string

+ Sensitive *bool

+ 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, options PolicySetParameterListOptions) (*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 Variable

+ Description string

type VariableCreateOptions

+ Description *string

type VariableUpdateOptions

+ Description *string

Jan 13, 2020

Changes in this version

+ const OrganizationMembershipActive

+ const OrganizationMembershipInvited

type Client

+ OrganizationMemberships OrganizationMemberships

+ type OrganizationMembership struct

+ ID string

+ Organization *Organization

+ Status OrganizationMembershipStatus

+ Teams []*Team

+ User *User

+ type OrganizationMembershipCreateOptions struct

+ Email *string

+ ID string

+ type OrganizationMembershipList struct

+ Items []*OrganizationMembership

+ type OrganizationMembershipListOptions struct

+ Include string

+ type OrganizationMembershipReadOptions struct

+ Include string

+ type OrganizationMembershipStatus string

+ 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)

Dec 9, 2019

Changes in this version

type OAuthClientCreateOptions

+ PrivateKey *string

Nov 7, 2019

Changes in this version

type ServiceProviderType

+ const ServiceProviderAzureDevOpsServer

+ const ServiceProviderAzureDevOpsServices

+ const ServiceProviderBitbucketServerLegacy

Sep 27, 2019

Changes in this version

type WorkspaceCreateOptions

+ Operations *bool

type WorkspaceUpdateOptions

+ Operations *bool

Sep 16, 2019

Changes in this version

type CostEstimateStatus

+ const CostEstimatePending

type CostEstimateStatusTimestamps

+ PendingAt time.Time

Aug 15, 2019

Changes in this version

type Client

+ CostEstimates CostEstimates

+ type CostEstimate struct

+ DeltaMonthlyCost string

+ ErrorMessage string

+ ID string

+ MatchedResourcesCount string

+ PriorMonthlyCost string

+ ProposedMonthlyCost string

+ ResourcesCount string

+ Status CostEstimateStatus

+ StatusTimestamps *CostEstimateStatusTimestamps

+ UnmatchedResourcesCount string

+ type CostEstimateStatus string

+ const CostEstimateCanceled

+ const CostEstimateErrored

+ const CostEstimateFinished

+ const CostEstimateQueued

+ type CostEstimateStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ QueuedAt 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 Run

+ CostEstimate *CostEstimate

type Workspaces

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

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

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

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

Jun 26, 2019

Changes in this version

+ const PingEndpoint

Jun 18, 2019

Changes in this version

type PolicySet

+ PoliciesPath string

+ VCSRepo *VCSRepo

type PolicySetCreateOptions

+ PoliciesPath *string

+ VCSRepo *VCSRepoOptions

Jun 3, 2019

Changes in this version

type Client

+ PlanExports PlanExports

type Plan

+ Exports []*PlanExport

+ type PlanExport struct

+ DataType PlanExportDataType

+ ID string

+ Status PlanExportStatus

+ StatusTimestamps *PlanExportStatusTimestamps

+ type PlanExportCreateOptions struct

+ DataType *PlanExportDataType

+ ID string

+ Plan *Plan

+ 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 Workspace

+ FileTriggersEnabled bool

+ TriggerPrefixes []string

type WorkspaceCreateOptions

+ FileTriggersEnabled *bool

+ TriggerPrefixes []string

type WorkspaceUpdateOptions

+ FileTriggersEnabled *bool

+ TriggerPrefixes []string

Apr 24, 2019

Changes in this version

type Client

+ CostEstimations CostEstimations

+ type CostEstimation struct

+ ErrorMessage string

+ ID string

+ Status CostEstimationStatus

+ StatusTimestamps *CostEstimationStatusTimestamps

+ type CostEstimationStatus string

+ const CostEstimationCanceled

+ const CostEstimationErrored

+ const CostEstimationFinished

+ const CostEstimationQueued

+ type CostEstimationStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ QueuedAt time.Time

+ type CostEstimations interface

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

+ Read func(ctx context.Context, costEstimationID string) (*CostEstimation, error)

type Organization

+ CostEstimationEnabled bool

type OrganizationCreateOptions

+ CostEstimationEnabled *bool

type OrganizationUpdateOptions

+ CostEstimationEnabled *bool

type Run

+ CostEstimation *CostEstimation

type RunStatus

+ const RunCostEstimated

+ const RunCostEstimating

Apr 19, 2019

Changes in this version

type RunStatus

+ const RunApplyQueued

+ const RunPlanQueued

Mar 25, 2019

Changes in this version

+ type NotificationConfigurationListOptions struct

type StateVersionCreateOptions

+ Force *bool

Mar 22, 2019

Changes in this version

+ const NotificationTriggerApplying

+ const NotificationTriggerCompleted

+ const NotificationTriggerCreated

+ const NotificationTriggerErrored

+ const NotificationTriggerNeedsAttention

+ const NotificationTriggerPlanning

type Client

+ NotificationConfigurations NotificationConfigurations

+ type DeliveryResponse struct

+ Body string

+ Code int

+ Headers http.Header

+ SentAt time.Time

+ Successful bool

+ URL string

+ type NotificationConfiguration struct

+ CreatedAt time.Time

+ DeliveryResponses []*DeliveryResponse

+ DestinationType NotificationDestinationType

+ Enabled bool

+ ID string

+ Name string

+ Token string

+ Triggers []string

+ URL string

+ UpdatedAt time.Time

+ type NotificationConfigurationCreateOptions struct

+ DestinationType *NotificationDestinationType

+ Enabled *bool

+ ID string

+ Name *string

+ Token *string

+ Triggers []string

+ URL *string

+ type NotificationConfigurationList struct

+ Items []*NotificationConfiguration

+ type NotificationConfigurationUpdateOptions struct

+ Enabled *bool

+ ID string

+ Name *string

+ Token *string

+ Triggers []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 NotificationDestinationTypeGeneric

+ const NotificationDestinationTypeSlack

+ func NotificationDestination(v NotificationDestinationType) *NotificationDestinationType

Mar 6, 2019

Changes in this version

type Client

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

type Config

+ RetryLogHook RetryLogHook

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

Feb 25, 2019

Changes in this version

type WorkspacePermissions

+ CanForceUnlock bool

+ CanQueueApply bool

+ CanUnlock bool

Feb 21, 2019

Changes in this version

type Organization

+ OwnersTeamSAMLRoleID string

type OrganizationCreateOptions

+ CollaboratorAuthPolicy *AuthPolicyType

+ OwnersTeamSAMLRoleID *string

+ SessionRemember *int

+ SessionTimeout *int

type OrganizationUpdateOptions

+ OwnersTeamSAMLRoleID *string

type RunStatusTimestamps

+ AppliedAt time.Time

+ ApplyingAt time.Time

+ PlanQueuabledAt time.Time

+ PlannedAndFinishedAt time.Time

+ PlannedAt time.Time

+ PlanningAt time.Time

type Workspaces

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

Jan 28, 2019

Changes in this version

+ type OrganizationAccess struct

+ ManagePolicies bool

+ ManageVCSSettings bool

+ ManageWorkspaces bool

+ type OrganizationAccessOptions struct

+ ManagePolicies *bool

+ ManageVCSSettings *bool

+ ManageWorkspaces *bool

type Team

+ OrganizationAccess *OrganizationAccess

type TeamCreateOptions

+ OrganizationAccess *OrganizationAccessOptions

+ type TeamUpdateOptions struct

+ ID string

+ Name *string

+ OrganizationAccess *OrganizationAccessOptions

type Teams

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

Jan 15, 2019

Changes in this version

type AccessType

+ const AccessPlan

Dec 12, 2018

Changes in this version

type PolicyStatus

+ const PolicyCanceled

type Workspace

+ QueueAllRuns bool

type WorkspaceCreateOptions

+ QueueAllRuns *bool

type WorkspaceUpdateOptions

+ QueueAllRuns *bool

Dec 5, 2018

Changes in this version

+ type Entitlements struct

+ ID string

+ Operations bool

+ PrivateModuleRegistry bool

+ Sentinel bool

+ StateStorage bool

+ Teams bool

+ VCSIntegrations bool

type Organizations

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

Nov 30, 2018

Changes in this version

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

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

type Workspaces

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

Nov 20, 2018

Changes in this version

type Workspace

+ Operations bool

Nov 13, 2018

Changes in this version

+ type PolicySetAddWorkspacesOptions struct

+ Workspaces []*Workspace

+ type PolicySetRemoveWorkspacesOptions struct

+ Workspaces []*Workspace

type PolicySets

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

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

Nov 13, 2018

Changes in this version

type Client

+ PolicySets PolicySets

type Policy

+ Description string

+ Organization *Organization

+ PolicySetCount int

type PolicyCreateOptions

+ Description *string

type PolicyListOptions

+ Search *string

+ type PolicySet struct

+ CreatedAt time.Time

+ Description string

+ Global bool

+ ID string

+ Name string

+ Organization *Organization

+ Policies []*Policy

+ PolicyCount int

+ UpdatedAt time.Time

+ WorkspaceCount int

+ Workspaces []*Workspace

+ type PolicySetAddPoliciesOptions struct

+ Policies []*Policy

+ type PolicySetAttachToWorkspacesOptions struct

+ Workspaces []*Workspace

+ type PolicySetCreateOptions struct

+ Description *string

+ Global *bool

+ ID string

+ Name *string

+ Policies []*Policy

+ Workspaces []*Workspace

+ type PolicySetDetachFromWorkspacesOptions struct

+ Workspaces []*Workspace

+ type PolicySetList struct

+ Items []*PolicySet

+ type PolicySetListOptions struct

+ Search *string

+ type PolicySetRemovePoliciesOptions struct

+ Policies []*Policy

+ type PolicySetUpdateOptions struct

+ Description *string

+ Global *bool

+ ID string

+ Name *string

+ type PolicySets interface

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

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

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

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

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

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

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

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

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

type PolicyUpdateOptions

+ Description *string

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

Oct 15, 2018

Changes in this version

type Config

+ Headers http.Header

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

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

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)

Sep 8, 2018

Changes in this version

type WorkspaceListOptions

+ Search *string

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

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

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)

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)