types

package

Go to main page

Versions in this module

v0

v0.3.6

Nov 22, 2024

Changes in this version

type Tag

+ func (t *Tag) UnmarshalID(id string) error

v0.3.5

Oct 30, 2024

v0.3.4

Oct 30, 2024

v0.3.3

Oct 23, 2024

v0.3.2

Oct 22, 2024

v0.3.1

Oct 22, 2024

v0.3.0

Oct 22, 2024

v0.2.4

Dec 16, 2023

v0.2.3

Dec 12, 2023

v0.2.2

Dec 11, 2023

v0.2.1

Dec 7, 2023

v0.2.0

Dec 5, 2023

Changes in this version

+ type AgentPool struct

+ AgentCount int

+ AllowedWorkspaces []*Workspace

+ ID string

+ Name string

+ Organization *Organization

+ OrganizationScoped bool

+ Workspaces []*Workspace

+ type AgentPoolCreateOptions struct

+ AllowedWorkspaces []*Workspace

+ Name *string

+ OrganizationScoped *bool

+ Type string

+ type AgentPoolListOptions struct

+ AllowedWorkspacesName *string

+ Query *string

+ type AgentPoolUpdateOptions struct

+ AllowedWorkspaces []*Workspace

+ Name *string

+ OrganizationScoped *bool

+ Type string

type AgentToken

+ CreatedAt time.Time

+ Description string

+ LastUsedAt time.Time

+ Token string

v0.1.18

Oct 30, 2023

v0.1.17

Oct 29, 2023

v0.1.16

Oct 27, 2023

v0.1.15

Oct 27, 2023

Changes in this version

type StateVersion

+ JSONUploadURL string

+ Status StateVersionStatus

+ UploadURL string

+ type StateVersionStatus string

+ const StateVersionDiscarded

+ const StateVersionFinalized

+ const StateVersionPending

+ type TeamToken struct

+ CreatedAt time.Time

+ Description string

+ ExpiredAt *time.Time

+ ID string

+ LastUsedAt time.Time

+ Token string

+ type TeamTokenCreateOptions struct

+ ExpiredAt *time.Time

v0.1.14

Oct 20, 2023

Changes in this version

type Organization

+ RemainingTestableCount int

v0.1.13

Sep 13, 2023

v0.1.12

Sep 12, 2023

Changes in this version

+ type WorkspaceOutput struct

+ ID string

+ Name string

+ Sensitive bool

+ Type string

+ Value any

v0.1.11

Sep 11, 2023

v0.1.10

Sep 6, 2023

v0.1.9

Sep 2, 2023

Changes in this version

+ const DefaultPageSize

+ const MaxPageSize

+ var DefaultOrganizationPermissions = OrganizationPermissions

+ type AgentToken struct

+ ID string

+ Organization string

+ type AgentTokenCreateOptions struct

+ Description string

+ Organization string

+ Type string

+ type Apply struct

+ ID string

+ LogReadURL string

+ Status string

+ StatusTimestamps *PhaseStatusTimestamps

+ type AuthPolicyType string

+ const AuthPolicyPassword

+ const AuthPolicyTwoFactor

+ type CVStatusTimestamps struct

+ FinishedAt *time.Time

+ QueuedAt *time.Time

+ StartedAt *time.Time

+ type ConfigurationVersion struct

+ AutoQueueRuns bool

+ Error string

+ ErrorMessage string

+ ID string

+ IngressAttributes *IngressAttributes

+ Source string

+ Speculative bool

+ Status string

+ StatusTimestamps *CVStatusTimestamps

+ UploadURL string

+ type ConfigurationVersionCreateOptions struct

+ AutoQueueRuns *bool

+ Speculative *bool

+ Type string

+ type ConfigurationVersionList struct

+ Items []*ConfigurationVersion

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

+ Organization *string

+ RunID *string

+ Type string

+ type CreateUserOptions struct

+ Type string

+ Username *string

+ type DeliveryResponse struct

+ Body string

+ Code string

+ Headers map[string][]string

+ SentAt time.Time

+ Successful string

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

+ Branch string

+ CloneURL string

+ CommitMessage string

+ CommitSHA string

