Documentation ¶
Overview ¶
Package zonefirewallaccessrulesv1 : Operations and models for the ZoneFirewallAccessRulesV1 service
Index ¶
- Constants
- func GetServiceURLForRegion(region string) (string, error)
- func UnmarshalDeleteZoneAccessRuleResp(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalDeleteZoneAccessRuleRespResult(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListZoneAccessRulesResp(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalListZoneAccessRulesRespResultInfo(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalZoneAccessRuleInputConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalZoneAccessRuleObject(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalZoneAccessRuleObjectConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalZoneAccessRuleObjectScope(m map[string]json.RawMessage, result interface{}) (err error)
- func UnmarshalZoneAccessRuleResp(m map[string]json.RawMessage, result interface{}) (err error)
- type CreateZoneAccessRuleOptions
- func (options *CreateZoneAccessRuleOptions) SetConfiguration(configuration *ZoneAccessRuleInputConfiguration) *CreateZoneAccessRuleOptions
- func (options *CreateZoneAccessRuleOptions) SetHeaders(param map[string]string) *CreateZoneAccessRuleOptions
- func (options *CreateZoneAccessRuleOptions) SetMode(mode string) *CreateZoneAccessRuleOptions
- func (options *CreateZoneAccessRuleOptions) SetNotes(notes string) *CreateZoneAccessRuleOptions
- type DeleteZoneAccessRuleOptions
- type DeleteZoneAccessRuleResp
- type DeleteZoneAccessRuleRespResult
- type GetZoneAccessRuleOptions
- type ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetConfigurationTarget(configurationTarget string) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetConfigurationValue(configurationValue string) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetDirection(direction string) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetHeaders(param map[string]string) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetMatch(match string) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetMode(mode string) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetNotes(notes string) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetOrder(order string) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetPage(page int64) *ListAllZoneAccessRulesOptions
- func (options *ListAllZoneAccessRulesOptions) SetPerPage(perPage int64) *ListAllZoneAccessRulesOptions
- type ListZoneAccessRulesResp
- type ListZoneAccessRulesRespResultInfo
- type UpdateZoneAccessRuleOptions
- func (options *UpdateZoneAccessRuleOptions) SetAccessruleIdentifier(accessruleIdentifier string) *UpdateZoneAccessRuleOptions
- func (options *UpdateZoneAccessRuleOptions) SetHeaders(param map[string]string) *UpdateZoneAccessRuleOptions
- func (options *UpdateZoneAccessRuleOptions) SetMode(mode string) *UpdateZoneAccessRuleOptions
- func (options *UpdateZoneAccessRuleOptions) SetNotes(notes string) *UpdateZoneAccessRuleOptions
- type ZoneAccessRuleInputConfiguration
- type ZoneAccessRuleObject
- type ZoneAccessRuleObjectConfiguration
- type ZoneAccessRuleObjectScope
- type ZoneAccessRuleResp
- type ZoneFirewallAccessRulesV1
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) Clone() *ZoneFirewallAccessRulesV1
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) CreateZoneAccessRule(createZoneAccessRuleOptions *CreateZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) CreateZoneAccessRuleWithContext(ctx context.Context, createZoneAccessRuleOptions *CreateZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) DeleteZoneAccessRule(deleteZoneAccessRuleOptions *DeleteZoneAccessRuleOptions) (result *DeleteZoneAccessRuleResp, response *core.DetailedResponse, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) DeleteZoneAccessRuleWithContext(ctx context.Context, deleteZoneAccessRuleOptions *DeleteZoneAccessRuleOptions) (result *DeleteZoneAccessRuleResp, response *core.DetailedResponse, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) DisableRetries()
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) GetEnableGzipCompression() bool
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) GetServiceURL() string
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) GetZoneAccessRule(getZoneAccessRuleOptions *GetZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) GetZoneAccessRuleWithContext(ctx context.Context, getZoneAccessRuleOptions *GetZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) ListAllZoneAccessRules(listAllZoneAccessRulesOptions *ListAllZoneAccessRulesOptions) (result *ListZoneAccessRulesResp, response *core.DetailedResponse, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) ListAllZoneAccessRulesWithContext(ctx context.Context, ...) (result *ListZoneAccessRulesResp, response *core.DetailedResponse, err error)
- func (*ZoneFirewallAccessRulesV1) NewCreateZoneAccessRuleOptions() *CreateZoneAccessRuleOptions
- func (*ZoneFirewallAccessRulesV1) NewDeleteZoneAccessRuleOptions(accessruleIdentifier string) *DeleteZoneAccessRuleOptions
- func (*ZoneFirewallAccessRulesV1) NewGetZoneAccessRuleOptions(accessruleIdentifier string) *GetZoneAccessRuleOptions
- func (*ZoneFirewallAccessRulesV1) NewListAllZoneAccessRulesOptions() *ListAllZoneAccessRulesOptions
- func (*ZoneFirewallAccessRulesV1) NewUpdateZoneAccessRuleOptions(accessruleIdentifier string) *UpdateZoneAccessRuleOptions
- func (*ZoneFirewallAccessRulesV1) NewZoneAccessRuleInputConfiguration(target string, value string) (model *ZoneAccessRuleInputConfiguration, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) SetDefaultHeaders(headers http.Header)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) SetEnableGzipCompression(enableGzip bool)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) SetServiceURL(url string) error
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) UpdateZoneAccessRule(updateZoneAccessRuleOptions *UpdateZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
- func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) UpdateZoneAccessRuleWithContext(ctx context.Context, updateZoneAccessRuleOptions *UpdateZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
- type ZoneFirewallAccessRulesV1Options
Constants ¶
const ( CreateZoneAccessRuleOptions_Mode_Block = "block" CreateZoneAccessRuleOptions_Mode_Challenge = "challenge" CreateZoneAccessRuleOptions_Mode_JsChallenge = "js_challenge" CreateZoneAccessRuleOptions_Mode_Whitelist = "whitelist" )
Constants associated with the CreateZoneAccessRuleOptions.Mode property. The action to apply to a matched request.
const ( ListAllZoneAccessRulesOptions_Mode_Block = "block" ListAllZoneAccessRulesOptions_Mode_Challenge = "challenge" ListAllZoneAccessRulesOptions_Mode_JsChallenge = "js_challenge" ListAllZoneAccessRulesOptions_Mode_Whitelist = "whitelist" )
Constants associated with the ListAllZoneAccessRulesOptions.Mode property. Search access rules by mode.
const ( ListAllZoneAccessRulesOptions_ConfigurationTarget_Asn = "asn" ListAllZoneAccessRulesOptions_ConfigurationTarget_Country = "country" ListAllZoneAccessRulesOptions_ConfigurationTarget_Ip = "ip" ListAllZoneAccessRulesOptions_ConfigurationTarget_IpRange = "ip_range" )
Constants associated with the ListAllZoneAccessRulesOptions.ConfigurationTarget property. Search access rules by configuration target.
const ( ListAllZoneAccessRulesOptions_Order_ConfigurationTarget = "configuration.target" ListAllZoneAccessRulesOptions_Order_ConfigurationValue = "configuration.value" ListAllZoneAccessRulesOptions_Order_Mode = "mode" )
Constants associated with the ListAllZoneAccessRulesOptions.Order property. Field by which to order list of access rules.
const ( ListAllZoneAccessRulesOptions_Direction_Asc = "asc" ListAllZoneAccessRulesOptions_Direction_Desc = "desc" )
Constants associated with the ListAllZoneAccessRulesOptions.Direction property. Direction in which to order results [ascending/descending order].
const ( ListAllZoneAccessRulesOptions_Match_All = "all" ListAllZoneAccessRulesOptions_Match_Any = "any" )
Constants associated with the ListAllZoneAccessRulesOptions.Match property. Whether to match all (all) or atleast one search parameter (any).
const ( UpdateZoneAccessRuleOptions_Mode_Block = "block" UpdateZoneAccessRuleOptions_Mode_Challenge = "challenge" UpdateZoneAccessRuleOptions_Mode_JsChallenge = "js_challenge" UpdateZoneAccessRuleOptions_Mode_Whitelist = "whitelist" )
Constants associated with the UpdateZoneAccessRuleOptions.Mode property. The action to apply to a matched request.
const ( ZoneAccessRuleInputConfiguration_Target_Asn = "asn" ZoneAccessRuleInputConfiguration_Target_Country = "country" ZoneAccessRuleInputConfiguration_Target_Ip = "ip" ZoneAccessRuleInputConfiguration_Target_IpRange = "ip_range" )
Constants associated with the ZoneAccessRuleInputConfiguration.Target property. The request property to target.
const ( ZoneAccessRuleObjectConfiguration_Target_Asn = "asn" ZoneAccessRuleObjectConfiguration_Target_Country = "country" ZoneAccessRuleObjectConfiguration_Target_Ip = "ip" ZoneAccessRuleObjectConfiguration_Target_IpRange = "ip_range" )
Constants associated with the ZoneAccessRuleObjectConfiguration.Target property. target.
const ( ZoneAccessRuleObjectScope_Type_Account = "account" ZoneAccessRuleObjectScope_Type_Zone = "zone" )
Constants associated with the ZoneAccessRuleObjectScope.Type property. The scope of the access rule, indicating if its applicable at zone level("zone") or inherited from instance level("account").
const ( ZoneAccessRuleObject_AllowedModes_Block = "block" ZoneAccessRuleObject_AllowedModes_Challenge = "challenge" ZoneAccessRuleObject_AllowedModes_JsChallenge = "js_challenge" ZoneAccessRuleObject_AllowedModes_Whitelist = "whitelist" )
Constants associated with the ZoneAccessRuleObject.AllowedModes property.
const ( ZoneAccessRuleObject_Mode_Block = "block" ZoneAccessRuleObject_Mode_Challenge = "challenge" ZoneAccessRuleObject_Mode_JsChallenge = "js_challenge" ZoneAccessRuleObject_Mode_Whitelist = "whitelist" )
Constants associated with the ZoneAccessRuleObject.Mode property. The action to be applied to a request matching the access rule.
const DefaultServiceName = "zone_firewall_access_rules"
DefaultServiceName is the default key used to find external configuration information.
const DefaultServiceURL = "https://api.cis.cloud.ibm.com"
DefaultServiceURL is the default URL to make service requests to.
Variables ¶
This section is empty.
Functions ¶
func GetServiceURLForRegion ¶ added in v0.12.1
GetServiceURLForRegion returns the service URL to be used for the specified region
func UnmarshalDeleteZoneAccessRuleResp ¶
func UnmarshalDeleteZoneAccessRuleResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteZoneAccessRuleResp unmarshals an instance of DeleteZoneAccessRuleResp from the specified map of raw messages.
func UnmarshalDeleteZoneAccessRuleRespResult ¶
func UnmarshalDeleteZoneAccessRuleRespResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteZoneAccessRuleRespResult unmarshals an instance of DeleteZoneAccessRuleRespResult from the specified map of raw messages.
func UnmarshalListZoneAccessRulesResp ¶
func UnmarshalListZoneAccessRulesResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListZoneAccessRulesResp unmarshals an instance of ListZoneAccessRulesResp from the specified map of raw messages.
func UnmarshalListZoneAccessRulesRespResultInfo ¶
func UnmarshalListZoneAccessRulesRespResultInfo(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListZoneAccessRulesRespResultInfo unmarshals an instance of ListZoneAccessRulesRespResultInfo from the specified map of raw messages.
func UnmarshalZoneAccessRuleInputConfiguration ¶
func UnmarshalZoneAccessRuleInputConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalZoneAccessRuleInputConfiguration unmarshals an instance of ZoneAccessRuleInputConfiguration from the specified map of raw messages.
func UnmarshalZoneAccessRuleObject ¶
func UnmarshalZoneAccessRuleObject(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalZoneAccessRuleObject unmarshals an instance of ZoneAccessRuleObject from the specified map of raw messages.
func UnmarshalZoneAccessRuleObjectConfiguration ¶
func UnmarshalZoneAccessRuleObjectConfiguration(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalZoneAccessRuleObjectConfiguration unmarshals an instance of ZoneAccessRuleObjectConfiguration from the specified map of raw messages.
func UnmarshalZoneAccessRuleObjectScope ¶
func UnmarshalZoneAccessRuleObjectScope(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalZoneAccessRuleObjectScope unmarshals an instance of ZoneAccessRuleObjectScope from the specified map of raw messages.
func UnmarshalZoneAccessRuleResp ¶
func UnmarshalZoneAccessRuleResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalZoneAccessRuleResp unmarshals an instance of ZoneAccessRuleResp from the specified map of raw messages.
Types ¶
type CreateZoneAccessRuleOptions ¶
type CreateZoneAccessRuleOptions struct { // The action to apply to a matched request. Mode *string `json:"mode,omitempty"` // A personal note about the rule. Typically used as a reminder or explanation for the rule. Notes *string `json:"notes,omitempty"` // Configuration object specifying access rule. Configuration *ZoneAccessRuleInputConfiguration `json:"configuration,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
CreateZoneAccessRuleOptions : The CreateZoneAccessRule options.
func (*CreateZoneAccessRuleOptions) SetConfiguration ¶
func (options *CreateZoneAccessRuleOptions) SetConfiguration(configuration *ZoneAccessRuleInputConfiguration) *CreateZoneAccessRuleOptions
SetConfiguration : Allow user to set Configuration
func (*CreateZoneAccessRuleOptions) SetHeaders ¶
func (options *CreateZoneAccessRuleOptions) SetHeaders(param map[string]string) *CreateZoneAccessRuleOptions
SetHeaders : Allow user to set Headers
func (*CreateZoneAccessRuleOptions) SetMode ¶
func (options *CreateZoneAccessRuleOptions) SetMode(mode string) *CreateZoneAccessRuleOptions
SetMode : Allow user to set Mode
func (*CreateZoneAccessRuleOptions) SetNotes ¶
func (options *CreateZoneAccessRuleOptions) SetNotes(notes string) *CreateZoneAccessRuleOptions
SetNotes : Allow user to set Notes
type DeleteZoneAccessRuleOptions ¶
type DeleteZoneAccessRuleOptions struct { // Identifier of the access rule to be deleted. AccessruleIdentifier *string `json:"accessrule_identifier" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
DeleteZoneAccessRuleOptions : The DeleteZoneAccessRule options.
func (*DeleteZoneAccessRuleOptions) SetAccessruleIdentifier ¶
func (options *DeleteZoneAccessRuleOptions) SetAccessruleIdentifier(accessruleIdentifier string) *DeleteZoneAccessRuleOptions
SetAccessruleIdentifier : Allow user to set AccessruleIdentifier
func (*DeleteZoneAccessRuleOptions) SetHeaders ¶
func (options *DeleteZoneAccessRuleOptions) SetHeaders(param map[string]string) *DeleteZoneAccessRuleOptions
SetHeaders : Allow user to set Headers
type DeleteZoneAccessRuleResp ¶
type DeleteZoneAccessRuleResp struct { // Operation success flag. Success *bool `json:"success" validate:"required"` // Array of errors encountered. Errors [][]string `json:"errors" validate:"required"` // Array of messages returned. Messages [][]string `json:"messages" validate:"required"` // Container for response information. Result *DeleteZoneAccessRuleRespResult `json:"result" validate:"required"` }
DeleteZoneAccessRuleResp : delete access rule response.
type DeleteZoneAccessRuleRespResult ¶
type DeleteZoneAccessRuleRespResult struct { // ID. ID *string `json:"id" validate:"required"` }
DeleteZoneAccessRuleRespResult : Container for response information.
type GetZoneAccessRuleOptions ¶
type GetZoneAccessRuleOptions struct { // Identifier of firewall access rule for the given zone. AccessruleIdentifier *string `json:"accessrule_identifier" validate:"required,ne="` // Allows users to set headers on API requests Headers map[string]string }
GetZoneAccessRuleOptions : The GetZoneAccessRule options.
func (*GetZoneAccessRuleOptions) SetAccessruleIdentifier ¶
func (options *GetZoneAccessRuleOptions) SetAccessruleIdentifier(accessruleIdentifier string) *GetZoneAccessRuleOptions
SetAccessruleIdentifier : Allow user to set AccessruleIdentifier
func (*GetZoneAccessRuleOptions) SetHeaders ¶
func (options *GetZoneAccessRuleOptions) SetHeaders(param map[string]string) *GetZoneAccessRuleOptions
SetHeaders : Allow user to set Headers
type ListAllZoneAccessRulesOptions ¶
type ListAllZoneAccessRulesOptions struct { // Search access rules by note.(Not case sensitive). Notes *string `json:"notes,omitempty"` // Search access rules by mode. Mode *string `json:"mode,omitempty"` // Search access rules by configuration target. ConfigurationTarget *string `json:"configuration.target,omitempty"` // Search access rules by configuration value which can be IP, IPrange, or country code. ConfigurationValue *string `json:"configuration.value,omitempty"` // Page number of paginated results. Page *int64 `json:"page,omitempty"` // Maximum number of access rules per page. PerPage *int64 `json:"per_page,omitempty"` // Field by which to order list of access rules. Order *string `json:"order,omitempty"` // Direction in which to order results [ascending/descending order]. Direction *string `json:"direction,omitempty"` // Whether to match all (all) or atleast one search parameter (any). Match *string `json:"match,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
ListAllZoneAccessRulesOptions : The ListAllZoneAccessRules options.
func (*ListAllZoneAccessRulesOptions) SetConfigurationTarget ¶
func (options *ListAllZoneAccessRulesOptions) SetConfigurationTarget(configurationTarget string) *ListAllZoneAccessRulesOptions
SetConfigurationTarget : Allow user to set ConfigurationTarget
func (*ListAllZoneAccessRulesOptions) SetConfigurationValue ¶
func (options *ListAllZoneAccessRulesOptions) SetConfigurationValue(configurationValue string) *ListAllZoneAccessRulesOptions
SetConfigurationValue : Allow user to set ConfigurationValue
func (*ListAllZoneAccessRulesOptions) SetDirection ¶
func (options *ListAllZoneAccessRulesOptions) SetDirection(direction string) *ListAllZoneAccessRulesOptions
SetDirection : Allow user to set Direction
func (*ListAllZoneAccessRulesOptions) SetHeaders ¶
func (options *ListAllZoneAccessRulesOptions) SetHeaders(param map[string]string) *ListAllZoneAccessRulesOptions
SetHeaders : Allow user to set Headers
func (*ListAllZoneAccessRulesOptions) SetMatch ¶
func (options *ListAllZoneAccessRulesOptions) SetMatch(match string) *ListAllZoneAccessRulesOptions
SetMatch : Allow user to set Match
func (*ListAllZoneAccessRulesOptions) SetMode ¶
func (options *ListAllZoneAccessRulesOptions) SetMode(mode string) *ListAllZoneAccessRulesOptions
SetMode : Allow user to set Mode
func (*ListAllZoneAccessRulesOptions) SetNotes ¶
func (options *ListAllZoneAccessRulesOptions) SetNotes(notes string) *ListAllZoneAccessRulesOptions
SetNotes : Allow user to set Notes
func (*ListAllZoneAccessRulesOptions) SetOrder ¶
func (options *ListAllZoneAccessRulesOptions) SetOrder(order string) *ListAllZoneAccessRulesOptions
SetOrder : Allow user to set Order
func (*ListAllZoneAccessRulesOptions) SetPage ¶
func (options *ListAllZoneAccessRulesOptions) SetPage(page int64) *ListAllZoneAccessRulesOptions
SetPage : Allow user to set Page
func (*ListAllZoneAccessRulesOptions) SetPerPage ¶
func (options *ListAllZoneAccessRulesOptions) SetPerPage(perPage int64) *ListAllZoneAccessRulesOptions
SetPerPage : Allow user to set PerPage
type ListZoneAccessRulesResp ¶
type ListZoneAccessRulesResp struct { // Operation success flag. Success *bool `json:"success" validate:"required"` // Array of errors encountered. Errors [][]string `json:"errors" validate:"required"` // Array of messages returned. Messages [][]string `json:"messages" validate:"required"` // Container for response information. Result []ZoneAccessRuleObject `json:"result" validate:"required"` // Statistics of results. ResultInfo *ListZoneAccessRulesRespResultInfo `json:"result_info" validate:"required"` }
ListZoneAccessRulesResp : list access rules response.
type ListZoneAccessRulesRespResultInfo ¶
type ListZoneAccessRulesRespResultInfo struct { // Page number. Page *int64 `json:"page" validate:"required"` // Number of results per page. PerPage *int64 `json:"per_page" validate:"required"` // Number of results. Count *int64 `json:"count" validate:"required"` // Total number of results. TotalCount *int64 `json:"total_count" validate:"required"` }
ListZoneAccessRulesRespResultInfo : Statistics of results.
type UpdateZoneAccessRuleOptions ¶
type UpdateZoneAccessRuleOptions struct { // Identifier of firewall access rule. AccessruleIdentifier *string `json:"accessrule_identifier" validate:"required,ne="` // The action to apply to a matched request. Mode *string `json:"mode,omitempty"` // A personal note about the rule. Typically used as a reminder or explanation for the rule. Notes *string `json:"notes,omitempty"` // Allows users to set headers on API requests Headers map[string]string }
UpdateZoneAccessRuleOptions : The UpdateZoneAccessRule options.
func (*UpdateZoneAccessRuleOptions) SetAccessruleIdentifier ¶
func (options *UpdateZoneAccessRuleOptions) SetAccessruleIdentifier(accessruleIdentifier string) *UpdateZoneAccessRuleOptions
SetAccessruleIdentifier : Allow user to set AccessruleIdentifier
func (*UpdateZoneAccessRuleOptions) SetHeaders ¶
func (options *UpdateZoneAccessRuleOptions) SetHeaders(param map[string]string) *UpdateZoneAccessRuleOptions
SetHeaders : Allow user to set Headers
func (*UpdateZoneAccessRuleOptions) SetMode ¶
func (options *UpdateZoneAccessRuleOptions) SetMode(mode string) *UpdateZoneAccessRuleOptions
SetMode : Allow user to set Mode
func (*UpdateZoneAccessRuleOptions) SetNotes ¶
func (options *UpdateZoneAccessRuleOptions) SetNotes(notes string) *UpdateZoneAccessRuleOptions
SetNotes : Allow user to set Notes
type ZoneAccessRuleInputConfiguration ¶
type ZoneAccessRuleInputConfiguration struct { // The request property to target. Target *string `json:"target" validate:"required"` // The value for the selected target.For ip the value is a valid ip address.For ip_range the value specifies ip range // limited to /16 and /24. For asn the value is an AS number. For country the value is a country code for the country. Value *string `json:"value" validate:"required"` }
ZoneAccessRuleInputConfiguration : Configuration object specifying access rule.
type ZoneAccessRuleObject ¶
type ZoneAccessRuleObject struct { // Identifier of the firewall access rule. ID *string `json:"id" validate:"required"` // A personal note about the rule. Typically used as a reminder or explanation for the rule. Notes *string `json:"notes" validate:"required"` // List of modes that are allowed. AllowedModes []string `json:"allowed_modes" validate:"required"` // The action to be applied to a request matching the access rule. Mode *string `json:"mode" validate:"required"` // The scope definition of the access rule. Scope *ZoneAccessRuleObjectScope `json:"scope,omitempty"` // The creation date-time of the firewall access rule. CreatedOn *string `json:"created_on" validate:"required"` // The modification date-time of the firewall access rule. ModifiedOn *string `json:"modified_on" validate:"required"` // configuration. Configuration *ZoneAccessRuleObjectConfiguration `json:"configuration" validate:"required"` }
ZoneAccessRuleObject : access rule object.
type ZoneAccessRuleObjectConfiguration ¶
type ZoneAccessRuleObjectConfiguration struct { // target. Target *string `json:"target" validate:"required"` // Value for the given target. For ip the value is a valid ip address.For ip_range the value specifies ip range limited // to /16 and /24. For asn the value is an AS number. For country the value is a country code for the country. Value *string `json:"value" validate:"required"` }
ZoneAccessRuleObjectConfiguration : configuration.
type ZoneAccessRuleObjectScope ¶
type ZoneAccessRuleObjectScope struct { // The scope of the access rule, indicating if its applicable at zone level("zone") or inherited from instance // level("account"). Type *string `json:"type" validate:"required"` }
ZoneAccessRuleObjectScope : The scope definition of the access rule.
type ZoneAccessRuleResp ¶
type ZoneAccessRuleResp struct { // Operation success flag. Success *bool `json:"success" validate:"required"` // Array of errors encountered. Errors [][]string `json:"errors" validate:"required"` // Array of messages returned. Messages [][]string `json:"messages" validate:"required"` // access rule object. Result *ZoneAccessRuleObject `json:"result" validate:"required"` }
ZoneAccessRuleResp : access rule response.
type ZoneFirewallAccessRulesV1 ¶
type ZoneFirewallAccessRulesV1 struct { Service *core.BaseService // Full crn of the service instance. Crn *string // Identifier of zone whose access rule is to be deleted. ZoneIdentifier *string }
ZoneFirewallAccessRulesV1 : Zone Firewall Access Rules
Version: 1.0.1
func NewZoneFirewallAccessRulesV1 ¶
func NewZoneFirewallAccessRulesV1(options *ZoneFirewallAccessRulesV1Options) (service *ZoneFirewallAccessRulesV1, err error)
NewZoneFirewallAccessRulesV1 : constructs an instance of ZoneFirewallAccessRulesV1 with passed in options.
func NewZoneFirewallAccessRulesV1UsingExternalConfig ¶
func NewZoneFirewallAccessRulesV1UsingExternalConfig(options *ZoneFirewallAccessRulesV1Options) (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1, err error)
NewZoneFirewallAccessRulesV1UsingExternalConfig : constructs an instance of ZoneFirewallAccessRulesV1 with passed in options and external configuration.
func (*ZoneFirewallAccessRulesV1) Clone ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) Clone() *ZoneFirewallAccessRulesV1
Clone makes a copy of "zoneFirewallAccessRules" suitable for processing requests.
func (*ZoneFirewallAccessRulesV1) CreateZoneAccessRule ¶
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) CreateZoneAccessRule(createZoneAccessRuleOptions *CreateZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
CreateZoneAccessRule : Create firewall access rule Create a new firewall access rule for a given zone under a service instance.
func (*ZoneFirewallAccessRulesV1) CreateZoneAccessRuleWithContext ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) CreateZoneAccessRuleWithContext(ctx context.Context, createZoneAccessRuleOptions *CreateZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
CreateZoneAccessRuleWithContext is an alternate form of the CreateZoneAccessRule method which supports a Context parameter
func (*ZoneFirewallAccessRulesV1) DeleteZoneAccessRule ¶
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) DeleteZoneAccessRule(deleteZoneAccessRuleOptions *DeleteZoneAccessRuleOptions) (result *DeleteZoneAccessRuleResp, response *core.DetailedResponse, err error)
DeleteZoneAccessRule : Delete firewall access rule Delete an access rule given its id.
func (*ZoneFirewallAccessRulesV1) DeleteZoneAccessRuleWithContext ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) DeleteZoneAccessRuleWithContext(ctx context.Context, deleteZoneAccessRuleOptions *DeleteZoneAccessRuleOptions) (result *DeleteZoneAccessRuleResp, response *core.DetailedResponse, err error)
DeleteZoneAccessRuleWithContext is an alternate form of the DeleteZoneAccessRule method which supports a Context parameter
func (*ZoneFirewallAccessRulesV1) DisableRetries ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) DisableRetries()
DisableRetries disables automatic retries for requests invoked for this service instance.
func (*ZoneFirewallAccessRulesV1) EnableRetries ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) 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 (*ZoneFirewallAccessRulesV1) GetEnableGzipCompression ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) GetEnableGzipCompression() bool
GetEnableGzipCompression returns the service's EnableGzipCompression field
func (*ZoneFirewallAccessRulesV1) GetServiceURL ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) GetServiceURL() string
GetServiceURL returns the service URL
func (*ZoneFirewallAccessRulesV1) GetZoneAccessRule ¶
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) GetZoneAccessRule(getZoneAccessRuleOptions *GetZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
GetZoneAccessRule : Get firewall access rule Get the details of a firewall access rule for a given zone under a given service instance.
func (*ZoneFirewallAccessRulesV1) GetZoneAccessRuleWithContext ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) GetZoneAccessRuleWithContext(ctx context.Context, getZoneAccessRuleOptions *GetZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
GetZoneAccessRuleWithContext is an alternate form of the GetZoneAccessRule method which supports a Context parameter
func (*ZoneFirewallAccessRulesV1) ListAllZoneAccessRules ¶
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) ListAllZoneAccessRules(listAllZoneAccessRulesOptions *ListAllZoneAccessRulesOptions) (result *ListZoneAccessRulesResp, response *core.DetailedResponse, err error)
ListAllZoneAccessRules : List all firewall access rules List all firewall access rules for a zone.
func (*ZoneFirewallAccessRulesV1) ListAllZoneAccessRulesWithContext ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) ListAllZoneAccessRulesWithContext(ctx context.Context, listAllZoneAccessRulesOptions *ListAllZoneAccessRulesOptions) (result *ListZoneAccessRulesResp, response *core.DetailedResponse, err error)
ListAllZoneAccessRulesWithContext is an alternate form of the ListAllZoneAccessRules method which supports a Context parameter
func (*ZoneFirewallAccessRulesV1) NewCreateZoneAccessRuleOptions ¶
func (*ZoneFirewallAccessRulesV1) NewCreateZoneAccessRuleOptions() *CreateZoneAccessRuleOptions
NewCreateZoneAccessRuleOptions : Instantiate CreateZoneAccessRuleOptions
func (*ZoneFirewallAccessRulesV1) NewDeleteZoneAccessRuleOptions ¶
func (*ZoneFirewallAccessRulesV1) NewDeleteZoneAccessRuleOptions(accessruleIdentifier string) *DeleteZoneAccessRuleOptions
NewDeleteZoneAccessRuleOptions : Instantiate DeleteZoneAccessRuleOptions
func (*ZoneFirewallAccessRulesV1) NewGetZoneAccessRuleOptions ¶
func (*ZoneFirewallAccessRulesV1) NewGetZoneAccessRuleOptions(accessruleIdentifier string) *GetZoneAccessRuleOptions
NewGetZoneAccessRuleOptions : Instantiate GetZoneAccessRuleOptions
func (*ZoneFirewallAccessRulesV1) NewListAllZoneAccessRulesOptions ¶
func (*ZoneFirewallAccessRulesV1) NewListAllZoneAccessRulesOptions() *ListAllZoneAccessRulesOptions
NewListAllZoneAccessRulesOptions : Instantiate ListAllZoneAccessRulesOptions
func (*ZoneFirewallAccessRulesV1) NewUpdateZoneAccessRuleOptions ¶
func (*ZoneFirewallAccessRulesV1) NewUpdateZoneAccessRuleOptions(accessruleIdentifier string) *UpdateZoneAccessRuleOptions
NewUpdateZoneAccessRuleOptions : Instantiate UpdateZoneAccessRuleOptions
func (*ZoneFirewallAccessRulesV1) NewZoneAccessRuleInputConfiguration ¶
func (*ZoneFirewallAccessRulesV1) NewZoneAccessRuleInputConfiguration(target string, value string) (model *ZoneAccessRuleInputConfiguration, err error)
NewZoneAccessRuleInputConfiguration : Instantiate ZoneAccessRuleInputConfiguration (Generic Model Constructor)
func (*ZoneFirewallAccessRulesV1) SetDefaultHeaders ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) SetDefaultHeaders(headers http.Header)
SetDefaultHeaders sets HTTP headers to be sent in every request
func (*ZoneFirewallAccessRulesV1) SetEnableGzipCompression ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) SetEnableGzipCompression(enableGzip bool)
SetEnableGzipCompression sets the service's EnableGzipCompression field
func (*ZoneFirewallAccessRulesV1) SetServiceURL ¶
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) SetServiceURL(url string) error
SetServiceURL sets the service URL
func (*ZoneFirewallAccessRulesV1) UpdateZoneAccessRule ¶
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) UpdateZoneAccessRule(updateZoneAccessRuleOptions *UpdateZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
UpdateZoneAccessRule : Update firewall access rule Update an existing firewall access rule for a given zone under a given service instance.
func (*ZoneFirewallAccessRulesV1) UpdateZoneAccessRuleWithContext ¶ added in v0.12.1
func (zoneFirewallAccessRules *ZoneFirewallAccessRulesV1) UpdateZoneAccessRuleWithContext(ctx context.Context, updateZoneAccessRuleOptions *UpdateZoneAccessRuleOptions) (result *ZoneAccessRuleResp, response *core.DetailedResponse, err error)
UpdateZoneAccessRuleWithContext is an alternate form of the UpdateZoneAccessRule method which supports a Context parameter
type ZoneFirewallAccessRulesV1Options ¶
type ZoneFirewallAccessRulesV1Options struct { ServiceName string URL string Authenticator core.Authenticator // Full crn of the service instance. Crn *string `validate:"required"` // Identifier of zone whose access rule is to be deleted. ZoneIdentifier *string `validate:"required"` }
ZoneFirewallAccessRulesV1Options : Service options