tfe

package module

Go to main page

Versions in this module

v0

v0.14.2

Apr 12, 2021

Changes in this version

type AuditTrailList

+ Pagination struct{ ... }

v0.14.1

Apr 12, 2021

v0.14.0

Apr 12, 2021

Changes in this version

+ const AccessCustom

+ const AccessPlan

+ const NotificationTriggerApplying

+ const NotificationTriggerCompleted

+ const NotificationTriggerCreated

+ const NotificationTriggerErrored

+ const NotificationTriggerNeedsAttention

+ const NotificationTriggerPlanning

+ const OrganizationMembershipActive

+ const OrganizationMembershipInvited

+ const PingEndpoint

+ const RunsPermissionApply

+ const RunsPermissionPlan

+ const RunsPermissionRead

+ const SentinelMocksPermissionNone

+ const SentinelMocksPermissionRead

+ const StateVersionsPermissionNone

+ const StateVersionsPermissionRead

+ const StateVersionsPermissionReadOutputs

+ const StateVersionsPermissionWrite

+ const VariablesPermissionNone

+ const VariablesPermissionRead

+ const VariablesPermissionWrite

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

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

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

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

+ ID string

+ Name string

+ Organization *Organization

+ type AgentPoolCreateOptions struct

+ Name *string

+ Type string

+ type AgentPoolList struct

+ Items []*AgentPool

+ type AgentPoolListOptions struct

+ type AgentPoolUpdateOptions struct

+ Name *string

+ Type string

+ type AgentPools interface

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

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

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

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

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

+ type AgentToken struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type AgentTokenGenerateOptions struct

+ Description *string

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

+ type AuditTrailAuthType string

+ const AuditTrailAuthTypeClient

+ const AuditTrailAuthTypeImpersonated

+ const AuditTrailAuthTypeSystem

+ type AuditTrailList struct

+ Data []*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 CategoryType

+ const CategoryPolicySet

type Client

+ Admin Admin

+ AgentPools AgentPools

+ AgentTokens AgentTokens

+ AuditTrails AuditTrails

+ CostEstimates CostEstimates

+ Meta Meta

+ NotificationConfigurations NotificationConfigurations

+ OrganizationMemberships OrganizationMemberships

+ PlanExports PlanExports

+ PolicySetParameters PolicySetParameters

+ PolicySets PolicySets

+ RegistryModules RegistryModules

+ RunTriggers RunTriggers

+ StateVersionOutputs StateVersionOutputs

+ UserTokens UserTokens

+ func (c *Client) RemoteAPIVersion() string

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

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

type Config

+ RetryLogHook RetryLogHook

type ConfigurationVersionCreateOptions

+ Type string

+ type CostEstimate struct

+ DeltaMonthlyCost string

+ ErrorMessage string

+ ID string

+ MatchedResourcesCount int

+ PriorMonthlyCost string

+ ProposedMonthlyCost string

+ ResourcesCount int

+ Status CostEstimateStatus

+ StatusTimestamps *CostEstimateStatusTimestamps

+ UnmatchedResourcesCount int

+ type CostEstimateStatus string

+ const CostEstimateCanceled

+ const CostEstimateErrored

+ const CostEstimateFinished

+ const CostEstimatePending

+ const CostEstimateQueued

+ const CostEstimateSkippedDueToTargeting

+ type CostEstimateStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ PendingAt time.Time

+ QueuedAt time.Time

+ SkippedDueToTargetingAt time.Time

+ type CostEstimates interface

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

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

+ type CostEstimationSettings interface

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

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

+ type CustomizationSettings interface

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

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

+ type DeliveryResponse struct

+ Body string

+ Code int

+ Headers http.Header

+ SentAt time.Time

+ Successful bool

+ URL string

+ type Entitlements struct

+ Agents bool

+ AuditLogging bool

+ CostEstimation bool

+ ID string

+ Operations bool

+ PrivateModuleRegistry bool

+ SSO bool

+ Sentinel bool

+ StateStorage bool

+ Teams bool

+ VCSIntegrations bool

+ type GeneralSettings interface

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

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

+ type IPRange struct

+ API []string

+ Notifications []string

+ Sentinel []string

+ VCS []string

+ type IPRanges interface

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

+ type Meta struct

+ IPRanges IPRanges

+ type NotificationConfiguration struct

+ CreatedAt time.Time