+ CommitURL string

+ CompareURL string

+ ID string

+ Identifier string

+ IsPullRequest bool

+ OnDefaultBranch bool

+ PullRequestBody string

+ PullRequestNumber int

+ PullRequestTitle string

+ PullRequestURL string

+ SenderAvatarURL string

+ SenderHTMLURL string

+ SenderUsername string

+ Tag string

+ type ListOptions struct

+ PageNumber int

+ PageSize int

+ type NotificationConfiguration struct

+ CreatedAt time.Time

+ DeliveryResponses []*DeliveryResponse

+ DestinationType NotificationDestinationType

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled bool

+ ID string

+ Name string

+ Subscribable *Workspace

+ Token string

+ Triggers []string

+ URL string

+ UpdatedAt time.Time

+ type NotificationConfigurationCreateOptions struct

+ DestinationType *NotificationDestinationType

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled *bool

+ Name *string

+ Token *string

+ Triggers []NotificationTriggerType

+ Type string

+ URL *string

+ type NotificationConfigurationList struct

+ Items []*NotificationConfiguration

+ type NotificationConfigurationUpdateOptions struct

+ EmailAddresses []string

+ EmailUsers []*User

+ Enabled *bool

+ Name *string

+ Token *string

+ Triggers []NotificationTriggerType

+ Type string

+ URL *string

+ type NotificationDestinationType string

+ const NotificationDestinationTypeEmail

+ const NotificationDestinationTypeGeneric

+ const NotificationDestinationTypeMicrosoftTeams

+ const NotificationDestinationTypeSlack

+ func NotificationDestinationPtr(d NotificationDestinationType) *NotificationDestinationType

+ type NotificationTriggerType string

+ const NotificationTriggerApplying

+ const NotificationTriggerAssessmentCheckFailed

+ const NotificationTriggerAssessmentDrifted

+ const NotificationTriggerAssessmentFailed

+ const NotificationTriggerCompleted

+ const NotificationTriggerCreated

+ const NotificationTriggerErrored

+ const NotificationTriggerNeedsAttention

+ const NotificationTriggerPlanning

+ type OAuthClient struct

+ APIURL string

+ CallbackURL string

+ ConnectPath string

+ CreatedAt time.Time

+ HTTPURL string

+ ID string

+ Key string

+ Name *string

+ OAuthTokens []*OAuthToken

+ Organization *Organization

+ RSAPublicKey string

+ Secret string

+ ServiceProvider ServiceProviderType

+ ServiceProviderName string

+ type OAuthClientCreateOptions struct

+ APIURL *string

+ HTTPURL *string

+ Key *string

+ Name *string

+ OAuthToken *string

+ PrivateKey *string

+ RSAPublicKey *string

+ Secret *string

+ ServiceProvider *ServiceProviderType

+ Type string

+ type OAuthToken struct

+ CreatedAt time.Time

+ HasSSHKey bool

+ ID string

+ OAuthClient *OAuthClient

+ ServiceProviderUser string

+ UID string

+ type Organization struct

+ AllowForceDeleteWorkspaces bool

+ AssessmentsEnforced bool

+ CollaboratorAuthPolicy AuthPolicyType

+ CostEstimationEnabled bool

+ CreatedAt time.Time

+ Email string

+ ExternalID string

+ Name string

+ OwnersTeamSAMLRoleID string

+ Permissions *OrganizationPermissions

+ SAMLEnabled bool

+ SendPassingStatusesForUntriggeredSpeculativePlans bool

+ SessionRemember *int

+ SessionTimeout *int

+ TrialExpiresAt time.Time

+ TwoFactorConformant bool

+ type OrganizationAccess struct

+ ManageMembership bool

+ ManageModules bool

+ ManagePolicies bool

+ ManagePolicyOverrides bool

+ ManageProjects bool

+ ManageProviders bool

+ ManageRunTasks bool

+ ManageVCSSettings bool

+ ManageWorkspaces bool

+ ReadProjects bool

+ ReadWorkspaces bool

+ type OrganizationAccessOptions struct

+ ManageMembership *bool

+ ManageModules *bool

+ ManagePolicies *bool

