firewallrulesv1

package
v0.46.1 Latest Latest
Warning

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

Go to latest
Published: Apr 24, 2024 License: Apache-2.0 Imports: 8 Imported by: 2

Documentation

Overview

Package firewallrulesv1 : Operations and models for the FirewallRulesV1 service

Index

Constants

View Source
const (
	FirewallRulesUpdateInputItem_Action_Allow       = "allow"
	FirewallRulesUpdateInputItem_Action_Block       = "block"
	FirewallRulesUpdateInputItem_Action_Challenge   = "challenge"
	FirewallRulesUpdateInputItem_Action_JsChallenge = "js_challenge"
	FirewallRulesUpdateInputItem_Action_Log         = "log"
)

Constants associated with the FirewallRulesUpdateInputItem.Action property. The firewall action to perform, "log" action is only available for enterprise plan instances.

View Source
const (
	UpdateFirewallRuleOptions_Action_Allow       = "allow"
	UpdateFirewallRuleOptions_Action_Block       = "block"
	UpdateFirewallRuleOptions_Action_Challenge   = "challenge"
	UpdateFirewallRuleOptions_Action_JsChallenge = "js_challenge"
	UpdateFirewallRuleOptions_Action_Log         = "log"
)

Constants associated with the UpdateFirewallRuleOptions.Action property. The firewall action to perform, "log" action is only available for enterprise plan instances.

View Source
const (
	FirewallRuleInput_Action_Allow       = "allow"
	FirewallRuleInput_Action_Block       = "block"
	FirewallRuleInput_Action_Challenge   = "challenge"
	FirewallRuleInput_Action_JsChallenge = "js_challenge"
	FirewallRuleInput_Action_Log         = "log"
)

Constants associated with the FirewallRuleInput.Action property. The firewall action to perform, "log" action is only available for enterprise plan instances.

View Source
const (
	FirewallRuleObject_Action_Allow       = "allow"
	FirewallRuleObject_Action_Block       = "block"
	FirewallRuleObject_Action_Challenge   = "challenge"
	FirewallRuleObject_Action_JsChallenge = "js_challenge"
	FirewallRuleObject_Action_Log         = "log"
)

Constants associated with the FirewallRuleObject.Action property. The firewall action to perform, "log" action is only available for enterprise plan instances.

View Source
const DefaultServiceName = "firewall_rules"

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

View Source
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

func GetServiceURLForRegion(region string) (string, error)

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

func UnmarshalDeleteFirewallRuleResp added in v0.16.0

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

UnmarshalDeleteFirewallRuleResp unmarshals an instance of DeleteFirewallRuleResp from the specified map of raw messages.

func UnmarshalDeleteFirewallRuleRespResult added in v0.16.0

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

UnmarshalDeleteFirewallRuleRespResult unmarshals an instance of DeleteFirewallRuleRespResult from the specified map of raw messages.

func UnmarshalDeleteFirewallRulesResp added in v0.16.0

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

UnmarshalDeleteFirewallRulesResp unmarshals an instance of DeleteFirewallRulesResp from the specified map of raw messages.

func UnmarshalDeleteFirewallRulesRespResultItem added in v0.16.0

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

UnmarshalDeleteFirewallRulesRespResultItem unmarshals an instance of DeleteFirewallRulesRespResultItem from the specified map of raw messages.

func UnmarshalFirewallRuleInput added in v0.33.0

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

UnmarshalFirewallRuleInput unmarshals an instance of FirewallRuleInput from the specified map of raw messages.

func UnmarshalFirewallRuleInputFilter added in v0.33.0

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

UnmarshalFirewallRuleInputFilter unmarshals an instance of FirewallRuleInputFilter from the specified map of raw messages.

func UnmarshalFirewallRuleInputFilterExpression added in v0.33.0

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

UnmarshalFirewallRuleInputFilterExpression unmarshals an instance of FirewallRuleInputFilterExpression from the specified map of raw messages.

func UnmarshalFirewallRuleInputFilterID added in v0.33.0

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

UnmarshalFirewallRuleInputFilterID unmarshals an instance of FirewallRuleInputFilterID from the specified map of raw messages.

func UnmarshalFirewallRuleObject added in v0.16.0

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

UnmarshalFirewallRuleObject unmarshals an instance of FirewallRuleObject from the specified map of raw messages.

func UnmarshalFirewallRuleObjectFilter added in v0.16.0

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

