Versions in this module Expand all Collapse all v5 v5.0.0 Mar 28, 2023 Changes in this version + const ActivationNetworkProduction + const ActivationNetworkStaging + const ActivationStatusAborted + const ActivationStatusActive + const ActivationStatusCancelling + const ActivationStatusDeactivated + const ActivationStatusDeactivating + const ActivationStatusFailed + const ActivationStatusInactive + const ActivationStatusNew + const ActivationStatusPending + const ActivationStatusZone1 + const ActivationStatusZone2 + const ActivationStatusZone3 + const ActivationTypeActivate + const ActivationTypeDeactivate + const EHIPVersionV4 + const EHIPVersionV6Compliance + const EHIPVersionV6Performance + const EHSecureNetworkEnhancedTLS + const EHSecureNetworkSharedCert + const EHSecureNetworkStandardTLS + const NoncomplianceReasonEmergency + const NoncomplianceReasonNoProductionTraffic + const NoncomplianceReasonNone + const NoncomplianceReasonOther + const RuleCriteriaMustSatisfyAll + const RuleCriteriaMustSatisfyAny + const RuleValidateModeFast + const RuleValidateModeFull + const SearchKeyEdgeHostname + const SearchKeyHostname + const SearchKeyPropertyName + const UseCaseGlobal + var ErrActivateInclude = errors.New("activate include") + var ErrCancelActivation = errors.New("canceling activation") + var ErrCancelIncludeActivation = errors.New("cancel include activation") + var ErrCreateActivation = errors.New("creating activation") + var ErrCreateCPCode = errors.New("creating CP Code") + var ErrCreateEdgeHostname = errors.New("creating edge hostname") + var ErrCreateInclude = errors.New("create an Include") + var ErrCreateIncludeVersion = errors.New("create an include version") + var ErrCreateProperty = errors.New("creating property") + var ErrCreatePropertyVersion = errors.New("creating property version") + var ErrDeactivateInclude = errors.New("deactivate include") + var ErrDefaultCertLimitReached = errors.New("the limit for DEFAULT certificates has been reached") + var ErrDeleteInclude = errors.New("delete an Include") + var ErrGetActivation = errors.New("fetching activation") + var ErrGetActivations = errors.New("fetching activations") + var ErrGetAvailableBehaviors = errors.New("fetching available behaviors") + var ErrGetAvailableCriteria = errors.New("fetching available criteria") + var ErrGetCPCode = errors.New("fetching CP Code") + var ErrGetCPCodeDetail = errors.New("fetching CP Code Detail") + var ErrGetCPCodes = errors.New("fetching CP Codes") + var ErrGetClientSettings = errors.New("fetching client settings") + var ErrGetContracts = errors.New("fetching contracts") + var ErrGetEdgeHostname = errors.New("fetching edge hostname") + var ErrGetEdgeHostnames = errors.New("fetching edge hostnames") + var ErrGetGroups = errors.New("fetching groups") + var ErrGetInclude = errors.New("get an Include") + var ErrGetIncludeActivation = errors.New("get include activation") + var ErrGetIncludeRuleTree = errors.New("fetching include rule tree") + var ErrGetIncludeVersion = errors.New("get an include version") + var ErrGetLatestVersion = errors.New("fetching latest property version") + var ErrGetProducts = errors.New("fetching products") + var ErrGetProperties = errors.New("fetching properties") + var ErrGetProperty = errors.New("fetching property") + var ErrGetPropertyVersion = errors.New("fetching property version") + var ErrGetPropertyVersionHostnames = errors.New("fetching hostnames") + var ErrGetPropertyVersions = errors.New("fetching property versions") + var ErrGetRuleFormats = errors.New("fetching rule formats") + var ErrGetRuleTree = errors.New("fetching rule tree") + var ErrInvalidResponseLink = errors.New("response link URL is invalid") + var ErrListAvailableIncludes = errors.New("fetching available includes") + var ErrListIncludeActivations = errors.New("list include activations") + var ErrListIncludeParents = errors.New("list Include Parents") + var ErrListIncludeVersionAvailableBehaviors = errors.New("list include version available behaviors") + var ErrListIncludeVersionAvailableCriteria = errors.New("list include version available criteria") + var ErrListIncludeVersions = errors.New("list include versions") + var ErrListIncludes = errors.New("list Includes") + var ErrListReferencedIncludes = errors.New("fetching referenced includes") + var ErrNotFound = errors.New("resource not found") + var ErrRemoveProperty = errors.New("removing property") + var ErrSBDNotEnabled = errors.New("secure-by-default is not enabled") + var ErrSearchProperties = errors.New("searching for properties") + var ErrStructValidation = errors.New("struct validation") + var ErrUpdateCPCode = errors.New("updating CP Code") + var ErrUpdateClientSettings = errors.New("updating client settings") + var ErrUpdateIncludeRuleTree = errors.New("updating include rule tree") + var ErrUpdatePropertyVersionHostnames = errors.New("updating hostnames") + var ErrUpdateRuleTree = errors.New("updating rule tree") + func ResponseLinkParse(link string) (string, error) + type ActivateIncludeRequest ActivateOrDeactivateIncludeRequest + func (i ActivateIncludeRequest) Validate() error + type ActivateOrDeactivateIncludeRequest struct + AcknowledgeAllWarnings bool + AcknowledgeWarnings []string + ComplianceRecord complianceRecord + IgnoreHTTPErrors *bool + IncludeID string + Network ActivationNetwork + Note string + NotifyEmails []string + Version int + type Activation struct + AccountID string + AcknowledgeAllWarnings bool + AcknowledgeWarnings []string + ActivationID string + ActivationType ActivationType + ComplianceRecord complianceRecord + FMAActivationState string + FallbackInfo *ActivationFallbackInfo + FastPush bool + GroupID string + IgnoreHTTPErrors bool + Network ActivationNetwork + Note string + NotifyEmails []string + PropertyID string + PropertyName string + PropertyVersion int + Status ActivationStatus + SubmitDate string + UpdateDate string + UseFastFallback bool + type ActivationFallbackInfo struct + CanFastFallback bool + FallbackVersion int + FastFallbackAttempted bool + FastFallbackExpirationTime int + FastFallbackRecoveryState *string + SteadyStateTime int + type ActivationIncludeResponse struct + ActivationID string + ActivationLink string + type ActivationNetwork string + type ActivationStatus string + type ActivationType string + type Activations interface + CancelActivation func(context.Context, CancelActivationRequest) (*CancelActivationResponse, error) + CreateActivation func(context.Context, CreateActivationRequest) (*CreateActivationResponse, error) + GetActivation func(context.Context, GetActivationRequest) (*GetActivationResponse, error) + GetActivations func(ctx context.Context, params GetActivationsRequest) (*GetActivationsResponse, error) + type ActivationsItems struct + Items []*Activation + type AvailableBehaviors struct + Items []Behavior + type AvailableBehaviorsResponse struct + AvailableBehaviors AvailableBehaviors + ContractID string + GroupID string + ProductID string + RuleFormat string + type AvailableCriteria struct + Items []Criteria + type AvailableCriteriaResponse struct + AvailableCriteria AvailableCriteria + ContractID string + GroupID string + ProductID string + RuleFormat string + type Behavior struct + Name string + SchemaLink string + type CPCode struct + CreatedDate string + ID string + Name string + ProductIDs []string + type CPCodeContract struct + ContractID string + Status string + func (contract CPCodeContract) Validate() error + type CPCodeDetailResponse struct + AccountID string + Contracts []CPCodeContract + DefaultTimeZone string + ID int + Name string + OverrideTimeZone CPCodeTimeZone + Products []CPCodeProduct + Purgeable bool + Type string + type CPCodeItems struct + Items []CPCode + type CPCodeProduct struct + ProductID string + ProductName string + func (product CPCodeProduct) Validate() error + type CPCodeTimeZone struct + TimeZoneID string + TimeZoneValue string + func (timeZone CPCodeTimeZone) Validate() error + type CPCodes interface + CreateCPCode func(context.Context, CreateCPCodeRequest) (*CreateCPCodeResponse, error) + GetCPCode func(context.Context, GetCPCodeRequest) (*GetCPCodesResponse, error) + GetCPCodeDetail func(context.Context, int) (*CPCodeDetailResponse, error) + GetCPCodes func(context.Context, GetCPCodesRequest) (*GetCPCodesResponse, error) + UpdateCPCode func(context.Context, UpdateCPCodeRequest) (*CPCodeDetailResponse, error) + type CancelActivationRequest struct + ActivationID string + ContractID string + GroupID string + PropertyID string + func (v CancelActivationRequest) Validate() error + type CancelActivationResponse struct + Activations ActivationsItems + type CancelIncludeActivationRequest struct + ActivationID string + ContractID string + GroupID string + IncludeID string + func (i CancelIncludeActivationRequest) Validate() error + type CancelIncludeActivationResponse ListIncludeActivationsResponse + type CertStatusItem struct + Production []StatusItem + Staging []StatusItem + ValidationCname ValidationCname + type ClientFunc func(sess session.Session, opts ...Option) PAPI + type ClientSettings interface + GetClientSettings func(context.Context) (*ClientSettingsBody, error) + UpdateClientSettings func(context.Context, ClientSettingsBody) (*ClientSettingsBody, error) + type ClientSettingsBody struct + RuleFormat string + UsePrefixes bool + type CloneIncludeFrom struct + CloneFromVersionEtag string + IncludeID string + Version int + type ComplianceRecordEmergency struct + TicketID string + func (c ComplianceRecordEmergency) MarshalJSON() ([]byte, error) + type ComplianceRecordNoProductionTraffic struct + TicketID string + func (c ComplianceRecordNoProductionTraffic) MarshalJSON() ([]byte, error) + type ComplianceRecordNone struct + CustomerEmail string + PeerReviewedBy string + TicketID string + UnitTested bool + func (c *ComplianceRecordNone) Validate() error + func (c ComplianceRecordNone) MarshalJSON() ([]byte, error) + type ComplianceRecordOther struct + OtherNoncomplianceReason string + TicketID string + func (c *ComplianceRecordOther) Validate() error + func (c ComplianceRecordOther) MarshalJSON() ([]byte, error) + type Contract struct + ContractID string + ContractTypeName string + type Contracts interface + GetContracts func(context.Context) (*GetContractsResponse, error) + type ContractsItems struct + Items []*Contract + type CreateActivationRequest struct + Activation Activation + ContractID string + GroupID string + PropertyID string + func (v CreateActivationRequest) Validate() error + type CreateActivationResponse struct + ActivationID string + ActivationLink string + type CreateCPCode struct + CPCodeName string + ProductID string + func (cp CreateCPCode) Validate() error + type CreateCPCodeFn func(context.Context, CreateCPCodeRequest) (*CreateCPCodeResponse, error) + type CreateCPCodeRequest struct + CPCode CreateCPCode + ContractID string + GroupID string + func (cp CreateCPCodeRequest) Validate() error + type CreateCPCodeResponse struct + CPCodeID string + CPCodeLink string + type CreateEdgeHostnameRequest struct + ContractID string + EdgeHostname EdgeHostnameCreate + GroupID string + Options []string + func (eh CreateEdgeHostnameRequest) Validate() error + type CreateEdgeHostnameResponse struct + EdgeHostnameID string + EdgeHostnameLink string + type CreateIncludeRequest struct + CloneIncludeFrom *CloneIncludeFrom + ContractID string + GroupID string + IncludeName string + IncludeType IncludeType + ProductID string + RuleFormat string + func (i CreateIncludeRequest) Validate() error + type CreateIncludeResponse struct + IncludeID string + IncludeLink string + ResponseHeaders CreateIncludeResponseHeaders + type CreateIncludeResponseHeaders struct + IncludesLimitRemaining string + IncludesLimitTotal string + type CreateIncludeVersionRequest struct + IncludeID string + func (i CreateIncludeVersionRequest) Validate() error + type CreateIncludeVersionResponse struct + Version int + VersionLink string + type CreatePropertyRequest struct + ContractID string + GroupID string + Property PropertyCreate + func (v CreatePropertyRequest) Validate() error + type CreatePropertyResponse struct + PropertyID string + PropertyLink string + type CreatePropertyVersionRequest struct + ContractID string + GroupID string + PropertyID string + Version PropertyVersionCreate + func (v CreatePropertyVersionRequest) Validate() error + type CreatePropertyVersionResponse struct + PropertyVersion int + VersionLink string + type Criteria struct + Name string + SchemaLink string + type DeactivateIncludeRequest ActivateOrDeactivateIncludeRequest + func (i DeactivateIncludeRequest) Validate() error + type DeactivationIncludeResponse struct + ActivationID string + ActivationLink string + type DeleteIncludeRequest struct + ContractID string + GroupID string + IncludeID string + func (i DeleteIncludeRequest) Validate() error + type DeleteIncludeResponse struct + Message string + type EdgeHostnameCreate struct + CertEnrollmentID int + DomainPrefix string + DomainSuffix string + IPVersionBehavior string + ProductID string + Secure bool + SecureNetwork string + SlotNumber int + UseCases []UseCase + func (eh EdgeHostnameCreate) Validate() error + type EdgeHostnameGetItem struct + Domain string + DomainPrefix string + DomainSuffix string + ID string + IPVersionBehavior string + ProductID string + Secure bool + Status string + UseCases []UseCase + type EdgeHostnameItems struct + Items []EdgeHostnameGetItem + type EdgeHostnames interface + CreateEdgeHostname func(context.Context, CreateEdgeHostnameRequest) (*CreateEdgeHostnameResponse, error) + GetEdgeHostname func(context.Context, GetEdgeHostnameRequest) (*GetEdgeHostnamesResponse, error) + GetEdgeHostnames func(context.Context, GetEdgeHostnamesRequest) (*GetEdgeHostnamesResponse, error) + type Error struct + BehaviorName string + Detail string + ErrorLocation string + Errors json.RawMessage + Instance string + Limit *int + LimitKey string + Remaining *int + StatusCode int + Title string + Type string + Warnings json.RawMessage + func (e *Error) Error() string + func (e *Error) Is(target error) bool + type ErrorItem struct + HasValidationError bool + HasValidationWarning bool + PropertyName string + ValidationResultsLink string + VersionID int + VersionNumber int + type ExternalIncludeData struct + FileName string + IncludeID string + IncludeName string + IncludeType IncludeType + ProductName string + RuleFormat string + type GetActivationRequest struct + ActivationID string + ContractID string + GroupID string + PropertyID string + func (v GetActivationRequest) Validate() error + type GetActivationResponse struct + Activation *Activation + type GetActivationsRequest struct + ContractID string + GroupID string + PropertyID string + func (v GetActivationsRequest) Validate() error + type GetActivationsResponse struct + Activations ActivationsItems + RetryAfter int + type GetAvailableBehaviorsRequest GetAvailableItemsRequest + func (v GetAvailableBehaviorsRequest) Validate() error + type GetAvailableCriteriaRequest GetAvailableItemsRequest + func (v GetAvailableCriteriaRequest) Validate() error + type GetAvailableItemsRequest struct + ContractID string + GroupID string + PropertyID string + PropertyVersion int + type GetBehaviorsResponse AvailableBehaviorsResponse + type GetCPCodeRequest struct + CPCodeID string + ContractID string + GroupID string + func (cp GetCPCodeRequest) Validate() error + type GetCPCodesFn func(context.Context, GetCPCodesRequest) (*GetCPCodesResponse, error) + type GetCPCodesRequest struct + ContractID string + GroupID string + func (cp GetCPCodesRequest) Validate() error + type GetCPCodesResponse struct + AccountID string + CPCode CPCode + CPCodes CPCodeItems + ContractID string + GroupID string + type GetContractsResponse struct + AccountID string + Contracts ContractsItems + type GetCriteriaResponse AvailableCriteriaResponse + type GetEdgeHostnameRequest struct + ContractID string + EdgeHostnameID string + GroupID string + Options []string + func (eh GetEdgeHostnameRequest) Validate() error + type GetEdgeHostnamesRequest struct + ContractID string + GroupID string + Options []string + func (eh GetEdgeHostnamesRequest) Validate() error + type GetEdgeHostnamesResponse struct + AccountID string + ContractID string + EdgeHostname EdgeHostnameGetItem + EdgeHostnames EdgeHostnameItems + GroupID string + type GetGroupsFn func(context.Context) (*GetGroupsResponse, error) + type GetGroupsResponse struct + AccountID string + AccountName string + Groups GroupItems + type GetIncludeActivationRequest struct + ActivationID string + IncludeID string + func (i GetIncludeActivationRequest) Validate() error + type GetIncludeActivationResponse struct + AccountID string + Activation IncludeActivation + Activations IncludeActivationsRes + ContractID string + GroupID string + Validations *Validations + type GetIncludeRequest struct + ContractID string + GroupID string + IncludeID string + func (i GetIncludeRequest) Validate() error + type GetIncludeResponse struct + Include Include + Includes IncludeItems + type GetIncludeRuleTreeRequest struct + ContractID string + GroupID string + IncludeID string + IncludeVersion int + RuleFormat string + ValidateMode string + ValidateRules bool + func (i GetIncludeRuleTreeRequest) Validate() error + type GetIncludeRuleTreeResponse struct + Comments string + Etag string + IncludeID string + IncludeName string + IncludeType IncludeType + IncludeVersion int + RuleFormat string + Rules Rules + type GetIncludeVersionRequest struct + ContractID string + GroupID string + IncludeID string + Version int + func (i GetIncludeVersionRequest) Validate() error + type GetIncludeVersionResponse struct + AccountID string + AssetID string + ContractID string + GroupID string + IncludeID string + IncludeName string + IncludeType IncludeType + IncludeVersion IncludeVersion + IncludeVersions Versions + type GetLatestVersionRequest struct + ActivatedOn string + ContractID string + GroupID string + PropertyID string + func (v GetLatestVersionRequest) Validate() error + type GetProductsRequest struct + ContractID string + func (pr GetProductsRequest) Validate() error + type GetProductsResponse struct + AccountID string + ContractID string + Products ProductsItems + type GetPropertiesRequest struct + ContractID string + GroupID string + func (v GetPropertiesRequest) Validate() error + type GetPropertiesResponse struct + Properties PropertiesItems + type GetPropertyFunc func(context.Context, GetPropertyRequest) (*GetPropertyResponse, error) + type GetPropertyRequest struct + ContractID string + GroupID string + PropertyID string + func (v GetPropertyRequest) Validate() error + type GetPropertyResponse struct + Properties PropertiesItems + Property *Property + type GetPropertyVersionHostnamesFn func(context.Context, GetPropertyVersionHostnamesRequest) (*GetPropertyVersionHostnamesResponse, error) + type GetPropertyVersionHostnamesRequest struct + ContractID string + GroupID string + IncludeCertStatus bool + PropertyID string + PropertyVersion int + ValidateHostnames bool + func (ph GetPropertyVersionHostnamesRequest) Validate() error + type GetPropertyVersionHostnamesResponse struct + AccountID string + ContractID string + Etag string + GroupID string + Hostnames HostnameResponseItems + PropertyID string + PropertyVersion int + type GetPropertyVersionRequest struct + ContractID string + GroupID string + PropertyID string + PropertyVersion int + func (v GetPropertyVersionRequest) Validate() error + type GetPropertyVersionsFn func(context.Context, GetPropertyVersionsRequest) (*GetPropertyVersionsResponse, error) + type GetPropertyVersionsRequest struct + ContractID string + GroupID string + Limit int + Offset int + PropertyID string + func (v GetPropertyVersionsRequest) Validate() error + type GetPropertyVersionsResponse struct + AccountID string + AssetID string + ContractID string + GroupID string + PropertyID string + PropertyName string + Version PropertyVersionGetItem + Versions PropertyVersionItems + type GetRuleFormatsResponse struct + RuleFormats RuleFormatItems + type GetRuleTreeFn = func(context.Context, GetRuleTreeRequest) (*GetRuleTreeResponse, error) + type GetRuleTreeRequest struct + ContractID string + GroupID string + PropertyID string + PropertyVersion int + RuleFormat string + ValidateMode string + ValidateRules bool + func (r GetRuleTreeRequest) Validate() error + type GetRuleTreeResponse struct + Comments string + Etag string + PropertyID string + PropertyVersion int + RuleFormat string + Rules Rules + type Group struct + ContractIDs []string + GroupID string + GroupName string + ParentGroupID string + type GroupItems struct + Items []*Group + type Groups interface + GetGroups func(context.Context) (*GetGroupsResponse, error) + type Hostname struct + CertProvisioningType string + CertStatus CertStatusItem + CnameFrom string + CnameTo string + CnameType HostnameCnameType + EdgeHostnameID string + type HostnameCnameType string + const HostnameCnameTypeEdgeHostname + type HostnameResponseItems struct + Items []Hostname + type Include struct + AccountID string + AssetID string + ContractID string + GroupID string + IncludeID string + IncludeName string + IncludeType IncludeType + LatestVersion int + ProductionVersion *int + PropertyType *string + StagingVersion *int + type IncludeActivation struct + ActivationID string + ActivationType ActivationType + FMAActivationState string + FallbackInfo *ActivationFallbackInfo + IncludeActivationID string + IncludeID string + IncludeName string + IncludeType IncludeType + IncludeVersion int + Network ActivationNetwork + Note string + NotifyEmails []string + Status ActivationStatus + SubmitDate string + UpdateDate string + type IncludeActivations interface + ActivateInclude func(context.Context, ActivateIncludeRequest) (*ActivationIncludeResponse, error) + CancelIncludeActivation func(context.Context, CancelIncludeActivationRequest) (*CancelIncludeActivationResponse, error) + DeactivateInclude func(context.Context, DeactivateIncludeRequest) (*DeactivationIncludeResponse, error) + GetIncludeActivation func(context.Context, GetIncludeActivationRequest) (*GetIncludeActivationResponse, error) + ListIncludeActivations func(context.Context, ListIncludeActivationsRequest) (*ListIncludeActivationsResponse, error) + type IncludeActivationsRes struct + Items []IncludeActivation + type IncludeItems struct + Items []Include + type IncludeRules interface + GetIncludeRuleTree func(context.Context, GetIncludeRuleTreeRequest) (*GetIncludeRuleTreeResponse, error) + UpdateIncludeRuleTree func(context.Context, UpdateIncludeRuleTreeRequest) (*UpdateIncludeRuleTreeResponse, error) + type IncludeType string + const IncludeTypeCommonSettings + const IncludeTypeMicroServices + type IncludeVersion struct + Etag string + IncludeVersion int + Note string + ProductID string + ProductionStatus VersionStatus + RuleFormat string + StagingStatus VersionStatus + UpdatedByUser string + UpdatedDate string + type IncludeVersionRequest struct + CreateFromVersion int + CreateFromVersionEtag string + type IncludeVersions interface + CreateIncludeVersion func(context.Context, CreateIncludeVersionRequest) (*CreateIncludeVersionResponse, error) + GetIncludeVersion func(context.Context, GetIncludeVersionRequest) (*GetIncludeVersionResponse, error) + ListIncludeVersionAvailableBehaviors func(context.Context, ListAvailableBehaviorsRequest) (*AvailableBehaviorsResponse, error) + ListIncludeVersionAvailableCriteria func(context.Context, ListAvailableCriteriaRequest) (*AvailableCriteriaResponse, error) + ListIncludeVersions func(context.Context, ListIncludeVersionsRequest) (*ListIncludeVersionsResponse, error) + type Includes interface + CreateInclude func(context.Context, CreateIncludeRequest) (*CreateIncludeResponse, error) + DeleteInclude func(context.Context, DeleteIncludeRequest) (*DeleteIncludeResponse, error) + GetInclude func(context.Context, GetIncludeRequest) (*GetIncludeResponse, error) + ListIncludeParents func(context.Context, ListIncludeParentsRequest) (*ListIncludeParentsResponse, error) + ListIncludes func(context.Context, ListIncludesRequest) (*ListIncludesResponse, error) + type ListAvailableBehaviorsRequest struct + IncludeID string + Version int + func (i ListAvailableBehaviorsRequest) Validate() error + type ListAvailableCriteriaRequest struct + IncludeID string + Version int + func (i ListAvailableCriteriaRequest) Validate() error + type ListAvailableIncludesRequest ListAvailableReferencedIncludesRequest + func (v ListAvailableIncludesRequest) Validate() error + type ListAvailableIncludesResponse struct + AvailableIncludes []ExternalIncludeData + func (r *ListAvailableIncludesResponse) UnmarshalJSON(data []byte) error + type ListAvailableReferencedIncludesRequest struct + ContractID string + GroupID string + PropertyID string + PropertyVersion int + type ListIncludeActivationsRequest struct + ContractID string + GroupID string + IncludeID string + func (i ListIncludeActivationsRequest) Validate() error + type ListIncludeActivationsResponse struct + AccountID string + Activations IncludeActivationsRes + ContractID string + GroupID string + type ListIncludeParentsRequest struct + ContractID string + GroupID string + IncludeID string + func (i ListIncludeParentsRequest) Validate() error + type ListIncludeParentsResponse struct + Properties ParentPropertyItems + type ListIncludeVersionsRequest struct + ContractID string + GroupID string + IncludeID string + func (i ListIncludeVersionsRequest) Validate() error + type ListIncludeVersionsResponse struct + AccountID string + AssetID string + ContractID string + GroupID string + IncludeID string + IncludeName string + IncludeType IncludeType + IncludeVersions Versions + type ListIncludesRequest struct + ContractID string + GroupID string + func (i ListIncludesRequest) Validate() error + type ListIncludesResponse struct + Includes IncludeItems + type ListReferencedIncludesRequest ListAvailableReferencedIncludesRequest + func (v ListReferencedIncludesRequest) Validate() error + type ListReferencedIncludesResponse struct + Includes IncludeItems + type Mock struct + func (p *Mock) ActivateInclude(ctx context.Context, r ActivateIncludeRequest) (*ActivationIncludeResponse, error) + func (p *Mock) CancelActivation(ctx context.Context, r CancelActivationRequest) (*CancelActivationResponse, error) + func (p *Mock) CancelIncludeActivation(ctx context.Context, r CancelIncludeActivationRequest) (*CancelIncludeActivationResponse, error) + func (p *Mock) CreateActivation(ctx context.Context, r CreateActivationRequest) (*CreateActivationResponse, error) + func (p *Mock) CreateCPCode(ctx context.Context, r CreateCPCodeRequest) (*CreateCPCodeResponse, error) + func (p *Mock) CreateEdgeHostname(ctx context.Context, r CreateEdgeHostnameRequest) (*CreateEdgeHostnameResponse, error) + func (p *Mock) CreateInclude(ctx context.Context, r CreateIncludeRequest) (*CreateIncludeResponse, error) + func (p *Mock) CreateIncludeVersion(ctx context.Context, r CreateIncludeVersionRequest) (*CreateIncludeVersionResponse, error) + func (p *Mock) CreateProperty(ctx context.Context, r CreatePropertyRequest) (*CreatePropertyResponse, error) + func (p *Mock) CreatePropertyVersion(ctx context.Context, r CreatePropertyVersionRequest) (*CreatePropertyVersionResponse, error) + func (p *Mock) DeactivateInclude(ctx context.Context, r DeactivateIncludeRequest) (*DeactivationIncludeResponse, error) + func (p *Mock) DeleteInclude(ctx context.Context, r DeleteIncludeRequest) (*DeleteIncludeResponse, error) + func (p *Mock) GetActivation(ctx context.Context, r GetActivationRequest) (*GetActivationResponse, error) + func (p *Mock) GetActivations(ctx context.Context, r GetActivationsRequest) (*GetActivationsResponse, error) + func (p *Mock) GetAvailableBehaviors(ctx context.Context, r GetAvailableBehaviorsRequest) (*GetBehaviorsResponse, error) + func (p *Mock) GetAvailableCriteria(ctx context.Context, r GetAvailableCriteriaRequest) (*GetCriteriaResponse, error) + func (p *Mock) GetCPCode(ctx context.Context, r GetCPCodeRequest) (*GetCPCodesResponse, error) + func (p *Mock) GetCPCodeDetail(ctx context.Context, r int) (*CPCodeDetailResponse, error) + func (p *Mock) GetCPCodes(ctx context.Context, r GetCPCodesRequest) (*GetCPCodesResponse, error) + func (p *Mock) GetClientSettings(ctx context.Context) (*ClientSettingsBody, error) + func (p *Mock) GetContracts(ctx context.Context) (*GetContractsResponse, error) + func (p *Mock) GetEdgeHostname(ctx context.Context, r GetEdgeHostnameRequest) (*GetEdgeHostnamesResponse, error) + func (p *Mock) GetEdgeHostnames(ctx context.Context, r GetEdgeHostnamesRequest) (*GetEdgeHostnamesResponse, error) + func (p *Mock) GetGroups(ctx context.Context) (*GetGroupsResponse, error) + func (p *Mock) GetInclude(ctx context.Context, r GetIncludeRequest) (*GetIncludeResponse, error) + func (p *Mock) GetIncludeActivation(ctx context.Context, r GetIncludeActivationRequest) (*GetIncludeActivationResponse, error) + func (p *Mock) GetIncludeRuleTree(ctx context.Context, r GetIncludeRuleTreeRequest) (*GetIncludeRuleTreeResponse, error) + func (p *Mock) GetIncludeVersion(ctx context.Context, r GetIncludeVersionRequest) (*GetIncludeVersionResponse, error) + func (p *Mock) GetLatestVersion(ctx context.Context, r GetLatestVersionRequest) (*GetPropertyVersionsResponse, error) + func (p *Mock) GetProducts(ctx context.Context, r GetProductsRequest) (*GetProductsResponse, error) + func (p *Mock) GetProperties(ctx context.Context, r GetPropertiesRequest) (*GetPropertiesResponse, error) + func (p *Mock) GetProperty(ctx context.Context, r GetPropertyRequest) (*GetPropertyResponse, error) + func (p *Mock) GetPropertyVersion(ctx context.Context, r GetPropertyVersionRequest) (*GetPropertyVersionsResponse, error) + func (p *Mock) GetPropertyVersionHostnames(ctx context.Context, r GetPropertyVersionHostnamesRequest) (*GetPropertyVersionHostnamesResponse, error) + func (p *Mock) GetPropertyVersions(ctx context.Context, r GetPropertyVersionsRequest) (*GetPropertyVersionsResponse, error) + func (p *Mock) GetRuleFormats(ctx context.Context) (*GetRuleFormatsResponse, error) + func (p *Mock) GetRuleTree(ctx context.Context, r GetRuleTreeRequest) (*GetRuleTreeResponse, error) + func (p *Mock) ListAvailableIncludes(ctx context.Context, r ListAvailableIncludesRequest) (*ListAvailableIncludesResponse, error) + func (p *Mock) ListIncludeActivations(ctx context.Context, r ListIncludeActivationsRequest) (*ListIncludeActivationsResponse, error) + func (p *Mock) ListIncludeParents(ctx context.Context, r ListIncludeParentsRequest) (*ListIncludeParentsResponse, error) + func (p *Mock) ListIncludeVersionAvailableBehaviors(ctx context.Context, r ListAvailableBehaviorsRequest) (*AvailableBehaviorsResponse, error) + func (p *Mock) ListIncludeVersionAvailableCriteria(ctx context.Context, r ListAvailableCriteriaRequest) (*AvailableCriteriaResponse, error) + func (p *Mock) ListIncludeVersions(ctx context.Context, r ListIncludeVersionsRequest) (*ListIncludeVersionsResponse, error) + func (p *Mock) ListIncludes(ctx context.Context, r ListIncludesRequest) (*ListIncludesResponse, error) + func (p *Mock) ListReferencedIncludes(ctx context.Context, r ListReferencedIncludesRequest) (*ListReferencedIncludesResponse, error) + func (p *Mock) OnCreateCPCode(impl CreateCPCodeFn, args ...interface{}) *mock.Call + func (p *Mock) OnGetCPCodes(impl GetCPCodesFn, args ...interface{}) *mock.Call + func (p *Mock) OnGetGroups(ctx interface{}, impl GetGroupsFn) *mock.Call + func (p *Mock) OnGetProperty(ctx, req interface{}, impl GetPropertyFunc) *mock.Call + func (p *Mock) OnGetPropertyVersionHostnames(ctx, req interface{}, impl GetPropertyVersionHostnamesFn) *mock.Call + func (p *Mock) OnGetPropertyVersions(ctx, req interface{}, impl GetPropertyVersionsFn) *mock.Call + func (p *Mock) OnGetRuleTree(ctx, req interface{}, impl GetRuleTreeFn) *mock.Call + func (p *Mock) OnUpdateCPCode(impl UpdateCPCodeFn, args ...interface{}) *mock.Call + func (p *Mock) OnUpdateRuleTree(ctx, req interface{}, impl UpdateRuleTreeFn) *mock.Call + func (p *Mock) RemoveProperty(ctx context.Context, r RemovePropertyRequest) (*RemovePropertyResponse, error) + func (p *Mock) SearchProperties(ctx context.Context, r SearchRequest) (*SearchResponse, error) + func (p *Mock) UpdateCPCode(ctx context.Context, r UpdateCPCodeRequest) (*CPCodeDetailResponse, error) + func (p *Mock) UpdateClientSettings(ctx context.Context, r ClientSettingsBody) (*ClientSettingsBody, error) + func (p *Mock) UpdateIncludeRuleTree(ctx context.Context, r UpdateIncludeRuleTreeRequest) (*UpdateIncludeRuleTreeResponse, error) + func (p *Mock) UpdatePropertyVersionHostnames(ctx context.Context, r UpdatePropertyVersionHostnamesRequest) (*UpdatePropertyVersionHostnamesResponse, error) + func (p *Mock) UpdateRuleTree(ctx context.Context, r UpdateRulesRequest) (*UpdateRulesResponse, error) + type Option func(*papi) + func WithUsePrefixes(usePrefixes bool) Option + type PAPI interface + func Client(sess session.Session, opts ...Option) PAPI + type ParentProperty struct + AccountID string + AssetID string + ContractID string + GroupID string + ProductionVersion *int + PropertyID string + PropertyName string + StagingVersion *int + type ParentPropertyItems struct + Items []ParentProperty + type ProductItem struct + ProductID string + ProductName string + type Products interface + GetProducts func(context.Context, GetProductsRequest) (*GetProductsResponse, error) + type ProductsItems struct + Items []ProductItem + type Properties interface + CreateProperty func(ctx context.Context, params CreatePropertyRequest) (*CreatePropertyResponse, error) + GetProperties func(ctx context.Context, r GetPropertiesRequest) (*GetPropertiesResponse, error) + GetProperty func(ctx context.Context, params GetPropertyRequest) (*GetPropertyResponse, error) + RemoveProperty func(ctx context.Context, params RemovePropertyRequest) (*RemovePropertyResponse, error) + type PropertiesItems struct + Items []*Property + type Property struct + AccountID string + AssetID string + ContractID string + GroupID string + LatestVersion int + Note string + ProductID string + ProductionVersion *int + PropertyID string + PropertyName string + RuleFormat string + StagingVersion *int + type PropertyCloneFrom struct + CloneFromVersionEtag string + CopyHostnames bool + PropertyID string + Version int + func (c PropertyCloneFrom) Validate() error + type PropertyCreate struct + CloneFrom *PropertyCloneFrom + ProductID string + PropertyName string + RuleFormat string + func (p PropertyCreate) Validate() error + type PropertyRules interface + GetRuleTree func(context.Context, GetRuleTreeRequest) (*GetRuleTreeResponse, error) + UpdateRuleTree func(context.Context, UpdateRulesRequest) (*UpdateRulesResponse, error) + type PropertyVersionCreate struct + CreateFromVersion int + CreateFromVersionEtag string + func (v PropertyVersionCreate) Validate() error + type PropertyVersionGetItem struct + Etag string + Note string + ProductID string + ProductionStatus VersionStatus + PropertyVersion int + RuleFormat string + StagingStatus VersionStatus + UpdatedByUser string + UpdatedDate string + type PropertyVersionHostnames interface + GetPropertyVersionHostnames func(context.Context, GetPropertyVersionHostnamesRequest) (*GetPropertyVersionHostnamesResponse, error) + UpdatePropertyVersionHostnames func(context.Context, UpdatePropertyVersionHostnamesRequest) (*UpdatePropertyVersionHostnamesResponse, error) + type PropertyVersionItems struct + Items []PropertyVersionGetItem + type PropertyVersions interface + CreatePropertyVersion func(context.Context, CreatePropertyVersionRequest) (*CreatePropertyVersionResponse, error) + GetAvailableBehaviors func(context.Context, GetAvailableBehaviorsRequest) (*GetBehaviorsResponse, error) + GetAvailableCriteria func(context.Context, GetAvailableCriteriaRequest) (*GetCriteriaResponse, error) + GetLatestVersion func(context.Context, GetLatestVersionRequest) (*GetPropertyVersionsResponse, error) + GetPropertyVersion func(context.Context, GetPropertyVersionRequest) (*GetPropertyVersionsResponse, error) + GetPropertyVersions func(context.Context, GetPropertyVersionsRequest) (*GetPropertyVersionsResponse, error) + ListAvailableIncludes func(context.Context, ListAvailableIncludesRequest) (*ListAvailableIncludesResponse, error) + ListReferencedIncludes func(context.Context, ListReferencedIncludesRequest) (*ListReferencedIncludesResponse, error) + type RemovePropertyRequest struct + ContractID string + GroupID string + PropertyID string + func (v RemovePropertyRequest) Validate() error + type RemovePropertyResponse struct + Message string + type Response struct + AccountID string + ContractID string + Errors []*Error + Etag string + GroupID string + Warnings []*Error + type RuleBehavior struct + Locked bool + Name string + Options RuleOptionsMap + TemplateUuid string + UUID string + func (b RuleBehavior) Validate() error + type RuleCriteriaMustSatisfy string + type RuleCustomOverride struct + Name string + OverrideID string + func (co RuleCustomOverride) Validate() error + type RuleError struct + BehaviorName string + Detail string + Instance string + Title string + Type string + type RuleFormatItems struct + Items []string + type RuleFormats interface + GetRuleFormats func(context.Context) (*GetRuleFormatsResponse, error) + type RuleOptions struct + IsSecure bool + type RuleOptionsMap map[string]interface + type RuleVariable struct + Description string + Hidden bool + Name string + Sensitive bool + Value string + func (v RuleVariable) Validate() error + type Rules struct + AdvancedOverride string + Behaviors []RuleBehavior + Children []Rules + Comments string + Criteria []RuleBehavior + CriteriaLocked bool + CriteriaMustSatisfy RuleCriteriaMustSatisfy + CustomOverride *RuleCustomOverride + Name string + Options RuleOptions + TemplateLink string + TemplateUuid string + UUID string + Variables []RuleVariable + func (r Rules) Validate() error + type RulesUpdate struct + Comments string + Rules Rules + func (r RulesUpdate) Validate() error + type Search interface + SearchProperties func(context.Context, SearchRequest) (*SearchResponse, error) + type SearchItem struct + AccountID string + AssetID string + ContractID string + EdgeHostname string + GroupID string + Hostname string + ProductionStatus string + PropertyID string + PropertyName string + PropertyVersion int + StagingStatus string + UpdatedByUser string + UpdatedDate string + type SearchItems struct + Items []SearchItem + type SearchRequest struct + Key string + Value string + func (s SearchRequest) Validate() error + type SearchResponse struct + Versions SearchItems + type StatusItem struct + Status string + type UpdateCPCodeFn func(context.Context, UpdateCPCodeRequest) (*CPCodeDetailResponse, error) + type UpdateCPCodeRequest struct + Contracts []CPCodeContract + ID int + Name string + OverrideTimeZone *CPCodeTimeZone + Products []CPCodeProduct + Purgeable *bool + func (cp UpdateCPCodeRequest) Validate() error + type UpdateIncludeResponseHeaders struct + ElementsPerPropertyRemaining string + ElementsPerPropertyTotal string + MaxNestedRulesPerIncludeRemaining string + MaxNestedRulesPerIncludeTotal string + type UpdateIncludeRuleTreeRequest struct + ContractID string + DryRun bool + GroupID string + IncludeID string + IncludeVersion int + Rules RulesUpdate + ValidateMode string + ValidateRules bool + func (i UpdateIncludeRuleTreeRequest) Validate() error + type UpdateIncludeRuleTreeResponse struct + Comments string + Etag string + IncludeID string + IncludeName string + IncludeType IncludeType + IncludeVersion int + ResponseHeaders UpdateIncludeResponseHeaders + RuleFormat string + Rules Rules + type UpdatePropertyVersionHostnamesRequest struct + ContractID string + GroupID string + Hostnames []Hostname + IncludeCertStatus bool + PropertyID string + PropertyVersion int + ValidateHostnames bool + func (ch UpdatePropertyVersionHostnamesRequest) Validate() error + type UpdatePropertyVersionHostnamesResponse struct + AccountID string + ContractID string + Etag string + GroupID string + Hostnames HostnameResponseItems + PropertyID string + PropertyVersion int + type UpdateRuleTreeFn func(context.Context, UpdateRulesRequest) (*UpdateRulesResponse, error) + type UpdateRulesRequest struct + ContractID string + DryRun bool + GroupID string + PropertyID string + PropertyVersion int + Rules RulesUpdate + ValidateMode string + ValidateRules bool + func (r UpdateRulesRequest) Validate() error + type UpdateRulesResponse struct + AccountID string + Comments string + ContractID string + Errors []RuleError + Etag string + GroupID string + PropertyID string + PropertyVersion int + RuleFormat string + Rules Rules + type UseCase struct + Option string + Type string + UseCase string + func (uc UseCase) Validate() error + type ValidationCname struct + Hostname string + Target string + type ValidationProgress struct + ErrorItems []ErrorItem + type ValidationSummary struct + CompletePercent float64 + HasClientError bool + HasSystemError bool + HasValidationError bool + HasValidationWarning bool + MessageState string + type Validations struct + Network ActivationNetwork + ValidationProgressItemList ValidationProgress + ValidationSummary ValidationSummary + type VersionStatus string + const VersionProduction + const VersionStaging + const VersionStatusActive + const VersionStatusDeactivated + const VersionStatusInactive + const VersionStatusPending + type Versions struct + Items []IncludeVersion Other modules containing this package github.com/akamai/AkamaiOPEN-edgegrid-golang/v2 github.com/akamai/AkamaiOPEN-edgegrid-golang/v3 github.com/akamai/AkamaiOPEN-edgegrid-golang/v4 github.com/akamai/AkamaiOPEN-edgegrid-golang/v6 github.com/akamai/AkamaiOPEN-edgegrid-golang/v7 github.com/akamai/AkamaiOPEN-edgegrid-golang/v8 github.com/akamai/AkamaiOPEN-edgegrid-golang/v9
Go to main page