+ DeliveryResponses []*DeliveryResponse

+ DestinationType NotificationDestinationType

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled bool

+ ID string

+ Name string

+ Subscribable *Workspace

+ Token string

+ Triggers []string

+ URL string

+ UpdatedAt time.Time

+ type NotificationConfigurationCreateOptions struct

+ DestinationType *NotificationDestinationType

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled *bool

+ Name *string

+ Token *string

+ Triggers []string

+ Type string

+ URL *string

+ type NotificationConfigurationList struct

+ Items []*NotificationConfiguration

+ type NotificationConfigurationListOptions struct

+ type NotificationConfigurationUpdateOptions struct

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled *bool

+ Name *string

+ Token *string

+ Triggers []string

+ Type string

+ URL *string

+ type NotificationConfigurations interface

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

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

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

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

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

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

+ type NotificationDestinationType string

+ const NotificationDestinationTypeEmail

+ const NotificationDestinationTypeGeneric

+ const NotificationDestinationTypeSlack

+ func NotificationDestination(v NotificationDestinationType) *NotificationDestinationType

type OAuthClientCreateOptions

+ PrivateKey *string

+ Type string

type OAuthTokenUpdateOptions

+ Type string

type Organization

+ CostEstimationEnabled bool

+ ExternalID string

+ OwnersTeamSAMLRoleID string

+ type OrganizationAccess struct

+ ManagePolicies bool

+ ManageVCSSettings bool

+ ManageWorkspaces bool

+ type OrganizationAccessOptions struct

+ ManagePolicies *bool

+ ManageVCSSettings *bool

+ ManageWorkspaces *bool

type OrganizationCreateOptions

+ CollaboratorAuthPolicy *AuthPolicyType

+ CostEstimationEnabled *bool

+ OwnersTeamSAMLRoleID *string

+ SessionRemember *int

+ SessionTimeout *int

+ Type string

+ type OrganizationMembership struct

+ Email string

+ ID string

+ Organization *Organization

+ Status OrganizationMembershipStatus

+ Teams []*Team

+ User *User

+ type OrganizationMembershipCreateOptions struct

+ Email *string

+ Type string

+ type OrganizationMembershipList struct

+ Items []*OrganizationMembership

+ type OrganizationMembershipListOptions struct

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

type OrganizationUpdateOptions

+ CostEstimationEnabled *bool

+ OwnersTeamSAMLRoleID *string

+ Type string

type Organizations

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

type Plan

+ Exports []*PlanExport

+ type PlanExport struct

+ DataType PlanExportDataType

+ ID string

+ Status PlanExportStatus

+ StatusTimestamps *PlanExportStatusTimestamps

+ type PlanExportCreateOptions struct

+ DataType *PlanExportDataType

+ Plan *Plan

+ Type string

+ type PlanExportDataType string

+ const PlanExportSentinelMockBundleV0

+ func PlanExportType(v PlanExportDataType) *PlanExportDataType

+ type PlanExportStatus string

+ const PlanExportCanceled

+ const PlanExportErrored

+ const PlanExportExpired

+ const PlanExportFinished

+ const PlanExportPending

+ const PlanExportQueued

+ type PlanExportStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ ExpiredAt time.Time

+ FinishedAt time.Time

+ QueuedAt time.Time

+ type PlanExports interface

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

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

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

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

type Policy

+ Description string

+ Organization *Organization

+ PolicySetCount int

type PolicyCheck

+ Run *Run

type PolicyCreateOptions

+ Description *string

+ Type string

type PolicyListOptions

+ Search *string

+ type PolicySet struct

+ CreatedAt time.Time

+ Description string

+ Global bool

+ ID string

+ Name string

+ Organization *Organization

+ Policies []*Policy

+ PoliciesPath string

+ PolicyCount int

+ UpdatedAt time.Time

+ VCSRepo *VCSRepo

+ WorkspaceCount int

+ Workspaces []*Workspace

+ type PolicySetAddPoliciesOptions struct

+ Policies []*Policy

+ type PolicySetAddWorkspacesOptions struct

+ Workspaces []*Workspace

+ type PolicySetCreateOptions struct

+ Description *string

+ Global *bool

+ Name *string

+ Policies []*Policy

+ PoliciesPath *string

+ Type string

+ VCSRepo *VCSRepoOptions

+ Workspaces []*Workspace

