Documentation
¶
Overview ¶
Code generated; DO NOT EDIT.
Package opslevel provides an OpsLevel API client implementation.
see README for more details.
Code generated; DO NOT EDIT.
Code generated; DO NOT EDIT.
Code generated; DO NOT EDIT.
Code generated; DO NOT EDIT.
Index ¶
- Variables
- func AllRunnerJobOutcomeEnum() []string
- func AllRunnerJobStatusEnum() []string
- func AllRunnerStatusTypeEnum() []string
- func ErrIs(err error, code ErrorCode) bool
- func HandleErrors(opts ...any) error
- func HasAPIErrors(errs []Error) error
- func IsID(value string) bool
- func IsOpsLevelApiError(err error) bool
- func IsResourceFound(resource any) error
- func IsResourceValid[T any](opslevelResource T) error
- func JsonStringAs[T any](data JsonString) (T, error)
- func NewCheckCreateInputTypeOf[T any](checkCreateInput CheckCreateInput) *T
- func NewCheckUpdateInputTypeOf[T any](checkUpdateInput CheckUpdateInput) *T
- func NewClientError(code ErrorCode, err error) error
- func NewExampleOf[T any]() T
- func NewISO8601Date(datetime string) iso8601.Time
- func NewISO8601DateNow() iso8601.Time
- func NewRestClient(options ...Option) *resty.Client
- func NewString(value string) *string
- func NullString() *string
- func SetDefaultsFor[T any](opslevelResource *T)
- func SetExamplesFor[T any](opslevelResource *T)
- func UnmarshalCheckCreateInput(checkType CheckType, data []byte) (any, error)
- func UnmarshalCheckUpdateInput(checkType CheckType, data []byte) (any, error)
- func ValidateTagKey(key string) error
- func WithName(name string) graphql.Option
- type AWSIntegrationFragment
- type AWSIntegrationInput
- type AlertSource
- type AlertSourceConnection
- type AlertSourceDeleteInput
- type AlertSourceExternalIdentifier
- type AlertSourceInput
- type AlertSourceService
- type AlertSourceServiceConnection
- type AlertSourceServiceCreateInput
- type AlertSourceServiceCreatePayload
- type AlertSourceServiceDeleteInput
- type AlertSourceServiceV2Connection
- type AlertSourceStatusTypeEnum
- type AlertSourceStatusUpdateInput
- type AlertSourceTypeEnum
- type AlertSourceUsageCheckFragment
- type AliasCreateInput
- type AliasCreatePayload
- type AliasDeleteInput
- type AliasOwnerTypeEnum
- type AliasableResourceInterface
- type ApiDocumentSourceEnum
- type ApprovalConfig
- type ApprovalConfigInput
- type ApprovalDecisionEnum
- type ApprovalResult
- type Approver
- type AwsIntegrationInput
- type AzureDevopsPermissionError
- type AzureResourcesIntegrationFragment
- type AzureResourcesIntegrationInput
- type BasePayload
- type BasicTypeEnum
- type Cacher
- func (cacher *Cacher) CacheAll(client *Client)
- func (cacher *Cacher) CacheCategories(client *Client)
- func (cacher *Cacher) CacheFilters(client *Client)
- func (cacher *Cacher) CacheInfraSchemas(client *Client)
- func (cacher *Cacher) CacheIntegrations(client *Client)
- func (cacher *Cacher) CacheLevels(client *Client)
- func (cacher *Cacher) CacheLifecycles(client *Client)
- func (cacher *Cacher) CacheRepositories(client *Client)
- func (cacher *Cacher) CacheSystems(client *Client)
- func (cacher *Cacher) CacheTeams(client *Client)
- func (cacher *Cacher) CacheTiers(client *Client)
- func (cacher *Cacher) TryGetCategory(alias string) (*Category, bool)
- func (cacher *Cacher) TryGetFilter(alias string) (*Filter, bool)
- func (cacher *Cacher) TryGetInfrastructureSchema(alias string) (*InfrastructureResourceSchema, bool)
- func (cacher *Cacher) TryGetIntegration(alias string) (*Integration, bool)
- func (cacher *Cacher) TryGetLevel(alias string) (*Level, bool)
- func (cacher *Cacher) TryGetLifecycle(alias string) (*Lifecycle, bool)
- func (cacher *Cacher) TryGetRepository(alias string) (*Repository, bool)
- func (cacher *Cacher) TryGetSystems(alias string) (*System, bool)
- func (cacher *Cacher) TryGetTeam(alias string) (*Team, bool)
- func (cacher *Cacher) TryGetTier(alias string) (*Tier, bool)
- type Campaign
- type CampaignConnection
- type CampaignFilterEnum
- type CampaignReminder
- type CampaignReminderChannelEnum
- type CampaignReminderFrequencyUnitEnum
- type CampaignReminderTypeEnum
- type CampaignSendReminderOutcomeTeams
- type CampaignServiceStatusEnum
- type CampaignSortEnum
- type CampaignStatusEnum
- type CampaignTeam
- type Category
- type CategoryBreakdown
- type CategoryConnection
- type CategoryCreateInput
- type CategoryCreatePayload
- type CategoryDeleteInput
- type CategoryLevel
- type CategoryUpdateInput
- type CategoryUpdatePayload
- type Check
- type CheckAlertSourceUsageCreateInput
- type CheckAlertSourceUsageUpdateInput
- type CheckCodeIssueConstraintEnum
- type CheckCodeIssueCreateInput
- type CheckCodeIssueUpdateInput
- type CheckConnection
- type CheckCopyInput
- type CheckCopyPayload
- type CheckCreateInput
- type CheckCreateInputProvider
- type CheckCustomEventCreateInput
- type CheckCustomEventUpdateInput
- type CheckDeleteInput
- type CheckGitBranchProtectionCreateInput
- type CheckGitBranchProtectionUpdateInput
- type CheckHasDocumentationCreateInput
- type CheckHasDocumentationUpdateInput
- type CheckHasRecentDeployCreateInput
- type CheckHasRecentDeployUpdateInput
- type CheckId
- type CheckInputConstructor
- type CheckManualCreateInput
- type CheckManualUpdateInput
- type CheckOwner
- type CheckPackageVersionCreateInput
- type CheckPackageVersionUpdateInput
- type CheckRelationshipCreateInput
- type CheckRelationshipUpdateInput
- type CheckRepositoryFileCreateInput
- type CheckRepositoryFileUpdateInput
- type CheckRepositoryGrepCreateInput
- type CheckRepositoryGrepUpdateInput
- type CheckRepositoryIntegratedCreateInput
- type CheckRepositoryIntegratedUpdateInput
- type CheckRepositorySearchCreateInput
- type CheckRepositorySearchUpdateInput
- type CheckResponsePayload
- type CheckResult
- type CheckResultStatusEnum
- type CheckResultsByLevel
- type CheckResultsByLevelConnection
- type CheckResultsConnection
- type CheckServiceConfigurationCreateInput
- type CheckServiceConfigurationUpdateInput
- type CheckServiceDependencyCreateInput
- type CheckServiceDependencyUpdateInput
- type CheckServiceOwnershipCreateInput
- type CheckServiceOwnershipUpdateInput
- type CheckServicePropertyCreateInput
- type CheckServicePropertyUpdateInput
- type CheckStats
- type CheckStatus
- type CheckTagDefinedCreateInput
- type CheckTagDefinedUpdateInput
- type CheckToPromoteInput
- type CheckToolUsageCreateInput
- type CheckToolUsageUpdateInput
- type CheckType
- type CheckUpdateInput
- type CheckUpdateInputProvider
- type Client
- func (client *Client) AddContact(team string, contact ContactInput) (*Contact, error)
- func (client *Client) AddMemberships(team *TeamId, memberships ...TeamMembershipUserInput) ([]TeamMembership, error)
- func (client *Client) AssignTag(input TagAssignInput) ([]Tag, error)
- func (client *Client) AssignTags(identifier string, tags map[string]string) ([]Tag, error)
- func (client *Client) AssignTagsWithTagInputs(identifier string, tags []TagInput) ([]Tag, error)
- func (client *Client) ConnectServiceRepository(service *ServiceId, repository *Repository) (*ServiceRepository, error)
- func (client *Client) CreateAlertSourceService(input AlertSourceServiceCreateInput) (*AlertSourceService, error)
- func (client *Client) CreateAlias(input AliasCreateInput) ([]string, error)
- func (client *Client) CreateAliases(ownerId ID, aliases []string) ([]string, error)
- func (client *Client) CreateCategory(input CategoryCreateInput) (*Category, error)
- func (client *Client) CreateCheck(input any) (*Check, error)
- func (client *Client) CreateCheckAlertSourceUsage(input CheckAlertSourceUsageCreateInput) (*Check, error)
- func (client *Client) CreateCheckCodeIssue(input CheckCodeIssueCreateInput) (*Check, error)
- func (client *Client) CreateCheckCustomEvent(input CheckCustomEventCreateInput) (*Check, error)
- func (client *Client) CreateCheckGitBranchProtection(input CheckGitBranchProtectionCreateInput) (*Check, error)
- func (client *Client) CreateCheckHasDocumentation(input CheckHasDocumentationCreateInput) (*Check, error)
- func (client *Client) CreateCheckHasRecentDeploy(input CheckHasRecentDeployCreateInput) (*Check, error)
- func (client *Client) CreateCheckManual(input CheckManualCreateInput) (*Check, error)
- func (client *Client) CreateCheckPackageVersion(input CheckPackageVersionCreateInput) (*Check, error)
- func (client *Client) CreateCheckRelationship(input CheckRelationshipCreateInput) (*Check, error)
- func (client *Client) CreateCheckRepositoryFile(input CheckRepositoryFileCreateInput) (*Check, error)
- func (client *Client) CreateCheckRepositoryGrep(input CheckRepositoryGrepCreateInput) (*Check, error)
- func (client *Client) CreateCheckRepositoryIntegrated(input CheckRepositoryIntegratedCreateInput) (*Check, error)
- func (client *Client) CreateCheckRepositorySearch(input CheckRepositorySearchCreateInput) (*Check, error)
- func (client *Client) CreateCheckServiceConfiguration(input CheckServiceConfigurationCreateInput) (*Check, error)
- func (client *Client) CreateCheckServiceDependency(input CheckServiceDependencyCreateInput) (*Check, error)
- func (client *Client) CreateCheckServiceOwnership(input CheckServiceOwnershipCreateInput) (*Check, error)
- func (client *Client) CreateCheckServiceProperty(input CheckServicePropertyCreateInput) (*Check, error)
- func (client *Client) CreateCheckTagDefined(input CheckTagDefinedCreateInput) (*Check, error)
- func (client *Client) CreateCheckToolUsage(input CheckToolUsageCreateInput) (*Check, error)
- func (client *Client) CreateComponent(input ComponentCreateInput) (*Component, error)
- func (client *Client) CreateComponentType(input ComponentTypeInput) (*ComponentType, error)
- func (client *Client) CreateDomain(input DomainInput) (*Domain, error)
- func (client *Client) CreateEventIntegration(input EventIntegrationInput) (*Integration, error)
- func (client *Client) CreateFilter(input FilterCreateInput) (*Filter, error)
- func (client *Client) CreateInfrastructure(input InfraInput) (*InfrastructureResource, error)
- func (client *Client) CreateIntegrationAWS(input AWSIntegrationInput) (*Integration, error)
- func (client *Client) CreateIntegrationAzureResources(input AzureResourcesIntegrationInput) (*Integration, error)
- func (client *Client) CreateIntegrationGCP(input GoogleCloudIntegrationInput) (*Integration, error)
- func (client *Client) CreateIntegrationNewRelic(input NewRelicIntegrationInput) (*Integration, error)
- func (client *Client) CreateLevel(input LevelCreateInput) (*Level, error)
- func (client *Client) CreateOrUpdateAlertSource(input AlertSourceInput) (*AlertSource, error)
- func (client *Client) CreatePropertyDefinition(input PropertyDefinitionInput) (*PropertyDefinition, error)
- func (client *Client) CreateRelationship(input RelationshipDefinition) (*RelationshipType, error)
- func (client *Client) CreateRelationshipDefinition(input RelationshipDefinitionInput) (*RelationshipDefinitionType, error)
- func (client *Client) CreateScorecard(input ScorecardInput) (*Scorecard, error)
- func (client *Client) CreateSecret(alias string, input SecretInput) (*Secret, error)
- func (client *Client) CreateService(input ServiceCreateInput) (*Service, error)
- func (client *Client) CreateServiceDependency(input ServiceDependencyCreateInput) (*ServiceDependency, error)
- func (client *Client) CreateServiceRepository(input ServiceRepositoryCreateInput) (*ServiceRepository, error)
- func (client *Client) CreateSystem(input SystemInput) (*System, error)
- func (client *Client) CreateTag(input TagCreateInput) (*Tag, error)
- func (client *Client) CreateTags(identifier string, tags map[string]string) ([]Tag, error)
- func (client *Client) CreateTeam(input TeamCreateInput) (*Team, error)
- func (client *Client) CreateTool(input ToolCreateInput) (*Tool, error)
- func (client *Client) CreateTriggerDefinition(input CustomActionsTriggerDefinitionCreateInput) (*CustomActionsTriggerDefinition, error)
- func (client *Client) CreateWebhookAction(input CustomActionsWebhookActionCreateInput) (*CustomActionsExternalAction, error)
- func (client *Client) DeleteAlertSourceService(id ID) error
- func (client *Client) DeleteAlias(input AliasDeleteInput) error
- func (client *Client) DeleteAliases(aliasOwnerType AliasOwnerTypeEnum, aliases []string) error
- func (client *Client) DeleteCategory(id ID) error
- func (client *Client) DeleteCheck(id ID) error
- func (client *Client) DeleteComponent(identifier string) error
- func (client *Client) DeleteComponentType(identifier string) error
- func (client *Client) DeleteDomain(identifier string) error
- func (client *Client) DeleteFilter(id ID) error
- func (client *Client) DeleteInfraAlias(alias string) errordeprecated
- func (client *Client) DeleteInfrastructure(identifier string) error
- func (client *Client) DeleteIntegration(identifier string) error
- func (client *Client) DeleteLevel(id ID) error
- func (client *Client) DeletePropertyDefinition(input string) error
- func (client *Client) DeleteRelationship(identifier string) (*ID, error)
- func (client *Client) DeleteRelationshipDefinition(identifier string) (*ID, error)
- func (client *Client) DeleteScorecard(identifier string) (*ID, error)
- func (client *Client) DeleteSecret(identifier string) error
- func (client *Client) DeleteService(identifier string) error
- func (client *Client) DeleteServiceAlias(alias string) errordeprecated
- func (client *Client) DeleteServiceDependency(id ID) error
- func (client *Client) DeleteServiceRepository(id ID) error
- func (client *Client) DeleteSystem(identifier string) error
- func (client *Client) DeleteTag(id ID) error
- func (client *Client) DeleteTeam(identifier string) error
- func (client *Client) DeleteTeamAlias(alias string) errordeprecated
- func (client *Client) DeleteTool(id ID) error
- func (client *Client) DeleteTriggerDefinition(input string) error
- func (client *Client) DeleteUser(user string) error
- func (client *Client) DeleteWebhookAction(input string) error
- func (client *Client) ExecRaw(q string, variables map[string]interface{}, options ...graphql.Option) ([]byte, error)
- func (client *Client) ExecRawCTX(ctx context.Context, q string, variables map[string]interface{}, ...) ([]byte, error)
- func (client *Client) GetAlertSource(id ID) (*AlertSource, error)
- func (client *Client) GetAlertSourceWithExternalIdentifier(input AlertSourceExternalIdentifier) (*AlertSource, error)
- func (client *Client) GetAliasableResource(resourceType AliasOwnerTypeEnum, identifier string) (AliasableResourceInterface, error)
- func (client *Client) GetCategory(id ID) (*Category, error)
- func (client *Client) GetCheck(id ID) (*Check, error)
- func (client *Client) GetComponent(identifier string) (*Component, error)
- func (client *Client) GetComponentType(identifier string) (*ComponentType, error)
- func (client *Client) GetCustomAction(input string) (*CustomActionsExternalAction, error)
- func (client *Client) GetDocument(id ID) (*ServiceDocumentContent, error)
- func (client *Client) GetDomain(identifier string) (*Domain, error)
- func (client *Client) GetFilter(id ID) (*Filter, error)
- func (client *Client) GetInfrastructure(identifier string) (*InfrastructureResource, error)
- func (client *Client) GetIntegration(id ID) (*Integration, error)
- func (client *Client) GetLevel(id ID) (*Level, error)
- func (client *Client) GetProperty(owner string, definition string) (*Property, error)
- func (client *Client) GetPropertyDefinition(input string) (*PropertyDefinition, error)
- func (client *Client) GetRelationship(identifier string) (*RelationshipType, error)
- func (client *Client) GetRelationshipDefinition(identifier string) (*RelationshipDefinitionType, error)
- func (client *Client) GetRepository(id ID) (*Repository, error)
- func (client *Client) GetRepositoryWithAlias(alias string) (*Repository, error)
- func (client *Client) GetScorecard(input string) (*Scorecard, error)
- func (client *Client) GetSecret(identifier string) (*Secret, error)
- func (client *Client) GetService(identifier string) (*Service, error)
- func (client *Client) GetServiceCount() (int, error)
- func (client *Client) GetServiceId(id ID) (*Service, error)
- func (client *Client) GetServiceIdWithAlias(alias string) (*ServiceId, error)
- func (client *Client) GetServiceMaturityWithAlias(alias string) (*ServiceMaturity, error)
- func (client *Client) GetServiceWithAlias(alias string) (*Service, error)
- func (client *Client) GetSystem(identifier string) (*System, error)
- func (client *Client) GetTaggableResource(resourceType TaggableResource, identifier string) (TaggableResourceInterface, error)
- func (client *Client) GetTeam(id ID) (*Team, error)
- func (client *Client) GetTeamCount() (int, error)
- func (client *Client) GetTeamWithAlias(alias string) (*Team, error)
- func (client *Client) GetTriggerDefinition(input string) (*CustomActionsTriggerDefinition, error)
- func (client *Client) GetUser(value string) (*User, error)
- func (client *Client) InitialPageVariables() PayloadVariables
- func (client *Client) InitialPageVariablesPointer() *PayloadVariables
- func (client *Client) IntegrationReactivate(identifier string) (*Integration, error)
- func (client *Client) InviteUser(email string, input UserInput, sendInvite bool) (*User, error)
- func (client *Client) InvokeAction(input CustomActionsTriggerInvokeInput) error
- func (client *Client) ListCampaigns(campaignVariables *ListCampaignsVariables) (*CampaignConnection, error)
- func (client *Client) ListCategories(variables *PayloadVariables) (*CategoryConnection, error)
- func (client *Client) ListChecks(variables *PayloadVariables) (*CheckConnection, error)
- func (client *Client) ListComponentTypes(variables *PayloadVariables) (*ComponentTypeConnection, error)
- func (client *Client) ListComponents(variables *PayloadVariables) (*ComponentConnection, error)
- func (client *Client) ListCustomActions(variables *PayloadVariables) (*CustomActionsExternalActionsConnection, error)
- func (client *Client) ListDocuments(variables *PayloadVariables) (*ServiceDocumentConnection, error)
- func (client *Client) ListDomains(variables *PayloadVariables) (*DomainConnection, error)
- func (client *Client) ListFilters(variables *PayloadVariables) (*FilterConnection, error)
- func (client *Client) ListInfrastructure(variables *PayloadVariables) (*InfrastructureResourceConnection, error)
- func (client *Client) ListInfrastructureSchemas(variables *PayloadVariables) (*InfrastructureResourceSchemaConnection, error)
- func (client *Client) ListIntegrations(variables *PayloadVariables) (*IntegrationConnection, error)
- func (client *Client) ListLevels(variables *PayloadVariables) (*LevelConnection, error)
- func (client *Client) ListLifecycles() ([]Lifecycle, error)
- func (client *Client) ListPropertyDefinitions(variables *PayloadVariables) (*PropertyDefinitionConnection, error)
- func (client *Client) ListRelationshipDefinitions(variables *PayloadVariables) (*RelationshipDefinitionConnection, error)
- func (client *Client) ListRepositories(variables *PayloadVariables) (*RepositoryConnection, error)
- func (client *Client) ListRepositoriesWithTier(tier string, variables *PayloadVariables) (*RepositoryConnection, error)
- func (client *Client) ListScorecards(variables *PayloadVariables) (*ScorecardConnection, error)
- func (client *Client) ListSecretsVaultsSecret(variables *PayloadVariables) (*SecretsVaultsSecretsConnection, error)
- func (client *Client) ListServices(variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesMaturity(variables *PayloadVariables) (*ServiceMaturityConnection, error)
- func (client *Client) ListServicesWithFilter(filterIdentifier string, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesWithFramework(framework string, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesWithInputFilter(filter ServiceFilterInput, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesWithLanguage(language string, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesWithLifecycle(lifecycle string, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesWithOwner(owner string, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesWithProduct(product string, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesWithTag(tag TagArgs, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListServicesWithTier(tier string, variables *PayloadVariables) (*ServiceConnection, error)
- func (client *Client) ListSystems(variables *PayloadVariables) (*SystemConnection, error)
- func (client *Client) ListTeams(variables *PayloadVariables) (*TeamConnection, error)
- func (client *Client) ListTeamsWithManager(email string, variables *PayloadVariables) (*TeamConnection, error)
- func (client *Client) ListTiers() ([]Tier, error)
- func (client *Client) ListTriggerDefinitions(variables *PayloadVariables) (*CustomActionsTriggerDefinitionsConnection, error)
- func (client *Client) ListUsers(variables *PayloadVariables) (*UserConnection, error)
- func (client *Client) Mutate(m interface{}, variables map[string]interface{}, options ...graphql.Option) error
- func (client *Client) MutateCTX(ctx context.Context, m interface{}, variables map[string]interface{}, ...) error
- func (client *Client) PropertyAssign(input PropertyInput) (*Property, error)
- func (client *Client) PropertyUnassign(owner string, definition string) error
- func (client *Client) Query(q interface{}, variables map[string]interface{}, options ...graphql.Option) error
- func (client *Client) QueryCTX(ctx context.Context, q interface{}, variables map[string]interface{}, ...) error
- func (client *Client) ReconcileTags(resourceType TaggableResourceInterface, tagsDesired []Tag) error
- func (client *Client) RemoveContact(contact ID) error
- func (client *Client) RemoveMemberships(team *TeamId, memberships ...TeamMembershipUserInput) ([]User, error)
- func (client *Client) RunnerAppendJobLog(input RunnerAppendJobLogInput) error
- func (client *Client) RunnerGetPendingJob(runnerId ID, lastUpdateToken ID) (*RunnerJob, ID, error)
- func (client *Client) RunnerRegister(queue ...string) (*Runner, error)
- func (client *Client) RunnerReportJobOutcome(input RunnerReportJobOutcomeInput) error
- func (client *Client) RunnerScale(runnerId ID, currentReplicaCount, jobConcurrency int) (*RunnerScale, error)
- func (client *Client) RunnerUnregister(runnerId ID) error
- func (client *Client) SearchTeams(searchTerm string, variables *PayloadVariables) (*TeamConnection, error)
- func (client *Client) ServiceApiDocSettingsUpdate(service string, docPath string, docSource *ApiDocumentSourceEnum) (*Service, error)
- func (client *Client) UpdateAlertSourceStatus(input AlertSourceStatusUpdateInput) (*AlertSource, error)
- func (client *Client) UpdateCategory(input CategoryUpdateInput) (*Category, error)
- func (client *Client) UpdateCheck(input any) (*Check, error)
- func (client *Client) UpdateCheckAlertSourceUsage(input CheckAlertSourceUsageUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckCodeIssue(input CheckCodeIssueUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckCustomEvent(input CheckCustomEventUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckGitBranchProtection(input CheckGitBranchProtectionUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckHasDocumentation(input CheckHasDocumentationUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckHasRecentDeploy(input CheckHasRecentDeployUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckManual(input CheckManualUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckPackageVersion(input CheckPackageVersionUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckRelationship(input CheckRelationshipUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckRepositoryFile(input CheckRepositoryFileUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckRepositoryGrep(input CheckRepositoryGrepUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckRepositoryIntegrated(input CheckRepositoryIntegratedUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckRepositorySearch(input CheckRepositorySearchUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckServiceConfiguration(input CheckServiceConfigurationUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckServiceDependency(input CheckServiceDependencyUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckServiceOwnership(input CheckServiceOwnershipUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckServiceProperty(input CheckServicePropertyUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckTagDefined(input CheckTagDefinedUpdateInput) (*Check, error)
- func (client *Client) UpdateCheckToolUsage(input CheckToolUsageUpdateInput) (*Check, error)
- func (client *Client) UpdateComponent(input ComponentUpdateInput) (*Component, error)
- func (client *Client) UpdateComponentType(identifier string, input ComponentTypeInput) (*ComponentType, error)
- func (client *Client) UpdateContact(id ID, contact ContactInput) (*Contact, error)
- func (client *Client) UpdateDomain(identifier string, input DomainInput) (*Domain, error)
- func (client *Client) UpdateEventIntegration(input EventIntegrationUpdateInput) (*Integration, error)
- func (client *Client) UpdateFilter(input FilterUpdateInput) (*Filter, error)
- func (client *Client) UpdateInfrastructure(identifier string, input InfraInput) (*InfrastructureResource, error)
- func (client *Client) UpdateIntegrationAWS(identifier string, input AWSIntegrationInput) (*Integration, error)
- func (client *Client) UpdateIntegrationAzureResources(identifier string, input AzureResourcesIntegrationInput) (*Integration, error)
- func (client *Client) UpdateIntegrationGCP(identifier string, input GoogleCloudIntegrationInput) (*Integration, error)
- func (client *Client) UpdateIntegrationNewRelic(identifier string, input NewRelicIntegrationInput) (*Integration, error)
- func (client *Client) UpdateLevel(input LevelUpdateInput) (*Level, error)
- func (client *Client) UpdatePropertyDefinition(identifier string, input PropertyDefinitionInput) (*PropertyDefinition, error)
- func (client *Client) UpdateRelationshipDefinition(identifier string, input RelationshipDefinitionInput) (*RelationshipDefinitionType, error)
- func (client *Client) UpdateRepository(input RepositoryUpdateInput) (*Repository, error)
- func (client *Client) UpdateScorecard(identifier string, input ScorecardInput) (*Scorecard, error)
- func (client *Client) UpdateSecret(identifier string, secretInput SecretInput) (*Secret, error)
- func (client *Client) UpdateService(input ServiceUpdateInput) (*Service, error)
- func (client *Client) UpdateServiceNote(input ServiceNoteUpdateInput) (*Service, error)
- func (client *Client) UpdateServiceRepository(input ServiceRepositoryUpdateInput) (*ServiceRepository, error)
- func (client *Client) UpdateSystem(identifier string, input SystemInput) (*System, error)
- func (client *Client) UpdateTag(input TagUpdateInput) (*Tag, error)
- func (client *Client) UpdateTeam(input TeamUpdateInput) (*Team, error)
- func (client *Client) UpdateTool(input ToolUpdateInput) (*Tool, error)
- func (client *Client) UpdateTriggerDefinition(input CustomActionsTriggerDefinitionUpdateInput) (*CustomActionsTriggerDefinition, error)
- func (client *Client) UpdateUser(user string, input UserInput) (*User, error)
- func (client *Client) UpdateWebhookAction(input CustomActionsWebhookActionUpdateInput) (*CustomActionsExternalAction, error)
- func (client *Client) Validate() error
- type ClientError
- type ClientSettings
- type CodeIssueCheckFragment
- type CodeIssueProjectResource
- type CodeIssueResolutionTime
- type CodeIssueResolutionTimeInput
- type CodeIssueResolutionTimeUnitEnum
- type CommonVulnerabilityEnumeration
- type CommonWeaknessEnumeration
- type Component
- type ComponentConnection
- type ComponentCreateInput
- type ComponentType
- type ComponentTypeConnection
- type ComponentTypeIcon
- type ComponentTypeIconEnum
- type ComponentTypeIconInput
- type ComponentTypeId
- type ComponentTypeInput
- type ComponentTypePayload
- type ComponentTypePropertyDefinitionInput
- type ComponentUpdateInput
- type ConfigError
- type ConfigFile
- type Connection
- type ConnectionBase
- type ConnectiveEnum
- type Contact
- type ContactCreateInput
- type ContactCreatePayload
- type ContactDeleteInput
- type ContactInput
- func CreateContactEmail(email string, name *Nullable[string]) ContactInput
- func CreateContactSlack(channel string, name *Nullable[string]) ContactInput
- func CreateContactSlackHandle(channel string, name *Nullable[string]) ContactInput
- func CreateContactWeb(address string, name *Nullable[string]) ContactInput
- type ContactOwner
- type ContactType
- type ContactUpdateInput
- type ContactUpdatePayload
- type CustomActionsAssociatedObject
- type CustomActionsEntityTypeEnum
- type CustomActionsExternalAction
- type CustomActionsExternalActionsConnection
- type CustomActionsHttpMethodEnum
- type CustomActionsId
- type CustomActionsTemplate
- type CustomActionsTemplatesAction
- type CustomActionsTemplatesMetadata
- type CustomActionsTemplatesTriggerDefinition
- type CustomActionsTriggerDefinition
- type CustomActionsTriggerDefinitionAccessControlEnum
- type CustomActionsTriggerDefinitionBase
- type CustomActionsTriggerDefinitionConnection
- type CustomActionsTriggerDefinitionCreateInput
- type CustomActionsTriggerDefinitionCreatePayload
- type CustomActionsTriggerDefinitionUpdateInput
- type CustomActionsTriggerDefinitionUpdatePayload
- type CustomActionsTriggerDefinitionsConnection
- type CustomActionsTriggerEventStatusEnum
- type CustomActionsTriggerInvokeInput
- type CustomActionsWebhookAction
- type CustomActionsWebhookActionCreateInput
- type CustomActionsWebhookActionCreatePayload
- type CustomActionsWebhookActionUpdateInput
- type CustomActionsWebhookActionUpdatePayload
- type CustomEventCheckFragment
- type CustomIntegrationInput
- type DayOfWeekEnum
- type DeleteInput
- type Deploy
- type DeployConnection
- type DeployStatusEnum
- type Document
- type DocumentSource
- type Domain
- type DomainChildAssignPayload
- type DomainChildRemovePayload
- type DomainConnection
- type DomainId
- func (DomainId *DomainId) AliasableType() AliasOwnerTypeEnum
- func (domainId *DomainId) AssignSystem(client *Client, systems ...string) error
- func (domainId *DomainId) ChildSystems(client *Client, variables *PayloadVariables) (*SystemConnection, error)
- func (domainId *DomainId) GetAliases() []string
- func (domainId *DomainId) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
- func (domainId *DomainId) ResourceId() ID
- func (domainId *DomainId) ResourceType() TaggableResource
- type DomainInput
- type DomainPayload
- type EntityOwner
- type EntityOwnerService
- type EntityOwnerTeam
- type Error
- type ErrorCode
- type EventIntegrationEnum
- type EventIntegrationInput
- type EventIntegrationUpdateInput
- type ExportConfigFilePayload
- type ExternalResourceIdentifierInput
- type ExternalUuidMutationInput
- type ExternalUuidMutationPayload
- type Filter
- type FilterConnection
- type FilterCreateInput
- type FilterCreatePayload
- type FilterId
- type FilterPredicate
- type FilterPredicateInput
- type FilterUpdateInput
- type FilterUpdatePayload
- type FireHydrantIntegrationInput
- type FrequencyTimeScale
- type GitBranchProtectionCheckFragment
- type GoogleCloudIntegrationFragment
- type GoogleCloudIntegrationInput
- type GoogleCloudProject
- type HasDocumentationCheckFragment
- type HasDocumentationSubtypeEnum
- type HasDocumentationTypeEnum
- type HasRecentDeployCheckFragment
- type ID
- type Identifiable
- type Identifier
- type IdentifierInput
- type ImportEntityFromBackstagePayload
- type InfraInput
- type InfraProviderInput
- type InfrastructureResource
- func (infrastructureResource *InfrastructureResource) AliasableType() AliasOwnerTypeEnum
- func (infrastructureResource *InfrastructureResource) GetAliases() []string
- func (infrastructureResource *InfrastructureResource) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
- func (infrastructureResource *InfrastructureResource) ReconcileAliases(client *Client, aliasesWanted []string) error
- func (infrastructureResource *InfrastructureResource) ResourceId() ID
- func (infrastructureResource *InfrastructureResource) ResourceType() TaggableResource
- type InfrastructureResourceConnection
- type InfrastructureResourceId
- type InfrastructureResourceInput
- type InfrastructureResourcePayload
- type InfrastructureResourceProviderData
- type InfrastructureResourceProviderDataInput
- type InfrastructureResourceSchema
- type InfrastructureResourceSchemaConnection
- type InfrastructureResourceSchemaInput
- type Integration
- type IntegrationConnection
- type IntegrationCreatePayload
- type IntegrationId
- type IntegrationReactivatePayload
- type IntegrationSourceObjectUpsertPayload
- type IntegrationUpdatePayload
- type JSON
- type JSONSchema
- type JsonString
- func (jsonString JsonString) AsArray() []any
- func (jsonString JsonString) AsBool() bool
- func (jsonString JsonString) AsFloat64() float64
- func (jsonString JsonString) AsInt() int
- func (jsonString JsonString) AsMap() map[string]any
- func (jsonString JsonString) AsString() string
- func (jsonString JsonString) GetGraphQLType() string
- type Language
- type Level
- type LevelConnection
- type LevelCount
- type LevelCreateInput
- type LevelCreatePayload
- type LevelDeleteInput
- type LevelUpdateInput
- type LevelUpdatePayload
- type Lifecycle
- type ListCampaignsVariables
- type ManagementRuleInput
- type ManualAlertSourceSync
- type ManualCheckFragment
- type ManualCheckFrequency
- type ManualCheckFrequencyInput
- type ManualCheckFrequencyUpdateInput
- type MaturityReport
- type MaturityReportOnlyOverallLevel
- type MemberInput
- type NewRelicAccountsPayload
- type NewRelicIntegrationAccountsInput
- type NewRelicIntegrationFragment
- type NewRelicIntegrationInput
- type Nullable
- func NewNull[T string]() *Nullable[T]
- func NewNullOf[T NullableConstraint]() *Nullable[T]
- func NewNullableFrom[T NullableConstraint](value T) *Nullable[T]
- func NullOf[T NullableConstraint]() *Nullable[T]
- func RefOf[T NullableConstraint](value T) *Nullable[T]
- func RefTo[T NullableConstraint](value T) *Nullable[T]
- type NullableConstraint
- type OctopusDeployIntegrationInput
- type Option
- func SetAPIToken(apiToken string) Option
- func SetAPIVisibility(visibility string) Option
- func SetHeader(key string, value string) Option
- func SetHeaders(headers map[string]string) Option
- func SetMaxRetries(amount int) Option
- func SetPageSize(size int) Option
- func SetTimeout(amount time.Duration) Option
- func SetTransport(transport http.RoundTripper) Option
- func SetURL(url string) Option
- func SetUserAgentExtra(extra string) Option
- type OwnerRelationshipInput
- type OwnerRelationshipType
- type PackageConstraintEnum
- type PackageManagerEnum
- type PackageVersionCheckFragment
- type PageInfo
- type PayloadFilterEnum
- type PayloadFilterInput
- type PayloadSortEnum
- type PayloadVariables
- type Predicate
- type PredicateInput
- type PredicateKeyEnum
- type PredicateTypeEnum
- type PredicateUpdateInput
- type Property
- type PropertyConnection
- type PropertyDefinition
- type PropertyDefinitionConnection
- type PropertyDefinitionDisplayTypeEnum
- type PropertyDefinitionId
- type PropertyDefinitionInput
- type PropertyDefinitionPayload
- type PropertyDisplayStatusEnum
- type PropertyInput
- type PropertyLockedStatusEnum
- type PropertyOwnerTypeEnum
- type PropertyPayload
- type PropertyUnassignPayload
- type ProvisionedByEnum
- type RelatedResourceConnection
- type RelatedResourceRelationshipTypeEnum
- type RelationshipCheckFragment
- type RelationshipConnection
- type RelationshipDefinition
- type RelationshipDefinitionConnection
- type RelationshipDefinitionInput
- type RelationshipDefinitionManagementRule
- type RelationshipDefinitionManagementRuleOperator
- type RelationshipDefinitionMetadata
- type RelationshipDefinitionMetadataInput
- type RelationshipDefinitionPayload
- type RelationshipDefinitionType
- type RelationshipNode
- type RelationshipResource
- type RelationshipType
- type RelationshipTypeEnum
- type RepositoriesUpdatePayload
- type Repository
- func (repository *Repository) GetService(service ID, directory string) *ServiceRepository
- func (repository *Repository) GetServices(client *Client, variables *PayloadVariables) (*RepositoryServiceConnection, error)
- func (repository *Repository) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
- func (repository *Repository) Hydrate(client *Client) error
- func (repository *Repository) ResourceId() ID
- func (repository *Repository) ResourceType() TaggableResource
- type RepositoryConnection
- type RepositoryFileCheckFragment
- type RepositoryGrepCheckFragment
- type RepositoryId
- type RepositoryOperationErrorPayload
- type RepositoryPath
- type RepositorySBOMGenerationConfigEnum
- type RepositorySBOMGenerationDisabledReasonEnum
- type RepositorySearchCheckFragment
- type RepositoryServiceConnection
- type RepositoryServiceEdge
- type RepositoryUpdateInput
- type RepositoryUpdatePayload
- type RepositoryVisibilityEnum
- type ResourceDocumentStatusTypeEnum
- type RestResponse
- type RubricReport
- type Runner
- type RunnerAppendJobLogInput
- type RunnerJob
- type RunnerJobFile
- type RunnerJobOutcomeEnum
- type RunnerJobOutcomeVariable
- type RunnerJobStatusEnum
- type RunnerJobVariable
- type RunnerReportJobOutcomeInput
- type RunnerScale
- type RunnerStatusTypeEnum
- type SBOMGenerationConfiguration
- type Scorecard
- type ScorecardCategoryConnection
- type ScorecardCheckConnection
- type ScorecardConnection
- type ScorecardId
- type ScorecardInput
- type ScorecardPayload
- type ScorecardServicesReport
- type ScorecardSortEnum
- type ScorecardStats
- type ScorecardStatsConnection
- type Secret
- type SecretInput
- type SecretPayload
- type SecretsVaultsSecretsConnection
- type Service
- func (service *Service) AliasableType() AliasOwnerTypeEnum
- func (service *Service) GetAliases() []string
- func (service *Service) GetDependencies(client *Client, variables *PayloadVariables) (*ServiceDependenciesConnection, error)
- func (service *Service) GetDependents(client *Client, variables *PayloadVariables) (*ServiceDependentsConnection, error)
- func (service *Service) GetDocuments(client *Client, variables *PayloadVariables) (*ServiceDocumentConnection, error)
- func (service *Service) GetLastDeploy(client *Client, variables *PayloadVariables) (*Deploy, error)
- func (service *Service) GetProperties(client *Client, variables *PayloadVariables) (*ServicePropertiesConnection, error)
- func (service *Service) GetRepositories(client *Client, variables *PayloadVariables) (*ServiceRepositoryConnection, error)
- func (service *Service) GetServiceStats(client *Client) (*ServiceStats, error)
- func (service *Service) GetSystem(client *Client, variables *PayloadVariables) (*System, error)
- func (service *Service) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
- func (service *Service) GetTools(client *Client, variables *PayloadVariables) (*ToolConnection, error)
- func (service *Service) HasAlias(alias string) bool
- func (service *Service) HasTag(key string, value string) bool
- func (service *Service) HasTool(category ToolCategory, name string, environment string) bool
- func (service *Service) Hydrate(client *Client) error
- func (service *Service) ReconcileAliases(client *Client, aliasesWanted []string) error
- func (service *Service) ResourceId() ID
- func (service *Service) ResourceType() TaggableResource
- func (service *Service) UniqueIdentifiers() []string
- type ServiceCategoryConnection
- type ServiceCheckResults
- type ServiceConnection
- type ServiceCreateInput
- type ServiceCreatePayload
- type ServiceDeleteInput
- type ServiceDependenciesConnection
- type ServiceDependenciesEdge
- type ServiceDependency
- type ServiceDependencyCreateInput
- type ServiceDependencyKey
- type ServiceDependencyPayload
- type ServiceDependentsConnection
- type ServiceDependentsEdge
- type ServiceDocument
- type ServiceDocumentConnection
- type ServiceDocumentContent
- type ServiceDocumentSource
- type ServiceFilterEnum
- type ServiceFilterInput
- type ServiceId
- type ServiceLevelNotifications
- type ServiceLevelNotificationsPayload
- type ServiceLevelNotificationsUpdateInput
- type ServiceMaturity
- type ServiceMaturityConnection
- type ServiceMaturityReport
- type ServiceNextLevel
- type ServiceNoteUpdateInput
- type ServiceNoteUpdatePayload
- type ServiceOwnershipCheckFragment
- type ServicePropertiesConnection
- type ServicePropertyCheckFragment
- type ServicePropertyTypeEnum
- type ServiceRepository
- type ServiceRepositoryConnection
- type ServiceRepositoryCreateInput
- type ServiceRepositoryCreatePayload
- type ServiceRepositoryEdge
- type ServiceRepositoryUpdateInput
- type ServiceRepositoryUpdatePayload
- type ServiceSortEnum
- type ServiceStats
- type ServiceUpdateInput
- type ServiceUpdatePayload
- type SnykIntegrationInput
- type SnykIntegrationRegionEnum
- type SonarqubeCloudIntegrationInput
- type SonarqubeIntegrationInput
- type Stats
- type System
- type SystemChildAssignPayload
- type SystemChildRemovePayload
- type SystemConnection
- type SystemId
- func (systemId *SystemId) AliasableType() AliasOwnerTypeEnum
- func (systemId *SystemId) AssignService(client *Client, services ...string) error
- func (systemId *SystemId) ChildServices(client *Client, variables *PayloadVariables) (*ServiceConnection, error)
- func (systemId *SystemId) GetAliases() []string
- func (systemId *SystemId) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
- func (system *SystemId) ReconcileAliases(client *Client, aliasesWanted []string) error
- func (systemId *SystemId) ResourceId() ID
- func (systemId *SystemId) ResourceType() TaggableResource
- type SystemInput
- type SystemPayload
- type Tag
- type TagArgs
- type TagAssignInput
- type TagAssignPayload
- type TagConnection
- type TagCreateInput
- type TagCreatePayload
- type TagDefinedCheckFragment
- type TagDeleteInput
- type TagInput
- type TagOwner
- type TagRelationshipKeys
- type TagRelationshipKeysAssignInput
- type TagRepositoryConnection
- type TagUpdateInput
- type TagUpdatePayload
- type TaggableResource
- type TaggableResourceInterface
- type Team
- func (team *Team) AliasableType() AliasOwnerTypeEnum
- func (team *Team) GetAliases() []string
- func (team *Team) GetMemberships(client *Client, variables *PayloadVariables) (*TeamMembershipConnection, error)
- func (team *Team) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
- func (team *Team) HasTag(key string, value string) bool
- func (team *Team) Hydrate(client *Client) error
- func (team *Team) ReconcileAliases(client *Client, aliasesWanted []string) error
- func (team *Team) ResourceId() ID
- func (team *Team) ResourceType() TaggableResource
- func (team *Team) UniqueIdentifiers() []string
- type TeamConnection
- type TeamCreateInput
- type TeamCreatePayload
- type TeamDeleteInput
- type TeamId
- type TeamIdConnection
- type TeamMembership
- type TeamMembershipConnection
- type TeamMembershipCreateInput
- type TeamMembershipCreatePayload
- type TeamMembershipDeleteInput
- type TeamMembershipUserInput
- type TeamPropertyDefinition
- type TeamPropertyDefinitionConnection
- type TeamPropertyDefinitionInput
- type TeamPropertyDefinitionPayload
- type TeamPropertyDefinitionsAssignInput
- type TeamUpdateInput
- type TeamUpdatePayload
- type Tier
- type Timestamps
- type Tool
- type ToolCategory
- type ToolConnection
- type ToolCreateInput
- type ToolCreatePayload
- type ToolDeleteInput
- type ToolUpdateInput
- type ToolUpdatePayload
- type ToolUsageCheckFragment
- type TypeEnum
- type User
- type UserConnection
- type UserId
- type UserIdentifierInput
- type UserInput
- type UserPayload
- type UserRole
- type UsersFilterEnum
- type UsersFilterInput
- type UsersInviteInput
- type UsersInvitePayload
- type UsersInviteScopeEnum
- type VaultSecretsSortEnum
- type Warning
Constants ¶
This section is empty.
Variables ¶
var ( TagKeyRegex = regexp.MustCompile(`\A[a-z][0-9a-z_\.\/\\-]*\z`) TagKeyErrorMsg = "tag key name '%s' must start with a letter and be only lowercase alphanumerics, underscores, hyphens, periods, and slashes" )
var AllAlertSourceStatusTypeEnum = []string{ string(AlertSourceStatusTypeEnumAlert), string(AlertSourceStatusTypeEnumFetchingData), string(AlertSourceStatusTypeEnumNoData), string(AlertSourceStatusTypeEnumOk), string(AlertSourceStatusTypeEnumWarn), }
All AlertSourceStatusTypeEnum as []string
var AllAlertSourceTypeEnum = []string{ string(AlertSourceTypeEnumCustom), string(AlertSourceTypeEnumDatadog), string(AlertSourceTypeEnumFireHydrant), string(AlertSourceTypeEnumIncidentIo), string(AlertSourceTypeEnumNewRelic), string(AlertSourceTypeEnumOpsgenie), string(AlertSourceTypeEnumPagerduty), }
All AlertSourceTypeEnum as []string
var AllAliasOwnerTypeEnum = []string{ string(AliasOwnerTypeEnumDomain), string(AliasOwnerTypeEnumGroup), string(AliasOwnerTypeEnumInfrastructureResource), string(AliasOwnerTypeEnumScorecard), string(AliasOwnerTypeEnumService), string(AliasOwnerTypeEnumSystem), string(AliasOwnerTypeEnumTeam), }
All AliasOwnerTypeEnum as []string
var AllApiDocumentSourceEnum = []string{ string(ApiDocumentSourceEnumPull), string(ApiDocumentSourceEnumPush), }
All ApiDocumentSourceEnum as []string
var AllApprovalDecisionEnum = []string{ string(ApprovalDecisionEnumApproved), string(ApprovalDecisionEnumDenied), }
All ApprovalDecisionEnum as []string
var AllBasicTypeEnum = []string{ string(BasicTypeEnumDoesNotEqual), string(BasicTypeEnumEquals), }
All BasicTypeEnum as []string
var AllCampaignFilterEnum = []string{ string(CampaignFilterEnumID), string(CampaignFilterEnumOwner), string(CampaignFilterEnumStatus), }
All CampaignFilterEnum as []string
var AllCampaignReminderChannelEnum = []string{ string(CampaignReminderChannelEnumEmail), string(CampaignReminderChannelEnumMicrosoftTeams), string(CampaignReminderChannelEnumSlack), }
All CampaignReminderChannelEnum as []string
var AllCampaignReminderFrequencyUnitEnum = []string{ string(CampaignReminderFrequencyUnitEnumDay), string(CampaignReminderFrequencyUnitEnumMonth), string(CampaignReminderFrequencyUnitEnumWeek), }
All CampaignReminderFrequencyUnitEnum as []string
var AllCampaignReminderTypeEnum = []string{ string(CampaignReminderTypeEnumEmail), string(CampaignReminderTypeEnumMicrosoftTeams), string(CampaignReminderTypeEnumSlack), }
All CampaignReminderTypeEnum as []string
var AllCampaignServiceStatusEnum = []string{ string(CampaignServiceStatusEnumFailing), string(CampaignServiceStatusEnumPassing), }
All CampaignServiceStatusEnum as []string
var AllCampaignSortEnum = []string{ string(CampaignSortEnumChecksPassingAsc), string(CampaignSortEnumChecksPassingDesc), string(CampaignSortEnumEndedDateAsc), string(CampaignSortEnumEndedDateDesc), string(CampaignSortEnumFilterAsc), string(CampaignSortEnumFilterDesc), string(CampaignSortEnumNameAsc), string(CampaignSortEnumNameDesc), string(CampaignSortEnumOwnerAsc), string(CampaignSortEnumOwnerDesc), string(CampaignSortEnumServicesCompleteAsc), string(CampaignSortEnumServicesCompleteDesc), string(CampaignSortEnumStartDateAsc), string(CampaignSortEnumStartDateDesc), string(CampaignSortEnumStatusAsc), string(CampaignSortEnumStatusDesc), string(CampaignSortEnumTargetDateAsc), string(CampaignSortEnumTargetDateDesc), }
All CampaignSortEnum as []string
var AllCampaignStatusEnum = []string{ string(CampaignStatusEnumDelayed), string(CampaignStatusEnumDraft), string(CampaignStatusEnumEnded), string(CampaignStatusEnumInProgress), string(CampaignStatusEnumScheduled), }
All CampaignStatusEnum as []string
var AllCheckCodeIssueConstraintEnum = []string{ string(CheckCodeIssueConstraintEnumAny), string(CheckCodeIssueConstraintEnumContains), string(CheckCodeIssueConstraintEnumExact), }
All CheckCodeIssueConstraintEnum as []string
var AllCheckResultStatusEnum = []string{ string(CheckResultStatusEnumFailed), string(CheckResultStatusEnumPassed), }
All CheckResultStatusEnum as []string
var AllCheckStatus = []string{ string(CheckStatusFailed), string(CheckStatusPassed), string(CheckStatusPending), }
All CheckStatus as []string
var AllCheckType = []string{ string(CheckTypeAlertSourceUsage), string(CheckTypeCodeIssue), string(CheckTypeCustom), string(CheckTypeGeneric), string(CheckTypeGitBranchProtection), string(CheckTypeHasDocumentation), string(CheckTypeHasOwner), string(CheckTypeHasRecentDeploy), string(CheckTypeHasRepository), string(CheckTypeHasServiceConfig), string(CheckTypeManual), string(CheckTypePackageVersion), string(CheckTypePayload), string(CheckTypeRelationship), string(CheckTypeRepoFile), string(CheckTypeRepoGrep), string(CheckTypeRepoSearch), string(CheckTypeServiceDependency), string(CheckTypeServiceProperty), string(CheckTypeTagDefined), string(CheckTypeToolUsage), }
All CheckType as []string
var AllCodeIssueResolutionTimeUnitEnum = []string{ string(CodeIssueResolutionTimeUnitEnumDay), string(CodeIssueResolutionTimeUnitEnumMonth), string(CodeIssueResolutionTimeUnitEnumWeek), }
All CodeIssueResolutionTimeUnitEnum as []string
var AllComponentTypeIconEnum = []string{}/* 1047 elements not displayed */
All ComponentTypeIconEnum as []string
var AllConnectiveEnum = []string{ string(ConnectiveEnumAnd), string(ConnectiveEnumOr), }
All ConnectiveEnum as []string
var AllContactType = []string{ string(ContactTypeEmail), string(ContactTypeGitHub), string(ContactTypeMicrosoftTeams), string(ContactTypeSlack), string(ContactTypeSlackHandle), string(ContactTypeWeb), }
All ContactType as []string
var AllCustomActionsEntityTypeEnum = []string{ string(CustomActionsEntityTypeEnumGlobal), string(CustomActionsEntityTypeEnumService), }
All CustomActionsEntityTypeEnum as []string
var AllCustomActionsHttpMethodEnum = []string{ string(CustomActionsHttpMethodEnumDelete), string(CustomActionsHttpMethodEnumGet), string(CustomActionsHttpMethodEnumPatch), string(CustomActionsHttpMethodEnumPost), string(CustomActionsHttpMethodEnumPut), }
All CustomActionsHttpMethodEnum as []string
var AllCustomActionsTriggerDefinitionAccessControlEnum = []string{ string(CustomActionsTriggerDefinitionAccessControlEnumAdmins), string(CustomActionsTriggerDefinitionAccessControlEnumEveryone), string(CustomActionsTriggerDefinitionAccessControlEnumServiceOwners), }
All CustomActionsTriggerDefinitionAccessControlEnum as []string
var AllCustomActionsTriggerEventStatusEnum = []string{ string(CustomActionsTriggerEventStatusEnumFailure), string(CustomActionsTriggerEventStatusEnumPending), string(CustomActionsTriggerEventStatusEnumPendingApproval), string(CustomActionsTriggerEventStatusEnumSuccess), }
All CustomActionsTriggerEventStatusEnum as []string
var AllDayOfWeekEnum = []string{ string(DayOfWeekEnumFriday), string(DayOfWeekEnumMonday), string(DayOfWeekEnumSaturday), string(DayOfWeekEnumSunday), string(DayOfWeekEnumThursday), string(DayOfWeekEnumTuesday), string(DayOfWeekEnumWednesday), }
All DayOfWeekEnum as []string
var AllDeployStatusEnum = []string{ string(DeployStatusEnumCanceled), string(DeployStatusEnumFailure), string(DeployStatusEnumNoStatus), string(DeployStatusEnumQueued), string(DeployStatusEnumRunning), string(DeployStatusEnumSuccess), }
All DeployStatusEnum as []string
var AllEventIntegrationEnum = []string{ string(EventIntegrationEnumApidoc), string(EventIntegrationEnumAquasecurity), string(EventIntegrationEnumArgocd), string(EventIntegrationEnumAwsecr), string(EventIntegrationEnumBugsnag), string(EventIntegrationEnumCircleci), string(EventIntegrationEnumCodacy), string(EventIntegrationEnumCoveralls), string(EventIntegrationEnumCustomevent), string(EventIntegrationEnumDatadogcheck), string(EventIntegrationEnumDeploy), string(EventIntegrationEnumDynatrace), string(EventIntegrationEnumFlux), string(EventIntegrationEnumGithubactions), string(EventIntegrationEnumGitlabci), string(EventIntegrationEnumGrafana), string(EventIntegrationEnumGrype), string(EventIntegrationEnumJenkins), string(EventIntegrationEnumJfrogxray), string(EventIntegrationEnumLacework), string(EventIntegrationEnumNewreliccheck), string(EventIntegrationEnumOctopus), string(EventIntegrationEnumPrismacloud), string(EventIntegrationEnumPrometheus), string(EventIntegrationEnumRollbar), string(EventIntegrationEnumSentry), string(EventIntegrationEnumSnyk), string(EventIntegrationEnumSonarqube), string(EventIntegrationEnumStackhawk), string(EventIntegrationEnumSumologic), string(EventIntegrationEnumVeracode), }
All EventIntegrationEnum as []string
var AllFrequencyTimeScale = []string{ string(FrequencyTimeScaleDay), string(FrequencyTimeScaleMonth), string(FrequencyTimeScaleWeek), string(FrequencyTimeScaleYear), }
All FrequencyTimeScale as []string
var AllHasDocumentationSubtypeEnum = []string{ string(HasDocumentationSubtypeEnumOpenapi), }
All HasDocumentationSubtypeEnum as []string
var AllHasDocumentationTypeEnum = []string{ string(HasDocumentationTypeEnumAPI), string(HasDocumentationTypeEnumTech), }
All HasDocumentationTypeEnum as []string
var AllPackageConstraintEnum = []string{ string(PackageConstraintEnumDoesNotExist), string(PackageConstraintEnumExists), string(PackageConstraintEnumMatchesVersion), }
All PackageConstraintEnum as []string
var AllPackageManagerEnum = []string{ string(PackageManagerEnumAlpm), string(PackageManagerEnumApk), string(PackageManagerEnumBitbucket), string(PackageManagerEnumBitnami), string(PackageManagerEnumCargo), string(PackageManagerEnumCocoapods), string(PackageManagerEnumComposer), string(PackageManagerEnumConan), string(PackageManagerEnumConda), string(PackageManagerEnumCpan), string(PackageManagerEnumCran), string(PackageManagerEnumDeb), string(PackageManagerEnumDocker), string(PackageManagerEnumGem), string(PackageManagerEnumGeneric), string(PackageManagerEnumGitHub), string(PackageManagerEnumGolang), string(PackageManagerEnumGradle), string(PackageManagerEnumHackage), string(PackageManagerEnumHelm), string(PackageManagerEnumHex), string(PackageManagerEnumMaven), string(PackageManagerEnumMlflow), string(PackageManagerEnumNpm), string(PackageManagerEnumNuget), string(PackageManagerEnumOci), string(PackageManagerEnumPub), string(PackageManagerEnumPypi), string(PackageManagerEnumQpkg), string(PackageManagerEnumRpm), string(PackageManagerEnumSwid), string(PackageManagerEnumSwift), }
All PackageManagerEnum as []string
var AllPayloadFilterEnum = []string{ string(PayloadFilterEnumIntegrationID), }
All PayloadFilterEnum as []string
var AllPayloadSortEnum = []string{ string(PayloadSortEnumCreatedAtAsc), string(PayloadSortEnumCreatedAtDesc), string(PayloadSortEnumProcessedAtAsc), string(PayloadSortEnumProcessedAtDesc), }
All PayloadSortEnum as []string
var AllPredicateKeyEnum = []string{ string(PredicateKeyEnumAliases), string(PredicateKeyEnumComponentCategory), string(PredicateKeyEnumComponentTypeID), string(PredicateKeyEnumCreationSource), string(PredicateKeyEnumDomainID), string(PredicateKeyEnumFilterID), string(PredicateKeyEnumFramework), string(PredicateKeyEnumGroupIDs), string(PredicateKeyEnumLanguage), string(PredicateKeyEnumLifecycleIndex), string(PredicateKeyEnumName), string(PredicateKeyEnumOwnerID), string(PredicateKeyEnumOwnerIDs), string(PredicateKeyEnumProduct), string(PredicateKeyEnumProperties), string(PredicateKeyEnumRelationships), string(PredicateKeyEnumRepositoryIDs), string(PredicateKeyEnumSystemID), string(PredicateKeyEnumTags), string(PredicateKeyEnumTierIndex), }
All PredicateKeyEnum as []string
var AllPredicateTypeEnum = []string{ string(PredicateTypeEnumBelongsTo), string(PredicateTypeEnumContains), string(PredicateTypeEnumDoesNotContain), string(PredicateTypeEnumDoesNotEqual), string(PredicateTypeEnumDoesNotExist), string(PredicateTypeEnumDoesNotMatch), string(PredicateTypeEnumDoesNotMatchRegex), string(PredicateTypeEnumEndsWith), string(PredicateTypeEnumEquals), string(PredicateTypeEnumExists), string(PredicateTypeEnumGreaterThanOrEqualTo), string(PredicateTypeEnumLessThanOrEqualTo), string(PredicateTypeEnumMatches), string(PredicateTypeEnumMatchesRegex), string(PredicateTypeEnumSatisfiesJqExpression), string(PredicateTypeEnumSatisfiesVersionConstraint), string(PredicateTypeEnumStartsWith), }
All PredicateTypeEnum as []string
var AllPropertyDefinitionDisplayTypeEnum = []string{ string(PropertyDefinitionDisplayTypeEnumArray), string(PropertyDefinitionDisplayTypeEnumBoolean), string(PropertyDefinitionDisplayTypeEnumDropdown), string(PropertyDefinitionDisplayTypeEnumNumber), string(PropertyDefinitionDisplayTypeEnumObject), string(PropertyDefinitionDisplayTypeEnumText), }
All PropertyDefinitionDisplayTypeEnum as []string
var AllPropertyDisplayStatusEnum = []string{ string(PropertyDisplayStatusEnumHidden), string(PropertyDisplayStatusEnumVisible), }
All PropertyDisplayStatusEnum as []string
var AllPropertyLockedStatusEnum = []string{ string(PropertyLockedStatusEnumUILocked), string(PropertyLockedStatusEnumUnlocked), }
All PropertyLockedStatusEnum as []string
var AllPropertyOwnerTypeEnum = []string{ string(PropertyOwnerTypeEnumComponent), string(PropertyOwnerTypeEnumTeam), }
All PropertyOwnerTypeEnum as []string
var AllProvisionedByEnum = []string{ string(ProvisionedByEnumAPICli), string(ProvisionedByEnumAPIOther), string(ProvisionedByEnumAPITerraform), string(ProvisionedByEnumBackstage), string(ProvisionedByEnumIntegrationScim), string(ProvisionedByEnumSsoOkta), string(ProvisionedByEnumSsoOther), string(ProvisionedByEnumUnknown), string(ProvisionedByEnumUser), }
All ProvisionedByEnum as []string
var AllRelatedResourceRelationshipTypeEnum = []string{ string(RelatedResourceRelationshipTypeEnumBelongsTo), string(RelatedResourceRelationshipTypeEnumContains), string(RelatedResourceRelationshipTypeEnumDependencyOf), string(RelatedResourceRelationshipTypeEnumDependsOn), string(RelatedResourceRelationshipTypeEnumIsRelatedTo), string(RelatedResourceRelationshipTypeEnumMemberOf), string(RelatedResourceRelationshipTypeEnumRelatedTo), }
All RelatedResourceRelationshipTypeEnum as []string
var AllRelationshipDefinitionManagementRuleOperator = []string{ string(RelationshipDefinitionManagementRuleOperatorArrayContains), string(RelationshipDefinitionManagementRuleOperatorEquals), }
All RelationshipDefinitionManagementRuleOperator as []string
var AllRelationshipTypeEnum = []string{ string(RelationshipTypeEnumBelongsTo), string(RelationshipTypeEnumDependsOn), string(RelationshipTypeEnumRelatedTo), }
All RelationshipTypeEnum as []string
var AllRepositorySBOMGenerationConfigEnum = []string{ string(RepositorySBOMGenerationConfigEnumOptIn), string(RepositorySBOMGenerationConfigEnumOptOut), }
All RepositorySBOMGenerationConfigEnum as []string
var AllRepositorySBOMGenerationDisabledReasonEnum = []string{ string(RepositorySBOMGenerationDisabledReasonEnumAccount), string(RepositorySBOMGenerationDisabledReasonEnumIntegration), string(RepositorySBOMGenerationDisabledReasonEnumRepository), }
All RepositorySBOMGenerationDisabledReasonEnum as []string
var AllRepositoryVisibilityEnum = []string{ string(RepositoryVisibilityEnumInternal), string(RepositoryVisibilityEnumOrganization), string(RepositoryVisibilityEnumPrivate), string(RepositoryVisibilityEnumPublic), }
All RepositoryVisibilityEnum as []string
var AllResourceDocumentStatusTypeEnum = []string{ string(ResourceDocumentStatusTypeEnumHidden), string(ResourceDocumentStatusTypeEnumPinned), string(ResourceDocumentStatusTypeEnumVisible), }
All ResourceDocumentStatusTypeEnum as []string
var AllScorecardSortEnum = []string{ string(ScorecardSortEnumAffectsoverallservicelevelsAsc), string(ScorecardSortEnumAffectsoverallservicelevelsDesc), string(ScorecardSortEnumFilterAsc), string(ScorecardSortEnumFilterDesc), string(ScorecardSortEnumNameAsc), string(ScorecardSortEnumNameDesc), string(ScorecardSortEnumOwnerAsc), string(ScorecardSortEnumOwnerDesc), string(ScorecardSortEnumPassingcheckfractionAsc), string(ScorecardSortEnumPassingcheckfractionDesc), string(ScorecardSortEnumServicecountAsc), string(ScorecardSortEnumServicecountDesc), }
All ScorecardSortEnum as []string
var AllServiceFilterEnum = []string{ string(ServiceFilterEnumAlertStatus), string(ServiceFilterEnumAliases), string(ServiceFilterEnumComponentTypeID), string(ServiceFilterEnumCreationSource), string(ServiceFilterEnumDeployEnvironment), string(ServiceFilterEnumDomainID), string(ServiceFilterEnumFilterID), string(ServiceFilterEnumFramework), string(ServiceFilterEnumGroupIDs), string(ServiceFilterEnumLanguage), string(ServiceFilterEnumLevelIndex), string(ServiceFilterEnumLifecycleIndex), string(ServiceFilterEnumName), string(ServiceFilterEnumOwnerID), string(ServiceFilterEnumOwnerIDs), string(ServiceFilterEnumProduct), string(ServiceFilterEnumProperty), string(ServiceFilterEnumRelationship), string(ServiceFilterEnumRepositoryIDs), string(ServiceFilterEnumSystemID), string(ServiceFilterEnumTag), string(ServiceFilterEnumTierIndex), }
All ServiceFilterEnum as []string
var AllServicePropertyTypeEnum = []string{ string(ServicePropertyTypeEnumCustomProperty), string(ServicePropertyTypeEnumDescription), string(ServicePropertyTypeEnumFramework), string(ServicePropertyTypeEnumLanguage), string(ServicePropertyTypeEnumLifecycleIndex), string(ServicePropertyTypeEnumName), string(ServicePropertyTypeEnumNote), string(ServicePropertyTypeEnumProduct), string(ServicePropertyTypeEnumSystem), string(ServicePropertyTypeEnumTierIndex), }
All ServicePropertyTypeEnum as []string
var AllServiceSortEnum = []string{ string(ServiceSortEnumAlertStatusAsc), string(ServiceSortEnumAlertStatusDesc), string(ServiceSortEnumChecksPassingAsc), string(ServiceSortEnumChecksPassingDesc), string(ServiceSortEnumComponentTypeAsc), string(ServiceSortEnumComponentTypeDesc), string(ServiceSortEnumLastDeployAsc), string(ServiceSortEnumLastDeployDesc), string(ServiceSortEnumLevelIndexAsc), string(ServiceSortEnumLevelIndexDesc), string(ServiceSortEnumLifecycleAsc), string(ServiceSortEnumLifecycleDesc), string(ServiceSortEnumNameAsc), string(ServiceSortEnumNameDesc), string(ServiceSortEnumOwnerAsc), string(ServiceSortEnumOwnerDesc), string(ServiceSortEnumProductAsc), string(ServiceSortEnumProductDesc), string(ServiceSortEnumServiceStatAsc), string(ServiceSortEnumServiceStatDesc), string(ServiceSortEnumTierAsc), string(ServiceSortEnumTierDesc), }
All ServiceSortEnum as []string
var AllSnykIntegrationRegionEnum = []string{ string(SnykIntegrationRegionEnumAu), string(SnykIntegrationRegionEnumEu), string(SnykIntegrationRegionEnumUs), }
All SnykIntegrationRegionEnum as []string
var AllTaggableResource = []string{ string(TaggableResourceDomain), string(TaggableResourceInfrastructureresource), string(TaggableResourceRepository), string(TaggableResourceService), string(TaggableResourceSystem), string(TaggableResourceTeam), string(TaggableResourceUser), }
All TaggableResource as []string
var AllToolCategory = []string{ string(ToolCategoryAdmin), string(ToolCategoryAPIDocumentation), string(ToolCategoryArchitectureDiagram), string(ToolCategoryBacklog), string(ToolCategoryCode), string(ToolCategoryContinuousIntegration), string(ToolCategoryDeployment), string(ToolCategoryDesignDocumentation), string(ToolCategoryErrors), string(ToolCategoryFeatureFlag), string(ToolCategoryHealthChecks), string(ToolCategoryIncidents), string(ToolCategoryIssueTracking), string(ToolCategoryLogs), string(ToolCategoryMetrics), string(ToolCategoryObservability), string(ToolCategoryOrchestrator), string(ToolCategoryOther), string(ToolCategoryResiliency), string(ToolCategoryRunbooks), string(ToolCategorySecurityScans), string(ToolCategoryStatusPage), string(ToolCategoryWiki), }
All ToolCategory as []string
var AllTypeEnum = []string{ string(TypeEnumBelongsTo), string(TypeEnumContains), string(TypeEnumDoesNotContain), string(TypeEnumDoesNotEqual), string(TypeEnumDoesNotExist), string(TypeEnumDoesNotMatch), string(TypeEnumDoesNotMatchRegex), string(TypeEnumEndsWith), string(TypeEnumEquals), string(TypeEnumExists), string(TypeEnumGreaterThanOrEqualTo), string(TypeEnumLessThanOrEqualTo), string(TypeEnumMatches), string(TypeEnumMatchesRegex), string(TypeEnumSatisfiesJqExpression), string(TypeEnumSatisfiesVersionConstraint), string(TypeEnumStartsWith), }
All TypeEnum as []string
var AllUserRole = []string{ string(UserRoleAdmin), string(UserRoleStandardsAdmin), string(UserRoleTeamMember), string(UserRoleUser), }
All UserRole as []string
var AllUsersFilterEnum = []string{ string(UsersFilterEnumDeactivatedAt), string(UsersFilterEnumEmail), string(UsersFilterEnumLastSignInAt), string(UsersFilterEnumName), string(UsersFilterEnumRole), string(UsersFilterEnumTag), }
All UsersFilterEnum as []string
var AllUsersInviteScopeEnum = []string{ string(UsersInviteScopeEnumPending), }
All UsersInviteScopeEnum as []string
var AllVaultSecretsSortEnum = []string{ string(VaultSecretsSortEnumSlugAsc), string(VaultSecretsSortEnumSlugDesc), string(VaultSecretsSortEnumUpdatedAtAsc), string(VaultSecretsSortEnumUpdatedAtDesc), }
All VaultSecretsSortEnum as []string
var Cache = &Cacher{ mutex: sync.Mutex{}, Tiers: make(map[string]Tier), Lifecycles: make(map[string]Lifecycle), Systems: make(map[string]System), Teams: make(map[string]Team), Categories: make(map[string]Category), Levels: make(map[string]Level), Filters: make(map[string]Filter), Integrations: make(map[string]Integration), Repositories: make(map[string]Repository), InfraSchemas: make(map[string]InfrastructureResourceSchema), }
var CheckCreateConstructors = map[CheckType]CheckInputConstructor{ CheckTypeAlertSourceUsage: func() any { return &CheckAlertSourceUsageCreateInput{} }, CheckTypeCodeIssue: func() any { return &CheckCodeIssueCreateInput{} }, CheckTypeCustom: func() any { return &CheckCreateInput{} }, CheckTypeGeneric: func() any { return &CheckCustomEventCreateInput{} }, CheckTypeGitBranchProtection: func() any { return &CheckGitBranchProtectionCreateInput{} }, CheckTypeHasDocumentation: func() any { return &CheckHasDocumentationCreateInput{} }, CheckTypeHasOwner: func() any { return &CheckServiceOwnershipCreateInput{} }, CheckTypeHasRecentDeploy: func() any { return &CheckHasRecentDeployCreateInput{} }, CheckTypeHasRepository: func() any { return &CheckRepositoryIntegratedCreateInput{} }, CheckTypeHasServiceConfig: func() any { return &CheckServiceConfigurationCreateInput{} }, CheckTypeManual: func() any { return &CheckManualCreateInput{} }, CheckTypePayload: func() any { return &CheckCreateInput{} }, CheckTypeRepoFile: func() any { return &CheckRepositoryFileCreateInput{} }, CheckTypeRepoGrep: func() any { return &CheckRepositoryGrepCreateInput{} }, CheckTypeRepoSearch: func() any { return &CheckRepositorySearchCreateInput{} }, CheckTypeServiceDependency: func() any { return &CheckServiceDependencyCreateInput{} }, CheckTypeServiceProperty: func() any { return &CheckServicePropertyCreateInput{} }, CheckTypeTagDefined: func() any { return &CheckTagDefinedCreateInput{} }, CheckTypeToolUsage: func() any { return &CheckToolUsageCreateInput{} }, CheckTypePackageVersion: func() any { return &CheckPackageVersionCreateInput{} }, CheckTypeRelationship: func() any { return &CheckRelationshipCreateInput{} }, }
var CheckUpdateConstructors = map[CheckType]CheckInputConstructor{ CheckTypeAlertSourceUsage: func() any { return &CheckAlertSourceUsageUpdateInput{} }, CheckTypeCodeIssue: func() any { return &CheckCodeIssueUpdateInput{} }, CheckTypeCustom: func() any { return &CheckUpdateInput{} }, CheckTypeGeneric: func() any { return &CheckCustomEventUpdateInput{} }, CheckTypeGitBranchProtection: func() any { return &CheckGitBranchProtectionUpdateInput{} }, CheckTypeHasDocumentation: func() any { return &CheckHasDocumentationUpdateInput{} }, CheckTypeHasOwner: func() any { return &CheckServiceOwnershipUpdateInput{} }, CheckTypeHasRecentDeploy: func() any { return &CheckHasRecentDeployUpdateInput{} }, CheckTypeHasRepository: func() any { return &CheckRepositoryIntegratedUpdateInput{} }, CheckTypeHasServiceConfig: func() any { return &CheckServiceConfigurationUpdateInput{} }, CheckTypeManual: func() any { return &CheckManualUpdateInput{} }, CheckTypePayload: func() any { return &CheckUpdateInput{} }, CheckTypeRepoFile: func() any { return &CheckRepositoryFileUpdateInput{} }, CheckTypeRepoGrep: func() any { return &CheckRepositoryGrepUpdateInput{} }, CheckTypeRepoSearch: func() any { return &CheckRepositorySearchUpdateInput{} }, CheckTypeServiceDependency: func() any { return &CheckServiceDependencyUpdateInput{} }, CheckTypeServiceProperty: func() any { return &CheckServicePropertyUpdateInput{} }, CheckTypeTagDefined: func() any { return &CheckTagDefinedUpdateInput{} }, CheckTypeToolUsage: func() any { return &CheckToolUsageUpdateInput{} }, CheckTypePackageVersion: func() any { return &CheckPackageVersionUpdateInput{} }, CheckTypeRelationship: func() any { return &CheckRelationshipUpdateInput{} }, }
Functions ¶
func AllRunnerJobOutcomeEnum ¶
func AllRunnerJobOutcomeEnum() []string
func AllRunnerJobStatusEnum ¶
func AllRunnerJobStatusEnum() []string
func AllRunnerStatusTypeEnum ¶
func AllRunnerStatusTypeEnum() []string
func HandleErrors ¶
func HasAPIErrors ¶
func IsOpsLevelApiError ¶
IsOpsLevelApiError checks if the error is returned by OpsLevel's API
func IsResourceFound ¶
func IsResourceValid ¶
IsResourceValid runs validator.Validate on all `validate` struct tags
func JsonStringAs ¶
func JsonStringAs[T any](data JsonString) (T, error)
func NewCheckCreateInputTypeOf ¶
func NewCheckCreateInputTypeOf[T any](checkCreateInput CheckCreateInput) *T
func NewCheckUpdateInputTypeOf ¶
func NewCheckUpdateInputTypeOf[T any](checkUpdateInput CheckUpdateInput) *T
func NewClientError ¶
func NewExampleOf ¶
func NewExampleOf[T any]() T
NewExampleOf makes a new OpsLevel resource with all `example` struct tags applied
func NewISO8601Date ¶
func NewISO8601DateNow ¶
func NewRestClient ¶
func NullString ¶
func NullString() *string
func SetDefaultsFor ¶
func SetDefaultsFor[T any](opslevelResource *T)
SetDefaultsFor applies all `default` struct tags
func SetExamplesFor ¶
func SetExamplesFor[T any](opslevelResource *T)
SetExamplesFor applies all `example` struct tags
func ValidateTagKey ¶
Types ¶
type AWSIntegrationFragment ¶
type AWSIntegrationInput ¶
type AWSIntegrationInput struct {
ExternalID *Nullable[string] `json:"externalId,omitempty"`
IAMRole *Nullable[string] `json:"iamRole,omitempty"`
Name *Nullable[string] `json:"name,omitempty"`
OwnershipTagKeys []string `json:"ownershipTagKeys"`
OwnershipTagOverride *Nullable[bool] `json:"awsTagsOverrideOwnership,omitempty"`
RegionOverride *[]string `json:"regionOverride,omitempty"`
}
func (AWSIntegrationInput) GetGraphQLType ¶
func (awsIntegrationInput AWSIntegrationInput) GetGraphQLType() string
type AlertSource ¶
type AlertSource struct {
Description string // The description of the alert source (Optional)
ExternalId string // The external id of the alert (Required)
Id ID // The id of the alert source (Required)
Integration IntegrationId // The integration of the alert source (Optional)
Metadata string // The metadata of the alert source (Optional)
Name string // The name of the alert source (Required)
Type AlertSourceTypeEnum // The type of the alert (Required)
Url string // The url to the alert source (Optional)
}
AlertSource An alert source that is currently integrated and belongs to the account
type AlertSourceConnection ¶
type AlertSourceConnection ConnectionBase[AlertSource]
AlertSourceConnection The connection type for AlertSource
type AlertSourceDeleteInput ¶
type AlertSourceDeleteInput struct {
Id ID `json:"id"`
}
type AlertSourceExternalIdentifier ¶
type AlertSourceExternalIdentifier struct {
ExternalId string `json:"externalId" yaml:"externalId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The external id of the alert (Required)
Type AlertSourceTypeEnum `json:"type" yaml:"type" example:"custom"` // The type of the alert (Required)
}
AlertSourceExternalIdentifier Specifies the input needed to find an alert source with external information
func NewAlertSource ¶
func NewAlertSource(kind AlertSourceTypeEnum, id string) *AlertSourceExternalIdentifier
type AlertSourceInput ¶
type AlertSourceInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the alert source (Optional)
Identifier ExternalResourceIdentifierInput `json:"identifier" yaml:"identifier"` // The alert source identifier (Required)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the alert source (Optional)
Url *Nullable[string] `json:"url,omitempty" yaml:"url,omitempty" example:"example_value"` // The url of the alert source (Optional)
}
AlertSourceInput Input fields for the mutations to manage Alert Sources
type AlertSourceService ¶
type AlertSourceService struct {
AlertSource AlertSource // The alert source that is mapped to a service (Required)
Id ID // id of the alert_source_service mapping (Required)
Service ServiceId // The service the alert source maps to (Required)
Status AlertSourceStatusTypeEnum // The status of the alert source (Required)
}
AlertSourceService An alert source that is connected with a service
type AlertSourceServiceConnection ¶
type AlertSourceServiceConnection ConnectionBase[AlertSource]
AlertSourceServiceConnection The connection type for AlertSource
type AlertSourceServiceCreateInput ¶
type AlertSourceServiceCreateInput struct {
AlertSourceExternalIdentifier *AlertSourceExternalIdentifier `json:"alertSourceExternalIdentifier,omitempty" yaml:"alertSourceExternalIdentifier,omitempty"` // Specifies the input needed to find an alert source with external information (Optional)
AlertSourceId *Nullable[ID] `json:"alertSourceId,omitempty" yaml:"alertSourceId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // Specifies the input needed to find an alert source with external information (Optional)
Service IdentifierInput `json:"service" yaml:"service"` // The service that the alert source will be attached to (Required)
}
AlertSourceServiceCreateInput Specifies the input used for attaching an alert source to a service
type AlertSourceServiceCreatePayload ¶
type AlertSourceServiceCreatePayload struct {
AlertSourceService AlertSourceService // An alert source service representing a connection between a service and an alert source (Optional)
BasePayload
}
AlertSourceServiceCreatePayload Return type for the `alertSourceServiceCreate` mutation
type AlertSourceServiceDeleteInput ¶
type AlertSourceServiceDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the alert source service to be deleted (Required)
}
AlertSourceServiceDeleteInput Specifies the input fields used in the `alertSourceServiceDelete` mutation
type AlertSourceServiceV2Connection ¶
type AlertSourceServiceV2Connection ConnectionBase[AlertSourceService]
AlertSourceServiceV2Connection The connection type for AlertSourceService
type AlertSourceStatusTypeEnum ¶
type AlertSourceStatusTypeEnum string
AlertSourceStatusTypeEnum The monitor status level
var ( AlertSourceStatusTypeEnumAlert AlertSourceStatusTypeEnum = "alert" // Monitor is reporting an alert AlertSourceStatusTypeEnumFetchingData AlertSourceStatusTypeEnum = "fetching_data" // Monitor currently being updated AlertSourceStatusTypeEnumNoData AlertSourceStatusTypeEnum = "no_data" // No data received yet. Ensure your monitors are configured correctly AlertSourceStatusTypeEnumOk AlertSourceStatusTypeEnum = "ok" // Monitor is not reporting any warnings or alerts AlertSourceStatusTypeEnumWarn AlertSourceStatusTypeEnum = "warn" // Monitor is reporting a warning )
type AlertSourceStatusUpdateInput ¶
type AlertSourceStatusUpdateInput struct {
AlertSource ExternalResourceIdentifierInput `json:"alertSource" yaml:"alertSource"` // The alert source to be updated (Required)
Status AlertSourceStatusTypeEnum `json:"status" yaml:"status" example:"alert"` // The new status of the alert source (Required)
}
AlertSourceStatusUpdateInput Specifies the input fields used in the `alertSourceStatusUpdate` mutation
type AlertSourceTypeEnum ¶
type AlertSourceTypeEnum string
AlertSourceTypeEnum The type of the alert source
var ( AlertSourceTypeEnumCustom AlertSourceTypeEnum = "custom" // A custom alert source (aka service) AlertSourceTypeEnumDatadog AlertSourceTypeEnum = "datadog" // A Datadog alert source (aka monitor) AlertSourceTypeEnumFireHydrant AlertSourceTypeEnum = "fire_hydrant" // An FireHydrant alert source (aka service) AlertSourceTypeEnumIncidentIo AlertSourceTypeEnum = "incident_io" // An incident.io alert source (aka service) AlertSourceTypeEnumNewRelic AlertSourceTypeEnum = "new_relic" // A New Relic alert source (aka service) AlertSourceTypeEnumOpsgenie AlertSourceTypeEnum = "opsgenie" // An Opsgenie alert source (aka service) AlertSourceTypeEnumPagerduty AlertSourceTypeEnum = "pagerduty" // A PagerDuty alert source (aka service) )
type AlertSourceUsageCheckFragment ¶
type AlertSourceUsageCheckFragment struct {
AlertSourceNamePredicate *Predicate `graphql:"alertSourceNamePredicate"` // The condition that the alert source name should satisfy to be evaluated.
AlertSourceType AlertSourceTypeEnum `graphql:"alertSourceType"` // The type of the alert source.
}
type AliasCreateInput ¶
type AliasCreateInput struct {
Alias string `json:"alias" yaml:"alias" example:"example_value"` // The alias you wish to create (Required)
OwnerId ID `json:"ownerId" yaml:"ownerId" example:"example_value"` // The ID of the resource you want to create the alias on. Services, teams, groups, systems, and domains are supported (Required)
}
AliasCreateInput The input for the `aliasCreate` mutation
type AliasCreatePayload ¶
type AliasCreatePayload struct {
Aliases []string // All of the aliases attached to the resource (Optional)
OwnerId string // The ID of the resource that had an alias attached (Optional)
BasePayload
}
AliasCreatePayload Return type for the `aliasCreate` mutation
type AliasDeleteInput ¶
type AliasDeleteInput struct {
Alias string `json:"alias" yaml:"alias" example:"example_value"` // The alias you wish to delete (Required)
OwnerType AliasOwnerTypeEnum `json:"ownerType" yaml:"ownerType" example:"domain"` // The resource the alias you wish to delete belongs to (Required)
}
AliasDeleteInput The input for the `aliasDelete` mutation
type AliasOwnerTypeEnum ¶
type AliasOwnerTypeEnum string
AliasOwnerTypeEnum The owner type an alias is assigned to
var ( AliasOwnerTypeEnumDomain AliasOwnerTypeEnum = "domain" // Aliases that are assigned to domains AliasOwnerTypeEnumGroup AliasOwnerTypeEnum = "group" // Aliases that are assigned to groups AliasOwnerTypeEnumInfrastructureResource AliasOwnerTypeEnum = "infrastructure_resource" // Aliases that are assigned to infrastructure resources AliasOwnerTypeEnumScorecard AliasOwnerTypeEnum = "scorecard" // Aliases that are assigned to scorecards AliasOwnerTypeEnumService AliasOwnerTypeEnum = "service" // Aliases that are assigned to services AliasOwnerTypeEnumSystem AliasOwnerTypeEnum = "system" // Aliases that are assigned to systems AliasOwnerTypeEnumTeam AliasOwnerTypeEnum = "team" // Aliases that are assigned to teams )
type AliasableResourceInterface ¶
type AliasableResourceInterface interface {
GetAliases() []string
ResourceId() ID
AliasableType() AliasOwnerTypeEnum
}
type ApiDocumentSourceEnum ¶
type ApiDocumentSourceEnum string
ApiDocumentSourceEnum The source used to determine the preferred API document
var ( ApiDocumentSourceEnumPull ApiDocumentSourceEnum = "PULL" // Use the document that was pulled by OpsLevel via a repo ApiDocumentSourceEnumPush ApiDocumentSourceEnum = "PUSH" // Use the document that was pushed to OpsLevel via an API Docs integration )
type ApprovalConfig ¶
type ApprovalConfig struct {
ApprovalRequired bool // Flag indicating approval is required (Required)
Teams []TeamId // Teams that can approve (Required)
Users []UserId // Users that can approve (Required)
}
ApprovalConfig Config for approval
type ApprovalConfigInput ¶
type ApprovalConfigInput struct {
ApprovalRequired *bool `json:"approvalRequired,omitempty" yaml:"approvalRequired,omitempty" example:"false"` // Flag indicating approval is required (Optional)
Teams *[]IdentifierInput `json:"teams,omitempty" yaml:"teams,omitempty" example:"[]"` // Teams that can approve (Optional)
Users *[]UserIdentifierInput `json:"users,omitempty" yaml:"users,omitempty" example:"[]"` // Users that can approve (Optional)
}
ApprovalConfigInput Config for approval
type ApprovalDecisionEnum ¶
type ApprovalDecisionEnum string
ApprovalDecisionEnum The set of possible outcomes for an approval decision
var ( ApprovalDecisionEnumApproved ApprovalDecisionEnum = "APPROVED" // ApprovalDecisionEnumDenied ApprovalDecisionEnum = "DENIED" // )
type ApprovalResult ¶
type ApprovalResult struct {
Actor *Approver // The actor that performed the approval/denial (Optional)
Comment string // The comment associated with the approval/denial (Optional)
DecidedAt iso8601.Time // The time the resource was approved (Required)
Status ApprovalDecisionEnum // The current decision status of the approval process (Required)
}
ApprovalResult The result details of an approvable resource being approved or denied
type Approver ¶
type Approver struct {
User UserId `graphql:"... on User"`
}
Approver The actor responsible for the approval/denial of an approvable resource.
type AwsIntegrationInput ¶
type AwsIntegrationInput struct {
AwsTagsOverrideOwnership *Nullable[bool] `json:"awsTagsOverrideOwnership,omitempty" yaml:"awsTagsOverrideOwnership,omitempty" example:"false"` // Allow tags imported from AWS to override ownership set in OpsLevel directly (Optional)
ExternalId *Nullable[string] `json:"externalId,omitempty" yaml:"externalId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The External ID defined in the trust relationship to ensure OpsLevel is the only third party assuming this role (See https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html for more details) (Optional)
IamRole *Nullable[string] `json:"iamRole,omitempty" yaml:"iamRole,omitempty" example:"example_value"` // The IAM role OpsLevel uses in order to access the AWS account (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration (Optional)
OwnershipTagKeys *Nullable[[]string] `json:"ownershipTagKeys,omitempty" yaml:"ownershipTagKeys,omitempty" example:"['tag_key1', 'tag_key2']"` // An array of tag keys used to associate ownership from an integration. Max 5 (Optional)
RegionOverride *Nullable[[]string] `json:"regionOverride,omitempty" yaml:"regionOverride,omitempty" example:"['us-east-1', 'eu-west-1']"` // Overrides the AWS region(s) that will be synchronized by this integration (Optional)
}
AwsIntegrationInput Specifies the input fields used to create and update an AWS integration
type AzureDevopsPermissionError ¶
type AzureDevopsPermissionError struct {
Name string // The name of the object that the error was encountered on (Required)
Permissions []string // The permissions that are missing (Optional)
Type string // The type of the object that the error was encountered on (Required)
}
AzureDevopsPermissionError
type AzureResourcesIntegrationInput ¶
type AzureResourcesIntegrationInput struct {
ClientId *Nullable[string] `json:"clientId,omitempty" yaml:"clientId,omitempty" example:"example_value"` // The client OpsLevel uses to access the Azure account (Optional)
ClientSecret *Nullable[string] `json:"clientSecret,omitempty" yaml:"clientSecret,omitempty" example:"example_value"` // The client secret OpsLevel uses to access the Azure account (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration (Optional)
OwnershipTagKeys *Nullable[[]string] `json:"ownershipTagKeys,omitempty" yaml:"ownershipTagKeys,omitempty" example:"['tag_key1', 'tag_key2']"` // An array of tag keys used to associate ownership from an integration. Max 5 (Optional)
SubscriptionId *Nullable[string] `json:"subscriptionId,omitempty" yaml:"subscriptionId,omitempty" example:"example_value"` // The subscription OpsLevel uses to access the Azure account (Optional)
TagsOverrideOwnership *Nullable[bool] `json:"tagsOverrideOwnership,omitempty" yaml:"tagsOverrideOwnership,omitempty" example:"false"` // Allow tags imported from Azure to override ownership set in OpsLevel directly (Optional)
TenantId *Nullable[string] `json:"tenantId,omitempty" yaml:"tenantId,omitempty" example:"example_value"` // The tenant OpsLevel uses to access the Azure account (Optional)
}
AzureResourcesIntegrationInput Specifies the input fields used to create and update an Azure resources integration
type BasePayload ¶
type BasePayload struct {
Errors []Error // List of errors that occurred while executing the mutation (Required)
}
type BasicTypeEnum ¶
type BasicTypeEnum string
BasicTypeEnum Operations that can be used on filters
var ( BasicTypeEnumDoesNotEqual BasicTypeEnum = "does_not_equal" // Does not equal a specific value BasicTypeEnumEquals BasicTypeEnum = "equals" // Equals a specific value )
type Cacher ¶
type Cacher struct {
Tiers map[string]Tier
Lifecycles map[string]Lifecycle
Systems map[string]System
Teams map[string]Team
Categories map[string]Category
Levels map[string]Level
Filters map[string]Filter
Integrations map[string]Integration
Repositories map[string]Repository
InfraSchemas map[string]InfrastructureResourceSchema
// contains filtered or unexported fields
}
func (*Cacher) CacheCategories ¶
func (*Cacher) CacheFilters ¶
func (*Cacher) CacheInfraSchemas ¶
func (*Cacher) CacheIntegrations ¶
func (*Cacher) CacheLevels ¶
func (*Cacher) CacheLifecycles ¶
func (*Cacher) CacheRepositories ¶
func (*Cacher) CacheSystems ¶
func (*Cacher) CacheTeams ¶
func (*Cacher) CacheTiers ¶
func (*Cacher) TryGetCategory ¶
func (*Cacher) TryGetInfrastructureSchema ¶
func (cacher *Cacher) TryGetInfrastructureSchema(alias string) (*InfrastructureResourceSchema, bool)
func (*Cacher) TryGetIntegration ¶
func (cacher *Cacher) TryGetIntegration(alias string) (*Integration, bool)
func (*Cacher) TryGetLifecycle ¶
func (*Cacher) TryGetRepository ¶
func (cacher *Cacher) TryGetRepository(alias string) (*Repository, bool)
type Campaign ¶
type Campaign struct {
CheckStats Stats // A summary of check results on the campaign (Optional)
EndedDate iso8601.Time // The date the campaign ended (Optional)
Filter FilterId // The filter that the campaign belongs to (Optional)
HtmlUrl string // A link to the HTML page for the resource. Ex. https://app.opslevel.com/services/shopping_cart (Required)
Id ID // The id of the campaign (Required)
Name string // The name of the campaign (Required)
Owner TeamId // The team that owns the campaign (Optional)
ProjectBrief string // The project brief of the campaign (Optional)
RawProjectBrief string // The raw unsanitized project brief of the campaign (Optional)
Reminder CampaignReminder // Configuration of an optional campaign reminder (Optional)
ServiceStats Stats // A summary of services that completed the campaign (Optional)
StartDate iso8601.Time // The date the campaign will start (Optional)
Status CampaignStatusEnum // The status of the campaign (Required)
TargetDate iso8601.Time // The target date the campaign should end (Optional)
}
Campaign A campaign is a fixed time initiative that allows you to attach checks to and progress through towards completion
type CampaignConnection ¶
type CampaignConnection ConnectionBase[Campaign]
CampaignConnection The connection type for Campaign
type CampaignFilterEnum ¶
type CampaignFilterEnum string
CampaignFilterEnum Fields that can be used as part of filter for campaigns
var ( CampaignFilterEnumID CampaignFilterEnum = "id" // Filter by `id` of campaign CampaignFilterEnumOwner CampaignFilterEnum = "owner" // Filter by campaign owner CampaignFilterEnumStatus CampaignFilterEnum = "status" // Filter by campaign status )
type CampaignReminder ¶
type CampaignReminder struct {
Channels []CampaignReminderChannelEnum // The communication channels through which the reminder will be delivered (Required)
DaysOfWeek []DayOfWeekEnum // A list of weekdays on which the reminders will be delivered. Only available with weekly frequency (Optional)
DefaultSlackChannel string // The name of the Slack channel that will be notified if a team doesn't have a default Slack contact (Optional)
Frequency int // The interval at which reminders will be delivered (Required)
FrequencyUnit CampaignReminderFrequencyUnitEnum // The time unit of the value in the 'frequency' field (Required)
Message string // The message that will be delivered as the reminder (Optional)
NextOccurrence iso8601.Time // The point in time at which the next reminder will be delivered based on the current configuration (Optional)
TimeOfDay string // The time of day at which the reminder will be delivered. Format: "HH:MM" (Required)
Timezone string // The timezone at which the timeOfDay field is evaluated (in IANA format (e.g. "America/Chicago")) (Required)
}
CampaignReminder Configuration of an optional campaign reminder
type CampaignReminderChannelEnum ¶
type CampaignReminderChannelEnum string
CampaignReminderChannelEnum The possible communication channels through which a campaign reminder can be delivered
var ( CampaignReminderChannelEnumEmail CampaignReminderChannelEnum = "email" // A system for sending messages to one or more recipients via telecommunications links between computers using dedicated software or a web-based service CampaignReminderChannelEnumMicrosoftTeams CampaignReminderChannelEnum = "microsoft_teams" // A proprietary business communication platform developed by Microsoft CampaignReminderChannelEnumSlack CampaignReminderChannelEnum = "slack" // A cloud-based team communication platform developed by Slack Technologies )
type CampaignReminderFrequencyUnitEnum ¶
type CampaignReminderFrequencyUnitEnum string
CampaignReminderFrequencyUnitEnum Possible time units for the frequency at which campaign reminders are delivered
var ( CampaignReminderFrequencyUnitEnumDay CampaignReminderFrequencyUnitEnum = "day" // A period of twenty-four hours as a unit of time, reckoned from one midnight to the next, corresponding to a rotation of the earth on its axis CampaignReminderFrequencyUnitEnumMonth CampaignReminderFrequencyUnitEnum = "month" // Each of the twelve named periods into which a year is divided CampaignReminderFrequencyUnitEnumWeek CampaignReminderFrequencyUnitEnum = "week" // A period of seven days )
type CampaignReminderTypeEnum ¶
type CampaignReminderTypeEnum string
CampaignReminderTypeEnum Type/Format of the notification
var ( CampaignReminderTypeEnumEmail CampaignReminderTypeEnum = "email" // Notification will be sent via email CampaignReminderTypeEnumMicrosoftTeams CampaignReminderTypeEnum = "microsoft_teams" // Notification will be sent by microsoft teams CampaignReminderTypeEnumSlack CampaignReminderTypeEnum = "slack" // Notification will be sent by slack )
type CampaignSendReminderOutcomeTeams ¶
type CampaignSendReminderOutcomeTeams struct {
ReminderType CampaignReminderTypeEnum // The reminder type linked to the attempt at notifying the listed teams (Required)
TeamIds []ID // List of team_ids in this group of teams (Optional)
TotalCount int // Count of number of teams listed (Required)
}
CampaignSendReminderOutcomeTeams Summarizes list of teams returned from attempt to send reminders for their failed campaigns
type CampaignServiceStatusEnum ¶
type CampaignServiceStatusEnum string
CampaignServiceStatusEnum Status of whether a service is passing all checks for a campaign or not
var ( CampaignServiceStatusEnumFailing CampaignServiceStatusEnum = "failing" // Service is failing one or more checks in the campaign CampaignServiceStatusEnumPassing CampaignServiceStatusEnum = "passing" // Service is passing all the checks in the campaign )
type CampaignSortEnum ¶
type CampaignSortEnum string
CampaignSortEnum Sort possibilities for campaigns
var ( CampaignSortEnumChecksPassingAsc CampaignSortEnum = "checks_passing_ASC" // Sort by number of `checks passing` ascending CampaignSortEnumChecksPassingDesc CampaignSortEnum = "checks_passing_DESC" // Sort by number of `checks passing` descending CampaignSortEnumEndedDateAsc CampaignSortEnum = "ended_date_ASC" // Sort by `endedDate` ascending CampaignSortEnumEndedDateDesc CampaignSortEnum = "ended_date_DESC" // Sort by `endedDate` descending CampaignSortEnumFilterAsc CampaignSortEnum = "filter_ASC" // Sort by `filter` ascending CampaignSortEnumFilterDesc CampaignSortEnum = "filter_DESC" // Sort by `filter` descending CampaignSortEnumNameAsc CampaignSortEnum = "name_ASC" // Sort by `name` ascending CampaignSortEnumNameDesc CampaignSortEnum = "name_DESC" // Sort by `name` descending CampaignSortEnumOwnerAsc CampaignSortEnum = "owner_ASC" // Sort by `owner` ascending CampaignSortEnumOwnerDesc CampaignSortEnum = "owner_DESC" // Sort by `owner` descending CampaignSortEnumServicesCompleteAsc CampaignSortEnum = "services_complete_ASC" // Sort by number of `services complete` ascending CampaignSortEnumServicesCompleteDesc CampaignSortEnum = "services_complete_DESC" // Sort by number of `services complete` descending CampaignSortEnumStartDateAsc CampaignSortEnum = "start_date_ASC" // Sort by `startDate` ascending CampaignSortEnumStartDateDesc CampaignSortEnum = "start_date_DESC" // Sort by `startDate` descending CampaignSortEnumStatusAsc CampaignSortEnum = "status_ASC" // Sort by `status` ascending CampaignSortEnumStatusDesc CampaignSortEnum = "status_DESC" // Sort by `status` descending CampaignSortEnumTargetDateAsc CampaignSortEnum = "target_date_ASC" // Sort by `targetDate` ascending CampaignSortEnumTargetDateDesc CampaignSortEnum = "target_date_DESC" // Sort by `targetDate` descending )
type CampaignStatusEnum ¶
type CampaignStatusEnum string
CampaignStatusEnum The campaign status
var ( CampaignStatusEnumDelayed CampaignStatusEnum = "delayed" // Campaign is delayed CampaignStatusEnumDraft CampaignStatusEnum = "draft" // Campaign has been created but is not yet active CampaignStatusEnumEnded CampaignStatusEnum = "ended" // Campaign ended CampaignStatusEnumInProgress CampaignStatusEnum = "in_progress" // Campaign is in progress CampaignStatusEnumScheduled CampaignStatusEnum = "scheduled" // Campaign has been scheduled to begin in the future )
type CampaignTeam ¶
type CampaignTeam struct {
Team TeamId // The team impacted by the campaign (Required)
}
CampaignTeam Team from the campaign context
type Category ¶
type Category struct {
Description string // The description of the category (Optional)
Id ID // The unique identifier for the category (Required)
Name string // The display name of the category (Required)
}
Category A category is used to group related checks in a rubric
type CategoryBreakdown ¶
type CategoryConnection ¶
type CategoryConnection ConnectionBase[Category]
CategoryConnection The connection type for Category
type CategoryCreateInput ¶
type CategoryCreateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the category (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the category (Required)
}
CategoryCreateInput Specifies the input fields used to create a category
type CategoryCreatePayload ¶
type CategoryCreatePayload struct {
Category Category // A category is used to group related checks in a rubric (Optional)
BasePayload
}
CategoryCreatePayload The return type of the `categoryCreate` mutation
type CategoryDeleteInput ¶
type CategoryDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category to be deleted (Required)
}
CategoryDeleteInput Specifies the input fields used to delete a category
type CategoryLevel ¶
type CategoryLevel struct {
Category Category // A category is used to group related checks in a rubric (Required)
Level Level // A performance rating that is used to grade your services against (Optional)
}
CategoryLevel The level of a specific category
type CategoryUpdateInput ¶
type CategoryUpdateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the category (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category to be updated (Required)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the category (Optional)
}
CategoryUpdateInput Specifies the input fields used to update a category
type CategoryUpdatePayload ¶
type CategoryUpdatePayload struct {
Category Category // A category is used to group related checks in a rubric (Optional)
BasePayload
}
CategoryUpdatePayload The return type of the `categoryUpdate` mutation
type Check ¶
type Check struct {
Category Category `graphql:"category"` // The category that the check belongs to.
Description string `graphql:"description"` // Description of the check type's purpose.
EnableOn iso8601.Time `graphql:"enableOn"` // The date when the check will be automatically enabled.
Enabled bool `graphql:"enabled"` // If the check is enabled or not.
Filter Filter `graphql:"filter"` // The filter that the check belongs to.
Id ID `graphql:"id"` // The id of the check.
Level Level `graphql:"level"` // The level that the check belongs to.
Name string `graphql:"name"` // The display name of the check.
Notes string `graphql:"notes: rawNotes"` // Additional information about the check.
Owner CheckOwner `graphql:"owner"` // The owner of the check.
Type CheckType `graphql:"type"` // The type of check.
AlertSourceUsageCheckFragment `graphql:"... on AlertSourceUsageCheck"`
CodeIssueCheckFragment `graphql:"... on CodeIssueCheck"`
CustomEventCheckFragment `graphql:"... on CustomEventCheck"`
HasRecentDeployCheckFragment `graphql:"... on HasRecentDeployCheck"`
ManualCheckFragment `graphql:"... on ManualCheck"`
RepositoryFileCheckFragment `graphql:"... on RepositoryFileCheck"`
RepositoryGrepCheckFragment `graphql:"... on RepositoryGrepCheck"`
RepositorySearchCheckFragment `graphql:"... on RepositorySearchCheck"`
ServiceOwnershipCheckFragment `graphql:"... on ServiceOwnershipCheck"`
ServicePropertyCheckFragment `graphql:"... on ServicePropertyCheck"`
TagDefinedCheckFragment `graphql:"... on TagDefinedCheck"`
ToolUsageCheckFragment `graphql:"... on ToolUsageCheck"`
HasDocumentationCheckFragment `graphql:"... on HasDocumentationCheck"`
PackageVersionCheckFragment `graphql:"... on PackageVersionCheck"`
RelationshipCheckFragment `graphql:"... on RelationshipCheck"`
}
Check represents checks allow you to monitor how your services are built and operated.
type CheckAlertSourceUsageCreateInput ¶
type CheckAlertSourceUsageCreateInput struct {
AlertSourceNamePredicate *PredicateInput `json:"alertSourceNamePredicate,omitempty" yaml:"alertSourceNamePredicate,omitempty"` // The condition that the alert source name should satisfy to be evaluated (Optional)
AlertSourceType *AlertSourceTypeEnum `json:"alertSourceType,omitempty" yaml:"alertSourceType,omitempty" example:"custom"` // The type of the alert source (Optional)
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckAlertSourceUsageCreateInput Specifies the input fields used to create an alert source usage check
type CheckAlertSourceUsageUpdateInput ¶
type CheckAlertSourceUsageUpdateInput struct {
AlertSourceNamePredicate *PredicateUpdateInput `json:"alertSourceNamePredicate,omitempty" yaml:"alertSourceNamePredicate,omitempty"` // The condition that the alert source name should satisfy to be evaluated (Optional)
AlertSourceType *AlertSourceTypeEnum `json:"alertSourceType,omitempty" yaml:"alertSourceType,omitempty" example:"custom"` // The type of the alert source (Optional)
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckAlertSourceUsageUpdateInput Specifies the input fields used to update an alert source usage check
type CheckCodeIssueConstraintEnum ¶
type CheckCodeIssueConstraintEnum string
CheckCodeIssueConstraintEnum The values allowed for the constraint type for the code issues check
var ( CheckCodeIssueConstraintEnumAny CheckCodeIssueConstraintEnum = "any" // The check will look for any code issues regardless of issue name CheckCodeIssueConstraintEnumContains CheckCodeIssueConstraintEnum = "contains" // The check will look for any code issues by name containing the issue name CheckCodeIssueConstraintEnumExact CheckCodeIssueConstraintEnum = "exact" // The check will look for any code issues matching the issue name exactly )
type CheckCodeIssueCreateInput ¶
type CheckCodeIssueCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
Constraint CheckCodeIssueConstraintEnum `json:"constraint" yaml:"constraint" example:"any"` // The type of constraint used in evaluation the code issues check (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
IssueName *Nullable[string] `json:"issueName,omitempty" yaml:"issueName,omitempty" example:"example_value"` // The issue name used for code issue lookup (Optional)
IssueType *Nullable[[]string] `json:"issueType,omitempty" yaml:"issueType,omitempty" example:"['bug', 'error']"` // The type of code issue to consider (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
MaxAllowed *int `json:"maxAllowed,omitempty" yaml:"maxAllowed,omitempty" example:"3"` // The threshold count of code issues beyond which the check starts failing (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
ResolutionTime *CodeIssueResolutionTimeInput `json:"resolutionTime,omitempty" yaml:"resolutionTime,omitempty"` // The resolution time recommended by the reporting source of the code issue (Optional)
Severity *Nullable[[]string] `json:"severity,omitempty" yaml:"severity,omitempty" example:"['sev1', 'sev2']"` // The severity levels of the issue (Optional)
}
CheckCodeIssueCreateInput Specifies the input fields used to create a code issue check
type CheckCodeIssueUpdateInput ¶
type CheckCodeIssueUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
Constraint CheckCodeIssueConstraintEnum `json:"constraint" yaml:"constraint" example:"any"` // The type of constraint used in evaluation the code issues check (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
IssueName *Nullable[string] `json:"issueName,omitempty" yaml:"issueName,omitempty" example:"example_value"` // The issue name used for code issue lookup (Optional)
IssueType *Nullable[[]string] `json:"issueType,omitempty" yaml:"issueType,omitempty" example:"['bug', 'error']"` // The type of code issue to consider (Optional)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
MaxAllowed *int `json:"maxAllowed,omitempty" yaml:"maxAllowed,omitempty" example:"3"` // The threshold count of code issues beyond which the check starts failing (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
ResolutionTime *CodeIssueResolutionTimeInput `json:"resolutionTime,omitempty" yaml:"resolutionTime,omitempty"` // The resolution time recommended by the reporting source of the code issue (Optional)
Severity *Nullable[[]string] `json:"severity,omitempty" yaml:"severity,omitempty" example:"['sev1', 'sev2']"` // The severity levels of the issue (Optional)
}
CheckCodeIssueUpdateInput Specifies the input fields used to update an exasting code issue check
type CheckConnection ¶
type CheckConnection ConnectionBase[Check]
CheckConnection The connection type for Check
type CheckCopyInput ¶
type CheckCopyInput struct {
CheckIds []ID `json:"checkIds" yaml:"checkIds" example:"['Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk', 'Z2lkOi8vc2VydmljZS85ODc2NTQzMjE']"` // The IDs of the checks to be copied (Required)
Move *Nullable[bool] `json:"move,omitempty" yaml:"move,omitempty" example:"false"` // If set to true, the original checks will be deleted after being successfully copied (Optional)
TargetCategoryId ID `json:"targetCategoryId" yaml:"targetCategoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the category to which the checks are copied. Belongs to either the rubric or a scorecard (Required)
TargetLevelId *Nullable[ID] `json:"targetLevelId,omitempty" yaml:"targetLevelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the level which the copied checks are associated with (Optional)
}
CheckCopyInput Information about the check(s) that are to be copied
type CheckCopyPayload ¶
type CheckCopyPayload struct {
TargetCategory Category // The category to which the checks have been copied (Optional)
BasePayload
}
CheckCopyPayload The result of a check copying operation
type CheckCreateInput ¶
type CheckCreateInput struct {
Category ID `json:"categoryId" yaml:"categoryId" mapstructure:"categoryId"`
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" mapstructure:"enabledOn,omitempty"`
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" mapstructure:"enabled"`
Filter *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" mapstructure:"filterId,omitempty"`
Level ID `json:"levelId" yaml:"levelId" mapstructure:"levelId"`
Name string `json:"name" yaml:"name" mapstructure:"name"`
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" mapstructure:"notes,omitempty"`
Owner *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" mapstructure:"ownerId,omitempty"`
}
type CheckCreateInputProvider ¶
type CheckCreateInputProvider interface {
GetCheckCreateInput() *CheckCreateInput
}
type CheckCustomEventCreateInput ¶
type CheckCustomEventCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
IntegrationId ID `json:"integrationId" yaml:"integrationId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The integration id this check will use (Required)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
PassPending *Nullable[bool] `json:"passPending,omitempty" yaml:"passPending,omitempty" example:"false"` // True if this check should pass by default. Otherwise the default 'pending' state counts as a failure (Optional)
ResultMessage *Nullable[string] `json:"resultMessage,omitempty" yaml:"resultMessage,omitempty" example:"example_value"` // The check result message template. It is compiled with Liquid and formatted in Markdown. [More info about liquid templates](https://docs.opslevel.com/docs/checks/payload-checks/#liquid-templating) (Optional)
ServiceSelector string `json:"serviceSelector" yaml:"serviceSelector" example:"example_value"` // A jq expression that will be ran against your payload. This will parse out the service identifier. [More info about jq](https://jqplay.org/) (Required)
SuccessCondition string `json:"successCondition" yaml:"successCondition" example:"example_value"` // A jq expression that will be ran against your payload. A truthy value will result in the check passing. [More info about jq](https://jqplay.org/) (Required)
}
CheckCustomEventCreateInput Creates a custom event check
type CheckCustomEventUpdateInput ¶
type CheckCustomEventUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
IntegrationId *Nullable[ID] `json:"integrationId,omitempty" yaml:"integrationId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The integration id this check will use (Optional)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
PassPending *Nullable[bool] `json:"passPending,omitempty" yaml:"passPending,omitempty" example:"false"` // True if this check should pass by default. Otherwise the default 'pending' state counts as a failure (Optional)
ResultMessage *Nullable[string] `json:"resultMessage,omitempty" yaml:"resultMessage,omitempty" example:"example_value"` // The check result message template. It is compiled with Liquid and formatted in Markdown. [More info about liquid templates](https://docs.opslevel.com/docs/checks/payload-checks/#liquid-templating) (Optional)
ServiceSelector *Nullable[string] `json:"serviceSelector,omitempty" yaml:"serviceSelector,omitempty" example:"example_value"` // A jq expression that will be ran against your payload. This will parse out the service identifier. [More info about jq](https://jqplay.org/) (Optional)
SuccessCondition *Nullable[string] `json:"successCondition,omitempty" yaml:"successCondition,omitempty" example:"example_value"` // A jq expression that will be ran against your payload. A truthy value will result in the check passing. [More info about jq](https://jqplay.org/) (Optional)
}
CheckCustomEventUpdateInput Specifies the input fields used to update a custom event check
type CheckDeleteInput ¶
type CheckDeleteInput struct {
Id *Nullable[ID] `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be deleted (Optional)
}
CheckDeleteInput Specifies the input fields used to delete a check
type CheckGitBranchProtectionCreateInput ¶
type CheckGitBranchProtectionCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckGitBranchProtectionCreateInput Specifies the input fields used to create a branch protection check
type CheckGitBranchProtectionUpdateInput ¶
type CheckGitBranchProtectionUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckGitBranchProtectionUpdateInput Specifies the input fields used to update a branch protection check
type CheckHasDocumentationCreateInput ¶
type CheckHasDocumentationCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
DocumentSubtype HasDocumentationSubtypeEnum `json:"documentSubtype" yaml:"documentSubtype" example:"openapi"` // The subtype of the document (Required)
DocumentType HasDocumentationTypeEnum `json:"documentType" yaml:"documentType" example:"api"` // The type of the document (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckHasDocumentationCreateInput Specifies the input fields used to create a documentation check
type CheckHasDocumentationUpdateInput ¶
type CheckHasDocumentationUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
DocumentSubtype *HasDocumentationSubtypeEnum `json:"documentSubtype,omitempty" yaml:"documentSubtype,omitempty" example:"openapi"` // The subtype of the document (Optional)
DocumentType *HasDocumentationTypeEnum `json:"documentType,omitempty" yaml:"documentType,omitempty" example:"api"` // The type of the document (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckHasDocumentationUpdateInput Specifies the input fields used to update a documentation check
type CheckHasRecentDeployCreateInput ¶
type CheckHasRecentDeployCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
Days int `json:"days" yaml:"days" example:"3"` // The number of days to check since the last deploy (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckHasRecentDeployCreateInput Specifies the input fields used to create a recent deploys check
type CheckHasRecentDeployUpdateInput ¶
type CheckHasRecentDeployUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
Days *int `json:"days,omitempty" yaml:"days,omitempty" example:"3"` // The number of days to check since the last deploy (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckHasRecentDeployUpdateInput Specifies the input fields used to update a has recent deploy check
type CheckInputConstructor ¶
type CheckInputConstructor func() any
type CheckManualCreateInput ¶
type CheckManualCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
UpdateFrequency *ManualCheckFrequencyInput `json:"updateFrequency,omitempty" yaml:"updateFrequency,omitempty"` // Defines the minimum frequency of the updates (Optional)
UpdateRequiresComment bool `json:"updateRequiresComment" yaml:"updateRequiresComment" example:"false"` // Whether the check requires a comment or not (Required)
}
CheckManualCreateInput Specifies the input fields used to create a manual check
type CheckManualUpdateInput ¶
type CheckManualUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
UpdateFrequency *ManualCheckFrequencyUpdateInput `json:"updateFrequency,omitempty" yaml:"updateFrequency,omitempty"` // Defines the minimum frequency of the updates (Optional)
UpdateRequiresComment *Nullable[bool] `json:"updateRequiresComment,omitempty" yaml:"updateRequiresComment,omitempty" example:"false"` // Whether the check requires a comment or not (Optional)
}
CheckManualUpdateInput Specifies the input fields used to update a manual check
type CheckOwner ¶
type CheckOwner struct {
Team TeamId `graphql:"... on Team"`
}
CheckOwner represents the owner a check can belong to.
type CheckPackageVersionCreateInput ¶
type CheckPackageVersionCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
MissingPackageResult *CheckResultStatusEnum `json:"missingPackageResult,omitempty" yaml:"missingPackageResult,omitempty" example:"failed"` // The check result if the package isn't being used by a service (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
PackageConstraint PackageConstraintEnum `json:"packageConstraint" yaml:"packageConstraint" example:"does_not_exist"` // The package constraint the service is to be checked for (Required)
PackageManager PackageManagerEnum `json:"packageManager" yaml:"packageManager" example:"alpm"` // The package manager (ecosystem) this package relates to (Required)
PackageName string `json:"packageName" yaml:"packageName" example:"example_value"` // The name of the package to be checked (Required)
PackageNameIsRegex *Nullable[bool] `json:"packageNameIsRegex,omitempty" yaml:"packageNameIsRegex,omitempty" example:"false"` // Whether or not the value in the package name field is a regular expression (Optional)
VersionConstraintPredicate *PredicateInput `json:"versionConstraintPredicate,omitempty" yaml:"versionConstraintPredicate,omitempty"` // The predicate that describes the version constraint the package must satisfy (Optional)
}
CheckPackageVersionCreateInput Information about the package version check to be created
type CheckPackageVersionUpdateInput ¶
type CheckPackageVersionUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
MissingPackageResult *Nullable[CheckResultStatusEnum] `json:"missingPackageResult,omitempty" yaml:"missingPackageResult,omitempty" example:"failed"` // The check result if the package isn't being used by a service (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
PackageConstraint *Nullable[PackageConstraintEnum] `json:"packageConstraint,omitempty" yaml:"packageConstraint,omitempty" example:"does_not_exist"` // The package constraint the service is to be checked for (Optional)
PackageManager *Nullable[PackageManagerEnum] `json:"packageManager,omitempty" yaml:"packageManager,omitempty" example:"alpm"` // The package manager (ecosystem) this package relates to (Optional)
PackageName *Nullable[string] `json:"packageName,omitempty" yaml:"packageName,omitempty" example:"example_value"` // The name of the package to be checked (Optional)
PackageNameIsRegex *Nullable[bool] `json:"packageNameIsRegex,omitempty" yaml:"packageNameIsRegex,omitempty" example:"false"` // Whether or not the value in the package name field is a regular expression (Optional)
VersionConstraintPredicate *Nullable[PredicateUpdateInput] `json:"versionConstraintPredicate,omitempty" yaml:"versionConstraintPredicate,omitempty"` // The predicate that describes the version constraint the package must satisfy (Optional)
}
CheckPackageVersionUpdateInput Information about the package version check to be updated
type CheckRelationshipCreateInput ¶
type CheckRelationshipCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
RelationshipCountPredicate PredicateInput `json:"relationshipCountPredicate" yaml:"relationshipCountPredicate"` // The condition that should be satisfied by the number of RelatedTo relationships (Required)
RelationshipDefinitionId ID `json:"relationshipDefinitionId" yaml:"relationshipDefinitionId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // Count relationships of a specific relationship definition (Required)
}
CheckRelationshipCreateInput Specifies the input fields used to create a relationships check
type CheckRelationshipUpdateInput ¶
type CheckRelationshipUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
RelationshipCountPredicate *PredicateInput `json:"relationshipCountPredicate,omitempty" yaml:"relationshipCountPredicate,omitempty"` // The condition that should be satisfied by the number of RelatedTo relationships (Optional)
RelationshipDefinitionId *ID `json:"relationshipDefinitionId,omitempty" yaml:"relationshipDefinitionId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // Count relationships of a specific relationship definition (Optional)
}
CheckRelationshipUpdateInput Specifies the input fields used to update a relationships check
type CheckRepositoryFileCreateInput ¶
type CheckRepositoryFileCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
DirectorySearch *Nullable[bool] `json:"directorySearch,omitempty" yaml:"directorySearch,omitempty" example:"false"` // Whether the check looks for the existence of a directory instead of a file (Optional Default: false)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FileContentsPredicate *PredicateInput `json:"fileContentsPredicate,omitempty" yaml:"fileContentsPredicate,omitempty"` // Condition to match the file content (Optional)
FilePaths []string `json:"filePaths" yaml:"filePaths" example:"['/usr/local/bin', '/home/opslevel']"` // Restrict the search to certain file paths (Required)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
UseAbsoluteRoot *Nullable[bool] `json:"useAbsoluteRoot,omitempty" yaml:"useAbsoluteRoot,omitempty" example:"false"` // Whether the checks looks at the absolute root of a repo or the relative root (the directory specified when attached a repo to a service) (Optional Default: false)
}
CheckRepositoryFileCreateInput Specifies the input fields used to create a repo file check
type CheckRepositoryFileUpdateInput ¶
type CheckRepositoryFileUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
DirectorySearch *Nullable[bool] `json:"directorySearch,omitempty" yaml:"directorySearch,omitempty" example:"false"` // Whether the check looks for the existence of a directory instead of a file (Optional Default: false)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FileContentsPredicate *PredicateUpdateInput `json:"fileContentsPredicate,omitempty" yaml:"fileContentsPredicate,omitempty"` // Condition to match the file content (Optional)
FilePaths *Nullable[[]string] `json:"filePaths,omitempty" yaml:"filePaths,omitempty" example:"['/usr/local/bin', '/home/opslevel']"` // Restrict the search to certain file paths (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
UseAbsoluteRoot *Nullable[bool] `json:"useAbsoluteRoot,omitempty" yaml:"useAbsoluteRoot,omitempty" example:"false"` // Whether the checks looks at the absolute root of a repo or the relative root (the directory specified when attached a repo to a service) (Optional Default: false)
}
CheckRepositoryFileUpdateInput Specifies the input fields used to update a repo file check
type CheckRepositoryGrepCreateInput ¶
type CheckRepositoryGrepCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
DirectorySearch *Nullable[bool] `json:"directorySearch,omitempty" yaml:"directorySearch,omitempty" example:"false"` // Whether the check looks for the existence of a directory instead of a file (Optional Default: false)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FileContentsPredicate PredicateInput `json:"fileContentsPredicate" yaml:"fileContentsPredicate"` // Condition to match the file content (Required)
FilePaths []string `json:"filePaths" yaml:"filePaths" example:"['/usr/local/bin', '/home/opslevel']"` // Restrict the search to certain file paths (Required)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckRepositoryGrepCreateInput Specifies the input fields used to create a repo grep check
type CheckRepositoryGrepUpdateInput ¶
type CheckRepositoryGrepUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
DirectorySearch *Nullable[bool] `json:"directorySearch,omitempty" yaml:"directorySearch,omitempty" example:"false"` // Whether the check looks for the existence of a directory instead of a file (Optional Default: false)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FileContentsPredicate *PredicateUpdateInput `json:"fileContentsPredicate,omitempty" yaml:"fileContentsPredicate,omitempty"` // Condition to match the file content (Optional)
FilePaths *Nullable[[]string] `json:"filePaths,omitempty" yaml:"filePaths,omitempty" example:"['/usr/local/bin', '/home/opslevel']"` // Restrict the search to certain file paths (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckRepositoryGrepUpdateInput Specifies the input fields used to update a repo file check
type CheckRepositoryIntegratedCreateInput ¶
type CheckRepositoryIntegratedCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckRepositoryIntegratedCreateInput Specifies the input fields used to create a repository integrated check
type CheckRepositoryIntegratedUpdateInput ¶
type CheckRepositoryIntegratedUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckRepositoryIntegratedUpdateInput Specifies the input fields used to update a repository integrated check
type CheckRepositorySearchCreateInput ¶
type CheckRepositorySearchCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FileContentsPredicate PredicateInput `json:"fileContentsPredicate" yaml:"fileContentsPredicate"` // Condition to match the text content (Required)
FileExtensions *Nullable[[]string] `json:"fileExtensions,omitempty" yaml:"fileExtensions,omitempty" example:"['go', 'py', 'rb']"` // Restrict the search to files of given extensions. Extensions should contain only letters and numbers. For example: `['py', 'rb']` (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckRepositorySearchCreateInput Specifies the input fields used to create a repo search check
type CheckRepositorySearchUpdateInput ¶
type CheckRepositorySearchUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FileContentsPredicate *PredicateUpdateInput `json:"fileContentsPredicate,omitempty" yaml:"fileContentsPredicate,omitempty"` // Condition to match the text content (Optional)
FileExtensions *Nullable[[]string] `json:"fileExtensions,omitempty" yaml:"fileExtensions,omitempty" example:"['go', 'py', 'rb']"` // Restrict the search to files of given extensions. Extensions should contain only letters and numbers. For example: `['py', 'rb']` (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckRepositorySearchUpdateInput Specifies the input fields used to update a repo search check
type CheckResponsePayload ¶
type CheckResponsePayload struct {
Check Check // The newly created check (Optional)
BasePayload
}
CheckResponsePayload The return type of a `checkCreate` mutation and `checkUpdate` mutation
type CheckResult ¶
type CheckResult struct {
Check CheckId // The check of check result (Required)
LastUpdated iso8601.Time // The time the check most recently ran (Required)
Message string // The check message (Required)
Service ServiceId // The service of check result (Optional)
ServiceAlias string // The alias for the service (Optional)
Status CheckStatus // The check status (Required)
}
CheckResult The result for a given Check
type CheckResultStatusEnum ¶
type CheckResultStatusEnum string
CheckResultStatusEnum The status of the check result
var ( CheckResultStatusEnumFailed CheckResultStatusEnum = "failed" // Indicates that the check has failed for the associated service CheckResultStatusEnumPassed CheckResultStatusEnum = "passed" // Indicates that the check has passed for the associated service. )
type CheckResultsByLevel ¶
type CheckResultsByLevel struct {
Items CheckResultsConnection // A list of check results by level (Optional)
Level Level // The check result level (Optional)
}
CheckResultsByLevel The check results grouped by level
type CheckResultsByLevelConnection ¶
type CheckResultsByLevelConnection ConnectionBase[CheckResultsByLevel]
CheckResultsByLevelConnection The connection type for CheckResultsByLevel
type CheckResultsConnection ¶
type CheckResultsConnection ConnectionBase[CheckResult]
CheckResultsConnection The connection type for CheckResult
type CheckServiceConfigurationCreateInput ¶
type CheckServiceConfigurationCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckServiceConfigurationCreateInput Specifies the input fields used to create a configuration check
type CheckServiceConfigurationUpdateInput ¶
type CheckServiceConfigurationUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckServiceConfigurationUpdateInput Specifies the input fields used to update a configuration check
type CheckServiceDependencyCreateInput ¶
type CheckServiceDependencyCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
}
CheckServiceDependencyCreateInput Specifies the input fields used to create a service dependency check
type CheckServiceDependencyUpdateInput ¶
type CheckServiceDependencyUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
}
CheckServiceDependencyUpdateInput Specifies the input fields used to update a service dependency check
type CheckServiceOwnershipCreateInput ¶
type CheckServiceOwnershipCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
ContactMethod *Nullable[string] `json:"contactMethod,omitempty" yaml:"contactMethod,omitempty" example:"example_value"` // The type of contact method that an owner should provide (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
RequireContactMethod *Nullable[bool] `json:"requireContactMethod,omitempty" yaml:"requireContactMethod,omitempty" example:"false"` // Whether to require a contact method for a service owner or not (Optional)
TagKey *Nullable[string] `json:"tagKey,omitempty" yaml:"tagKey,omitempty" example:"example_value"` // The tag key that should exist for a service owner (Optional)
TagPredicate *PredicateInput `json:"tagPredicate,omitempty" yaml:"tagPredicate,omitempty"` // The condition that should be satisfied by the tag value (Optional)
}
CheckServiceOwnershipCreateInput Specifies the input fields used to create an ownership check
type CheckServiceOwnershipUpdateInput ¶
type CheckServiceOwnershipUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
ContactMethod *Nullable[string] `json:"contactMethod,omitempty" yaml:"contactMethod,omitempty" example:"example_value"` // The type of contact method that an owner should provide (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
RequireContactMethod *Nullable[bool] `json:"requireContactMethod,omitempty" yaml:"requireContactMethod,omitempty" example:"false"` // Whether to require a contact method for a service owner or not (Optional)
TagKey *Nullable[string] `json:"tagKey,omitempty" yaml:"tagKey,omitempty" example:"example_value"` // The tag key that should exist for a service owner (Optional)
TagPredicate *PredicateUpdateInput `json:"tagPredicate,omitempty" yaml:"tagPredicate,omitempty"` // The condition that should be satisfied by the tag value (Optional)
}
CheckServiceOwnershipUpdateInput Specifies the input fields used to update an ownership check
type CheckServicePropertyCreateInput ¶
type CheckServicePropertyCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
ComponentType *IdentifierInput `json:"componentType,omitempty" yaml:"componentType,omitempty"` // The Component Type that a custom property belongs to. Defaults to Service properties if not provided (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
PropertyDefinition *IdentifierInput `json:"propertyDefinition,omitempty" yaml:"propertyDefinition,omitempty"` // The secondary key of the property that the check will verify (e.g. the specific custom property) (Optional)
PropertyValuePredicate *PredicateInput `json:"propertyValuePredicate,omitempty" yaml:"propertyValuePredicate,omitempty"` // The condition that should be satisfied by the service property value (Optional)
ServiceProperty ServicePropertyTypeEnum `json:"serviceProperty" yaml:"serviceProperty" example:"custom_property"` // The property of the service that the check will verify (Required)
}
CheckServicePropertyCreateInput Specifies the input fields used to create a service property check
type CheckServicePropertyUpdateInput ¶
type CheckServicePropertyUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
ComponentType *IdentifierInput `json:"componentType,omitempty" yaml:"componentType,omitempty"` // The Component Type that a custom property belongs to. Defaults to Service properties if not provided (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
PropertyDefinition *IdentifierInput `json:"propertyDefinition,omitempty" yaml:"propertyDefinition,omitempty"` // The secondary key of the property that the check will verify (e.g. the specific custom property) (Optional)
PropertyValuePredicate *PredicateUpdateInput `json:"propertyValuePredicate,omitempty" yaml:"propertyValuePredicate,omitempty"` // The condition that should be satisfied by the service property value (Optional)
ServiceProperty *ServicePropertyTypeEnum `json:"serviceProperty,omitempty" yaml:"serviceProperty,omitempty" example:"custom_property"` // The property of the service that the check will verify (Optional)
}
CheckServicePropertyUpdateInput Specifies the input fields used to update a service property check
type CheckStats ¶
type CheckStats struct {
PassingChecksPercentage float64 // The percentage of checks that are passing for the resource (Required)
TotalChecks int // The number of existing checks for the resource (Required)
TotalPassingChecks int // The number of checks that are passing for the resource (Required)
}
CheckStats Check stats shows a summary of check results
type CheckStatus ¶
type CheckStatus string
CheckStatus The evaluation status of the check
var ( CheckStatusFailed CheckStatus = "failed" // The check evaluated to a falsy value based on some conditions CheckStatusPassed CheckStatus = "passed" // The check evaluated to a truthy value based on some conditions CheckStatusPending CheckStatus = "pending" // The check has not been evaluated yet. )
type CheckTagDefinedCreateInput ¶
type CheckTagDefinedCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
TagKey string `json:"tagKey" yaml:"tagKey" example:"example_value"` // The tag key where the tag predicate should be applied (Required)
TagPredicate *PredicateInput `json:"tagPredicate,omitempty" yaml:"tagPredicate,omitempty"` // The condition that should be satisfied by the tag value (Optional)
}
CheckTagDefinedCreateInput Specifies the input fields used to create a tag check
type CheckTagDefinedUpdateInput ¶
type CheckTagDefinedUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
TagKey *Nullable[string] `json:"tagKey,omitempty" yaml:"tagKey,omitempty" example:"example_value"` // The tag key where the tag predicate should be applied (Optional)
TagPredicate *PredicateUpdateInput `json:"tagPredicate,omitempty" yaml:"tagPredicate,omitempty"` // The condition that should be satisfied by the tag value (Optional)
}
CheckTagDefinedUpdateInput Specifies the input fields used to update a tag defined check
type CheckToPromoteInput ¶
type CheckToPromoteInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the category that the promoted check will be linked to (Required)
CheckId ID `json:"checkId" yaml:"checkId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the check to be promoted to the rubric (Required)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the level that the promoted check will be linked to (Required)
}
CheckToPromoteInput Specifies the input fields used to promote a campaign check to the rubric
type CheckToolUsageCreateInput ¶
type CheckToolUsageCreateInput struct {
CategoryId ID `json:"categoryId" yaml:"categoryId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Required)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional Default: false)
EnvironmentPredicate *PredicateInput `json:"environmentPredicate,omitempty" yaml:"environmentPredicate,omitempty"` // The condition that the environment should satisfy to be evaluated (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter of the check (Optional)
LevelId ID `json:"levelId" yaml:"levelId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the check (Required)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team that owns the check (Optional)
ToolCategory ToolCategory `json:"toolCategory" yaml:"toolCategory" example:"admin"` // The category that the tool belongs to (Required)
ToolNamePredicate *PredicateInput `json:"toolNamePredicate,omitempty" yaml:"toolNamePredicate,omitempty"` // The condition that the tool name should satisfy to be evaluated (Optional)
ToolUrlPredicate *PredicateInput `json:"toolUrlPredicate,omitempty" yaml:"toolUrlPredicate,omitempty"` // The condition that the tool url should satisfy to be evaluated (Optional)
}
CheckToolUsageCreateInput Specifies the input fields used to create a tool usage check
type CheckToolUsageUpdateInput ¶
type CheckToolUsageUpdateInput struct {
CategoryId *Nullable[ID] `json:"categoryId,omitempty" yaml:"categoryId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the category the check belongs to (Optional)
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" yaml:"enableOn,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date when the check will be automatically enabled (Optional)
Enabled *Nullable[bool] `json:"enabled,omitempty" yaml:"enabled,omitempty" example:"false"` // Whether the check is enabled or not (Optional)
EnvironmentPredicate *PredicateUpdateInput `json:"environmentPredicate,omitempty" yaml:"environmentPredicate,omitempty"` // The condition that the environment should satisfy to be evaluated (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter the check belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the check to be updated (Required)
LevelId *Nullable[ID] `json:"levelId,omitempty" yaml:"levelId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level the check belongs to (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the check (Optional)
Notes *string `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Additional information about the check (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of the check (Optional)
ToolCategory *ToolCategory `json:"toolCategory,omitempty" yaml:"toolCategory,omitempty" example:"admin"` // The category that the tool belongs to (Optional)
ToolNamePredicate *PredicateUpdateInput `json:"toolNamePredicate,omitempty" yaml:"toolNamePredicate,omitempty"` // The condition that the tool name should satisfy to be evaluated (Optional)
ToolUrlPredicate *PredicateUpdateInput `json:"toolUrlPredicate,omitempty" yaml:"toolUrlPredicate,omitempty"` // The condition that the tool url should satisfy to be evaluated (Optional)
}
CheckToolUsageUpdateInput Specifies the input fields used to update a tool usage check
type CheckType ¶
type CheckType string
CheckType The type of check
var ( CheckTypeAlertSourceUsage CheckType = "alert_source_usage" // Verifies that the service has an alert source of a particular type or name CheckTypeCodeIssue CheckType = "code_issue" // Verifies that the severity and quantity of code issues does not exceed defined thresholds CheckTypeCustom CheckType = "custom" // Allows for the creation of programmatic checks that use an API to mark the status as passing or failing CheckTypeGeneric CheckType = "generic" // Requires a generic integration api call to complete a series of checks for multiple services CheckTypeGitBranchProtection CheckType = "git_branch_protection" // Verifies that all the repositories on the service have branch protection enabled CheckTypeHasDocumentation CheckType = "has_documentation" // Verifies that the service has visible documentation of a particular type and subtype CheckTypeHasOwner CheckType = "has_owner" // Verifies that the service has an owner defined CheckTypeHasRecentDeploy CheckType = "has_recent_deploy" // Verifies that the services has received a deploy within a specified number of days CheckTypeHasRepository CheckType = "has_repository" // Verifies that the service has a repository integrated CheckTypeHasServiceConfig CheckType = "has_service_config" // Verifies that the service is maintained though the use of an opslevel.yml service config CheckTypeManual CheckType = "manual" // Requires a service owner to manually complete a check for the service CheckTypePackageVersion CheckType = "package_version" // Verifies certain aspects of a service using or not using software packages CheckTypePayload CheckType = "payload" // Requires a payload integration api call to complete a check for the service CheckTypeRelationship CheckType = "relationship" // Verifies that the component has a specific number of relationship items defined for a specific relationship definition, with support for minimum, maximum, or exact count requirements CheckTypeRepoFile CheckType = "repo_file" // Quickly scan the service’s repository for the existence or contents of a specific file CheckTypeRepoGrep CheckType = "repo_grep" // Run a comprehensive search across the service's repository using advanced search parameters CheckTypeRepoSearch CheckType = "repo_search" // Quickly search the service’s repository for specific contents in any file CheckTypeServiceDependency CheckType = "service_dependency" // Verifies that the service has either a dependent or dependency CheckTypeServiceProperty CheckType = "service_property" // Verifies that a service property is set or matches a specified format CheckTypeTagDefined CheckType = "tag_defined" // Verifies that the service has the specified tag defined CheckTypeToolUsage CheckType = "tool_usage" // Verifies that the service is using a tool of a particular category or name )
type CheckUpdateInput ¶
type CheckUpdateInput struct {
Category *Nullable[ID] `json:"categoryId,omitempty" mapstructure:"categoryId,omitempty"`
EnableOn *Nullable[iso8601.Time] `json:"enableOn,omitempty" mapstructure:"enabledOn,omitempty"`
Enabled *Nullable[bool] `json:"enabled,omitempty" mapstructure:"enabled,omitempty"`
Filter *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" mapstructure:"filterId,omitempty"`
Id ID `json:"id" mapstructure:"id"`
Level *Nullable[ID] `json:"levelId,omitempty" mapstructure:"levelId,omitempty"`
Name *Nullable[string] `json:"name,omitempty" mapstructure:"name,omitempty"`
Notes *string `json:"notes,omitempty" mapstructure:"notes,omitempty"`
Owner *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" mapstructure:"ownerId,omitempty"`
}
type CheckUpdateInputProvider ¶
type CheckUpdateInputProvider interface {
GetCheckUpdateInput() *CheckUpdateInput
}
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
func NewGQLClient ¶
func (*Client) AddContact ¶
func (client *Client) AddContact(team string, contact ContactInput) (*Contact, error)
func (*Client) AddMemberships ¶
func (client *Client) AddMemberships(team *TeamId, memberships ...TeamMembershipUserInput) ([]TeamMembership, error)
func (*Client) AssignTags ¶
func (*Client) AssignTagsWithTagInputs ¶
func (*Client) ConnectServiceRepository ¶
func (client *Client) ConnectServiceRepository(service *ServiceId, repository *Repository) (*ServiceRepository, error)
func (*Client) CreateAlertSourceService ¶
func (client *Client) CreateAlertSourceService(input AlertSourceServiceCreateInput) (*AlertSourceService, error)
func (*Client) CreateAlias ¶
func (client *Client) CreateAlias(input AliasCreateInput) ([]string, error)
func (*Client) CreateAliases ¶
func (*Client) CreateCategory ¶
func (client *Client) CreateCategory(input CategoryCreateInput) (*Category, error)
func (*Client) CreateCheckAlertSourceUsage ¶
func (client *Client) CreateCheckAlertSourceUsage(input CheckAlertSourceUsageCreateInput) (*Check, error)
func (*Client) CreateCheckCodeIssue ¶
func (client *Client) CreateCheckCodeIssue(input CheckCodeIssueCreateInput) (*Check, error)
func (*Client) CreateCheckCustomEvent ¶
func (client *Client) CreateCheckCustomEvent(input CheckCustomEventCreateInput) (*Check, error)
func (*Client) CreateCheckGitBranchProtection ¶
func (client *Client) CreateCheckGitBranchProtection(input CheckGitBranchProtectionCreateInput) (*Check, error)
func (*Client) CreateCheckHasDocumentation ¶
func (client *Client) CreateCheckHasDocumentation(input CheckHasDocumentationCreateInput) (*Check, error)
func (*Client) CreateCheckHasRecentDeploy ¶
func (client *Client) CreateCheckHasRecentDeploy(input CheckHasRecentDeployCreateInput) (*Check, error)
func (*Client) CreateCheckManual ¶
func (client *Client) CreateCheckManual(input CheckManualCreateInput) (*Check, error)
func (*Client) CreateCheckPackageVersion ¶
func (client *Client) CreateCheckPackageVersion(input CheckPackageVersionCreateInput) (*Check, error)
CreateCheckPackageVersion Creates a package version check.
func (*Client) CreateCheckRelationship ¶
func (client *Client) CreateCheckRelationship(input CheckRelationshipCreateInput) (*Check, error)
func (*Client) CreateCheckRepositoryFile ¶
func (client *Client) CreateCheckRepositoryFile(input CheckRepositoryFileCreateInput) (*Check, error)
func (*Client) CreateCheckRepositoryGrep ¶
func (client *Client) CreateCheckRepositoryGrep(input CheckRepositoryGrepCreateInput) (*Check, error)
func (*Client) CreateCheckRepositoryIntegrated ¶
func (client *Client) CreateCheckRepositoryIntegrated(input CheckRepositoryIntegratedCreateInput) (*Check, error)
func (*Client) CreateCheckRepositorySearch ¶
func (client *Client) CreateCheckRepositorySearch(input CheckRepositorySearchCreateInput) (*Check, error)
func (*Client) CreateCheckServiceConfiguration ¶
func (client *Client) CreateCheckServiceConfiguration(input CheckServiceConfigurationCreateInput) (*Check, error)
func (*Client) CreateCheckServiceDependency ¶
func (client *Client) CreateCheckServiceDependency(input CheckServiceDependencyCreateInput) (*Check, error)
func (*Client) CreateCheckServiceOwnership ¶
func (client *Client) CreateCheckServiceOwnership(input CheckServiceOwnershipCreateInput) (*Check, error)
func (*Client) CreateCheckServiceProperty ¶
func (client *Client) CreateCheckServiceProperty(input CheckServicePropertyCreateInput) (*Check, error)
func (*Client) CreateCheckTagDefined ¶
func (client *Client) CreateCheckTagDefined(input CheckTagDefinedCreateInput) (*Check, error)
func (*Client) CreateCheckToolUsage ¶
func (client *Client) CreateCheckToolUsage(input CheckToolUsageCreateInput) (*Check, error)
func (*Client) CreateComponent ¶
func (client *Client) CreateComponent(input ComponentCreateInput) (*Component, error)
func (*Client) CreateComponentType ¶
func (client *Client) CreateComponentType(input ComponentTypeInput) (*ComponentType, error)
func (*Client) CreateDomain ¶
func (client *Client) CreateDomain(input DomainInput) (*Domain, error)
func (*Client) CreateEventIntegration ¶
func (client *Client) CreateEventIntegration(input EventIntegrationInput) (*Integration, error)
func (*Client) CreateFilter ¶
func (client *Client) CreateFilter(input FilterCreateInput) (*Filter, error)
func (*Client) CreateInfrastructure ¶
func (client *Client) CreateInfrastructure(input InfraInput) (*InfrastructureResource, error)
func (*Client) CreateIntegrationAWS ¶
func (client *Client) CreateIntegrationAWS(input AWSIntegrationInput) (*Integration, error)
func (*Client) CreateIntegrationAzureResources ¶
func (client *Client) CreateIntegrationAzureResources(input AzureResourcesIntegrationInput) (*Integration, error)
func (*Client) CreateIntegrationGCP ¶
func (client *Client) CreateIntegrationGCP(input GoogleCloudIntegrationInput) (*Integration, error)
func (*Client) CreateIntegrationNewRelic ¶
func (client *Client) CreateIntegrationNewRelic(input NewRelicIntegrationInput) (*Integration, error)
func (*Client) CreateLevel ¶
func (client *Client) CreateLevel(input LevelCreateInput) (*Level, error)
func (*Client) CreateOrUpdateAlertSource ¶
func (client *Client) CreateOrUpdateAlertSource(input AlertSourceInput) (*AlertSource, error)
func (*Client) CreatePropertyDefinition ¶
func (client *Client) CreatePropertyDefinition(input PropertyDefinitionInput) (*PropertyDefinition, error)
func (*Client) CreateRelationship ¶
func (client *Client) CreateRelationship(input RelationshipDefinition) (*RelationshipType, error)
func (*Client) CreateRelationshipDefinition ¶
func (client *Client) CreateRelationshipDefinition(input RelationshipDefinitionInput) (*RelationshipDefinitionType, error)
func (*Client) CreateScorecard ¶
func (client *Client) CreateScorecard(input ScorecardInput) (*Scorecard, error)
func (*Client) CreateSecret ¶
func (client *Client) CreateSecret(alias string, input SecretInput) (*Secret, error)
func (*Client) CreateService ¶
func (client *Client) CreateService(input ServiceCreateInput) (*Service, error)
func (*Client) CreateServiceDependency ¶
func (client *Client) CreateServiceDependency(input ServiceDependencyCreateInput) (*ServiceDependency, error)
func (*Client) CreateServiceRepository ¶
func (client *Client) CreateServiceRepository(input ServiceRepositoryCreateInput) (*ServiceRepository, error)
func (*Client) CreateSystem ¶
func (client *Client) CreateSystem(input SystemInput) (*System, error)
func (*Client) CreateTags ¶
func (*Client) CreateTeam ¶
func (client *Client) CreateTeam(input TeamCreateInput) (*Team, error)
func (*Client) CreateTool ¶
func (client *Client) CreateTool(input ToolCreateInput) (*Tool, error)
func (*Client) CreateTriggerDefinition ¶
func (client *Client) CreateTriggerDefinition(input CustomActionsTriggerDefinitionCreateInput) (*CustomActionsTriggerDefinition, error)
func (*Client) CreateWebhookAction ¶
func (client *Client) CreateWebhookAction(input CustomActionsWebhookActionCreateInput) (*CustomActionsExternalAction, error)
func (*Client) DeleteAlertSourceService ¶
func (*Client) DeleteAlias ¶
func (client *Client) DeleteAlias(input AliasDeleteInput) error
func (*Client) DeleteAliases ¶
func (client *Client) DeleteAliases(aliasOwnerType AliasOwnerTypeEnum, aliases []string) error
func (*Client) DeleteCategory ¶
func (*Client) DeleteCheck ¶
func (*Client) DeleteComponent ¶
func (*Client) DeleteComponentType ¶
func (*Client) DeleteDomain ¶
func (*Client) DeleteFilter ¶
func (*Client) DeleteInfraAlias
deprecated
func (*Client) DeleteInfrastructure ¶
func (*Client) DeleteIntegration ¶
func (*Client) DeleteLevel ¶
func (*Client) DeletePropertyDefinition ¶
func (*Client) DeleteRelationship ¶
func (*Client) DeleteRelationshipDefinition ¶
func (*Client) DeleteScorecard ¶
func (*Client) DeleteSecret ¶
func (*Client) DeleteService ¶
func (*Client) DeleteServiceAlias
deprecated
func (*Client) DeleteServiceDependency ¶
func (*Client) DeleteServiceRepository ¶
func (*Client) DeleteSystem ¶
func (*Client) DeleteTeam ¶
func (*Client) DeleteTeamAlias
deprecated
func (*Client) DeleteTool ¶
func (*Client) DeleteTriggerDefinition ¶
func (*Client) DeleteUser ¶
func (*Client) DeleteWebhookAction ¶
func (*Client) ExecRawCTX ¶
func (*Client) GetAlertSource ¶
func (client *Client) GetAlertSource(id ID) (*AlertSource, error)
func (*Client) GetAlertSourceWithExternalIdentifier ¶
func (client *Client) GetAlertSourceWithExternalIdentifier(input AlertSourceExternalIdentifier) (*AlertSource, error)
func (*Client) GetAliasableResource ¶
func (client *Client) GetAliasableResource(resourceType AliasOwnerTypeEnum, identifier string) (AliasableResourceInterface, error)
func (*Client) GetComponent ¶
func (*Client) GetComponentType ¶
func (client *Client) GetComponentType(identifier string) (*ComponentType, error)
func (*Client) GetCustomAction ¶
func (client *Client) GetCustomAction(input string) (*CustomActionsExternalAction, error)
func (*Client) GetDocument ¶
func (client *Client) GetDocument(id ID) (*ServiceDocumentContent, error)
func (*Client) GetInfrastructure ¶
func (client *Client) GetInfrastructure(identifier string) (*InfrastructureResource, error)
func (*Client) GetIntegration ¶
func (client *Client) GetIntegration(id ID) (*Integration, error)
func (*Client) GetProperty ¶
func (*Client) GetPropertyDefinition ¶
func (client *Client) GetPropertyDefinition(input string) (*PropertyDefinition, error)
func (*Client) GetRelationship ¶
func (client *Client) GetRelationship(identifier string) (*RelationshipType, error)
func (*Client) GetRelationshipDefinition ¶
func (client *Client) GetRelationshipDefinition(identifier string) (*RelationshipDefinitionType, error)
func (*Client) GetRepository ¶
func (client *Client) GetRepository(id ID) (*Repository, error)
func (*Client) GetRepositoryWithAlias ¶
func (client *Client) GetRepositoryWithAlias(alias string) (*Repository, error)
func (*Client) GetServiceCount ¶
func (*Client) GetServiceIdWithAlias ¶
func (*Client) GetServiceMaturityWithAlias ¶
func (client *Client) GetServiceMaturityWithAlias(alias string) (*ServiceMaturity, error)
func (*Client) GetServiceWithAlias ¶
func (*Client) GetTaggableResource ¶
func (client *Client) GetTaggableResource(resourceType TaggableResource, identifier string) (TaggableResourceInterface, error)
func (*Client) GetTeamCount ¶
func (*Client) GetTeamWithAlias ¶
func (*Client) GetTriggerDefinition ¶
func (client *Client) GetTriggerDefinition(input string) (*CustomActionsTriggerDefinition, error)
func (*Client) InitialPageVariables ¶
func (client *Client) InitialPageVariables() PayloadVariables
func (*Client) InitialPageVariablesPointer ¶
func (client *Client) InitialPageVariablesPointer() *PayloadVariables
func (*Client) IntegrationReactivate ¶
func (client *Client) IntegrationReactivate(identifier string) (*Integration, error)
func (*Client) InviteUser ¶
func (*Client) InvokeAction ¶
func (client *Client) InvokeAction(input CustomActionsTriggerInvokeInput) error
func (*Client) ListCampaigns ¶
func (client *Client) ListCampaigns(campaignVariables *ListCampaignsVariables) (*CampaignConnection, error)
func (*Client) ListCategories ¶
func (client *Client) ListCategories(variables *PayloadVariables) (*CategoryConnection, error)
func (*Client) ListChecks ¶
func (client *Client) ListChecks(variables *PayloadVariables) (*CheckConnection, error)
func (*Client) ListComponentTypes ¶
func (client *Client) ListComponentTypes(variables *PayloadVariables) (*ComponentTypeConnection, error)
func (*Client) ListComponents ¶
func (client *Client) ListComponents(variables *PayloadVariables) (*ComponentConnection, error)
func (*Client) ListCustomActions ¶
func (client *Client) ListCustomActions(variables *PayloadVariables) (*CustomActionsExternalActionsConnection, error)
func (*Client) ListDocuments ¶
func (client *Client) ListDocuments(variables *PayloadVariables) (*ServiceDocumentConnection, error)
func (*Client) ListDomains ¶
func (client *Client) ListDomains(variables *PayloadVariables) (*DomainConnection, error)
func (*Client) ListFilters ¶
func (client *Client) ListFilters(variables *PayloadVariables) (*FilterConnection, error)
func (*Client) ListInfrastructure ¶
func (client *Client) ListInfrastructure(variables *PayloadVariables) (*InfrastructureResourceConnection, error)
func (*Client) ListInfrastructureSchemas ¶
func (client *Client) ListInfrastructureSchemas(variables *PayloadVariables) (*InfrastructureResourceSchemaConnection, error)
func (*Client) ListIntegrations ¶
func (client *Client) ListIntegrations(variables *PayloadVariables) (*IntegrationConnection, error)
func (*Client) ListLevels ¶
func (client *Client) ListLevels(variables *PayloadVariables) (*LevelConnection, error)
func (*Client) ListLifecycles ¶
func (*Client) ListPropertyDefinitions ¶
func (client *Client) ListPropertyDefinitions(variables *PayloadVariables) (*PropertyDefinitionConnection, error)
func (*Client) ListRelationshipDefinitions ¶
func (client *Client) ListRelationshipDefinitions(variables *PayloadVariables) (*RelationshipDefinitionConnection, error)
func (*Client) ListRepositories ¶
func (client *Client) ListRepositories(variables *PayloadVariables) (*RepositoryConnection, error)
func (*Client) ListRepositoriesWithTier ¶
func (client *Client) ListRepositoriesWithTier(tier string, variables *PayloadVariables) (*RepositoryConnection, error)
func (*Client) ListScorecards ¶
func (client *Client) ListScorecards(variables *PayloadVariables) (*ScorecardConnection, error)
func (*Client) ListSecretsVaultsSecret ¶
func (client *Client) ListSecretsVaultsSecret(variables *PayloadVariables) (*SecretsVaultsSecretsConnection, error)
func (*Client) ListServices ¶
func (client *Client) ListServices(variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesMaturity ¶
func (client *Client) ListServicesMaturity(variables *PayloadVariables) (*ServiceMaturityConnection, error)
func (*Client) ListServicesWithFilter ¶
func (client *Client) ListServicesWithFilter(filterIdentifier string, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesWithFramework ¶
func (client *Client) ListServicesWithFramework(framework string, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesWithInputFilter ¶
func (client *Client) ListServicesWithInputFilter(filter ServiceFilterInput, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesWithLanguage ¶
func (client *Client) ListServicesWithLanguage(language string, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesWithLifecycle ¶
func (client *Client) ListServicesWithLifecycle(lifecycle string, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesWithOwner ¶
func (client *Client) ListServicesWithOwner(owner string, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesWithProduct ¶
func (client *Client) ListServicesWithProduct(product string, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesWithTag ¶
func (client *Client) ListServicesWithTag(tag TagArgs, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListServicesWithTier ¶
func (client *Client) ListServicesWithTier(tier string, variables *PayloadVariables) (*ServiceConnection, error)
func (*Client) ListSystems ¶
func (client *Client) ListSystems(variables *PayloadVariables) (*SystemConnection, error)
func (*Client) ListTeams ¶
func (client *Client) ListTeams(variables *PayloadVariables) (*TeamConnection, error)
func (*Client) ListTeamsWithManager ¶
func (client *Client) ListTeamsWithManager(email string, variables *PayloadVariables) (*TeamConnection, error)
func (*Client) ListTriggerDefinitions ¶
func (client *Client) ListTriggerDefinitions(variables *PayloadVariables) (*CustomActionsTriggerDefinitionsConnection, error)
func (*Client) ListUsers ¶
func (client *Client) ListUsers(variables *PayloadVariables) (*UserConnection, error)
func (*Client) PropertyAssign ¶
func (client *Client) PropertyAssign(input PropertyInput) (*Property, error)
func (*Client) PropertyUnassign ¶
func (*Client) ReconcileTags ¶
func (client *Client) ReconcileTags(resourceType TaggableResourceInterface, tagsDesired []Tag) error
ReconcileTags manages tags API operations for TaggableResourceInterface implementations
Tags from `tagsDesired` are compared against current tags of TaggableResourceInterface and differences are either created or deleted.
func (*Client) RemoveContact ¶
func (*Client) RemoveMemberships ¶
func (client *Client) RemoveMemberships(team *TeamId, memberships ...TeamMembershipUserInput) ([]User, error)
func (*Client) RunnerAppendJobLog ¶
func (client *Client) RunnerAppendJobLog(input RunnerAppendJobLogInput) error
func (*Client) RunnerGetPendingJob ¶
func (*Client) RunnerRegister ¶
func (*Client) RunnerReportJobOutcome ¶
func (client *Client) RunnerReportJobOutcome(input RunnerReportJobOutcomeInput) error
func (*Client) RunnerScale ¶
func (client *Client) RunnerScale(runnerId ID, currentReplicaCount, jobConcurrency int) (*RunnerScale, error)
func (*Client) RunnerUnregister ¶
func (*Client) SearchTeams ¶
func (client *Client) SearchTeams(searchTerm string, variables *PayloadVariables) (*TeamConnection, error)
func (*Client) ServiceApiDocSettingsUpdate ¶
func (*Client) UpdateAlertSourceStatus ¶
func (client *Client) UpdateAlertSourceStatus(input AlertSourceStatusUpdateInput) (*AlertSource, error)
func (*Client) UpdateCategory ¶
func (client *Client) UpdateCategory(input CategoryUpdateInput) (*Category, error)
func (*Client) UpdateCheckAlertSourceUsage ¶
func (client *Client) UpdateCheckAlertSourceUsage(input CheckAlertSourceUsageUpdateInput) (*Check, error)
func (*Client) UpdateCheckCodeIssue ¶
func (client *Client) UpdateCheckCodeIssue(input CheckCodeIssueUpdateInput) (*Check, error)
func (*Client) UpdateCheckCustomEvent ¶
func (client *Client) UpdateCheckCustomEvent(input CheckCustomEventUpdateInput) (*Check, error)
func (*Client) UpdateCheckGitBranchProtection ¶
func (client *Client) UpdateCheckGitBranchProtection(input CheckGitBranchProtectionUpdateInput) (*Check, error)
func (*Client) UpdateCheckHasDocumentation ¶
func (client *Client) UpdateCheckHasDocumentation(input CheckHasDocumentationUpdateInput) (*Check, error)
func (*Client) UpdateCheckHasRecentDeploy ¶
func (client *Client) UpdateCheckHasRecentDeploy(input CheckHasRecentDeployUpdateInput) (*Check, error)
func (*Client) UpdateCheckManual ¶
func (client *Client) UpdateCheckManual(input CheckManualUpdateInput) (*Check, error)
func (*Client) UpdateCheckPackageVersion ¶
func (client *Client) UpdateCheckPackageVersion(input CheckPackageVersionUpdateInput) (*Check, error)
UpdateCheckPackageVersion Updates a package version check.
func (*Client) UpdateCheckRelationship ¶
func (client *Client) UpdateCheckRelationship(input CheckRelationshipUpdateInput) (*Check, error)
func (*Client) UpdateCheckRepositoryFile ¶
func (client *Client) UpdateCheckRepositoryFile(input CheckRepositoryFileUpdateInput) (*Check, error)
func (*Client) UpdateCheckRepositoryGrep ¶
func (client *Client) UpdateCheckRepositoryGrep(input CheckRepositoryGrepUpdateInput) (*Check, error)
func (*Client) UpdateCheckRepositoryIntegrated ¶
func (client *Client) UpdateCheckRepositoryIntegrated(input CheckRepositoryIntegratedUpdateInput) (*Check, error)
func (*Client) UpdateCheckRepositorySearch ¶
func (client *Client) UpdateCheckRepositorySearch(input CheckRepositorySearchUpdateInput) (*Check, error)
func (*Client) UpdateCheckServiceConfiguration ¶
func (client *Client) UpdateCheckServiceConfiguration(input CheckServiceConfigurationUpdateInput) (*Check, error)
func (*Client) UpdateCheckServiceDependency ¶
func (client *Client) UpdateCheckServiceDependency(input CheckServiceDependencyUpdateInput) (*Check, error)
func (*Client) UpdateCheckServiceOwnership ¶
func (client *Client) UpdateCheckServiceOwnership(input CheckServiceOwnershipUpdateInput) (*Check, error)
func (*Client) UpdateCheckServiceProperty ¶
func (client *Client) UpdateCheckServiceProperty(input CheckServicePropertyUpdateInput) (*Check, error)
func (*Client) UpdateCheckTagDefined ¶
func (client *Client) UpdateCheckTagDefined(input CheckTagDefinedUpdateInput) (*Check, error)
func (*Client) UpdateCheckToolUsage ¶
func (client *Client) UpdateCheckToolUsage(input CheckToolUsageUpdateInput) (*Check, error)
func (*Client) UpdateComponent ¶
func (client *Client) UpdateComponent(input ComponentUpdateInput) (*Component, error)
func (*Client) UpdateComponentType ¶
func (client *Client) UpdateComponentType(identifier string, input ComponentTypeInput) (*ComponentType, error)
func (*Client) UpdateContact ¶
func (client *Client) UpdateContact(id ID, contact ContactInput) (*Contact, error)
func (*Client) UpdateDomain ¶
func (client *Client) UpdateDomain(identifier string, input DomainInput) (*Domain, error)
func (*Client) UpdateEventIntegration ¶
func (client *Client) UpdateEventIntegration(input EventIntegrationUpdateInput) (*Integration, error)
func (*Client) UpdateFilter ¶
func (client *Client) UpdateFilter(input FilterUpdateInput) (*Filter, error)
func (*Client) UpdateInfrastructure ¶
func (client *Client) UpdateInfrastructure(identifier string, input InfraInput) (*InfrastructureResource, error)
func (*Client) UpdateIntegrationAWS ¶
func (client *Client) UpdateIntegrationAWS(identifier string, input AWSIntegrationInput) (*Integration, error)
func (*Client) UpdateIntegrationAzureResources ¶
func (client *Client) UpdateIntegrationAzureResources(identifier string, input AzureResourcesIntegrationInput) (*Integration, error)
func (*Client) UpdateIntegrationGCP ¶
func (client *Client) UpdateIntegrationGCP(identifier string, input GoogleCloudIntegrationInput) (*Integration, error)
func (*Client) UpdateIntegrationNewRelic ¶
func (client *Client) UpdateIntegrationNewRelic(identifier string, input NewRelicIntegrationInput) (*Integration, error)
func (*Client) UpdateLevel ¶
func (client *Client) UpdateLevel(input LevelUpdateInput) (*Level, error)
func (*Client) UpdatePropertyDefinition ¶
func (client *Client) UpdatePropertyDefinition(identifier string, input PropertyDefinitionInput) (*PropertyDefinition, error)
func (*Client) UpdateRelationshipDefinition ¶
func (client *Client) UpdateRelationshipDefinition(identifier string, input RelationshipDefinitionInput) (*RelationshipDefinitionType, error)
func (*Client) UpdateRepository ¶
func (client *Client) UpdateRepository(input RepositoryUpdateInput) (*Repository, error)
func (*Client) UpdateScorecard ¶
func (client *Client) UpdateScorecard(identifier string, input ScorecardInput) (*Scorecard, error)
func (*Client) UpdateSecret ¶
func (client *Client) UpdateSecret(identifier string, secretInput SecretInput) (*Secret, error)
func (*Client) UpdateService ¶
func (client *Client) UpdateService(input ServiceUpdateInput) (*Service, error)
func (*Client) UpdateServiceNote ¶
func (client *Client) UpdateServiceNote(input ServiceNoteUpdateInput) (*Service, error)
func (*Client) UpdateServiceRepository ¶
func (client *Client) UpdateServiceRepository(input ServiceRepositoryUpdateInput) (*ServiceRepository, error)
func (*Client) UpdateSystem ¶
func (client *Client) UpdateSystem(identifier string, input SystemInput) (*System, error)
func (*Client) UpdateTeam ¶
func (client *Client) UpdateTeam(input TeamUpdateInput) (*Team, error)
func (*Client) UpdateTool ¶
func (client *Client) UpdateTool(input ToolUpdateInput) (*Tool, error)
func (*Client) UpdateTriggerDefinition ¶
func (client *Client) UpdateTriggerDefinition(input CustomActionsTriggerDefinitionUpdateInput) (*CustomActionsTriggerDefinition, error)
func (*Client) UpdateUser ¶
func (*Client) UpdateWebhookAction ¶
func (client *Client) UpdateWebhookAction(input CustomActionsWebhookActionUpdateInput) (*CustomActionsExternalAction, error)
type ClientError ¶
type ClientError struct {
ErrorCode ErrorCode
// contains filtered or unexported fields
}
type ClientSettings ¶
type ClientSettings struct {
// contains filtered or unexported fields
}
type CodeIssueCheckFragment ¶
type CodeIssueCheckFragment struct {
Constraint CheckCodeIssueConstraintEnum `graphql:"constraint"` // The type of constraint used in evaluation the code issues check.
IssueName string `graphql:"issueName"` // The issue name used for code issue lookup.
IssueType []string `graphql:"issueType"` // The type of code issue to consider.
MaxAllowed int `graphql:"maxAllowed"` // The threshold count of code issues beyond which the check starts failing.
ResolutionTime CodeIssueResolutionTime `graphql:"resolutionTime"` // The resolution time recommended by the reporting source of the code issue.
Severity []string `graphql:"severity"` // The severity levels of the issue.
}
type CodeIssueProjectResource ¶
type CodeIssueProjectResource struct {
Repository Repository `graphql:"... on Repository"`
Service Service `graphql:"... on Service"`
}
CodeIssueProjectResource represents resource linked to the CodeIssueProject. Can be either Service or Repository.
type CodeIssueResolutionTime ¶
type CodeIssueResolutionTime struct {
Unit CodeIssueResolutionTimeUnitEnum `graphql:"unit"` // The name of duration of time.
Value int `graphql:"value"` // The count value of the specified unit.
}
CodeIssueResolutionTime represents how long a code issue has been detected.
type CodeIssueResolutionTimeInput ¶
type CodeIssueResolutionTimeInput struct {
Unit CodeIssueResolutionTimeUnitEnum `json:"unit" yaml:"unit" example:"day"` // (Required)
Value int `json:"value" yaml:"value" example:"3"` // (Required)
}
CodeIssueResolutionTimeInput The allowed threshold for how long an issue has been detected before the check starts failing
type CodeIssueResolutionTimeUnitEnum ¶
type CodeIssueResolutionTimeUnitEnum string
CodeIssueResolutionTimeUnitEnum The allowed values for duration units for the resolution time
var ( CodeIssueResolutionTimeUnitEnumDay CodeIssueResolutionTimeUnitEnum = "day" // Day, as a duration CodeIssueResolutionTimeUnitEnumMonth CodeIssueResolutionTimeUnitEnum = "month" // Month, as a duration CodeIssueResolutionTimeUnitEnumWeek CodeIssueResolutionTimeUnitEnum = "week" // Week, as a duration )
type CommonVulnerabilityEnumeration ¶
type CommonVulnerabilityEnumeration struct {
Identifier string // The identifer of this item in the CVE system (Required)
Url string // The url for this item in the CVE system (Optional)
}
CommonVulnerabilityEnumeration A category system for hardware and software weaknesses
type CommonWeaknessEnumeration ¶
type CommonWeaknessEnumeration struct {
Identifier string // The identifer of this item in the CWE system (Required)
Url string // The url for this item in the CWE system (Optional)
}
CommonWeaknessEnumeration A category system for hardware and software weaknesses
type ComponentConnection ¶
type ComponentConnection ConnectionBase[Service]
type ComponentCreateInput ¶
type ComponentCreateInput ServiceCreateInput
type ComponentType ¶
type ComponentType struct {
ComponentTypeId
Description string // The description of the component type (Optional)
Href string // The relative path to link to the component type (Required)
Icon ComponentTypeIcon // The icon associated with the component type (Required)
IsDefault bool // Whether or not the component type is the default (Required)
Name string // The name of the component type (Required)
OwnerRelationship OwnerRelationshipType // The owner relationship for this component type (Required)
Timestamps Timestamps // When the component type was created and updated (Required)
Properties *PropertyDefinitionConnection `graphql:"-"`
}
ComponentType Information about a particular component type
func (*ComponentType) GetProperties ¶
func (s *ComponentType) GetProperties(client *Client, v *PayloadVariables) (*PropertyDefinitionConnection, error)
type ComponentTypeConnection ¶
type ComponentTypeConnection ConnectionBase[ComponentType]
ComponentTypeConnection The connection type for ComponentType
type ComponentTypeIcon ¶
type ComponentTypeIcon struct {
Color string // The color, represented as a hexcode, for the icon (Optional)
Name ComponentTypeIconEnum // The name of the icon in Phosphor icons for Vue, e.g. `PhBird`. See https://phosphoricons.com/ for a full list (Optional)
}
ComponentTypeIcon The icon for a component type
type ComponentTypeIconEnum ¶
type ComponentTypeIconEnum string
ComponentTypeIconEnum The possible icon names for a component type, provided by Phosphor icons for Vue: https://phosphoricons.com/
var ( ComponentTypeIconEnumPhactivity ComponentTypeIconEnum = "PhActivity" // ComponentTypeIconEnumPhaddressbook ComponentTypeIconEnum = "PhAddressBook" // ComponentTypeIconEnumPhairplane ComponentTypeIconEnum = "PhAirplane" // ComponentTypeIconEnumPhairplaneinflight ComponentTypeIconEnum = "PhAirplaneInFlight" // ComponentTypeIconEnumPhairplanelanding ComponentTypeIconEnum = "PhAirplaneLanding" // ComponentTypeIconEnumPhairplanetakeoff ComponentTypeIconEnum = "PhAirplaneTakeoff" // ComponentTypeIconEnumPhairplanetilt ComponentTypeIconEnum = "PhAirplaneTilt" // ComponentTypeIconEnumPhairplay ComponentTypeIconEnum = "PhAirplay" // ComponentTypeIconEnumPhalarm ComponentTypeIconEnum = "PhAlarm" // ComponentTypeIconEnumPhalien ComponentTypeIconEnum = "PhAlien" // ComponentTypeIconEnumPhalignbottom ComponentTypeIconEnum = "PhAlignBottom" // ComponentTypeIconEnumPhalignbottomsimple ComponentTypeIconEnum = "PhAlignBottomSimple" // ComponentTypeIconEnumPhaligncenterhorizontal ComponentTypeIconEnum = "PhAlignCenterHorizontal" // ComponentTypeIconEnumPhaligncenterhorizontalsimple ComponentTypeIconEnum = "PhAlignCenterHorizontalSimple" // ComponentTypeIconEnumPhaligncentervertical ComponentTypeIconEnum = "PhAlignCenterVertical" // ComponentTypeIconEnumPhaligncenterverticalsimple ComponentTypeIconEnum = "PhAlignCenterVerticalSimple" // ComponentTypeIconEnumPhalignleft ComponentTypeIconEnum = "PhAlignLeft" // ComponentTypeIconEnumPhalignleftsimple ComponentTypeIconEnum = "PhAlignLeftSimple" // ComponentTypeIconEnumPhalignright ComponentTypeIconEnum = "PhAlignRight" // ComponentTypeIconEnumPhalignrightsimple ComponentTypeIconEnum = "PhAlignRightSimple" // ComponentTypeIconEnumPhaligntop ComponentTypeIconEnum = "PhAlignTop" // ComponentTypeIconEnumPhaligntopsimple ComponentTypeIconEnum = "PhAlignTopSimple" // ComponentTypeIconEnumPhanchor ComponentTypeIconEnum = "PhAnchor" // ComponentTypeIconEnumPhanchorsimple ComponentTypeIconEnum = "PhAnchorSimple" // ComponentTypeIconEnumPhandroidlogo ComponentTypeIconEnum = "PhAndroidLogo" // ComponentTypeIconEnumPhangularlogo ComponentTypeIconEnum = "PhAngularLogo" // ComponentTypeIconEnumPhaperture ComponentTypeIconEnum = "PhAperture" // ComponentTypeIconEnumPhappstorelogo ComponentTypeIconEnum = "PhAppStoreLogo" // ComponentTypeIconEnumPhappwindow ComponentTypeIconEnum = "PhAppWindow" // ComponentTypeIconEnumPhapplelogo ComponentTypeIconEnum = "PhAppleLogo" // ComponentTypeIconEnumPhapplepodcastslogo ComponentTypeIconEnum = "PhApplePodcastsLogo" // ComponentTypeIconEnumPharchive ComponentTypeIconEnum = "PhArchive" // ComponentTypeIconEnumPharchivebox ComponentTypeIconEnum = "PhArchiveBox" // ComponentTypeIconEnumPharchivetray ComponentTypeIconEnum = "PhArchiveTray" // ComponentTypeIconEnumPharmchair ComponentTypeIconEnum = "PhArmchair" // ComponentTypeIconEnumPharrowarcleft ComponentTypeIconEnum = "PhArrowArcLeft" // ComponentTypeIconEnumPharrowarcright ComponentTypeIconEnum = "PhArrowArcRight" // ComponentTypeIconEnumPharrowbenddoubleupleft ComponentTypeIconEnum = "PhArrowBendDoubleUpLeft" // ComponentTypeIconEnumPharrowbenddoubleupright ComponentTypeIconEnum = "PhArrowBendDoubleUpRight" // ComponentTypeIconEnumPharrowbenddownleft ComponentTypeIconEnum = "PhArrowBendDownLeft" // ComponentTypeIconEnumPharrowbenddownright ComponentTypeIconEnum = "PhArrowBendDownRight" // ComponentTypeIconEnumPharrowbendleftdown ComponentTypeIconEnum = "PhArrowBendLeftDown" // ComponentTypeIconEnumPharrowbendleftup ComponentTypeIconEnum = "PhArrowBendLeftUp" // ComponentTypeIconEnumPharrowbendrightdown ComponentTypeIconEnum = "PhArrowBendRightDown" // ComponentTypeIconEnumPharrowbendrightup ComponentTypeIconEnum = "PhArrowBendRightUp" // ComponentTypeIconEnumPharrowbendupleft ComponentTypeIconEnum = "PhArrowBendUpLeft" // ComponentTypeIconEnumPharrowbendupright ComponentTypeIconEnum = "PhArrowBendUpRight" // ComponentTypeIconEnumPharrowcircledown ComponentTypeIconEnum = "PhArrowCircleDown" // ComponentTypeIconEnumPharrowcircledownleft ComponentTypeIconEnum = "PhArrowCircleDownLeft" // ComponentTypeIconEnumPharrowcircledownright ComponentTypeIconEnum = "PhArrowCircleDownRight" // ComponentTypeIconEnumPharrowcircleleft ComponentTypeIconEnum = "PhArrowCircleLeft" // ComponentTypeIconEnumPharrowcircleright ComponentTypeIconEnum = "PhArrowCircleRight" // ComponentTypeIconEnumPharrowcircleup ComponentTypeIconEnum = "PhArrowCircleUp" // ComponentTypeIconEnumPharrowcircleupleft ComponentTypeIconEnum = "PhArrowCircleUpLeft" // ComponentTypeIconEnumPharrowcircleupright ComponentTypeIconEnum = "PhArrowCircleUpRight" // ComponentTypeIconEnumPharrowclockwise ComponentTypeIconEnum = "PhArrowClockwise" // ComponentTypeIconEnumPharrowcounterclockwise ComponentTypeIconEnum = "PhArrowCounterClockwise" // ComponentTypeIconEnumPharrowdown ComponentTypeIconEnum = "PhArrowDown" // ComponentTypeIconEnumPharrowdownleft ComponentTypeIconEnum = "PhArrowDownLeft" // ComponentTypeIconEnumPharrowdownright ComponentTypeIconEnum = "PhArrowDownRight" // ComponentTypeIconEnumPharrowelbowdownleft ComponentTypeIconEnum = "PhArrowElbowDownLeft" // ComponentTypeIconEnumPharrowelbowdownright ComponentTypeIconEnum = "PhArrowElbowDownRight" // ComponentTypeIconEnumPharrowelbowleft ComponentTypeIconEnum = "PhArrowElbowLeft" // ComponentTypeIconEnumPharrowelbowleftdown ComponentTypeIconEnum = "PhArrowElbowLeftDown" // ComponentTypeIconEnumPharrowelbowleftup ComponentTypeIconEnum = "PhArrowElbowLeftUp" // ComponentTypeIconEnumPharrowelbowright ComponentTypeIconEnum = "PhArrowElbowRight" // ComponentTypeIconEnumPharrowelbowrightdown ComponentTypeIconEnum = "PhArrowElbowRightDown" // ComponentTypeIconEnumPharrowelbowrightup ComponentTypeIconEnum = "PhArrowElbowRightUp" // ComponentTypeIconEnumPharrowelbowupleft ComponentTypeIconEnum = "PhArrowElbowUpLeft" // ComponentTypeIconEnumPharrowelbowupright ComponentTypeIconEnum = "PhArrowElbowUpRight" // ComponentTypeIconEnumPharrowfatdown ComponentTypeIconEnum = "PhArrowFatDown" // ComponentTypeIconEnumPharrowfatleft ComponentTypeIconEnum = "PhArrowFatLeft" // ComponentTypeIconEnumPharrowfatlinedown ComponentTypeIconEnum = "PhArrowFatLineDown" // ComponentTypeIconEnumPharrowfatlineleft ComponentTypeIconEnum = "PhArrowFatLineLeft" // ComponentTypeIconEnumPharrowfatlineright ComponentTypeIconEnum = "PhArrowFatLineRight" // ComponentTypeIconEnumPharrowfatlineup ComponentTypeIconEnum = "PhArrowFatLineUp" // ComponentTypeIconEnumPharrowfatlinesdown ComponentTypeIconEnum = "PhArrowFatLinesDown" // ComponentTypeIconEnumPharrowfatlinesleft ComponentTypeIconEnum = "PhArrowFatLinesLeft" // ComponentTypeIconEnumPharrowfatlinesright ComponentTypeIconEnum = "PhArrowFatLinesRight" // ComponentTypeIconEnumPharrowfatlinesup ComponentTypeIconEnum = "PhArrowFatLinesUp" // ComponentTypeIconEnumPharrowfatright ComponentTypeIconEnum = "PhArrowFatRight" // ComponentTypeIconEnumPharrowfatup ComponentTypeIconEnum = "PhArrowFatUp" // ComponentTypeIconEnumPharrowleft ComponentTypeIconEnum = "PhArrowLeft" // ComponentTypeIconEnumPharrowlinedown ComponentTypeIconEnum = "PhArrowLineDown" // ComponentTypeIconEnumPharrowlinedownleft ComponentTypeIconEnum = "PhArrowLineDownLeft" // ComponentTypeIconEnumPharrowlinedownright ComponentTypeIconEnum = "PhArrowLineDownRight" // ComponentTypeIconEnumPharrowlineleft ComponentTypeIconEnum = "PhArrowLineLeft" // ComponentTypeIconEnumPharrowlineright ComponentTypeIconEnum = "PhArrowLineRight" // ComponentTypeIconEnumPharrowlineup ComponentTypeIconEnum = "PhArrowLineUp" // ComponentTypeIconEnumPharrowlineupleft ComponentTypeIconEnum = "PhArrowLineUpLeft" // ComponentTypeIconEnumPharrowlineupright ComponentTypeIconEnum = "PhArrowLineUpRight" // ComponentTypeIconEnumPharrowright ComponentTypeIconEnum = "PhArrowRight" // ComponentTypeIconEnumPharrowsquaredown ComponentTypeIconEnum = "PhArrowSquareDown" // ComponentTypeIconEnumPharrowsquaredownleft ComponentTypeIconEnum = "PhArrowSquareDownLeft" // ComponentTypeIconEnumPharrowsquaredownright ComponentTypeIconEnum = "PhArrowSquareDownRight" // ComponentTypeIconEnumPharrowsquarein ComponentTypeIconEnum = "PhArrowSquareIn" // ComponentTypeIconEnumPharrowsquareleft ComponentTypeIconEnum = "PhArrowSquareLeft" // ComponentTypeIconEnumPharrowsquareout ComponentTypeIconEnum = "PhArrowSquareOut" // ComponentTypeIconEnumPharrowsquareright ComponentTypeIconEnum = "PhArrowSquareRight" // ComponentTypeIconEnumPharrowsquareup ComponentTypeIconEnum = "PhArrowSquareUp" // ComponentTypeIconEnumPharrowsquareupleft ComponentTypeIconEnum = "PhArrowSquareUpLeft" // ComponentTypeIconEnumPharrowsquareupright ComponentTypeIconEnum = "PhArrowSquareUpRight" // ComponentTypeIconEnumPharrowudownleft ComponentTypeIconEnum = "PhArrowUDownLeft" // ComponentTypeIconEnumPharrowudownright ComponentTypeIconEnum = "PhArrowUDownRight" // ComponentTypeIconEnumPharrowuleftdown ComponentTypeIconEnum = "PhArrowULeftDown" // ComponentTypeIconEnumPharrowuleftup ComponentTypeIconEnum = "PhArrowULeftUp" // ComponentTypeIconEnumPharrowurightdown ComponentTypeIconEnum = "PhArrowURightDown" // ComponentTypeIconEnumPharrowurightup ComponentTypeIconEnum = "PhArrowURightUp" // ComponentTypeIconEnumPharrowuupleft ComponentTypeIconEnum = "PhArrowUUpLeft" // ComponentTypeIconEnumPharrowuupright ComponentTypeIconEnum = "PhArrowUUpRight" // ComponentTypeIconEnumPharrowup ComponentTypeIconEnum = "PhArrowUp" // ComponentTypeIconEnumPharrowupleft ComponentTypeIconEnum = "PhArrowUpLeft" // ComponentTypeIconEnumPharrowupright ComponentTypeIconEnum = "PhArrowUpRight" // ComponentTypeIconEnumPharrowsclockwise ComponentTypeIconEnum = "PhArrowsClockwise" // ComponentTypeIconEnumPharrowscounterclockwise ComponentTypeIconEnum = "PhArrowsCounterClockwise" // ComponentTypeIconEnumPharrowsdownup ComponentTypeIconEnum = "PhArrowsDownUp" // ComponentTypeIconEnumPharrowshorizontal ComponentTypeIconEnum = "PhArrowsHorizontal" // ComponentTypeIconEnumPharrowsin ComponentTypeIconEnum = "PhArrowsIn" // ComponentTypeIconEnumPharrowsincardinal ComponentTypeIconEnum = "PhArrowsInCardinal" // ComponentTypeIconEnumPharrowsinlinehorizontal ComponentTypeIconEnum = "PhArrowsInLineHorizontal" // ComponentTypeIconEnumPharrowsinlinevertical ComponentTypeIconEnum = "PhArrowsInLineVertical" // ComponentTypeIconEnumPharrowsinsimple ComponentTypeIconEnum = "PhArrowsInSimple" // ComponentTypeIconEnumPharrowsleftright ComponentTypeIconEnum = "PhArrowsLeftRight" // ComponentTypeIconEnumPharrowsout ComponentTypeIconEnum = "PhArrowsOut" // ComponentTypeIconEnumPharrowsoutcardinal ComponentTypeIconEnum = "PhArrowsOutCardinal" // ComponentTypeIconEnumPharrowsoutlinehorizontal ComponentTypeIconEnum = "PhArrowsOutLineHorizontal" // ComponentTypeIconEnumPharrowsoutlinevertical ComponentTypeIconEnum = "PhArrowsOutLineVertical" // ComponentTypeIconEnumPharrowsoutsimple ComponentTypeIconEnum = "PhArrowsOutSimple" // ComponentTypeIconEnumPharrowsvertical ComponentTypeIconEnum = "PhArrowsVertical" // ComponentTypeIconEnumPharticle ComponentTypeIconEnum = "PhArticle" // ComponentTypeIconEnumPharticlemedium ComponentTypeIconEnum = "PhArticleMedium" // ComponentTypeIconEnumPharticlenytimes ComponentTypeIconEnum = "PhArticleNyTimes" // ComponentTypeIconEnumPhasterisk ComponentTypeIconEnum = "PhAsterisk" // ComponentTypeIconEnumPhasterisksimple ComponentTypeIconEnum = "PhAsteriskSimple" // ComponentTypeIconEnumPhat ComponentTypeIconEnum = "PhAt" // ComponentTypeIconEnumPhatom ComponentTypeIconEnum = "PhAtom" // ComponentTypeIconEnumPhbaby ComponentTypeIconEnum = "PhBaby" // ComponentTypeIconEnumPhbackpack ComponentTypeIconEnum = "PhBackpack" // ComponentTypeIconEnumPhbackspace ComponentTypeIconEnum = "PhBackspace" // ComponentTypeIconEnumPhbag ComponentTypeIconEnum = "PhBag" // ComponentTypeIconEnumPhbagsimple ComponentTypeIconEnum = "PhBagSimple" // ComponentTypeIconEnumPhballoon ComponentTypeIconEnum = "PhBalloon" // ComponentTypeIconEnumPhbandaids ComponentTypeIconEnum = "PhBandaids" // ComponentTypeIconEnumPhbank ComponentTypeIconEnum = "PhBank" // ComponentTypeIconEnumPhbarbell ComponentTypeIconEnum = "PhBarbell" // ComponentTypeIconEnumPhbarcode ComponentTypeIconEnum = "PhBarcode" // ComponentTypeIconEnumPhbarricade ComponentTypeIconEnum = "PhBarricade" // ComponentTypeIconEnumPhbaseball ComponentTypeIconEnum = "PhBaseball" // ComponentTypeIconEnumPhbasketball ComponentTypeIconEnum = "PhBasketball" // ComponentTypeIconEnumPhbathtub ComponentTypeIconEnum = "PhBathtub" // ComponentTypeIconEnumPhbatterycharging ComponentTypeIconEnum = "PhBatteryCharging" // ComponentTypeIconEnumPhbatterychargingvertical ComponentTypeIconEnum = "PhBatteryChargingVertical" // ComponentTypeIconEnumPhbatteryempty ComponentTypeIconEnum = "PhBatteryEmpty" // ComponentTypeIconEnumPhbatteryfull ComponentTypeIconEnum = "PhBatteryFull" // ComponentTypeIconEnumPhbatteryhigh ComponentTypeIconEnum = "PhBatteryHigh" // ComponentTypeIconEnumPhbatterylow ComponentTypeIconEnum = "PhBatteryLow" // ComponentTypeIconEnumPhbatterymedium ComponentTypeIconEnum = "PhBatteryMedium" // ComponentTypeIconEnumPhbatteryplus ComponentTypeIconEnum = "PhBatteryPlus" // ComponentTypeIconEnumPhbatterywarning ComponentTypeIconEnum = "PhBatteryWarning" // ComponentTypeIconEnumPhbatterywarningvertical ComponentTypeIconEnum = "PhBatteryWarningVertical" // ComponentTypeIconEnumPhbed ComponentTypeIconEnum = "PhBed" // ComponentTypeIconEnumPhbeerbottle ComponentTypeIconEnum = "PhBeerBottle" // ComponentTypeIconEnumPhbehancelogo ComponentTypeIconEnum = "PhBehanceLogo" // ComponentTypeIconEnumPhbell ComponentTypeIconEnum = "PhBell" // ComponentTypeIconEnumPhbellringing ComponentTypeIconEnum = "PhBellRinging" // ComponentTypeIconEnumPhbellsimple ComponentTypeIconEnum = "PhBellSimple" // ComponentTypeIconEnumPhbellsimpleringing ComponentTypeIconEnum = "PhBellSimpleRinging" // ComponentTypeIconEnumPhbellsimpleslash ComponentTypeIconEnum = "PhBellSimpleSlash" // ComponentTypeIconEnumPhbellsimplez ComponentTypeIconEnum = "PhBellSimpleZ" // ComponentTypeIconEnumPhbellslash ComponentTypeIconEnum = "PhBellSlash" // ComponentTypeIconEnumPhbellz ComponentTypeIconEnum = "PhBellZ" // ComponentTypeIconEnumPhbeziercurve ComponentTypeIconEnum = "PhBezierCurve" // ComponentTypeIconEnumPhbicycle ComponentTypeIconEnum = "PhBicycle" // ComponentTypeIconEnumPhbinoculars ComponentTypeIconEnum = "PhBinoculars" // ComponentTypeIconEnumPhbird ComponentTypeIconEnum = "PhBird" // ComponentTypeIconEnumPhbluetooth ComponentTypeIconEnum = "PhBluetooth" // ComponentTypeIconEnumPhbluetoothconnected ComponentTypeIconEnum = "PhBluetoothConnected" // ComponentTypeIconEnumPhbluetoothslash ComponentTypeIconEnum = "PhBluetoothSlash" // ComponentTypeIconEnumPhbluetoothx ComponentTypeIconEnum = "PhBluetoothX" // ComponentTypeIconEnumPhboat ComponentTypeIconEnum = "PhBoat" // ComponentTypeIconEnumPhbook ComponentTypeIconEnum = "PhBook" // ComponentTypeIconEnumPhbookbookmark ComponentTypeIconEnum = "PhBookBookmark" // ComponentTypeIconEnumPhbookopen ComponentTypeIconEnum = "PhBookOpen" // ComponentTypeIconEnumPhbookmark ComponentTypeIconEnum = "PhBookmark" // ComponentTypeIconEnumPhbookmarksimple ComponentTypeIconEnum = "PhBookmarkSimple" // ComponentTypeIconEnumPhbookmarks ComponentTypeIconEnum = "PhBookmarks" // ComponentTypeIconEnumPhbookmarkssimple ComponentTypeIconEnum = "PhBookmarksSimple" // ComponentTypeIconEnumPhbooks ComponentTypeIconEnum = "PhBooks" // ComponentTypeIconEnumPhboundingbox ComponentTypeIconEnum = "PhBoundingBox" // ComponentTypeIconEnumPhbracketsangle ComponentTypeIconEnum = "PhBracketsAngle" // ComponentTypeIconEnumPhbracketscurly ComponentTypeIconEnum = "PhBracketsCurly" // ComponentTypeIconEnumPhbracketsround ComponentTypeIconEnum = "PhBracketsRound" // ComponentTypeIconEnumPhbracketssquare ComponentTypeIconEnum = "PhBracketsSquare" // ComponentTypeIconEnumPhbrain ComponentTypeIconEnum = "PhBrain" // ComponentTypeIconEnumPhbrandy ComponentTypeIconEnum = "PhBrandy" // ComponentTypeIconEnumPhbriefcase ComponentTypeIconEnum = "PhBriefcase" // ComponentTypeIconEnumPhbriefcasemetal ComponentTypeIconEnum = "PhBriefcaseMetal" // ComponentTypeIconEnumPhbroadcast ComponentTypeIconEnum = "PhBroadcast" // ComponentTypeIconEnumPhbrowser ComponentTypeIconEnum = "PhBrowser" // ComponentTypeIconEnumPhbrowsers ComponentTypeIconEnum = "PhBrowsers" // ComponentTypeIconEnumPhbug ComponentTypeIconEnum = "PhBug" // ComponentTypeIconEnumPhbugbeetle ComponentTypeIconEnum = "PhBugBeetle" // ComponentTypeIconEnumPhbugdroid ComponentTypeIconEnum = "PhBugDroid" // ComponentTypeIconEnumPhbuildings ComponentTypeIconEnum = "PhBuildings" // ComponentTypeIconEnumPhbus ComponentTypeIconEnum = "PhBus" // ComponentTypeIconEnumPhbutterfly ComponentTypeIconEnum = "PhButterfly" // ComponentTypeIconEnumPhcactus ComponentTypeIconEnum = "PhCactus" // ComponentTypeIconEnumPhcake ComponentTypeIconEnum = "PhCake" // ComponentTypeIconEnumPhcalculator ComponentTypeIconEnum = "PhCalculator" // ComponentTypeIconEnumPhcalendar ComponentTypeIconEnum = "PhCalendar" // ComponentTypeIconEnumPhcalendarblank ComponentTypeIconEnum = "PhCalendarBlank" // ComponentTypeIconEnumPhcalendarcheck ComponentTypeIconEnum = "PhCalendarCheck" // ComponentTypeIconEnumPhcalendarplus ComponentTypeIconEnum = "PhCalendarPlus" // ComponentTypeIconEnumPhcalendarx ComponentTypeIconEnum = "PhCalendarX" // ComponentTypeIconEnumPhcamera ComponentTypeIconEnum = "PhCamera" // ComponentTypeIconEnumPhcamerarotate ComponentTypeIconEnum = "PhCameraRotate" // ComponentTypeIconEnumPhcameraslash ComponentTypeIconEnum = "PhCameraSlash" // ComponentTypeIconEnumPhcampfire ComponentTypeIconEnum = "PhCampfire" // ComponentTypeIconEnumPhcar ComponentTypeIconEnum = "PhCar" // ComponentTypeIconEnumPhcarsimple ComponentTypeIconEnum = "PhCarSimple" // ComponentTypeIconEnumPhcardholder ComponentTypeIconEnum = "PhCardholder" // ComponentTypeIconEnumPhcards ComponentTypeIconEnum = "PhCards" // ComponentTypeIconEnumPhcaretcircledoubledown ComponentTypeIconEnum = "PhCaretCircleDoubleDown" // ComponentTypeIconEnumPhcaretcircledoubleleft ComponentTypeIconEnum = "PhCaretCircleDoubleLeft" // ComponentTypeIconEnumPhcaretcircledoubleright ComponentTypeIconEnum = "PhCaretCircleDoubleRight" // ComponentTypeIconEnumPhcaretcircledoubleup ComponentTypeIconEnum = "PhCaretCircleDoubleUp" // ComponentTypeIconEnumPhcaretcircledown ComponentTypeIconEnum = "PhCaretCircleDown" // ComponentTypeIconEnumPhcaretcircleleft ComponentTypeIconEnum = "PhCaretCircleLeft" // ComponentTypeIconEnumPhcaretcircleright ComponentTypeIconEnum = "PhCaretCircleRight" // ComponentTypeIconEnumPhcaretcircleup ComponentTypeIconEnum = "PhCaretCircleUp" // ComponentTypeIconEnumPhcaretdoubledown ComponentTypeIconEnum = "PhCaretDoubleDown" // ComponentTypeIconEnumPhcaretdoubleleft ComponentTypeIconEnum = "PhCaretDoubleLeft" // ComponentTypeIconEnumPhcaretdoubleright ComponentTypeIconEnum = "PhCaretDoubleRight" // ComponentTypeIconEnumPhcaretdoubleup ComponentTypeIconEnum = "PhCaretDoubleUp" // ComponentTypeIconEnumPhcaretdown ComponentTypeIconEnum = "PhCaretDown" // ComponentTypeIconEnumPhcaretleft ComponentTypeIconEnum = "PhCaretLeft" // ComponentTypeIconEnumPhcaretright ComponentTypeIconEnum = "PhCaretRight" // ComponentTypeIconEnumPhcaretup ComponentTypeIconEnum = "PhCaretUp" // ComponentTypeIconEnumPhcat ComponentTypeIconEnum = "PhCat" // ComponentTypeIconEnumPhcellsignalfull ComponentTypeIconEnum = "PhCellSignalFull" // ComponentTypeIconEnumPhcellsignalhigh ComponentTypeIconEnum = "PhCellSignalHigh" // ComponentTypeIconEnumPhcellsignallow ComponentTypeIconEnum = "PhCellSignalLow" // ComponentTypeIconEnumPhcellsignalmedium ComponentTypeIconEnum = "PhCellSignalMedium" // ComponentTypeIconEnumPhcellsignalnone ComponentTypeIconEnum = "PhCellSignalNone" // ComponentTypeIconEnumPhcellsignalslash ComponentTypeIconEnum = "PhCellSignalSlash" // ComponentTypeIconEnumPhcellsignalx ComponentTypeIconEnum = "PhCellSignalX" // ComponentTypeIconEnumPhchalkboard ComponentTypeIconEnum = "PhChalkboard" // ComponentTypeIconEnumPhchalkboardsimple ComponentTypeIconEnum = "PhChalkboardSimple" // ComponentTypeIconEnumPhchalkboardteacher ComponentTypeIconEnum = "PhChalkboardTeacher" // ComponentTypeIconEnumPhchartbar ComponentTypeIconEnum = "PhChartBar" // ComponentTypeIconEnumPhchartbarhorizontal ComponentTypeIconEnum = "PhChartBarHorizontal" // ComponentTypeIconEnumPhchartline ComponentTypeIconEnum = "PhChartLine" // ComponentTypeIconEnumPhchartlineup ComponentTypeIconEnum = "PhChartLineUp" // ComponentTypeIconEnumPhchartpie ComponentTypeIconEnum = "PhChartPie" // ComponentTypeIconEnumPhchartpieslice ComponentTypeIconEnum = "PhChartPieSlice" // ComponentTypeIconEnumPhchat ComponentTypeIconEnum = "PhChat" // ComponentTypeIconEnumPhchatcentered ComponentTypeIconEnum = "PhChatCentered" // ComponentTypeIconEnumPhchatcentereddots ComponentTypeIconEnum = "PhChatCenteredDots" // ComponentTypeIconEnumPhchatcenteredtext ComponentTypeIconEnum = "PhChatCenteredText" // ComponentTypeIconEnumPhchatcircle ComponentTypeIconEnum = "PhChatCircle" // ComponentTypeIconEnumPhchatcircledots ComponentTypeIconEnum = "PhChatCircleDots" // ComponentTypeIconEnumPhchatcircletext ComponentTypeIconEnum = "PhChatCircleText" // ComponentTypeIconEnumPhchatdots ComponentTypeIconEnum = "PhChatDots" // ComponentTypeIconEnumPhchatteardrop ComponentTypeIconEnum = "PhChatTeardrop" // ComponentTypeIconEnumPhchatteardropdots ComponentTypeIconEnum = "PhChatTeardropDots" // ComponentTypeIconEnumPhchatteardroptext ComponentTypeIconEnum = "PhChatTeardropText" // ComponentTypeIconEnumPhchattext ComponentTypeIconEnum = "PhChatText" // ComponentTypeIconEnumPhchats ComponentTypeIconEnum = "PhChats" // ComponentTypeIconEnumPhchatscircle ComponentTypeIconEnum = "PhChatsCircle" // ComponentTypeIconEnumPhchatsteardrop ComponentTypeIconEnum = "PhChatsTeardrop" // ComponentTypeIconEnumPhcheck ComponentTypeIconEnum = "PhCheck" // ComponentTypeIconEnumPhcheckcircle ComponentTypeIconEnum = "PhCheckCircle" // ComponentTypeIconEnumPhchecksquare ComponentTypeIconEnum = "PhCheckSquare" // ComponentTypeIconEnumPhchecksquareoffset ComponentTypeIconEnum = "PhCheckSquareOffset" // ComponentTypeIconEnumPhchecks ComponentTypeIconEnum = "PhChecks" // ComponentTypeIconEnumPhcircle ComponentTypeIconEnum = "PhCircle" // ComponentTypeIconEnumPhcircledashed ComponentTypeIconEnum = "PhCircleDashed" // ComponentTypeIconEnumPhcirclehalf ComponentTypeIconEnum = "PhCircleHalf" // ComponentTypeIconEnumPhcirclehalftilt ComponentTypeIconEnum = "PhCircleHalfTilt" // ComponentTypeIconEnumPhcirclenotch ComponentTypeIconEnum = "PhCircleNotch" // ComponentTypeIconEnumPhcirclewavy ComponentTypeIconEnum = "PhCircleWavy" // ComponentTypeIconEnumPhcirclewavycheck ComponentTypeIconEnum = "PhCircleWavyCheck" // ComponentTypeIconEnumPhcirclewavyquestion ComponentTypeIconEnum = "PhCircleWavyQuestion" // ComponentTypeIconEnumPhcirclewavywarning ComponentTypeIconEnum = "PhCircleWavyWarning" // ComponentTypeIconEnumPhcirclesfour ComponentTypeIconEnum = "PhCirclesFour" // ComponentTypeIconEnumPhcirclesthree ComponentTypeIconEnum = "PhCirclesThree" // ComponentTypeIconEnumPhcirclesthreeplus ComponentTypeIconEnum = "PhCirclesThreePlus" // ComponentTypeIconEnumPhclipboard ComponentTypeIconEnum = "PhClipboard" // ComponentTypeIconEnumPhclipboardtext ComponentTypeIconEnum = "PhClipboardText" // ComponentTypeIconEnumPhclock ComponentTypeIconEnum = "PhClock" // ComponentTypeIconEnumPhclockafternoon ComponentTypeIconEnum = "PhClockAfternoon" // ComponentTypeIconEnumPhclockclockwise ComponentTypeIconEnum = "PhClockClockwise" // ComponentTypeIconEnumPhclockcounterclockwise ComponentTypeIconEnum = "PhClockCounterClockwise" // ComponentTypeIconEnumPhclosedcaptioning ComponentTypeIconEnum = "PhClosedCaptioning" // ComponentTypeIconEnumPhcloud ComponentTypeIconEnum = "PhCloud" // ComponentTypeIconEnumPhcloudarrowdown ComponentTypeIconEnum = "PhCloudArrowDown" // ComponentTypeIconEnumPhcloudarrowup ComponentTypeIconEnum = "PhCloudArrowUp" // ComponentTypeIconEnumPhcloudcheck ComponentTypeIconEnum = "PhCloudCheck" // ComponentTypeIconEnumPhcloudfog ComponentTypeIconEnum = "PhCloudFog" // ComponentTypeIconEnumPhcloudlightning ComponentTypeIconEnum = "PhCloudLightning" // ComponentTypeIconEnumPhcloudmoon ComponentTypeIconEnum = "PhCloudMoon" // ComponentTypeIconEnumPhcloudrain ComponentTypeIconEnum = "PhCloudRain" // ComponentTypeIconEnumPhcloudslash ComponentTypeIconEnum = "PhCloudSlash" // ComponentTypeIconEnumPhcloudsnow ComponentTypeIconEnum = "PhCloudSnow" // ComponentTypeIconEnumPhcloudsun ComponentTypeIconEnum = "PhCloudSun" // ComponentTypeIconEnumPhclub ComponentTypeIconEnum = "PhClub" // ComponentTypeIconEnumPhcoathanger ComponentTypeIconEnum = "PhCoatHanger" // ComponentTypeIconEnumPhcode ComponentTypeIconEnum = "PhCode" // ComponentTypeIconEnumPhcodesimple ComponentTypeIconEnum = "PhCodeSimple" // ComponentTypeIconEnumPhcodepenlogo ComponentTypeIconEnum = "PhCodepenLogo" // ComponentTypeIconEnumPhcodesandboxlogo ComponentTypeIconEnum = "PhCodesandboxLogo" // ComponentTypeIconEnumPhcoffee ComponentTypeIconEnum = "PhCoffee" // ComponentTypeIconEnumPhcoin ComponentTypeIconEnum = "PhCoin" // ComponentTypeIconEnumPhcoinvertical ComponentTypeIconEnum = "PhCoinVertical" // ComponentTypeIconEnumPhcoins ComponentTypeIconEnum = "PhCoins" // ComponentTypeIconEnumPhcolumns ComponentTypeIconEnum = "PhColumns" // ComponentTypeIconEnumPhcommand ComponentTypeIconEnum = "PhCommand" // ComponentTypeIconEnumPhcompass ComponentTypeIconEnum = "PhCompass" // ComponentTypeIconEnumPhcomputertower ComponentTypeIconEnum = "PhComputerTower" // ComponentTypeIconEnumPhconfetti ComponentTypeIconEnum = "PhConfetti" // ComponentTypeIconEnumPhcookingpot ComponentTypeIconEnum = "PhCookingPot" // ComponentTypeIconEnumPhcopy ComponentTypeIconEnum = "PhCopy" // ComponentTypeIconEnumPhcopysimple ComponentTypeIconEnum = "PhCopySimple" // ComponentTypeIconEnumPhcopyleft ComponentTypeIconEnum = "PhCopyleft" // ComponentTypeIconEnumPhcopyright ComponentTypeIconEnum = "PhCopyright" // ComponentTypeIconEnumPhcornersin ComponentTypeIconEnum = "PhCornersIn" // ComponentTypeIconEnumPhcornersout ComponentTypeIconEnum = "PhCornersOut" // ComponentTypeIconEnumPhcpu ComponentTypeIconEnum = "PhCpu" // ComponentTypeIconEnumPhcreditcard ComponentTypeIconEnum = "PhCreditCard" // ComponentTypeIconEnumPhcrop ComponentTypeIconEnum = "PhCrop" // ComponentTypeIconEnumPhcrosshair ComponentTypeIconEnum = "PhCrosshair" // ComponentTypeIconEnumPhcrosshairsimple ComponentTypeIconEnum = "PhCrosshairSimple" // ComponentTypeIconEnumPhcrown ComponentTypeIconEnum = "PhCrown" // ComponentTypeIconEnumPhcrownsimple ComponentTypeIconEnum = "PhCrownSimple" // ComponentTypeIconEnumPhcube ComponentTypeIconEnum = "PhCube" // ComponentTypeIconEnumPhcurrencybtc ComponentTypeIconEnum = "PhCurrencyBtc" // ComponentTypeIconEnumPhcurrencycircledollar ComponentTypeIconEnum = "PhCurrencyCircleDollar" // ComponentTypeIconEnumPhcurrencycny ComponentTypeIconEnum = "PhCurrencyCny" // ComponentTypeIconEnumPhcurrencydollar ComponentTypeIconEnum = "PhCurrencyDollar" // ComponentTypeIconEnumPhcurrencydollarsimple ComponentTypeIconEnum = "PhCurrencyDollarSimple" // ComponentTypeIconEnumPhcurrencyeth ComponentTypeIconEnum = "PhCurrencyEth" // ComponentTypeIconEnumPhcurrencyeur ComponentTypeIconEnum = "PhCurrencyEur" // ComponentTypeIconEnumPhcurrencygbp ComponentTypeIconEnum = "PhCurrencyGbp" // ComponentTypeIconEnumPhcurrencyinr ComponentTypeIconEnum = "PhCurrencyInr" // ComponentTypeIconEnumPhcurrencyjpy ComponentTypeIconEnum = "PhCurrencyJpy" // ComponentTypeIconEnumPhcurrencykrw ComponentTypeIconEnum = "PhCurrencyKrw" // ComponentTypeIconEnumPhcurrencykzt ComponentTypeIconEnum = "PhCurrencyKzt" // ComponentTypeIconEnumPhcurrencyngn ComponentTypeIconEnum = "PhCurrencyNgn" // ComponentTypeIconEnumPhcurrencyrub ComponentTypeIconEnum = "PhCurrencyRub" // ComponentTypeIconEnumPhcursor ComponentTypeIconEnum = "PhCursor" // ComponentTypeIconEnumPhcursortext ComponentTypeIconEnum = "PhCursorText" // ComponentTypeIconEnumPhcylinder ComponentTypeIconEnum = "PhCylinder" // ComponentTypeIconEnumPhdatabase ComponentTypeIconEnum = "PhDatabase" // ComponentTypeIconEnumPhdesktop ComponentTypeIconEnum = "PhDesktop" // ComponentTypeIconEnumPhdesktoptower ComponentTypeIconEnum = "PhDesktopTower" // ComponentTypeIconEnumPhdetective ComponentTypeIconEnum = "PhDetective" // ComponentTypeIconEnumPhdevicemobile ComponentTypeIconEnum = "PhDeviceMobile" // ComponentTypeIconEnumPhdevicemobilecamera ComponentTypeIconEnum = "PhDeviceMobileCamera" // ComponentTypeIconEnumPhdevicemobilespeaker ComponentTypeIconEnum = "PhDeviceMobileSpeaker" // ComponentTypeIconEnumPhdevicetablet ComponentTypeIconEnum = "PhDeviceTablet" // ComponentTypeIconEnumPhdevicetabletcamera ComponentTypeIconEnum = "PhDeviceTabletCamera" // ComponentTypeIconEnumPhdevicetabletspeaker ComponentTypeIconEnum = "PhDeviceTabletSpeaker" // ComponentTypeIconEnumPhdiamond ComponentTypeIconEnum = "PhDiamond" // ComponentTypeIconEnumPhdiamondsfour ComponentTypeIconEnum = "PhDiamondsFour" // ComponentTypeIconEnumPhdicefive ComponentTypeIconEnum = "PhDiceFive" // ComponentTypeIconEnumPhdicefour ComponentTypeIconEnum = "PhDiceFour" // ComponentTypeIconEnumPhdiceone ComponentTypeIconEnum = "PhDiceOne" // ComponentTypeIconEnumPhdicesix ComponentTypeIconEnum = "PhDiceSix" // ComponentTypeIconEnumPhdicethree ComponentTypeIconEnum = "PhDiceThree" // ComponentTypeIconEnumPhdicetwo ComponentTypeIconEnum = "PhDiceTwo" // ComponentTypeIconEnumPhdisc ComponentTypeIconEnum = "PhDisc" // ComponentTypeIconEnumPhdiscordlogo ComponentTypeIconEnum = "PhDiscordLogo" // ComponentTypeIconEnumPhdivide ComponentTypeIconEnum = "PhDivide" // ComponentTypeIconEnumPhdog ComponentTypeIconEnum = "PhDog" // ComponentTypeIconEnumPhdoor ComponentTypeIconEnum = "PhDoor" // ComponentTypeIconEnumPhdotsnine ComponentTypeIconEnum = "PhDotsNine" // ComponentTypeIconEnumPhdotssix ComponentTypeIconEnum = "PhDotsSix" // ComponentTypeIconEnumPhdotssixvertical ComponentTypeIconEnum = "PhDotsSixVertical" // ComponentTypeIconEnumPhdotsthree ComponentTypeIconEnum = "PhDotsThree" // ComponentTypeIconEnumPhdotsthreecircle ComponentTypeIconEnum = "PhDotsThreeCircle" // ComponentTypeIconEnumPhdotsthreecirclevertical ComponentTypeIconEnum = "PhDotsThreeCircleVertical" // ComponentTypeIconEnumPhdotsthreeoutline ComponentTypeIconEnum = "PhDotsThreeOutline" // ComponentTypeIconEnumPhdotsthreeoutlinevertical ComponentTypeIconEnum = "PhDotsThreeOutlineVertical" // ComponentTypeIconEnumPhdotsthreevertical ComponentTypeIconEnum = "PhDotsThreeVertical" // ComponentTypeIconEnumPhdownload ComponentTypeIconEnum = "PhDownload" // ComponentTypeIconEnumPhdownloadsimple ComponentTypeIconEnum = "PhDownloadSimple" // ComponentTypeIconEnumPhdribbblelogo ComponentTypeIconEnum = "PhDribbbleLogo" // ComponentTypeIconEnumPhdrop ComponentTypeIconEnum = "PhDrop" // ComponentTypeIconEnumPhdrophalf ComponentTypeIconEnum = "PhDropHalf" // ComponentTypeIconEnumPhdrophalfbottom ComponentTypeIconEnum = "PhDropHalfBottom" // ComponentTypeIconEnumPhear ComponentTypeIconEnum = "PhEar" // ComponentTypeIconEnumPhearslash ComponentTypeIconEnum = "PhEarSlash" // ComponentTypeIconEnumPhegg ComponentTypeIconEnum = "PhEgg" // ComponentTypeIconEnumPheggcrack ComponentTypeIconEnum = "PhEggCrack" // ComponentTypeIconEnumPheject ComponentTypeIconEnum = "PhEject" // ComponentTypeIconEnumPhejectsimple ComponentTypeIconEnum = "PhEjectSimple" // ComponentTypeIconEnumPhenvelope ComponentTypeIconEnum = "PhEnvelope" // ComponentTypeIconEnumPhenvelopeopen ComponentTypeIconEnum = "PhEnvelopeOpen" // ComponentTypeIconEnumPhenvelopesimple ComponentTypeIconEnum = "PhEnvelopeSimple" // ComponentTypeIconEnumPhenvelopesimpleopen ComponentTypeIconEnum = "PhEnvelopeSimpleOpen" // ComponentTypeIconEnumPhequalizer ComponentTypeIconEnum = "PhEqualizer" // ComponentTypeIconEnumPhequals ComponentTypeIconEnum = "PhEquals" // ComponentTypeIconEnumPheraser ComponentTypeIconEnum = "PhEraser" // ComponentTypeIconEnumPhexam ComponentTypeIconEnum = "PhExam" // ComponentTypeIconEnumPhexport ComponentTypeIconEnum = "PhExport" // ComponentTypeIconEnumPheye ComponentTypeIconEnum = "PhEye" // ComponentTypeIconEnumPheyeclosed ComponentTypeIconEnum = "PhEyeClosed" // ComponentTypeIconEnumPheyeslash ComponentTypeIconEnum = "PhEyeSlash" // ComponentTypeIconEnumPheyedropper ComponentTypeIconEnum = "PhEyedropper" // ComponentTypeIconEnumPheyedroppersample ComponentTypeIconEnum = "PhEyedropperSample" // ComponentTypeIconEnumPheyeglasses ComponentTypeIconEnum = "PhEyeglasses" // ComponentTypeIconEnumPhfacemask ComponentTypeIconEnum = "PhFaceMask" // ComponentTypeIconEnumPhfacebooklogo ComponentTypeIconEnum = "PhFacebookLogo" // ComponentTypeIconEnumPhfactory ComponentTypeIconEnum = "PhFactory" // ComponentTypeIconEnumPhfaders ComponentTypeIconEnum = "PhFaders" // ComponentTypeIconEnumPhfadershorizontal ComponentTypeIconEnum = "PhFadersHorizontal" // ComponentTypeIconEnumPhfastforward ComponentTypeIconEnum = "PhFastForward" // ComponentTypeIconEnumPhfastforwardcircle ComponentTypeIconEnum = "PhFastForwardCircle" // ComponentTypeIconEnumPhfigmalogo ComponentTypeIconEnum = "PhFigmaLogo" // ComponentTypeIconEnumPhfile ComponentTypeIconEnum = "PhFile" // ComponentTypeIconEnumPhfilearrowdown ComponentTypeIconEnum = "PhFileArrowDown" // ComponentTypeIconEnumPhfilearrowup ComponentTypeIconEnum = "PhFileArrowUp" // ComponentTypeIconEnumPhfileaudio ComponentTypeIconEnum = "PhFileAudio" // ComponentTypeIconEnumPhfilecloud ComponentTypeIconEnum = "PhFileCloud" // ComponentTypeIconEnumPhfilecode ComponentTypeIconEnum = "PhFileCode" // ComponentTypeIconEnumPhfilecss ComponentTypeIconEnum = "PhFileCss" // ComponentTypeIconEnumPhfilecsv ComponentTypeIconEnum = "PhFileCsv" // ComponentTypeIconEnumPhfiledoc ComponentTypeIconEnum = "PhFileDoc" // ComponentTypeIconEnumPhfiledotted ComponentTypeIconEnum = "PhFileDotted" // ComponentTypeIconEnumPhfilehtml ComponentTypeIconEnum = "PhFileHtml" // ComponentTypeIconEnumPhfileimage ComponentTypeIconEnum = "PhFileImage" // ComponentTypeIconEnumPhfilejpg ComponentTypeIconEnum = "PhFileJpg" // ComponentTypeIconEnumPhfilejs ComponentTypeIconEnum = "PhFileJs" // ComponentTypeIconEnumPhfilejsx ComponentTypeIconEnum = "PhFileJsx" // ComponentTypeIconEnumPhfilelock ComponentTypeIconEnum = "PhFileLock" // ComponentTypeIconEnumPhfileminus ComponentTypeIconEnum = "PhFileMinus" // ComponentTypeIconEnumPhfilepdf ComponentTypeIconEnum = "PhFilePdf" // ComponentTypeIconEnumPhfileplus ComponentTypeIconEnum = "PhFilePlus" // ComponentTypeIconEnumPhfilepng ComponentTypeIconEnum = "PhFilePng" // ComponentTypeIconEnumPhfileppt ComponentTypeIconEnum = "PhFilePpt" // ComponentTypeIconEnumPhfilers ComponentTypeIconEnum = "PhFileRs" // ComponentTypeIconEnumPhfilesearch ComponentTypeIconEnum = "PhFileSearch" // ComponentTypeIconEnumPhfiletext ComponentTypeIconEnum = "PhFileText" // ComponentTypeIconEnumPhfilets ComponentTypeIconEnum = "PhFileTs" // ComponentTypeIconEnumPhfiletsx ComponentTypeIconEnum = "PhFileTsx" // ComponentTypeIconEnumPhfilevideo ComponentTypeIconEnum = "PhFileVideo" // ComponentTypeIconEnumPhfilevue ComponentTypeIconEnum = "PhFileVue" // ComponentTypeIconEnumPhfilex ComponentTypeIconEnum = "PhFileX" // ComponentTypeIconEnumPhfilexls ComponentTypeIconEnum = "PhFileXls" // ComponentTypeIconEnumPhfilezip ComponentTypeIconEnum = "PhFileZip" // ComponentTypeIconEnumPhfiles ComponentTypeIconEnum = "PhFiles" // ComponentTypeIconEnumPhfilmscript ComponentTypeIconEnum = "PhFilmScript" // ComponentTypeIconEnumPhfilmslate ComponentTypeIconEnum = "PhFilmSlate" // ComponentTypeIconEnumPhfilmstrip ComponentTypeIconEnum = "PhFilmStrip" // ComponentTypeIconEnumPhfingerprint ComponentTypeIconEnum = "PhFingerprint" // ComponentTypeIconEnumPhfingerprintsimple ComponentTypeIconEnum = "PhFingerprintSimple" // ComponentTypeIconEnumPhfinnthehuman ComponentTypeIconEnum = "PhFinnTheHuman" // ComponentTypeIconEnumPhfire ComponentTypeIconEnum = "PhFire" // ComponentTypeIconEnumPhfiresimple ComponentTypeIconEnum = "PhFireSimple" // ComponentTypeIconEnumPhfirstaid ComponentTypeIconEnum = "PhFirstAid" // ComponentTypeIconEnumPhfirstaidkit ComponentTypeIconEnum = "PhFirstAidKit" // ComponentTypeIconEnumPhfish ComponentTypeIconEnum = "PhFish" // ComponentTypeIconEnumPhfishsimple ComponentTypeIconEnum = "PhFishSimple" // ComponentTypeIconEnumPhflag ComponentTypeIconEnum = "PhFlag" // ComponentTypeIconEnumPhflagcheckered ComponentTypeIconEnum = "PhFlagCheckered" // ComponentTypeIconEnumPhflame ComponentTypeIconEnum = "PhFlame" // ComponentTypeIconEnumPhflashlight ComponentTypeIconEnum = "PhFlashlight" // ComponentTypeIconEnumPhflask ComponentTypeIconEnum = "PhFlask" // ComponentTypeIconEnumPhfloppydisk ComponentTypeIconEnum = "PhFloppyDisk" // ComponentTypeIconEnumPhfloppydiskback ComponentTypeIconEnum = "PhFloppyDiskBack" // ComponentTypeIconEnumPhflowarrow ComponentTypeIconEnum = "PhFlowArrow" // ComponentTypeIconEnumPhflower ComponentTypeIconEnum = "PhFlower" // ComponentTypeIconEnumPhflowerlotus ComponentTypeIconEnum = "PhFlowerLotus" // ComponentTypeIconEnumPhflyingsaucer ComponentTypeIconEnum = "PhFlyingSaucer" // ComponentTypeIconEnumPhfolder ComponentTypeIconEnum = "PhFolder" // ComponentTypeIconEnumPhfolderdotted ComponentTypeIconEnum = "PhFolderDotted" // ComponentTypeIconEnumPhfolderlock ComponentTypeIconEnum = "PhFolderLock" // ComponentTypeIconEnumPhfolderminus ComponentTypeIconEnum = "PhFolderMinus" // ComponentTypeIconEnumPhfoldernotch ComponentTypeIconEnum = "PhFolderNotch" // ComponentTypeIconEnumPhfoldernotchminus ComponentTypeIconEnum = "PhFolderNotchMinus" // ComponentTypeIconEnumPhfoldernotchopen ComponentTypeIconEnum = "PhFolderNotchOpen" // ComponentTypeIconEnumPhfoldernotchplus ComponentTypeIconEnum = "PhFolderNotchPlus" // ComponentTypeIconEnumPhfolderopen ComponentTypeIconEnum = "PhFolderOpen" // ComponentTypeIconEnumPhfolderplus ComponentTypeIconEnum = "PhFolderPlus" // ComponentTypeIconEnumPhfoldersimple ComponentTypeIconEnum = "PhFolderSimple" // ComponentTypeIconEnumPhfoldersimpledotted ComponentTypeIconEnum = "PhFolderSimpleDotted" // ComponentTypeIconEnumPhfoldersimplelock ComponentTypeIconEnum = "PhFolderSimpleLock" // ComponentTypeIconEnumPhfoldersimpleminus ComponentTypeIconEnum = "PhFolderSimpleMinus" // ComponentTypeIconEnumPhfoldersimpleplus ComponentTypeIconEnum = "PhFolderSimplePlus" // ComponentTypeIconEnumPhfoldersimplestar ComponentTypeIconEnum = "PhFolderSimpleStar" // ComponentTypeIconEnumPhfoldersimpleuser ComponentTypeIconEnum = "PhFolderSimpleUser" // ComponentTypeIconEnumPhfolderstar ComponentTypeIconEnum = "PhFolderStar" // ComponentTypeIconEnumPhfolderuser ComponentTypeIconEnum = "PhFolderUser" // ComponentTypeIconEnumPhfolders ComponentTypeIconEnum = "PhFolders" // ComponentTypeIconEnumPhfootball ComponentTypeIconEnum = "PhFootball" // ComponentTypeIconEnumPhforkknife ComponentTypeIconEnum = "PhForkKnife" // ComponentTypeIconEnumPhframecorners ComponentTypeIconEnum = "PhFrameCorners" // ComponentTypeIconEnumPhframerlogo ComponentTypeIconEnum = "PhFramerLogo" // ComponentTypeIconEnumPhfunction ComponentTypeIconEnum = "PhFunction" // ComponentTypeIconEnumPhfunnel ComponentTypeIconEnum = "PhFunnel" // ComponentTypeIconEnumPhfunnelsimple ComponentTypeIconEnum = "PhFunnelSimple" // ComponentTypeIconEnumPhgamecontroller ComponentTypeIconEnum = "PhGameController" // ComponentTypeIconEnumPhgaspump ComponentTypeIconEnum = "PhGasPump" // ComponentTypeIconEnumPhgauge ComponentTypeIconEnum = "PhGauge" // ComponentTypeIconEnumPhgear ComponentTypeIconEnum = "PhGear" // ComponentTypeIconEnumPhgearsix ComponentTypeIconEnum = "PhGearSix" // ComponentTypeIconEnumPhgenderfemale ComponentTypeIconEnum = "PhGenderFemale" // ComponentTypeIconEnumPhgenderintersex ComponentTypeIconEnum = "PhGenderIntersex" // ComponentTypeIconEnumPhgendermale ComponentTypeIconEnum = "PhGenderMale" // ComponentTypeIconEnumPhgenderneuter ComponentTypeIconEnum = "PhGenderNeuter" // ComponentTypeIconEnumPhgendernonbinary ComponentTypeIconEnum = "PhGenderNonbinary" // ComponentTypeIconEnumPhgendertransgender ComponentTypeIconEnum = "PhGenderTransgender" // ComponentTypeIconEnumPhghost ComponentTypeIconEnum = "PhGhost" // ComponentTypeIconEnumPhgif ComponentTypeIconEnum = "PhGif" // ComponentTypeIconEnumPhgift ComponentTypeIconEnum = "PhGift" // ComponentTypeIconEnumPhgitbranch ComponentTypeIconEnum = "PhGitBranch" // ComponentTypeIconEnumPhgitcommit ComponentTypeIconEnum = "PhGitCommit" // ComponentTypeIconEnumPhgitdiff ComponentTypeIconEnum = "PhGitDiff" // ComponentTypeIconEnumPhgitfork ComponentTypeIconEnum = "PhGitFork" // ComponentTypeIconEnumPhgitmerge ComponentTypeIconEnum = "PhGitMerge" // ComponentTypeIconEnumPhgitpullrequest ComponentTypeIconEnum = "PhGitPullRequest" // ComponentTypeIconEnumPhgithublogo ComponentTypeIconEnum = "PhGithubLogo" // ComponentTypeIconEnumPhgitlablogo ComponentTypeIconEnum = "PhGitlabLogo" // ComponentTypeIconEnumPhgitlablogosimple ComponentTypeIconEnum = "PhGitlabLogoSimple" // ComponentTypeIconEnumPhglobe ComponentTypeIconEnum = "PhGlobe" // ComponentTypeIconEnumPhglobehemisphereeast ComponentTypeIconEnum = "PhGlobeHemisphereEast" // ComponentTypeIconEnumPhglobehemispherewest ComponentTypeIconEnum = "PhGlobeHemisphereWest" // ComponentTypeIconEnumPhglobesimple ComponentTypeIconEnum = "PhGlobeSimple" // ComponentTypeIconEnumPhglobestand ComponentTypeIconEnum = "PhGlobeStand" // ComponentTypeIconEnumPhgooglechromelogo ComponentTypeIconEnum = "PhGoogleChromeLogo" // ComponentTypeIconEnumPhgooglelogo ComponentTypeIconEnum = "PhGoogleLogo" // ComponentTypeIconEnumPhgooglephotoslogo ComponentTypeIconEnum = "PhGooglePhotosLogo" // ComponentTypeIconEnumPhgoogleplaylogo ComponentTypeIconEnum = "PhGooglePlayLogo" // ComponentTypeIconEnumPhgooglepodcastslogo ComponentTypeIconEnum = "PhGooglePodcastsLogo" // ComponentTypeIconEnumPhgradient ComponentTypeIconEnum = "PhGradient" // ComponentTypeIconEnumPhgraduationcap ComponentTypeIconEnum = "PhGraduationCap" // ComponentTypeIconEnumPhgraph ComponentTypeIconEnum = "PhGraph" // ComponentTypeIconEnumPhgridfour ComponentTypeIconEnum = "PhGridFour" // ComponentTypeIconEnumPhhamburger ComponentTypeIconEnum = "PhHamburger" // ComponentTypeIconEnumPhhand ComponentTypeIconEnum = "PhHand" // ComponentTypeIconEnumPhhandeye ComponentTypeIconEnum = "PhHandEye" // ComponentTypeIconEnumPhhandfist ComponentTypeIconEnum = "PhHandFist" // ComponentTypeIconEnumPhhandgrabbing ComponentTypeIconEnum = "PhHandGrabbing" // ComponentTypeIconEnumPhhandpalm ComponentTypeIconEnum = "PhHandPalm" // ComponentTypeIconEnumPhhandpointing ComponentTypeIconEnum = "PhHandPointing" // ComponentTypeIconEnumPhhandsoap ComponentTypeIconEnum = "PhHandSoap" // ComponentTypeIconEnumPhhandwaving ComponentTypeIconEnum = "PhHandWaving" // ComponentTypeIconEnumPhhandbag ComponentTypeIconEnum = "PhHandbag" // ComponentTypeIconEnumPhhandbagsimple ComponentTypeIconEnum = "PhHandbagSimple" // ComponentTypeIconEnumPhhandsclapping ComponentTypeIconEnum = "PhHandsClapping" // ComponentTypeIconEnumPhhandshake ComponentTypeIconEnum = "PhHandshake" // ComponentTypeIconEnumPhharddrive ComponentTypeIconEnum = "PhHardDrive" // ComponentTypeIconEnumPhharddrives ComponentTypeIconEnum = "PhHardDrives" // ComponentTypeIconEnumPhhash ComponentTypeIconEnum = "PhHash" // ComponentTypeIconEnumPhhashstraight ComponentTypeIconEnum = "PhHashStraight" // ComponentTypeIconEnumPhheadlights ComponentTypeIconEnum = "PhHeadlights" // ComponentTypeIconEnumPhheadphones ComponentTypeIconEnum = "PhHeadphones" // ComponentTypeIconEnumPhheadset ComponentTypeIconEnum = "PhHeadset" // ComponentTypeIconEnumPhheart ComponentTypeIconEnum = "PhHeart" // ComponentTypeIconEnumPhheartbreak ComponentTypeIconEnum = "PhHeartBreak" // ComponentTypeIconEnumPhheartstraight ComponentTypeIconEnum = "PhHeartStraight" // ComponentTypeIconEnumPhheartstraightbreak ComponentTypeIconEnum = "PhHeartStraightBreak" // ComponentTypeIconEnumPhheartbeat ComponentTypeIconEnum = "PhHeartbeat" // ComponentTypeIconEnumPhhexagon ComponentTypeIconEnum = "PhHexagon" // ComponentTypeIconEnumPhhighlightercircle ComponentTypeIconEnum = "PhHighlighterCircle" // ComponentTypeIconEnumPhhorse ComponentTypeIconEnum = "PhHorse" // ComponentTypeIconEnumPhhourglass ComponentTypeIconEnum = "PhHourglass" // ComponentTypeIconEnumPhhourglasshigh ComponentTypeIconEnum = "PhHourglassHigh" // ComponentTypeIconEnumPhhourglasslow ComponentTypeIconEnum = "PhHourglassLow" // ComponentTypeIconEnumPhhourglassmedium ComponentTypeIconEnum = "PhHourglassMedium" // ComponentTypeIconEnumPhhourglasssimple ComponentTypeIconEnum = "PhHourglassSimple" // ComponentTypeIconEnumPhhourglasssimplehigh ComponentTypeIconEnum = "PhHourglassSimpleHigh" // ComponentTypeIconEnumPhhourglasssimplelow ComponentTypeIconEnum = "PhHourglassSimpleLow" // ComponentTypeIconEnumPhhourglasssimplemedium ComponentTypeIconEnum = "PhHourglassSimpleMedium" // ComponentTypeIconEnumPhhouse ComponentTypeIconEnum = "PhHouse" // ComponentTypeIconEnumPhhouseline ComponentTypeIconEnum = "PhHouseLine" // ComponentTypeIconEnumPhhousesimple ComponentTypeIconEnum = "PhHouseSimple" // ComponentTypeIconEnumPhidentificationbadge ComponentTypeIconEnum = "PhIdentificationBadge" // ComponentTypeIconEnumPhidentificationcard ComponentTypeIconEnum = "PhIdentificationCard" // ComponentTypeIconEnumPhimage ComponentTypeIconEnum = "PhImage" // ComponentTypeIconEnumPhimagesquare ComponentTypeIconEnum = "PhImageSquare" // ComponentTypeIconEnumPhinfinity ComponentTypeIconEnum = "PhInfinity" // ComponentTypeIconEnumPhinfo ComponentTypeIconEnum = "PhInfo" // ComponentTypeIconEnumPhinstagramlogo ComponentTypeIconEnum = "PhInstagramLogo" // ComponentTypeIconEnumPhintersect ComponentTypeIconEnum = "PhIntersect" // ComponentTypeIconEnumPhjeep ComponentTypeIconEnum = "PhJeep" // ComponentTypeIconEnumPhkanban ComponentTypeIconEnum = "PhKanban" // ComponentTypeIconEnumPhkey ComponentTypeIconEnum = "PhKey" // ComponentTypeIconEnumPhkeyreturn ComponentTypeIconEnum = "PhKeyReturn" // ComponentTypeIconEnumPhkeyboard ComponentTypeIconEnum = "PhKeyboard" // ComponentTypeIconEnumPhkeyhole ComponentTypeIconEnum = "PhKeyhole" // ComponentTypeIconEnumPhknife ComponentTypeIconEnum = "PhKnife" // ComponentTypeIconEnumPhladder ComponentTypeIconEnum = "PhLadder" // ComponentTypeIconEnumPhladdersimple ComponentTypeIconEnum = "PhLadderSimple" // ComponentTypeIconEnumPhlamp ComponentTypeIconEnum = "PhLamp" // ComponentTypeIconEnumPhlaptop ComponentTypeIconEnum = "PhLaptop" // ComponentTypeIconEnumPhlayout ComponentTypeIconEnum = "PhLayout" // ComponentTypeIconEnumPhleaf ComponentTypeIconEnum = "PhLeaf" // ComponentTypeIconEnumPhlifebuoy ComponentTypeIconEnum = "PhLifebuoy" // ComponentTypeIconEnumPhlightbulb ComponentTypeIconEnum = "PhLightbulb" // ComponentTypeIconEnumPhlightbulbfilament ComponentTypeIconEnum = "PhLightbulbFilament" // ComponentTypeIconEnumPhlightning ComponentTypeIconEnum = "PhLightning" // ComponentTypeIconEnumPhlightningslash ComponentTypeIconEnum = "PhLightningSlash" // ComponentTypeIconEnumPhlinesegment ComponentTypeIconEnum = "PhLineSegment" // ComponentTypeIconEnumPhlinesegments ComponentTypeIconEnum = "PhLineSegments" // ComponentTypeIconEnumPhlink ComponentTypeIconEnum = "PhLink" // ComponentTypeIconEnumPhlinkbreak ComponentTypeIconEnum = "PhLinkBreak" // ComponentTypeIconEnumPhlinksimple ComponentTypeIconEnum = "PhLinkSimple" // ComponentTypeIconEnumPhlinksimplebreak ComponentTypeIconEnum = "PhLinkSimpleBreak" // ComponentTypeIconEnumPhlinksimplehorizontal ComponentTypeIconEnum = "PhLinkSimpleHorizontal" // ComponentTypeIconEnumPhlinksimplehorizontalbreak ComponentTypeIconEnum = "PhLinkSimpleHorizontalBreak" // ComponentTypeIconEnumPhlinkedinlogo ComponentTypeIconEnum = "PhLinkedinLogo" // ComponentTypeIconEnumPhlinuxlogo ComponentTypeIconEnum = "PhLinuxLogo" // ComponentTypeIconEnumPhlist ComponentTypeIconEnum = "PhList" // ComponentTypeIconEnumPhlistbullets ComponentTypeIconEnum = "PhListBullets" // ComponentTypeIconEnumPhlistchecks ComponentTypeIconEnum = "PhListChecks" // ComponentTypeIconEnumPhlistdashes ComponentTypeIconEnum = "PhListDashes" // ComponentTypeIconEnumPhlistnumbers ComponentTypeIconEnum = "PhListNumbers" // ComponentTypeIconEnumPhlistplus ComponentTypeIconEnum = "PhListPlus" // ComponentTypeIconEnumPhlock ComponentTypeIconEnum = "PhLock" // ComponentTypeIconEnumPhlockkey ComponentTypeIconEnum = "PhLockKey" // ComponentTypeIconEnumPhlockkeyopen ComponentTypeIconEnum = "PhLockKeyOpen" // ComponentTypeIconEnumPhlocklaminated ComponentTypeIconEnum = "PhLockLaminated" // ComponentTypeIconEnumPhlocklaminatedopen ComponentTypeIconEnum = "PhLockLaminatedOpen" // ComponentTypeIconEnumPhlockopen ComponentTypeIconEnum = "PhLockOpen" // ComponentTypeIconEnumPhlocksimple ComponentTypeIconEnum = "PhLockSimple" // ComponentTypeIconEnumPhlocksimpleopen ComponentTypeIconEnum = "PhLockSimpleOpen" // ComponentTypeIconEnumPhmagicwand ComponentTypeIconEnum = "PhMagicWand" // ComponentTypeIconEnumPhmagnet ComponentTypeIconEnum = "PhMagnet" // ComponentTypeIconEnumPhmagnetstraight ComponentTypeIconEnum = "PhMagnetStraight" // ComponentTypeIconEnumPhmagnifyingglass ComponentTypeIconEnum = "PhMagnifyingGlass" // ComponentTypeIconEnumPhmagnifyingglassminus ComponentTypeIconEnum = "PhMagnifyingGlassMinus" // ComponentTypeIconEnumPhmagnifyingglassplus ComponentTypeIconEnum = "PhMagnifyingGlassPlus" // ComponentTypeIconEnumPhmappin ComponentTypeIconEnum = "PhMapPin" // ComponentTypeIconEnumPhmappinline ComponentTypeIconEnum = "PhMapPinLine" // ComponentTypeIconEnumPhmaptrifold ComponentTypeIconEnum = "PhMapTrifold" // ComponentTypeIconEnumPhmarkercircle ComponentTypeIconEnum = "PhMarkerCircle" // ComponentTypeIconEnumPhmartini ComponentTypeIconEnum = "PhMartini" // ComponentTypeIconEnumPhmaskhappy ComponentTypeIconEnum = "PhMaskHappy" // ComponentTypeIconEnumPhmasksad ComponentTypeIconEnum = "PhMaskSad" // ComponentTypeIconEnumPhmathoperations ComponentTypeIconEnum = "PhMathOperations" // ComponentTypeIconEnumPhmedal ComponentTypeIconEnum = "PhMedal" // ComponentTypeIconEnumPhmediumlogo ComponentTypeIconEnum = "PhMediumLogo" // ComponentTypeIconEnumPhmegaphone ComponentTypeIconEnum = "PhMegaphone" // ComponentTypeIconEnumPhmegaphonesimple ComponentTypeIconEnum = "PhMegaphoneSimple" // ComponentTypeIconEnumPhmessengerlogo ComponentTypeIconEnum = "PhMessengerLogo" // ComponentTypeIconEnumPhmicrophone ComponentTypeIconEnum = "PhMicrophone" // ComponentTypeIconEnumPhmicrophoneslash ComponentTypeIconEnum = "PhMicrophoneSlash" // ComponentTypeIconEnumPhmicrophonestage ComponentTypeIconEnum = "PhMicrophoneStage" // ComponentTypeIconEnumPhmicrosoftexcellogo ComponentTypeIconEnum = "PhMicrosoftExcelLogo" // ComponentTypeIconEnumPhmicrosoftpowerpointlogo ComponentTypeIconEnum = "PhMicrosoftPowerpointLogo" // ComponentTypeIconEnumPhmicrosoftteamslogo ComponentTypeIconEnum = "PhMicrosoftTeamsLogo" // ComponentTypeIconEnumPhmicrosoftwordlogo ComponentTypeIconEnum = "PhMicrosoftWordLogo" // ComponentTypeIconEnumPhminus ComponentTypeIconEnum = "PhMinus" // ComponentTypeIconEnumPhminuscircle ComponentTypeIconEnum = "PhMinusCircle" // ComponentTypeIconEnumPhmoney ComponentTypeIconEnum = "PhMoney" // ComponentTypeIconEnumPhmonitor ComponentTypeIconEnum = "PhMonitor" // ComponentTypeIconEnumPhmonitorplay ComponentTypeIconEnum = "PhMonitorPlay" // ComponentTypeIconEnumPhmoon ComponentTypeIconEnum = "PhMoon" // ComponentTypeIconEnumPhmoonstars ComponentTypeIconEnum = "PhMoonStars" // ComponentTypeIconEnumPhmountains ComponentTypeIconEnum = "PhMountains" // ComponentTypeIconEnumPhmouse ComponentTypeIconEnum = "PhMouse" // ComponentTypeIconEnumPhmousesimple ComponentTypeIconEnum = "PhMouseSimple" // ComponentTypeIconEnumPhmusicnote ComponentTypeIconEnum = "PhMusicNote" // ComponentTypeIconEnumPhmusicnotesimple ComponentTypeIconEnum = "PhMusicNoteSimple" // ComponentTypeIconEnumPhmusicnotes ComponentTypeIconEnum = "PhMusicNotes" // ComponentTypeIconEnumPhmusicnotesplus ComponentTypeIconEnum = "PhMusicNotesPlus" // ComponentTypeIconEnumPhmusicnotessimple ComponentTypeIconEnum = "PhMusicNotesSimple" // ComponentTypeIconEnumPhneedle ComponentTypeIconEnum = "PhNeedle" // ComponentTypeIconEnumPhnewspaper ComponentTypeIconEnum = "PhNewspaper" // ComponentTypeIconEnumPhnewspaperclipping ComponentTypeIconEnum = "PhNewspaperClipping" // ComponentTypeIconEnumPhnote ComponentTypeIconEnum = "PhNote" // ComponentTypeIconEnumPhnoteblank ComponentTypeIconEnum = "PhNoteBlank" // ComponentTypeIconEnumPhnotepencil ComponentTypeIconEnum = "PhNotePencil" // ComponentTypeIconEnumPhnotebook ComponentTypeIconEnum = "PhNotebook" // ComponentTypeIconEnumPhnotepad ComponentTypeIconEnum = "PhNotepad" // ComponentTypeIconEnumPhnotification ComponentTypeIconEnum = "PhNotification" // ComponentTypeIconEnumPhnumbercircleeight ComponentTypeIconEnum = "PhNumberCircleEight" // ComponentTypeIconEnumPhnumbercirclefive ComponentTypeIconEnum = "PhNumberCircleFive" // ComponentTypeIconEnumPhnumbercirclefour ComponentTypeIconEnum = "PhNumberCircleFour" // ComponentTypeIconEnumPhnumbercirclenine ComponentTypeIconEnum = "PhNumberCircleNine" // ComponentTypeIconEnumPhnumbercircleone ComponentTypeIconEnum = "PhNumberCircleOne" // ComponentTypeIconEnumPhnumbercircleseven ComponentTypeIconEnum = "PhNumberCircleSeven" // ComponentTypeIconEnumPhnumbercirclesix ComponentTypeIconEnum = "PhNumberCircleSix" // ComponentTypeIconEnumPhnumbercirclethree ComponentTypeIconEnum = "PhNumberCircleThree" // ComponentTypeIconEnumPhnumbercircletwo ComponentTypeIconEnum = "PhNumberCircleTwo" // ComponentTypeIconEnumPhnumbercirclezero ComponentTypeIconEnum = "PhNumberCircleZero" // ComponentTypeIconEnumPhnumbereight ComponentTypeIconEnum = "PhNumberEight" // ComponentTypeIconEnumPhnumberfive ComponentTypeIconEnum = "PhNumberFive" // ComponentTypeIconEnumPhnumberfour ComponentTypeIconEnum = "PhNumberFour" // ComponentTypeIconEnumPhnumbernine ComponentTypeIconEnum = "PhNumberNine" // ComponentTypeIconEnumPhnumberone ComponentTypeIconEnum = "PhNumberOne" // ComponentTypeIconEnumPhnumberseven ComponentTypeIconEnum = "PhNumberSeven" // ComponentTypeIconEnumPhnumbersix ComponentTypeIconEnum = "PhNumberSix" // ComponentTypeIconEnumPhnumbersquareeight ComponentTypeIconEnum = "PhNumberSquareEight" // ComponentTypeIconEnumPhnumbersquarefive ComponentTypeIconEnum = "PhNumberSquareFive" // ComponentTypeIconEnumPhnumbersquarefour ComponentTypeIconEnum = "PhNumberSquareFour" // ComponentTypeIconEnumPhnumbersquarenine ComponentTypeIconEnum = "PhNumberSquareNine" // ComponentTypeIconEnumPhnumbersquareone ComponentTypeIconEnum = "PhNumberSquareOne" // ComponentTypeIconEnumPhnumbersquareseven ComponentTypeIconEnum = "PhNumberSquareSeven" // ComponentTypeIconEnumPhnumbersquaresix ComponentTypeIconEnum = "PhNumberSquareSix" // ComponentTypeIconEnumPhnumbersquarethree ComponentTypeIconEnum = "PhNumberSquareThree" // ComponentTypeIconEnumPhnumbersquaretwo ComponentTypeIconEnum = "PhNumberSquareTwo" // ComponentTypeIconEnumPhnumbersquarezero ComponentTypeIconEnum = "PhNumberSquareZero" // ComponentTypeIconEnumPhnumberthree ComponentTypeIconEnum = "PhNumberThree" // ComponentTypeIconEnumPhnumbertwo ComponentTypeIconEnum = "PhNumberTwo" // ComponentTypeIconEnumPhnumberzero ComponentTypeIconEnum = "PhNumberZero" // ComponentTypeIconEnumPhnut ComponentTypeIconEnum = "PhNut" // ComponentTypeIconEnumPhnytimeslogo ComponentTypeIconEnum = "PhNyTimesLogo" // ComponentTypeIconEnumPhoctagon ComponentTypeIconEnum = "PhOctagon" // ComponentTypeIconEnumPhoption ComponentTypeIconEnum = "PhOption" // ComponentTypeIconEnumPhpackage ComponentTypeIconEnum = "PhPackage" // ComponentTypeIconEnumPhpaintbrush ComponentTypeIconEnum = "PhPaintBrush" // ComponentTypeIconEnumPhpaintbrushbroad ComponentTypeIconEnum = "PhPaintBrushBroad" // ComponentTypeIconEnumPhpaintbrushhousehold ComponentTypeIconEnum = "PhPaintBrushHousehold" // ComponentTypeIconEnumPhpaintbucket ComponentTypeIconEnum = "PhPaintBucket" // ComponentTypeIconEnumPhpaintroller ComponentTypeIconEnum = "PhPaintRoller" // ComponentTypeIconEnumPhpalette ComponentTypeIconEnum = "PhPalette" // ComponentTypeIconEnumPhpaperplane ComponentTypeIconEnum = "PhPaperPlane" // ComponentTypeIconEnumPhpaperplaneright ComponentTypeIconEnum = "PhPaperPlaneRight" // ComponentTypeIconEnumPhpaperplanetilt ComponentTypeIconEnum = "PhPaperPlaneTilt" // ComponentTypeIconEnumPhpaperclip ComponentTypeIconEnum = "PhPaperclip" // ComponentTypeIconEnumPhpapercliphorizontal ComponentTypeIconEnum = "PhPaperclipHorizontal" // ComponentTypeIconEnumPhparachute ComponentTypeIconEnum = "PhParachute" // ComponentTypeIconEnumPhpassword ComponentTypeIconEnum = "PhPassword" // ComponentTypeIconEnumPhpath ComponentTypeIconEnum = "PhPath" // ComponentTypeIconEnumPhpause ComponentTypeIconEnum = "PhPause" // ComponentTypeIconEnumPhpausecircle ComponentTypeIconEnum = "PhPauseCircle" // ComponentTypeIconEnumPhpawprint ComponentTypeIconEnum = "PhPawPrint" // ComponentTypeIconEnumPhpeace ComponentTypeIconEnum = "PhPeace" // ComponentTypeIconEnumPhpen ComponentTypeIconEnum = "PhPen" // ComponentTypeIconEnumPhpennib ComponentTypeIconEnum = "PhPenNib" // ComponentTypeIconEnumPhpennibstraight ComponentTypeIconEnum = "PhPenNibStraight" // ComponentTypeIconEnumPhpencil ComponentTypeIconEnum = "PhPencil" // ComponentTypeIconEnumPhpencilcircle ComponentTypeIconEnum = "PhPencilCircle" // ComponentTypeIconEnumPhpencilline ComponentTypeIconEnum = "PhPencilLine" // ComponentTypeIconEnumPhpencilsimple ComponentTypeIconEnum = "PhPencilSimple" // ComponentTypeIconEnumPhpencilsimpleline ComponentTypeIconEnum = "PhPencilSimpleLine" // ComponentTypeIconEnumPhpercent ComponentTypeIconEnum = "PhPercent" // ComponentTypeIconEnumPhperson ComponentTypeIconEnum = "PhPerson" // ComponentTypeIconEnumPhpersonsimple ComponentTypeIconEnum = "PhPersonSimple" // ComponentTypeIconEnumPhpersonsimplerun ComponentTypeIconEnum = "PhPersonSimpleRun" // ComponentTypeIconEnumPhpersonsimplewalk ComponentTypeIconEnum = "PhPersonSimpleWalk" // ComponentTypeIconEnumPhperspective ComponentTypeIconEnum = "PhPerspective" // ComponentTypeIconEnumPhphone ComponentTypeIconEnum = "PhPhone" // ComponentTypeIconEnumPhphonecall ComponentTypeIconEnum = "PhPhoneCall" // ComponentTypeIconEnumPhphonedisconnect ComponentTypeIconEnum = "PhPhoneDisconnect" // ComponentTypeIconEnumPhphoneincoming ComponentTypeIconEnum = "PhPhoneIncoming" // ComponentTypeIconEnumPhphoneoutgoing ComponentTypeIconEnum = "PhPhoneOutgoing" // ComponentTypeIconEnumPhphoneslash ComponentTypeIconEnum = "PhPhoneSlash" // ComponentTypeIconEnumPhphonex ComponentTypeIconEnum = "PhPhoneX" // ComponentTypeIconEnumPhphosphorlogo ComponentTypeIconEnum = "PhPhosphorLogo" // ComponentTypeIconEnumPhpianokeys ComponentTypeIconEnum = "PhPianoKeys" // ComponentTypeIconEnumPhpictureinpicture ComponentTypeIconEnum = "PhPictureInPicture" // ComponentTypeIconEnumPhpill ComponentTypeIconEnum = "PhPill" // ComponentTypeIconEnumPhpinterestlogo ComponentTypeIconEnum = "PhPinterestLogo" // ComponentTypeIconEnumPhpinwheel ComponentTypeIconEnum = "PhPinwheel" // ComponentTypeIconEnumPhpizza ComponentTypeIconEnum = "PhPizza" // ComponentTypeIconEnumPhplaceholder ComponentTypeIconEnum = "PhPlaceholder" // ComponentTypeIconEnumPhplanet ComponentTypeIconEnum = "PhPlanet" // ComponentTypeIconEnumPhplay ComponentTypeIconEnum = "PhPlay" // ComponentTypeIconEnumPhplaycircle ComponentTypeIconEnum = "PhPlayCircle" // ComponentTypeIconEnumPhplaylist ComponentTypeIconEnum = "PhPlaylist" // ComponentTypeIconEnumPhplug ComponentTypeIconEnum = "PhPlug" // ComponentTypeIconEnumPhplugs ComponentTypeIconEnum = "PhPlugs" // ComponentTypeIconEnumPhplugsconnected ComponentTypeIconEnum = "PhPlugsConnected" // ComponentTypeIconEnumPhplus ComponentTypeIconEnum = "PhPlus" // ComponentTypeIconEnumPhpluscircle ComponentTypeIconEnum = "PhPlusCircle" // ComponentTypeIconEnumPhplusminus ComponentTypeIconEnum = "PhPlusMinus" // ComponentTypeIconEnumPhpokerchip ComponentTypeIconEnum = "PhPokerChip" // ComponentTypeIconEnumPhpolicecar ComponentTypeIconEnum = "PhPoliceCar" // ComponentTypeIconEnumPhpolygon ComponentTypeIconEnum = "PhPolygon" // ComponentTypeIconEnumPhpopcorn ComponentTypeIconEnum = "PhPopcorn" // ComponentTypeIconEnumPhpower ComponentTypeIconEnum = "PhPower" // ComponentTypeIconEnumPhprescription ComponentTypeIconEnum = "PhPrescription" // ComponentTypeIconEnumPhpresentation ComponentTypeIconEnum = "PhPresentation" // ComponentTypeIconEnumPhpresentationchart ComponentTypeIconEnum = "PhPresentationChart" // ComponentTypeIconEnumPhprinter ComponentTypeIconEnum = "PhPrinter" // ComponentTypeIconEnumPhprohibit ComponentTypeIconEnum = "PhProhibit" // ComponentTypeIconEnumPhprohibitinset ComponentTypeIconEnum = "PhProhibitInset" // ComponentTypeIconEnumPhprojectorscreen ComponentTypeIconEnum = "PhProjectorScreen" // ComponentTypeIconEnumPhprojectorscreenchart ComponentTypeIconEnum = "PhProjectorScreenChart" // ComponentTypeIconEnumPhpushpin ComponentTypeIconEnum = "PhPushPin" // ComponentTypeIconEnumPhpushpinsimple ComponentTypeIconEnum = "PhPushPinSimple" // ComponentTypeIconEnumPhpushpinsimpleslash ComponentTypeIconEnum = "PhPushPinSimpleSlash" // ComponentTypeIconEnumPhpushpinslash ComponentTypeIconEnum = "PhPushPinSlash" // ComponentTypeIconEnumPhpuzzlepiece ComponentTypeIconEnum = "PhPuzzlePiece" // ComponentTypeIconEnumPhqrcode ComponentTypeIconEnum = "PhQrCode" // ComponentTypeIconEnumPhquestion ComponentTypeIconEnum = "PhQuestion" // ComponentTypeIconEnumPhqueue ComponentTypeIconEnum = "PhQueue" // ComponentTypeIconEnumPhquotes ComponentTypeIconEnum = "PhQuotes" // ComponentTypeIconEnumPhradical ComponentTypeIconEnum = "PhRadical" // ComponentTypeIconEnumPhradio ComponentTypeIconEnum = "PhRadio" // ComponentTypeIconEnumPhrainbow ComponentTypeIconEnum = "PhRainbow" // ComponentTypeIconEnumPhrainbowcloud ComponentTypeIconEnum = "PhRainbowCloud" // ComponentTypeIconEnumPhreceipt ComponentTypeIconEnum = "PhReceipt" // ComponentTypeIconEnumPhrecord ComponentTypeIconEnum = "PhRecord" // ComponentTypeIconEnumPhrectangle ComponentTypeIconEnum = "PhRectangle" // ComponentTypeIconEnumPhrecycle ComponentTypeIconEnum = "PhRecycle" // ComponentTypeIconEnumPhredditlogo ComponentTypeIconEnum = "PhRedditLogo" // ComponentTypeIconEnumPhrepeat ComponentTypeIconEnum = "PhRepeat" // ComponentTypeIconEnumPhrepeatonce ComponentTypeIconEnum = "PhRepeatOnce" // ComponentTypeIconEnumPhrewind ComponentTypeIconEnum = "PhRewind" // ComponentTypeIconEnumPhrewindcircle ComponentTypeIconEnum = "PhRewindCircle" // ComponentTypeIconEnumPhrobot ComponentTypeIconEnum = "PhRobot" // ComponentTypeIconEnumPhrocket ComponentTypeIconEnum = "PhRocket" // ComponentTypeIconEnumPhrocketlaunch ComponentTypeIconEnum = "PhRocketLaunch" // ComponentTypeIconEnumPhrows ComponentTypeIconEnum = "PhRows" // ComponentTypeIconEnumPhrss ComponentTypeIconEnum = "PhRss" // ComponentTypeIconEnumPhrsssimple ComponentTypeIconEnum = "PhRssSimple" // ComponentTypeIconEnumPhrug ComponentTypeIconEnum = "PhRug" // ComponentTypeIconEnumPhruler ComponentTypeIconEnum = "PhRuler" // ComponentTypeIconEnumPhscales ComponentTypeIconEnum = "PhScales" // ComponentTypeIconEnumPhscan ComponentTypeIconEnum = "PhScan" // ComponentTypeIconEnumPhscissors ComponentTypeIconEnum = "PhScissors" // ComponentTypeIconEnumPhscreencast ComponentTypeIconEnum = "PhScreencast" // ComponentTypeIconEnumPhscribbleloop ComponentTypeIconEnum = "PhScribbleLoop" // ComponentTypeIconEnumPhscroll ComponentTypeIconEnum = "PhScroll" // ComponentTypeIconEnumPhselection ComponentTypeIconEnum = "PhSelection" // ComponentTypeIconEnumPhselectionall ComponentTypeIconEnum = "PhSelectionAll" // ComponentTypeIconEnumPhselectionbackground ComponentTypeIconEnum = "PhSelectionBackground" // ComponentTypeIconEnumPhselectionforeground ComponentTypeIconEnum = "PhSelectionForeground" // ComponentTypeIconEnumPhselectioninverse ComponentTypeIconEnum = "PhSelectionInverse" // ComponentTypeIconEnumPhselectionplus ComponentTypeIconEnum = "PhSelectionPlus" // ComponentTypeIconEnumPhselectionslash ComponentTypeIconEnum = "PhSelectionSlash" // ComponentTypeIconEnumPhshield ComponentTypeIconEnum = "PhShield" // ComponentTypeIconEnumPhshieldcheck ComponentTypeIconEnum = "PhShieldCheck" // ComponentTypeIconEnumPhshieldcheckered ComponentTypeIconEnum = "PhShieldCheckered" // ComponentTypeIconEnumPhshieldchevron ComponentTypeIconEnum = "PhShieldChevron" // ComponentTypeIconEnumPhshieldplus ComponentTypeIconEnum = "PhShieldPlus" // ComponentTypeIconEnumPhshieldslash ComponentTypeIconEnum = "PhShieldSlash" // ComponentTypeIconEnumPhshieldstar ComponentTypeIconEnum = "PhShieldStar" // ComponentTypeIconEnumPhshieldwarning ComponentTypeIconEnum = "PhShieldWarning" // ComponentTypeIconEnumPhshoppingbag ComponentTypeIconEnum = "PhShoppingBag" // ComponentTypeIconEnumPhshoppingbagopen ComponentTypeIconEnum = "PhShoppingBagOpen" // ComponentTypeIconEnumPhshoppingcart ComponentTypeIconEnum = "PhShoppingCart" // ComponentTypeIconEnumPhshoppingcartsimple ComponentTypeIconEnum = "PhShoppingCartSimple" // ComponentTypeIconEnumPhshower ComponentTypeIconEnum = "PhShower" // ComponentTypeIconEnumPhshuffle ComponentTypeIconEnum = "PhShuffle" // ComponentTypeIconEnumPhshuffleangular ComponentTypeIconEnum = "PhShuffleAngular" // ComponentTypeIconEnumPhshufflesimple ComponentTypeIconEnum = "PhShuffleSimple" // ComponentTypeIconEnumPhsignin ComponentTypeIconEnum = "PhSignIn" // ComponentTypeIconEnumPhsignout ComponentTypeIconEnum = "PhSignOut" // ComponentTypeIconEnumPhsignpost ComponentTypeIconEnum = "PhSignpost" // ComponentTypeIconEnumPhsimcard ComponentTypeIconEnum = "PhSimCard" // ComponentTypeIconEnumPhsketchlogo ComponentTypeIconEnum = "PhSketchLogo" // ComponentTypeIconEnumPhskipback ComponentTypeIconEnum = "PhSkipBack" // ComponentTypeIconEnumPhskipbackcircle ComponentTypeIconEnum = "PhSkipBackCircle" // ComponentTypeIconEnumPhskipforward ComponentTypeIconEnum = "PhSkipForward" // ComponentTypeIconEnumPhskipforwardcircle ComponentTypeIconEnum = "PhSkipForwardCircle" // ComponentTypeIconEnumPhskull ComponentTypeIconEnum = "PhSkull" // ComponentTypeIconEnumPhslacklogo ComponentTypeIconEnum = "PhSlackLogo" // ComponentTypeIconEnumPhsliders ComponentTypeIconEnum = "PhSliders" // ComponentTypeIconEnumPhslidershorizontal ComponentTypeIconEnum = "PhSlidersHorizontal" // ComponentTypeIconEnumPhsmiley ComponentTypeIconEnum = "PhSmiley" // ComponentTypeIconEnumPhsmileyblank ComponentTypeIconEnum = "PhSmileyBlank" // ComponentTypeIconEnumPhsmileymeh ComponentTypeIconEnum = "PhSmileyMeh" // ComponentTypeIconEnumPhsmileynervous ComponentTypeIconEnum = "PhSmileyNervous" // ComponentTypeIconEnumPhsmileysad ComponentTypeIconEnum = "PhSmileySad" // ComponentTypeIconEnumPhsmileysticker ComponentTypeIconEnum = "PhSmileySticker" // ComponentTypeIconEnumPhsmileywink ComponentTypeIconEnum = "PhSmileyWink" // ComponentTypeIconEnumPhsmileyxeyes ComponentTypeIconEnum = "PhSmileyXEyes" // ComponentTypeIconEnumPhsnapchatlogo ComponentTypeIconEnum = "PhSnapchatLogo" // ComponentTypeIconEnumPhsnowflake ComponentTypeIconEnum = "PhSnowflake" // ComponentTypeIconEnumPhsoccerball ComponentTypeIconEnum = "PhSoccerBall" // ComponentTypeIconEnumPhsortascending ComponentTypeIconEnum = "PhSortAscending" // ComponentTypeIconEnumPhsortdescending ComponentTypeIconEnum = "PhSortDescending" // ComponentTypeIconEnumPhspade ComponentTypeIconEnum = "PhSpade" // ComponentTypeIconEnumPhsparkle ComponentTypeIconEnum = "PhSparkle" // ComponentTypeIconEnumPhspeakerhigh ComponentTypeIconEnum = "PhSpeakerHigh" // ComponentTypeIconEnumPhspeakerlow ComponentTypeIconEnum = "PhSpeakerLow" // ComponentTypeIconEnumPhspeakernone ComponentTypeIconEnum = "PhSpeakerNone" // ComponentTypeIconEnumPhspeakersimplehigh ComponentTypeIconEnum = "PhSpeakerSimpleHigh" // ComponentTypeIconEnumPhspeakersimplelow ComponentTypeIconEnum = "PhSpeakerSimpleLow" // ComponentTypeIconEnumPhspeakersimplenone ComponentTypeIconEnum = "PhSpeakerSimpleNone" // ComponentTypeIconEnumPhspeakersimpleslash ComponentTypeIconEnum = "PhSpeakerSimpleSlash" // ComponentTypeIconEnumPhspeakersimplex ComponentTypeIconEnum = "PhSpeakerSimpleX" // ComponentTypeIconEnumPhspeakerslash ComponentTypeIconEnum = "PhSpeakerSlash" // ComponentTypeIconEnumPhspeakerx ComponentTypeIconEnum = "PhSpeakerX" // ComponentTypeIconEnumPhspinner ComponentTypeIconEnum = "PhSpinner" // ComponentTypeIconEnumPhspinnergap ComponentTypeIconEnum = "PhSpinnerGap" // ComponentTypeIconEnumPhspiral ComponentTypeIconEnum = "PhSpiral" // ComponentTypeIconEnumPhspotifylogo ComponentTypeIconEnum = "PhSpotifyLogo" // ComponentTypeIconEnumPhsquare ComponentTypeIconEnum = "PhSquare" // ComponentTypeIconEnumPhsquarehalf ComponentTypeIconEnum = "PhSquareHalf" // ComponentTypeIconEnumPhsquarehalfbottom ComponentTypeIconEnum = "PhSquareHalfBottom" // ComponentTypeIconEnumPhsquarelogo ComponentTypeIconEnum = "PhSquareLogo" // ComponentTypeIconEnumPhsquaresfour ComponentTypeIconEnum = "PhSquaresFour" // ComponentTypeIconEnumPhstack ComponentTypeIconEnum = "PhStack" // ComponentTypeIconEnumPhstackoverflowlogo ComponentTypeIconEnum = "PhStackOverflowLogo" // ComponentTypeIconEnumPhstacksimple ComponentTypeIconEnum = "PhStackSimple" // ComponentTypeIconEnumPhstamp ComponentTypeIconEnum = "PhStamp" // ComponentTypeIconEnumPhstar ComponentTypeIconEnum = "PhStar" // ComponentTypeIconEnumPhstarfour ComponentTypeIconEnum = "PhStarFour" // ComponentTypeIconEnumPhstarhalf ComponentTypeIconEnum = "PhStarHalf" // ComponentTypeIconEnumPhsticker ComponentTypeIconEnum = "PhSticker" // ComponentTypeIconEnumPhstop ComponentTypeIconEnum = "PhStop" // ComponentTypeIconEnumPhstopcircle ComponentTypeIconEnum = "PhStopCircle" // ComponentTypeIconEnumPhstorefront ComponentTypeIconEnum = "PhStorefront" // ComponentTypeIconEnumPhstrategy ComponentTypeIconEnum = "PhStrategy" // ComponentTypeIconEnumPhstripelogo ComponentTypeIconEnum = "PhStripeLogo" // ComponentTypeIconEnumPhstudent ComponentTypeIconEnum = "PhStudent" // ComponentTypeIconEnumPhsuitcase ComponentTypeIconEnum = "PhSuitcase" // ComponentTypeIconEnumPhsuitcasesimple ComponentTypeIconEnum = "PhSuitcaseSimple" // ComponentTypeIconEnumPhsun ComponentTypeIconEnum = "PhSun" // ComponentTypeIconEnumPhsundim ComponentTypeIconEnum = "PhSunDim" // ComponentTypeIconEnumPhsunhorizon ComponentTypeIconEnum = "PhSunHorizon" // ComponentTypeIconEnumPhsunglasses ComponentTypeIconEnum = "PhSunglasses" // ComponentTypeIconEnumPhswap ComponentTypeIconEnum = "PhSwap" // ComponentTypeIconEnumPhswatches ComponentTypeIconEnum = "PhSwatches" // ComponentTypeIconEnumPhsword ComponentTypeIconEnum = "PhSword" // ComponentTypeIconEnumPhsyringe ComponentTypeIconEnum = "PhSyringe" // ComponentTypeIconEnumPhtshirt ComponentTypeIconEnum = "PhTShirt" // ComponentTypeIconEnumPhtable ComponentTypeIconEnum = "PhTable" // ComponentTypeIconEnumPhtabs ComponentTypeIconEnum = "PhTabs" // ComponentTypeIconEnumPhtag ComponentTypeIconEnum = "PhTag" // ComponentTypeIconEnumPhtagchevron ComponentTypeIconEnum = "PhTagChevron" // ComponentTypeIconEnumPhtarget ComponentTypeIconEnum = "PhTarget" // ComponentTypeIconEnumPhtaxi ComponentTypeIconEnum = "PhTaxi" // ComponentTypeIconEnumPhtelegramlogo ComponentTypeIconEnum = "PhTelegramLogo" // ComponentTypeIconEnumPhtelevision ComponentTypeIconEnum = "PhTelevision" // ComponentTypeIconEnumPhtelevisionsimple ComponentTypeIconEnum = "PhTelevisionSimple" // ComponentTypeIconEnumPhtennisball ComponentTypeIconEnum = "PhTennisBall" // ComponentTypeIconEnumPhterminal ComponentTypeIconEnum = "PhTerminal" // ComponentTypeIconEnumPhterminalwindow ComponentTypeIconEnum = "PhTerminalWindow" // ComponentTypeIconEnumPhtesttube ComponentTypeIconEnum = "PhTestTube" // ComponentTypeIconEnumPhtextaa ComponentTypeIconEnum = "PhTextAa" // ComponentTypeIconEnumPhtextaligncenter ComponentTypeIconEnum = "PhTextAlignCenter" // ComponentTypeIconEnumPhtextalignjustify ComponentTypeIconEnum = "PhTextAlignJustify" // ComponentTypeIconEnumPhtextalignleft ComponentTypeIconEnum = "PhTextAlignLeft" // ComponentTypeIconEnumPhtextalignright ComponentTypeIconEnum = "PhTextAlignRight" // ComponentTypeIconEnumPhtextbolder ComponentTypeIconEnum = "PhTextBolder" // ComponentTypeIconEnumPhtexth ComponentTypeIconEnum = "PhTextH" // ComponentTypeIconEnumPhtexthfive ComponentTypeIconEnum = "PhTextHFive" // ComponentTypeIconEnumPhtexthfour ComponentTypeIconEnum = "PhTextHFour" // ComponentTypeIconEnumPhtexthone ComponentTypeIconEnum = "PhTextHOne" // ComponentTypeIconEnumPhtexthsix ComponentTypeIconEnum = "PhTextHSix" // ComponentTypeIconEnumPhtexththree ComponentTypeIconEnum = "PhTextHThree" // ComponentTypeIconEnumPhtexthtwo ComponentTypeIconEnum = "PhTextHTwo" // ComponentTypeIconEnumPhtextindent ComponentTypeIconEnum = "PhTextIndent" // ComponentTypeIconEnumPhtextitalic ComponentTypeIconEnum = "PhTextItalic" // ComponentTypeIconEnumPhtextoutdent ComponentTypeIconEnum = "PhTextOutdent" // ComponentTypeIconEnumPhtextstrikethrough ComponentTypeIconEnum = "PhTextStrikethrough" // ComponentTypeIconEnumPhtextt ComponentTypeIconEnum = "PhTextT" // ComponentTypeIconEnumPhtextunderline ComponentTypeIconEnum = "PhTextUnderline" // ComponentTypeIconEnumPhtextbox ComponentTypeIconEnum = "PhTextbox" // ComponentTypeIconEnumPhthermometer ComponentTypeIconEnum = "PhThermometer" // ComponentTypeIconEnumPhthermometercold ComponentTypeIconEnum = "PhThermometerCold" // ComponentTypeIconEnumPhthermometerhot ComponentTypeIconEnum = "PhThermometerHot" // ComponentTypeIconEnumPhthermometersimple ComponentTypeIconEnum = "PhThermometerSimple" // ComponentTypeIconEnumPhthumbsdown ComponentTypeIconEnum = "PhThumbsDown" // ComponentTypeIconEnumPhthumbsup ComponentTypeIconEnum = "PhThumbsUp" // ComponentTypeIconEnumPhticket ComponentTypeIconEnum = "PhTicket" // ComponentTypeIconEnumPhtiktoklogo ComponentTypeIconEnum = "PhTiktokLogo" // ComponentTypeIconEnumPhtimer ComponentTypeIconEnum = "PhTimer" // ComponentTypeIconEnumPhtoggleleft ComponentTypeIconEnum = "PhToggleLeft" // ComponentTypeIconEnumPhtoggleright ComponentTypeIconEnum = "PhToggleRight" // ComponentTypeIconEnumPhtoilet ComponentTypeIconEnum = "PhToilet" // ComponentTypeIconEnumPhtoiletpaper ComponentTypeIconEnum = "PhToiletPaper" // ComponentTypeIconEnumPhtote ComponentTypeIconEnum = "PhTote" // ComponentTypeIconEnumPhtotesimple ComponentTypeIconEnum = "PhToteSimple" // ComponentTypeIconEnumPhtrademarkregistered ComponentTypeIconEnum = "PhTrademarkRegistered" // ComponentTypeIconEnumPhtrafficcone ComponentTypeIconEnum = "PhTrafficCone" // ComponentTypeIconEnumPhtrafficsign ComponentTypeIconEnum = "PhTrafficSign" // ComponentTypeIconEnumPhtrafficsignal ComponentTypeIconEnum = "PhTrafficSignal" // ComponentTypeIconEnumPhtrain ComponentTypeIconEnum = "PhTrain" // ComponentTypeIconEnumPhtrainregional ComponentTypeIconEnum = "PhTrainRegional" // ComponentTypeIconEnumPhtrainsimple ComponentTypeIconEnum = "PhTrainSimple" // ComponentTypeIconEnumPhtranslate ComponentTypeIconEnum = "PhTranslate" // ComponentTypeIconEnumPhtrash ComponentTypeIconEnum = "PhTrash" // ComponentTypeIconEnumPhtrashsimple ComponentTypeIconEnum = "PhTrashSimple" // ComponentTypeIconEnumPhtray ComponentTypeIconEnum = "PhTray" // ComponentTypeIconEnumPhtree ComponentTypeIconEnum = "PhTree" // ComponentTypeIconEnumPhtreeevergreen ComponentTypeIconEnum = "PhTreeEvergreen" // ComponentTypeIconEnumPhtreestructure ComponentTypeIconEnum = "PhTreeStructure" // ComponentTypeIconEnumPhtrenddown ComponentTypeIconEnum = "PhTrendDown" // ComponentTypeIconEnumPhtrendup ComponentTypeIconEnum = "PhTrendUp" // ComponentTypeIconEnumPhtriangle ComponentTypeIconEnum = "PhTriangle" // ComponentTypeIconEnumPhtrophy ComponentTypeIconEnum = "PhTrophy" // ComponentTypeIconEnumPhtruck ComponentTypeIconEnum = "PhTruck" // ComponentTypeIconEnumPhtwitchlogo ComponentTypeIconEnum = "PhTwitchLogo" // ComponentTypeIconEnumPhtwitterlogo ComponentTypeIconEnum = "PhTwitterLogo" // ComponentTypeIconEnumPhumbrella ComponentTypeIconEnum = "PhUmbrella" // ComponentTypeIconEnumPhumbrellasimple ComponentTypeIconEnum = "PhUmbrellaSimple" // ComponentTypeIconEnumPhupload ComponentTypeIconEnum = "PhUpload" // ComponentTypeIconEnumPhuploadsimple ComponentTypeIconEnum = "PhUploadSimple" // ComponentTypeIconEnumPhuser ComponentTypeIconEnum = "PhUser" // ComponentTypeIconEnumPhusercircle ComponentTypeIconEnum = "PhUserCircle" // ComponentTypeIconEnumPhusercirclegear ComponentTypeIconEnum = "PhUserCircleGear" // ComponentTypeIconEnumPhusercircleminus ComponentTypeIconEnum = "PhUserCircleMinus" // ComponentTypeIconEnumPhusercircleplus ComponentTypeIconEnum = "PhUserCirclePlus" // ComponentTypeIconEnumPhuserfocus ComponentTypeIconEnum = "PhUserFocus" // ComponentTypeIconEnumPhusergear ComponentTypeIconEnum = "PhUserGear" // ComponentTypeIconEnumPhuserlist ComponentTypeIconEnum = "PhUserList" // ComponentTypeIconEnumPhuserminus ComponentTypeIconEnum = "PhUserMinus" // ComponentTypeIconEnumPhuserplus ComponentTypeIconEnum = "PhUserPlus" // ComponentTypeIconEnumPhuserrectangle ComponentTypeIconEnum = "PhUserRectangle" // ComponentTypeIconEnumPhusersquare ComponentTypeIconEnum = "PhUserSquare" // ComponentTypeIconEnumPhuserswitch ComponentTypeIconEnum = "PhUserSwitch" // ComponentTypeIconEnumPhusers ComponentTypeIconEnum = "PhUsers" // ComponentTypeIconEnumPhusersfour ComponentTypeIconEnum = "PhUsersFour" // ComponentTypeIconEnumPhusersthree ComponentTypeIconEnum = "PhUsersThree" // ComponentTypeIconEnumPhvault ComponentTypeIconEnum = "PhVault" // ComponentTypeIconEnumPhvibrate ComponentTypeIconEnum = "PhVibrate" // ComponentTypeIconEnumPhvideocamera ComponentTypeIconEnum = "PhVideoCamera" // ComponentTypeIconEnumPhvideocameraslash ComponentTypeIconEnum = "PhVideoCameraSlash" // ComponentTypeIconEnumPhvignette ComponentTypeIconEnum = "PhVignette" // ComponentTypeIconEnumPhvoicemail ComponentTypeIconEnum = "PhVoicemail" // ComponentTypeIconEnumPhvolleyball ComponentTypeIconEnum = "PhVolleyball" // ComponentTypeIconEnumPhwall ComponentTypeIconEnum = "PhWall" // ComponentTypeIconEnumPhwallet ComponentTypeIconEnum = "PhWallet" // ComponentTypeIconEnumPhwarning ComponentTypeIconEnum = "PhWarning" // ComponentTypeIconEnumPhwarningcircle ComponentTypeIconEnum = "PhWarningCircle" // ComponentTypeIconEnumPhwarningoctagon ComponentTypeIconEnum = "PhWarningOctagon" // ComponentTypeIconEnumPhwatch ComponentTypeIconEnum = "PhWatch" // ComponentTypeIconEnumPhwavesawtooth ComponentTypeIconEnum = "PhWaveSawtooth" // ComponentTypeIconEnumPhwavesine ComponentTypeIconEnum = "PhWaveSine" // ComponentTypeIconEnumPhwavesquare ComponentTypeIconEnum = "PhWaveSquare" // ComponentTypeIconEnumPhwavetriangle ComponentTypeIconEnum = "PhWaveTriangle" // ComponentTypeIconEnumPhwaves ComponentTypeIconEnum = "PhWaves" // ComponentTypeIconEnumPhwebcam ComponentTypeIconEnum = "PhWebcam" // ComponentTypeIconEnumPhwhatsapplogo ComponentTypeIconEnum = "PhWhatsappLogo" // ComponentTypeIconEnumPhwheelchair ComponentTypeIconEnum = "PhWheelchair" // ComponentTypeIconEnumPhwifihigh ComponentTypeIconEnum = "PhWifiHigh" // ComponentTypeIconEnumPhwifilow ComponentTypeIconEnum = "PhWifiLow" // ComponentTypeIconEnumPhwifimedium ComponentTypeIconEnum = "PhWifiMedium" // ComponentTypeIconEnumPhwifinone ComponentTypeIconEnum = "PhWifiNone" // ComponentTypeIconEnumPhwifislash ComponentTypeIconEnum = "PhWifiSlash" // ComponentTypeIconEnumPhwifix ComponentTypeIconEnum = "PhWifiX" // ComponentTypeIconEnumPhwind ComponentTypeIconEnum = "PhWind" // ComponentTypeIconEnumPhwindowslogo ComponentTypeIconEnum = "PhWindowsLogo" // ComponentTypeIconEnumPhwine ComponentTypeIconEnum = "PhWine" // ComponentTypeIconEnumPhwrench ComponentTypeIconEnum = "PhWrench" // ComponentTypeIconEnumPhx ComponentTypeIconEnum = "PhX" // ComponentTypeIconEnumPhxcircle ComponentTypeIconEnum = "PhXCircle" // ComponentTypeIconEnumPhxsquare ComponentTypeIconEnum = "PhXSquare" // ComponentTypeIconEnumPhyinyang ComponentTypeIconEnum = "PhYinYang" // ComponentTypeIconEnumPhyoutubelogo ComponentTypeIconEnum = "PhYoutubeLogo" // )
type ComponentTypeIconInput ¶
type ComponentTypeIconInput struct {
Color string `json:"color" yaml:"color" example:"example_value"` // The color, represented as a hexcode, for the icon (Required)
Name ComponentTypeIconEnum `json:"name" yaml:"name" example:"PhActivity"` // The name of the icon in Phosphor icons for Vue, e.g. `PhBird`. See https://phosphoricons.com/ for a full list (Required)
}
ComponentTypeIconInput The input for defining a component type's icon
type ComponentTypeId ¶
type ComponentTypeId struct {
Id ID // The id of the component type.
Aliases []string // A list of human-friendly, unique identifiers of the component type.
}
ComponentTypeId Information about a particular component type
type ComponentTypeInput ¶
type ComponentTypeInput struct {
Alias *Nullable[string] `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The unique alias of the component type (Optional)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the component type (Optional)
Icon *ComponentTypeIconInput `json:"icon,omitempty" yaml:"icon,omitempty"` // The icon associated with the component type (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The unique name of the component type (Optional)
OwnerRelationship *OwnerRelationshipInput `json:"ownerRelationship,omitempty" yaml:"ownerRelationship,omitempty"` // The owner relationship for the component type (Optional)
Properties *[]ComponentTypePropertyDefinitionInput `json:"properties,omitempty" yaml:"properties,omitempty" example:"[]"` // A list of property definitions for the component type (Optional)
}
ComponentTypeInput Specifies the input fields used to create a component type
type ComponentTypePayload ¶
type ComponentTypePayload struct {
ComponentType ComponentType // The created component type (Optional)
BasePayload
}
ComponentTypePayload Return type for the `componentTypeCreate` mutation
type ComponentTypePropertyDefinitionInput ¶
type ComponentTypePropertyDefinitionInput struct {
Alias string `json:"alias" yaml:"alias" example:"example_value"` // The human-friendly, unique identifier for the resource (Required)
AllowedInConfigFiles bool `json:"allowedInConfigFiles" yaml:"allowedInConfigFiles" example:"false"` // Whether or not the property is allowed to be set in opslevel.yml config files (Required)
Description string `json:"description" yaml:"description" example:"example_value"` // The description of the property definition (Required)
LockedStatus *PropertyLockedStatusEnum `json:"lockedStatus,omitempty" yaml:"lockedStatus,omitempty" example:"ui_locked"` // Restricts what sources are able to assign values to this property (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The name of the property definition (Required)
PropertyDisplayStatus PropertyDisplayStatusEnum `json:"propertyDisplayStatus" yaml:"propertyDisplayStatus" example:"hidden"` // The UI display status of the custom property (Required)
Schema JSONSchema `json:"schema" yaml:"schema" example:"SCHEMA_TBD"` // The schema of the property definition (Required)
}
ComponentTypePropertyDefinitionInput The input for defining a property
type ComponentUpdateInput ¶
type ComponentUpdateInput ServiceUpdateInput
type ConfigError ¶
type ConfigError struct {
Message string // A description of the error (Optional)
SourceFilename string // The file name where the error was found (Required)
}
ConfigError An error that occurred when syncing an opslevel.yml file
type ConfigFile ¶
type ConfigFile struct {
OwnerType string // The relation for which the config was returned (Required)
Yaml string // The OpsLevel config in yaml format (Required)
}
ConfigFile An OpsLevel config as code definition
type ConnectionBase ¶
type ConnectionBase[T any] struct { Nodes []T // A list of nodes PageInfo PageInfo // Information to aid in pagination TotalCount int `graphql:"-"` // The number of returned nodes }
func (*ConnectionBase[T]) GetNodes ¶
func (s *ConnectionBase[T]) GetNodes() any
type ConnectiveEnum ¶
type ConnectiveEnum string
ConnectiveEnum The logical operator to be used in conjunction with multiple filters (requires filters to be supplied)
var ( ConnectiveEnumAnd ConnectiveEnum = "and" // Used to ensure **all** filters match for a given resource ConnectiveEnumOr ConnectiveEnum = "or" // Used to ensure **any** filters match for a given resource )
type Contact ¶
type Contact struct {
Address string // The contact address. Examples: support@company.com for type `email`, https://opslevel.com for type `web` (Required)
DisplayName string // The name shown in the UI for the contact (Optional)
DisplayType string // The type shown in the UI for the contact (Optional)
ExternalId string // The remote identifier of the contact method (Optional)
Id ID // The unique identifier for the contact (Required)
IsDefault bool // Indicates if this address is a team's default for the given type (Optional)
Type ContactType // The method of contact [email, slack, slack_handle, web, microsoft_teams] (Required)
}
Contact A method of contact for a team
type ContactCreateInput ¶
type ContactCreateInput struct {
Address string `json:"address" yaml:"address" example:"example_value"` // The contact address. Examples: support@company.com for type `email`, https://opslevel.com for type `web` (Required)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The name shown in the UI for the contact (Optional)
DisplayType *Nullable[string] `json:"displayType,omitempty" yaml:"displayType,omitempty" example:"example_value"` // The type shown in the UI for the contact (Optional)
ExternalId *Nullable[string] `json:"externalId,omitempty" yaml:"externalId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The remote identifier of the contact method (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner of this contact (Optional)
TeamAlias *Nullable[string] `json:"teamAlias,omitempty" yaml:"teamAlias,omitempty" example:"example_value"` // The alias of the team the contact belongs to (Optional)
TeamId *Nullable[ID] `json:"teamId,omitempty" yaml:"teamId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team the contact belongs to (Optional)
Type ContactType `json:"type" yaml:"type" example:"email"` // The method of contact [email, slack, slack_handle, web, microsoft_teams] (Required)
}
ContactCreateInput Specifies the input fields used to create a contact
type ContactCreatePayload ¶
type ContactCreatePayload struct {
Contact Contact // A method of contact for a team (Optional)
BasePayload
}
ContactCreatePayload The return type of a `contactCreate` mutation
type ContactDeleteInput ¶
type ContactDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The `id` of the contact you wish to delete (Required)
}
ContactDeleteInput Specifies the input fields used to delete a contact
type ContactInput ¶
type ContactInput struct {
Address string `json:"address" yaml:"address" example:"example_value"` // The contact address. Examples: support@company.com for type `email`, https://opslevel.com for type `web` (Required)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The name shown in the UI for the contact (Optional)
Type ContactType `json:"type" yaml:"type" example:"email"` // The method of contact [email, slack, slack_handle, web, microsoft_teams] (Required)
}
ContactInput Specifies the input fields used to create a contact
func CreateContactEmail ¶
func CreateContactEmail(email string, name *Nullable[string]) ContactInput
func CreateContactSlack ¶
func CreateContactSlack(channel string, name *Nullable[string]) ContactInput
func CreateContactSlackHandle ¶
func CreateContactSlackHandle(channel string, name *Nullable[string]) ContactInput
func CreateContactWeb ¶
func CreateContactWeb(address string, name *Nullable[string]) ContactInput
type ContactOwner ¶
type ContactOwner struct {
Team TeamId `graphql:"... on Team"`
User UserId `graphql:"... on User"`
}
ContactOwner represents the owner of this contact.
type ContactType ¶
type ContactType string
ContactType The method of contact
var ( ContactTypeEmail ContactType = "email" // An email contact method ContactTypeGitHub ContactType = "github" // A GitHub handle ContactTypeMicrosoftTeams ContactType = "microsoft_teams" // A Microsoft Teams channel ContactTypeSlack ContactType = "slack" // A Slack channel contact method ContactTypeSlackHandle ContactType = "slack_handle" // A Slack handle contact method ContactTypeWeb ContactType = "web" // A website contact method )
type ContactUpdateInput ¶
type ContactUpdateInput struct {
Address *Nullable[string] `json:"address,omitempty" yaml:"address,omitempty" example:"example_value"` // The contact address. Examples: support@company.com for type `email`, https://opslevel.com for type `web` (Optional)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The name shown in the UI for the contact (Optional)
DisplayType *Nullable[string] `json:"displayType,omitempty" yaml:"displayType,omitempty" example:"example_value"` // The type shown in the UI for the contact (Optional)
ExternalId *Nullable[string] `json:"externalId,omitempty" yaml:"externalId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The remote identifier of the contact method (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The unique identifier for the contact (Required)
MakeDefault *Nullable[bool] `json:"makeDefault,omitempty" yaml:"makeDefault,omitempty" example:"false"` // Makes the contact the default for the given type. Only available for team contacts (Optional)
Type *ContactType `json:"type,omitempty" yaml:"type,omitempty" example:"email"` // The method of contact [email, slack, slack_handle, web, microsoft_teams] (Optional)
}
ContactUpdateInput Specifies the input fields used to update a contact
type ContactUpdatePayload ¶
type ContactUpdatePayload struct {
Contact Contact // A method of contact for a team (Optional)
BasePayload
}
ContactUpdatePayload The return type of a `contactUpdate` mutation
type CustomActionsAssociatedObject ¶
type CustomActionsAssociatedObject struct {
Service Service `graphql:"... on Service"`
}
CustomActionsAssociatedObject represents the object that an event was triggered on.
type CustomActionsEntityTypeEnum ¶
type CustomActionsEntityTypeEnum string
CustomActionsEntityTypeEnum The entity types a custom action can be associated with
var ( CustomActionsEntityTypeEnumGlobal CustomActionsEntityTypeEnum = "GLOBAL" // A custom action associated with the global scope (no particular entity type) CustomActionsEntityTypeEnumService CustomActionsEntityTypeEnum = "SERVICE" // A custom action associated with services )
type CustomActionsExternalAction ¶
type CustomActionsExternalAction struct {
CustomActionsId
Description string `graphql:"description"` // A description of what the action should accomplish.
LiquidTemplate string `graphql:"liquidTemplate"` // The liquid template used to generate the data sent to the external action.
Name string `graphql:"name"` // The name of the external action.
CustomActionsWebhookAction `graphql:"... on CustomActionsWebhookAction"`
}
CustomActionsExternalAction represents an external action to be triggered by a custom action.
type CustomActionsExternalActionsConnection ¶
type CustomActionsExternalActionsConnection ConnectionBase[CustomActionsExternalAction]
CustomActionsExternalActionsConnection The connection type for CustomActionsExternalAction
type CustomActionsHttpMethodEnum ¶
type CustomActionsHttpMethodEnum string
CustomActionsHttpMethodEnum An HTTP request method
var ( CustomActionsHttpMethodEnumDelete CustomActionsHttpMethodEnum = "DELETE" // An HTTP DELETE request CustomActionsHttpMethodEnumGet CustomActionsHttpMethodEnum = "GET" // An HTTP GET request CustomActionsHttpMethodEnumPatch CustomActionsHttpMethodEnum = "PATCH" // An HTTP PATCH request CustomActionsHttpMethodEnumPost CustomActionsHttpMethodEnum = "POST" // An HTTP POST request CustomActionsHttpMethodEnumPut CustomActionsHttpMethodEnum = "PUT" // An HTTP PUT request )
type CustomActionsId ¶
type CustomActionsTemplate ¶
type CustomActionsTemplate struct {
Action CustomActionsTemplatesAction // The template's action (Required)
Metadata CustomActionsTemplatesMetadata // The template's metadata (Required)
TriggerDefinition CustomActionsTemplatesTriggerDefinition // The template's trigger definition (Required)
}
CustomActionsTemplate Template of a custom action
type CustomActionsTemplatesAction ¶
type CustomActionsTemplatesAction struct {
Description string // A description of what the action should accomplish (Optional)
Headers JSON `scalar:"true"` // The headers sent along with the webhook, if any (Optional)
HttpMethod CustomActionsHttpMethodEnum // The HTTP Method used to call the webhook action (Required)
LiquidTemplate string // The liquid template used to generate the data sent to the external action (Optional)
Name string // The name of the external action (Required)
Url string // The URL of the webhook action (Required)
}
CustomActionsTemplatesAction The action of a custom action template
type CustomActionsTemplatesMetadata ¶
type CustomActionsTemplatesMetadata struct {
Categories []string // The categories for the custom action template (Required)
Description string // The description of the custom action template (Optional)
Icon string // The icon for the custom action template (Optional)
Name string // The name of the custom action template (Required)
}
CustomActionsTemplatesMetadata The metadata about the custom action template
type CustomActionsTemplatesTriggerDefinition ¶
type CustomActionsTemplatesTriggerDefinition struct {
AccessControl CustomActionsTriggerDefinitionAccessControlEnum // The set of users that should be able to use the trigger definition (Required)
Description string // The description of what the trigger definition will do, supports Markdown (Optional)
ManualInputsDefinition string // The YAML definition of any custom inputs for this trigger definition (Optional)
Name string // The name of the trigger definition (Required)
Published bool // The published state of the action; true if the definition is ready for use; false if it is a draft (Required)
ResponseTemplate string // The liquid template used to parse the response from the External Action (Optional)
}
CustomActionsTemplatesTriggerDefinition The definition of a potential trigger for a template custom action
type CustomActionsTriggerDefinition ¶
type CustomActionsTriggerDefinition struct {
AccessControl CustomActionsTriggerDefinitionAccessControlEnum // The set of users that should be able to use the trigger definition (Required)
Action CustomActionsId // The action that would be triggered (Required)
Aliases []string // Any aliases for this trigger definition (Required)
ApprovalConfig ApprovalConfig // Configuration defining conditions of approval if it is required (Required)
Description string // The description of what the trigger definition will do, supports Markdown (Optional)
EntityType CustomActionsEntityTypeEnum // The entity type associated with this trigger definition (Required)
Filter FilterId // A filter defining which services this trigger definition applies to, if present (Optional)
Id ID // The ID of the trigger definition (Required)
ManualInputsDefinition string // The YAML definition of any custom inputs for this trigger definition (Optional)
Name string // The name of the trigger definition (Required)
Owner TeamId // The owner of the trigger definition (Optional)
Published bool // The published state of the action; true if the definition is ready for use; false if it is a draft (Required)
ResponseTemplate string // The liquid template used to parse the response from the External Action (Optional)
Timestamps Timestamps // Relevant timestamps (Required)
}
CustomActionsTriggerDefinition The definition of a potential trigger for a custom action
func (*CustomActionsTriggerDefinition) ExtendedTeamAccess ¶
func (customActionsTriggerDefinition *CustomActionsTriggerDefinition) ExtendedTeamAccess(client *Client, variables *PayloadVariables) (*TeamConnection, error)
type CustomActionsTriggerDefinitionAccessControlEnum ¶
type CustomActionsTriggerDefinitionAccessControlEnum string
CustomActionsTriggerDefinitionAccessControlEnum Who can see and use the trigger definition
var ( CustomActionsTriggerDefinitionAccessControlEnumAdmins CustomActionsTriggerDefinitionAccessControlEnum = "admins" // Admin users CustomActionsTriggerDefinitionAccessControlEnumEveryone CustomActionsTriggerDefinitionAccessControlEnum = "everyone" // All users of OpsLevel CustomActionsTriggerDefinitionAccessControlEnumServiceOwners CustomActionsTriggerDefinitionAccessControlEnum = "service_owners" // The owners of a service )
type CustomActionsTriggerDefinitionBase ¶
type CustomActionsTriggerDefinitionBase struct {
AccessControl string `graphql:"accessControl"` // The set of users that should be able to use the trigger definition.
Description string `graphql:"description"` // The description of what the trigger definition will do, supports Markdown.
ManualInputsDefinition string `graphql:"manualInputsDefinition"` // The YAML definition of any custom inputs for this trigger definition.
Name string `graphql:"name"` // The name of the trigger definition.
Published bool `graphql:"published"` // The published state of the action; true if the definition is ready for use; false if it is a draft.
ResponseTemplate string `graphql:"responseTemplate"` // The liquid template used to parse the response from the External Action.
}
CustomActionsTriggerDefinitionBase represents .
type CustomActionsTriggerDefinitionConnection ¶
type CustomActionsTriggerDefinitionConnection ConnectionBase[CustomActionsTriggerDefinition]
CustomActionsTriggerDefinitionConnection The connection type for CustomActionsTriggerDefinition
type CustomActionsTriggerDefinitionCreateInput ¶
type CustomActionsTriggerDefinitionCreateInput struct {
AccessControl *CustomActionsTriggerDefinitionAccessControlEnum `json:"accessControl,omitempty" yaml:"accessControl,omitempty" example:"admins"` // The set of users that should be able to use the trigger definition (Optional)
ActionId *Nullable[ID] `json:"actionId,omitempty" yaml:"actionId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The action that will be triggered by the Trigger Definition (Optional)
ApprovalConfig *ApprovalConfigInput `json:"approvalConfig,omitempty" yaml:"approvalConfig,omitempty"` // Config for approval of action (Optional)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of what the Trigger Definition will do, supports Markdown (Optional)
ExtendedTeamAccess *[]IdentifierInput `json:"extendedTeamAccess,omitempty" yaml:"extendedTeamAccess,omitempty" example:"[]"` // The set of additional teams who can invoke this Trigger Definition (Optional)
EntityType *CustomActionsEntityTypeEnum `json:"entityType,omitempty" yaml:"entityType,omitempty" example:"GLOBAL"` // The entity type to associate with the Trigger Definition (Optional Default: SERVICE)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The filter that will determine which services apply to the Trigger Definition (Optional)
ManualInputsDefinition *Nullable[string] `json:"manualInputsDefinition,omitempty" yaml:"manualInputsDefinition,omitempty" example:"example_value"` // The YAML definition of custom inputs for the Trigger Definition (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The name of the Trigger Definition (Required)
OwnerId ID `json:"ownerId" yaml:"ownerId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The owner of the Trigger Definition (Required)
Published *Nullable[bool] `json:"published,omitempty" yaml:"published,omitempty" example:"false"` // The published state of the action; true if the definition is ready for use; false if it is a draft (Optional)
ResponseTemplate *Nullable[string] `json:"responseTemplate,omitempty" yaml:"responseTemplate,omitempty" example:"example_value"` // The liquid template used to parse the response from the External Action (Optional)
}
CustomActionsTriggerDefinitionCreateInput Specifies the input fields used in the `customActionsTriggerDefinitionCreate` mutation
type CustomActionsTriggerDefinitionCreatePayload ¶
type CustomActionsTriggerDefinitionCreatePayload struct {
TriggerDefinition CustomActionsTriggerDefinition // The definition of a potential trigger for a custom action (Optional)
BasePayload
}
CustomActionsTriggerDefinitionCreatePayload Return type for the `customActionsTriggerDefinitionCreate` mutation
type CustomActionsTriggerDefinitionUpdateInput ¶
type CustomActionsTriggerDefinitionUpdateInput struct {
AccessControl *CustomActionsTriggerDefinitionAccessControlEnum `json:"accessControl,omitempty" yaml:"accessControl,omitempty" example:"admins"` // The set of users that should be able to use the trigger definition (Optional)
Action *CustomActionsWebhookActionUpdateInput `json:"action,omitempty" yaml:"action,omitempty"` // The details for the action to update for the Trigger Definition (Optional)
ActionId *Nullable[ID] `json:"actionId,omitempty" yaml:"actionId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The action that will be triggered by the Trigger Definition (Optional)
ApprovalConfig *ApprovalConfigInput `json:"approvalConfig,omitempty" yaml:"approvalConfig,omitempty"` // Config for approval of action (Optional)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of what the Trigger Definition will do, support Markdown (Optional)
ExtendedTeamAccess *[]IdentifierInput `json:"extendedTeamAccess,omitempty" yaml:"extendedTeamAccess,omitempty" example:"[]"` // The set of additional teams who can invoke this Trigger Definition (Optional)
EntityType *CustomActionsEntityTypeEnum `json:"entityType,omitempty" yaml:"entityType,omitempty" example:"GLOBAL"` // The entity type to associate with the Trigger Definition (Optional Default: SERVICE)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The filter that will determine which services apply to the Trigger Definition (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the trigger definition (Required)
ManualInputsDefinition *Nullable[string] `json:"manualInputsDefinition,omitempty" yaml:"manualInputsDefinition,omitempty" example:"example_value"` // The YAML definition of custom inputs for the Trigger Definition (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the Trigger Definition (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The owner of the Trigger Definition (Optional)
Published *Nullable[bool] `json:"published,omitempty" yaml:"published,omitempty" example:"false"` // The published state of the action; true if the definition is ready for use; false if it is a draft (Optional)
ResponseTemplate *Nullable[string] `json:"responseTemplate,omitempty" yaml:"responseTemplate,omitempty" example:"example_value"` // The liquid template used to parse the response from the External Action (Optional)
}
CustomActionsTriggerDefinitionUpdateInput Specifies the input fields used in the `customActionsTriggerDefinitionUpdate` mutation
type CustomActionsTriggerDefinitionUpdatePayload ¶
type CustomActionsTriggerDefinitionUpdatePayload struct {
TriggerDefinition CustomActionsTriggerDefinition // The definition of a potential trigger for a custom action (Optional)
BasePayload
}
CustomActionsTriggerDefinitionUpdatePayload Return type for the `customActionsTriggerDefinitionUpdate` mutation
type CustomActionsTriggerDefinitionsConnection ¶
type CustomActionsTriggerDefinitionsConnection struct {
Nodes []CustomActionsTriggerDefinition
PageInfo PageInfo
TotalCount int `graphql:"-"`
}
func (*CustomActionsTriggerDefinitionsConnection) GetNodes ¶
func (s *CustomActionsTriggerDefinitionsConnection) GetNodes() any
type CustomActionsTriggerEventStatusEnum ¶
type CustomActionsTriggerEventStatusEnum string
CustomActionsTriggerEventStatusEnum The status of the custom action trigger event
var ( CustomActionsTriggerEventStatusEnumFailure CustomActionsTriggerEventStatusEnum = "FAILURE" // The action failed to complete CustomActionsTriggerEventStatusEnumPending CustomActionsTriggerEventStatusEnum = "PENDING" // A result has not been determined CustomActionsTriggerEventStatusEnumPendingApproval CustomActionsTriggerEventStatusEnum = "PENDING_APPROVAL" // The action is waiting for an approval before it executes CustomActionsTriggerEventStatusEnumSuccess CustomActionsTriggerEventStatusEnum = "SUCCESS" // The action completed successfully )
type CustomActionsTriggerInvokeInput ¶
type CustomActionsTriggerInvokeInput struct {
ManualInputs JSON `` // Additional details provided for a specific invocation of this Custom Action (Optional Default: "{}")
/* 175-byte string literal not displayed */
TargetObject *IdentifierInput `json:"targetObject,omitempty" yaml:"targetObject,omitempty"` // The identifier of the object to perform the custom action on (Optional)
TriggerDefinition IdentifierInput `json:"triggerDefinition" yaml:"triggerDefinition"` // The trigger definition to invoke (Required)
}
CustomActionsTriggerInvokeInput Inputs that specify the trigger definition to invoke, the user that invoked it, and what object it is invoked on
type CustomActionsWebhookAction ¶
type CustomActionsWebhookAction struct {
Aliases []string // Any aliases for this external action (Required)
Async bool // Whether the action expects an additional, asynchronous response upon completion (Required)
Description string // A description of what the action should accomplish (Optional)
Headers JSON `scalar:"true"` // The headers sent along with the webhook, if any (Optional)
HttpMethod CustomActionsHttpMethodEnum // The HTTP Method used to call the webhook action (Required)
Id ID // The ID of the external action (Required)
LiquidTemplate string // The liquid template used to generate the data sent to the external action (Optional)
Name string // The name of the external action (Required)
WebhookUrl string // The URL of the webhook action (Required)
}
CustomActionsWebhookAction An external webhook action to be triggered by a custom action
type CustomActionsWebhookActionCreateInput ¶
type CustomActionsWebhookActionCreateInput struct {
Async *bool `json:"async,omitempty" yaml:"async,omitempty" example:"false"` // Whether the action expects an additional, asynchronous response upon completion (Required Default: false)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description that gets assigned to the Webhook Action you're creating (Optional)
Headers *JSON `` // HTTP headers be passed along with your Webhook when triggered (Optional)
/* 165-byte string literal not displayed */
HttpMethod CustomActionsHttpMethodEnum `json:"httpMethod" yaml:"httpMethod" example:"DELETE"` // HTTP used when the Webhook is triggered. Either POST or PUT (Required)
LiquidTemplate *Nullable[string] `json:"liquidTemplate,omitempty" yaml:"liquidTemplate,omitempty" example:"example_value"` // Template that can be used to generate a Webhook payload (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The name that gets assigned to the Webhook Action you're creating (Required)
WebhookUrl string `json:"webhookUrl" yaml:"webhookUrl" example:"example_value"` // The URL that you wish to send the Webhook to when triggered (Required)
}
CustomActionsWebhookActionCreateInput Specifies the input fields used in the `customActionsWebhookActionCreate` mutation
type CustomActionsWebhookActionCreatePayload ¶
type CustomActionsWebhookActionCreatePayload struct {
WebhookAction CustomActionsWebhookAction // An external webhook action to be triggered by a custom action (Optional)
BasePayload
}
CustomActionsWebhookActionCreatePayload Return type for the `customActionsWebhookActionCreate` mutation
type CustomActionsWebhookActionUpdateInput ¶
type CustomActionsWebhookActionUpdateInput struct {
Async *bool `json:"async,omitempty" yaml:"async,omitempty" example:"false"` // Whether the action expects an additional, asynchronous response upon completion (Optional)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description that gets assigned to the Webhook Action you're creating (Optional)
Headers *JSON `` // HTTP headers be passed along with your Webhook when triggered (Optional)
/* 165-byte string literal not displayed */
HttpMethod *CustomActionsHttpMethodEnum `json:"httpMethod,omitempty" yaml:"httpMethod,omitempty" example:"DELETE"` // HTTP used when the Webhook is triggered. Either POST or PUT (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the Webhook Action you wish to update (Required)
LiquidTemplate *Nullable[string] `json:"liquidTemplate,omitempty" yaml:"liquidTemplate,omitempty" example:"example_value"` // Template that can be used to generate a Webhook payload (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name that gets assigned to the Webhook Action you're creating (Optional)
WebhookUrl *Nullable[string] `json:"webhookUrl,omitempty" yaml:"webhookUrl,omitempty" example:"example_value"` // The URL that you wish to send the Webhook too when triggered (Optional)
}
CustomActionsWebhookActionUpdateInput Inputs that specify the details of a Webhook Action you wish to update
type CustomActionsWebhookActionUpdatePayload ¶
type CustomActionsWebhookActionUpdatePayload struct {
WebhookAction CustomActionsWebhookAction // An external webhook action to be triggered by a custom action (Optional)
BasePayload
}
CustomActionsWebhookActionUpdatePayload The response returned after updating a Webhook Action
type CustomEventCheckFragment ¶
type CustomEventCheckFragment struct {
Integration IntegrationId `graphql:"integration"` // The integration this check uses.
PassPending bool `graphql:"passPending"` // True if this check should pass by default. Otherwise the default 'pending' state counts as a failure.
ResultMessage string `graphql:"resultMessage"` // The check result message template.
ServiceSelector string `graphql:"serviceSelector"` // A jq expression that will be ran against your payload to select the service.
SuccessCondition string `graphql:"successCondition"` // A jq expression that will be ran against your payload to evaluate the check result. A truthy value will result in the check passing.
}
type CustomIntegrationInput ¶
type CustomIntegrationInput struct {
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // Name of the custom integration type (Optional)
}
CustomIntegrationInput Input for upserting a custom integration
type DayOfWeekEnum ¶
type DayOfWeekEnum string
DayOfWeekEnum Possible days of the week
var ( DayOfWeekEnumFriday DayOfWeekEnum = "friday" // Yesterday was Thursday. Tomorrow is Saturday. We so excited DayOfWeekEnumMonday DayOfWeekEnum = "monday" // Monday is the day of the week that takes place between Sunday and Tuesday DayOfWeekEnumSaturday DayOfWeekEnum = "saturday" // The day of the week before Sunday and following Friday, and (together with Sunday) forming part of the weekend DayOfWeekEnumSunday DayOfWeekEnum = "sunday" // The day of the week before Monday and following Saturday, (together with Saturday) forming part of the weekend DayOfWeekEnumThursday DayOfWeekEnum = "thursday" // The day of the week before Friday and following Wednesday DayOfWeekEnumTuesday DayOfWeekEnum = "tuesday" // Tuesday is the day of the week between Monday and Wednesday DayOfWeekEnumWednesday DayOfWeekEnum = "wednesday" // The day of the week before Thursday and following Tuesday )
type DeleteInput ¶
type DeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the entity to be deleted (Required)
}
DeleteInput Specifies the input fields used to delete an entity
type Deploy ¶
type Deploy struct {
AssociatedUser UserId // The associated OpsLevel user for the deploy (Optional)
Author string // The author of the deploy (Optional)
CommitAuthorEmail string // The email of the commit (Optional)
CommitAuthorName string // The author of the commit (Optional)
CommitAuthoringDate iso8601.Time // The time the commit was authored (Optional)
CommitBranch string // The branch the commit took place on (Optional)
CommitMessage string // The commit message associated with the deploy (Optional)
CommitSha string // The sha associated with the commit of the deploy (Optional)
CommittedAt iso8601.Time // The time the commit happened (Optional)
CommitterEmail string // The email of the person who created the commit (Optional)
CommitterName string // The name of the person who created the commit (Optional)
DedupId string // The deduplication ID provided to prevent duplicate deploys (Optional)
DeployNumber string // An identifier to keep track of the version of the deploy (Optional)
DeployStatus DeployStatusEnum // The normalized status of the deploy. This is derived from the status field (Optional)
DeployUrl string // The url the where the deployment can be found (Optional)
DeployedAt iso8601.Time // The time the deployment happened (Optional)
DeployerEmail string // The email of who is responsible for the deployment (Optional)
DeployerId string // An external id of who deployed (Optional)
DeployerName string // The name of who is responsible for the deployment (Optional)
Description string // The given description of the deploy (Required)
Duration int // The duration of the deploy (Optional)
Environment string // The environment in which the deployment happened in (Optional)
Id ID // The id of the deploy (Required)
ProviderName string // The integration name of the deploy (Optional)
ProviderType string // The integration type used the deploy (Optional)
ProviderUrl string // The url to the deploy integration (Optional)
Service ServiceId // The service object the deploy is attached to (Optional)
ServiceAlias string // The alias used to associated this deploy to its service (Required)
ServiceId string // The id the deploy is associated to (Optional)
StartedAt iso8601.Time // The time the deploy started (Optional)
Status string // The deployment status (Optional)
}
Deploy An event sent via webhook to track deploys
type DeployConnection ¶
type DeployConnection ConnectionBase[Deploy]
DeployConnection The connection type for Deploy
type DeployStatusEnum ¶
type DeployStatusEnum string
DeployStatusEnum The possible statuses of a deploy
var ( DeployStatusEnumCanceled DeployStatusEnum = "canceled" // The deploy was canceled DeployStatusEnumFailure DeployStatusEnum = "failure" // The deploy failed DeployStatusEnumNoStatus DeployStatusEnum = "no_status" // The deploy has no recognized status DeployStatusEnumQueued DeployStatusEnum = "queued" // The deploy is queued DeployStatusEnumRunning DeployStatusEnum = "running" // The deploy is currently running DeployStatusEnumSuccess DeployStatusEnum = "success" // The deploy was successful )
type Document ¶
type Document struct {
Content string // The contents of the document (Optional)
HtmlUrl string // The URL of the document, if any (Optional)
Id ID // The ID of the Document (Required)
Source DocumentSource // The source of the document (Required)
Timestamps Timestamps // When the document was created and updated (Required)
}
Document A document that is attached to resource(s) in OpsLevel
type DocumentSource ¶
type DocumentSource struct {
Repository RepositoryId `graphql:"... on Repository"`
Service ServiceId `graphql:"... on Service"`
ServiceRepository ServiceRepository `graphql:"... on ServiceRepository"`
}
DocumentSource
type Domain ¶
type Domain struct {
DomainId
Description string // The description of the Domain (Optional)
HtmlUrl string // A link to the HTML page for the resource. Ex. https://app.opslevel.com/services/shopping_cart (Required)
ManagedAliases []string // A list of aliases that can be set by users. The unique identifier for the resource is omitted (Required)
Name string // The name of the object (Required)
Note string // Additional information about the domain (Optional)
Owner EntityOwner // The owner of the object (Optional)
}
Domain A collection of related Systems
func (*Domain) ReconcileAliases ¶
func (*Domain) UniqueIdentifiers ¶
Returns unique identifiers created by OpsLevel, values in Aliases but not ManagedAliases
type DomainChildAssignPayload ¶
type DomainChildAssignPayload struct {
Domain Domain // The domain after children have been assigned (Optional)
BasePayload
}
DomainChildAssignPayload Return type for the `domainChildAssign` mutation
type DomainChildRemovePayload ¶
type DomainChildRemovePayload struct {
Domain Domain // The domain after children have been removed (Optional)
BasePayload
}
DomainChildRemovePayload Return type for the `domainChildRemove` mutation
type DomainConnection ¶
type DomainConnection ConnectionBase[Domain]
DomainConnection The connection type for Domain
type DomainId ¶
type DomainId struct {
Id ID // The identifier of the object.
Aliases []string // All of the aliases attached to the resource.
}
DomainId A collection of related Systems
func (*DomainId) AliasableType ¶
func (DomainId *DomainId) AliasableType() AliasOwnerTypeEnum
func (*DomainId) AssignSystem ¶
func (*DomainId) ChildSystems ¶
func (domainId *DomainId) ChildSystems(client *Client, variables *PayloadVariables) (*SystemConnection, error)
func (*DomainId) GetAliases ¶
func (*DomainId) GetTags ¶
func (domainId *DomainId) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
func (*DomainId) ResourceId ¶
func (*DomainId) ResourceType ¶
func (domainId *DomainId) ResourceType() TaggableResource
type DomainInput ¶
type DomainInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description for the domain (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name for the domain (Optional)
Note *Nullable[string] `json:"note,omitempty" yaml:"note,omitempty" example:"example_value"` // Additional information about the domain (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner for the domain (Optional)
}
DomainInput Specifies the input fields for a domain
type DomainPayload ¶
type DomainPayload struct {
Domain Domain // A collection of related Systems (Optional)
BasePayload
}
DomainPayload Return type for `domainCreate` and `domainUpdate` mutations
type EntityOwner ¶
type EntityOwner struct {
OnTeam EntityOwnerTeam `graphql:"... on Team"`
}
EntityOwner represents the Group or Team owning the entity.
func (*EntityOwner) Alias ¶
func (entityOwner *EntityOwner) Alias() string
func (*EntityOwner) Id ¶
func (entityOwner *EntityOwner) Id() ID
type EntityOwnerService ¶
type EntityOwnerService struct {
OnService ServiceId `graphql:"... on Service"`
}
func (*EntityOwnerService) Aliases ¶
func (entityOwnerService *EntityOwnerService) Aliases() []string
func (*EntityOwnerService) Id ¶
func (entityOwnerService *EntityOwnerService) Id() ID
type EntityOwnerTeam ¶
type EntityOwnerTeam struct {
Alias string `json:"alias,omitempty" graphql:"teamAlias:alias"`
Id ID `json:"id"`
}
func (*EntityOwnerTeam) AsTeam ¶
func (entityOwnerTeam *EntityOwnerTeam) AsTeam() TeamId
type Error ¶
type Error struct {
Message string // The error message (Required)
Path []string // The path to the input field with an error (Required)
}
Error The input error of a mutation
type EventIntegrationEnum ¶
type EventIntegrationEnum string
EventIntegrationEnum The type of event integration
var ( EventIntegrationEnumApidoc EventIntegrationEnum = "apiDoc" // API Documentation integration EventIntegrationEnumAquasecurity EventIntegrationEnum = "aquaSecurity" // Aqua Security Custom Event Check integration EventIntegrationEnumArgocd EventIntegrationEnum = "argocd" // ArgoCD deploy integration EventIntegrationEnumAwsecr EventIntegrationEnum = "awsEcr" // AWS ECR Custom Event Check integration EventIntegrationEnumBugsnag EventIntegrationEnum = "bugsnag" // Bugsnag Custom Event Check integration EventIntegrationEnumCircleci EventIntegrationEnum = "circleci" // CircleCI deploy integration EventIntegrationEnumCodacy EventIntegrationEnum = "codacy" // Codacy Custom Event Check integration EventIntegrationEnumCoveralls EventIntegrationEnum = "coveralls" // Coveralls Custom Event Check integration EventIntegrationEnumCustomevent EventIntegrationEnum = "customEvent" // Custom Event integration EventIntegrationEnumDatadogcheck EventIntegrationEnum = "datadogCheck" // Datadog Check integration EventIntegrationEnumDeploy EventIntegrationEnum = "deploy" // Deploy integration EventIntegrationEnumDynatrace EventIntegrationEnum = "dynatrace" // Dynatrace Custom Event Check integration EventIntegrationEnumFlux EventIntegrationEnum = "flux" // Flux deploy integration EventIntegrationEnumGithubactions EventIntegrationEnum = "githubActions" // Github Actions deploy integration EventIntegrationEnumGitlabci EventIntegrationEnum = "gitlabCi" // Gitlab CI deploy integration EventIntegrationEnumGrafana EventIntegrationEnum = "grafana" // Grafana Custom Event Check integration EventIntegrationEnumGrype EventIntegrationEnum = "grype" // Grype Custom Event Check integration EventIntegrationEnumJenkins EventIntegrationEnum = "jenkins" // Jenkins deploy integration EventIntegrationEnumJfrogxray EventIntegrationEnum = "jfrogXray" // JFrog Xray Custom Event Check integration EventIntegrationEnumLacework EventIntegrationEnum = "lacework" // Lacework Custom Event Check integration EventIntegrationEnumNewreliccheck EventIntegrationEnum = "newRelicCheck" // New Relic Check integration EventIntegrationEnumOctopus EventIntegrationEnum = "octopus" // Octopus deploy integration EventIntegrationEnumPrismacloud EventIntegrationEnum = "prismaCloud" // Prisma Cloud Custom Event Check integration EventIntegrationEnumPrometheus EventIntegrationEnum = "prometheus" // Prometheus Custom Event Check integration EventIntegrationEnumRollbar EventIntegrationEnum = "rollbar" // Rollbar Custom Event Check integration EventIntegrationEnumSentry EventIntegrationEnum = "sentry" // Sentry Custom Event Check integration EventIntegrationEnumSnyk EventIntegrationEnum = "snyk" // Snyk Custom Event Check integration EventIntegrationEnumSonarqube EventIntegrationEnum = "sonarqube" // SonarQube Custom Event Check integration EventIntegrationEnumStackhawk EventIntegrationEnum = "stackhawk" // StackHawk Custom Event Check integration EventIntegrationEnumSumologic EventIntegrationEnum = "sumoLogic" // Sumo Logic Custom Event Check integration EventIntegrationEnumVeracode EventIntegrationEnum = "veracode" // Veracode Custom Event Check integration )
type EventIntegrationInput ¶
type EventIntegrationInput struct {
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the event integration (Optional)
Type EventIntegrationEnum `json:"type" yaml:"type" example:"apiDoc"` // The type of event integration to create (Required)
}
EventIntegrationInput
type EventIntegrationUpdateInput ¶
type EventIntegrationUpdateInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the event integration to update (Required)
Name string `json:"name" yaml:"name" example:"example_value"` // The name of the event integration (Required)
}
EventIntegrationUpdateInput
type ExportConfigFilePayload ¶
type ExportConfigFilePayload struct {
Kind string // The GraphQL type that represents the exported object (Optional)
Yaml string // The YAML representation of the object (Optional)
BasePayload
}
ExportConfigFilePayload The result of exporting an object as YAML
type ExternalResourceIdentifierInput ¶
type ExternalResourceIdentifierInput struct {
ExternalId string `json:"externalId" yaml:"externalId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the resource in your system (Required)
Integration IdentifierInput `json:"integration" yaml:"integration"` // The integration identifier (Required)
}
ExternalResourceIdentifierInput Specifies the input fields to locate resouce created via API in OpsLevel
type ExternalUuidMutationInput ¶
type ExternalUuidMutationInput struct {
ResourceId ID `json:"resourceId" yaml:"resourceId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the resource (Required)
}
ExternalUuidMutationInput Specifies the input used for modifying a resource's external UUID
type ExternalUuidMutationPayload ¶
type ExternalUuidMutationPayload struct {
ExternalUuid string // The updated external UUID of the resource (Optional)
BasePayload
}
ExternalUuidMutationPayload Return type for the external UUID mutations
type Filter ¶
type Filter struct {
FilterId
Connective ConnectiveEnum // The logical operator to be used in conjunction with predicates (Optional)
HtmlUrl string // A link to the HTML page for the resource. Ex. https://app.opslevel.com/services/shopping_cart (Required)
Predicates []FilterPredicate // The predicates used to select services (Required)
}
Filter A filter is used to select which services will have checks applied. It can also be used to filter services in reports
type FilterConnection ¶
type FilterConnection ConnectionBase[Filter]
FilterConnection The connection type for Filter
type FilterCreateInput ¶
type FilterCreateInput struct {
Connective *ConnectiveEnum `json:"connective,omitempty" yaml:"connective,omitempty" example:"and"` // The logical operator to be used in conjunction with predicates (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the filter (Required)
Predicates *[]FilterPredicateInput `json:"predicates,omitempty" yaml:"predicates,omitempty" example:"[]"` // The list of predicates used to select which services apply to the filter (Optional)
}
FilterCreateInput Specifies the input fields used to create a filter
type FilterCreatePayload ¶
type FilterCreatePayload struct {
Filter Filter // The newly created filter (Optional)
BasePayload
}
FilterCreatePayload The return type of a `filterCreatePayload` mutation
type FilterId ¶
type FilterId struct {
Id ID // The unique identifier for the filter.
Name string // The display name of the filter.
}
FilterId A filter is used to select which services will have checks applied. It can also be used to filter services in reports
type FilterPredicate ¶
type FilterPredicate struct {
CaseSensitive *bool // Option for determining whether to compare strings case-sensitively (Optional)
Key PredicateKeyEnum // The key of the condition (Required)
KeyData string // Additional data used in the condition (Optional)
Type PredicateTypeEnum // Type of operation to be used in the condition (Required)
Value string // The value of the condition (Optional)
}
FilterPredicate A condition used to select services
func (*FilterPredicate) Validate ¶
func (filterPredicate *FilterPredicate) Validate() error
Validate the FilterPredicate based on known expectations before sending to API
type FilterPredicateInput ¶
type FilterPredicateInput struct {
CaseSensitive *Nullable[bool] `json:"caseSensitive,omitempty" yaml:"caseSensitive,omitempty" example:"false"` // (Optional)
Key PredicateKeyEnum `json:"key" yaml:"key" example:"aliases"` // The condition key used by the predicate (Required)
KeyData *Nullable[string] `json:"keyData,omitempty" yaml:"keyData,omitempty" example:"example_value"` // Additional data used by the predicate. This field is used by predicates with key = 'tags' to specify the tag key. For example, to create a predicate for services containing the tag 'db:mysql', set keyData = 'db' and value = 'mysql' (Optional)
Type PredicateTypeEnum `json:"type" yaml:"type" example:"belongs_to"` // The condition type used by the predicate (Required)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // The condition value used by the predicate (Optional)
}
FilterPredicateInput A condition that should be satisfied
type FilterUpdateInput ¶
type FilterUpdateInput struct {
Connective *ConnectiveEnum `json:"connective,omitempty" yaml:"connective,omitempty" example:"and"` // The logical operator to be used in conjunction with predicates (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the filter (Required)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the filter (Optional)
Predicates *[]FilterPredicateInput `json:"predicates,omitempty" yaml:"predicates,omitempty" example:"[]"` // The list of predicates used to select which services apply to the filter. All existing predicates will be replaced by these predicates (Optional)
}
FilterUpdateInput Specifies the input fields used to update a filter
type FilterUpdatePayload ¶
type FilterUpdatePayload struct {
Filter Filter // The updated filter (Optional)
BasePayload
}
FilterUpdatePayload The return type of the `filterUpdate` mutation
type FireHydrantIntegrationInput ¶
type FireHydrantIntegrationInput struct {
ApiKey *Nullable[string] `json:"apiKey,omitempty" yaml:"apiKey,omitempty" example:"example_value"` // The API Key for the FireHydrant API (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name for the FireHydrant integration (Optional)
}
FireHydrantIntegrationInput A FireHydrant integration input
type FrequencyTimeScale ¶
type FrequencyTimeScale string
FrequencyTimeScale The time scale type for the frequency
var ( FrequencyTimeScaleDay FrequencyTimeScale = "day" // Consider the time scale of days FrequencyTimeScaleMonth FrequencyTimeScale = "month" // Consider the time scale of months FrequencyTimeScaleWeek FrequencyTimeScale = "week" // Consider the time scale of weeks FrequencyTimeScaleYear FrequencyTimeScale = "year" // Consider the time scale of years )
type GitBranchProtectionCheckFragment ¶
type GitBranchProtectionCheckFragment struct{}
type GoogleCloudIntegrationFragment ¶
type GoogleCloudIntegrationFragment struct {
Aliases []string `graphql:"aliases"`
ClientEmail string `graphql:"clientEmail"`
OwnershipTagKeys []string `graphql:"ownershipTagKeys"`
Projects []GoogleCloudProject `graphql:"projects"`
TagsOverrideOwnership bool `graphql:"tagsOverrideOwnership"`
}
type GoogleCloudIntegrationInput ¶
type GoogleCloudIntegrationInput struct {
ClientEmail *Nullable[string] `json:"clientEmail,omitempty" yaml:"clientEmail,omitempty" example:"example_value"` // The service account email OpsLevel uses to access the Google Cloud account (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration (Optional)
OwnershipTagKeys *Nullable[[]string] `json:"ownershipTagKeys,omitempty" yaml:"ownershipTagKeys,omitempty" example:"['tag_key1', 'tag_key2']"` // An array of tag keys used to associate ownership from an integration. Max 5 (Optional)
PrivateKey *Nullable[string] `json:"privateKey,omitempty" yaml:"privateKey,omitempty" example:"example_value"` // The private key for the service account that OpsLevel uses to access the Google Cloud account (Optional)
TagsOverrideOwnership *Nullable[bool] `json:"tagsOverrideOwnership,omitempty" yaml:"tagsOverrideOwnership,omitempty" example:"false"` // Allow tags imported from Google Cloud to override ownership set in OpsLevel directly (Optional)
}
GoogleCloudIntegrationInput Specifies the input fields used to create and update a Google Cloud integration
type GoogleCloudProject ¶
type GoogleCloudProject struct {
Id string // The ID of the Google Cloud project (Required)
Name string // The name of the Google Cloud project (Required)
Url string // The URL to the Google Cloud project (Required)
}
GoogleCloudProject
type HasDocumentationCheckFragment ¶
type HasDocumentationCheckFragment struct {
DocumentSubtype HasDocumentationSubtypeEnum `graphql:"documentSubtype"` // The subtype of the document.
DocumentType HasDocumentationTypeEnum `graphql:"documentType"` // The type of the document.
}
type HasDocumentationSubtypeEnum ¶
type HasDocumentationSubtypeEnum string
HasDocumentationSubtypeEnum The subtype of the document
var HasDocumentationSubtypeEnumOpenapi HasDocumentationSubtypeEnum = "openapi" // Document is an OpenAPI document
type HasDocumentationTypeEnum ¶
type HasDocumentationTypeEnum string
HasDocumentationTypeEnum The type of the document
var ( HasDocumentationTypeEnumAPI HasDocumentationTypeEnum = "api" // Document is an API document HasDocumentationTypeEnumTech HasDocumentationTypeEnum = "tech" // Document is a Tech document )
type HasRecentDeployCheckFragment ¶
type HasRecentDeployCheckFragment struct {
Days int `graphql:"days"` // The number of days to check since the last deploy.
}
type Identifiable ¶
type Identifiable interface {
GetID() ID
}
type Identifier ¶
type Identifier struct {
Id ID `graphql:"id" json:"id"`
Aliases []string `graphql:"aliases" json:"aliases"`
}
func (Identifier) GetID ¶
func (s Identifier) GetID() ID
type IdentifierInput ¶
type IdentifierInput struct {
Alias *string `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The human-friendly, unique identifier for the resource (Optional)
Id *ID `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the resource (Optional)
}
IdentifierInput Specifies the input fields used to identify a resource
func NewIdentifier ¶
func NewIdentifier(value ...string) *IdentifierInput
func NewIdentifierArray ¶
func NewIdentifierArray(values []string) []IdentifierInput
func (IdentifierInput) MarshalJSON ¶
func (identifierInput IdentifierInput) MarshalJSON() ([]byte, error)
type ImportEntityFromBackstagePayload ¶
type ImportEntityFromBackstagePayload struct {
ActionMessage string // The action taken by OpsLevel (ie: service created) (Required)
HtmlUrl string // A link to the created or updated object in OpsLevel, if any (Optional)
BasePayload
}
ImportEntityFromBackstagePayload Results of importing an Entity from Backstage into OpsLevel
type InfraInput ¶
type InfraInput struct {
Schema string `json:"schema" yaml:"schema" default:"Database"`
Owner *ID `json:"owner,omitempty" yaml:"owner,omitempty" default:"XXX_owner_id_XXX"`
Provider *InfraProviderInput `json:"provider" yaml:"provider"`
Data *JSON `` /* 139-byte string literal not displayed */
}
type InfraProviderInput ¶
type InfrastructureResource ¶
type InfrastructureResource struct {
Id ID `json:"id"`
Aliases []string `json:"aliases"`
Name string `json:"name"`
Schema string `json:"type" graphql:"type @include(if: $all)"`
ProviderType string `json:"providerResourceType" graphql:"providerResourceType @include(if: $all)"`
ProviderData InfrastructureResourceProviderData `json:"providerData" graphql:"providerData @include(if: $all)"`
Owner EntityOwner `json:"owner" graphql:"owner @include(if: $all)"`
OwnerLocked bool `json:"ownerLocked" graphql:"ownerLocked @include(if: $all)"`
ParsedData JSON `json:"data" scalar:"true" graphql:"data @include(if: $all)"`
Data JSON `json:"rawData" scalar:"true" graphql:"rawData @include(if: $all)"`
}
func (*InfrastructureResource) AliasableType ¶
func (infrastructureResource *InfrastructureResource) AliasableType() AliasOwnerTypeEnum
func (*InfrastructureResource) GetAliases ¶
func (infrastructureResource *InfrastructureResource) GetAliases() []string
func (*InfrastructureResource) GetTags ¶
func (infrastructureResource *InfrastructureResource) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
func (*InfrastructureResource) ReconcileAliases ¶
func (infrastructureResource *InfrastructureResource) ReconcileAliases(client *Client, aliasesWanted []string) error
func (*InfrastructureResource) ResourceId ¶
func (infrastructureResource *InfrastructureResource) ResourceId() ID
func (*InfrastructureResource) ResourceType ¶
func (infrastructureResource *InfrastructureResource) ResourceType() TaggableResource
type InfrastructureResourceConnection ¶
type InfrastructureResourceConnection ConnectionBase[InfrastructureResource]
InfrastructureResourceConnection The connection type for InfrastructureResource
type InfrastructureResourceInput ¶
type InfrastructureResourceInput struct {
Data *JSON `` // The data for the infrastructure_resource (Optional)
/* 159-byte string literal not displayed */
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner for the infrastructure_resource (Optional)
ProviderData *InfrastructureResourceProviderDataInput `json:"providerData,omitempty" yaml:"providerData,omitempty"` // Data about the provider of the infrastructure resource (Optional)
ProviderResourceType *Nullable[string] `json:"providerResourceType,omitempty" yaml:"providerResourceType,omitempty" example:"example_value"` // The type of the infrastructure resource in its provider (Optional)
Schema *InfrastructureResourceSchemaInput `json:"schema,omitempty" yaml:"schema,omitempty"` // The schema for the infrastructure_resource that determines its type (Optional)
}
InfrastructureResourceInput Specifies the input fields for a infrastructure resource
type InfrastructureResourcePayload ¶
type InfrastructureResourcePayload struct {
InfrastructureResource InfrastructureResource // An Infrastructure Resource (Optional)
Warnings []Warning // The warnings of the mutation (Required)
BasePayload
}
InfrastructureResourcePayload Return type for the `infrastructureResourceUpdate` mutation
type InfrastructureResourceProviderData ¶
type InfrastructureResourceProviderData struct {
AccountName string // The account name of the provider (Required)
ExternalUrl string // The external URL of the infrastructure resource in its provider (Optional)
ProviderName string // The name of the provider (e.g. AWS, GCP, Azure) (Optional)
}
InfrastructureResourceProviderData Data about the provider the infrastructure resource is from
type InfrastructureResourceProviderDataInput ¶
type InfrastructureResourceProviderDataInput struct {
AccountName string `json:"accountName" yaml:"accountName" example:"example_value"` // The account name of the provider (Required)
ExternalUrl *Nullable[string] `json:"externalUrl,omitempty" yaml:"externalUrl,omitempty" example:"example_value"` // The external URL of the infrastructure resource in its provider (Optional)
ProviderName *Nullable[string] `json:"providerName,omitempty" yaml:"providerName,omitempty" example:"example_value"` // The name of the provider (e.g. AWS, GCP, Azure) (Optional)
}
InfrastructureResourceProviderDataInput Specifies the input fields for data about an infrastructure resource's provider
type InfrastructureResourceSchemaConnection ¶
type InfrastructureResourceSchemaConnection ConnectionBase[InfrastructureResourceSchema]
InfrastructureResourceSchemaConnection The connection type for InfrastructureResourceSchema
type InfrastructureResourceSchemaInput ¶
type InfrastructureResourceSchemaInput struct {
Type string `json:"type" yaml:"type" example:"example_value"` // The type of the infrastructure resource (Required)
}
InfrastructureResourceSchemaInput Specifies the schema for an infrastructure resource
type Integration ¶
type Integration struct {
IntegrationId
DisplayName string `graphql:"displayName"` // The display name of the integration.
WebhookURL *string `graphql:"webhookUrl"` // The endpoint to send events via webhook (if applicable).
CreatedAt iso8601.Time `graphql:"createdAt"` // The time this integration was created.
InstalledAt iso8601.Time `graphql:"installedAt"` // The time that this integration was successfully installed, if null, this indicates the integration was not completed installed.
AWSIntegrationFragment `graphql:"... on AwsIntegration"`
AzureResourcesIntegrationFragment `graphql:"... on AzureResourcesIntegration"`
GoogleCloudIntegrationFragment `graphql:"... on GoogleCloudIntegration"`
NewRelicIntegrationFragment `graphql:"... on NewRelicIntegration"`
}
Integration represents an integration is a way of extending OpsLevel functionality.
type IntegrationConnection ¶
type IntegrationConnection ConnectionBase[Integration]
IntegrationConnection The connection type for Integration
type IntegrationCreatePayload ¶
type IntegrationCreatePayload struct {
Integration Integration // The newly created integration (Optional)
BasePayload
}
IntegrationCreatePayload The result of creating an integration
type IntegrationId ¶
type IntegrationId struct {
Id ID `json:"id"` // The unique identifier of the integration.
Name string `json:"name"` // The name of the integration.
Type string `json:"type"` // The type of the integration.
}
func (*IntegrationId) Alias ¶
func (integrationId *IntegrationId) Alias() string
type IntegrationReactivatePayload ¶
type IntegrationReactivatePayload struct {
Integration Integration // The newly reactivated integration (Optional)
BasePayload
}
IntegrationReactivatePayload The return type of a 'integrationReactivate' mutation
type IntegrationSourceObjectUpsertPayload ¶
type IntegrationSourceObjectUpsertPayload struct {
Integration Integration // The integration that the source object was upserted to (Optional)
BasePayload
}
IntegrationSourceObjectUpsertPayload The return type of a 'integrationSourceObjectUpsert' mutation
type IntegrationUpdatePayload ¶
type IntegrationUpdatePayload struct {
Integration Integration // The newly updated integration (Optional)
BasePayload
}
IntegrationUpdatePayload The return type of a 'integrationUpdate' mutation
type JSON ¶
JSON represents a json object with keys and values for use with the OpsLevel API. Instantiate using NewJSON. Has a different graphql type compared to JSONSchema.
func (JSON) GetGraphQLType ¶
func (JSON) MarshalJSON ¶
type JSONSchema ¶
JSONSchema represents a json object with keys and values for use with the OpsLevel API. Instantiate using NewJSONSchema. Has a different graphql type compared to JSON.
func NewJSONSchema ¶
func NewJSONSchema(data string) (*JSONSchema, error)
func (JSONSchema) AsString ¶
func (jsonSchema JSONSchema) AsString() string
AsString returns a string containing its key value pairs marshalled as a json object.
func (JSONSchema) GetGraphQLType ¶
func (jsonSchema JSONSchema) GetGraphQLType() string
func (JSONSchema) MarshalJSON ¶
func (jsonSchema JSONSchema) MarshalJSON() ([]byte, error)
type JsonString ¶
type JsonString string
JsonString is a specialized input type to support serialization of any json compatible type (bool, string, int, map, slice, etc.) for use with the OpsLevel API. Instantiate using NewJSONInput.
func NewJSONInput ¶
func NewJSONInput(data any) (*JsonString, error)
NewJSONInput converts any json compatible type (bool, string, int, map, slice, etc.) into a valid JsonString. If passed a json object or array wrapped in a string, it will not use json.Marshal(data) and instead simply return the value of of JsonString(data) to prevent adding unnecessary escape characters.
func (JsonString) AsArray ¶
func (jsonString JsonString) AsArray() []any
func (JsonString) AsBool ¶
func (jsonString JsonString) AsBool() bool
func (JsonString) AsFloat64 ¶
func (jsonString JsonString) AsFloat64() float64
func (JsonString) AsInt ¶
func (jsonString JsonString) AsInt() int
func (JsonString) AsMap ¶
func (jsonString JsonString) AsMap() map[string]any
func (JsonString) AsString ¶
func (jsonString JsonString) AsString() string
func (JsonString) GetGraphQLType ¶
func (jsonString JsonString) GetGraphQLType() string
type Language ¶
type Language struct {
Name string // The name of the language (Required)
Usage float64 // The percentage of the code written in that language (Required)
}
Language A language that can be assigned to a repository
type Level ¶
type Level struct {
Alias string // The human-friendly, unique identifier for the level (Optional)
Checks []CheckId // The checks that belong to the level (Optional)
Description string // A brief description of the level (Optional)
Id ID // The unique identifier for the level (Required)
Index int // The numerical representation of the level (highest is better) (Optional)
Name string // The display name of the level (Optional)
}
Level A performance rating that is used to grade your services against
type LevelConnection ¶
type LevelConnection ConnectionBase[Level]
LevelConnection The connection type for Level
type LevelCount ¶
type LevelCount struct {
Level Level // A performance rating that is used to grade your services against (Required)
ServiceCount int // The number of services (Required)
}
LevelCount The total number of services in each level
type LevelCreateInput ¶
type LevelCreateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the level (Optional)
Index *int `json:"index,omitempty" yaml:"index,omitempty" example:"3"` // an integer allowing this level to be inserted between others. Must be unique per Rubric (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the level (Required)
}
LevelCreateInput Specifies the input fields used to create a level. The new level will be added as the highest level (greatest level index)
type LevelCreatePayload ¶
type LevelCreatePayload struct {
Level Level // A performance rating that is used to grade your services against (Optional)
BasePayload
}
LevelCreatePayload The return type of the `levelCreate` mutation
type LevelDeleteInput ¶
type LevelDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level to be deleted (Required)
}
LevelDeleteInput Specifies the input fields used to delete a level
type LevelUpdateInput ¶
type LevelUpdateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the level (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the level to be updated (Required)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the level (Optional)
}
LevelUpdateInput Specifies the input fields used to update a level
type LevelUpdatePayload ¶
type LevelUpdatePayload struct {
Level Level // A performance rating that is used to grade your services against (Optional)
BasePayload
}
LevelUpdatePayload The return type of the `levelUpdate` mutation
type Lifecycle ¶
type Lifecycle struct {
Alias string // The human-friendly, unique identifier for the lifecycle (Optional)
Description string // The lifecycle's description (Optional)
Id ID // The unique identifier for the lifecycle (Required)
Index int // The numerical representation of the lifecycle (Optional)
Name string // The lifecycle's display name (Optional)
}
Lifecycle A lifecycle represents the current development stage of a service
type ListCampaignsVariables ¶
type ListCampaignsVariables struct {
After *string
First *int
SortBy *CampaignSortEnum
Status *CampaignStatusEnum
}
func (*ListCampaignsVariables) AsPayloadVariables ¶
func (v *ListCampaignsVariables) AsPayloadVariables() *PayloadVariables
type ManagementRuleInput ¶
type ManagementRuleInput struct {
Operator RelationshipDefinitionManagementRuleOperator `json:"operator,omitempty" yaml:"operator,omitempty" example:"ARRAY_CONTAINS"` // The operator used to compare the source and target properties (Required Default: EQUALS)
SourceProperty string `json:"sourceProperty" yaml:"sourceProperty" example:"example_value"` // The property on the source component type that is used in the rule (Required)
SourcePropertyBuiltin bool `json:"sourcePropertyBuiltin" yaml:"sourcePropertyBuiltin" example:"false"` // Whether the source property is a built-in property (Required)
TargetCategory *Nullable[string] `json:"targetCategory,omitempty" yaml:"targetCategory,omitempty" example:"example_value"` // A component type category that is the target category for the rule (Optional)
TargetProperty string `json:"targetProperty" yaml:"targetProperty" example:"example_value"` // The property on the target type that is used in the rule (Required)
TargetPropertyBuiltin bool `json:"targetPropertyBuiltin" yaml:"targetPropertyBuiltin" example:"false"` // Whether the target property is a built-in property (Required)
TargetType *Nullable[string] `json:"targetType,omitempty" yaml:"targetType,omitempty" example:"example_value"` // The target type for the rule (i.e., a component type alias, 'team', or 'user') (Optional)
}
ManagementRuleInput A rule that defines how a relationship is automatically managed
type ManualAlertSourceSync ¶
type ManualAlertSourceSync struct {
AllowManualSyncAlertSources string `graphql:"allowManualSyncAlertSources"` // Indicates if manual alert source synchronization can be triggered.
LastManualSyncAlertSources string `graphql:"lastManualSyncAlertSources"` // The time that alert sources were last manually synchronized at.
}
ManualAlertSourceSync represents .
type ManualCheckFragment ¶
type ManualCheckFragment struct {
UpdateFrequency *ManualCheckFrequency `graphql:"updateFrequency"` // The minimum frequency of the updates.
UpdateRequiresComment bool `graphql:"updateRequiresComment"` // Whether the check requires a comment or not.
}
type ManualCheckFrequency ¶
type ManualCheckFrequency struct {
FrequencyTimeScale FrequencyTimeScale // The time scale type for the frequency (Required)
FrequencyValue int // The value to be used together with the frequency scale (Required)
StartingDate iso8601.Time // The date that the check will start to evaluate (Required)
}
ManualCheckFrequency
type ManualCheckFrequencyInput ¶
type ManualCheckFrequencyInput struct {
FrequencyTimeScale FrequencyTimeScale `json:"frequencyTimeScale" yaml:"frequencyTimeScale" example:"day"` // The time scale type for the frequency (Required)
FrequencyValue int `json:"frequencyValue" yaml:"frequencyValue" example:"3"` // The value to be used together with the frequency scale (Required)
StartingDate iso8601.Time `json:"startingDate" yaml:"startingDate" example:"2025-01-05T01:00:00.000Z"` // The date that the check will start to evaluate (Required)
}
ManualCheckFrequencyInput Defines a frequency for the check update
func NewManualCheckFrequencyInput ¶
func NewManualCheckFrequencyInput(startingDate string, timeScale FrequencyTimeScale, value int) *ManualCheckFrequencyInput
type ManualCheckFrequencyUpdateInput ¶
type ManualCheckFrequencyUpdateInput struct {
FrequencyTimeScale *FrequencyTimeScale `json:"frequencyTimeScale,omitempty" yaml:"frequencyTimeScale,omitempty" example:"day"` // The time scale type for the frequency (Optional)
FrequencyValue *Nullable[int] `json:"frequencyValue,omitempty" yaml:"frequencyValue,omitempty" example:"3"` // The value to be used together with the frequency scale (Optional)
StartingDate *Nullable[iso8601.Time] `json:"startingDate,omitempty" yaml:"startingDate,omitempty" example:"2025-01-05T01:00:00.000Z"` // The date that the check will start to evaluate (Optional)
}
ManualCheckFrequencyUpdateInput Defines a frequency for the check update
func NewManualCheckFrequencyUpdateInput ¶
func NewManualCheckFrequencyUpdateInput(startingDate string, timeScale FrequencyTimeScale, value int) *ManualCheckFrequencyUpdateInput
type MaturityReport ¶
type MaturityReport struct {
CategoryBreakdown []CategoryBreakdown
OverallLevel Level
}
func (*MaturityReport) Get ¶
func (maturityReport *MaturityReport) Get(category string) *Level
Get Given a 'category' name returns the 'Level'
type MaturityReportOnlyOverallLevel ¶
type MaturityReportOnlyOverallLevel struct {
OverallLevel Level
}
type MemberInput ¶
type MemberInput struct {
Email string `json:"email" yaml:"email" example:"example_value"` // The user's email (Required)
}
MemberInput Input for specifying members on a group
type NewRelicAccountsPayload ¶
type NewRelicAccountsPayload struct {
BasePayload
}
NewRelicAccountsPayload
type NewRelicIntegrationAccountsInput ¶
type NewRelicIntegrationAccountsInput struct {
ApiKey string `json:"apiKey" yaml:"apiKey" example:"example_value"` // The API Key for the New Relic API (Required)
BaseUrl string `json:"baseUrl" yaml:"baseUrl" example:"example_value"` // The API URL for New Relic API (Required)
}
NewRelicIntegrationAccountsInput
type NewRelicIntegrationInput ¶
type NewRelicIntegrationInput struct {
ApiKey *Nullable[string] `json:"apiKey,omitempty" yaml:"apiKey,omitempty" example:"example_value"` // The API Key for the New Relic API (Optional)
BaseUrl *Nullable[string] `json:"baseUrl,omitempty" yaml:"baseUrl,omitempty" example:"example_value"` // The API URL for New Relic API (Optional)
}
NewRelicIntegrationInput
func (NewRelicIntegrationInput) GetGraphQLType ¶
func (newRelicIntegrationInput NewRelicIntegrationInput) GetGraphQLType() string
type Nullable ¶
type Nullable[T NullableConstraint] struct { Value T SetNull bool }
Nullable can be used to unset a value using an OpsLevel input struct type, should always be instantiated using a constructor.
func NewNull ¶
NewNull returns a Nullable string that will always marshal into `null`, can be used to unset fields
func NewNullOf ¶
func NewNullOf[T NullableConstraint]() *Nullable[T]
NewNullOf returns a Nullable of any type that fits NullableConstraint that will always marshal into `null`, can be used to unset fields
func NewNullableFrom ¶
func NewNullableFrom[T NullableConstraint](value T) *Nullable[T]
NewNullableFrom returns a Nullable that will never marshal into `null`, can be used to change fields or even set them to an empty value (like "")
func NullOf ¶
func NullOf[T NullableConstraint]() *Nullable[T]
func RefOf ¶
func RefOf[T NullableConstraint](value T) *Nullable[T]
func RefTo ¶
func RefTo[T NullableConstraint](value T) *Nullable[T]
func (Nullable[T]) MarshalJSON ¶
func (*Nullable[T]) MarshalYAML ¶
func (*Nullable[T]) UnmarshalJSON ¶
type NullableConstraint ¶
type NullableConstraint interface {
any
}
NullableConstraint defines what types can be nullable - keep separated using the union operator (pipe)
type OctopusDeployIntegrationInput ¶
type OctopusDeployIntegrationInput struct {
ApiKey *Nullable[string] `json:"apiKey,omitempty" yaml:"apiKey,omitempty" example:"example_value"` // The API Key for the Octopus Deploy API (Optional)
InstanceUrl *Nullable[string] `json:"instanceUrl,omitempty" yaml:"instanceUrl,omitempty" example:"example_value"` // The URL the Octopus Deploy instance if hosted on (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration (Optional)
}
OctopusDeployIntegrationInput Specifies the input fields used to create and update an Octopus Deploy integration
type Option ¶
type Option func(*ClientSettings)
func SetAPIToken ¶
func SetAPIVisibility ¶
func SetHeaders ¶
func SetMaxRetries ¶
func SetPageSize ¶
func SetTimeout ¶
func SetTransport ¶
func SetTransport(transport http.RoundTripper) Option
func SetUserAgentExtra ¶
type OwnerRelationshipInput ¶
type OwnerRelationshipInput struct {
ManagementRules *[]ManagementRuleInput `json:"managementRules,omitempty" yaml:"managementRules,omitempty"` // The management rules for the relationship (Optional)
}
OwnerRelationshipInput The input for defining the owner relationship for a component type
type OwnerRelationshipType ¶
type OwnerRelationshipType struct {
ManagementRules []RelationshipDefinitionManagementRule // The management rules for the owner relationship (Required)
}
OwnerRelationshipType The owner relationship for a component type
type PackageConstraintEnum ¶
type PackageConstraintEnum string
PackageConstraintEnum Possible values of a package version check constraint
var ( PackageConstraintEnumDoesNotExist PackageConstraintEnum = "does_not_exist" // The package must not be used by a service PackageConstraintEnumExists PackageConstraintEnum = "exists" // The package must be used by a service PackageConstraintEnumMatchesVersion PackageConstraintEnum = "matches_version" // The package usage by a service must match certain specified version constraints )
type PackageManagerEnum ¶
type PackageManagerEnum string
PackageManagerEnum Supported software package manager types
var ( PackageManagerEnumAlpm PackageManagerEnum = "alpm" // PackageManagerEnumApk PackageManagerEnum = "apk" // PackageManagerEnumBitbucket PackageManagerEnum = "bitbucket" // PackageManagerEnumBitnami PackageManagerEnum = "bitnami" // PackageManagerEnumCargo PackageManagerEnum = "cargo" // PackageManagerEnumCocoapods PackageManagerEnum = "cocoapods" // PackageManagerEnumComposer PackageManagerEnum = "composer" // PackageManagerEnumConan PackageManagerEnum = "conan" // PackageManagerEnumConda PackageManagerEnum = "conda" // PackageManagerEnumCpan PackageManagerEnum = "cpan" // PackageManagerEnumCran PackageManagerEnum = "cran" // PackageManagerEnumDeb PackageManagerEnum = "deb" // PackageManagerEnumDocker PackageManagerEnum = "docker" // PackageManagerEnumGem PackageManagerEnum = "gem" // PackageManagerEnumGeneric PackageManagerEnum = "generic" // PackageManagerEnumGitHub PackageManagerEnum = "github" // PackageManagerEnumGolang PackageManagerEnum = "golang" // PackageManagerEnumGradle PackageManagerEnum = "gradle" // PackageManagerEnumHackage PackageManagerEnum = "hackage" // PackageManagerEnumHelm PackageManagerEnum = "helm" // PackageManagerEnumHex PackageManagerEnum = "hex" // PackageManagerEnumMaven PackageManagerEnum = "maven" // PackageManagerEnumMlflow PackageManagerEnum = "mlflow" // PackageManagerEnumNpm PackageManagerEnum = "npm" // PackageManagerEnumNuget PackageManagerEnum = "nuget" // PackageManagerEnumOci PackageManagerEnum = "oci" // PackageManagerEnumPub PackageManagerEnum = "pub" // PackageManagerEnumPypi PackageManagerEnum = "pypi" // PackageManagerEnumQpkg PackageManagerEnum = "qpkg" // PackageManagerEnumRpm PackageManagerEnum = "rpm" // PackageManagerEnumSwid PackageManagerEnum = "swid" // PackageManagerEnumSwift PackageManagerEnum = "swift" // )
type PackageVersionCheckFragment ¶
type PackageVersionCheckFragment struct {
MissingPackageResult *CheckResultStatusEnum `graphql:"missingPackageResult"` // The check result if the package isn't being used by a service.
PackageConstraint PackageConstraintEnum `graphql:"packageConstraint"` // The package constraint the service is to be checked for.
PackageManager PackageManagerEnum `graphql:"packageManager"` // The package manager (ecosystem) this package relates to.
PackageName string `graphql:"packageName"` // The name of the package to be checked.
PackageNameIsRegex bool `graphql:"packageNameIsRegex"` // Whether or not the value in the package name field is a regular expression.
VersionConstraintPredicate *Predicate `graphql:"versionConstraintPredicate"` // The predicate that describes the version constraint the package must satisfy.
}
type PayloadFilterEnum ¶
type PayloadFilterEnum string
PayloadFilterEnum Fields that can be used as part of filters for payloads
var PayloadFilterEnumIntegrationID PayloadFilterEnum = "integration_id" // Filter by `integration` field. Note that this is an internal id, ex. "123"
type PayloadFilterInput ¶
type PayloadFilterInput struct {
Arg *Nullable[string] `json:"arg,omitempty" yaml:"arg,omitempty" example:"example_value"` // Value to be filtered (Optional)
Key PayloadFilterEnum `json:"key" yaml:"key" example:"integration_id"` // Field to be filtered (Required)
Type *BasicTypeEnum `json:"type,omitempty" yaml:"type,omitempty" example:"does_not_equal"` // Type of operation to be applied to value on the field (Optional Default: equals)
}
PayloadFilterInput Input to be used to filter types
type PayloadSortEnum ¶
type PayloadSortEnum string
PayloadSortEnum Sort possibilities for payloads
var ( PayloadSortEnumCreatedAtAsc PayloadSortEnum = "created_at_ASC" // Order by `created_at` ascending PayloadSortEnumCreatedAtDesc PayloadSortEnum = "created_at_DESC" // Order by `created_at` descending PayloadSortEnumProcessedAtAsc PayloadSortEnum = "processed_at_ASC" // Order by `processed_at` ascending PayloadSortEnumProcessedAtDesc PayloadSortEnum = "processed_at_DESC" // Order by `processed_at` descending )
type PayloadVariables ¶
type PayloadVariables map[string]interface{}
func (*PayloadVariables) WithoutDeactivedUsers ¶
func (pv *PayloadVariables) WithoutDeactivedUsers() *PayloadVariables
WithoutDeactivedUsers filters out deactivated users on ListUsers query
type Predicate ¶
type Predicate struct {
Type PredicateTypeEnum // Type of operation to be used in the condition (Required)
Value string // The value of the condition (Optional)
}
Predicate A condition used to select services
type PredicateInput ¶
type PredicateInput struct {
Type PredicateTypeEnum `json:"type" yaml:"type" example:"belongs_to"` // The condition type used by the predicate (Required)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // The condition value used by the predicate (Optional)
}
PredicateInput A condition that should be satisfied
type PredicateKeyEnum ¶
type PredicateKeyEnum string
PredicateKeyEnum Fields that can be used as part of filter for services
var ( PredicateKeyEnumAliases PredicateKeyEnum = "aliases" // Filter by Alias attached to this service, if any PredicateKeyEnumComponentCategory PredicateKeyEnum = "component_category" // Filter by the component type category for this service PredicateKeyEnumComponentTypeID PredicateKeyEnum = "component_type_id" // Filter by the `component_type` field PredicateKeyEnumCreationSource PredicateKeyEnum = "creation_source" // Filter by the creation source PredicateKeyEnumDomainID PredicateKeyEnum = "domain_id" // Filter by Domain that includes the System this service is assigned to, if any PredicateKeyEnumFilterID PredicateKeyEnum = "filter_id" // Filter by another filter PredicateKeyEnumFramework PredicateKeyEnum = "framework" // Filter by `framework` field PredicateKeyEnumGroupIDs PredicateKeyEnum = "group_ids" // Filter by group hierarchy. Will return resources who's owner is in the group ancestry chain PredicateKeyEnumLanguage PredicateKeyEnum = "language" // Filter by `language` field PredicateKeyEnumLifecycleIndex PredicateKeyEnum = "lifecycle_index" // Filter by `lifecycle` field PredicateKeyEnumName PredicateKeyEnum = "name" // Filter by `name` field PredicateKeyEnumOwnerID PredicateKeyEnum = "owner_id" // Filter by `owner` field PredicateKeyEnumOwnerIDs PredicateKeyEnum = "owner_ids" // Filter by `owner` hierarchy. Will return resources who's owner is in the team ancestry chain PredicateKeyEnumProduct PredicateKeyEnum = "product" // Filter by `product` field PredicateKeyEnumProperties PredicateKeyEnum = "properties" // Filter by custom-defined properties PredicateKeyEnumRelationships PredicateKeyEnum = "relationships" // Filter by `relationships` PredicateKeyEnumRepositoryIDs PredicateKeyEnum = "repository_ids" // Filter by Repository that this service is attached to, if any PredicateKeyEnumSystemID PredicateKeyEnum = "system_id" // Filter by System that this service is assigned to, if any PredicateKeyEnumTags PredicateKeyEnum = "tags" // Filter by `tags` field PredicateKeyEnumTierIndex PredicateKeyEnum = "tier_index" // Filter by `tier` field )
type PredicateTypeEnum ¶
type PredicateTypeEnum string
PredicateTypeEnum Operations that can be used on predicates
var ( PredicateTypeEnumBelongsTo PredicateTypeEnum = "belongs_to" // Belongs to a group's hierarchy PredicateTypeEnumContains PredicateTypeEnum = "contains" // Contains a specific value PredicateTypeEnumDoesNotContain PredicateTypeEnum = "does_not_contain" // Does not contain a specific value PredicateTypeEnumDoesNotEqual PredicateTypeEnum = "does_not_equal" // Does not equal a specific value PredicateTypeEnumDoesNotExist PredicateTypeEnum = "does_not_exist" // Specific attribute does not exist PredicateTypeEnumDoesNotMatch PredicateTypeEnum = "does_not_match" // A certain filter is not matched PredicateTypeEnumDoesNotMatchRegex PredicateTypeEnum = "does_not_match_regex" // Does not match a value using a regular expression PredicateTypeEnumEndsWith PredicateTypeEnum = "ends_with" // Ends with a specific value PredicateTypeEnumEquals PredicateTypeEnum = "equals" // Equals a specific value PredicateTypeEnumExists PredicateTypeEnum = "exists" // Specific attribute exists PredicateTypeEnumGreaterThanOrEqualTo PredicateTypeEnum = "greater_than_or_equal_to" // Greater than or equal to a specific value (numeric only) PredicateTypeEnumLessThanOrEqualTo PredicateTypeEnum = "less_than_or_equal_to" // Less than or equal to a specific value (numeric only) PredicateTypeEnumMatches PredicateTypeEnum = "matches" // A certain filter is matched PredicateTypeEnumMatchesRegex PredicateTypeEnum = "matches_regex" // Matches a value using a regular expression PredicateTypeEnumSatisfiesJqExpression PredicateTypeEnum = "satisfies_jq_expression" // Satisfies an expression defined in jq PredicateTypeEnumSatisfiesVersionConstraint PredicateTypeEnum = "satisfies_version_constraint" // Satisfies version constraint (tag value only) PredicateTypeEnumStartsWith PredicateTypeEnum = "starts_with" // Starts with a specific value )
type PredicateUpdateInput ¶
type PredicateUpdateInput struct {
Type *PredicateTypeEnum `json:"type,omitempty" yaml:"type,omitempty" example:"belongs_to"` // The condition type used by the predicate (Optional)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // The condition value used by the predicate (Optional)
}
PredicateUpdateInput A condition that should be satisfied
func (*PredicateUpdateInput) MarshalJSON ¶
func (p *PredicateUpdateInput) MarshalJSON() ([]byte, error)
type Property ¶
type Property struct {
Definition PropertyDefinitionId `graphql:"definition"`
Locked bool `graphql:"locked"`
Owner EntityOwnerService `graphql:"owner"`
ValidationErrors []Error `graphql:"validationErrors"`
Value *JsonString `graphql:"value"`
}
Property represents a custom property value assigned to an entity.
type PropertyConnection ¶
type PropertyConnection ConnectionBase[Property]
PropertyConnection The connection type for Property
type PropertyDefinition ¶
type PropertyDefinition struct {
Aliases []string `graphql:"aliases" json:"aliases"`
AllowedInConfigFiles bool `graphql:"allowedInConfigFiles"` // Whether or not the property is allowed to be set in opslevel.yml config files.
Id ID `graphql:"id" json:"id"`
Name string `graphql:"name" json:"name"`
Description string `graphql:"description" json:"description"`
DisplaySubtype PropertyDefinitionDisplayTypeEnum `graphql:"displaySubtype" json:"displaySubtype"`
DisplayType PropertyDefinitionDisplayTypeEnum `graphql:"displayType" json:"displayType"`
PropertyDisplayStatus PropertyDisplayStatusEnum `graphql:"propertyDisplayStatus" json:"propertyDisplayStatus"`
LockedStatus PropertyLockedStatusEnum `graphql:"lockedStatus" json:"lockedStatus"`
Schema JSONSchema `json:"schema" scalar:"true"`
}
PropertyDefinition represents the definition of a property.
type PropertyDefinitionConnection ¶
type PropertyDefinitionConnection ConnectionBase[PropertyDefinition]
PropertyDefinitionConnection The connection type for PropertyDefinition
type PropertyDefinitionDisplayTypeEnum ¶
type PropertyDefinitionDisplayTypeEnum string
PropertyDefinitionDisplayTypeEnum The set of possible display types of a property definition schema
var ( PropertyDefinitionDisplayTypeEnumArray PropertyDefinitionDisplayTypeEnum = "ARRAY" // An array PropertyDefinitionDisplayTypeEnumBoolean PropertyDefinitionDisplayTypeEnum = "BOOLEAN" // A boolean PropertyDefinitionDisplayTypeEnumDropdown PropertyDefinitionDisplayTypeEnum = "DROPDOWN" // A dropdown PropertyDefinitionDisplayTypeEnumNumber PropertyDefinitionDisplayTypeEnum = "NUMBER" // A number PropertyDefinitionDisplayTypeEnumObject PropertyDefinitionDisplayTypeEnum = "OBJECT" // An object PropertyDefinitionDisplayTypeEnumText PropertyDefinitionDisplayTypeEnum = "TEXT" // A text string )
type PropertyDefinitionId ¶
type PropertyDefinitionInput ¶
type PropertyDefinitionInput struct {
AllowedInConfigFiles *Nullable[bool] `json:"allowedInConfigFiles,omitempty" yaml:"allowedInConfigFiles,omitempty" example:"false"` // Whether or not the property is allowed to be set in opslevel.yml config files (Optional Default: true)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the property definition (Optional)
LockedStatus *PropertyLockedStatusEnum `json:"lockedStatus,omitempty" yaml:"lockedStatus,omitempty" example:"ui_locked"` // Restricts what sources are able to assign values to this property (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the property definition (Optional)
PropertyDisplayStatus *PropertyDisplayStatusEnum `json:"propertyDisplayStatus,omitempty" yaml:"propertyDisplayStatus,omitempty" example:"hidden"` // The UI display status of the custom property (Optional)
Schema *JSONSchema `json:"schema,omitempty" yaml:"schema,omitempty" example:"SCHEMA_TBD"` // The schema of the property definition (Optional)
}
PropertyDefinitionInput The input for defining a property
type PropertyDefinitionPayload ¶
type PropertyDefinitionPayload struct {
Definition PropertyDefinition // The property that was defined (Optional)
BasePayload
}
PropertyDefinitionPayload The return type for property definition mutations
type PropertyDisplayStatusEnum ¶
type PropertyDisplayStatusEnum string
PropertyDisplayStatusEnum The UI display status of a custom property
var ( PropertyDisplayStatusEnumHidden PropertyDisplayStatusEnum = "hidden" // The property is not shown on resource pages PropertyDisplayStatusEnumVisible PropertyDisplayStatusEnum = "visible" // The property is shown on resource pages )
type PropertyInput ¶
type PropertyInput struct {
Definition IdentifierInput `json:"definition" yaml:"definition"` // The definition of the property (Required)
Owner IdentifierInput `json:"owner" yaml:"owner"` // The entity that the property has been assigned to (Required)
OwnerType *PropertyOwnerTypeEnum `json:"ownerType,omitempty" yaml:"ownerType,omitempty" example:"COMPONENT"` // The type of the entity that the property has been assigned to. Defaults to `COMPONENT` if alias is provided for `owner` and `definition` (Optional)
RunValidation *Nullable[bool] `json:"runValidation,omitempty" yaml:"runValidation,omitempty" example:"false"` // Validate the property value against the schema. On by default (Optional Default: true)
Value JsonString `json:"value" yaml:"value" example:"JSON_TBD"` // The value of the property (Required)
}
PropertyInput The input for setting a property
type PropertyLockedStatusEnum ¶
type PropertyLockedStatusEnum string
PropertyLockedStatusEnum Values for which lock is assigned to a property definition to restrict what sources can assign values to it
var ( PropertyLockedStatusEnumUILocked PropertyLockedStatusEnum = "ui_locked" // Value assignments on the property cannot be changed through the UI PropertyLockedStatusEnumUnlocked PropertyLockedStatusEnum = "unlocked" // There are no restrictions on what sources can assign values to the property )
type PropertyOwnerTypeEnum ¶
type PropertyOwnerTypeEnum string
PropertyOwnerTypeEnum The possible entity types that a property can be assigned to
var ( PropertyOwnerTypeEnumComponent PropertyOwnerTypeEnum = "COMPONENT" // A component PropertyOwnerTypeEnumTeam PropertyOwnerTypeEnum = "TEAM" // A team )
type PropertyPayload ¶
type PropertyPayload struct {
Property Property // The property that was set (Optional)
BasePayload
}
PropertyPayload The payload for setting a property
type PropertyUnassignPayload ¶
type PropertyUnassignPayload struct {
Definition PropertyDefinition // The definition of the property that was unassigned (Optional)
Owner EntityOwnerService // The entity that the property was unassigned from (Optional)
BasePayload
}
PropertyUnassignPayload The payload for unassigning a property
type ProvisionedByEnum ¶
type ProvisionedByEnum string
ProvisionedByEnum
var ( ProvisionedByEnumAPICli ProvisionedByEnum = "api_cli" // ProvisionedByEnumAPIOther ProvisionedByEnum = "api_other" // ProvisionedByEnumAPITerraform ProvisionedByEnum = "api_terraform" // ProvisionedByEnumBackstage ProvisionedByEnum = "backstage" // ProvisionedByEnumIntegrationScim ProvisionedByEnum = "integration_scim" // ProvisionedByEnumSsoOkta ProvisionedByEnum = "sso_okta" // ProvisionedByEnumSsoOther ProvisionedByEnum = "sso_other" // ProvisionedByEnumUnknown ProvisionedByEnum = "unknown" // ProvisionedByEnumUser ProvisionedByEnum = "user" // )
type RelatedResourceConnection ¶
type RelatedResourceConnection ConnectionBase[RelationshipResource]
RelatedResourceConnection The connection type for RelationshipResource
type RelatedResourceRelationshipTypeEnum ¶
type RelatedResourceRelationshipTypeEnum string
RelatedResourceRelationshipTypeEnum The type of the relationship between two resources
var ( RelatedResourceRelationshipTypeEnumBelongsTo RelatedResourceRelationshipTypeEnum = "belongs_to" // The resource belongs to the node on the edge RelatedResourceRelationshipTypeEnumContains RelatedResourceRelationshipTypeEnum = "contains" // The resource contains the node on the edge RelatedResourceRelationshipTypeEnumDependencyOf RelatedResourceRelationshipTypeEnum = "dependency_of" // The resource is a dependency of the node on the edge RelatedResourceRelationshipTypeEnumDependsOn RelatedResourceRelationshipTypeEnum = "depends_on" // The resource depends on the node on the edge RelatedResourceRelationshipTypeEnumIsRelatedTo RelatedResourceRelationshipTypeEnum = "is_related_to" // The resource is part of a specialized relationship defined on another node RelatedResourceRelationshipTypeEnumMemberOf RelatedResourceRelationshipTypeEnum = "member_of" // The resource is a member of the node on the edge RelatedResourceRelationshipTypeEnumRelatedTo RelatedResourceRelationshipTypeEnum = "related_to" // The resource has a specialized relationship to another node )
type RelationshipCheckFragment ¶
type RelationshipCheckFragment struct {
RelationshipCountPredicate *Predicate `graphql:"relationshipCountPredicate"` // The condition that should be satisfied by the number of RelatedTo relationships
RelationshipDefinition RelationshipDefinitionType `graphql:"relationshipDefinition"` // The relationship definition that the check is based on.
}
type RelationshipConnection ¶
type RelationshipConnection ConnectionBase[RelationshipNode]
RelationshipConnection The connection type for RelationshipNode
type RelationshipDefinition ¶
type RelationshipDefinition struct {
RelationshipDefinition *IdentifierInput `json:"relationshipDefinition,omitempty" yaml:"relationshipDefinition,omitempty"` // A dynamic definition that specifies how the source and target are related (Optional)
Source IdentifierInput `json:"source" yaml:"source"` // The resource that is the source of the relationship (Required)
Target IdentifierInput `json:"target" yaml:"target"` // The resource that is the target of the relationship (Required)
Type RelationshipTypeEnum `json:"type" yaml:"type" example:"belongs_to"` // The type of the relationship between source and target (Required)
}
RelationshipDefinition A source, target and relationship type specifying a relationship between two resources
type RelationshipDefinitionConnection ¶
type RelationshipDefinitionConnection ConnectionBase[RelationshipDefinitionType]
RelationshipDefinitionConnection The connection type for RelationshipDefinitionType
type RelationshipDefinitionInput ¶
type RelationshipDefinitionInput struct {
Alias *string `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The unique identifier of the relationship (Optional)
ComponentType *IdentifierInput `json:"componentType,omitempty" yaml:"componentType,omitempty"` // The component type to create the relationship on (Optional)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description of the relationship (Optional)
ManagementRules *[]ManagementRuleInput `json:"managementRules,omitempty" yaml:"managementRules,omitempty"` // The management rules for the relationship (Optional)
Metadata *RelationshipDefinitionMetadataInput `json:"metadata,omitempty" yaml:"metadata,omitempty"` // The metadata of the relationship (Optional)
Name *string `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the relationship (Optional)
}
RelationshipDefinitionInput The input for defining a relationship on a component type
type RelationshipDefinitionManagementRule ¶
type RelationshipDefinitionManagementRule struct {
Operator RelationshipDefinitionManagementRuleOperator // The operator used to compare the source and target properties (Required)
SourceProperty string // The property on the source component type that is used in the rule (Required)
SourcePropertyBuiltin bool // Whether the source property is a built-in property (Required)
TargetCategory *Nullable[string] // A component type category that is the target category for the rule (Optional)
TargetProperty string // The property on the target type that is used in the rule (Required)
TargetPropertyBuiltin bool // Whether the target property is a built-in property (Required)
TargetType *Nullable[string] // The target type for the rule (i.e., a component type alias, 'team', or 'user') (Optional)
}
RelationshipDefinitionManagementRule A rule that defines how a relationship is automatically managed
type RelationshipDefinitionManagementRuleOperator ¶
type RelationshipDefinitionManagementRuleOperator string
RelationshipDefinitionManagementRuleOperator The operator used in a relationship definition management rule
var ( RelationshipDefinitionManagementRuleOperatorArrayContains RelationshipDefinitionManagementRuleOperator = "ARRAY_CONTAINS" // RelationshipDefinitionManagementRuleOperatorEquals RelationshipDefinitionManagementRuleOperator = "EQUALS" // )
type RelationshipDefinitionMetadata ¶
type RelationshipDefinitionMetadata struct {
AllowedCategories []string // The aliases of which categories this relationship can target. Valid values include any component category on your account (Required)
AllowedTypes []string // The aliases of which types this relationship can target. Valid values include any component type alias on your account, `team`, or `user` (Required)
MaxItems int // The maximum number of records this relationship can associate to the component type. Defaults to null (no maximum) (Optional)
MinItems int // The minimum number of records this relationship must associate to the component type. Defaults to 0 (optional) (Optional)
}
RelationshipDefinitionMetadata The metadata of the relationship
type RelationshipDefinitionMetadataInput ¶
type RelationshipDefinitionMetadataInput struct {
AllowedCategories []string `json:"allowedCategories,omitempty" yaml:"allowedCategories,omitempty" example:"infrastructure"` // The aliases of which categories this relationship can target. Valid values include any component category on your account (Optional)
AllowedTypes []string `json:"allowedTypes,omitempty" yaml:"allowedTypes,omitempty" example:"team"` // The aliases of which types this relationship can target. Valid values include any component type alias on your account, `team`, or `user` (Optional)
MaxItems *int `json:"maxItems,omitempty" yaml:"maxItems,omitempty" example:"3"` // The maximum number of records this relationship can associate to the component type. Defaults to null (no maximum) (Optional)
MinItems *int `json:"minItems,omitempty" yaml:"minItems,omitempty" example:"3"` // The minimum number of records this relationship must associate to the component type. Defaults to 0 (optional) (Optional)
}
RelationshipDefinitionMetadataInput The metadata of the relationship
type RelationshipDefinitionPayload ¶
type RelationshipDefinitionPayload struct {
Definition RelationshipDefinitionType // The relationship that was defined.
BasePayload
}
type RelationshipDefinitionType ¶
type RelationshipDefinitionType struct {
Alias string // The programmatic alias that can be used to reference the relationship in OpsLevel tooling (Required)
ComponentType ComponentTypeId // The component type that the relationship belongs to (Required)
Description string // The long-form descripion of what the relationship represents (Optional)
Id ID // The ID of the relationship definition (Required)
ManagementRules []RelationshipDefinitionManagementRule // Rules that define how relationships will be automatically created and deleted (Required)
Metadata RelationshipDefinitionMetadata // JSON data that defines rules for how the relationship should be validated internally (Required)
Name string // The human-readable name for a relationship (Required)
}
RelationshipDefinitionType A dynamic definition for a relationship between one catalog entity to another
type RelationshipNode ¶
type RelationshipNode struct {
Destination RelationshipResource // The catalog item that a relationship points to (Required)
Id ID // The ID of the relationship (Required)
Source RelationshipResource // The catalog item that a relationship stems from (Required)
}
RelationshipNode The relationship between two resources. A pair of source and destination resources
type RelationshipResource ¶
type RelationshipResource struct {
Domain DomainId `graphql:"... on Domain"`
InfrastructureResource InfrastructureResourceId `graphql:"... on InfrastructureResource"`
Service ServiceId `graphql:"... on Service"`
System SystemId `graphql:"... on System"`
Team TeamId `graphql:"... on Team"`
}
RelationshipResource represents a resource that can have relationships to other resources.
type RelationshipType ¶
type RelationshipType struct {
Id ID // The ID of the relationship (Required)
Source RelationshipResource // The resource that is the source of the relationship (Required)
Target RelationshipResource // The resource that is the target of the relationship (Required)
Type RelationshipTypeEnum // The type of the relationship between source and target (Required)
}
RelationshipType The type specifying a relationship between two resources
type RelationshipTypeEnum ¶
type RelationshipTypeEnum string
RelationshipTypeEnum The type of relationship between two resources
var ( RelationshipTypeEnumBelongsTo RelationshipTypeEnum = "belongs_to" // The source resource belongs to the target resource. Can be used to allow Components to belong to Systems and Domains, or for Infrastructure to belong to Components RelationshipTypeEnumDependsOn RelationshipTypeEnum = "depends_on" // The source resource depends on the target resource. Can be used to specify that a Component depends on some Infrastructure, or that a System depends on a Component RelationshipTypeEnumRelatedTo RelationshipTypeEnum = "related_to" // The source resource is related to the target resource through a custom relationship definition. These are dynamic and can be used to extend our out-of-the-box relationships )
type RepositoriesUpdatePayload ¶
type RepositoriesUpdatePayload struct {
NotUpdatedRepositories []RepositoryOperationErrorPayload // The repository objects that were not updated along with the error that happened when attempting to update the repository (Optional)
UpdatedRepositories []Repository // The identifiers of the updated repositories (Optional)
BasePayload
}
RepositoriesUpdatePayload Return type for the `repositoriesUpdate` mutation
type Repository ¶
type Repository struct {
ArchivedAt iso8601.Time
CreatedOn iso8601.Time
DefaultAlias string
DefaultBranch string
Description string
Forked bool
HtmlUrl string
Id ID
Languages []Language
LastOwnerChangedAt iso8601.Time
Locked bool
Name string
Organization string
Owner TeamId
Private bool
RepoKey string
SBOMGenerationConfiguration SBOMGenerationConfiguration
Services *RepositoryServiceConnection
Tags *TagConnection
Tier Tier
Type string
Url string
Visible bool
}
func (*Repository) GetService ¶
func (repository *Repository) GetService(service ID, directory string) *ServiceRepository
func (*Repository) GetServices ¶
func (repository *Repository) GetServices(client *Client, variables *PayloadVariables) (*RepositoryServiceConnection, error)
func (*Repository) GetTags ¶
func (repository *Repository) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
func (*Repository) Hydrate ¶
func (repository *Repository) Hydrate(client *Client) error
func (*Repository) ResourceId ¶
func (repository *Repository) ResourceId() ID
func (*Repository) ResourceType ¶
func (repository *Repository) ResourceType() TaggableResource
type RepositoryConnection ¶
type RepositoryConnection struct {
HiddenCount int
Nodes []Repository
OrganizationCount int
OwnedCount int
PageInfo PageInfo
TotalCount int `graphql:"-"`
VisibleCount int
}
RepositoryConnection The connection type for Repository
type RepositoryFileCheckFragment ¶
type RepositoryFileCheckFragment struct {
DirectorySearch bool `graphql:"directorySearch"` // Whether the check looks for the existence of a directory instead of a file.
FileContentsPredicate *Predicate `graphql:"fileContentsPredicate"` // Condition to match the file content.
Filepaths []string `graphql:"filePaths"` // Restrict the search to certain file paths.
UseAbsoluteRoot bool `graphql:"useAbsoluteRoot"` // Whether the checks looks at the absolute root of a repo or the relative root (the directory specified when attached a repo to a service).
}
type RepositoryGrepCheckFragment ¶
type RepositoryGrepCheckFragment struct {
DirectorySearch bool `graphql:"directorySearch"` // Whether the check looks for the existence of a directory instead of a file.
FileContentsPredicate Predicate `graphql:"fileContentsPredicate"` // Condition to match the file content.
Filepaths []string `graphql:"filePaths"` // Restrict the search to certain file paths.
}
type RepositoryId ¶
type RepositoryOperationErrorPayload ¶
type RepositoryOperationErrorPayload struct {
Error string // The error message after an operation was attempted (Optional)
Repository Repository // The repository on which an operation was attempted (Required)
BasePayload
}
RepositoryOperationErrorPayload Specifies the repository and error after attempting and failing to perform a CRUD operation on a repository
type RepositoryPath ¶
type RepositoryPath struct {
Href string // The deep link to the repository path where the linked service's code exists (Required)
Path string // The path where the linked service's code exists, relative to the root of the repository (Required)
}
RepositoryPath The repository path used for this service
type RepositorySBOMGenerationConfigEnum ¶
type RepositorySBOMGenerationConfigEnum string
RepositorySBOMGenerationConfigEnum The enumerated list of configuration values for SBOM generation at the repository level
var ( RepositorySBOMGenerationConfigEnumOptIn RepositorySBOMGenerationConfigEnum = "opt_in" // Indicates that the repository will opt in to automated SBOM generation if it would be otherwise enabled at an integration or account level RepositorySBOMGenerationConfigEnumOptOut RepositorySBOMGenerationConfigEnum = "opt_out" // Indicates that the repository will opt out of automated SBOM generation if it would be otherwise enabled at an integration or account level )
type RepositorySBOMGenerationDisabledReasonEnum ¶
type RepositorySBOMGenerationDisabledReasonEnum string
RepositorySBOMGenerationDisabledReasonEnum The set of values that explain why SBOM autogeneration is disabled
var ( RepositorySBOMGenerationDisabledReasonEnumAccount RepositorySBOMGenerationDisabledReasonEnum = "account" // SBOM autogeneration is disabled at the account level RepositorySBOMGenerationDisabledReasonEnumIntegration RepositorySBOMGenerationDisabledReasonEnum = "integration" // SBOM autogeneration is disabled at the integration level RepositorySBOMGenerationDisabledReasonEnumRepository RepositorySBOMGenerationDisabledReasonEnum = "repository" // SBOM autogeneration is disabled at the repository level )
type RepositoryServiceConnection ¶
type RepositoryServiceConnection struct {
Edges []RepositoryServiceEdge
PageInfo PageInfo
TotalCount int `graphql:"-"`
}
RepositoryServiceConnection The connection type for Service
type RepositoryServiceEdge ¶
type RepositoryServiceEdge struct {
AtRoot bool
Node ServiceId
Paths []RepositoryPath
ServiceRepositories []ServiceRepository
}
type RepositoryUpdateInput ¶
type RepositoryUpdateInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the repository to be updated (Required)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The team that owns the repository (Optional)
SbomGeneration *RepositorySBOMGenerationConfigEnum `json:"sbomGeneration,omitempty" yaml:"sbomGeneration,omitempty" example:"opt_in"` // The desired configuration state at the repository level for SBOM generation (Optional)
Visible *Nullable[bool] `json:"visible,omitempty" yaml:"visible,omitempty" example:"false"` // Indicates if the repository is visible (Optional)
}
RepositoryUpdateInput Specifies the input fields used to update a repository
type RepositoryUpdatePayload ¶
type RepositoryUpdatePayload struct {
Repository Repository // A repository contains code that pertains to a service (Optional)
BasePayload
}
RepositoryUpdatePayload The return type of a `repositoryUpdate` mutation
type RepositoryVisibilityEnum ¶
type RepositoryVisibilityEnum string
RepositoryVisibilityEnum Possible visibility levels for repositories
var ( RepositoryVisibilityEnumInternal RepositoryVisibilityEnum = "INTERNAL" // Repositories that are only accessible to organization users (Github, Gitlab) RepositoryVisibilityEnumOrganization RepositoryVisibilityEnum = "ORGANIZATION" // Repositories that are only accessible to organization users (ADO) RepositoryVisibilityEnumPrivate RepositoryVisibilityEnum = "PRIVATE" // Repositories that are private to the user RepositoryVisibilityEnumPublic RepositoryVisibilityEnum = "PUBLIC" // Repositories that are publicly accessible )
type ResourceDocumentStatusTypeEnum ¶
type ResourceDocumentStatusTypeEnum string
ResourceDocumentStatusTypeEnum Status of a document on a resource
var ( ResourceDocumentStatusTypeEnumHidden ResourceDocumentStatusTypeEnum = "hidden" // Document is hidden ResourceDocumentStatusTypeEnumPinned ResourceDocumentStatusTypeEnum = "pinned" // Document is pinned ResourceDocumentStatusTypeEnumVisible ResourceDocumentStatusTypeEnum = "visible" // Document is visible )
type RestResponse ¶
type RubricReport ¶
type RubricReport struct {
CategoryLevel Level // The level of a specific category (Optional)
CheckResults ServiceCheckResults // The service check results (Optional)
Level Level // The overall level of the service (Optional)
}
RubricReport The check result information for the service's rubric
type Runner ¶
type Runner struct {
Id ID `json:"id"`
Status RunnerStatusTypeEnum `json:"status"`
}
type RunnerAppendJobLogInput ¶
type RunnerAppendJobLogInput struct {
RunnerId ID `json:"runnerId" yaml:"runnerId" default:"46290"`
RunnerJobId ID `json:"runnerJobId" yaml:"runnerJobId" default:"4133720"`
SentAt iso8601.Time `json:"sentAt" yaml:"sentAt" default:"2023-11-05T01:00:00.000Z"`
Logs []string `json:"logChunk" yaml:"logChunk" default:"[\"LogRoger\",\"LogDodger\"]"`
}
type RunnerJob ¶
type RunnerJob struct {
Commands []string `json:"commands"`
Id ID `json:"id"`
Image string `json:"image"`
Outcome RunnerJobOutcomeEnum `json:"outcome"`
Status RunnerJobStatusEnum `json:"status"`
Variables []RunnerJobVariable `json:"variables"`
Files []RunnerJobFile `json:"files"`
}
type RunnerJobFile ¶
type RunnerJobOutcomeEnum ¶
type RunnerJobOutcomeEnum string
RunnerJobOutcomeEnum represents the runner job outcome.
const ( RunnerJobOutcomeEnumUnstarted RunnerJobOutcomeEnum = "unstarted" // translation missing: en.graphql.types.runner_job_outcome_enum.unstarted. RunnerJobOutcomeEnumCanceled RunnerJobOutcomeEnum = "canceled" // Job was canceled. RunnerJobOutcomeEnumFailed RunnerJobOutcomeEnum = "failed" // Job failed during execution. RunnerJobOutcomeEnumSuccess RunnerJobOutcomeEnum = "success" // Job succeeded the execution. RunnerJobOutcomeEnumQueueTimeout RunnerJobOutcomeEnum = "queue_timeout" // Job was not assigned to a runner for too long. RunnerJobOutcomeEnumExecutionTimeout RunnerJobOutcomeEnum = "execution_timeout" // Job run took too long to complete, and was marked as failed. RunnerJobOutcomeEnumPodTimeout RunnerJobOutcomeEnum = "pod_timeout" // A pod could not be scheduled for the job in time. )
type RunnerJobStatusEnum ¶
type RunnerJobStatusEnum string
RunnerJobStatusEnum represents the runner job status.
const ( RunnerJobStatusEnumCreated RunnerJobStatusEnum = "created" // A created runner job, but not yet ready to be run. RunnerJobStatusEnumPending RunnerJobStatusEnum = "pending" // A runner job ready to be run. RunnerJobStatusEnumRunning RunnerJobStatusEnum = "running" // A runner job being run by a runner. RunnerJobStatusEnumComplete RunnerJobStatusEnum = "complete" // A finished runner job. )
const ( RunnerStatusTypeEnumInactive RunnerJobStatusEnum = "inactive" // The runner will not actively take jobs. RunnerStatusTypeEnumRegistered RunnerJobStatusEnum = "registered" // The runner will process jobs. )
type RunnerJobVariable ¶
type RunnerReportJobOutcomeInput ¶
type RunnerReportJobOutcomeInput struct {
RunnerId ID `json:"runnerId" yaml:"runnerId" default:"42690"`
RunnerJobId ID `json:"runnerJobId" yaml:"runnerJobId" default:"4213370"`
Outcome RunnerJobOutcomeEnum `json:"outcome" yaml:"outcome" default:"pod_timeout"`
OutcomeVariables []RunnerJobOutcomeVariable `json:"outcomeVariables,omitempty" yaml:"outcomeVariables,omitempty"`
}
type RunnerScale ¶
type RunnerScale struct {
RecommendedReplicaCount int `json:"recommendedReplicaCount"`
}
type RunnerStatusTypeEnum ¶
type RunnerStatusTypeEnum string
RunnerStatusTypeEnum represents The status of an OpsLevel runner.
type SBOMGenerationConfiguration ¶
type SBOMGenerationConfiguration struct {
DisabledReason RepositorySBOMGenerationDisabledReasonEnum // A brief explanation of why SBOM autogeneration is disabled (Optional)
Enabled bool // Whether SBOM autogeneration is enabled through all associated configuration objects (Required)
NextGenerationAt iso8601.Time // The approximate time at which a new software bill of material will be generated for this repository (Optional)
State RepositorySBOMGenerationConfigEnum // The configuration option set by the current object (Required)
}
SBOMGenerationConfiguration The configuration details that explain whether SBOM generation is allowed for the repository
type Scorecard ¶
type Scorecard struct {
ScorecardId
AffectsOverallServiceLevels bool // Specifies whether the checks on this scorecard affect services' overall maturity level (Required)
Description string // Description of the scorecard (Optional)
Filter Filter // Filter used by the scorecard to restrict services (Optional)
Href string // The hypertext reference (link) to the UI showing this scorecard (Required)
Name string // Name of the scorecard (Required)
Owner EntityOwner // The owner of this scorecard. Can currently either be a team or a group (Optional)
PassingChecks int // The number of checks that are passing on this scorecard. A check executed against two services counts as two (Required)
PassingChecksPercentage float64 // The percentage of checks that are passing on this scorecard. A check executed against two services counts as two (Required)
ServiceCount int // The number of services covered by this scorecard (Required)
ServicesReport ScorecardServicesReport // Service stats regarding this scorecard (Optional)
Slug string // Slug of the scorecard (Required)
TotalChecks int // The number of checks that are performed on this scorecard. A check executed against two services counts as two (Required)
}
Scorecard A scorecard
func (*Scorecard) ListCategories ¶
func (scorecard *Scorecard) ListCategories(client *Client, variables *PayloadVariables) (*ScorecardCategoryConnection, error)
type ScorecardCategoryConnection ¶
type ScorecardCategoryConnection ConnectionBase[Category]
ScorecardCategoryConnection The connection type for Category
type ScorecardCheckConnection ¶
type ScorecardCheckConnection ConnectionBase[Check]
ScorecardCheckConnection The connection type for Check
type ScorecardConnection ¶
type ScorecardConnection ConnectionBase[Scorecard]
ScorecardConnection The connection type for Scorecard
type ScorecardId ¶
type ScorecardId struct {
Id ID // A reference to the scorecard.
Aliases []string // Aliases of the scorecard.
}
ScorecardId A scorecard
func (*ScorecardId) AliasableType ¶
func (scorecard *ScorecardId) AliasableType() AliasOwnerTypeEnum
func (*ScorecardId) GetAliases ¶
func (scorecard *ScorecardId) GetAliases() []string
func (*ScorecardId) ReconcileAliases ¶
func (scorecard *ScorecardId) ReconcileAliases(client *Client, aliasesWanted []string) error
func (*ScorecardId) ResourceId ¶
func (scorecard *ScorecardId) ResourceId() ID
type ScorecardInput ¶
type ScorecardInput struct {
AffectsOverallServiceLevels *Nullable[bool] `json:"affectsOverallServiceLevels,omitempty" yaml:"affectsOverallServiceLevels,omitempty" example:"false"` // (Optional)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // Description of the scorecard (Optional)
FilterId *Nullable[ID] `json:"filterId,omitempty" yaml:"filterId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // Filter used by the scorecard to restrict services (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // Name of the scorecard (Required)
OwnerId ID `json:"ownerId" yaml:"ownerId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // Owner of the scorecard. Can currently be a team or a group (Required)
}
ScorecardInput Input used to create scorecards
type ScorecardPayload ¶
type ScorecardPayload struct {
Scorecard Scorecard // The created scorecard (Optional)
BasePayload
}
ScorecardPayload The type returned when creating a scorecard
type ScorecardServicesReport ¶
type ScorecardServicesReport struct {
LevelCounts []LevelCount // Services per level regarding this scorecard (Required)
}
ScorecardServicesReport Service stats regarding this scorecard
type ScorecardSortEnum ¶
type ScorecardSortEnum string
ScorecardSortEnum The possible options to sort the resulting list of scorecards
var ( ScorecardSortEnumAffectsoverallservicelevelsAsc ScorecardSortEnum = "affectsOverallServiceLevels_ASC" // Order by whether or not the checks on the scorecard affect the overall maturity, in ascending order ScorecardSortEnumAffectsoverallservicelevelsDesc ScorecardSortEnum = "affectsOverallServiceLevels_DESC" // Order by whether or not the checks on the scorecard affect the overall maturity, in descending order ScorecardSortEnumFilterAsc ScorecardSortEnum = "filter_ASC" // Order by the associated filter's name, in ascending order ScorecardSortEnumFilterDesc ScorecardSortEnum = "filter_DESC" // Order by the associated filter's name, in descending order ScorecardSortEnumNameAsc ScorecardSortEnum = "name_ASC" // Order by the scorecard's name, in ascending order ScorecardSortEnumNameDesc ScorecardSortEnum = "name_DESC" // Order by the scorecard's name, in descending order ScorecardSortEnumOwnerAsc ScorecardSortEnum = "owner_ASC" // Order by the scorecard owner's name, in ascending order ScorecardSortEnumOwnerDesc ScorecardSortEnum = "owner_DESC" // Order by the scorecard owner's name, in descending order ScorecardSortEnumPassingcheckfractionAsc ScorecardSortEnum = "passingCheckFraction_ASC" // Order by the fraction of passing checks on the scorecard, in ascending order ScorecardSortEnumPassingcheckfractionDesc ScorecardSortEnum = "passingCheckFraction_DESC" // Order by the fraction of passing checks on the scorecard, in descending order ScorecardSortEnumServicecountAsc ScorecardSortEnum = "serviceCount_ASC" // Order by the number of services covered by the scorecard, in ascending order ScorecardSortEnumServicecountDesc ScorecardSortEnum = "serviceCount_DESC" // Order by the number of services covered by the scorecard, in descending order )
type ScorecardStats ¶
type ScorecardStats struct {
CheckResults ServiceCheckResults // The service check results (Optional)
Scorecard Scorecard // The scorecard (Optional)
}
ScorecardStats Service maturity information about a scorecard
type ScorecardStatsConnection ¶
type ScorecardStatsConnection ConnectionBase[ScorecardStats]
ScorecardStatsConnection The connection type for ScorecardStats
type Secret ¶
type Secret struct {
Alias string // A human reference for the secret (Required)
Id ID // A reference for the secret (Required)
Owner TeamId // The owner of this secret (Optional)
Timestamps Timestamps // Relevant timestamps (Required)
}
Secret A sensitive value
type SecretInput ¶
type SecretInput struct {
Owner *IdentifierInput `json:"owner,omitempty" yaml:"owner,omitempty"` // The owner of this secret (Optional)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // A sensitive value (Optional)
}
SecretInput Arguments for secret operations
type SecretPayload ¶
type SecretPayload struct {
Secret Secret // A sensitive value (Optional)
BasePayload
}
SecretPayload Return type for secret operations
type SecretsVaultsSecretsConnection ¶
type SecretsVaultsSecretsConnection ConnectionBase[Secret]
SecretsVaultsSecretsConnection The connection type for Secret
type Service ¶
type Service struct {
ApiDocumentPath string `json:"apiDocumentPath,omitempty"`
Description string `json:"description,omitempty"`
Framework string `json:"framework,omitempty"`
HtmlURL string `json:"htmlUrl"`
ServiceId
Language string `json:"language,omitempty"`
Lifecycle Lifecycle `json:"lifecycle,omitempty"`
Locked bool `json:"locked" graphql:"locked"`
ManagedAliases []string `json:"managedAliases,omitempty"`
MaturityReport MaturityReportOnlyOverallLevel `json:"maturityReport" graphql:"maturityReport"`
Name string `json:"name,omitempty"`
Note string `json:"note,omitempty"`
Owner TeamId `json:"owner,omitempty"`
Parent *SystemId `json:"parent,omitempty" graphql:"parent"`
PreferredApiDocument *ServiceDocument `json:"preferredApiDocument,omitempty"`
PreferredApiDocumentSource *ApiDocumentSourceEnum `json:"preferredApiDocumentSource,omitempty"`
Product string `json:"product,omitempty"`
Repositories *ServiceRepositoryConnection `json:"repos,omitempty" graphql:"repos"`
Repository *ServiceRepository `graphql:"defaultServiceRepository" json:"defaultServiceRepository"`
Tags *TagConnection `json:"tags,omitempty"`
Tier Tier `json:"tier,omitempty"`
Timestamps Timestamps `json:"timestamps"`
Tools *ToolConnection `json:"tools,omitempty"`
Type *ComponentTypeId `json:"type,omitempty"`
Dependencies *ServiceDependenciesConnection `graphql:"-"`
Dependents *ServiceDependentsConnection `graphql:"-"`
LastDeploy *Deploy `graphql:"-"`
Properties *ServicePropertiesConnection `graphql:"-"`
}
TODO: Lifecycle, TeamId, Tier should probably be pointers.
func (*Service) AliasableType ¶
func (service *Service) AliasableType() AliasOwnerTypeEnum
func (*Service) GetAliases ¶
func (*Service) GetDependencies ¶
func (service *Service) GetDependencies(client *Client, variables *PayloadVariables) (*ServiceDependenciesConnection, error)
func (*Service) GetDependents ¶
func (service *Service) GetDependents(client *Client, variables *PayloadVariables) (*ServiceDependentsConnection, error)
func (*Service) GetDocuments ¶
func (service *Service) GetDocuments(client *Client, variables *PayloadVariables) (*ServiceDocumentConnection, error)
func (*Service) GetLastDeploy ¶
func (service *Service) GetLastDeploy(client *Client, variables *PayloadVariables) (*Deploy, error)
func (*Service) GetProperties ¶
func (service *Service) GetProperties(client *Client, variables *PayloadVariables) (*ServicePropertiesConnection, error)
func (*Service) GetRepositories ¶
func (service *Service) GetRepositories(client *Client, variables *PayloadVariables) (*ServiceRepositoryConnection, error)
func (*Service) GetServiceStats ¶
func (service *Service) GetServiceStats(client *Client) (*ServiceStats, error)
func (*Service) GetSystem ¶
func (service *Service) GetSystem(client *Client, variables *PayloadVariables) (*System, error)
func (*Service) GetTags ¶
func (service *Service) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
func (*Service) GetTools ¶
func (service *Service) GetTools(client *Client, variables *PayloadVariables) (*ToolConnection, error)
func (*Service) HasTool ¶
func (service *Service) HasTool(category ToolCategory, name string, environment string) bool
func (*Service) ReconcileAliases ¶
func (*Service) ResourceId ¶
func (*Service) ResourceType ¶
func (service *Service) ResourceType() TaggableResource
func (*Service) UniqueIdentifiers ¶
Returns unique identifiers created by OpsLevel, values in Aliases but not ManagedAliases
type ServiceCategoryConnection ¶
type ServiceCategoryConnection ConnectionBase[Category]
ServiceCategoryConnection The connection type for Category
type ServiceCheckResults ¶
type ServiceCheckResults struct {
ByLevel CheckResultsByLevelConnection // The list of service check results grouped by level (Optional)
NextLevel ServiceNextLevel // The next level for this service to achieve and the associated checks (Optional)
}
ServiceCheckResults The service check results
type ServiceConnection ¶
type ServiceConnection ConnectionBase[Service]
ServiceConnection The connection type for Service
type ServiceCreateInput ¶
type ServiceCreateInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // A brief description of the service (Optional)
Framework *Nullable[string] `json:"framework,omitempty" yaml:"framework,omitempty" example:"example_value"` // The primary software development framework that the service uses (Optional)
Language *Nullable[string] `json:"language,omitempty" yaml:"language,omitempty" example:"example_value"` // The primary programming language that the service is written in (Optional)
LifecycleAlias *Nullable[string] `json:"lifecycleAlias,omitempty" yaml:"lifecycleAlias,omitempty" example:"example_value"` // The lifecycle stage of the service (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The display name of the service (Required)
OwnerAlias *Nullable[string] `json:"ownerAlias,omitempty" yaml:"ownerAlias,omitempty" example:"example_value"` // The team that owns the service (Optional)
OwnerInput *IdentifierInput `json:"ownerInput,omitempty" yaml:"ownerInput,omitempty"` // The owner for this service (Optional)
Parent *IdentifierInput `json:"parent,omitempty" yaml:"parent,omitempty"` // The parent system for the service (Optional)
Product *Nullable[string] `json:"product,omitempty" yaml:"product,omitempty" example:"example_value"` // A product is an application that your end user interacts with. Multiple services can work together to power a single product (Optional)
SkipAliasesValidation *Nullable[bool] `json:"skipAliasesValidation,omitempty" yaml:"skipAliasesValidation,omitempty" example:"false"` // Allows for the creation of a service with invalid aliases (Optional Default: false)
TierAlias *Nullable[string] `json:"tierAlias,omitempty" yaml:"tierAlias,omitempty" example:"example_value"` // The software tier that the service belongs to (Optional)
Type *IdentifierInput `json:"type,omitempty" yaml:"type,omitempty"` // The type of the component (Optional)
}
ServiceCreateInput Specifies the input fields used in the `serviceCreate` mutation
type ServiceCreatePayload ¶
type ServiceCreatePayload struct {
Service Service // The newly created service (Optional)
BasePayload
}
ServiceCreatePayload Return type for the `serviceCreate` mutation
type ServiceDeleteInput ¶
type ServiceDeleteInput struct {
Alias *Nullable[string] `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The alias of the service to be deleted (Optional)
Id *Nullable[ID] `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the service to be deleted (Optional)
}
ServiceDeleteInput Specifies the input fields used in the `serviceDelete` mutation
type ServiceDependenciesConnection ¶
type ServiceDependenciesConnection struct {
Edges []ServiceDependenciesEdge `graphql:"edges"`
PageInfo PageInfo
}
ServiceDependenciesConnection The connection type for Service
type ServiceDependenciesEdge ¶
type ServiceDependency ¶
type ServiceDependencyCreateInput ¶
type ServiceDependencyCreateInput struct {
DependencyKey ServiceDependencyKey `json:"dependencyKey" yaml:"dependencyKey"` // A source, destination pair specifying a dependency between services (Required)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Notes for service dependency (Optional)
}
ServiceDependencyCreateInput Specifies the input fields used for creating a service dependency
type ServiceDependencyKey ¶
type ServiceDependencyKey struct {
Destination *Nullable[ID] `json:"destination,omitempty" yaml:"destination,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the service that is depended upon (Optional)
DestinationIdentifier *IdentifierInput `json:"destinationIdentifier,omitempty" yaml:"destinationIdentifier,omitempty"` // The ID or alias identifier of the service that is depended upon (Optional)
Notes *Nullable[string] `json:"notes,omitempty" yaml:"notes,omitempty" example:"example_value"` // Notes about the dependency edge (Optional)
Source *Nullable[ID] `json:"source,omitempty" yaml:"source,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the service with the dependency (Optional)
SourceIdentifier *IdentifierInput `json:"sourceIdentifier,omitempty" yaml:"sourceIdentifier,omitempty"` // The ID or alias identifier of the service with the dependency (Optional)
}
ServiceDependencyKey A source, destination pair specifying a dependency between services
type ServiceDependencyPayload ¶
type ServiceDependencyPayload struct {
ServiceDependency ServiceDependency // A service dependency edge (Optional)
BasePayload
}
ServiceDependencyPayload Return type for the requested `serviceDependency`
type ServiceDependentsConnection ¶
type ServiceDependentsConnection struct {
Edges []ServiceDependentsEdge `graphql:"edges"`
PageInfo PageInfo
}
ServiceDependentsConnection The connection type for Service
type ServiceDependentsEdge ¶
type ServiceDocument ¶
type ServiceDocument struct {
Id ID `graphql:"id" json:"id"`
HtmlURL string `graphql:"htmlUrl" json:"htmlUrl,omitempty"`
Source ServiceDocumentSource `graphql:"source" json:"source"`
Timestamps Timestamps `graphql:"timestamps" json:"timestamps"`
}
type ServiceDocumentConnection ¶
type ServiceDocumentConnection ConnectionBase[ServiceDocument]
ServiceDocumentConnection The connection type for ServiceDocument
type ServiceDocumentContent ¶
type ServiceDocumentContent struct {
ServiceDocument
Content string `graphql:"content" json:"content,omitempty"`
}
type ServiceDocumentSource ¶
type ServiceDocumentSource struct {
IntegrationId `graphql:"... on ApiDocIntegration"`
ServiceRepository `graphql:"... on ServiceRepository"`
}
ServiceDocumentSource represents the source of a document.
type ServiceFilterEnum ¶
type ServiceFilterEnum string
ServiceFilterEnum Fields that can be used as part of filter for services
var ( ServiceFilterEnumAlertStatus ServiceFilterEnum = "alert_status" // Filter by `alert status` field ServiceFilterEnumAliases ServiceFilterEnum = "aliases" // Filter by Alias attached to this service, if any ServiceFilterEnumComponentTypeID ServiceFilterEnum = "component_type_id" // Filter by the type of service ServiceFilterEnumCreationSource ServiceFilterEnum = "creation_source" // Filter by the creation source ServiceFilterEnumDeployEnvironment ServiceFilterEnum = "deploy_environment" // Filter by the existence of a deploy to an environment ServiceFilterEnumDomainID ServiceFilterEnum = "domain_id" // Filter by Domain that includes the System this service is assigned to, if any ServiceFilterEnumFilterID ServiceFilterEnum = "filter_id" // Filter by another filter ServiceFilterEnumFramework ServiceFilterEnum = "framework" // Filter by `framework` field ServiceFilterEnumGroupIDs ServiceFilterEnum = "group_ids" // Filter by group hierarchy. Will return resources who's owner is in the group ancestry chain ServiceFilterEnumLanguage ServiceFilterEnum = "language" // Filter by `language` field ServiceFilterEnumLevelIndex ServiceFilterEnum = "level_index" // Filter by `level` field ServiceFilterEnumLifecycleIndex ServiceFilterEnum = "lifecycle_index" // Filter by `lifecycle` field ServiceFilterEnumName ServiceFilterEnum = "name" // Filter by `name` field ServiceFilterEnumOwnerID ServiceFilterEnum = "owner_id" // Filter by `owner` field ServiceFilterEnumOwnerIDs ServiceFilterEnum = "owner_ids" // Filter by `owner` hierarchy. Will return resources who's owner is in the team ancestry chain ServiceFilterEnumProduct ServiceFilterEnum = "product" // Filter by `product` field ServiceFilterEnumProperty ServiceFilterEnum = "property" // Filter by a custom-defined property value ServiceFilterEnumRelationship ServiceFilterEnum = "relationship" // Filter by the existence of a relationship to another catalog component ServiceFilterEnumRepositoryIDs ServiceFilterEnum = "repository_ids" // Filter by Repository that this service is attached to, if any ServiceFilterEnumSystemID ServiceFilterEnum = "system_id" // Filter by System that this service is assigned to, if any ServiceFilterEnumTag ServiceFilterEnum = "tag" // Filter by `tag` field ServiceFilterEnumTierIndex ServiceFilterEnum = "tier_index" // Filter by `tier` field )
type ServiceFilterInput ¶
type ServiceFilterInput struct {
Arg string `json:"arg,omitempty" yaml:"arg,omitempty" example:"example_value"` // Value to be filtered (Optional)
CaseSensitive bool `json:"caseSensitive" yaml:"caseSensitive"` // Whether or not the filter should be case sensitive (Optional)
Connective *ConnectiveEnum `json:"connective,omitempty" yaml:"connective,omitempty" example:"and"` // The logical operator to be used in conjunction with multiple filters (requires predicates to be supplied) (Optional Default: or)
Key *ServiceFilterEnum `json:"key,omitempty" yaml:"key,omitempty" example:"alert_status"` // Field to be filtered (Optional)
Predicates []ServiceFilterInput `json:"predicates,omitempty" yaml:"predicates,omitempty" example:"[]"` // A list of service filter input (Optional)
Type *TypeEnum `json:"type,omitempty" yaml:"type,omitempty" example:"belongs_to"` // Type of operation to be applied to value on the field (Optional Default: equals)
}
ServiceFilterInput Input to be used to filter types
type ServiceLevelNotifications ¶
type ServiceLevelNotifications struct {
SlackNotificationEnabled bool // Whether slack notifications on service level changes are enabled on your account (Required)
}
ServiceLevelNotifications
type ServiceLevelNotificationsPayload ¶
type ServiceLevelNotificationsPayload struct {
ServiceLevelNotifications ServiceLevelNotifications // The updated service level notification settings (Optional)
BasePayload
}
ServiceLevelNotificationsPayload The return type of the service level notifications update mutation
type ServiceLevelNotificationsUpdateInput ¶
type ServiceLevelNotificationsUpdateInput struct {
EnableSlackNotifications *Nullable[bool] `json:"enableSlackNotifications,omitempty" yaml:"enableSlackNotifications,omitempty" example:"false"` // Whether or not to enable receiving slack notifications on service level changes (Optional)
}
ServiceLevelNotificationsUpdateInput Specifies the input fields used to update service level notification settings
type ServiceMaturity ¶
type ServiceMaturity struct {
Name string
MaturityReport MaturityReport
}
type ServiceMaturityConnection ¶
type ServiceMaturityConnection struct {
Nodes []ServiceMaturity
PageInfo PageInfo
TotalCount int `graphql:"-"`
}
NOTE: ServiceMaturityConnection is not part of GraphQL API schema
type ServiceMaturityReport ¶
type ServiceMaturityReport struct {
CategoryBreakdown []CategoryLevel // The level of each category for this service (Required)
LatestCheckResults []CheckResult // The latest check results for this service across the given checks (Optional)
OverallLevel Level // The overall level for this service (Required)
}
ServiceMaturityReport The health report for this service in terms of its levels and checks
type ServiceNextLevel ¶
type ServiceNextLevel struct {
Level Level // The next level for a service to achieve (Optional)
}
ServiceNextLevel The next level for a service to achieve and the associated checks
type ServiceNoteUpdateInput ¶
type ServiceNoteUpdateInput struct {
Note *Nullable[string] `json:"note,omitempty" yaml:"note,omitempty" example:"example_value"` // Note about the service (Optional)
Service IdentifierInput `json:"service" yaml:"service"` // The identifier for the service (Required)
}
ServiceNoteUpdateInput Specifies the input fields used in the `serviceNoteUpdate` mutation
type ServiceNoteUpdatePayload ¶
type ServiceNoteUpdatePayload struct {
Service Service // A service represents software deployed in your production infrastructure (Optional)
BasePayload
}
ServiceNoteUpdatePayload Return type for the `serviceNoteUpdate` mutation
type ServiceOwnershipCheckFragment ¶
type ServiceOwnershipCheckFragment struct {
ContactMethod *ContactType `graphql:"contactMethod"` // The type of contact method that an owner should provide.
RequireContactMethod *bool `graphql:"requireContactMethod"` // Whether to require a contact method for a service owner or not.
TeamTagKey string `graphql:"tagKey"` // The tag key that should exist for a service owner.
TeamTagPredicate *Predicate `graphql:"tagPredicate"` // The condition that should be satisfied by the tag value.
}
type ServicePropertyCheckFragment ¶
type ServicePropertyCheckFragment struct {
Property ServicePropertyTypeEnum `graphql:"serviceProperty"` // The property of the service that the check will verify.
PropertyDefinition *PropertyDefinition `graphql:"propertyDefinition"` // The definition of a property.
Predicate *Predicate `graphql:"propertyValuePredicate"` // The condition that should be satisfied by the service property value.
}
type ServicePropertyTypeEnum ¶
type ServicePropertyTypeEnum string
ServicePropertyTypeEnum Properties of services that can be validated
var ( ServicePropertyTypeEnumCustomProperty ServicePropertyTypeEnum = "custom_property" // A custom property that is associated with the service ServicePropertyTypeEnumDescription ServicePropertyTypeEnum = "description" // The description of a service ServicePropertyTypeEnumFramework ServicePropertyTypeEnum = "framework" // The primary software development framework of a service ServicePropertyTypeEnumLanguage ServicePropertyTypeEnum = "language" // The primary programming language of a service ServicePropertyTypeEnumLifecycleIndex ServicePropertyTypeEnum = "lifecycle_index" // The index of the lifecycle a service belongs to ServicePropertyTypeEnumName ServicePropertyTypeEnum = "name" // The name of a service ServicePropertyTypeEnumNote ServicePropertyTypeEnum = "note" // Additional information about the service ServicePropertyTypeEnumProduct ServicePropertyTypeEnum = "product" // The product that is associated with a service ServicePropertyTypeEnumSystem ServicePropertyTypeEnum = "system" // The system that the service belongs to ServicePropertyTypeEnumTierIndex ServicePropertyTypeEnum = "tier_index" // The index of the tier a service belongs to )
type ServiceRepository ¶
type ServiceRepository struct {
BaseDirectory string // The directory in the repository where service information exists, including the opslevel.yml file. This path is always returned without leading and trailing slashes (Optional)
DisplayName string // The name displayed in the UI for the service repository (Optional)
Id ID // ID of the service repository (Required)
Repository RepositoryId // The repository that is part of this connection (Required)
Service ServiceId // The service that is part of this connection (Required)
}
ServiceRepository A record of the connection between a service and a repository
type ServiceRepositoryConnection ¶
type ServiceRepositoryConnection struct {
Edges []ServiceRepositoryEdge
PageInfo PageInfo
TotalCount int `graphql:"-"`
}
ServiceRepositoryConnection The connection type for Repository
type ServiceRepositoryCreateInput ¶
type ServiceRepositoryCreateInput struct {
BaseDirectory *Nullable[string] `json:"baseDirectory,omitempty" yaml:"baseDirectory,omitempty" example:"example_value"` // The directory in the repository where service information exists, including the opslevel.yml file. This path is always returned without leading and trailing slashes (Optional)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The name displayed in the UI for the service repository (Optional)
Repository IdentifierInput `json:"repository" yaml:"repository"` // The identifier for the repository (Required)
Service IdentifierInput `json:"service" yaml:"service"` // The identifier for the service (Required)
}
ServiceRepositoryCreateInput Specifies the input fields used in the `serviceRepositoryCreate` mutation
type ServiceRepositoryCreatePayload ¶
type ServiceRepositoryCreatePayload struct {
ServiceRepository ServiceRepository // A record of the connection between a service and a repository (Optional)
BasePayload
}
ServiceRepositoryCreatePayload Return type for the `serviceRepositoryCreate` mutation
type ServiceRepositoryEdge ¶
type ServiceRepositoryEdge struct {
Node RepositoryId
ServiceRepositories []ServiceRepository
}
type ServiceRepositoryUpdateInput ¶
type ServiceRepositoryUpdateInput struct {
BaseDirectory *Nullable[string] `json:"baseDirectory,omitempty" yaml:"baseDirectory,omitempty" example:"example_value"` // The directory in the repository where service information exists, including the opslevel.yml file. This path is always returned without leading and trailing slashes (Optional)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The name displayed in the UI for the service repository (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the service repository to be updated (Required)
}
ServiceRepositoryUpdateInput Specifies the input fields used to update a service repository
type ServiceRepositoryUpdatePayload ¶
type ServiceRepositoryUpdatePayload struct {
ServiceRepository ServiceRepository // The updated service repository (Optional)
BasePayload
}
ServiceRepositoryUpdatePayload The return type of the `serviceRepositoryUpdate` mutation
type ServiceSortEnum ¶
type ServiceSortEnum string
ServiceSortEnum Sort possibilities for services
var ( ServiceSortEnumAlertStatusAsc ServiceSortEnum = "alert_status_ASC" // Sort by alert status ascending ServiceSortEnumAlertStatusDesc ServiceSortEnum = "alert_status_DESC" // Sort by alert status descending ServiceSortEnumChecksPassingAsc ServiceSortEnum = "checks_passing_ASC" // Sort by `checks_passing` ascending ServiceSortEnumChecksPassingDesc ServiceSortEnum = "checks_passing_DESC" // Sort by `checks_passing` descending ServiceSortEnumComponentTypeAsc ServiceSortEnum = "component_type_ASC" // Sort by component type ascending ServiceSortEnumComponentTypeDesc ServiceSortEnum = "component_type_DESC" // Sort by component type descending ServiceSortEnumLastDeployAsc ServiceSortEnum = "last_deploy_ASC" // Sort by last deploy time ascending ServiceSortEnumLastDeployDesc ServiceSortEnum = "last_deploy_DESC" // Sort by last deploy time descending ServiceSortEnumLevelIndexAsc ServiceSortEnum = "level_index_ASC" // Sort by level ascending ServiceSortEnumLevelIndexDesc ServiceSortEnum = "level_index_DESC" // Sort by level descending ServiceSortEnumLifecycleAsc ServiceSortEnum = "lifecycle_ASC" // Sort by lifecycle ascending ServiceSortEnumLifecycleDesc ServiceSortEnum = "lifecycle_DESC" // Sort by lifecycle descending ServiceSortEnumNameAsc ServiceSortEnum = "name_ASC" // Sort by `name` ascending ServiceSortEnumNameDesc ServiceSortEnum = "name_DESC" // Sort by `name` descending ServiceSortEnumOwnerAsc ServiceSortEnum = "owner_ASC" // Sort by `owner` ascending ServiceSortEnumOwnerDesc ServiceSortEnum = "owner_DESC" // Sort by `owner` descending ServiceSortEnumProductAsc ServiceSortEnum = "product_ASC" // Sort by `product` ascending ServiceSortEnumProductDesc ServiceSortEnum = "product_DESC" // Sort by `product` descending ServiceSortEnumServiceStatAsc ServiceSortEnum = "service_stat_ASC" // Alias to sort by `checks_passing` ascending ServiceSortEnumServiceStatDesc ServiceSortEnum = "service_stat_DESC" // Alias to sort by `checks_passing` descending ServiceSortEnumTierAsc ServiceSortEnum = "tier_ASC" // Sort by `tier` ascending ServiceSortEnumTierDesc ServiceSortEnum = "tier_DESC" // Sort by `tier` descending )
type ServiceStats ¶
type ServiceStats struct {
Rubric RubricReport // The check result information for the service's rubric (Required)
}
ServiceStats The summary of check results for this service
type ServiceUpdateInput ¶
type ServiceUpdateInput struct {
Alias *Nullable[string] `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The alias of the service to be updated (Optional)
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // A brief description of the service (Optional)
Framework *Nullable[string] `json:"framework,omitempty" yaml:"framework,omitempty" example:"example_value"` // The primary software development framework that the service uses (Optional)
Id *Nullable[ID] `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the service to be updated (Optional)
Language *Nullable[string] `json:"language,omitempty" yaml:"language,omitempty" example:"example_value"` // The primary programming language that the service is written in (Optional)
LifecycleAlias *Nullable[string] `json:"lifecycleAlias,omitempty" yaml:"lifecycleAlias,omitempty" example:"example_value"` // The lifecycle stage of the service (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The display name of the service (Optional)
OwnerAlias *Nullable[string] `json:"ownerAlias,omitempty" yaml:"ownerAlias,omitempty" example:"example_value"` // The team that owns the service (Optional)
OwnerInput *IdentifierInput `json:"ownerInput,omitempty" yaml:"ownerInput,omitempty"` // The owner for the service (Optional)
Parent *IdentifierInput `json:"parent,omitempty" yaml:"parent,omitempty"` // The parent system for the service (Optional)
Product *Nullable[string] `json:"product,omitempty" yaml:"product,omitempty" example:"example_value"` // A product is an application that your end user interacts with. Multiple services can work together to power a single product (Optional)
SkipAliasesValidation *Nullable[bool] `json:"skipAliasesValidation,omitempty" yaml:"skipAliasesValidation,omitempty" example:"false"` // Allows updating a service with invalid aliases (Optional Default: false)
TierAlias *Nullable[string] `json:"tierAlias,omitempty" yaml:"tierAlias,omitempty" example:"example_value"` // The software tier that the service belongs to (Optional)
Type *IdentifierInput `json:"type,omitempty" yaml:"type,omitempty"` // The type of the component (Optional)
}
ServiceUpdateInput Specifies the input fields used in the `serviceUpdate` mutation
type ServiceUpdatePayload ¶
type ServiceUpdatePayload struct {
Service Service // The updated service (Optional)
BasePayload
}
ServiceUpdatePayload Return type for the `serviceUpdate` mutation
type SnykIntegrationInput ¶
type SnykIntegrationInput struct {
ApiKey *Nullable[string] `json:"apiKey,omitempty" yaml:"apiKey,omitempty" example:"example_value"` // The API Key for the Snyk API (Optional)
BaseUrl *Nullable[string] `json:"baseUrl,omitempty" yaml:"baseUrl,omitempty" example:"example_value"` // The base url for your Snyk installation (Optional)
GroupId *Nullable[string] `json:"groupId,omitempty" yaml:"groupId,omitempty" example:"example_value"` // The group ID for the Snyk API (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration (Optional)
Region *SnykIntegrationRegionEnum `json:"region,omitempty" yaml:"region,omitempty" example:"AU"` // The region in which your data is hosted (Optional)
}
SnykIntegrationInput Specifies the input fields used to create and update a Snyk integration
type SnykIntegrationRegionEnum ¶
type SnykIntegrationRegionEnum string
SnykIntegrationRegionEnum The data residency regions offered by Snyk
var ( SnykIntegrationRegionEnumAu SnykIntegrationRegionEnum = "AU" // Australia (https://api.au.snyk.io) SnykIntegrationRegionEnumEu SnykIntegrationRegionEnum = "EU" // Europe (https://api.eu.snyk.io) SnykIntegrationRegionEnumUs SnykIntegrationRegionEnum = "US" // USA (https://app.snyk.io) )
type SonarqubeCloudIntegrationInput ¶
type SonarqubeCloudIntegrationInput struct {
ApiKey *Nullable[string] `json:"apiKey,omitempty" yaml:"apiKey,omitempty" example:"example_value"` // The API Key for the SonarQube Cloud API (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration (Optional)
OrganizationKey *Nullable[string] `json:"organizationKey,omitempty" yaml:"organizationKey,omitempty" example:"example_value"` // The Organization Key for the SonarQube Cloud organization (Optional)
}
SonarqubeCloudIntegrationInput Specifies the input fields used to create and update a SonarQube Cloud integration
type SonarqubeIntegrationInput ¶
type SonarqubeIntegrationInput struct {
ApiKey *Nullable[string] `json:"apiKey,omitempty" yaml:"apiKey,omitempty" example:"example_value"` // The API Key for the SonarQube API (Optional)
BaseUrl *Nullable[string] `json:"baseUrl,omitempty" yaml:"baseUrl,omitempty" example:"example_value"` // The base URL for the SonarQube instance (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the integration (Optional)
}
SonarqubeIntegrationInput Specifies the input fields used to create and update a SonarQube integration
type Stats ¶
type Stats struct {
Total int // How many there are (Required)
TotalSuccessful int // How many are successfully passing (Required)
}
Stats An object that contains statistics
type System ¶
type System struct {
SystemId
Description string // The description of the System (Optional)
HtmlUrl string // A link to the HTML page for the resource. Ex. https://app.opslevel.com/services/shopping_cart (Required)
ManagedAliases []string // A list of aliases that can be set by users. The unique identifier for the resource is omitted (Required)
Name string // The name of the object (Required)
Note string // Additional information about the system (Optional)
Owner EntityOwner // The owner of the object (Optional)
Parent Domain // Parent domain of the System (Optional)
}
System A collection of related Services
func (*System) UniqueIdentifiers ¶
Returns unique identifiers created by OpsLevel, values in Aliases but not ManagedAliases
type SystemChildAssignPayload ¶
type SystemChildAssignPayload struct {
System System // The system after children have been assigned (Optional)
BasePayload
}
SystemChildAssignPayload Return type for the `systemChildAssign` mutation
type SystemChildRemovePayload ¶
type SystemChildRemovePayload struct {
System System // The system after children have been removed (Optional)
BasePayload
}
SystemChildRemovePayload Return type for the `systemChildRemove` mutation
type SystemConnection ¶
type SystemConnection ConnectionBase[System]
SystemConnection The connection type for System
type SystemId ¶
type SystemId struct {
Id ID // The identifier of the object.
Aliases []string // All of the aliases attached to the resource.
}
SystemId A collection of related Services
func (*SystemId) AliasableType ¶
func (systemId *SystemId) AliasableType() AliasOwnerTypeEnum
func (*SystemId) AssignService ¶
func (*SystemId) ChildServices ¶
func (systemId *SystemId) ChildServices(client *Client, variables *PayloadVariables) (*ServiceConnection, error)
func (*SystemId) GetAliases ¶
func (*SystemId) GetTags ¶
func (systemId *SystemId) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
func (*SystemId) ReconcileAliases ¶
func (*SystemId) ResourceId ¶
func (*SystemId) ResourceType ¶
func (systemId *SystemId) ResourceType() TaggableResource
type SystemInput ¶
type SystemInput struct {
Description *Nullable[string] `json:"description,omitempty" yaml:"description,omitempty" example:"example_value"` // The description for the system (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name for the system (Optional)
Note *Nullable[string] `json:"note,omitempty" yaml:"note,omitempty" example:"example_value"` // Additional information about the system (Optional)
OwnerId *Nullable[ID] `json:"ownerId,omitempty" yaml:"ownerId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the owner for the system (Optional)
Parent *IdentifierInput `json:"parent,omitempty" yaml:"parent,omitempty"` // The parent domain for the system (Optional)
}
SystemInput Specifies the input fields for a system
type SystemPayload ¶
type SystemPayload struct {
System System // A collection of related Services (Optional)
BasePayload
}
SystemPayload Return type for the `systemCreate` and `systemUpdate` mutations
type Tag ¶
type Tag struct {
Id ID // The unique identifier for the tag (Required)
Key string // The tag's key (Required)
Value string // The tag's value (Required)
}
Tag An arbitrary key-value pair associated with a resource
func (Tag) HasSameKeyValue ¶
type TagArgs ¶
type TagArgs struct {
Key *Nullable[string] `json:"key,omitempty" yaml:"key,omitempty" example:"example_value"` // The key of a tag (Optional)
Value *Nullable[string] `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // The value of a tag (Optional)
}
TagArgs Arguments used to query with a certain tag
func NewTagArgs ¶
type TagAssignInput ¶
type TagAssignInput struct {
Alias *Nullable[string] `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The alias of the resource that tags will be added to (Optional)
Id *Nullable[ID] `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the resource that the tags will be assigned to (Optional)
Tags []TagInput `json:"tags" yaml:"tags" example:"[]"` // The desired tags to assign to the resource (Required)
Type *TaggableResource `json:"type,omitempty" yaml:"type,omitempty" example:"Domain"` // The type of resource `alias` refers to, if `alias` is provided (Optional Default: Service)
}
TagAssignInput Specifies the input fields used to assign tags
type TagAssignPayload ¶
type TagAssignPayload struct {
Tags []Tag // The new tags that have been assigned to the resource (Optional)
BasePayload
}
TagAssignPayload The return type of a `tagAssign` mutation
type TagConnection ¶
type TagConnection ConnectionBase[Tag]
TagConnection The connection type for Tag
func (*TagConnection) GetTagById ¶
func (tagConnection *TagConnection) GetTagById(tagId ID) (*Tag, error)
type TagCreateInput ¶
type TagCreateInput struct {
Alias *string `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The alias of the resource that this tag will be added to (Optional)
Id *ID `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the resource that this tag will be added to (Optional)
Key string `json:"key" yaml:"key" example:"example_value"` // The tag's key (Required)
Type *TaggableResource `json:"type,omitempty" yaml:"type,omitempty" example:"Domain"` // The type of resource `alias` refers to, if `alias` is provided (Optional Default: Service)
Value string `json:"value" yaml:"value" example:"example_value"` // The tag's value (Required)
}
TagCreateInput Specifies the input fields used to create a tag
type TagCreatePayload ¶
type TagCreatePayload struct {
Tag Tag // The newly created tag (Optional)
BasePayload
}
TagCreatePayload The return type of a `tagCreate` mutation
type TagDefinedCheckFragment ¶
type TagDeleteInput ¶
type TagDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the tag to be deleted (Required)
}
TagDeleteInput Specifies the input fields used to delete a tag
type TagInput ¶
type TagInput struct {
Key string `json:"key" yaml:"key" example:"example_value"` // The tag's key (Required)
Value string `json:"value" yaml:"value" example:"example_value"` // The tag's value (Required)
}
TagInput Specifies the basic input fields used to construct a tag
type TagOwner ¶
type TagOwner struct {
Domain DomainId `graphql:"... on Domain"`
InfrastructureResource InfrastructureResourceId `graphql:"... on InfrastructureResource"`
Repository Repository `graphql:"... on Repository"`
Service Service `graphql:"... on Service"`
System SystemId `graphql:"... on System"`
Team TeamId `graphql:"... on Team"`
User UserId `graphql:"... on User"`
}
TagOwner represents a resource that a tag can be applied to.
type TagRelationshipKeys ¶
type TagRelationshipKeys struct {
BelongsTo string // The tag key that will create `belongs_to` relationships (Required)
DependencyOf []string // The tag keys that will create `dependency_of` relationships (Required)
DependsOn []string // The tag keys that will create `depends_on` relationships (Required)
}
TagRelationshipKeys Returns the keys that set relationships when imported from AWS
type TagRelationshipKeysAssignInput ¶
type TagRelationshipKeysAssignInput struct {
BelongsTo *Nullable[string] `json:"belongsTo,omitempty" yaml:"belongsTo,omitempty" example:"example_value"` // (Optional)
DependencyOf *Nullable[[]string] `json:"dependencyOf,omitempty" yaml:"dependencyOf,omitempty" example:"[]"` // (Optional)
DependsOn *Nullable[[]string] `json:"dependsOn,omitempty" yaml:"dependsOn,omitempty" example:"[]"` // (Optional)
}
TagRelationshipKeysAssignInput The input for the `tagRelationshipKeysAssign` mutation
type TagRepositoryConnection ¶
type TagRepositoryConnection ConnectionBase[Tag]
TagRepositoryConnection The connection type for Tag
type TagUpdateInput ¶
type TagUpdateInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the tag to be updated (Required)
Key *string `json:"key,omitempty" yaml:"key,omitempty" example:"example_value"` // The tag's key (Optional)
Value *string `json:"value,omitempty" yaml:"value,omitempty" example:"example_value"` // The tag's value (Optional)
}
TagUpdateInput Specifies the input fields used to update a tag
type TagUpdatePayload ¶
type TagUpdatePayload struct {
Tag Tag // The newly updated tag (Optional)
BasePayload
}
TagUpdatePayload The return type of a `tagUpdate` mutation
type TaggableResource ¶
type TaggableResource string
TaggableResource Possible types to apply tags to
var ( TaggableResourceDomain TaggableResource = "Domain" // Used to identify a Domain TaggableResourceInfrastructureresource TaggableResource = "InfrastructureResource" // Used to identify an Infrastructure Resource TaggableResourceRepository TaggableResource = "Repository" // Used to identify a Repository TaggableResourceService TaggableResource = "Service" // Used to identify a Service TaggableResourceSystem TaggableResource = "System" // Used to identify a System TaggableResourceTeam TaggableResource = "Team" // Used to identify a Team TaggableResourceUser TaggableResource = "User" // Used to identify a User )
type TaggableResourceInterface ¶
type TaggableResourceInterface interface {
GetTags(*Client, *PayloadVariables) (*TagConnection, error)
ResourceId() ID
ResourceType() TaggableResource
}
type Team ¶
type Team struct {
TeamId
Aliases []string `graphql:"aliases" json:"aliases" yaml:"aliases"`
ManagedAliases []string `graphql:"managedAliases" json:"managedAliases" yaml:"managedAliases"`
Contacts []Contact
HTMLUrl string
Manager User // Deprecated: Use .GetMemberships() and Memberships field instead.
Memberships *TeamMembershipConnection
Name string
ParentTeam TeamId
Responsibilities string
Tags *TagConnection
}
func (*Team) AliasableType ¶
func (team *Team) AliasableType() AliasOwnerTypeEnum
func (*Team) GetAliases ¶
func (*Team) GetMemberships ¶
func (team *Team) GetMemberships(client *Client, variables *PayloadVariables) (*TeamMembershipConnection, error)
func (*Team) GetTags ¶
func (team *Team) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
func (*Team) ReconcileAliases ¶
func (*Team) ResourceId ¶
func (*Team) ResourceType ¶
func (team *Team) ResourceType() TaggableResource
func (*Team) UniqueIdentifiers ¶
Returns unique identifiers created by OpsLevel, values in Aliases but not ManagedAliases
type TeamConnection ¶
type TeamConnection ConnectionBase[Team]
TeamConnection The connection type for Team
type TeamCreateInput ¶
type TeamCreateInput struct {
Contacts *[]ContactInput `json:"contacts,omitempty" yaml:"contacts,omitempty" example:"[]"` // The contacts for the team (Optional)
Group *IdentifierInput `json:"group,omitempty" yaml:"group,omitempty"` // The group this team belongs to (Optional)
ManagerEmail *Nullable[string] `json:"managerEmail,omitempty" yaml:"managerEmail,omitempty" example:"example_value"` // The email of the user who manages the team (Optional)
Members *[]TeamMembershipUserInput `json:"members,omitempty" yaml:"members,omitempty" example:"[]"` // A set of emails that identify users in OpsLevel (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The team's display name (Required)
ParentTeam *IdentifierInput `json:"parentTeam,omitempty" yaml:"parentTeam,omitempty"` // The parent team (Optional)
Responsibilities *Nullable[string] `json:"responsibilities,omitempty" yaml:"responsibilities,omitempty" example:"example_value"` // A description of what the team is responsible for (Optional)
}
TeamCreateInput Specifies the input fields used to create a team
type TeamCreatePayload ¶
type TeamCreatePayload struct {
Team Team // A team belongs to your organization. Teams can own multiple services (Optional)
BasePayload
}
TeamCreatePayload The return type of a `teamCreate` mutation
type TeamDeleteInput ¶
type TeamDeleteInput struct {
Alias *Nullable[string] `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The alias of the team to be deleted (Optional)
Id *Nullable[ID] `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team to be deleted (Optional)
}
TeamDeleteInput Specifies the input fields used to delete a team
type TeamIdConnection ¶
type TeamIdConnection ConnectionBase[TeamId]
TeamIdConnection exists to prevent circular references on User because Team has a UserConnection
type TeamMembership ¶
type TeamMembership struct {
Role string // Role of the user on the Team (Optional)
Team TeamId // Team for the membership (Required)
User UserId // User for the membership (Required)
}
TeamMembership
type TeamMembershipConnection ¶
type TeamMembershipConnection ConnectionBase[TeamMembership]
TeamMembershipConnection The connection type for TeamMembership
type TeamMembershipCreateInput ¶
type TeamMembershipCreateInput struct {
Members []TeamMembershipUserInput `json:"members" yaml:"members" example:"[]"` // A set of emails that identify users in OpsLevel (Required)
TeamId ID `json:"teamId" yaml:"teamId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the team to add members (Required)
}
TeamMembershipCreateInput Input for adding members to a team
type TeamMembershipCreatePayload ¶
type TeamMembershipCreatePayload struct {
Members []User // A list of users that are a member of the team (Optional)
Memberships []TeamMembership // A list of memberships on the team (Optional)
BasePayload
}
TeamMembershipCreatePayload The response returned when creating memberships on teams
type TeamMembershipDeleteInput ¶
type TeamMembershipDeleteInput struct {
Members []TeamMembershipUserInput `json:"members" yaml:"members" example:"[]"` // A set of emails that identify users in OpsLevel (Required)
TeamId ID `json:"teamId" yaml:"teamId" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the team to remove members from (Required)
}
TeamMembershipDeleteInput Input for removing members from a team
type TeamMembershipUserInput ¶
type TeamMembershipUserInput struct {
Email *Nullable[string] `json:"email,omitempty" yaml:"email,omitempty" example:"example_value"` // The user's email (Optional)
Role *Nullable[string] `json:"role,omitempty" yaml:"role,omitempty" example:"example_value"` // The type of relationship this membership implies (Optional)
User *UserIdentifierInput `json:"user,omitempty" yaml:"user,omitempty"` // The email address or ID of the user to add to a team (Optional)
}
TeamMembershipUserInput Input for specifying members on a team
type TeamPropertyDefinition ¶
type TeamPropertyDefinition struct {
Alias string // The human-friendly, unique identifier of the property definition (Required)
Description string // The description of the property definition (Required)
DisplaySubtype PropertyDefinitionDisplayTypeEnum // The secondary inferred type of the schema (Optional)
DisplayType PropertyDefinitionDisplayTypeEnum // The primary inferred type of the schema (Required)
Id ID // The id of the property definition (Required)
LockedStatus PropertyLockedStatusEnum // Restricts what sources are able to assign values to this property (Required)
Name string // The name of the property definition (Required)
Schema JSONSchema `scalar:"true"` // The schema of the property definition (Required)
}
TeamPropertyDefinition The definition of a property
type TeamPropertyDefinitionConnection ¶
type TeamPropertyDefinitionConnection ConnectionBase[TeamPropertyDefinition]
TeamPropertyDefinitionConnection The connection type for TeamPropertyDefinition
type TeamPropertyDefinitionInput ¶
type TeamPropertyDefinitionInput struct {
Alias string `json:"alias" yaml:"alias" example:"example_value"` // The human-friendly, unique identifier for the resource (Required)
Description string `json:"description" yaml:"description" example:"example_value"` // The description of the property definition (Required)
LockedStatus *PropertyLockedStatusEnum `json:"lockedStatus,omitempty" yaml:"lockedStatus,omitempty" example:"ui_locked"` // Restricts what sources are able to assign values to this property (Optional)
Name string `json:"name" yaml:"name" example:"example_value"` // The name of the property definition (Required)
Schema JSONSchema `json:"schema" yaml:"schema" example:"SCHEMA_TBD"` // The schema of the property definition (Required)
}
TeamPropertyDefinitionInput The input for defining a property
type TeamPropertyDefinitionPayload ¶
type TeamPropertyDefinitionPayload struct {
Definition TeamPropertyDefinition // The team property that was defined (Optional)
BasePayload
}
TeamPropertyDefinitionPayload The return type for team property definition mutations
type TeamPropertyDefinitionsAssignInput ¶
type TeamPropertyDefinitionsAssignInput struct {
Properties []TeamPropertyDefinitionInput `json:"properties" yaml:"properties" example:"[]"` // A list of property definitions (Required)
}
TeamPropertyDefinitionsAssignInput Specifies the input fields used to define properties that apply to teams
type TeamUpdateInput ¶
type TeamUpdateInput struct {
Alias *string `json:"alias,omitempty" yaml:"alias,omitempty" example:"example_value"` // The alias of the team to be updated (Optional)
Group *IdentifierInput `json:"group,omitempty" yaml:"group,omitempty"` // The group this team belongs to (Optional)
Id *ID `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the team to be updated (Optional)
ManagerEmail *Nullable[string] `json:"managerEmail,omitempty" yaml:"managerEmail,omitempty" example:"example_value"` // The email of the user who manages the team (Optional)
Members *[]TeamMembershipUserInput `json:"members,omitempty" yaml:"members,omitempty" example:"[]"` // A set of emails that identify users in OpsLevel (Optional)
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The team's display name (Optional)
ParentTeam *IdentifierInput `json:"parentTeam,omitempty" yaml:"parentTeam,omitempty"` // The parent team (Optional)
Responsibilities *Nullable[string] `json:"responsibilities,omitempty" yaml:"responsibilities,omitempty" example:"example_value"` // A description of what the team is responsible for (Optional)
}
TeamUpdateInput Specifies the input fields used to update a team
type TeamUpdatePayload ¶
type TeamUpdatePayload struct {
Team Team // A team belongs to your organization. Teams can own multiple services (Optional)
BasePayload
}
TeamUpdatePayload The return type of a `teamUpdate` mutation
type Tier ¶
type Tier struct {
Alias string // The human-friendly, unique identifier for the tier (Optional)
Description string // A brief description of the tier (Optional)
Id ID // The unique identifier for the tier (Required)
Index int // The numerical representation of the tier (Optional)
Name string // The display name of the tier (Optional)
}
Tier A tier measures how critical or important a service is to your business
type Timestamps ¶
type Timestamps struct {
CreatedAt iso8601.Time // The time at which the entity was created (Required)
UpdatedAt iso8601.Time // The time at which the entity was most recently updated (Required)
}
Timestamps Relevant timestamps
type Tool ¶
type Tool struct {
Category ToolCategory // The category that the tool belongs to (Optional)
CategoryAlias string // The human-friendly, unique identifier for the tool's category (Optional)
DisplayName string // The display name of the tool (Optional)
Environment string // The environment that the tool belongs to (Optional)
Id ID // The unique identifier for the tool (Required)
Service ServiceId // The service that is associated to the tool (Required)
Url string // The URL of the tool (Required)
}
Tool A tool is used to support the operations of a service
type ToolCategory ¶
type ToolCategory string
ToolCategory The specific categories that a tool can belong to
var ( ToolCategoryAdmin ToolCategory = "admin" // Tools used for administrative purposes ToolCategoryAPIDocumentation ToolCategory = "api_documentation" // Tools used as API documentation for this service ToolCategoryArchitectureDiagram ToolCategory = "architecture_diagram" // Tools used for diagramming architecture ToolCategoryBacklog ToolCategory = "backlog" // Tools used for tracking issues ToolCategoryCode ToolCategory = "code" // Tools used for source code ToolCategoryContinuousIntegration ToolCategory = "continuous_integration" // Tools used for building/unit testing a service ToolCategoryDeployment ToolCategory = "deployment" // Tools used for deploying changes to a service ToolCategoryDesignDocumentation ToolCategory = "design_documentation" // Tools used for documenting design ToolCategoryErrors ToolCategory = "errors" // Tools used for tracking/reporting errors ToolCategoryFeatureFlag ToolCategory = "feature_flag" // Tools used for managing feature flags ToolCategoryHealthChecks ToolCategory = "health_checks" // Tools used for tracking/reporting the health of a service ToolCategoryIncidents ToolCategory = "incidents" // Tools used to surface incidents on a service ToolCategoryIssueTracking ToolCategory = "issue_tracking" // Tools used for tracking issues ToolCategoryLogs ToolCategory = "logs" // Tools used for displaying logs from services ToolCategoryMetrics ToolCategory = "metrics" // Tools used for tracking/reporting service metrics ToolCategoryObservability ToolCategory = "observability" // Tools used for observability ToolCategoryOrchestrator ToolCategory = "orchestrator" // Tools used for orchestrating a service ToolCategoryOther ToolCategory = "other" // Tools that do not fit into the available categories ToolCategoryResiliency ToolCategory = "resiliency" // Tools used for testing the resiliency of a service ToolCategoryRunbooks ToolCategory = "runbooks" // Tools used for managing runbooks for a service ToolCategorySecurityScans ToolCategory = "security_scans" // Tools used for performing security scans ToolCategoryStatusPage ToolCategory = "status_page" // Tools used for reporting the status of a service ToolCategoryWiki ToolCategory = "wiki" // Tools used as a wiki for this service )
type ToolConnection ¶
type ToolConnection ConnectionBase[Tool]
ToolConnection The connection type for Tool
type ToolCreateInput ¶
type ToolCreateInput struct {
Category ToolCategory `json:"category" yaml:"category" example:"admin"` // The category that the tool belongs to (Required)
DisplayName string `json:"displayName" yaml:"displayName" example:"example_value"` // The display name of the tool (Required)
Environment *Nullable[string] `json:"environment,omitempty" yaml:"environment,omitempty" example:"example_value"` // The environment that the tool belongs to (Optional)
ServiceAlias *string `json:"serviceAlias,omitempty" yaml:"serviceAlias,omitempty" example:"example_value"` // The alias of the service the tool will be assigned to (Optional)
ServiceId *ID `json:"serviceId,omitempty" yaml:"serviceId,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the service the tool will be assigned to (Optional)
Url string `json:"url" yaml:"url" example:"example_value"` // The URL of the tool (Required)
}
ToolCreateInput Specifies the input fields used to create a tool
type ToolCreatePayload ¶
type ToolCreatePayload struct {
Tool Tool // A tool is used to support the operations of a service (Optional)
BasePayload
}
ToolCreatePayload The return type of a `toolCreate` mutation
type ToolDeleteInput ¶
type ToolDeleteInput struct {
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the tool to be deleted (Required)
}
ToolDeleteInput Specifies the input fields used to delete a tool
type ToolUpdateInput ¶
type ToolUpdateInput struct {
Category *ToolCategory `json:"category,omitempty" yaml:"category,omitempty" example:"admin"` // The category that the tool belongs to (Optional)
DisplayName *Nullable[string] `json:"displayName,omitempty" yaml:"displayName,omitempty" example:"example_value"` // The display name of the tool (Optional)
Environment *Nullable[string] `json:"environment,omitempty" yaml:"environment,omitempty" example:"example_value"` // The environment that the tool belongs to (Optional)
Id ID `json:"id" yaml:"id" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The id of the tool to be updated (Required)
Url *Nullable[string] `json:"url,omitempty" yaml:"url,omitempty" example:"example_value"` // The URL of the tool (Optional)
}
ToolUpdateInput Specifies the input fields used to update a tool
type ToolUpdatePayload ¶
type ToolUpdatePayload struct {
Tool Tool // A tool is used to support the operations of a service (Optional)
BasePayload
}
ToolUpdatePayload The return type of a `toolUpdate` payload
type ToolUsageCheckFragment ¶
type ToolUsageCheckFragment struct {
EnvironmentPredicate *Predicate `graphql:"environmentPredicate"` // The condition that the environment should satisfy to be evaluated.
ToolCategory ToolCategory `graphql:"toolCategory"` // The category that the tool belongs to.
ToolNamePredicate *Predicate `graphql:"toolNamePredicate"` // The condition that the tool name should satisfy to be evaluated.
ToolUrlPredicate *Predicate `graphql:"toolUrlPredicate"` // The condition that the tool url should satisfy to be evaluated.
}
type TypeEnum ¶
type TypeEnum string
TypeEnum Operations that can be used on filters
var ( TypeEnumBelongsTo TypeEnum = "belongs_to" // Belongs to a group's hierarchy TypeEnumContains TypeEnum = "contains" // Contains a specific value TypeEnumDoesNotContain TypeEnum = "does_not_contain" // Does not contain a specific value TypeEnumDoesNotEqual TypeEnum = "does_not_equal" // Does not equal a specific value TypeEnumDoesNotExist TypeEnum = "does_not_exist" // Specific attribute does not exist TypeEnumDoesNotMatch TypeEnum = "does_not_match" // A certain filter is not matched TypeEnumDoesNotMatchRegex TypeEnum = "does_not_match_regex" // Does not match a value using a regular expression TypeEnumEndsWith TypeEnum = "ends_with" // Ends with a specific value TypeEnumEquals TypeEnum = "equals" // Equals a specific value TypeEnumExists TypeEnum = "exists" // Specific attribute exists TypeEnumGreaterThanOrEqualTo TypeEnum = "greater_than_or_equal_to" // Greater than or equal to a specific value (numeric only) TypeEnumLessThanOrEqualTo TypeEnum = "less_than_or_equal_to" // Less than or equal to a specific value (numeric only) TypeEnumMatches TypeEnum = "matches" // A certain filter is matched TypeEnumMatchesRegex TypeEnum = "matches_regex" // Matches a value using a regular expression TypeEnumSatisfiesJqExpression TypeEnum = "satisfies_jq_expression" // Satisfies an expression defined in jq (property value only) TypeEnumSatisfiesVersionConstraint TypeEnum = "satisfies_version_constraint" // Satisfies version constraint (tag value only) TypeEnumStartsWith TypeEnum = "starts_with" // Starts with a specific value )
type User ¶
type User struct {
UserId
Contacts []Contact // The contacts for the user (Optional)
HtmlUrl string // A link to the HTML page for the resource. Ex. https://app.opslevel.com/services/shopping_cart (Required)
ProvisionedBy ProvisionedByEnum // What provisioned this user (Optional)
Role UserRole // The user's assigned role (Optional)
}
User A user is someone who belongs to an organization
func (*User) ResourceId ¶
func (*User) ResourceType ¶
func (user *User) ResourceType() TaggableResource
func (*User) Teams ¶
func (user *User) Teams(client *Client, variables *PayloadVariables) (*TeamIdConnection, error)
type UserConnection ¶
type UserConnection ConnectionBase[User]
UserConnection The connection type for User
type UserId ¶
type UserId struct {
Id ID // The unique identifier for the user.
Email string // The user's email.
Name string // The user's full name (Required)
}
UserId A user is someone who belongs to an organization
func (*UserId) GetTags ¶
func (userId *UserId) GetTags(client *Client, variables *PayloadVariables) (*TagConnection, error)
type UserIdentifierInput ¶
type UserIdentifierInput struct {
Email *Nullable[string] `json:"email,omitempty" yaml:"email,omitempty" example:"example_value"` // The email address of the user (Optional)
Id *Nullable[ID] `json:"id,omitempty" yaml:"id,omitempty" example:"Z2lkOi8vc2VydmljZS8xMjM0NTY3ODk"` // The ID of the user (Optional)
}
UserIdentifierInput Specifies the input fields used to identify a user. Exactly one field should be provided
func NewUserIdentifier ¶
func NewUserIdentifier(value string) *UserIdentifierInput
type UserInput ¶
type UserInput struct {
Name *Nullable[string] `json:"name,omitempty" yaml:"name,omitempty" example:"example_value"` // The name of the user (Optional)
Role *UserRole `json:"role,omitempty" yaml:"role,omitempty" example:"admin"` // The access role (e.g. user vs admin) of the user (Optional)
SkipWelcomeEmail *Nullable[bool] `json:"skipWelcomeEmail,omitempty" yaml:"skipWelcomeEmail,omitempty" example:"false"` // Don't send an email welcoming the user to OpsLevel (Optional)
}
UserInput Specifies the input fields used to create and update a user
type UserPayload ¶
type UserPayload struct {
User User // A user is someone who belongs to an organization (Optional)
BasePayload
}
UserPayload The return type of user management mutations
type UserRole ¶
type UserRole string
UserRole A role that can be assigned to a user
var ( UserRoleAdmin UserRole = "admin" // An administrator on the account UserRoleStandardsAdmin UserRole = "standards_admin" // Full write access to Standards resources, including rubric, campaigns, and checks. User-level access to all other entities UserRoleTeamMember UserRole = "team_member" // Read access to all resources. Write access based on team membership UserRoleUser UserRole = "user" // A regular user on the account )
type UsersFilterEnum ¶
type UsersFilterEnum string
UsersFilterEnum Fields that can be used as part of filter for users
var ( UsersFilterEnumDeactivatedAt UsersFilterEnum = "deactivated_at" // Filter by the `deactivated_at` field UsersFilterEnumEmail UsersFilterEnum = "email" // Filter by `email` field UsersFilterEnumLastSignInAt UsersFilterEnum = "last_sign_in_at" // Filter by the `last_sign_in_at` field UsersFilterEnumName UsersFilterEnum = "name" // Filter by `name` field UsersFilterEnumRole UsersFilterEnum = "role" // Filter by `role` field. (user or admin) UsersFilterEnumTag UsersFilterEnum = "tag" // Filter by `tags` belonging to user )
type UsersFilterInput ¶
type UsersFilterInput struct {
Arg *Nullable[string] `json:"arg,omitempty" yaml:"arg,omitempty" example:"example_value"` // Value to be filtered (Optional)
Key UsersFilterEnum `json:"key" yaml:"key" example:"deactivated_at"` // Field to be filtered (Required)
Type *BasicTypeEnum `json:"type,omitempty" yaml:"type,omitempty" example:"does_not_equal"` // The operation applied to value on the field (Optional Default: equals)
}
UsersFilterInput The input for filtering users
type UsersInviteInput ¶
type UsersInviteInput struct {
Scope *UsersInviteScopeEnum `json:"scope,omitempty" yaml:"scope,omitempty" example:"pending"` // A classification of users to invite (Optional)
Users *[]UserIdentifierInput `json:"users,omitempty" yaml:"users,omitempty" example:"[]"` // A list of individual users to invite (Optional)
}
UsersInviteInput Specifies the input fields used in the `usersInvite` mutation
type UsersInvitePayload ¶
type UsersInvitePayload struct {
Failed []string // The user identifiers which failed to successfully send an invite (Optional)
Users []User // The users that were successfully invited (Optional)
BasePayload
}
UsersInvitePayload The return type of the users invite mutation
type UsersInviteScopeEnum ¶
type UsersInviteScopeEnum string
UsersInviteScopeEnum A classification of users to invite
var UsersInviteScopeEnumPending UsersInviteScopeEnum = "pending" // All users who have yet to log in to OpsLevel for the first time
type VaultSecretsSortEnum ¶
type VaultSecretsSortEnum string
VaultSecretsSortEnum Sort possibilities for secrets
var ( VaultSecretsSortEnumSlugAsc VaultSecretsSortEnum = "slug_ASC" // Sort by slug ascending VaultSecretsSortEnumSlugDesc VaultSecretsSortEnum = "slug_DESC" // Sort by slug descending VaultSecretsSortEnumUpdatedAtAsc VaultSecretsSortEnum = "updated_at_ASC" // Sort by updated_at ascending VaultSecretsSortEnumUpdatedAtDesc VaultSecretsSortEnum = "updated_at_DESC" // Sort by updated_at descending )
Source Files
¶
- actions.go
- alert_source.go
- aliases.go
- cache.go
- campaign.go
- category.go
- check.go
- check_alert_source_usage.go
- check_code_issue.go
- check_custom_event.go
- check_git_branch_protection.go
- check_has_documentation.go
- check_has_owner.go
- check_has_recent_deploy.go
- check_has_repository.go
- check_manual.go
- check_package_version.go
- check_relationship.go
- check_repo_file.go
- check_repo_grep.go
- check_repo_search.go
- check_service_config.go
- check_service_dependency.go
- check_service_property.go
- check_tag_defined.go
- check_tool_usage.go
- client.go
- clientGQL.go
- clientRest.go
- common.go
- component.go
- connection.go
- dependencies.go
- doc.go
- document.go
- domain.go
- enum.go
- errors.go
- filters.go
- infra.go
- input.go
- integration.go
- interfaces.go
- job.go
- json.go
- level.go
- lifecycle.go
- maturity.go
- object.go
- owner.go
- payload.go
- predicate.go
- property.go
- relationship.go
- repository.go
- scalar.go
- scorecards.go
- secrets.go
- service.go
- system.go
- tags.go
- team.go
- tier.go
- tools.go
- union.go
- user.go
- utils.go
- version.go