UnmarshalFirewallRuleObjectFilter unmarshals an instance of FirewallRuleObjectFilter from the specified map of raw messages.

func UnmarshalFirewallRuleResp added in v0.16.0

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

UnmarshalFirewallRuleResp unmarshals an instance of FirewallRuleResp from the specified map of raw messages.

func UnmarshalFirewallRuleUpdateInputFilter

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

UnmarshalFirewallRuleUpdateInputFilter unmarshals an instance of FirewallRuleUpdateInputFilter from the specified map of raw messages.

func UnmarshalFirewallRulesResp added in v0.16.0

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

UnmarshalFirewallRulesResp unmarshals an instance of FirewallRulesResp from the specified map of raw messages.

func UnmarshalFirewallRulesUpdateInputItem

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

UnmarshalFirewallRulesUpdateInputItem unmarshals an instance of FirewallRulesUpdateInputItem from the specified map of raw messages.

func UnmarshalFirewallRulesUpdateInputItemFilter

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

UnmarshalFirewallRulesUpdateInputItemFilter unmarshals an instance of FirewallRulesUpdateInputItemFilter from the specified map of raw messages.

func UnmarshalListFirewallRulesResp added in v0.16.0

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

UnmarshalListFirewallRulesResp unmarshals an instance of ListFirewallRulesResp from the specified map of raw messages.

func UnmarshalListFirewallRulesRespResultInfo added in v0.16.0

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

UnmarshalListFirewallRulesRespResultInfo unmarshals an instance of ListFirewallRulesRespResultInfo from the specified map of raw messages.

Types

type CreateFirewallRulesOptions

type CreateFirewallRulesOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `json:"X-Auth-User-Token" validate:"required"`

	// Full url-encoded cloud resource name (CRN) of resource instance.
	Crn *string `json:"crn" validate:"required,ne="`

	// Zone identifier of the zone for which firewall rules are created.
	ZoneIdentifier *string `json:"zone_identifier" validate:"required,ne="`

	// Json objects which are used to create firewall rules.
	FirewallRuleInput []FirewallRuleInput `json:"firewall_rule_input,omitempty"`

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

CreateFirewallRulesOptions : The CreateFirewallRules options.

func (*CreateFirewallRulesOptions) SetCrn

SetCrn : Allow user to set Crn

func (*CreateFirewallRulesOptions) SetFirewallRuleInput added in v0.33.0

func (_options *CreateFirewallRulesOptions) SetFirewallRuleInput(firewallRuleInput []FirewallRuleInput) *CreateFirewallRulesOptions

SetFirewallRuleInput : Allow user to set FirewallRuleInput

func (*CreateFirewallRulesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateFirewallRulesOptions) SetXAuthUserToken

func (_options *CreateFirewallRulesOptions) SetXAuthUserToken(xAuthUserToken string) *CreateFirewallRulesOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*CreateFirewallRulesOptions) SetZoneIdentifier

func (_options *CreateFirewallRulesOptions) SetZoneIdentifier(zoneIdentifier string) *CreateFirewallRulesOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type DeleteFirewallRuleOptions

type DeleteFirewallRuleOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `json:"X-Auth-User-Token" validate:"required"`

	// Full crn of the service instance.
	Crn *string `json:"crn" validate:"required,ne="`

	// Identifier of zone whose firewall rule is to be deleted.
	ZoneIdentifier *string `json:"zone_identifier" validate:"required,ne="`

	// Identifier of the firewall rule to be deleted.
	FirewallRuleIdentifier *string `json:"firewall_rule_identifier" validate:"required,ne="`

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

DeleteFirewallRuleOptions : The DeleteFirewallRule options.

func (*DeleteFirewallRuleOptions) SetCrn

SetCrn : Allow user to set Crn

func (*DeleteFirewallRuleOptions) SetFirewallRuleIdentifier

func (_options *DeleteFirewallRuleOptions) SetFirewallRuleIdentifier(firewallRuleIdentifier string) *DeleteFirewallRuleOptions

SetFirewallRuleIdentifier : Allow user to set FirewallRuleIdentifier

func (*DeleteFirewallRuleOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteFirewallRuleOptions) SetXAuthUserToken

func (_options *DeleteFirewallRuleOptions) SetXAuthUserToken(xAuthUserToken string) *DeleteFirewallRuleOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*DeleteFirewallRuleOptions) SetZoneIdentifier

func (_options *DeleteFirewallRuleOptions) SetZoneIdentifier(zoneIdentifier string) *DeleteFirewallRuleOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type DeleteFirewallRuleResp added in v0.16.0