+ type PolicySetList struct

+ Items []*PolicySet

+ type PolicySetListOptions struct

+ Search *string

+ type PolicySetParameter struct

+ Category CategoryType

+ ID string

+ Key string

+ PolicySet *PolicySet

+ Sensitive bool

+ Value string

+ type PolicySetParameterCreateOptions struct

+ Category *CategoryType

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type PolicySetParameterList struct

+ Items []*PolicySetParameter

+ type PolicySetParameterListOptions struct

+ type PolicySetParameterUpdateOptions struct

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type PolicySetParameters interface

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

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

+ List func(ctx context.Context, policySetID string, 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 PolicySetRemovePoliciesOptions struct

+ Policies []*Policy

+ type PolicySetRemoveWorkspacesOptions struct

+ Workspaces []*Workspace

+ type PolicySetUpdateOptions struct

+ Description *string

+ Global *bool

+ Name *string

+ PoliciesPath *string

+ Type string

+ VCSRepo *VCSRepoOptions

+ type PolicySets interface

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

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

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

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

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

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

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

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

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

type PolicyStatus

+ const PolicyCanceled

type PolicyUpdateOptions

+ Description *string

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

+ Name *string

+ Provider *string

+ Type string

+ type RegistryModuleCreateVersionOptions struct

+ Type string

+ Version *string

+ type RegistryModuleCreateWithVCSConnectionOptions struct

+ ID string

+ 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 RetryLogHook func(attemptNum int, resp *http.Response)

type Run

+ CostEstimate *CostEstimate

+ CreatedBy *User

+ TargetAddrs []string

type RunCreateOptions

+ TargetAddrs []string

+ Type string

type RunListOptions

+ Include *string

+ type RunReadOptions struct

+ Include string

type RunStatus

+ const RunApplyQueued

+ const RunCostEstimated

+ const RunCostEstimating

+ const RunPlanQueued

type RunStatusTimestamps

+ AppliedAt time.Time

+ ApplyingAt time.Time

+ PlanQueuabledAt time.Time

+ PlannedAndFinishedAt time.Time

+ PlannedAt time.Time

+ PlanningAt time.Time

+ type RunTrigger struct

+ CreatedAt time.Time

+ ID string

+ Sourceable *Workspace

+ SourceableName string

+ Workspace *Workspace

+ WorkspaceName string

+ type RunTriggerCreateOptions struct

+ Sourceable *Workspace

+ Type string

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

type Runs

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

+ type RunsPermissionType string

+ func RunsPermission(v RunsPermissionType) *RunsPermissionType

+ type SAMLSettings interface

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

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

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

+ type SMTPAuthType string

+ const SMTPAuthLogin

+ const SMTPAuthNone

+ const SMTPAuthPlain

+ func SMTPAuthValue(v SMTPAuthType) *SMTPAuthType

+ type SMTPSettings interface

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

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

type SSHKeyCreateOptions

+ Type string

+ type SentinelMocksPermissionType string

+ func SentinelMocksPermission(v SentinelMocksPermissionType) *SentinelMocksPermissionType

type ServiceProviderType

+ const ServiceProviderAzureDevOpsServer

+ const ServiceProviderAzureDevOpsServices

+ const ServiceProviderBitbucketServerLegacy

type StateVersion

+ Outputs []*StateVersionOutput

type StateVersionCreateOptions

+ Force *bool

+ Type string

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

+ func StateVersionsPermission(v StateVersionsPermissionType) *StateVersionsPermissionType

type Team

+ OrganizationAccess *OrganizationAccess

+ OrganizationMemberships []*OrganizationMembership

+ Visibility string

type TeamAccess

+ Runs RunsPermissionType

+ SentinelMocks SentinelMocksPermissionType

+ StateVersions StateVersionsPermissionType

+ Variables VariablesPermissionType

+ WorkspaceLocking bool

type TeamAccessAddOptions

+ Runs *RunsPermissionType

+ SentinelMocks *SentinelMocksPermissionType

+ StateVersions *StateVersionsPermissionType

+ Type string

+ Variables *VariablesPermissionType

+ WorkspaceLocking *bool

+ type TeamAccessUpdateOptions struct

+ Access *AccessType

+ Runs *RunsPermissionType

+ SentinelMocks *SentinelMocksPermissionType

+ StateVersions *StateVersionsPermissionType

+ Type string

+ Variables *VariablesPermissionType

+ WorkspaceLocking *bool

type TeamAccesses

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

type TeamCreateOptions

+ OrganizationAccess *OrganizationAccessOptions

+ Type string

+ Visibility *string

type TeamListOptions

+ Include string

type TeamMemberAddOptions

+ OrganizationMembershipIDs []string

type TeamMemberRemoveOptions

+ OrganizationMembershipIDs []string

type TeamMembers

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

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

+ type TeamUpdateOptions struct

+ Name *string

+ OrganizationAccess *OrganizationAccessOptions

+ Type string

+ Visibility *string

type Teams

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

+ type TestAccountDetails struct

+ Email string

+ ID string

+ Username string

+ func FetchTestAccountDetails(t *testing.T, client *Client) *TestAccountDetails

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

type UserUpdateOptions

+ Type string

type VCSRepo

+ DisplayIdentifier string

+ RepositoryHTTPURL string

+ ServiceProvider string

type Variable

+ Description string

type VariableCreateOptions

+ Description *string

+ Type string

type VariableUpdateOptions

+ Description *string

+ Type string

+ type VariablesPermissionType string

+ func VariablesPermission(v VariablesPermissionType) *VariablesPermissionType

type Workspace

+ AgentPool *AgentPool

+ AgentPoolID string

+ AllowDestroyPlan bool

+ ApplyDurationAverage time.Duration

+ Description string

+ ExecutionMode string

+ FileTriggersEnabled bool

+ Operations bool

+ PlanDurationAverage time.Duration

+ PolicyCheckFailures int

+ QueueAllRuns bool

+ ResourceCount int

+ RunFailures int

+ RunsCount int

+ SpeculativeEnabled bool

+ TriggerPrefixes []string

+ UpdatedAt time.Time

type WorkspaceAssignSSHKeyOptions

+ Type string

type WorkspaceCreateOptions

+ AgentPoolID *string

+ AllowDestroyPlan *bool

+ Description *string

+ ExecutionMode *string

+ FileTriggersEnabled *bool

+ Operations *bool

+ QueueAllRuns *bool

+ SpeculativeEnabled *bool

+ TriggerPrefixes []string

+ Type string

type WorkspaceListOptions

+ Include *string

+ type WorkspaceLockingPermissionType bool

type WorkspacePermissions

+ CanForceUnlock bool

+ CanQueueApply bool

+ CanUnlock bool

type WorkspaceUpdateOptions

+ AgentPoolID *string

+ AllowDestroyPlan *bool

+ Description *string

+ ExecutionMode *string

+ FileTriggersEnabled *bool

+ Operations *bool

+ QueueAllRuns *bool

+ SpeculativeEnabled *bool

+ TriggerPrefixes []string

+ Type string

type Workspaces

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

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

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

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

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

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

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

v0.2.6

Oct 23, 2018

Changes in this version

type ApplyStatus

+ const ApplyUnreachable

type PlanStatus

+ const PlanUnreachable

type PolicyStatus

+ const PolicyUnreachable

type RunStatus

+ const RunPlannedAndFinished

+ const RunPolicySoftFailed

v0.2.5

Oct 15, 2018

Changes in this version

type Config

+ Headers http.Header

v0.2.4

Oct 11, 2018

Changes in this version

+ type Capacity struct

+ Organization string

+ Pending int

+ Running int

type Organizations

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

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

type Run

+ ForceCancelAvailableAt time.Time

+ PositionInQueue int

type RunActions

+ IsForceCancelable bool

+ type RunForceCancelOptions struct

+ Comment *string

type RunPermissions

+ CanForceCancel bool

+ type RunQueue struct

+ Items []*Run

+ type RunQueueOptions struct

type Runs

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

type Workspace

+ CurrentRun *Run

v0.2.3

Sep 20, 2018

Changes in this version

+ type Applies interface

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

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

+ type Apply struct

+ ID string

+ LogReadURL string

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

+ Status ApplyStatus

+ StatusTimestamps *ApplyStatusTimestamps

+ type ApplyStatus string

+ const ApplyCanceled

+ const ApplyCreated

+ const ApplyErrored

+ const ApplyFinished

+ const ApplyMFAWaiting

+ const ApplyPending

+ const ApplyQueued

+ const ApplyRunning

+ type ApplyStatusTimestamps struct

+ CanceledAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ ForceCanceledAt time.Time

+ QueuedAt time.Time

+ StartedAt time.Time

type Client

+ Applies Applies

type Plan

+ ResourceAdditions int

+ ResourceChanges int

+ ResourceDestructions int

type PlanStatusTimestamps

+ ForceCanceledAt time.Time

+ StartedAt time.Time

type PolicyChecks

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

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

type Run

+ Apply *Apply

+ PolicyChecks []*PolicyCheck

type RunActions

+ IsConfirmable bool

v0.2.2

Sep 14, 2018

Changes in this version

type OAuthClient

+ OAuthTokens []*OAuthToken

type OAuthClientCreateOptions

+ OAuthToken *string

+ type OAuthClientList struct

+ Items []*OAuthClient

+ type OAuthClientListOptions struct

type OAuthClients

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

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

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

+ type OAuthTokenUpdateOptions struct

+ ID string

+ PrivateSSHKey *string

type OAuthTokens

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

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

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

type Variables

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

v0.2.1

Sep 8, 2018

Changes in this version

type WorkspaceListOptions

+ Search *string

v0.2.0

Sep 7, 2018

Changes in this version

+ type ConfigurationVersionList struct

+ Items []*ConfigurationVersion

+ type OAuthTokenList struct

+ Items []*OAuthToken

+ type OAuthTokenListOptions struct

+ type OrganizationList struct

+ Items []*Organization

+ type Pagination struct

+ CurrentPage int

+ NextPage int

+ PreviousPage int

+ TotalCount int

+ TotalPages int

+ type PolicyCheckList struct

+ Items []*PolicyCheck

+ type PolicyList struct

+ Items []*Policy

+ type RunList struct

+ Items []*Run

+ type SSHKeyList struct

+ Items []*SSHKey

type StateVersionCreateOptions

+ Run *Run

+ type StateVersionList struct

+ Items []*StateVersion

+ type TeamAccessList struct

+ Items []*TeamAccess

+ type TeamList struct

+ Items []*Team

+ type VariableList struct

+ Items []*Variable

+ type WorkspaceList struct

+ Items []*Workspace

v0.1.2

Aug 9, 2018

Changes in this version

+ func Int(v int) *int

+ type AccessType string

+ const AccessAdmin

+ const AccessRead

+ const AccessWrite

type OrganizationTokens

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

type Policies

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

type Team

+ Users []*User

type TeamMembers

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

type TeamTokens

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

type VCSRepo

+ IngressSubmodules bool

type VCSRepoOptions

+ IngressSubmodules *bool

v0.1.1

Aug 1, 2018

Changes in this version

type Client

+ Plans Plans

type ConfigurationVersion

+ Speculative bool

type ConfigurationVersionCreateOptions

+ Speculative *bool

+ type LogReader struct

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

+ type Plan struct

+ HasChanges bool

+ ID string

+ LogReadURL string

+ Status PlanStatus

+ StatusTimestamps *PlanStatusTimestamps

+ type PlanStatus string

+ const PlanCanceled

+ const PlanCreated

+ const PlanErrored

+ const PlanFinished

+ const PlanMFAWaiting

+ const PlanPending

+ const PlanQueued

+ const PlanRunning

+ type PlanStatusTimestamps struct

+ CanceledAt time.Time

+ CreatedAt time.Time

+ ErroredAt time.Time

+ FinishedAt time.Time

+ MFAWaitingAt time.Time

+ PendingAt time.Time

+ QueuedAt time.Time

+ RunningAt time.Time

+ type Plans interface

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

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

type Run

+ Plan *Plan

type StateVersions

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

v0.1.0

Jul 13, 2018

Changes in this version

+ const DefaultAddress

+ const DefaultBasePath

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

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

+ func Bool(v bool) *bool

+ func Int64(v int64) *int64

+ func String(v string) *string

+ type AuthPolicyType string

+ const AuthPolicyPassword

+ const AuthPolicyTwoFactor

+ func AuthPolicy(v AuthPolicyType) *AuthPolicyType

+ type CVStatusTimestamps struct

+ FinishedAt time.Time

+ QueuedAt time.Time

+ StartedAt time.Time

+ type CategoryType string

+ const CategoryEnv

+ const CategoryTerraform

+ func Category(v CategoryType) *CategoryType

+ type Client struct

+ ConfigurationVersions *ConfigurationVersions

+ OAuthClients *OAuthClients

+ OAuthTokens *OAuthTokens

+ OrganizationTokens *OrganizationTokens

+ Organizations *Organizations

+ Policies *Policies

+ PolicyChecks *PolicyChecks

+ Runs *Runs

+ SSHKeys *SSHKeys

+ StateVersions *StateVersions

+ TeamAccess *TeamAccesses

+ TeamMembers *TeamMembers

+ TeamTokens *TeamTokens

+ Teams *Teams

+ Users *Users

+ Variables *Variables

+ Workspaces *Workspaces

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

+ type Config struct

+ Address string

+ BasePath string

+ HTTPClient *http.Client

+ Token string

+ func DefaultConfig() *Config

+ type ConfigurationSource string

+ const ConfigurationSourceAPI

+ const ConfigurationSourceBitbucket

+ const ConfigurationSourceGithub

+ const ConfigurationSourceGitlab

+ const ConfigurationSourceTerraform

+ type ConfigurationStatus string

+ const ConfigurationErrored

+ const ConfigurationPending

+ const ConfigurationUploaded

+ type ConfigurationVersion struct

+ AutoQueueRuns bool

+ Error string

+ ErrorMessage string

+ ID string

+ Source ConfigurationSource

+ Status ConfigurationStatus

+ StatusTimestamps *CVStatusTimestamps

+ UploadURL string

+ type ConfigurationVersionCreateOptions struct

+ AutoQueueRuns *bool

+ ID string

+ type ConfigurationVersionListOptions struct

+ type ConfigurationVersions struct

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

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

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

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

+ type Enforcement struct

+ Mode EnforcementLevel

+ Path string

+ type EnforcementLevel string

+ const EnforcementAdvisory

+ const EnforcementHard

+ const EnforcementSoft

+ func EnforcementMode(v EnforcementLevel) *EnforcementLevel

+ type EnforcementOptions struct

+ Mode *EnforcementLevel

+ Path *string

+ type EnterprisePlanType string

+ const EnterprisePlanDisabled

+ const EnterprisePlanPremium

+ const EnterprisePlanPro

+ const EnterprisePlanTrial

+ type ListOptions struct

+ PageNumber int

+ PageSize int

+ type OAuthClient struct

+ APIURL string

+ CallbackURL string

+ ConnectPath string

+ CreatedAt time.Time

+ HTTPURL string

+ ID string

+ Key string

+ OAuthToken []*OAuthToken

+ Organization *Organization

+ RSAPublicKey string

+ ServiceProvider ServiceProviderType

+ ServiceProviderName string

+ type OAuthClientCreateOptions struct

+ APIURL *string

+ HTTPURL *string

+ ID string

+ Key *string

+ Secret *string

+ ServiceProvider *ServiceProviderType

+ type OAuthClients struct

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

+ type OAuthToken struct

+ CreatedAt time.Time

+ HasSSHKey bool

+ ID string

+ OAuthClient *OAuthClient

+ ServiceProviderUser string

+ UID string

+ type OAuthTokens struct

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

+ type Organization struct

+ CollaboratorAuthPolicy AuthPolicyType

+ CreatedAt time.Time

+ Email string

+ EnterprisePlan EnterprisePlanType

+ Name string

+ OwnersTeamSamlRoleID string

+ Permissions *OrganizationPermissions

+ SAMLEnabled bool

+ SessionRemember int

+ SessionTimeout int

+ TrialExpiresAt time.Time

+ TwoFactorConformant bool

+ type OrganizationCreateOptions struct

+ Email *string

+ ID string

+ Name *string

+ type OrganizationListOptions struct

+ type OrganizationPermissions struct

+ CanCreateTeam bool

+ CanCreateWorkspace bool

+ CanCreateWorkspaceMigration bool

+ CanDestroy bool

+ CanTraverse bool

+ CanUpdate bool

+ CanUpdateAPIToken bool

+ CanUpdateOAuth bool

+ CanUpdateSentinel bool

+ type OrganizationToken struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type OrganizationTokens struct

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

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

+ type OrganizationUpdateOptions struct

+ CollaboratorAuthPolicy *AuthPolicyType

+ Email *string

+ ID string

+ Name *string

+ SessionRemember *int

+ SessionTimeout *int

+ type Organizations struct

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

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

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

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

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

+ type Policies struct

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

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

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

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

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

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

+ type Policy struct

+ Enforce []*Enforcement

+ ID string

+ Name string

+ UpdatedAt time.Time

+ type PolicyActions struct

+ IsOverridable bool

+ type PolicyCheck struct

+ Actions *PolicyActions

+ ID string

+ Permissions *PolicyPermissions

+ Result *PolicyResult

+ Scope PolicyScope

+ Status PolicyStatus

+ StatusTimestamps *PolicyStatusTimestamps

+ type PolicyCheckListOptions struct

+ type PolicyChecks struct

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

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

+ type PolicyCreateOptions struct

+ Enforce []*EnforcementOptions

+ ID string

+ Name *string

+ type PolicyListOptions struct

+ type PolicyPermissions struct

+ CanOverride bool

+ type PolicyResult struct

+ AdvisoryFailed int

+ Duration int

+ HardFailed int

+ Passed int

+ Result bool

+ SoftFailed int

+ TotalFailed int

+ type PolicyScope string

+ const PolicyScopeOrganization

+ const PolicyScopeWorkspace

+ type PolicyStatus string

+ const PolicyErrored

+ const PolicyHardFailed

+ const PolicyOverridden

+ const PolicyPasses

+ const PolicyPending

+ const PolicyQueued

+ const PolicySoftFailed

+ type PolicyStatusTimestamps struct

+ ErroredAt time.Time

+ HardFailedAt time.Time

+ PassedAt time.Time

+ QueuedAt time.Time

+ SoftFailedAt time.Time

+ type PolicyUpdateOptions struct

+ Enforce []*EnforcementOptions

+ ID string

+ type Run struct

+ Actions *RunActions

+ ConfigurationVersion *ConfigurationVersion

+ CreatedAt time.Time

+ HasChanges bool

+ ID string

+ IsDestroy bool

+ Message string

+ Permissions *RunPermissions

+ Source RunSource

+ Status RunStatus

+ StatusTimestamps *RunStatusTimestamps

+ Workspace *Workspace

+ type RunActions struct

+ IsCancelable bool

+ IsComfirmable bool

+ IsDiscardable bool

+ type RunApplyOptions struct

+ Comment *string

+ type RunCancelOptions struct

+ Comment *string

+ type RunCreateOptions struct

+ ConfigurationVersion *ConfigurationVersion

+ ID string

+ IsDestroy *bool

+ Message *string

+ Workspace *Workspace

+ type RunDiscardOptions struct

+ Comment *string

+ type RunListOptions struct

+ type RunPermissions struct

+ CanApply bool

+ CanCancel bool

+ CanDiscard bool

+ CanForceExecute bool

+ type RunSource string

+ const RunSourceAPI

+ const RunSourceConfigurationVersion

+ const RunSourceUI

+ type RunStatus string

+ const RunApplied

+ const RunApplying

+ const RunCanceled

+ const RunConfirmed

+ const RunDiscarded

+ const RunErrored

+ const RunPending

+ const RunPlanned

+ const RunPlanning

+ const RunPolicyChecked

+ const RunPolicyChecking

+ const RunPolicyOverride

+ type RunStatusTimestamps struct

+ ErroredAt time.Time

+ FinishedAt time.Time

+ QueuedAt time.Time

+ StartedAt time.Time

+ type Runs struct

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

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

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

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

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

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

+ type SSHKey struct

+ ID string

+ Name string

+ type SSHKeyCreateOptions struct

+ ID string

+ Name *string

+ Value *string

+ type SSHKeyListOptions struct

+ type SSHKeyUpdateOptions struct

+ ID string

+ Name *string

+ Value *string

+ type SSHKeys struct

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

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

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

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

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

+ type ServiceProviderType string

+ const ServiceProviderBitbucket

+ const ServiceProviderBitbucketServer

+ const ServiceProviderGithub

+ const ServiceProviderGithubEE

+ const ServiceProviderGitlab

+ const ServiceProviderGitlabCE

+ const ServiceProviderGitlabEE

+ func ServiceProvider(v ServiceProviderType) *ServiceProviderType

+ type StateVersion struct

+ CreatedAt time.Time

+ DownloadURL string

+ ID string

+ Run *Run

+ Serial int

+ VCSCommitSHA string

+ VCSCommitURL string

+ type StateVersionCreateOptions struct

+ ID string

+ Lineage *string

+ MD5 *string

+ Serial *int64

+ State *string

+ type StateVersionListOptions struct

+ Organization *string

+ Workspace *string

+ type StateVersions struct

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

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

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

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

+ type Team struct

+ ID string

+ Name string

+ Permissions *TeamPermissions

+ UserCount int

+ type TeamAccess struct

+ Access TeamAccessType

+ ID string

+ Team *Team

+ Workspace *Workspace

+ type TeamAccessAddOptions struct

+ Access *TeamAccessType

+ ID string

+ Team *Team

+ Workspace *Workspace

+ type TeamAccessListOptions struct

+ WorkspaceID *string

+ type TeamAccessType string

+ const TeamAccessAdmin

+ const TeamAccessRead

+ const TeamAccessWrite

+ func Access(v TeamAccessType) *TeamAccessType

+ type TeamAccesses struct

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

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

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

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

+ type TeamCreateOptions struct

+ ID string

+ Name *string

+ type TeamListOptions struct

+ type TeamMemberAddOptions struct

+ Usernames []string

+ type TeamMemberRemoveOptions struct

+ Usernames []string

+ type TeamMembers struct

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

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

+ type TeamPermissions struct

+ CanDestroy bool

+ CanUpdateMembership bool

+ type TeamToken struct

+ CreatedAt time.Time

+ Description string

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type TeamTokens struct

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

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

+ type Teams struct

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

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

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

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

+ type TwoFactor struct

+ Enabled bool

+ Verified bool

+ type User struct

+ AvatarURL string

+ Email string

+ ID string

+ IsServiceAccount bool

+ TwoFactor *TwoFactor

+ UnconfirmedEmail string

+ Username string

+ V2Only bool

+ type UserUpdateOptions struct

+ Email *string

+ ID string

+ Username *string

+ type Users struct

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

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

+ type VCSRepo struct

+ Branch string

+ Identifier string

+ IncludeSubmodules bool

+ OAuthTokenID string

+ type VCSRepoOptions struct

+ Branch *string

+ Identifier *string

+ IncludeSubmodules *bool

+ OAuthTokenID *string

+ type Variable struct

+ Category CategoryType

+ HCL bool

+ ID string

+ Key string

+ Sensitive bool

+ Value string

+ Workspace *Workspace

+ type VariableCreateOptions struct

+ Category *CategoryType

+ HCL *bool

+ ID string

+ Key *string

+ Sensitive *bool

+ Value *string

+ Workspace *Workspace

+ type VariableListOptions struct

+ Organization *string

+ Workspace *string

+ type VariableUpdateOptions struct

+ Category *CategoryType

+ HCL *bool

+ ID string

+ Key *string

+ Sensitive *bool

+ Value *string

+ type Variables struct

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

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

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

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

+ type Workspace struct

+ Actions *WorkspaceActions

+ AutoApply bool

+ CanQueueDestroyPlan bool

+ CreatedAt time.Time

+ Environment string

+ ID string

+ Locked bool

+ MigrationEnvironment string

+ Name string

+ Organization *Organization

+ Permissions *WorkspacePermissions

+ SSHKey *SSHKey

+ TerraformVersion string

+ VCSRepo *VCSRepo

+ WorkingDirectory string

+ type WorkspaceActions struct

+ IsDestroyable bool

+ type WorkspaceAssignSSHKeyOptions struct

+ ID string

+ SSHKeyID *string

+ type WorkspaceCreateOptions struct

+ AutoApply *bool

+ ID string

+ MigrationEnvironment *string

+ Name *string

+ TerraformVersion *string

+ VCSRepo *VCSRepoOptions

+ WorkingDirectory *string

+ type WorkspaceListOptions struct

+ type WorkspaceLockOptions struct

+ Reason *string

+ type WorkspacePermissions struct

+ CanDestroy bool

+ CanLock bool

+ CanQueueDestroy bool

+ CanQueueRun bool

+ CanReadSettings bool

+ CanUpdate bool

+ CanUpdateVariable bool

+ type WorkspaceUpdateOptions struct

+ AutoApply *bool

+ ID string

+ Name *string

+ TerraformVersion *string

+ VCSRepo *VCSRepoOptions

+ WorkingDirectory *string

+ type Workspaces struct

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

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

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

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

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

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

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

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

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

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