configurationgovernancev1

package
Version: v1.2.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 15, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package configurationgovernancev1 : Operations and models for the ConfigurationGovernanceV1 service

Index

Constants

View Source
const (
	RuleConditionOperatorIpsInRangeConst           = "ips_in_range"
	RuleConditionOperatorIsEmptyConst              = "is_empty"
	RuleConditionOperatorIsFalseConst              = "is_false"
	RuleConditionOperatorIsNotEmptyConst           = "is_not_empty"
	RuleConditionOperatorIsTrueConst               = "is_true"
	RuleConditionOperatorNumEqualsConst            = "num_equals"
	RuleConditionOperatorNumGreaterThanConst       = "num_greater_than"
	RuleConditionOperatorNumGreaterThanEqualsConst = "num_greater_than_equals"
	RuleConditionOperatorNumLessThanConst          = "num_less_than"
	RuleConditionOperatorNumLessThanEqualsConst    = "num_less_than_equals"
	RuleConditionOperatorNumNotEqualsConst         = "num_not_equals"
	RuleConditionOperatorStringEqualsConst         = "string_equals"
	RuleConditionOperatorStringMatchConst          = "string_match"
	RuleConditionOperatorStringNotEqualsConst      = "string_not_equals"
	RuleConditionOperatorStringNotMatchConst       = "string_not_match"
	RuleConditionOperatorStringsInListConst        = "strings_in_list"
)

Constants associated with the RuleCondition.Operator property. The way in which the `property` field is compared to its value.

To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).

View Source
const (
	RuleRequiredConfigOperatorIpsInRangeConst           = "ips_in_range"
	RuleRequiredConfigOperatorIsEmptyConst              = "is_empty"
	RuleRequiredConfigOperatorIsFalseConst              = "is_false"
	RuleRequiredConfigOperatorIsNotEmptyConst           = "is_not_empty"
	RuleRequiredConfigOperatorIsTrueConst               = "is_true"
	RuleRequiredConfigOperatorNumEqualsConst            = "num_equals"
	RuleRequiredConfigOperatorNumGreaterThanConst       = "num_greater_than"
	RuleRequiredConfigOperatorNumGreaterThanEqualsConst = "num_greater_than_equals"
	RuleRequiredConfigOperatorNumLessThanConst          = "num_less_than"
	RuleRequiredConfigOperatorNumLessThanEqualsConst    = "num_less_than_equals"
	RuleRequiredConfigOperatorNumNotEqualsConst         = "num_not_equals"
	RuleRequiredConfigOperatorStringEqualsConst         = "string_equals"
	RuleRequiredConfigOperatorStringMatchConst          = "string_match"
	RuleRequiredConfigOperatorStringNotEqualsConst      = "string_not_equals"
	RuleRequiredConfigOperatorStringNotMatchConst       = "string_not_match"
	RuleRequiredConfigOperatorStringsInListConst        = "strings_in_list"
)

Constants associated with the RuleRequiredConfig.Operator property. The way in which the `property` field is compared to its value.

To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).

View Source
const (
	RuleScopeScopeTypeAccountConst                = "account"
	RuleScopeScopeTypeAccountResourceGroupConst   = "account.resource_group"
	RuleScopeScopeTypeEnterpriseConst             = "enterprise"
	RuleScopeScopeTypeEnterpriseAccountConst      = "enterprise.account"
	RuleScopeScopeTypeEnterpriseAccountGroupConst = "enterprise.account_group"
)

Constants associated with the RuleScope.ScopeType property. The type of scope that you want to evaluate.

View Source
const (
	RuleSinglePropertyOperatorIpsInRangeConst           = "ips_in_range"
	RuleSinglePropertyOperatorIsEmptyConst              = "is_empty"
	RuleSinglePropertyOperatorIsFalseConst              = "is_false"
	RuleSinglePropertyOperatorIsNotEmptyConst           = "is_not_empty"
	RuleSinglePropertyOperatorIsTrueConst               = "is_true"
	RuleSinglePropertyOperatorNumEqualsConst            = "num_equals"
	RuleSinglePropertyOperatorNumGreaterThanConst       = "num_greater_than"
	RuleSinglePropertyOperatorNumGreaterThanEqualsConst = "num_greater_than_equals"
	RuleSinglePropertyOperatorNumLessThanConst          = "num_less_than"
	RuleSinglePropertyOperatorNumLessThanEqualsConst    = "num_less_than_equals"
	RuleSinglePropertyOperatorNumNotEqualsConst         = "num_not_equals"
	RuleSinglePropertyOperatorStringEqualsConst         = "string_equals"
	RuleSinglePropertyOperatorStringMatchConst          = "string_match"
	RuleSinglePropertyOperatorStringNotEqualsConst      = "string_not_equals"
	RuleSinglePropertyOperatorStringNotMatchConst       = "string_not_match"
	RuleSinglePropertyOperatorStringsInListConst        = "strings_in_list"
)

Constants associated with the RuleSingleProperty.Operator property. The way in which the `property` field is compared to its value.

To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).

View Source
const (
	TargetResourceAdditionalTargetAttributesItemOperatorIpsInRangeConst           = "ips_in_range"
	TargetResourceAdditionalTargetAttributesItemOperatorIsEmptyConst              = "is_empty"
	TargetResourceAdditionalTargetAttributesItemOperatorIsFalseConst              = "is_false"
	TargetResourceAdditionalTargetAttributesItemOperatorIsNotEmptyConst           = "is_not_empty"
	TargetResourceAdditionalTargetAttributesItemOperatorIsTrueConst               = "is_true"
	TargetResourceAdditionalTargetAttributesItemOperatorNumEqualsConst            = "num_equals"
	TargetResourceAdditionalTargetAttributesItemOperatorNumGreaterThanConst       = "num_greater_than"
	TargetResourceAdditionalTargetAttributesItemOperatorNumGreaterThanEqualsConst = "num_greater_than_equals"
	TargetResourceAdditionalTargetAttributesItemOperatorNumLessThanConst          = "num_less_than"
	TargetResourceAdditionalTargetAttributesItemOperatorNumLessThanEqualsConst    = "num_less_than_equals"
	TargetResourceAdditionalTargetAttributesItemOperatorNumNotEqualsConst         = "num_not_equals"
	TargetResourceAdditionalTargetAttributesItemOperatorStringEqualsConst         = "string_equals"
	TargetResourceAdditionalTargetAttributesItemOperatorStringMatchConst          = "string_match"
	TargetResourceAdditionalTargetAttributesItemOperatorStringNotEqualsConst      = "string_not_equals"
	TargetResourceAdditionalTargetAttributesItemOperatorStringNotMatchConst       = "string_not_match"
	TargetResourceAdditionalTargetAttributesItemOperatorStringsInListConst        = "strings_in_list"
)

Constants associated with the TargetResourceAdditionalTargetAttributesItem.Operator property. The way in which the `name` field is compared to its value.

There are three types of operators: string, numeric, and boolean.

View Source
const (
	TemplateScopeScopeTypeAccountConst                = "account"
	TemplateScopeScopeTypeAccountResourceGroupConst   = "account.resource_group"
	TemplateScopeScopeTypeEnterpriseConst             = "enterprise"
	TemplateScopeScopeTypeEnterpriseAccountConst      = "enterprise.account"
	TemplateScopeScopeTypeEnterpriseAccountGroupConst = "enterprise.account_group"
)

Constants associated with the TemplateScope.ScopeType property. The type of scope.

View Source
const (
	RuleConditionSinglePropertyOperatorIpsInRangeConst           = "ips_in_range"
	RuleConditionSinglePropertyOperatorIsEmptyConst              = "is_empty"
	RuleConditionSinglePropertyOperatorIsFalseConst              = "is_false"
	RuleConditionSinglePropertyOperatorIsNotEmptyConst           = "is_not_empty"
	RuleConditionSinglePropertyOperatorIsTrueConst               = "is_true"
	RuleConditionSinglePropertyOperatorNumEqualsConst            = "num_equals"
	RuleConditionSinglePropertyOperatorNumGreaterThanConst       = "num_greater_than"
	RuleConditionSinglePropertyOperatorNumGreaterThanEqualsConst = "num_greater_than_equals"
	RuleConditionSinglePropertyOperatorNumLessThanConst          = "num_less_than"
	RuleConditionSinglePropertyOperatorNumLessThanEqualsConst    = "num_less_than_equals"
	RuleConditionSinglePropertyOperatorNumNotEqualsConst         = "num_not_equals"
	RuleConditionSinglePropertyOperatorStringEqualsConst         = "string_equals"
	RuleConditionSinglePropertyOperatorStringMatchConst          = "string_match"
	RuleConditionSinglePropertyOperatorStringNotEqualsConst      = "string_not_equals"
	RuleConditionSinglePropertyOperatorStringNotMatchConst       = "string_not_match"
	RuleConditionSinglePropertyOperatorStringsInListConst        = "strings_in_list"
)

Constants associated with the RuleConditionSingleProperty.Operator property. The way in which the `property` field is compared to its value.

To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).

View Source
const (
	RuleRequiredConfigSinglePropertyOperatorIpsInRangeConst           = "ips_in_range"
	RuleRequiredConfigSinglePropertyOperatorIsEmptyConst              = "is_empty"
	RuleRequiredConfigSinglePropertyOperatorIsFalseConst              = "is_false"
	RuleRequiredConfigSinglePropertyOperatorIsNotEmptyConst           = "is_not_empty"
	RuleRequiredConfigSinglePropertyOperatorIsTrueConst               = "is_true"
	RuleRequiredConfigSinglePropertyOperatorNumEqualsConst            = "num_equals"
	RuleRequiredConfigSinglePropertyOperatorNumGreaterThanConst       = "num_greater_than"
	RuleRequiredConfigSinglePropertyOperatorNumGreaterThanEqualsConst = "num_greater_than_equals"
	RuleRequiredConfigSinglePropertyOperatorNumLessThanConst          = "num_less_than"
	RuleRequiredConfigSinglePropertyOperatorNumLessThanEqualsConst    = "num_less_than_equals"
	RuleRequiredConfigSinglePropertyOperatorNumNotEqualsConst         = "num_not_equals"
	RuleRequiredConfigSinglePropertyOperatorStringEqualsConst         = "string_equals"
	RuleRequiredConfigSinglePropertyOperatorStringMatchConst          = "string_match"
	RuleRequiredConfigSinglePropertyOperatorStringNotEqualsConst      = "string_not_equals"
	RuleRequiredConfigSinglePropertyOperatorStringNotMatchConst       = "string_not_match"
	RuleRequiredConfigSinglePropertyOperatorStringsInListConst        = "strings_in_list"
)

Constants associated with the RuleRequiredConfigSingleProperty.Operator property. The way in which the `property` field is compared to its value.

To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).

View Source
const DefaultServiceName = "configuration_governance"

DefaultServiceName is the default key used to find external configuration information.

View Source
const DefaultServiceURL = "https://us.compliance.cloud.ibm.com"

DefaultServiceURL is the default URL to make service requests to.

View Source
const (
	EnforcementActionActionDisallowConst = "audit_log"
)

Constants associated with the EnforcementAction.Action property. To block a request from completing, use `disallow`. To log the request to Activity Tracker with LogDNA, use `audit_log`. To block a request from completing, use `disallow`.

View Source
const (
	RuleRequestRuleTypeUserDefinedConst = "user_defined"
)

Constants associated with the RuleRequest.RuleType property. The type of rule. Rules that you create are `user_defined`.

View Source
const (
	RuleRuleTypeUserDefinedConst = "user_defined"
)

Constants associated with the Rule.RuleType property. The type of rule. Rules that you create are `user_defined`.

View Source
const (
	UpdateRuleOptionsRuleTypeUserDefinedConst = "user_defined"
)

Constants associated with the UpdateRuleOptions.RuleType property. The type of rule. Rules that you create are `user_defined`.

Variables

This section is empty.

Functions

func GetServiceURLForRegion

func GetServiceURLForRegion(region string) (string, error)

GetServiceURLForRegion returns the service URL to be used for the specified region

func UnmarshalBaseTargetAttribute added in v1.2.0