type DeleteFirewallRuleResp 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 *DeleteFirewallRuleRespResult `json:"result" validate:"required"`
}

DeleteFirewallRuleResp : DeleteFirewallRuleResp struct

type DeleteFirewallRuleRespResult added in v0.16.0

type DeleteFirewallRuleRespResult struct {
	// Identifier of the firewall rule.
	ID *string `json:"id" validate:"required"`
}

DeleteFirewallRuleRespResult : Container for response information.

type DeleteFirewallRulesOptions

type DeleteFirewallRulesOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `json:"X-Auth-User-Token" validate:"required"`

	// Full crn of the service instance.
	Crn *string `json:"crn" validate:"required,ne="`

	// Identifier of zone whose firewall rules are to be deleted.
	ZoneIdentifier *string `json:"zone_identifier" validate:"required,ne="`

	// ids of firewall rules which will be deleted.
	ID *string `json:"id" validate:"required"`

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

DeleteFirewallRulesOptions : The DeleteFirewallRules options.

func (*DeleteFirewallRulesOptions) SetCrn

SetCrn : Allow user to set Crn

func (*DeleteFirewallRulesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteFirewallRulesOptions) SetID

SetID : Allow user to set ID

func (*DeleteFirewallRulesOptions) SetXAuthUserToken

func (_options *DeleteFirewallRulesOptions) SetXAuthUserToken(xAuthUserToken string) *DeleteFirewallRulesOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*DeleteFirewallRulesOptions) SetZoneIdentifier

func (_options *DeleteFirewallRulesOptions) SetZoneIdentifier(zoneIdentifier string) *DeleteFirewallRulesOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type DeleteFirewallRulesResp added in v0.16.0

type DeleteFirewallRulesResp 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 []DeleteFirewallRulesRespResultItem `json:"result" validate:"required"`
}

DeleteFirewallRulesResp : DeleteFirewallRulesResp struct

type DeleteFirewallRulesRespResultItem added in v0.16.0

type DeleteFirewallRulesRespResultItem struct {
	// Identifier of firewall rules.
	ID *string `json:"id" validate:"required"`
}

DeleteFirewallRulesRespResultItem : DeleteFirewallRulesRespResultItem struct

type FirewallRuleInput added in v0.33.0

type FirewallRuleInput struct {
	Filter FirewallRuleInputFilterIntf `json:"filter" validate:"required"`

	// The firewall action to perform, "log" action is only available for enterprise plan instances.
	Action *string `json:"action" validate:"required"`

	// An informative summary of the firewall rule.
	Description *string `json:"description,omitempty"`

	// Indicates if the firewall rule is active.
	Paused *bool `json:"paused,omitempty"`

	// The priority of the rule.
	Priority *int64 `json:"priority,omitempty"`
}

FirewallRuleInput : Json objects which are used to create firewall rule.

type FirewallRuleInputFilter added in v0.33.0

type FirewallRuleInputFilter struct {
	// Identifier of the filter.
	ID *string `json:"id,omitempty"`

	// A filter expression.
	Expression *string `json:"expression,omitempty"`

	// Indicates if the filter is active.
	Paused *bool `json:"paused,omitempty"`

	// An informative summary of the filter.
	Description *string `json:"description,omitempty"`
}

FirewallRuleInputFilter : FirewallRuleInputFilter struct Models which "extend" this model: - FirewallRuleInputFilterID - FirewallRuleInputFilterExpression

type FirewallRuleInputFilterExpression added in v0.33.0

type FirewallRuleInputFilterExpression struct {
	// A filter expression.
	Expression *string `json:"expression" validate:"required"`

	// Indicates if the filter is active.
	Paused *bool `json:"paused,omitempty"`

	// An informative summary of the filter.
	Description *string `json:"description,omitempty"`
}

FirewallRuleInputFilterExpression : Json objects which are used to create firewall rule. This model "extends" FirewallRuleInputFilter

type FirewallRuleInputFilterID added in v0.33.0

type FirewallRuleInputFilterID struct {
	// Identifier of the filter.
	ID *string `json:"id" validate:"required"`
}

FirewallRuleInputFilterID : An existing filter. This model "extends" FirewallRuleInputFilter

type FirewallRuleInputFilterIntf added in v0.33.0

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

type FirewallRuleObject added in v0.16.0