+ ManagePolicyOverrides *bool

+ ManageProjects *bool

+ ManageProviders *bool

+ ManageRunTasks *bool

+ ManageVCSSettings *bool

+ ManageWorkspaces *bool

+ ReadProjects *bool

+ ReadWorkspaces *bool

+ type OrganizationCreateOptions struct

+ AllowForceDeleteWorkspaces *bool

+ AssessmentsEnforced *bool

+ CollaboratorAuthPolicy *AuthPolicyType

+ CostEstimationEnabled *bool

+ Email *string

+ Name *string

+ OwnersTeamSAMLRoleID *string

+ SendPassingStatusesForUntriggeredSpeculativePlans *bool

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

+ const OrganizationMembershipActive

+ const OrganizationMembershipInvited

+ type OrganizationPermissions struct

+ CanCreateTeam bool

+ CanCreateWorkspace bool

+ CanCreateWorkspaceMigration bool

+ CanDestroy bool

+ CanTraverse bool

+ CanUpdate bool

+ CanUpdateAPIToken bool

+ CanUpdateOAuth bool

+ CanUpdateSentinel bool

+ type OrganizationTag struct

+ ID string

+ InstanceCount int

+ Name string

+ Organization *Organization

+ type OrganizationToken struct

+ CreatedAt time.Time

+ ExpiredAt *time.Time

+ ID string

+ Token string

+ type OrganizationTokenCreateOptions struct

+ ExpiredAt *time.Time

+ type OrganizationUpdateOptions struct

+ AllowForceDeleteWorkspaces *bool

+ AssessmentsEnforced *bool

+ CollaboratorAuthPolicy *AuthPolicyType

+ CostEstimationEnabled *bool

+ Email *string

+ Name *string

+ OwnersTeamSAMLRoleID *string

+ SendPassingStatusesForUntriggeredSpeculativePlans *bool

+ SessionRemember *int

+ SessionTimeout *int

+ Type string

+ type Pagination struct

+ CurrentPage int

+ NextPage *int

+ PreviousPage *int

+ TotalCount int

+ TotalPages int

+ type PhaseStatusTimestamps struct

+ CanceledAt *time.Time

+ ErroredAt *time.Time

+ FinishedAt *time.Time

+ PendingAt *time.Time

+ QueuedAt *time.Time

+ StartedAt *time.Time

+ UnreachableAt *time.Time

+ type Plan struct

+ HasChanges bool

+ ID string

+ LogReadURL string

+ Status string

+ StatusTimestamps *PhaseStatusTimestamps

+ type ResourceReport struct

+ Additions *int

+ Changes *int

+ Destructions *int

+ type RollbackStateVersionOptions struct

+ RollbackStateVersion *StateVersion

+ Type string

+ type Run struct

+ Actions *RunActions

+ AllowEmptyApply bool

+ Apply *Apply

+ AutoApply bool

+ ConfigurationVersion *ConfigurationVersion

+ CostEstimate *CostEstimate

+ CreatedAt time.Time

+ CreatedBy *User

+ ExecutionMode string

+ ForceCancelAvailableAt *time.Time

+ HasChanges bool

+ ID string

+ IsDestroy bool

+ Message string

+ Permissions *RunPermissions

+ Plan *Plan

+ PlanOnly bool

+ PositionInQueue int

+ Refresh bool

+ RefreshOnly bool

+ ReplaceAddrs []string

+ Source string

+ Status string

+ StatusTimestamps *RunStatusTimestamps

+ TargetAddrs []string

+ TerraformVersion string

+ Variables []RunVariable

+ Workspace *Workspace

+ type RunActions struct

+ IsCancelable bool

+ IsConfirmable bool

+ IsDiscardable bool

+ IsForceCancelable bool

+ type RunCreateOptions struct

+ AllowEmptyApply *bool

+ AutoApply *bool

+ ConfigurationVersion *ConfigurationVersion

+ IsDestroy *bool

+ Message *string

+ PlanOnly *bool

+ Refresh *bool

+ RefreshOnly *bool

+ ReplaceAddrs []string

+ TargetAddrs []string

+ TerraformVersion *string

+ Type string

+ Variables []*RunVariable