func UnmarshalBaseTargetAttribute(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalBaseTargetAttribute unmarshals an instance of BaseTargetAttribute from the specified map of raw messages.

func UnmarshalCreateRuleAttachmentsResponse

func UnmarshalCreateRuleAttachmentsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateRuleAttachmentsResponse unmarshals an instance of CreateRuleAttachmentsResponse from the specified map of raw messages.

func UnmarshalCreateRuleRequest

func UnmarshalCreateRuleRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateRuleRequest unmarshals an instance of CreateRuleRequest from the specified map of raw messages.

func UnmarshalCreateRuleResponse

func UnmarshalCreateRuleResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateRuleResponse unmarshals an instance of CreateRuleResponse from the specified map of raw messages.

func UnmarshalCreateRulesResponse

func UnmarshalCreateRulesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateRulesResponse unmarshals an instance of CreateRulesResponse from the specified map of raw messages.

func UnmarshalCreateTemplateAttachmentsResponse added in v1.2.0

func UnmarshalCreateTemplateAttachmentsResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateTemplateAttachmentsResponse unmarshals an instance of CreateTemplateAttachmentsResponse from the specified map of raw messages.

func UnmarshalCreateTemplateRequest added in v1.2.0

func UnmarshalCreateTemplateRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateTemplateRequest unmarshals an instance of CreateTemplateRequest from the specified map of raw messages.

func UnmarshalCreateTemplateResponse added in v1.2.0

func UnmarshalCreateTemplateResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateTemplateResponse unmarshals an instance of CreateTemplateResponse from the specified map of raw messages.

func UnmarshalCreateTemplatesResponse added in v1.2.0

func UnmarshalCreateTemplatesResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalCreateTemplatesResponse unmarshals an instance of CreateTemplatesResponse from the specified map of raw messages.

func UnmarshalEnforcementAction

func UnmarshalEnforcementAction(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalEnforcementAction unmarshals an instance of EnforcementAction from the specified map of raw messages.

func UnmarshalLink(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalLink unmarshals an instance of Link from the specified map of raw messages.

func UnmarshalRule

func UnmarshalRule(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRule unmarshals an instance of Rule from the specified map of raw messages.

func UnmarshalRuleAttachment

func UnmarshalRuleAttachment(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleAttachment unmarshals an instance of RuleAttachment from the specified map of raw messages.

func UnmarshalRuleAttachmentList

func UnmarshalRuleAttachmentList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleAttachmentList unmarshals an instance of RuleAttachmentList from the specified map of raw messages.

func UnmarshalRuleAttachmentRequest

func UnmarshalRuleAttachmentRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleAttachmentRequest unmarshals an instance of RuleAttachmentRequest from the specified map of raw messages.

func UnmarshalRuleCondition

func UnmarshalRuleCondition(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleCondition unmarshals an instance of RuleCondition from the specified map of raw messages.

func UnmarshalRuleConditionAndLvl2

func UnmarshalRuleConditionAndLvl2(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleConditionAndLvl2 unmarshals an instance of RuleConditionAndLvl2 from the specified map of raw messages.

func UnmarshalRuleConditionOrLvl2

func UnmarshalRuleConditionOrLvl2(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleConditionOrLvl2 unmarshals an instance of RuleConditionOrLvl2 from the specified map of raw messages.

func UnmarshalRuleConditionSingleProperty

func UnmarshalRuleConditionSingleProperty(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleConditionSingleProperty unmarshals an instance of RuleConditionSingleProperty from the specified map of raw messages.

func UnmarshalRuleList

func UnmarshalRuleList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleList unmarshals an instance of RuleList from the specified map of raw messages.

func UnmarshalRuleRequest

func UnmarshalRuleRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleRequest unmarshals an instance of RuleRequest from the specified map of raw messages.

func UnmarshalRuleRequiredConfig

func UnmarshalRuleRequiredConfig(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleRequiredConfig unmarshals an instance of RuleRequiredConfig from the specified map of raw messages.

func UnmarshalRuleRequiredConfigMultipleProperties

func UnmarshalRuleRequiredConfigMultipleProperties(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleRequiredConfigMultipleProperties unmarshals an instance of RuleRequiredConfigMultipleProperties from the specified map of raw messages.

func UnmarshalRuleRequiredConfigMultiplePropertiesConditionAnd

func UnmarshalRuleRequiredConfigMultiplePropertiesConditionAnd(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleRequiredConfigMultiplePropertiesConditionAnd unmarshals an instance of RuleRequiredConfigMultiplePropertiesConditionAnd from the specified map of raw messages.

func UnmarshalRuleRequiredConfigMultiplePropertiesConditionOr

func UnmarshalRuleRequiredConfigMultiplePropertiesConditionOr(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleRequiredConfigMultiplePropertiesConditionOr unmarshals an instance of RuleRequiredConfigMultiplePropertiesConditionOr from the specified map of raw messages.

func UnmarshalRuleRequiredConfigSingleProperty

func UnmarshalRuleRequiredConfigSingleProperty(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleRequiredConfigSingleProperty unmarshals an instance of RuleRequiredConfigSingleProperty from the specified map of raw messages.

func UnmarshalRuleResponseError

func UnmarshalRuleResponseError(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleResponseError unmarshals an instance of RuleResponseError from the specified map of raw messages.

func UnmarshalRuleScope

func UnmarshalRuleScope(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleScope unmarshals an instance of RuleScope from the specified map of raw messages.

func UnmarshalRuleSingleProperty

func UnmarshalRuleSingleProperty(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalRuleSingleProperty unmarshals an instance of RuleSingleProperty from the specified map of raw messages.

func UnmarshalSimpleTargetResource added in v1.2.0

func UnmarshalSimpleTargetResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalSimpleTargetResource unmarshals an instance of SimpleTargetResource from the specified map of raw messages.

func UnmarshalTargetResource

func UnmarshalTargetResource(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTargetResource unmarshals an instance of TargetResource from the specified map of raw messages.

func UnmarshalTargetResourceAdditionalTargetAttributesItem

func UnmarshalTargetResourceAdditionalTargetAttributesItem(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTargetResourceAdditionalTargetAttributesItem unmarshals an instance of TargetResourceAdditionalTargetAttributesItem from the specified map of raw messages.

func UnmarshalTemplate added in v1.2.0

func UnmarshalTemplate(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplate unmarshals an instance of Template from the specified map of raw messages.

func UnmarshalTemplateAttachment

func UnmarshalTemplateAttachment(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateAttachment unmarshals an instance of TemplateAttachment from the specified map of raw messages.

func UnmarshalTemplateAttachmentList added in v1.2.0

func UnmarshalTemplateAttachmentList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateAttachmentList unmarshals an instance of TemplateAttachmentList from the specified map of raw messages.

func UnmarshalTemplateAttachmentRequest added in v1.2.0

func UnmarshalTemplateAttachmentRequest(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateAttachmentRequest unmarshals an instance of TemplateAttachmentRequest from the specified map of raw messages.

func UnmarshalTemplateCustomizedDefaultProperty added in v1.2.0

func UnmarshalTemplateCustomizedDefaultProperty(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateCustomizedDefaultProperty unmarshals an instance of TemplateCustomizedDefaultProperty from the specified map of raw messages.

func UnmarshalTemplateList added in v1.2.0

func UnmarshalTemplateList(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateList unmarshals an instance of TemplateList from the specified map of raw messages.

func UnmarshalTemplateResponse added in v1.2.0

func UnmarshalTemplateResponse(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateResponse unmarshals an instance of TemplateResponse from the specified map of raw messages.

func UnmarshalTemplateResponseError added in v1.2.0

func UnmarshalTemplateResponseError(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateResponseError unmarshals an instance of TemplateResponseError from the specified map of raw messages.

func UnmarshalTemplateScope

func UnmarshalTemplateScope(m map[string]json.RawMessage, result interface{}) (err error)

UnmarshalTemplateScope unmarshals an instance of TemplateScope from the specified map of raw messages.

Types

type BaseTargetAttribute added in v1.2.0

type BaseTargetAttribute struct {
	// The name of the additional attribute that you want to use to further qualify the target.
	//
	// Options differ depending on the service or resource that you are targeting with a rule or template. For more
	// information, refer to the service documentation.
	Name *string `json:"name" validate:"required"`

	// The value that you want to apply to `name` field.
	//
	// Options differ depending on the rule or template that you configure. For more information, refer to the service
	// documentation.
	Value *string `json:"value" validate:"required"`
}

BaseTargetAttribute : The attributes that are associated with a rule or template target.

type ConfigurationGovernanceV1

type ConfigurationGovernanceV1 struct {
	Service *core.BaseService
}

ConfigurationGovernanceV1 : API specification for the Configuration Governance service.

Version: 1.0.0

func NewConfigurationGovernanceV1

func NewConfigurationGovernanceV1(options *ConfigurationGovernanceV1Options) (service *ConfigurationGovernanceV1, err error)

NewConfigurationGovernanceV1 : constructs an instance of ConfigurationGovernanceV1 with passed in options.

func NewConfigurationGovernanceV1UsingExternalConfig

func NewConfigurationGovernanceV1UsingExternalConfig(options *ConfigurationGovernanceV1Options) (configurationGovernance *ConfigurationGovernanceV1, err error)

NewConfigurationGovernanceV1UsingExternalConfig : constructs an instance of ConfigurationGovernanceV1 with passed in options and external configuration.

func (*ConfigurationGovernanceV1) Clone

func (configurationGovernance *ConfigurationGovernanceV1) Clone() *ConfigurationGovernanceV1

Clone makes a copy of "configurationGovernance" suitable for processing requests.

func (*ConfigurationGovernanceV1) CreateRuleAttachments

func (configurationGovernance *ConfigurationGovernanceV1) CreateRuleAttachments(createRuleAttachmentsOptions *CreateRuleAttachmentsOptions) (result *CreateRuleAttachmentsResponse, response *core.DetailedResponse, err error)

CreateRuleAttachments : Create attachments Creates one or more scope attachments for an existing rule.

You can attach an existing rule to a scope, such as a specific IBM Cloud account, to start evaluating the rule for compliance. A successful `POST /config/v1/rules/{rule_id}/attachments` returns the ID value for the attachment, along with other metadata.

func (*ConfigurationGovernanceV1) CreateRuleAttachmentsWithContext

func (configurationGovernance *ConfigurationGovernanceV1) CreateRuleAttachmentsWithContext(ctx context.Context, createRuleAttachmentsOptions *CreateRuleAttachmentsOptions) (result *CreateRuleAttachmentsResponse, response *core.DetailedResponse, err error)

CreateRuleAttachmentsWithContext is an alternate form of the CreateRuleAttachments method which supports a Context parameter

func (*ConfigurationGovernanceV1) CreateRules

func (configurationGovernance *ConfigurationGovernanceV1) CreateRules(createRulesOptions *CreateRulesOptions) (result *CreateRulesResponse, response *core.DetailedResponse, err error)

CreateRules : Create rules Creates one or more rules that you can use to govern the way that IBM Cloud resources can be provisioned and configured.

A successful `POST /config/rules` request defines a rule based on the target, conditions, and enforcement actions that you specify. The response returns the ID value for your rule, along with other metadata.

To learn more about rules, check out the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule).

func (*ConfigurationGovernanceV1) CreateRulesWithContext

func (configurationGovernance *ConfigurationGovernanceV1) CreateRulesWithContext(ctx context.Context, createRulesOptions *CreateRulesOptions) (result *CreateRulesResponse, response *core.DetailedResponse, err error)

CreateRulesWithContext is an alternate form of the CreateRules method which supports a Context parameter

func (*ConfigurationGovernanceV1) CreateTemplateAttachments added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) CreateTemplateAttachments(createTemplateAttachmentsOptions *CreateTemplateAttachmentsOptions) (result *CreateTemplateAttachmentsResponse, response *core.DetailedResponse, err error)

CreateTemplateAttachments : Create attachments Creates one or more scope attachments for an existing template.

You can attach an existing template to a scope, such as a specific IBM Cloud account, to start using the template for setting default values. A successful `POST /config/v1/templates/{template_id}/attachments` returns the ID value for the attachment, along with other metadata.

func (*ConfigurationGovernanceV1) CreateTemplateAttachmentsWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) CreateTemplateAttachmentsWithContext(ctx context.Context, createTemplateAttachmentsOptions *CreateTemplateAttachmentsOptions) (result *CreateTemplateAttachmentsResponse, response *core.DetailedResponse, err error)

CreateTemplateAttachmentsWithContext is an alternate form of the CreateTemplateAttachments method which supports a Context parameter

func (*ConfigurationGovernanceV1) CreateTemplates added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) CreateTemplates(createTemplatesOptions *CreateTemplatesOptions) (result *CreateTemplatesResponse, response *core.DetailedResponse, err error)

CreateTemplates : Create templates Creates one or more templates that you can use to define your preferred property values for IBM Cloud resources.

A successful `POST /config/templates` request defines a template based on the target and customized defaults that you specify. The response returns the ID value for your template, along with other metadata.

To learn more about templates, check out the [docs](/docs/security-compliance?topic=security-compliance-what-is-template).

func (*ConfigurationGovernanceV1) CreateTemplatesWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) CreateTemplatesWithContext(ctx context.Context, createTemplatesOptions *CreateTemplatesOptions) (result *CreateTemplatesResponse, response *core.DetailedResponse, err error)

CreateTemplatesWithContext is an alternate form of the CreateTemplates method which supports a Context parameter

func (*ConfigurationGovernanceV1) DeleteRule

func (configurationGovernance *ConfigurationGovernanceV1) DeleteRule(deleteRuleOptions *DeleteRuleOptions) (response *core.DetailedResponse, err error)

DeleteRule : Delete a rule Deletes an existing rule.

func (*ConfigurationGovernanceV1) DeleteRuleAttachment

func (configurationGovernance *ConfigurationGovernanceV1) DeleteRuleAttachment(deleteRuleAttachmentOptions *DeleteRuleAttachmentOptions) (response *core.DetailedResponse, err error)

DeleteRuleAttachment : Delete an attachment Deletes an existing scope attachment.

func (*ConfigurationGovernanceV1) DeleteRuleAttachmentWithContext

func (configurationGovernance *ConfigurationGovernanceV1) DeleteRuleAttachmentWithContext(ctx context.Context, deleteRuleAttachmentOptions *DeleteRuleAttachmentOptions) (response *core.DetailedResponse, err error)

DeleteRuleAttachmentWithContext is an alternate form of the DeleteRuleAttachment method which supports a Context parameter

func (*ConfigurationGovernanceV1) DeleteRuleWithContext

func (configurationGovernance *ConfigurationGovernanceV1) DeleteRuleWithContext(ctx context.Context, deleteRuleOptions *DeleteRuleOptions) (response *core.DetailedResponse, err error)

DeleteRuleWithContext is an alternate form of the DeleteRule method which supports a Context parameter

func (*ConfigurationGovernanceV1) DeleteTemplate added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) DeleteTemplate(deleteTemplateOptions *DeleteTemplateOptions) (response *core.DetailedResponse, err error)

DeleteTemplate : Delete a template Deletes an existing template.

func (*ConfigurationGovernanceV1) DeleteTemplateAttachment added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) DeleteTemplateAttachment(deleteTemplateAttachmentOptions *DeleteTemplateAttachmentOptions) (response *core.DetailedResponse, err error)

DeleteTemplateAttachment : Delete an attachment Deletes an existing scope attachment.

func (*ConfigurationGovernanceV1) DeleteTemplateAttachmentWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) DeleteTemplateAttachmentWithContext(ctx context.Context, deleteTemplateAttachmentOptions *DeleteTemplateAttachmentOptions) (response *core.DetailedResponse, err error)

DeleteTemplateAttachmentWithContext is an alternate form of the DeleteTemplateAttachment method which supports a Context parameter

func (*ConfigurationGovernanceV1) DeleteTemplateWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) DeleteTemplateWithContext(ctx context.Context, deleteTemplateOptions *DeleteTemplateOptions) (response *core.DetailedResponse, err error)

DeleteTemplateWithContext is an alternate form of the DeleteTemplate method which supports a Context parameter

func (*ConfigurationGovernanceV1) DisableRetries

func (configurationGovernance *ConfigurationGovernanceV1) DisableRetries()

DisableRetries disables automatic retries for requests invoked for this service instance.

func (*ConfigurationGovernanceV1) EnableRetries

func (configurationGovernance *ConfigurationGovernanceV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)

EnableRetries enables automatic retries for requests invoked for this service instance. If either parameter is specified as 0, then a default value is used instead.

func (*ConfigurationGovernanceV1) GetEnableGzipCompression

func (configurationGovernance *ConfigurationGovernanceV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*ConfigurationGovernanceV1) GetRule

func (configurationGovernance *ConfigurationGovernanceV1) GetRule(getRuleOptions *GetRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

GetRule : Get a rule Retrieves an existing rule and its details.

func (*ConfigurationGovernanceV1) GetRuleAttachment

func (configurationGovernance *ConfigurationGovernanceV1) GetRuleAttachment(getRuleAttachmentOptions *GetRuleAttachmentOptions) (result *RuleAttachment, response *core.DetailedResponse, err error)

GetRuleAttachment : Get an attachment Retrieves an existing scope attachment for a rule.

func (*ConfigurationGovernanceV1) GetRuleAttachmentWithContext

func (configurationGovernance *ConfigurationGovernanceV1) GetRuleAttachmentWithContext(ctx context.Context, getRuleAttachmentOptions *GetRuleAttachmentOptions) (result *RuleAttachment, response *core.DetailedResponse, err error)

GetRuleAttachmentWithContext is an alternate form of the GetRuleAttachment method which supports a Context parameter

func (*ConfigurationGovernanceV1) GetRuleWithContext

func (configurationGovernance *ConfigurationGovernanceV1) GetRuleWithContext(ctx context.Context, getRuleOptions *GetRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

GetRuleWithContext is an alternate form of the GetRule method which supports a Context parameter

func (*ConfigurationGovernanceV1) GetServiceURL

func (configurationGovernance *ConfigurationGovernanceV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*ConfigurationGovernanceV1) GetTemplate added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) GetTemplate(getTemplateOptions *GetTemplateOptions) (result *TemplateResponse, response *core.DetailedResponse, err error)

GetTemplate : Get a template Retrieves an existing template and its details.

func (*ConfigurationGovernanceV1) GetTemplateAttachment added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) GetTemplateAttachment(getTemplateAttachmentOptions *GetTemplateAttachmentOptions) (result *TemplateAttachment, response *core.DetailedResponse, err error)

GetTemplateAttachment : Get an attachment Retrieves an existing scope attachment for a template.

func (*ConfigurationGovernanceV1) GetTemplateAttachmentWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) GetTemplateAttachmentWithContext(ctx context.Context, getTemplateAttachmentOptions *GetTemplateAttachmentOptions) (result *TemplateAttachment, response *core.DetailedResponse, err error)

GetTemplateAttachmentWithContext is an alternate form of the GetTemplateAttachment method which supports a Context parameter

func (*ConfigurationGovernanceV1) GetTemplateWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) GetTemplateWithContext(ctx context.Context, getTemplateOptions *GetTemplateOptions) (result *TemplateResponse, response *core.DetailedResponse, err error)

GetTemplateWithContext is an alternate form of the GetTemplate method which supports a Context parameter

func (*ConfigurationGovernanceV1) ListRuleAttachments

func (configurationGovernance *ConfigurationGovernanceV1) ListRuleAttachments(listRuleAttachmentsOptions *ListRuleAttachmentsOptions) (result *RuleAttachmentList, response *core.DetailedResponse, err error)

ListRuleAttachments : List attachments Retrieves a list of scope attachments that are associated with the specified rule.

func (*ConfigurationGovernanceV1) ListRuleAttachmentsWithContext

func (configurationGovernance *ConfigurationGovernanceV1) ListRuleAttachmentsWithContext(ctx context.Context, listRuleAttachmentsOptions *ListRuleAttachmentsOptions) (result *RuleAttachmentList, response *core.DetailedResponse, err error)

ListRuleAttachmentsWithContext is an alternate form of the ListRuleAttachments method which supports a Context parameter

func (*ConfigurationGovernanceV1) ListRules

func (configurationGovernance *ConfigurationGovernanceV1) ListRules(listRulesOptions *ListRulesOptions) (result *RuleList, response *core.DetailedResponse, err error)

ListRules : List rules Retrieves a list of the rules that are available in your account.

func (*ConfigurationGovernanceV1) ListRulesWithContext

func (configurationGovernance *ConfigurationGovernanceV1) ListRulesWithContext(ctx context.Context, listRulesOptions *ListRulesOptions) (result *RuleList, response *core.DetailedResponse, err error)

ListRulesWithContext is an alternate form of the ListRules method which supports a Context parameter

func (*ConfigurationGovernanceV1) ListTemplateAttachments added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) ListTemplateAttachments(listTemplateAttachmentsOptions *ListTemplateAttachmentsOptions) (result *TemplateAttachmentList, response *core.DetailedResponse, err error)

ListTemplateAttachments : List attachments Retrieves a list of scope attachments that are associated with the specified template.

func (*ConfigurationGovernanceV1) ListTemplateAttachmentsWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) ListTemplateAttachmentsWithContext(ctx context.Context, listTemplateAttachmentsOptions *ListTemplateAttachmentsOptions) (result *TemplateAttachmentList, response *core.DetailedResponse, err error)

ListTemplateAttachmentsWithContext is an alternate form of the ListTemplateAttachments method which supports a Context parameter

func (*ConfigurationGovernanceV1) ListTemplates added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) ListTemplates(listTemplatesOptions *ListTemplatesOptions) (result *TemplateList, response *core.DetailedResponse, err error)

ListTemplates : List templates Retrieves a list of the templates that are available in your account.

func (*ConfigurationGovernanceV1) ListTemplatesWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) ListTemplatesWithContext(ctx context.Context, listTemplatesOptions *ListTemplatesOptions) (result *TemplateList, response *core.DetailedResponse, err error)

ListTemplatesWithContext is an alternate form of the ListTemplates method which supports a Context parameter

func (*ConfigurationGovernanceV1) NewBaseTargetAttribute added in v1.2.0

func (*ConfigurationGovernanceV1) NewBaseTargetAttribute(name string, value string) (_model *BaseTargetAttribute, err error)

NewBaseTargetAttribute : Instantiate BaseTargetAttribute (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewCreateRuleAttachmentsOptions

func (*ConfigurationGovernanceV1) NewCreateRuleAttachmentsOptions(ruleID string, attachments []RuleAttachmentRequest) *CreateRuleAttachmentsOptions

NewCreateRuleAttachmentsOptions : Instantiate CreateRuleAttachmentsOptions

func (*ConfigurationGovernanceV1) NewCreateRuleRequest

func (*ConfigurationGovernanceV1) NewCreateRuleRequest(rule *RuleRequest) (_model *CreateRuleRequest, err error)

NewCreateRuleRequest : Instantiate CreateRuleRequest (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewCreateRulesOptions

func (*ConfigurationGovernanceV1) NewCreateRulesOptions(rules []CreateRuleRequest) *CreateRulesOptions

NewCreateRulesOptions : Instantiate CreateRulesOptions

func (*ConfigurationGovernanceV1) NewCreateTemplateAttachmentsOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewCreateTemplateAttachmentsOptions(templateID string, attachments []TemplateAttachmentRequest) *CreateTemplateAttachmentsOptions

NewCreateTemplateAttachmentsOptions : Instantiate CreateTemplateAttachmentsOptions

func (*ConfigurationGovernanceV1) NewCreateTemplateRequest added in v1.2.0

func (*ConfigurationGovernanceV1) NewCreateTemplateRequest(template *Template) (_model *CreateTemplateRequest, err error)

NewCreateTemplateRequest : Instantiate CreateTemplateRequest (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewCreateTemplatesOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewCreateTemplatesOptions(templates []CreateTemplateRequest) *CreateTemplatesOptions

NewCreateTemplatesOptions : Instantiate CreateTemplatesOptions

func (*ConfigurationGovernanceV1) NewDeleteRuleAttachmentOptions

func (*ConfigurationGovernanceV1) NewDeleteRuleAttachmentOptions(ruleID string, attachmentID string) *DeleteRuleAttachmentOptions

NewDeleteRuleAttachmentOptions : Instantiate DeleteRuleAttachmentOptions

func (*ConfigurationGovernanceV1) NewDeleteRuleOptions

func (*ConfigurationGovernanceV1) NewDeleteRuleOptions(ruleID string) *DeleteRuleOptions

NewDeleteRuleOptions : Instantiate DeleteRuleOptions

func (*ConfigurationGovernanceV1) NewDeleteTemplateAttachmentOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewDeleteTemplateAttachmentOptions(templateID string, attachmentID string) *DeleteTemplateAttachmentOptions

NewDeleteTemplateAttachmentOptions : Instantiate DeleteTemplateAttachmentOptions

func (*ConfigurationGovernanceV1) NewDeleteTemplateOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewDeleteTemplateOptions(templateID string) *DeleteTemplateOptions

NewDeleteTemplateOptions : Instantiate DeleteTemplateOptions

func (*ConfigurationGovernanceV1) NewEnforcementAction

func (*ConfigurationGovernanceV1) NewEnforcementAction(action string) (_model *EnforcementAction, err error)

NewEnforcementAction : Instantiate EnforcementAction (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewGetRuleAttachmentOptions

func (*ConfigurationGovernanceV1) NewGetRuleAttachmentOptions(ruleID string, attachmentID string) *GetRuleAttachmentOptions

NewGetRuleAttachmentOptions : Instantiate GetRuleAttachmentOptions

func (*ConfigurationGovernanceV1) NewGetRuleOptions

func (*ConfigurationGovernanceV1) NewGetRuleOptions(ruleID string) *GetRuleOptions

NewGetRuleOptions : Instantiate GetRuleOptions

func (*ConfigurationGovernanceV1) NewGetTemplateAttachmentOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewGetTemplateAttachmentOptions(templateID string, attachmentID string) *GetTemplateAttachmentOptions

NewGetTemplateAttachmentOptions : Instantiate GetTemplateAttachmentOptions

func (*ConfigurationGovernanceV1) NewGetTemplateOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewGetTemplateOptions(templateID string) *GetTemplateOptions

NewGetTemplateOptions : Instantiate GetTemplateOptions

func (*ConfigurationGovernanceV1) NewListRuleAttachmentsOptions

func (*ConfigurationGovernanceV1) NewListRuleAttachmentsOptions(ruleID string) *ListRuleAttachmentsOptions

NewListRuleAttachmentsOptions : Instantiate ListRuleAttachmentsOptions

func (*ConfigurationGovernanceV1) NewListRulesOptions

func (*ConfigurationGovernanceV1) NewListRulesOptions(accountID string) *ListRulesOptions

NewListRulesOptions : Instantiate ListRulesOptions

func (*ConfigurationGovernanceV1) NewListTemplateAttachmentsOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewListTemplateAttachmentsOptions(templateID string) *ListTemplateAttachmentsOptions

NewListTemplateAttachmentsOptions : Instantiate ListTemplateAttachmentsOptions

func (*ConfigurationGovernanceV1) NewListTemplatesOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewListTemplatesOptions(accountID string) *ListTemplatesOptions

NewListTemplatesOptions : Instantiate ListTemplatesOptions

func (*ConfigurationGovernanceV1) NewRuleAttachmentRequest

func (*ConfigurationGovernanceV1) NewRuleAttachmentRequest(accountID string, includedScope *RuleScope) (_model *RuleAttachmentRequest, err error)

NewRuleAttachmentRequest : Instantiate RuleAttachmentRequest (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleConditionAndLvl2

func (*ConfigurationGovernanceV1) NewRuleConditionAndLvl2(and []RuleSingleProperty) (_model *RuleConditionAndLvl2, err error)

NewRuleConditionAndLvl2 : Instantiate RuleConditionAndLvl2 (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleConditionOrLvl2

func (*ConfigurationGovernanceV1) NewRuleConditionOrLvl2(or []RuleSingleProperty) (_model *RuleConditionOrLvl2, err error)

NewRuleConditionOrLvl2 : Instantiate RuleConditionOrLvl2 (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleConditionSingleProperty

func (*ConfigurationGovernanceV1) NewRuleConditionSingleProperty(property string, operator string) (_model *RuleConditionSingleProperty, err error)

NewRuleConditionSingleProperty : Instantiate RuleConditionSingleProperty (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleRequest

func (*ConfigurationGovernanceV1) NewRuleRequest(name string, description string, target *TargetResource, requiredConfig RuleRequiredConfigIntf, enforcementActions []EnforcementAction) (_model *RuleRequest, err error)

NewRuleRequest : Instantiate RuleRequest (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleRequiredConfigMultiplePropertiesConditionAnd

func (*ConfigurationGovernanceV1) NewRuleRequiredConfigMultiplePropertiesConditionAnd(and []RuleConditionIntf) (_model *RuleRequiredConfigMultiplePropertiesConditionAnd, err error)

NewRuleRequiredConfigMultiplePropertiesConditionAnd : Instantiate RuleRequiredConfigMultiplePropertiesConditionAnd (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleRequiredConfigMultiplePropertiesConditionOr

func (*ConfigurationGovernanceV1) NewRuleRequiredConfigMultiplePropertiesConditionOr(or []RuleConditionIntf) (_model *RuleRequiredConfigMultiplePropertiesConditionOr, err error)

NewRuleRequiredConfigMultiplePropertiesConditionOr : Instantiate RuleRequiredConfigMultiplePropertiesConditionOr (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleRequiredConfigSingleProperty

func (*ConfigurationGovernanceV1) NewRuleRequiredConfigSingleProperty(property string, operator string) (_model *RuleRequiredConfigSingleProperty, err error)

NewRuleRequiredConfigSingleProperty : Instantiate RuleRequiredConfigSingleProperty (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleScope

func (*ConfigurationGovernanceV1) NewRuleScope(scopeID string, scopeType string) (_model *RuleScope, err error)

NewRuleScope : Instantiate RuleScope (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewRuleSingleProperty

func (*ConfigurationGovernanceV1) NewRuleSingleProperty(property string, operator string) (_model *RuleSingleProperty, err error)

NewRuleSingleProperty : Instantiate RuleSingleProperty (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewSimpleTargetResource added in v1.2.0

func (*ConfigurationGovernanceV1) NewSimpleTargetResource(serviceName string, resourceKind string) (_model *SimpleTargetResource, err error)

NewSimpleTargetResource : Instantiate SimpleTargetResource (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewTargetResource

func (*ConfigurationGovernanceV1) NewTargetResource(serviceName string, resourceKind string) (_model *TargetResource, err error)

NewTargetResource : Instantiate TargetResource (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewTargetResourceAdditionalTargetAttributesItem

func (*ConfigurationGovernanceV1) NewTargetResourceAdditionalTargetAttributesItem(name string, value string, operator string) (_model *TargetResourceAdditionalTargetAttributesItem, err error)

NewTargetResourceAdditionalTargetAttributesItem : Instantiate TargetResourceAdditionalTargetAttributesItem (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewTemplate added in v1.2.0

func (*ConfigurationGovernanceV1) NewTemplate(accountID string, name string, description string, target *SimpleTargetResource, customizedDefaults []TemplateCustomizedDefaultProperty) (_model *Template, err error)

NewTemplate : Instantiate Template (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewTemplateAttachmentRequest added in v1.2.0

func (*ConfigurationGovernanceV1) NewTemplateAttachmentRequest(accountID string, includedScope *TemplateScope) (_model *TemplateAttachmentRequest, err error)

NewTemplateAttachmentRequest : Instantiate TemplateAttachmentRequest (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewTemplateCustomizedDefaultProperty added in v1.2.0

func (*ConfigurationGovernanceV1) NewTemplateCustomizedDefaultProperty(property string, value string) (_model *TemplateCustomizedDefaultProperty, err error)

NewTemplateCustomizedDefaultProperty : Instantiate TemplateCustomizedDefaultProperty (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewTemplateScope added in v1.2.0

func (*ConfigurationGovernanceV1) NewTemplateScope(scopeID string, scopeType string) (_model *TemplateScope, err error)

NewTemplateScope : Instantiate TemplateScope (Generic Model Constructor)

func (*ConfigurationGovernanceV1) NewUpdateRuleAttachmentOptions

func (*ConfigurationGovernanceV1) NewUpdateRuleAttachmentOptions(ruleID string, attachmentID string, ifMatch string, accountID string, includedScope *RuleScope) *UpdateRuleAttachmentOptions

NewUpdateRuleAttachmentOptions : Instantiate UpdateRuleAttachmentOptions

func (*ConfigurationGovernanceV1) NewUpdateRuleOptions

func (*ConfigurationGovernanceV1) NewUpdateRuleOptions(ruleID string, ifMatch string, name string, description string, target *TargetResource, requiredConfig RuleRequiredConfigIntf, enforcementActions []EnforcementAction) *UpdateRuleOptions

NewUpdateRuleOptions : Instantiate UpdateRuleOptions

func (*ConfigurationGovernanceV1) NewUpdateTemplateAttachmentOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewUpdateTemplateAttachmentOptions(templateID string, attachmentID string, ifMatch string, accountID string, includedScope *TemplateScope) *UpdateTemplateAttachmentOptions

NewUpdateTemplateAttachmentOptions : Instantiate UpdateTemplateAttachmentOptions

func (*ConfigurationGovernanceV1) NewUpdateTemplateOptions added in v1.2.0

func (*ConfigurationGovernanceV1) NewUpdateTemplateOptions(templateID string, ifMatch string, accountID string, name string, description string, target *SimpleTargetResource, customizedDefaults []TemplateCustomizedDefaultProperty) *UpdateTemplateOptions

NewUpdateTemplateOptions : Instantiate UpdateTemplateOptions

func (*ConfigurationGovernanceV1) SetDefaultHeaders

func (configurationGovernance *ConfigurationGovernanceV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*ConfigurationGovernanceV1) SetEnableGzipCompression

func (configurationGovernance *ConfigurationGovernanceV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*ConfigurationGovernanceV1) SetServiceURL

func (configurationGovernance *ConfigurationGovernanceV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*ConfigurationGovernanceV1) UpdateRule

func (configurationGovernance *ConfigurationGovernanceV1) UpdateRule(updateRuleOptions *UpdateRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

UpdateRule : Update a rule Updates an existing rule based on the properties that you specify.

func (*ConfigurationGovernanceV1) UpdateRuleAttachment

func (configurationGovernance *ConfigurationGovernanceV1) UpdateRuleAttachment(updateRuleAttachmentOptions *UpdateRuleAttachmentOptions) (result *TemplateAttachment, response *core.DetailedResponse, err error)

UpdateRuleAttachment : Update an attachment Updates an existing scope attachment based on the properties that you specify.

func (*ConfigurationGovernanceV1) UpdateRuleAttachmentWithContext

func (configurationGovernance *ConfigurationGovernanceV1) UpdateRuleAttachmentWithContext(ctx context.Context, updateRuleAttachmentOptions *UpdateRuleAttachmentOptions) (result *TemplateAttachment, response *core.DetailedResponse, err error)

UpdateRuleAttachmentWithContext is an alternate form of the UpdateRuleAttachment method which supports a Context parameter

func (*ConfigurationGovernanceV1) UpdateRuleWithContext

func (configurationGovernance *ConfigurationGovernanceV1) UpdateRuleWithContext(ctx context.Context, updateRuleOptions *UpdateRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

UpdateRuleWithContext is an alternate form of the UpdateRule method which supports a Context parameter

func (*ConfigurationGovernanceV1) UpdateTemplate added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) UpdateTemplate(updateTemplateOptions *UpdateTemplateOptions) (result *TemplateResponse, response *core.DetailedResponse, err error)

UpdateTemplate : Update a template Updates an existing template based on the properties that you specify.

func (*ConfigurationGovernanceV1) UpdateTemplateAttachment added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) UpdateTemplateAttachment(updateTemplateAttachmentOptions *UpdateTemplateAttachmentOptions) (result *TemplateAttachment, response *core.DetailedResponse, err error)

UpdateTemplateAttachment : Update an attachment Updates an existing scope attachment based on the properties that you specify.

func (*ConfigurationGovernanceV1) UpdateTemplateAttachmentWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) UpdateTemplateAttachmentWithContext(ctx context.Context, updateTemplateAttachmentOptions *UpdateTemplateAttachmentOptions) (result *TemplateAttachment, response *core.DetailedResponse, err error)

UpdateTemplateAttachmentWithContext is an alternate form of the UpdateTemplateAttachment method which supports a Context parameter

func (*ConfigurationGovernanceV1) UpdateTemplateWithContext added in v1.2.0

func (configurationGovernance *ConfigurationGovernanceV1) UpdateTemplateWithContext(ctx context.Context, updateTemplateOptions *UpdateTemplateOptions) (result *TemplateResponse, response *core.DetailedResponse, err error)

UpdateTemplateWithContext is an alternate form of the UpdateTemplate method which supports a Context parameter

type ConfigurationGovernanceV1Options

type ConfigurationGovernanceV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
}

ConfigurationGovernanceV1Options : Service options

type CreateRuleAttachmentsOptions

type CreateRuleAttachmentsOptions struct {
	// The UUID that uniquely identifies the rule.
	RuleID *string `validate:"required,ne="`

	Attachments []RuleAttachmentRequest `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateRuleAttachmentsOptions : The CreateRuleAttachments options.

func (*CreateRuleAttachmentsOptions) SetAttachments

func (_options *CreateRuleAttachmentsOptions) SetAttachments(attachments []RuleAttachmentRequest) *CreateRuleAttachmentsOptions

SetAttachments : Allow user to set Attachments

func (*CreateRuleAttachmentsOptions) SetHeaders

SetHeaders : Allow user to set Headers

func (*CreateRuleAttachmentsOptions) SetRuleID

SetRuleID : Allow user to set RuleID

func (*CreateRuleAttachmentsOptions) SetTransactionID

func (_options *CreateRuleAttachmentsOptions) SetTransactionID(transactionID string) *CreateRuleAttachmentsOptions

SetTransactionID : Allow user to set TransactionID

type CreateRuleAttachmentsResponse

type CreateRuleAttachmentsResponse struct {
	Attachments []RuleAttachment `json:"attachments" validate:"required"`
}

CreateRuleAttachmentsResponse : CreateRuleAttachmentsResponse struct

type CreateRuleRequest

type CreateRuleRequest struct {
	// A field that you can use in bulk operations to store a custom identifier for an individual request. If you omit this
	// field, the service generates and sends a `request_id` string for each new rule. The generated string corresponds
	// with the numerical order of the rules request array. For example, `"request_id": "1"`, `"request_id": "2"`.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `request_id` with
	// each request.
	RequestID *string `json:"request_id,omitempty"`

	// Properties that you can associate with a rule.
	Rule *RuleRequest `json:"rule" validate:"required"`
}

CreateRuleRequest : A rule to be created.

type CreateRuleResponse

type CreateRuleResponse struct {
	// The identifier that is used to correlate an individual request.
	//
	// To assist with debugging, you can use this ID to identify and inspect only one request that was made as part of a
	// bulk operation.
	RequestID *string `json:"request_id,omitempty"`

	// The HTTP response status code.
	StatusCode *int64 `json:"status_code,omitempty"`

	// Information about a newly-created rule.
	//
	// This field is present for successful requests.
	Rule *Rule `json:"rule,omitempty"`

	// The error contents of the multi-status response.
	//
	// This field is present for unsuccessful requests.
	Errors []RuleResponseError `json:"errors,omitempty"`

	// The UUID that uniquely identifies the request.
	//
	// This field is present for unsuccessful requests.
	Trace *string `json:"trace,omitempty"`
}

CreateRuleResponse : Response information for a rule request.

If the 'status_code' property indicates success, the 'request_id' and 'rule' properties are returned in the response. If the 'status_code' property indicates an error, the 'request_id', 'errors', and 'trace' fields are returned.

type CreateRulesOptions

type CreateRulesOptions struct {
	// A list of rules to be created.
	Rules []CreateRuleRequest `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateRulesOptions : The CreateRules options.

func (*CreateRulesOptions) SetHeaders

func (options *CreateRulesOptions) SetHeaders(param map[string]string) *CreateRulesOptions

SetHeaders : Allow user to set Headers

func (*CreateRulesOptions) SetRules

func (_options *CreateRulesOptions) SetRules(rules []CreateRuleRequest) *CreateRulesOptions

SetRules : Allow user to set Rules

func (*CreateRulesOptions) SetTransactionID

func (_options *CreateRulesOptions) SetTransactionID(transactionID string) *CreateRulesOptions

SetTransactionID : Allow user to set TransactionID

type CreateRulesResponse

type CreateRulesResponse struct {
	// An array of rule responses.
	Rules []CreateRuleResponse `json:"rules" validate:"required"`
}

CreateRulesResponse : The response associated with a request to create one or more rules.

type CreateTemplateAttachmentsOptions added in v1.2.0

type CreateTemplateAttachmentsOptions struct {
	// The UUID that uniquely identifies the template.
	TemplateID *string `validate:"required,ne="`

	Attachments []TemplateAttachmentRequest `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateTemplateAttachmentsOptions : The CreateTemplateAttachments options.

func (*CreateTemplateAttachmentsOptions) SetAttachments added in v1.2.0

SetAttachments : Allow user to set Attachments

func (*CreateTemplateAttachmentsOptions) SetHeaders added in v1.2.0

SetHeaders : Allow user to set Headers

func (*CreateTemplateAttachmentsOptions) SetTemplateID added in v1.2.0

func (_options *CreateTemplateAttachmentsOptions) SetTemplateID(templateID string) *CreateTemplateAttachmentsOptions

SetTemplateID : Allow user to set TemplateID

func (*CreateTemplateAttachmentsOptions) SetTransactionID added in v1.2.0

func (_options *CreateTemplateAttachmentsOptions) SetTransactionID(transactionID string) *CreateTemplateAttachmentsOptions

SetTransactionID : Allow user to set TransactionID

type CreateTemplateAttachmentsResponse added in v1.2.0

type CreateTemplateAttachmentsResponse struct {
	Attachments []TemplateAttachment `json:"attachments" validate:"required"`
}

CreateTemplateAttachmentsResponse : CreateTemplateAttachmentsResponse struct

type CreateTemplateRequest added in v1.2.0

type CreateTemplateRequest struct {
	// A field that you can use in bulk operations to store a custom identifier for an individual request. If you omit this
	// field, the service generates and sends a `request_id` string for each new template. The generated string corresponds
	// with the numerical order of the templates request array. For example, `"request_id": "1"`,
	// `"request_id": "2"`.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `request_id` with
	// each request.
	RequestID *string `json:"request_id,omitempty"`

	// Properties that you can associate with a template.
	Template *Template `json:"template" validate:"required"`
}

CreateTemplateRequest : A template to be created.

type CreateTemplateResponse added in v1.2.0

type CreateTemplateResponse struct {
	// The identifier that is used to correlate an individual request.
	//
	// To assist with debugging, you can use this ID to identify and inspect only one request that was made as part of a
	// bulk operation.
	RequestID *string `json:"request_id,omitempty"`

	// The HTTP response status code.
	StatusCode *int64 `json:"status_code,omitempty"`

	// Information about a newly-created template.
	//
	// This field is present for successful requests.
	Template *Template `json:"template,omitempty"`

	// The error contents of the multi-status response.
	//
	// This field is present for unsuccessful requests.
	Errors []TemplateResponseError `json:"errors,omitempty"`

	// The UUID that uniquely identifies the request.
	//
	// This field is present for unsuccessful requests.
	Trace *string `json:"trace,omitempty"`
}

CreateTemplateResponse : Response information for a template request.

If the 'status_code' property indicates success, the 'request_id' and 'template' properties is returned in the response. If the 'status_code' property indicates an error, the 'request_id', 'errors', and 'trace' fields are returned.

type CreateTemplatesOptions added in v1.2.0

type CreateTemplatesOptions struct {
	// A list of templates to be created.
	Templates []CreateTemplateRequest `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

CreateTemplatesOptions : The CreateTemplates options.

func (*CreateTemplatesOptions) SetHeaders added in v1.2.0

func (options *CreateTemplatesOptions) SetHeaders(param map[string]string) *CreateTemplatesOptions

SetHeaders : Allow user to set Headers

func (*CreateTemplatesOptions) SetTemplates added in v1.2.0

func (_options *CreateTemplatesOptions) SetTemplates(templates []CreateTemplateRequest) *CreateTemplatesOptions

SetTemplates : Allow user to set Templates

func (*CreateTemplatesOptions) SetTransactionID added in v1.2.0

func (_options *CreateTemplatesOptions) SetTransactionID(transactionID string) *CreateTemplatesOptions

SetTransactionID : Allow user to set TransactionID

type CreateTemplatesResponse added in v1.2.0

type CreateTemplatesResponse struct {
	// An array of template responses.
	Templates []CreateTemplateResponse `json:"templates" validate:"required"`
}

CreateTemplatesResponse : The response associated with a request to create one or more templates.

type DeleteRuleAttachmentOptions

type DeleteRuleAttachmentOptions struct {
	// The UUID that uniquely identifies the rule.
	RuleID *string `validate:"required,ne="`

	// The UUID that uniquely identifies the attachment.
	AttachmentID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteRuleAttachmentOptions : The DeleteRuleAttachment options.

func (*DeleteRuleAttachmentOptions) SetAttachmentID

func (_options *DeleteRuleAttachmentOptions) SetAttachmentID(attachmentID string) *DeleteRuleAttachmentOptions

SetAttachmentID : Allow user to set AttachmentID

func (*DeleteRuleAttachmentOptions) SetHeaders

func (options *DeleteRuleAttachmentOptions) SetHeaders(param map[string]string) *DeleteRuleAttachmentOptions

SetHeaders : Allow user to set Headers

func (*DeleteRuleAttachmentOptions) SetRuleID

func (_options *DeleteRuleAttachmentOptions) SetRuleID(ruleID string) *DeleteRuleAttachmentOptions

SetRuleID : Allow user to set RuleID

func (*DeleteRuleAttachmentOptions) SetTransactionID

func (_options *DeleteRuleAttachmentOptions) SetTransactionID(transactionID string) *DeleteRuleAttachmentOptions

SetTransactionID : Allow user to set TransactionID

type DeleteRuleOptions

type DeleteRuleOptions struct {
	// The UUID that uniquely identifies the rule.
	RuleID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteRuleOptions : The DeleteRule options.

func (*DeleteRuleOptions) SetHeaders

func (options *DeleteRuleOptions) SetHeaders(param map[string]string) *DeleteRuleOptions

SetHeaders : Allow user to set Headers

func (*DeleteRuleOptions) SetRuleID

func (_options *DeleteRuleOptions) SetRuleID(ruleID string) *DeleteRuleOptions

SetRuleID : Allow user to set RuleID

func (*DeleteRuleOptions) SetTransactionID

func (_options *DeleteRuleOptions) SetTransactionID(transactionID string) *DeleteRuleOptions

SetTransactionID : Allow user to set TransactionID

type DeleteTemplateAttachmentOptions added in v1.2.0

type DeleteTemplateAttachmentOptions struct {
	// The UUID that uniquely identifies the template.
	TemplateID *string `validate:"required,ne="`

	// The UUID that uniquely identifies the attachment.
	AttachmentID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteTemplateAttachmentOptions : The DeleteTemplateAttachment options.

func (*DeleteTemplateAttachmentOptions) SetAttachmentID added in v1.2.0

func (_options *DeleteTemplateAttachmentOptions) SetAttachmentID(attachmentID string) *DeleteTemplateAttachmentOptions

SetAttachmentID : Allow user to set AttachmentID

func (*DeleteTemplateAttachmentOptions) SetHeaders added in v1.2.0

SetHeaders : Allow user to set Headers

func (*DeleteTemplateAttachmentOptions) SetTemplateID added in v1.2.0

func (_options *DeleteTemplateAttachmentOptions) SetTemplateID(templateID string) *DeleteTemplateAttachmentOptions

SetTemplateID : Allow user to set TemplateID

func (*DeleteTemplateAttachmentOptions) SetTransactionID added in v1.2.0

func (_options *DeleteTemplateAttachmentOptions) SetTransactionID(transactionID string) *DeleteTemplateAttachmentOptions

SetTransactionID : Allow user to set TransactionID

type DeleteTemplateOptions added in v1.2.0

type DeleteTemplateOptions struct {
	// The UUID that uniquely identifies the template.
	TemplateID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

DeleteTemplateOptions : The DeleteTemplate options.

func (*DeleteTemplateOptions) SetHeaders added in v1.2.0

func (options *DeleteTemplateOptions) SetHeaders(param map[string]string) *DeleteTemplateOptions

SetHeaders : Allow user to set Headers

func (*DeleteTemplateOptions) SetTemplateID added in v1.2.0

func (_options *DeleteTemplateOptions) SetTemplateID(templateID string) *DeleteTemplateOptions

SetTemplateID : Allow user to set TemplateID

func (*DeleteTemplateOptions) SetTransactionID added in v1.2.0

func (_options *DeleteTemplateOptions) SetTransactionID(transactionID string) *DeleteTemplateOptions

SetTransactionID : Allow user to set TransactionID

type EnforcementAction

type EnforcementAction struct {
	// To block a request from completing, use `disallow`. To log the request to Activity Tracker with LogDNA, use
	// `audit_log`.
	Action *string `json:"action" validate:"required"`
}

EnforcementAction : EnforcementAction struct

type GetRuleAttachmentOptions

type GetRuleAttachmentOptions struct {
	// The UUID that uniquely identifies the rule.
	RuleID *string `validate:"required,ne="`

	// The UUID that uniquely identifies the attachment.
	AttachmentID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetRuleAttachmentOptions : The GetRuleAttachment options.

func (*GetRuleAttachmentOptions) SetAttachmentID

func (_options *GetRuleAttachmentOptions) SetAttachmentID(attachmentID string) *GetRuleAttachmentOptions

SetAttachmentID : Allow user to set AttachmentID

func (*GetRuleAttachmentOptions) SetHeaders

func (options *GetRuleAttachmentOptions) SetHeaders(param map[string]string) *GetRuleAttachmentOptions

SetHeaders : Allow user to set Headers

func (*GetRuleAttachmentOptions) SetRuleID

func (_options *GetRuleAttachmentOptions) SetRuleID(ruleID string) *GetRuleAttachmentOptions

SetRuleID : Allow user to set RuleID

func (*GetRuleAttachmentOptions) SetTransactionID

func (_options *GetRuleAttachmentOptions) SetTransactionID(transactionID string) *GetRuleAttachmentOptions

SetTransactionID : Allow user to set TransactionID

type GetRuleOptions

type GetRuleOptions struct {
	// The UUID that uniquely identifies the rule.
	RuleID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetRuleOptions : The GetRule options.

func (*GetRuleOptions) SetHeaders

func (options *GetRuleOptions) SetHeaders(param map[string]string) *GetRuleOptions

SetHeaders : Allow user to set Headers

func (*GetRuleOptions) SetRuleID

func (_options *GetRuleOptions) SetRuleID(ruleID string) *GetRuleOptions

SetRuleID : Allow user to set RuleID

func (*GetRuleOptions) SetTransactionID

func (_options *GetRuleOptions) SetTransactionID(transactionID string) *GetRuleOptions

SetTransactionID : Allow user to set TransactionID

type GetTemplateAttachmentOptions added in v1.2.0

type GetTemplateAttachmentOptions struct {
	// The UUID that uniquely identifies the template.
	TemplateID *string `validate:"required,ne="`

	// The UUID that uniquely identifies the attachment.
	AttachmentID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetTemplateAttachmentOptions : The GetTemplateAttachment options.

func (*GetTemplateAttachmentOptions) SetAttachmentID added in v1.2.0

func (_options *GetTemplateAttachmentOptions) SetAttachmentID(attachmentID string) *GetTemplateAttachmentOptions

SetAttachmentID : Allow user to set AttachmentID

func (*GetTemplateAttachmentOptions) SetHeaders added in v1.2.0

SetHeaders : Allow user to set Headers

func (*GetTemplateAttachmentOptions) SetTemplateID added in v1.2.0

func (_options *GetTemplateAttachmentOptions) SetTemplateID(templateID string) *GetTemplateAttachmentOptions

SetTemplateID : Allow user to set TemplateID

func (*GetTemplateAttachmentOptions) SetTransactionID added in v1.2.0

func (_options *GetTemplateAttachmentOptions) SetTransactionID(transactionID string) *GetTemplateAttachmentOptions

SetTransactionID : Allow user to set TransactionID

type GetTemplateOptions added in v1.2.0

type GetTemplateOptions struct {
	// The UUID that uniquely identifies the template.
	TemplateID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

GetTemplateOptions : The GetTemplate options.

func (*GetTemplateOptions) SetHeaders added in v1.2.0

func (options *GetTemplateOptions) SetHeaders(param map[string]string) *GetTemplateOptions

SetHeaders : Allow user to set Headers

func (*GetTemplateOptions) SetTemplateID added in v1.2.0

func (_options *GetTemplateOptions) SetTemplateID(templateID string) *GetTemplateOptions

SetTemplateID : Allow user to set TemplateID

func (*GetTemplateOptions) SetTransactionID added in v1.2.0

func (_options *GetTemplateOptions) SetTransactionID(transactionID string) *GetTemplateOptions

SetTransactionID : Allow user to set TransactionID

type Link struct {
	// The URL for the first, previous, next, or last page of resources.
	Href *string `json:"href" validate:"required"`
}

Link : A link that is used to paginate through available resources.

type ListRuleAttachmentsOptions

type ListRuleAttachmentsOptions struct {
	// The UUID that uniquely identifies the rule.
	RuleID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// The number of resources to retrieve. By default, list operations return the first 100 items. To retrieve a different
	// set of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 rules, and you want to retrieve only the first 5 rules, use
	// `../rules?account_id={account_id}&limit=5`.
	Limit *int64

	// The number of resources to skip. By specifying `offset`, you retrieve a subset of resources that starts with the
	// `offset` value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 rules, and you want to retrieve rules 26 through 50, use
	// `../rules?account_id={account_id}&offset=25&limit=5`.
	Offset *int64

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListRuleAttachmentsOptions : The ListRuleAttachments options.

func (*ListRuleAttachmentsOptions) SetHeaders

func (options *ListRuleAttachmentsOptions) SetHeaders(param map[string]string) *ListRuleAttachmentsOptions

SetHeaders : Allow user to set Headers

func (*ListRuleAttachmentsOptions) SetLimit

func (_options *ListRuleAttachmentsOptions) SetLimit(limit int64) *ListRuleAttachmentsOptions

SetLimit : Allow user to set Limit

func (*ListRuleAttachmentsOptions) SetOffset

func (_options *ListRuleAttachmentsOptions) SetOffset(offset int64) *ListRuleAttachmentsOptions

SetOffset : Allow user to set Offset

func (*ListRuleAttachmentsOptions) SetRuleID

func (_options *ListRuleAttachmentsOptions) SetRuleID(ruleID string) *ListRuleAttachmentsOptions

SetRuleID : Allow user to set RuleID

func (*ListRuleAttachmentsOptions) SetTransactionID

func (_options *ListRuleAttachmentsOptions) SetTransactionID(transactionID string) *ListRuleAttachmentsOptions

SetTransactionID : Allow user to set TransactionID

type ListRulesOptions

type ListRulesOptions struct {
	// Your IBM Cloud account ID.
	AccountID *string `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Retrieves a list of rules that have scope attachments.
	Attached *bool

	// Retrieves a list of rules that match the labels that you specify.
	Labels *string

	// Retrieves a list of rules that match the scope ID that you specify.
	Scopes *string

	// The number of resources to retrieve. By default, list operations return the first 100 items. To retrieve a different
	// set of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 rules, and you want to retrieve only the first 5 rules, use
	// `../rules?account_id={account_id}&limit=5`.
	Limit *int64

	// The number of resources to skip. By specifying `offset`, you retrieve a subset of resources that starts with the
	// `offset` value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 rules, and you want to retrieve rules 26 through 50, use
	// `../rules?account_id={account_id}&offset=25&limit=5`.
	Offset *int64

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListRulesOptions : The ListRules options.

func (*ListRulesOptions) SetAccountID

func (_options *ListRulesOptions) SetAccountID(accountID string) *ListRulesOptions

SetAccountID : Allow user to set AccountID

func (*ListRulesOptions) SetAttached

func (_options *ListRulesOptions) SetAttached(attached bool) *ListRulesOptions

SetAttached : Allow user to set Attached

func (*ListRulesOptions) SetHeaders

func (options *ListRulesOptions) SetHeaders(param map[string]string) *ListRulesOptions

SetHeaders : Allow user to set Headers

func (*ListRulesOptions) SetLabels

func (_options *ListRulesOptions) SetLabels(labels string) *ListRulesOptions

SetLabels : Allow user to set Labels

func (*ListRulesOptions) SetLimit

func (_options *ListRulesOptions) SetLimit(limit int64) *ListRulesOptions

SetLimit : Allow user to set Limit

func (*ListRulesOptions) SetOffset

func (_options *ListRulesOptions) SetOffset(offset int64) *ListRulesOptions

SetOffset : Allow user to set Offset

func (*ListRulesOptions) SetScopes

func (_options *ListRulesOptions) SetScopes(scopes string) *ListRulesOptions

SetScopes : Allow user to set Scopes

func (*ListRulesOptions) SetTransactionID

func (_options *ListRulesOptions) SetTransactionID(transactionID string) *ListRulesOptions

SetTransactionID : Allow user to set TransactionID

type ListTemplateAttachmentsOptions added in v1.2.0

type ListTemplateAttachmentsOptions struct {
	// The UUID that uniquely identifies the template.
	TemplateID *string `validate:"required,ne="`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// The number of resources to retrieve. By default, list operations return the first 100 items. To retrieve a different
	// set of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 rules, and you want to retrieve only the first 5 rules, use
	// `../rules?account_id={account_id}&limit=5`.
	Limit *int64

	// The number of resources to skip. By specifying `offset`, you retrieve a subset of resources that starts with the
	// `offset` value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 rules, and you want to retrieve rules 26 through 50, use
	// `../rules?account_id={account_id}&offset=25&limit=5`.
	Offset *int64

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListTemplateAttachmentsOptions : The ListTemplateAttachments options.

func (*ListTemplateAttachmentsOptions) SetHeaders added in v1.2.0

SetHeaders : Allow user to set Headers

func (*ListTemplateAttachmentsOptions) SetLimit added in v1.2.0

SetLimit : Allow user to set Limit

func (*ListTemplateAttachmentsOptions) SetOffset added in v1.2.0

SetOffset : Allow user to set Offset

func (*ListTemplateAttachmentsOptions) SetTemplateID added in v1.2.0

func (_options *ListTemplateAttachmentsOptions) SetTemplateID(templateID string) *ListTemplateAttachmentsOptions

SetTemplateID : Allow user to set TemplateID

func (*ListTemplateAttachmentsOptions) SetTransactionID added in v1.2.0

func (_options *ListTemplateAttachmentsOptions) SetTransactionID(transactionID string) *ListTemplateAttachmentsOptions

SetTransactionID : Allow user to set TransactionID

type ListTemplatesOptions added in v1.2.0

type ListTemplatesOptions struct {
	// Your IBM Cloud account ID.
	AccountID *string `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Retrieves a list of templates that have scope attachments.
	Attached *bool

	// Retrieves a list of templates that match the scope ID that you specify.
	Scopes *string

	// The number of resources to retrieve. By default, list operations return the first 100 items. To retrieve a different
	// set of items, use `limit` with `offset` to page through your available resources.
	//
	// **Usage:** If you have 20 rules, and you want to retrieve only the first 5 rules, use
	// `../rules?account_id={account_id}&limit=5`.
	Limit *int64

	// The number of resources to skip. By specifying `offset`, you retrieve a subset of resources that starts with the
	// `offset` value. Use `offset` with `limit` to page through your available resources.
	//
	// **Usage:** If you have 100 rules, and you want to retrieve rules 26 through 50, use
	// `../rules?account_id={account_id}&offset=25&limit=5`.
	Offset *int64

	// Allows users to set headers on API requests
	Headers map[string]string
}

ListTemplatesOptions : The ListTemplates options.

func (*ListTemplatesOptions) SetAccountID added in v1.2.0

func (_options *ListTemplatesOptions) SetAccountID(accountID string) *ListTemplatesOptions

SetAccountID : Allow user to set AccountID

func (*ListTemplatesOptions) SetAttached added in v1.2.0

func (_options *ListTemplatesOptions) SetAttached(attached bool) *ListTemplatesOptions

SetAttached : Allow user to set Attached

func (*ListTemplatesOptions) SetHeaders added in v1.2.0

func (options *ListTemplatesOptions) SetHeaders(param map[string]string) *ListTemplatesOptions

SetHeaders : Allow user to set Headers

func (*ListTemplatesOptions) SetLimit added in v1.2.0

func (_options *ListTemplatesOptions) SetLimit(limit int64) *ListTemplatesOptions

SetLimit : Allow user to set Limit

func (*ListTemplatesOptions) SetOffset added in v1.2.0

func (_options *ListTemplatesOptions) SetOffset(offset int64) *ListTemplatesOptions

SetOffset : Allow user to set Offset

func (*ListTemplatesOptions) SetScopes added in v1.2.0

func (_options *ListTemplatesOptions) SetScopes(scopes string) *ListTemplatesOptions

SetScopes : Allow user to set Scopes

func (*ListTemplatesOptions) SetTransactionID added in v1.2.0

func (_options *ListTemplatesOptions) SetTransactionID(transactionID string) *ListTemplatesOptions

SetTransactionID : Allow user to set TransactionID

type Rule

type Rule struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"account_id,omitempty"`

	// A human-readable alias to assign to your rule.
	Name *string `json:"name" validate:"required"`

	// An extended description of your rule.
	Description *string `json:"description" validate:"required"`

	// The type of rule. Rules that you create are `user_defined`.
	RuleType *string `json:"rule_type,omitempty"`

	// The properties that describe the resource that you want to target
	// with the rule or template.
	Target *TargetResource `json:"target" validate:"required"`

	RequiredConfig RuleRequiredConfigIntf `json:"required_config" validate:"required"`

	// The actions that the service must run on your behalf when a request to create or modify the target resource does not
	// comply with your conditions.
	EnforcementActions []EnforcementAction `json:"enforcement_actions" validate:"required"`

	// Labels that you can use to group and search for similar rules, such as those that help you to meet a specific
	// organization guideline.
	Labels []string `json:"labels,omitempty"`

	// The UUID that uniquely identifies the rule.
	RuleID *string `json:"rule_id,omitempty"`

	// The date the resource was created.
	CreationDate *strfmt.DateTime `json:"creation_date,omitempty"`

	// The unique identifier for the user or application that created the resource.
	CreatedBy *string `json:"created_by,omitempty"`

	// The date the resource was last modified.
	ModificationDate *strfmt.DateTime `json:"modification_date,omitempty"`

	// The unique identifier for the user or application that last modified the resource.
	ModifiedBy *string `json:"modified_by,omitempty"`

	// The number of scope attachments that are associated with the rule.
	NumberOfAttachments *int64 `json:"number_of_attachments,omitempty"`
}

Rule : Properties associated with a rule, including both user-defined and server-populated properties.

type RuleAttachment

type RuleAttachment struct {
	// The UUID that uniquely identifies the attachment.
	AttachmentID *string `json:"attachment_id" validate:"required"`

	// The UUID that uniquely identifies the rule.
	RuleID *string `json:"rule_id" validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// The extent at which the rule can be attached across your accounts.
	IncludedScope *RuleScope `json:"included_scope" validate:"required"`

	// The extent at which the rule can be excluded from the included scope.
	ExcludedScopes []RuleScope `json:"excluded_scopes,omitempty"`
}

RuleAttachment : The scopes to attach to a rule.

type RuleAttachmentList

type RuleAttachmentList struct {
	// The requested offset for the returned items.
	Offset *int64 `json:"offset" validate:"required"`

	// The requested limit for the returned items.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of available items.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The first page of available items.
	First *Link `json:"first" validate:"required"`

	// The last page of available items.
	Last *Link `json:"last" validate:"required"`

	Attachments []RuleAttachment `json:"attachments" validate:"required"`
}

RuleAttachmentList : A list of attachments.

type RuleAttachmentRequest

type RuleAttachmentRequest struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// The extent at which the rule can be attached across your accounts.
	IncludedScope *RuleScope `json:"included_scope" validate:"required"`

	// The extent at which the rule can be excluded from the included scope.
	ExcludedScopes []RuleScope `json:"excluded_scopes,omitempty"`
}

RuleAttachmentRequest : The scopes to attach to a rule.

type RuleCondition

type RuleCondition struct {
	Description *string `json:"description,omitempty"`

	// A resource configuration variable that describes the property that you want to apply to the target resource.
	//
	// Available options depend on the target service and resource.
	Property *string `json:"property,omitempty"`

	// The way in which the `property` field is compared to its value.
	//
	// To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).
	Operator *string `json:"operator,omitempty"`

	// The way in which you want your property to be applied.
	//
	// Value options differ depending on the rule that you configure. If you use a boolean operator, you do not need to
	// input a value.
	Value *string `json:"value,omitempty"`

	Or []RuleSingleProperty `json:"or,omitempty"`

	And []RuleSingleProperty `json:"and,omitempty"`
}

RuleCondition : RuleCondition struct Models which "extend" this model: - RuleConditionSingleProperty - RuleConditionOrLvl2 - RuleConditionAndLvl2

type RuleConditionAndLvl2

type RuleConditionAndLvl2 struct {
	Description *string `json:"description,omitempty"`

	And []RuleSingleProperty `json:"and" validate:"required"`
}

RuleConditionAndLvl2 : A condition with the `and` logical operator. This model "extends" RuleCondition

type RuleConditionIntf

type RuleConditionIntf interface {
	// contains filtered or unexported methods
}

type RuleConditionOrLvl2

type RuleConditionOrLvl2 struct {
	Description *string `json:"description,omitempty"`

	Or []RuleSingleProperty `json:"or" validate:"required"`
}

RuleConditionOrLvl2 : A condition with the `or` logical operator. This model "extends" RuleCondition

type RuleConditionSingleProperty

type RuleConditionSingleProperty struct {
	Description *string `json:"description,omitempty"`

	// A resource configuration variable that describes the property that you want to apply to the target resource.
	//
	// Available options depend on the target service and resource.
	Property *string `json:"property" validate:"required"`

	// The way in which the `property` field is compared to its value.
	//
	// To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).
	Operator *string `json:"operator" validate:"required"`

	// The way in which you want your property to be applied.
	//
	// Value options differ depending on the rule that you configure. If you use a boolean operator, you do not need to
	// input a value.
	Value *string `json:"value,omitempty"`
}

RuleConditionSingleProperty : The requirement that must be met to determine the resource's level of compliance in accordance with the rule.

To apply a single property check, define a configuration property and the desired value that you want to check against. This model "extends" RuleCondition

type RuleList

type RuleList struct {
	// The requested offset for the returned items.
	Offset *int64 `json:"offset" validate:"required"`

	// The requested limit for the returned items.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of available items.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The first page of available items.
	First *Link `json:"first" validate:"required"`

	// The last page of available items.
	Last *Link `json:"last" validate:"required"`

	// An array of rules.
	Rules []Rule `json:"rules" validate:"required"`
}

RuleList : A list of rules.

type RuleRequest

type RuleRequest struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"account_id,omitempty"`

	// A human-readable alias to assign to your rule.
	Name *string `json:"name" validate:"required"`

	// An extended description of your rule.
	Description *string `json:"description" validate:"required"`

	// The type of rule. Rules that you create are `user_defined`.
	RuleType *string `json:"rule_type,omitempty"`

	// The properties that describe the resource that you want to target
	// with the rule or template.
	Target *TargetResource `json:"target" validate:"required"`

	RequiredConfig RuleRequiredConfigIntf `json:"required_config" validate:"required"`

	// The actions that the service must run on your behalf when a request to create or modify the target resource does not
	// comply with your conditions.
	EnforcementActions []EnforcementAction `json:"enforcement_actions" validate:"required"`

	// Labels that you can use to group and search for similar rules, such as those that help you to meet a specific
	// organization guideline.
	Labels []string `json:"labels,omitempty"`
}

RuleRequest : Properties that you can associate with a rule.

type RuleRequiredConfig

type RuleRequiredConfig struct {
	Description *string `json:"description,omitempty"`

	// A resource configuration variable that describes the property that you want to apply to the target resource.
	//
	// Available options depend on the target service and resource.
	Property *string `json:"property,omitempty"`

	// The way in which the `property` field is compared to its value.
	//
	// To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).
	Operator *string `json:"operator,omitempty"`

	// The way in which you want your property to be applied.
	//
	// Value options differ depending on the rule that you configure. If you use a boolean operator, you do not need to
	// input a value.
	Value *string `json:"value,omitempty"`

	Or []RuleConditionIntf `json:"or,omitempty"`

	And []RuleConditionIntf `json:"and,omitempty"`
}

RuleRequiredConfig : RuleRequiredConfig struct Models which "extend" this model: - RuleRequiredConfigSingleProperty - RuleRequiredConfigMultipleProperties

type RuleRequiredConfigIntf

type RuleRequiredConfigIntf interface {
	// contains filtered or unexported methods
}

type RuleRequiredConfigMultipleProperties

type RuleRequiredConfigMultipleProperties struct {
	Description *string `json:"description,omitempty"`

	Or []RuleConditionIntf `json:"or,omitempty"`

	And []RuleConditionIntf `json:"and,omitempty"`
}

RuleRequiredConfigMultipleProperties : The requirements that must be met to determine the resource's level of compliance in accordance with the rule.

Use logical operators (`and`/`or`) to define multiple property checks and conditions. To define requirements for a rule, list one or more property check objects in the `and` array. To add conditions to a property check, use `or`. Models which "extend" this model: - RuleRequiredConfigMultiplePropertiesConditionOr - RuleRequiredConfigMultiplePropertiesConditionAnd This model "extends" RuleRequiredConfig

type RuleRequiredConfigMultiplePropertiesConditionAnd

type RuleRequiredConfigMultiplePropertiesConditionAnd struct {
	Description *string `json:"description,omitempty"`

	And []RuleConditionIntf `json:"and" validate:"required"`
}

RuleRequiredConfigMultiplePropertiesConditionAnd : A condition with the `and` logical operator. This model "extends" RuleRequiredConfigMultipleProperties

type RuleRequiredConfigMultiplePropertiesConditionOr

type RuleRequiredConfigMultiplePropertiesConditionOr struct {
	Description *string `json:"description,omitempty"`

	Or []RuleConditionIntf `json:"or" validate:"required"`
}

RuleRequiredConfigMultiplePropertiesConditionOr : A condition with the `or` logical operator. This model "extends" RuleRequiredConfigMultipleProperties

type RuleRequiredConfigMultiplePropertiesIntf

type RuleRequiredConfigMultiplePropertiesIntf interface {
	RuleRequiredConfigIntf
	// contains filtered or unexported methods
}

type RuleRequiredConfigSingleProperty

type RuleRequiredConfigSingleProperty struct {
	Description *string `json:"description,omitempty"`

	// A resource configuration variable that describes the property that you want to apply to the target resource.
	//
	// Available options depend on the target service and resource.
	Property *string `json:"property" validate:"required"`

	// The way in which the `property` field is compared to its value.
	//
	// To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).
	Operator *string `json:"operator" validate:"required"`

	// The way in which you want your property to be applied.
	//
	// Value options differ depending on the rule that you configure. If you use a boolean operator, you do not need to
	// input a value.
	Value *string `json:"value,omitempty"`
}

RuleRequiredConfigSingleProperty : The requirement that must be met to determine the resource's level of compliance in accordance with the rule.

To apply a single property check, define a configuration property and the desired value that you want to check against. This model "extends" RuleRequiredConfig

type RuleResponseError

type RuleResponseError struct {
	// Specifies the problem that caused the error.
	Code *string `json:"code" validate:"required"`

	// Describes the problem.
	Message *string `json:"message" validate:"required"`
}

RuleResponseError : RuleResponseError struct

type RuleScope

type RuleScope struct {
	// A short description or alias to assign to the scope.
	Note *string `json:"note,omitempty"`

	// The ID of the scope, such as an enterprise, account, or account group, that you want to evaluate.
	ScopeID *string `json:"scope_id" validate:"required"`

	// The type of scope that you want to evaluate.
	ScopeType *string `json:"scope_type" validate:"required"`
}

RuleScope : The extent at which the rule can be attached across your accounts.

type RuleSingleProperty

type RuleSingleProperty struct {
	Description *string `json:"description,omitempty"`

	// A resource configuration variable that describes the property that you want to apply to the target resource.
	//
	// Available options depend on the target service and resource.
	Property *string `json:"property" validate:"required"`

	// The way in which the `property` field is compared to its value.
	//
	// To learn more, see the [docs](/docs/security-compliance?topic=security-compliance-what-is-rule#rule-operators).
	Operator *string `json:"operator" validate:"required"`

	// The way in which you want your property to be applied.
	//
	// Value options differ depending on the rule that you configure. If you use a boolean operator, you do not need to
	// input a value.
	Value *string `json:"value,omitempty"`
}

RuleSingleProperty : The requirement that must be met to determine the resource's level of compliance in accordance with the rule.

To apply a single property check, define a configuration property and the desired value that you want to check against.

type SimpleTargetResource added in v1.2.0

type SimpleTargetResource struct {
	// The programmatic name of the IBM Cloud service that you want to target with the rule or template.
	ServiceName *string `json:"service_name" validate:"required"`

	// The type of resource that you want to target.
	ResourceKind *string `json:"resource_kind" validate:"required"`

	// An extra qualifier for the resource kind. When you include additional attributes, only the resources that match the
	// definition are included in the rule or template.
	AdditionalTargetAttributes []BaseTargetAttribute `json:"additional_target_attributes,omitempty"`
}

SimpleTargetResource : The properties that describe the resource that you want to target with the rule or template.

type TargetResource

type TargetResource struct {
	// The programmatic name of the IBM Cloud service that you want to target with the rule or template.
	ServiceName *string `json:"service_name" validate:"required"`

	// The type of resource that you want to target.
	ResourceKind *string `json:"resource_kind" validate:"required"`

	// An extra qualifier for the resource kind. When you include additional attributes, only the resources that match the
	// definition are included in the rule or template.
	AdditionalTargetAttributes []TargetResourceAdditionalTargetAttributesItem `json:"additional_target_attributes,omitempty"`
}

TargetResource : The properties that describe the resource that you want to target with the rule or template.

type TargetResourceAdditionalTargetAttributesItem

type TargetResourceAdditionalTargetAttributesItem struct {
	// The name of the additional attribute that you want to use to further qualify the target.
	//
	// Options differ depending on the service or resource that you are targeting with a rule or template. For more
	// information, refer to the service documentation.
	Name *string `json:"name" validate:"required"`

	// The value that you want to apply to `name` field.
	//
	// Options differ depending on the rule or template that you configure. For more information, refer to the service
	// documentation.
	Value *string `json:"value" validate:"required"`

	// The way in which the `name` field is compared to its value.
	//
	// There are three types of operators: string, numeric, and boolean.
	Operator *string `json:"operator" validate:"required"`
}

TargetResourceAdditionalTargetAttributesItem : The attributes that are associated with a rule or template target.

type Template added in v1.2.0

type Template struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// A human-readablse alias to assign to your template.
	Name *string `json:"name" validate:"required"`

	// An extended description of your template.
	Description *string `json:"description" validate:"required"`

	// The UUID that uniquely identifies the template.
	TemplateID *string `json:"template_id,omitempty"`

	// The properties that describe the resource that you want to target
	// with the rule or template.
	Target *SimpleTargetResource `json:"target" validate:"required"`

	// A list of default property values to apply to your template.
	CustomizedDefaults []TemplateCustomizedDefaultProperty `json:"customized_defaults" validate:"required"`
}

Template : Properties that you can associate with a template.

type TemplateAttachment

type TemplateAttachment struct {
	// The UUID that uniquely identifies the attachment.
	AttachmentID *string `json:"attachment_id" validate:"required"`

	// The UUID that uniquely identifies the template.
	TemplateID *string `json:"template_id" validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// The extent at which the template can be attached across your accounts.
	IncludedScope *TemplateScope `json:"included_scope" validate:"required"`

	ExcludedScopes []TemplateScope `json:"excluded_scopes,omitempty"`
}

TemplateAttachment : The scopes to attach to a template.

type TemplateAttachmentList added in v1.2.0

type TemplateAttachmentList struct {
	// The requested offset for the returned items.
	Offset *int64 `json:"offset" validate:"required"`

	// The requested limit for the returned items.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of available items.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The first page of available items.
	First *Link `json:"first" validate:"required"`

	// The last page of available items.
	Last *Link `json:"last" validate:"required"`

	Attachments []TemplateAttachment `json:"attachments" validate:"required"`
}

TemplateAttachmentList : A list of attachments.

type TemplateAttachmentRequest added in v1.2.0

type TemplateAttachmentRequest struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// The extent at which the template can be attached across your accounts.
	IncludedScope *TemplateScope `json:"included_scope" validate:"required"`

	ExcludedScopes []TemplateScope `json:"excluded_scopes,omitempty"`
}

TemplateAttachmentRequest : The scopes to attach to a template.

type TemplateCustomizedDefaultProperty added in v1.2.0

type TemplateCustomizedDefaultProperty struct {
	// The name of the resource property that you want to configure.
	//
	// Property options differ depending on the service or resource that you are targeting with a template. To view a list
	// of properties that are compatible with templates, refer to the service documentation.
	Property *string `json:"property" validate:"required"`

	// The custom value that you want to apply as the default for the resource property in the `name` field.
	//
	// This value is used to to override the default value that is provided by IBM when a resource is created. Value
	// options differ depending on the resource that you are configuring. To learn more about your options, refer to the
	// service documentation.
	Value *string `json:"value" validate:"required"`
}

TemplateCustomizedDefaultProperty : The default property values to customize.

type TemplateList added in v1.2.0

type TemplateList struct {
	// The requested offset for the returned items.
	Offset *int64 `json:"offset" validate:"required"`

	// The requested limit for the returned items.
	Limit *int64 `json:"limit" validate:"required"`

	// The total number of available items.
	TotalCount *int64 `json:"total_count" validate:"required"`

	// The first page of available items.
	First *Link `json:"first" validate:"required"`

	// The last page of available items.
	Last *Link `json:"last" validate:"required"`

	// An array of templates.
	Templates []Template `json:"templates" validate:"required"`
}

TemplateList : A list of templates.

type TemplateResponse added in v1.2.0

type TemplateResponse struct {
	// Your IBM Cloud account ID.
	AccountID *string `json:"account_id" validate:"required"`

	// A human-readablse alias to assign to your template.
	Name *string `json:"name" validate:"required"`

	// An extended description of your template.
	Description *string `json:"description" validate:"required"`

	// The UUID that uniquely identifies the template.
	TemplateID *string `json:"template_id,omitempty"`

	// The properties that describe the resource that you want to target
	// with the rule or template.
	Target *SimpleTargetResource `json:"target" validate:"required"`

	// A list of default property values to apply to your template.
	CustomizedDefaults []TemplateCustomizedDefaultProperty `json:"customized_defaults" validate:"required"`

	// The date the resource was created.
	CreationDate *strfmt.DateTime `json:"creation_date" validate:"required"`

	// The unique identifier for the user or application that created the resource.
	CreatedBy *string `json:"created_by,omitempty"`

	// The date the resource was last modified.
	ModificationDate *strfmt.DateTime `json:"modification_date" validate:"required"`

	// The unique identifier for the user or application that last modified the resource.
	ModifiedBy *string `json:"modified_by,omitempty"`
}

TemplateResponse : Properties associated with a template, including both user-defined and server-populated properties.

type TemplateResponseError added in v1.2.0

type TemplateResponseError struct {
	// Specifies the problem that caused the error.
	Code *string `json:"code" validate:"required"`

	// Describes the problem.
	Message *string `json:"message" validate:"required"`
}

TemplateResponseError : TemplateResponseError struct

type TemplateScope

type TemplateScope struct {
	// A short description or alias to assign to the scope.
	Note *string `json:"note,omitempty"`

	// The ID of the scope, such as an enterprise, account, or account group, where you want to apply the customized
	// defaults that are associated with a template.
	ScopeID *string `json:"scope_id" validate:"required"`

	// The type of scope.
	ScopeType *string `json:"scope_type" validate:"required"`
}

TemplateScope : The extent at which the template can be attached across your accounts.

type UpdateRuleAttachmentOptions

type UpdateRuleAttachmentOptions struct {
	// The UUID that uniquely identifies the rule.
	RuleID *string `validate:"required,ne="`

	// The UUID that uniquely identifies the attachment.
	AttachmentID *string `validate:"required,ne="`

	// Compares a supplied `Etag` value with the version that is stored for the requested resource. If the values match,
	// the server allows the request method to continue.
	//
	// To find the `Etag` value, run a GET request on the resource that you want to modify, and check the response headers.
	IfMatch *string `validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `validate:"required"`

	// The extent at which the rule can be attached across your accounts.
	IncludedScope *RuleScope `validate:"required"`

	// The extent at which the rule can be excluded from the included scope.
	ExcludedScopes []RuleScope

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateRuleAttachmentOptions : The UpdateRuleAttachment options.

func (*UpdateRuleAttachmentOptions) SetAccountID

func (_options *UpdateRuleAttachmentOptions) SetAccountID(accountID string) *UpdateRuleAttachmentOptions

SetAccountID : Allow user to set AccountID

func (*UpdateRuleAttachmentOptions) SetAttachmentID

func (_options *UpdateRuleAttachmentOptions) SetAttachmentID(attachmentID string) *UpdateRuleAttachmentOptions

SetAttachmentID : Allow user to set AttachmentID

func (*UpdateRuleAttachmentOptions) SetExcludedScopes

func (_options *UpdateRuleAttachmentOptions) SetExcludedScopes(excludedScopes []RuleScope) *UpdateRuleAttachmentOptions

SetExcludedScopes : Allow user to set ExcludedScopes

func (*UpdateRuleAttachmentOptions) SetHeaders

func (options *UpdateRuleAttachmentOptions) SetHeaders(param map[string]string) *UpdateRuleAttachmentOptions

SetHeaders : Allow user to set Headers

func (*UpdateRuleAttachmentOptions) SetIfMatch

func (_options *UpdateRuleAttachmentOptions) SetIfMatch(ifMatch string) *UpdateRuleAttachmentOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateRuleAttachmentOptions) SetIncludedScope

func (_options *UpdateRuleAttachmentOptions) SetIncludedScope(includedScope *RuleScope) *UpdateRuleAttachmentOptions

SetIncludedScope : Allow user to set IncludedScope

func (*UpdateRuleAttachmentOptions) SetRuleID

func (_options *UpdateRuleAttachmentOptions) SetRuleID(ruleID string) *UpdateRuleAttachmentOptions

SetRuleID : Allow user to set RuleID

func (*UpdateRuleAttachmentOptions) SetTransactionID

func (_options *UpdateRuleAttachmentOptions) SetTransactionID(transactionID string) *UpdateRuleAttachmentOptions

SetTransactionID : Allow user to set TransactionID

type UpdateRuleOptions

type UpdateRuleOptions struct {
	// The UUID that uniquely identifies the rule.
	RuleID *string `validate:"required,ne="`

	// Compares a supplied `Etag` value with the version that is stored for the requested resource. If the values match,
	// the server allows the request method to continue.
	//
	// To find the `Etag` value, run a GET request on the resource that you want to modify, and check the response headers.
	IfMatch *string `validate:"required"`

	// A human-readable alias to assign to your rule.
	Name *string `validate:"required"`

	// An extended description of your rule.
	Description *string `validate:"required"`

	// The properties that describe the resource that you want to target
	// with the rule or template.
	Target *TargetResource `validate:"required"`

	RequiredConfig RuleRequiredConfigIntf `validate:"required"`

	// The actions that the service must run on your behalf when a request to create or modify the target resource does not
	// comply with your conditions.
	EnforcementActions []EnforcementAction `validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string

	// The type of rule. Rules that you create are `user_defined`.
	RuleType *string

	// Labels that you can use to group and search for similar rules, such as those that help you to meet a specific
	// organization guideline.
	Labels []string

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateRuleOptions : The UpdateRule options.

func (*UpdateRuleOptions) SetAccountID

func (_options *UpdateRuleOptions) SetAccountID(accountID string) *UpdateRuleOptions

SetAccountID : Allow user to set AccountID

func (*UpdateRuleOptions) SetDescription

func (_options *UpdateRuleOptions) SetDescription(description string) *UpdateRuleOptions

SetDescription : Allow user to set Description

func (*UpdateRuleOptions) SetEnforcementActions

func (_options *UpdateRuleOptions) SetEnforcementActions(enforcementActions []EnforcementAction) *UpdateRuleOptions

SetEnforcementActions : Allow user to set EnforcementActions

func (*UpdateRuleOptions) SetHeaders

func (options *UpdateRuleOptions) SetHeaders(param map[string]string) *UpdateRuleOptions

SetHeaders : Allow user to set Headers

func (*UpdateRuleOptions) SetIfMatch

func (_options *UpdateRuleOptions) SetIfMatch(ifMatch string) *UpdateRuleOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateRuleOptions) SetLabels

func (_options *UpdateRuleOptions) SetLabels(labels []string) *UpdateRuleOptions

SetLabels : Allow user to set Labels

func (*UpdateRuleOptions) SetName

func (_options *UpdateRuleOptions) SetName(name string) *UpdateRuleOptions

SetName : Allow user to set Name

func (*UpdateRuleOptions) SetRequiredConfig

func (_options *UpdateRuleOptions) SetRequiredConfig(requiredConfig RuleRequiredConfigIntf) *UpdateRuleOptions

SetRequiredConfig : Allow user to set RequiredConfig

func (*UpdateRuleOptions) SetRuleID

func (_options *UpdateRuleOptions) SetRuleID(ruleID string) *UpdateRuleOptions

SetRuleID : Allow user to set RuleID

func (*UpdateRuleOptions) SetRuleType

func (_options *UpdateRuleOptions) SetRuleType(ruleType string) *UpdateRuleOptions

SetRuleType : Allow user to set RuleType

func (*UpdateRuleOptions) SetTarget

func (_options *UpdateRuleOptions) SetTarget(target *TargetResource) *UpdateRuleOptions

SetTarget : Allow user to set Target

func (*UpdateRuleOptions) SetTransactionID

func (_options *UpdateRuleOptions) SetTransactionID(transactionID string) *UpdateRuleOptions

SetTransactionID : Allow user to set TransactionID

type UpdateTemplateAttachmentOptions added in v1.2.0

type UpdateTemplateAttachmentOptions struct {
	// The UUID that uniquely identifies the template.
	TemplateID *string `validate:"required,ne="`

	// The UUID that uniquely identifies the attachment.
	AttachmentID *string `validate:"required,ne="`

	// Compares a supplied `Etag` value with the version that is stored for the requested resource. If the values match,
	// the server allows the request method to continue.
	//
	// To find the `Etag` value, run a GET request on the resource that you want to modify, and check the response headers.
	IfMatch *string `validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `validate:"required"`

	// The extent at which the template can be attached across your accounts.
	IncludedScope *TemplateScope `validate:"required"`

	ExcludedScopes []TemplateScope

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateTemplateAttachmentOptions : The UpdateTemplateAttachment options.

func (*UpdateTemplateAttachmentOptions) SetAccountID added in v1.2.0

func (_options *UpdateTemplateAttachmentOptions) SetAccountID(accountID string) *UpdateTemplateAttachmentOptions

SetAccountID : Allow user to set AccountID

func (*UpdateTemplateAttachmentOptions) SetAttachmentID added in v1.2.0

func (_options *UpdateTemplateAttachmentOptions) SetAttachmentID(attachmentID string) *UpdateTemplateAttachmentOptions

SetAttachmentID : Allow user to set AttachmentID

func (*UpdateTemplateAttachmentOptions) SetExcludedScopes added in v1.2.0

func (_options *UpdateTemplateAttachmentOptions) SetExcludedScopes(excludedScopes []TemplateScope) *UpdateTemplateAttachmentOptions

SetExcludedScopes : Allow user to set ExcludedScopes

func (*UpdateTemplateAttachmentOptions) SetHeaders added in v1.2.0

SetHeaders : Allow user to set Headers

func (*UpdateTemplateAttachmentOptions) SetIfMatch added in v1.2.0

SetIfMatch : Allow user to set IfMatch

func (*UpdateTemplateAttachmentOptions) SetIncludedScope added in v1.2.0

func (_options *UpdateTemplateAttachmentOptions) SetIncludedScope(includedScope *TemplateScope) *UpdateTemplateAttachmentOptions

SetIncludedScope : Allow user to set IncludedScope

func (*UpdateTemplateAttachmentOptions) SetTemplateID added in v1.2.0

func (_options *UpdateTemplateAttachmentOptions) SetTemplateID(templateID string) *UpdateTemplateAttachmentOptions

SetTemplateID : Allow user to set TemplateID

func (*UpdateTemplateAttachmentOptions) SetTransactionID added in v1.2.0

func (_options *UpdateTemplateAttachmentOptions) SetTransactionID(transactionID string) *UpdateTemplateAttachmentOptions

SetTransactionID : Allow user to set TransactionID

type UpdateTemplateOptions added in v1.2.0

type UpdateTemplateOptions struct {
	// The UUID that uniquely identifies the template.
	TemplateID *string `validate:"required,ne="`

	// Compares a supplied `Etag` value with the version that is stored for the requested resource. If the values match,
	// the server allows the request method to continue.
	//
	// To find the `Etag` value, run a GET request on the resource that you want to modify, and check the response headers.
	IfMatch *string `validate:"required"`

	// Your IBM Cloud account ID.
	AccountID *string `validate:"required"`

	// A human-readablse alias to assign to your template.
	Name *string `validate:"required"`

	// An extended description of your template.
	Description *string `validate:"required"`

	// The properties that describe the resource that you want to target
	// with the rule or template.
	Target *SimpleTargetResource `validate:"required"`

	// A list of default property values to apply to your template.
	CustomizedDefaults []TemplateCustomizedDefaultProperty `validate:"required"`

	// The unique identifier that is used to trace an entire request. If you omit this field, the service generates and
	// sends a transaction ID as a response header of the request. In the case of an error, the transaction ID is set in
	// the `trace` field of the response body.
	//
	// **Note:** To help with debugging logs, it is strongly recommended that you generate and supply a `Transaction-Id`
	// with each request.
	TransactionID *string

	// Allows users to set headers on API requests
	Headers map[string]string
}

UpdateTemplateOptions : The UpdateTemplate options.

func (*UpdateTemplateOptions) SetAccountID added in v1.2.0

func (_options *UpdateTemplateOptions) SetAccountID(accountID string) *UpdateTemplateOptions

SetAccountID : Allow user to set AccountID

func (*UpdateTemplateOptions) SetCustomizedDefaults added in v1.2.0

func (_options *UpdateTemplateOptions) SetCustomizedDefaults(customizedDefaults []TemplateCustomizedDefaultProperty) *UpdateTemplateOptions

SetCustomizedDefaults : Allow user to set CustomizedDefaults

func (*UpdateTemplateOptions) SetDescription added in v1.2.0

func (_options *UpdateTemplateOptions) SetDescription(description string) *UpdateTemplateOptions

SetDescription : Allow user to set Description

func (*UpdateTemplateOptions) SetHeaders added in v1.2.0

func (options *UpdateTemplateOptions) SetHeaders(param map[string]string) *UpdateTemplateOptions

SetHeaders : Allow user to set Headers

func (*UpdateTemplateOptions) SetIfMatch added in v1.2.0

func (_options *UpdateTemplateOptions) SetIfMatch(ifMatch string) *UpdateTemplateOptions

SetIfMatch : Allow user to set IfMatch

func (*UpdateTemplateOptions) SetName added in v1.2.0

func (_options *UpdateTemplateOptions) SetName(name string) *UpdateTemplateOptions

SetName : Allow user to set Name

func (*UpdateTemplateOptions) SetTarget added in v1.2.0

SetTarget : Allow user to set Target

func (*UpdateTemplateOptions) SetTemplateID added in v1.2.0

func (_options *UpdateTemplateOptions) SetTemplateID(templateID string) *UpdateTemplateOptions

SetTemplateID : Allow user to set TemplateID

func (*UpdateTemplateOptions) SetTransactionID added in v1.2.0

func (_options *UpdateTemplateOptions) SetTransactionID(transactionID string) *UpdateTemplateOptions

SetTransactionID : Allow user to set TransactionID

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
t or T : Toggle theme light dark auto
y or Y : Canonical URL