type FirewallRuleObject struct {
	// Identifier of the firewall rule.
	ID *string `json:"id" validate:"required"`

	// Indicates if the firewall rule is active.
	Paused *bool `json:"paused" validate:"required"`

	// To briefly describe the firewall rule, omitted from object if empty.
	Description *string `json:"description" validate:"required"`

	// The firewall action to perform, "log" action is only available for enterprise plan instances.
	Action *string `json:"action" validate:"required"`

	// An existing filter.
	Filter *FirewallRuleObjectFilter `json:"filter" validate:"required"`

	// The creation date-time of the filter.
	CreatedOn *string `json:"created_on" validate:"required"`

	// The modification date-time of the filter.
	ModifiedOn *string `json:"modified_on" validate:"required"`
}

FirewallRuleObject : FirewallRuleObject struct

type FirewallRuleObjectFilter added in v0.16.0

type FirewallRuleObjectFilter struct {
	// Identifier of the filter.
	ID *string `json:"id" validate:"required"`

	// Indicates if the filter is active.
	Paused *bool `json:"paused" validate:"required"`

	// To briefly describe the filter, omitted from object if empty.
	Description *string `json:"description" validate:"required"`

	// A filter expression.
	Expression *string `json:"expression" validate:"required"`
}

FirewallRuleObjectFilter : An existing filter.

type FirewallRuleResp added in v0.16.0

type FirewallRuleResp 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"`

	Result *FirewallRuleObject `json:"result" validate:"required"`
}

FirewallRuleResp : FirewallRuleResp struct

type FirewallRuleUpdateInputFilter

type FirewallRuleUpdateInputFilter struct {
	// Identifier of the filter.
	ID *string `json:"id" validate:"required"`
}

FirewallRuleUpdateInputFilter : An existing filter.

type FirewallRulesResp added in v0.16.0

type FirewallRulesResp 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 []FirewallRuleObject `json:"result" validate:"required"`
}

FirewallRulesResp : FirewallRulesResp struct

type FirewallRulesUpdateInputItem

type FirewallRulesUpdateInputItem struct {
	// Identifier of the firewall rule.
	ID *string `json:"id" validate:"required"`

	// The firewall action to perform, "log" action is only available for enterprise plan instances.
	Action *string `json:"action" validate:"required"`

	// Indicates if the firewall rule is active.
	Paused *bool `json:"paused,omitempty"`

	// The priority of the rule.
	Priority *int64 `json:"priority,omitempty"`

	// To briefly describe the firewall rule, omitted from object if empty.
	Description *string `json:"description,omitempty"`

	// An existing filter.
	Filter *FirewallRulesUpdateInputItemFilter `json:"filter,omitempty"`
}

FirewallRulesUpdateInputItem : FirewallRulesUpdateInputItem struct

type FirewallRulesUpdateInputItemFilter

type FirewallRulesUpdateInputItemFilter struct {
	// Identifier of the filter.
	ID *string `json:"id" validate:"required"`
}

FirewallRulesUpdateInputItemFilter : An existing filter.

type FirewallRulesV1

type FirewallRulesV1 struct {
	Service *core.BaseService
}

FirewallRulesV1 : Firewall rules

API Version: 1.0.1

func NewFirewallRulesV1

func NewFirewallRulesV1(options *FirewallRulesV1Options) (service *FirewallRulesV1, err error)

NewFirewallRulesV1 : constructs an instance of FirewallRulesV1 with passed in options.

func NewFirewallRulesV1UsingExternalConfig

func NewFirewallRulesV1UsingExternalConfig(options *FirewallRulesV1Options) (firewallRules *FirewallRulesV1, err error)

NewFirewallRulesV1UsingExternalConfig : constructs an instance of FirewallRulesV1 with passed in options and external configuration.

func (*FirewallRulesV1) Clone

func (firewallRules *FirewallRulesV1) Clone() *FirewallRulesV1

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

func (*FirewallRulesV1) CreateFirewallRules

func (firewallRules *FirewallRulesV1) CreateFirewallRules(createFirewallRulesOptions *CreateFirewallRulesOptions) (result *FirewallRulesResp, response *core.DetailedResponse, err error)

CreateFirewallRules : Create firewall rules for a zone Create new firewall rules for a given zone under a service instance.

func (*FirewallRulesV1) CreateFirewallRulesWithContext

func (firewallRules *FirewallRulesV1) CreateFirewallRulesWithContext(ctx context.Context, createFirewallRulesOptions *CreateFirewallRulesOptions) (result *FirewallRulesResp, response *core.DetailedResponse, err error)