+ Workspace *Workspace

+ type RunEvent struct

+ Action string

+ Actor *User

+ CreatedAt time.Time

+ Description string

+ ID string

+ type RunEventList struct

+ Items []*RunEvent

+ type RunList struct

+ Items []*Run

+ type RunListOptions struct

+ Commit *string

+ Include []string

+ Operation string

+ Organization *string

+ Search string

+ Source string

+ Status string

+ User *string

+ WorkspaceID *string

+ type RunOperation string

+ const RunOperationDestroy

+ const RunOperationEmptyApply

+ const RunOperationPlanApply

+ const RunOperationPlanOnly

+ const RunOperationRefreshOnly

+ const RunOperationSavePlan

+ type RunPermissions struct

+ CanApply bool

+ CanCancel bool

+ CanDiscard bool

+ CanForceCancel bool

+ CanForceExecute bool

+ type RunStatusTimestamps struct

+ AppliedAt *time.Time

+ ApplyQueuedAt *time.Time

+ ApplyingAt *time.Time

+ CanceledAt *time.Time

+ ConfirmedAt *time.Time

+ CostEstimatedAt *time.Time

+ CostEstimatingAt *time.Time

+ DiscardedAt *time.Time

+ ErroredAt *time.Time

+ ForceCanceledAt *time.Time

+ PlanQueueableAt *time.Time

+ PlanQueuedAt *time.Time

+ PlannedAndFinishedAt *time.Time

+ PlannedAt *time.Time

+ PlanningAt *time.Time

+ PolicyCheckedAt *time.Time

+ PolicySoftFailedAt *time.Time

+ type RunVariable struct

+ Key string

+ Value string

+ type ServiceProviderType string

+ const ServiceProviderAzureDevOpsServer

+ const ServiceProviderAzureDevOpsServices

+ const ServiceProviderBitbucket

+ const ServiceProviderBitbucketServer

+ const ServiceProviderBitbucketServerLegacy

+ const ServiceProviderGithub

+ const ServiceProviderGithubEE

+ const ServiceProviderGitlab

+ const ServiceProviderGitlabCE

+ const ServiceProviderGitlabEE

+ type StateVersion struct

+ CreatedAt time.Time

+ DownloadURL string

+ ID string

+ Outputs []*StateVersionOutput

+ ResourcesProcessed bool

+ Serial int64

+ StateVersion int

+ TerraformVersion string

+ VCSCommitSHA string

+ type StateVersionCreateVersionOptions struct

+ Force *bool

+ Lineage *string

+ MD5 *string

+ Serial *int64

+ State *string

+ Type string

+ type StateVersionList struct

+ Items []*StateVersion

+ type StateVersionOutput struct

+ ID string

+ Name string

+ Sensitive bool

+ Type string

+ Value any

+ type Tag struct

+ ID string

+ Name string

+ type Team struct

+ ID string

+ Name string

+ OrganizationAccess *OrganizationAccess

+ Permissions *TeamPermissions

+ SSOTeamID *string

+ UserCount int

+ Users []*User

+ Visibility string

+ type TeamCreateOptions struct

+ Name *string

+ OrganizationAccess *OrganizationAccessOptions

+ SSOTeamID *string

+ Type string

+ Visibility *string

+ type TeamPermissions struct

+ CanDestroy bool

+ CanUpdateMembership bool

+ type TeamUpdateOptions struct

+ Name *string

+ OrganizationAccess *OrganizationAccessOptions

+ SSOTeamID *string

+ Type string

+ Visibility *string

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

+ Branch string

+ DisplayIdentifier string

+ Identifier string

+ IngressSubmodules bool

+ OAuthTokenID string

+ RepositoryHTTPURL string

+ ServiceProvider string

+ TagsRegex string

+ type VCSRepoOptions struct

+ Branch *string

+ Identifier *string

+ IngressSubmodules *bool

+ OAuthTokenID *string

+ Set bool

+ TagsRegex *string

+ Valid bool

+ type VCSRepoOptionsJSON struct

+ Set bool

+ Valid bool

+ func (o *VCSRepoOptionsJSON) UnmarshalJSON(data []byte) error