CreateFirewallRulesWithContext is an alternate form of the CreateFirewallRules method which supports a Context parameter

func (*FirewallRulesV1) DeleteFirewallRule

func (firewallRules *FirewallRulesV1) DeleteFirewallRule(deleteFirewallRuleOptions *DeleteFirewallRuleOptions) (result *DeleteFirewallRuleResp, response *core.DetailedResponse, err error)

DeleteFirewallRule : Delete a firewall rule Delete a firewall rule given its id.

func (*FirewallRulesV1) DeleteFirewallRuleWithContext

func (firewallRules *FirewallRulesV1) DeleteFirewallRuleWithContext(ctx context.Context, deleteFirewallRuleOptions *DeleteFirewallRuleOptions) (result *DeleteFirewallRuleResp, response *core.DetailedResponse, err error)

DeleteFirewallRuleWithContext is an alternate form of the DeleteFirewallRule method which supports a Context parameter

func (*FirewallRulesV1) DeleteFirewallRules

func (firewallRules *FirewallRulesV1) DeleteFirewallRules(deleteFirewallRulesOptions *DeleteFirewallRulesOptions) (result *DeleteFirewallRulesResp, response *core.DetailedResponse, err error)

DeleteFirewallRules : Delete firewall rules Delete firewall rules by filter ids.

func (*FirewallRulesV1) DeleteFirewallRulesWithContext

func (firewallRules *FirewallRulesV1) DeleteFirewallRulesWithContext(ctx context.Context, deleteFirewallRulesOptions *DeleteFirewallRulesOptions) (result *DeleteFirewallRulesResp, response *core.DetailedResponse, err error)

DeleteFirewallRulesWithContext is an alternate form of the DeleteFirewallRules method which supports a Context parameter

func (*FirewallRulesV1) DisableRetries

func (firewallRules *FirewallRulesV1) DisableRetries()

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

func (*FirewallRulesV1) EnableRetries

func (firewallRules *FirewallRulesV1) 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 (*FirewallRulesV1) GetEnableGzipCompression

func (firewallRules *FirewallRulesV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*FirewallRulesV1) GetFirewallRule

func (firewallRules *FirewallRulesV1) GetFirewallRule(getFirewallRuleOptions *GetFirewallRuleOptions) (result *FirewallRuleResp, response *core.DetailedResponse, err error)

GetFirewallRule : Get firewall rule details by id Get the details of a firewall rule for a given zone under a given service instance.

func (*FirewallRulesV1) GetFirewallRuleWithContext

func (firewallRules *FirewallRulesV1) GetFirewallRuleWithContext(ctx context.Context, getFirewallRuleOptions *GetFirewallRuleOptions) (result *FirewallRuleResp, response *core.DetailedResponse, err error)

GetFirewallRuleWithContext is an alternate form of the GetFirewallRule method which supports a Context parameter

func (*FirewallRulesV1) GetServiceURL

func (firewallRules *FirewallRulesV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*FirewallRulesV1) ListAllFirewallRules

func (firewallRules *FirewallRulesV1) ListAllFirewallRules(listAllFirewallRulesOptions *ListAllFirewallRulesOptions) (result *ListFirewallRulesResp, response *core.DetailedResponse, err error)

ListAllFirewallRules : List all firewall rules for a zone List all firewall rules for a zone.

func (*FirewallRulesV1) ListAllFirewallRulesWithContext

func (firewallRules *FirewallRulesV1) ListAllFirewallRulesWithContext(ctx context.Context, listAllFirewallRulesOptions *ListAllFirewallRulesOptions) (result *ListFirewallRulesResp, response *core.DetailedResponse, err error)

ListAllFirewallRulesWithContext is an alternate form of the ListAllFirewallRules method which supports a Context parameter

func (*FirewallRulesV1) NewCreateFirewallRulesOptions

func (*FirewallRulesV1) NewCreateFirewallRulesOptions(xAuthUserToken string, crn string, zoneIdentifier string) *CreateFirewallRulesOptions

NewCreateFirewallRulesOptions : Instantiate CreateFirewallRulesOptions

func (*FirewallRulesV1) NewDeleteFirewallRuleOptions

func (*FirewallRulesV1) NewDeleteFirewallRuleOptions(xAuthUserToken string, crn string, zoneIdentifier string, firewallRuleIdentifier string) *DeleteFirewallRuleOptions

NewDeleteFirewallRuleOptions : Instantiate DeleteFirewallRuleOptions

func (*FirewallRulesV1) NewDeleteFirewallRulesOptions

func (*FirewallRulesV1) NewDeleteFirewallRulesOptions(xAuthUserToken string, crn string, zoneIdentifier string, id string) *DeleteFirewallRulesOptions

NewDeleteFirewallRulesOptions : Instantiate DeleteFirewallRulesOptions

func (*FirewallRulesV1) NewFirewallRuleInput added in v0.33.0

func (*FirewallRulesV1) NewFirewallRuleInput(filter FirewallRuleInputFilterIntf, action string) (_model *FirewallRuleInput, err error)

NewFirewallRuleInput : Instantiate FirewallRuleInput (Generic Model Constructor)

func (*FirewallRulesV1) NewFirewallRuleInputFilterExpression added in v0.33.0

func (*FirewallRulesV1) NewFirewallRuleInputFilterExpression(expression string) (_model *FirewallRuleInputFilterExpression, err error)

NewFirewallRuleInputFilterExpression : Instantiate FirewallRuleInputFilterExpression (Generic Model Constructor)

func (*FirewallRulesV1) NewFirewallRuleInputFilterID added in v0.33.0

func (*FirewallRulesV1) NewFirewallRuleInputFilterID(id string) (_model *FirewallRuleInputFilterID, err error)

NewFirewallRuleInputFilterID : Instantiate FirewallRuleInputFilterID (Generic Model Constructor)

func (*FirewallRulesV1) NewFirewallRuleUpdateInputFilter

func (*FirewallRulesV1) NewFirewallRuleUpdateInputFilter(id string) (_model *FirewallRuleUpdateInputFilter, err error)

NewFirewallRuleUpdateInputFilter : Instantiate FirewallRuleUpdateInputFilter (Generic Model Constructor)

func (*FirewallRulesV1) NewFirewallRulesUpdateInputItem

func (*FirewallRulesV1) NewFirewallRulesUpdateInputItem(id string, action string) (_model *FirewallRulesUpdateInputItem, err error)

NewFirewallRulesUpdateInputItem : Instantiate FirewallRulesUpdateInputItem (Generic Model Constructor)

func (*FirewallRulesV1) NewFirewallRulesUpdateInputItemFilter

func (*FirewallRulesV1) NewFirewallRulesUpdateInputItemFilter(id string) (_model *FirewallRulesUpdateInputItemFilter, err error)

NewFirewallRulesUpdateInputItemFilter : Instantiate FirewallRulesUpdateInputItemFilter (Generic Model Constructor)

func (*FirewallRulesV1) NewGetFirewallRuleOptions

func (*FirewallRulesV1) NewGetFirewallRuleOptions(xAuthUserToken string, crn string, zoneIdentifier string, firewallRuleIdentifier string) *GetFirewallRuleOptions

NewGetFirewallRuleOptions : Instantiate GetFirewallRuleOptions

func (*FirewallRulesV1) NewListAllFirewallRulesOptions

func (*FirewallRulesV1) NewListAllFirewallRulesOptions(xAuthUserToken string, crn string, zoneIdentifier string) *ListAllFirewallRulesOptions

NewListAllFirewallRulesOptions : Instantiate ListAllFirewallRulesOptions

func (*FirewallRulesV1) NewUpdateFirewallRuleOptions

func (*FirewallRulesV1) NewUpdateFirewallRuleOptions(xAuthUserToken string, crn string, zoneIdentifier string, firewallRuleIdentifier string) *UpdateFirewallRuleOptions

NewUpdateFirewallRuleOptions : Instantiate UpdateFirewallRuleOptions

func (*FirewallRulesV1) NewUpdateFirewllRulesOptions

func (*FirewallRulesV1) NewUpdateFirewllRulesOptions(xAuthUserToken string, crn string, zoneIdentifier string) *UpdateFirewllRulesOptions

NewUpdateFirewllRulesOptions : Instantiate UpdateFirewllRulesOptions

func (*FirewallRulesV1) SetDefaultHeaders

func (firewallRules *FirewallRulesV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*FirewallRulesV1) SetEnableGzipCompression

func (firewallRules *FirewallRulesV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*FirewallRulesV1) SetServiceURL

func (firewallRules *FirewallRulesV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*FirewallRulesV1) UpdateFirewallRule

func (firewallRules *FirewallRulesV1) UpdateFirewallRule(updateFirewallRuleOptions *UpdateFirewallRuleOptions) (result *FirewallRuleResp, response *core.DetailedResponse, err error)