+ type Variable struct

+ Category string

+ Description string

+ HCL bool

+ ID string

+ Key string

+ Sensitive bool

+ Value string

+ VersionID string

+ type VariableCreateOptions struct

+ Category *string

+ Description *string

+ HCL *bool

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type VariableList struct

+ Items []*Variable

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

+ Description *string

+ Global *bool

+ Name *string

+ Type string

+ type VariableSetVariable struct

+ VariableSet *VariableSet

+ type VariableSetVariableCreateOptions struct

+ Category *string

+ Description *string

+ HCL *bool

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type VariableSetVariableUpdateOptions struct

+ Description *string

+ HCL *bool

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type VariableUpdateOptions struct

+ Category *string

+ Description *string

+ HCL *bool

+ Key *string

+ Sensitive *bool

+ Type string

+ Value *string

+ type Workspace struct

+ Actions *WorkspaceActions

+ AgentPoolID string

+ AllowDestroyPlan bool

+ ApplyDurationAverage time.Duration

+ AutoApply bool

+ CanQueueDestroyPlan bool

+ CreatedAt time.Time

+ CurrentRun *Run

+ Description string

+ Environment string

+ ExecutionMode string

+ FileTriggersEnabled bool

+ GlobalRemoteState bool

+ ID string

+ Locked bool

+ MigrationEnvironment string

+ Name string

+ Operations bool

+ Organization *Organization

+ Outputs []*StateVersionOutput

+ Permissions *WorkspacePermissions

+ PlanDurationAverage time.Duration

+ PolicyCheckFailures int

+ QueueAllRuns bool

+ ResourceCount int

+ RunFailures int

+ RunsCount int

+ SourceName string

+ SourceURL string

+ SpeculativeEnabled bool

+ StructuredRunOutputEnabled bool

+ TagNames []string

+ TerraformVersion string

+ TriggerPatterns []string

+ TriggerPrefixes []string

+ UpdatedAt time.Time

+ VCSRepo *VCSRepo

+ WorkingDirectory string

+ type WorkspaceActions struct

+ IsDestroyable bool

+ type WorkspaceCreateOptions struct

+ AgentPoolID *string

+ AllowDestroyPlan *bool

+ AutoApply *bool

+ Description *string

+ ExecutionMode *string

+ FileTriggersEnabled *bool

+ GlobalRemoteState *bool

+ MigrationEnvironment *string

+ Name *string

+ Operations *bool

+ Organization *string

+ QueueAllRuns *bool

+ SourceName *string

+ SourceURL *string

+ SpeculativeEnabled *bool

+ StructuredRunOutputEnabled *bool

+ Tags []*Tag

+ TerraformVersion *string

+ TriggerPatterns []string

+ TriggerPrefixes []string

+ Type string

+ VCSRepo *VCSRepoOptions

+ WorkingDirectory *string

+ type WorkspaceList struct

+ Items []*Workspace

+ type WorkspaceListOptions struct

+ ExcludeTags string

+ ProjectID string

+ Search string

+ Tags string

+ WildcardName string

+ type WorkspacePermissions struct

+ CanDestroy bool

+ CanForceUnlock bool

+ CanLock bool

+ CanQueueApply bool

+ CanQueueDestroy bool

+ CanQueueRun bool

+ CanReadSettings bool

+ CanUnlock bool

+ CanUpdate bool

+ CanUpdateVariable bool

+ type WorkspaceUpdateOptions struct

+ AgentPoolID *string

+ AllowDestroyPlan *bool

+ AutoApply *bool

+ Description *string

+ ExecutionMode *string

+ FileTriggersEnabled *bool

+ GlobalRemoteState *bool

+ Name *string

+ Operations *bool

+ QueueAllRuns *bool

+ SpeculativeEnabled *bool

+ StructuredRunOutputEnabled *bool

+ TerraformVersion *string

+ TriggerPatterns []string

+ TriggerPrefixes []string

+ Type string

+ VCSRepo VCSRepoOptionsJSON

+ WorkingDirectory *string

+ func (opts *WorkspaceUpdateOptions) Validate() error

+ type WorkspaceVariable struct

+ Workspace *Workspace

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