UpdateFirewallRule : Update a firewall rule Update an existing firewall rule for a given zone under a given service instance.

func (*FirewallRulesV1) UpdateFirewallRuleWithContext

func (firewallRules *FirewallRulesV1) UpdateFirewallRuleWithContext(ctx context.Context, updateFirewallRuleOptions *UpdateFirewallRuleOptions) (result *FirewallRuleResp, response *core.DetailedResponse, err error)

UpdateFirewallRuleWithContext is an alternate form of the UpdateFirewallRule method which supports a Context parameter

func (*FirewallRulesV1) UpdateFirewllRules

func (firewallRules *FirewallRulesV1) UpdateFirewllRules(updateFirewllRulesOptions *UpdateFirewllRulesOptions) (result *FirewallRulesResp, response *core.DetailedResponse, err error)

UpdateFirewllRules : Update firewall rules Update existing firewall rules for a given zone under a given service instance.

func (*FirewallRulesV1) UpdateFirewllRulesWithContext

func (firewallRules *FirewallRulesV1) UpdateFirewllRulesWithContext(ctx context.Context, updateFirewllRulesOptions *UpdateFirewllRulesOptions) (result *FirewallRulesResp, response *core.DetailedResponse, err error)

UpdateFirewllRulesWithContext is an alternate form of the UpdateFirewllRules method which supports a Context parameter

type FirewallRulesV1Options

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

FirewallRulesV1Options : Service options

type GetFirewallRuleOptions

type GetFirewallRuleOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `json:"X-Auth-User-Token" validate:"required"`

	// Full crn of the service instance.
	Crn *string `json:"crn" validate:"required,ne="`

	// Zone identifier (zone id).
	ZoneIdentifier *string `json:"zone_identifier" validate:"required,ne="`

	// Identifier of firewall rule for the given zone.
	FirewallRuleIdentifier *string `json:"firewall_rule_identifier" validate:"required,ne="`

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

GetFirewallRuleOptions : The GetFirewallRule options.

func (*GetFirewallRuleOptions) SetCrn

func (_options *GetFirewallRuleOptions) SetCrn(crn string) *GetFirewallRuleOptions

SetCrn : Allow user to set Crn

func (*GetFirewallRuleOptions) SetFirewallRuleIdentifier

func (_options *GetFirewallRuleOptions) SetFirewallRuleIdentifier(firewallRuleIdentifier string) *GetFirewallRuleOptions

SetFirewallRuleIdentifier : Allow user to set FirewallRuleIdentifier

func (*GetFirewallRuleOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetFirewallRuleOptions) SetXAuthUserToken

func (_options *GetFirewallRuleOptions) SetXAuthUserToken(xAuthUserToken string) *GetFirewallRuleOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*GetFirewallRuleOptions) SetZoneIdentifier

func (_options *GetFirewallRuleOptions) SetZoneIdentifier(zoneIdentifier string) *GetFirewallRuleOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type ListAllFirewallRulesOptions

type ListAllFirewallRulesOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `json:"X-Auth-User-Token" validate:"required"`

	// Full url-encoded cloud resource name (CRN) of resource instance.
	Crn *string `json:"crn" validate:"required,ne="`

	// Zone identifier of the zone for which firewall rules are listed.
	ZoneIdentifier *string `json:"zone_identifier" validate:"required,ne="`

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

ListAllFirewallRulesOptions : The ListAllFirewallRules options.

func (*ListAllFirewallRulesOptions) SetCrn

SetCrn : Allow user to set Crn

func (*ListAllFirewallRulesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListAllFirewallRulesOptions) SetXAuthUserToken

func (_options *ListAllFirewallRulesOptions) SetXAuthUserToken(xAuthUserToken string) *ListAllFirewallRulesOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*ListAllFirewallRulesOptions) SetZoneIdentifier

func (_options *ListAllFirewallRulesOptions) SetZoneIdentifier(zoneIdentifier string) *ListAllFirewallRulesOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type ListFirewallRulesResp added in v0.16.0

type ListFirewallRulesResp 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 []FirewallRuleObject `json:"result" validate:"required"`

	// Statistics of results.
	ResultInfo *ListFirewallRulesRespResultInfo `json:"result_info" validate:"required"`
}

ListFirewallRulesResp : ListFirewallRulesResp struct

type ListFirewallRulesRespResultInfo added in v0.16.0

type ListFirewallRulesRespResultInfo 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"`
}

ListFirewallRulesRespResultInfo : Statistics of results.

type UpdateFirewallRuleOptions

type UpdateFirewallRuleOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `json:"X-Auth-User-Token" validate:"required"`

	// Full crn of the service instance.
	Crn *string `json:"crn" validate:"required,ne="`

	// Zone identifier (zone id).
	ZoneIdentifier *string `json:"zone_identifier" validate:"required,ne="`

	// Identifier of firewall rule.
	FirewallRuleIdentifier *string `json:"firewall_rule_identifier" validate:"required,ne="`

	// The firewall action to perform, "log" action is only available for enterprise plan instances.
	Action *string `json:"action,omitempty"`

	// Indicates if the firewall rule is active.
	Paused *bool `json:"paused,omitempty"`

	// The priority of the rule.
	Priority *int64 `json:"priority,omitempty"`

	// To briefly describe the firewall rule, omitted from object if empty.
	Description *string `json:"description,omitempty"`

	// An existing filter.
	Filter *FirewallRuleUpdateInputFilter `json:"filter,omitempty"`

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

UpdateFirewallRuleOptions : The UpdateFirewallRule options.

func (*UpdateFirewallRuleOptions) SetAction

func (_options *UpdateFirewallRuleOptions) SetAction(action string) *UpdateFirewallRuleOptions

SetAction : Allow user to set Action

func (*UpdateFirewallRuleOptions) SetCrn

SetCrn : Allow user to set Crn

func (*UpdateFirewallRuleOptions) SetDescription

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

SetDescription : Allow user to set Description

func (*UpdateFirewallRuleOptions) SetFilter

SetFilter : Allow user to set Filter

func (*UpdateFirewallRuleOptions) SetFirewallRuleIdentifier

func (_options *UpdateFirewallRuleOptions) SetFirewallRuleIdentifier(firewallRuleIdentifier string) *UpdateFirewallRuleOptions

SetFirewallRuleIdentifier : Allow user to set FirewallRuleIdentifier

func (*UpdateFirewallRuleOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateFirewallRuleOptions) SetPaused

func (_options *UpdateFirewallRuleOptions) SetPaused(paused bool) *UpdateFirewallRuleOptions

SetPaused : Allow user to set Paused

func (*UpdateFirewallRuleOptions) SetPriority added in v0.33.0

func (_options *UpdateFirewallRuleOptions) SetPriority(priority int64) *UpdateFirewallRuleOptions

SetPriority : Allow user to set Priority

func (*UpdateFirewallRuleOptions) SetXAuthUserToken

func (_options *UpdateFirewallRuleOptions) SetXAuthUserToken(xAuthUserToken string) *UpdateFirewallRuleOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*UpdateFirewallRuleOptions) SetZoneIdentifier

func (_options *UpdateFirewallRuleOptions) SetZoneIdentifier(zoneIdentifier string) *UpdateFirewallRuleOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type UpdateFirewllRulesOptions

type UpdateFirewllRulesOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `json:"X-Auth-User-Token" validate:"required"`

	// Full crn of the service instance.
	Crn *string `json:"crn" validate:"required,ne="`

	// Zone identifier (zone id).
	ZoneIdentifier *string `json:"zone_identifier" validate:"required,ne="`

	FirewallRulesUpdateInputItem []FirewallRulesUpdateInputItem `json:"FirewallRulesUpdateInputItem,omitempty"`

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

UpdateFirewllRulesOptions : The UpdateFirewllRules options.

func (*UpdateFirewllRulesOptions) SetCrn

SetCrn : Allow user to set Crn

func (*UpdateFirewllRulesOptions) SetFirewallRulesUpdateInputItem

func (_options *UpdateFirewllRulesOptions) SetFirewallRulesUpdateInputItem(firewallRulesUpdateInputItem []FirewallRulesUpdateInputItem) *UpdateFirewllRulesOptions

SetFirewallRulesUpdateInputItem : Allow user to set FirewallRulesUpdateInputItem

func (*UpdateFirewllRulesOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateFirewllRulesOptions) SetXAuthUserToken

func (_options *UpdateFirewllRulesOptions) SetXAuthUserToken(xAuthUserToken string) *UpdateFirewllRulesOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*UpdateFirewllRulesOptions) SetZoneIdentifier

func (_options *UpdateFirewllRulesOptions) SetZoneIdentifier(zoneIdentifier string) *UpdateFirewllRulesOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

Jump to

Keyboard shortcuts

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