contextbasedrestrictionsv1

package
v0.63.0 Latest Latest
Warning

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

 Go to latest Published: May 22, 2024 License: Apache-2.0 Imports: 9 Imported by: 4

Documentation

Overview

Package contextbasedrestrictionsv1 : Operations and models for the ContextBasedRestrictionsV1 service

Index

Constants

View Source 
const (
	AddressTypeIpaddressConst  = "ipAddress"
	AddressTypeIprangeConst    = "ipRange"
	AddressTypeServicerefConst = "serviceRef"
	AddressTypeSubnetConst     = "subnet"
	AddressTypeVPCConst        = "vpc"
)

Constants associated with the Address.Type property. The type of address.

View Source 
const (
	CreateRuleOptionsEnforcementModeDisabledConst = "disabled"
	CreateRuleOptionsEnforcementModeEnabledConst  = "enabled"
	CreateRuleOptionsEnforcementModeReportConst   = "report"
)

Constants associated with the CreateRuleOptions.EnforcementMode property. The rule enforcement mode:

  • `enabled` - The restrictions are enforced and reported. This is the default.
  • `disabled` - The restrictions are disabled. Nothing is enforced or reported.
  • `report` - The restrictions are evaluated and reported, but not enforced.
View Source 
const (
	ListAvailableServicerefTargetsOptionsTypeAllConst             = "all"
	ListAvailableServicerefTargetsOptionsTypePlatformServiceConst = "platform_service"
)

Constants associated with the ListAvailableServicerefTargetsOptions.Type property. Specifies the types of services to retrieve.

View Source 
const (
	ListRulesOptionsEnforcementModeDisabledConst = "disabled"
	ListRulesOptionsEnforcementModeEnabledConst  = "enabled"
	ListRulesOptionsEnforcementModeReportConst   = "report"
)

Constants associated with the ListRulesOptions.EnforcementMode property. The rule's `enforcement_mode` attribute.

View Source 
const (
	ReplaceRuleOptionsEnforcementModeDisabledConst = "disabled"
	ReplaceRuleOptionsEnforcementModeEnabledConst  = "enabled"
	ReplaceRuleOptionsEnforcementModeReportConst   = "report"
)

Constants associated with the ReplaceRuleOptions.EnforcementMode property. The rule enforcement mode:

  • `enabled` - The restrictions are enforced and reported. This is the default.
  • `disabled` - The restrictions are disabled. Nothing is enforced or reported.
  • `report` - The restrictions are evaluated and reported, but not enforced.
View Source 
const (
	RuleEnforcementModeDisabledConst = "disabled"
	RuleEnforcementModeEnabledConst  = "enabled"
	RuleEnforcementModeReportConst   = "report"
)

Constants associated with the Rule.EnforcementMode property. The rule enforcement mode:

  • `enabled` - The restrictions are enforced and reported. This is the default.
  • `disabled` - The restrictions are disabled. Nothing is enforced or reported.
  • `report` - The restrictions are evaluated and reported, but not enforced.
View Source 
const (
	AddressIPAddressRangeTypeIprangeConst = "ipRange"
)

Constants associated with the AddressIPAddressRange.Type property. The type of address.

View Source 
const (
	AddressIPAddressTypeIpaddressConst = "ipAddress"
)

Constants associated with the AddressIPAddress.Type property. The type of address.

View Source 
const (
	AddressServiceRefTypeServicerefConst = "serviceRef"
)

Constants associated with the AddressServiceRef.Type property. The type of address.

View Source 
const (
	AddressSubnetTypeSubnetConst = "subnet"
)

Constants associated with the AddressSubnet.Type property. The type of address.

View Source 
const (
	AddressVPCTypeVPCConst = "vpc"
)

Constants associated with the AddressVPC.Type property. The type of address.

View Source 
const DefaultServiceName = "context_based_restrictions"

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

View Source 
const DefaultServiceURL = "https://cbr.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 UnmarshalAPIType added in v0.28.0 

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

UnmarshalAPIType unmarshals an instance of APIType from the specified map of raw messages.

func UnmarshalAccountSettings 

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

UnmarshalAccountSettings unmarshals an instance of AccountSettings from the specified map of raw messages.

func UnmarshalAction added in v0.28.0 

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

UnmarshalAction unmarshals an instance of Action from the specified map of raw messages.

func UnmarshalAddress 

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

UnmarshalAddress unmarshals an instance of Address from the specified map of raw messages.

func UnmarshalAddressIPAddress 

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

UnmarshalAddressIPAddress unmarshals an instance of AddressIPAddress from the specified map of raw messages.

func UnmarshalAddressIPAddressRange 

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

UnmarshalAddressIPAddressRange unmarshals an instance of AddressIPAddressRange from the specified map of raw messages.

func UnmarshalAddressServiceRef 

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

UnmarshalAddressServiceRef unmarshals an instance of AddressServiceRef from the specified map of raw messages.

func UnmarshalAddressSubnet 

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

UnmarshalAddressSubnet unmarshals an instance of AddressSubnet from the specified map of raw messages.

func UnmarshalAddressVPC 

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

UnmarshalAddressVPC unmarshals an instance of AddressVPC from the specified map of raw messages.

func UnmarshalNewRuleOperations added in v0.28.0 

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

UnmarshalNewRuleOperations unmarshals an instance of NewRuleOperations from the specified map of raw messages.

func UnmarshalNewRuleOperationsAPITypesItem added in v0.28.0 

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

UnmarshalNewRuleOperationsAPITypesItem unmarshals an instance of NewRuleOperationsAPITypesItem from the specified map of raw messages.

func UnmarshalOperationsList added in v0.28.0 

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

UnmarshalOperationsList unmarshals an instance of OperationsList from the specified map of raw messages.

func UnmarshalResource 

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

UnmarshalResource unmarshals an instance of Resource from the specified map of raw messages.

func UnmarshalResourceAttribute 

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

UnmarshalResourceAttribute unmarshals an instance of ResourceAttribute from the specified map of raw messages.

func UnmarshalResourceTagAttribute 

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

UnmarshalResourceTagAttribute unmarshals an instance of ResourceTagAttribute 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 UnmarshalRuleContext 

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

UnmarshalRuleContext unmarshals an instance of RuleContext from the specified map of raw messages.

func UnmarshalRuleContextAttribute 

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

UnmarshalRuleContextAttribute unmarshals an instance of RuleContextAttribute 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 UnmarshalServiceRefTarget 

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

UnmarshalServiceRefTarget unmarshals an instance of ServiceRefTarget from the specified map of raw messages.

func UnmarshalServiceRefTargetList 

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

UnmarshalServiceRefTargetList unmarshals an instance of ServiceRefTargetList from the specified map of raw messages.

func UnmarshalServiceRefTargetLocationsItem added in v0.28.0 

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

UnmarshalServiceRefTargetLocationsItem unmarshals an instance of ServiceRefTargetLocationsItem from the specified map of raw messages.

func UnmarshalServiceRefValue 

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

UnmarshalServiceRefValue unmarshals an instance of ServiceRefValue from the specified map of raw messages.

func UnmarshalZone 

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

UnmarshalZone unmarshals an instance of Zone from the specified map of raw messages.

func UnmarshalZoneList 

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

UnmarshalZoneList unmarshals an instance of ZoneList from the specified map of raw messages.

func UnmarshalZoneSummary 

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

UnmarshalZoneSummary unmarshals an instance of ZoneSummary from the specified map of raw messages.

Types

type APIType added in v0.28.0 

type APIType struct {
	// The id of the API type.
	APITypeID *string `json:"api_type_id" validate:"required"`

	// The displayed name of the API type.
	DisplayName *string `json:"display_name" validate:"required"`

	// The description of the API type.
	Description *string `json:"description" validate:"required"`

	// The type of the API type.
	Type *string `json:"type" validate:"required"`

	// The actions available for the API type.
	Actions []Action `json:"actions" validate:"required"`

	// The enforcement modes supported by the API type.
	EnforcementModes []string `json:"enforcement_modes,omitempty"`
}

APIType : Service API Type details.

type AccountSettings 

type AccountSettings struct {
	// The globally unique ID of the account settings.
	ID *string `json:"id" validate:"required"`

	// The account settings CRN.
	CRN *string `json:"crn" validate:"required"`

	// the max number of rules allowed for the account.
	RuleCountLimit *int64 `json:"rule_count_limit" validate:"required"`

	// the max number of zones allowed for the account.
	ZoneCountLimit *int64 `json:"zone_count_limit" validate:"required"`

	// the max number of rules with tags allowed for the account.
	TagsRuleCountLimit *int64 `json:"tags_rule_count_limit,omitempty"`

	// the current number of rules used by the account.
	CurrentRuleCount *int64 `json:"current_rule_count" validate:"required"`

	// the current number of zones used by the account.
	CurrentZoneCount *int64 `json:"current_zone_count" validate:"required"`

	// the current number of rules with tags used by the account.
	CurrentTagsRuleCount *int64 `json:"current_tags_rule_count,omitempty"`

	// The href link to the resource.
	Href *string `json:"href" validate:"required"`

	// The time the resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// IAM ID of the user or service which created the resource.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The last time the resource was modified.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// IAM ID of the user or service which modified the resource.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

AccountSettings : An output account settings.

type Action added in v0.28.0 

type Action struct {
	// The id of the action.
	ActionID *string `json:"action_id" validate:"required"`

	// The description of the action.
	Description *string `json:"description" validate:"required"`
}

Action : Service API Type actions.

type Address 

type Address struct {
	// The type of address.
	Type *string `json:"type,omitempty"`

	// The IP address.
	Value *string `json:"value,omitempty"`

	// A service reference value.
	Ref *ServiceRefValue `json:"ref,omitempty"`
}

Address : A zone address. Models which "extend" this model: - AddressIPAddress - AddressIPAddressRange - AddressSubnet - AddressVPC - AddressServiceRef

type AddressIPAddress 

type AddressIPAddress struct {
	// The type of address.
	Type *string `json:"type" validate:"required"`

	// The IP address.
	Value *string `json:"value" validate:"required"`
}

AddressIPAddress : A single IP address. IPv4 and IPv6 are supported. This model "extends" Address

type AddressIPAddressRange 

type AddressIPAddressRange struct {
	// The type of address.
	Type *string `json:"type" validate:"required"`

	// The ip range in <first-ip>-<last-ip> format.
	Value *string `json:"value" validate:"required"`
}

AddressIPAddressRange : An IP address range. IPv4 and IPv6 are supported. This model "extends" Address

type AddressIntf 

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

type AddressServiceRef 

type AddressServiceRef struct {
	// The type of address.
	Type *string `json:"type" validate:"required"`

	// A service reference value.
	Ref *ServiceRefValue `json:"ref" validate:"required"`
}

AddressServiceRef : A service reference. This model "extends" Address

type AddressSubnet 

type AddressSubnet struct {
	// The type of address.
	Type *string `json:"type" validate:"required"`

	// The subnet in CIDR format.
	Value *string `json:"value" validate:"required"`
}

AddressSubnet : A subnet in CIDR format. This model "extends" Address

type AddressVPC 

type AddressVPC struct {
	// The type of address.
	Type *string `json:"type" validate:"required"`

	// The VPC CRN.
	Value *string `json:"value" validate:"required"`
}

AddressVPC : A single VPC address. This model "extends" Address

type ContextBasedRestrictionsV1 

type ContextBasedRestrictionsV1 struct {
	Service *core.BaseService
}

ContextBasedRestrictionsV1 : With the Context Based Restrictions API, you can: * Create, list, get, replace, and delete network zones * Create, list, get, replace, and delete context-based restriction rules * Get account settings

API Version: 1.0.1

func NewContextBasedRestrictionsV1 

func NewContextBasedRestrictionsV1(options *ContextBasedRestrictionsV1Options) (service *ContextBasedRestrictionsV1, err error)

NewContextBasedRestrictionsV1 : constructs an instance of ContextBasedRestrictionsV1 with passed in options.

func NewContextBasedRestrictionsV1UsingExternalConfig 

func NewContextBasedRestrictionsV1UsingExternalConfig(options *ContextBasedRestrictionsV1Options) (contextBasedRestrictions *ContextBasedRestrictionsV1, err error)

NewContextBasedRestrictionsV1UsingExternalConfig : constructs an instance of ContextBasedRestrictionsV1 with passed in options and external configuration.

func (*ContextBasedRestrictionsV1) Clone 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) Clone() *ContextBasedRestrictionsV1

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

func (*ContextBasedRestrictionsV1) CreateRule 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) CreateRule(createRuleOptions *CreateRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

CreateRule : Create a rule This operation creates a rule for the specified account.

func (*ContextBasedRestrictionsV1) CreateRuleWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) CreateRuleWithContext(ctx context.Context, createRuleOptions *CreateRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

CreateRuleWithContext is an alternate form of the CreateRule method which supports a Context parameter

func (*ContextBasedRestrictionsV1) CreateZone 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) CreateZone(createZoneOptions *CreateZoneOptions) (result *Zone, response *core.DetailedResponse, err error)

CreateZone : Create a network zone This operation creates a network zone for the specified account.

func (*ContextBasedRestrictionsV1) CreateZoneWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) CreateZoneWithContext(ctx context.Context, createZoneOptions *CreateZoneOptions) (result *Zone, response *core.DetailedResponse, err error)

CreateZoneWithContext is an alternate form of the CreateZone method which supports a Context parameter

func (*ContextBasedRestrictionsV1) DeleteRule 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) DeleteRule(deleteRuleOptions *DeleteRuleOptions) (response *core.DetailedResponse, err error)

DeleteRule : Delete a rule This operation deletes the rule identified by the specified rule ID.

func (*ContextBasedRestrictionsV1) DeleteRuleWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) 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 (*ContextBasedRestrictionsV1) DeleteZone 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) DeleteZone(deleteZoneOptions *DeleteZoneOptions) (response *core.DetailedResponse, err error)

DeleteZone : Delete a network zone This operation deletes the network zone identified by the specified zone ID.

func (*ContextBasedRestrictionsV1) DeleteZoneWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) DeleteZoneWithContext(ctx context.Context, deleteZoneOptions *DeleteZoneOptions) (response *core.DetailedResponse, err error)

DeleteZoneWithContext is an alternate form of the DeleteZone method which supports a Context parameter

func (*ContextBasedRestrictionsV1) DisableRetries 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) DisableRetries()

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

func (*ContextBasedRestrictionsV1) EnableRetries 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) 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 (*ContextBasedRestrictionsV1) GetAccountSettings 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) GetAccountSettings(getAccountSettingsOptions *GetAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

GetAccountSettings : Get account settings This operation retrieves the settings for the specified account ID.

func (*ContextBasedRestrictionsV1) GetAccountSettingsWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) GetAccountSettingsWithContext(ctx context.Context, getAccountSettingsOptions *GetAccountSettingsOptions) (result *AccountSettings, response *core.DetailedResponse, err error)

GetAccountSettingsWithContext is an alternate form of the GetAccountSettings method which supports a Context parameter

func (*ContextBasedRestrictionsV1) GetEnableGzipCompression 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*ContextBasedRestrictionsV1) GetRule 

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

GetRule : Get a rule This operation retrieves the rule identified by the specified rule ID.

func (*ContextBasedRestrictionsV1) GetRuleWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) 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 (*ContextBasedRestrictionsV1) GetServiceURL 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*ContextBasedRestrictionsV1) GetServicerefTarget added in v0.60.0 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) GetServicerefTarget(getServicerefTargetOptions *GetServicerefTargetOptions) (result *ServiceRefTarget, response *core.DetailedResponse, err error)

GetServicerefTarget : Get service reference target for a specified service name This operation gets the service reference target for a specified service name.

func (*ContextBasedRestrictionsV1) GetServicerefTargetWithContext added in v0.60.0 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) GetServicerefTargetWithContext(ctx context.Context, getServicerefTargetOptions *GetServicerefTargetOptions) (result *ServiceRefTarget, response *core.DetailedResponse, err error)

GetServicerefTargetWithContext is an alternate form of the GetServicerefTarget method which supports a Context parameter

func (*ContextBasedRestrictionsV1) GetZone 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) GetZone(getZoneOptions *GetZoneOptions) (result *Zone, response *core.DetailedResponse, err error)

GetZone : Get a network zone This operation retrieves the network zone identified by the specified zone ID.

func (*ContextBasedRestrictionsV1) GetZoneWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) GetZoneWithContext(ctx context.Context, getZoneOptions *GetZoneOptions) (result *Zone, response *core.DetailedResponse, err error)

GetZoneWithContext is an alternate form of the GetZone method which supports a Context parameter

func (*ContextBasedRestrictionsV1) ListAvailableServiceOperations added in v0.28.0 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ListAvailableServiceOperations(listAvailableServiceOperationsOptions *ListAvailableServiceOperationsOptions) (result *OperationsList, response *core.DetailedResponse, err error)

ListAvailableServiceOperations : List available service operations This operation lists all available service operations.

func (*ContextBasedRestrictionsV1) ListAvailableServiceOperationsWithContext added in v0.28.0 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ListAvailableServiceOperationsWithContext(ctx context.Context, listAvailableServiceOperationsOptions *ListAvailableServiceOperationsOptions) (result *OperationsList, response *core.DetailedResponse, err error)

ListAvailableServiceOperationsWithContext is an alternate form of the ListAvailableServiceOperations method which supports a Context parameter

func (*ContextBasedRestrictionsV1) ListAvailableServicerefTargets 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ListAvailableServicerefTargets(listAvailableServicerefTargetsOptions *ListAvailableServicerefTargetsOptions) (result *ServiceRefTargetList, response *core.DetailedResponse, err error)

ListAvailableServicerefTargets : List available service reference targets This operation lists all available service reference targets.

func (*ContextBasedRestrictionsV1) ListAvailableServicerefTargetsWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ListAvailableServicerefTargetsWithContext(ctx context.Context, listAvailableServicerefTargetsOptions *ListAvailableServicerefTargetsOptions) (result *ServiceRefTargetList, response *core.DetailedResponse, err error)

ListAvailableServicerefTargetsWithContext is an alternate form of the ListAvailableServicerefTargets method which supports a Context parameter

func (*ContextBasedRestrictionsV1) ListRules 

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

ListRules : List rules This operation lists rules in the specified account.

func (*ContextBasedRestrictionsV1) ListRulesWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) 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 (*ContextBasedRestrictionsV1) ListZones 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ListZones(listZonesOptions *ListZonesOptions) (result *ZoneList, response *core.DetailedResponse, err error)

ListZones : List network zones This operation lists network zones in the specified account.

func (*ContextBasedRestrictionsV1) ListZonesWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ListZonesWithContext(ctx context.Context, listZonesOptions *ListZonesOptions) (result *ZoneList, response *core.DetailedResponse, err error)

ListZonesWithContext is an alternate form of the ListZones method which supports a Context parameter

func (*ContextBasedRestrictionsV1) NewAddressIPAddress 

func (*ContextBasedRestrictionsV1) NewAddressIPAddress(typeVar string, value string) (_model *AddressIPAddress, err error)

NewAddressIPAddress : Instantiate AddressIPAddress (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewAddressIPAddressRange 

func (*ContextBasedRestrictionsV1) NewAddressIPAddressRange(typeVar string, value string) (_model *AddressIPAddressRange, err error)

NewAddressIPAddressRange : Instantiate AddressIPAddressRange (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewAddressServiceRef 

func (*ContextBasedRestrictionsV1) NewAddressServiceRef(typeVar string, ref *ServiceRefValue) (_model *AddressServiceRef, err error)

NewAddressServiceRef : Instantiate AddressServiceRef (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewAddressSubnet 

func (*ContextBasedRestrictionsV1) NewAddressSubnet(typeVar string, value string) (_model *AddressSubnet, err error)

NewAddressSubnet : Instantiate AddressSubnet (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewAddressVPC 

func (*ContextBasedRestrictionsV1) NewAddressVPC(typeVar string, value string) (_model *AddressVPC, err error)

NewAddressVPC : Instantiate AddressVPC (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewCreateRuleOptions 

func (*ContextBasedRestrictionsV1) NewCreateRuleOptions() *CreateRuleOptions

NewCreateRuleOptions : Instantiate CreateRuleOptions

func (*ContextBasedRestrictionsV1) NewCreateZoneOptions 

func (*ContextBasedRestrictionsV1) NewCreateZoneOptions() *CreateZoneOptions

NewCreateZoneOptions : Instantiate CreateZoneOptions

func (*ContextBasedRestrictionsV1) NewDeleteRuleOptions 

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

NewDeleteRuleOptions : Instantiate DeleteRuleOptions

func (*ContextBasedRestrictionsV1) NewDeleteZoneOptions 

func (*ContextBasedRestrictionsV1) NewDeleteZoneOptions(zoneID string) *DeleteZoneOptions

NewDeleteZoneOptions : Instantiate DeleteZoneOptions

func (*ContextBasedRestrictionsV1) NewGetAccountSettingsOptions 

func (*ContextBasedRestrictionsV1) NewGetAccountSettingsOptions(accountID string) *GetAccountSettingsOptions

NewGetAccountSettingsOptions : Instantiate GetAccountSettingsOptions

func (*ContextBasedRestrictionsV1) NewGetRuleOptions 

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

NewGetRuleOptions : Instantiate GetRuleOptions

func (*ContextBasedRestrictionsV1) NewGetServicerefTargetOptions added in v0.60.0 

func (*ContextBasedRestrictionsV1) NewGetServicerefTargetOptions(serviceName string) *GetServicerefTargetOptions

NewGetServicerefTargetOptions : Instantiate GetServicerefTargetOptions

func (*ContextBasedRestrictionsV1) NewGetZoneOptions 

func (*ContextBasedRestrictionsV1) NewGetZoneOptions(zoneID string) *GetZoneOptions

NewGetZoneOptions : Instantiate GetZoneOptions

func (*ContextBasedRestrictionsV1) NewListAvailableServiceOperationsOptions added in v0.28.0 

func (*ContextBasedRestrictionsV1) NewListAvailableServiceOperationsOptions() *ListAvailableServiceOperationsOptions

NewListAvailableServiceOperationsOptions : Instantiate ListAvailableServiceOperationsOptions

func (*ContextBasedRestrictionsV1) NewListAvailableServicerefTargetsOptions 

func (*ContextBasedRestrictionsV1) NewListAvailableServicerefTargetsOptions() *ListAvailableServicerefTargetsOptions

NewListAvailableServicerefTargetsOptions : Instantiate ListAvailableServicerefTargetsOptions

func (*ContextBasedRestrictionsV1) NewListRulesOptions 

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

NewListRulesOptions : Instantiate ListRulesOptions

func (*ContextBasedRestrictionsV1) NewListZonesOptions 

func (*ContextBasedRestrictionsV1) NewListZonesOptions(accountID string) *ListZonesOptions

NewListZonesOptions : Instantiate ListZonesOptions

func (*ContextBasedRestrictionsV1) NewNewRuleOperations added in v0.28.0 

func (*ContextBasedRestrictionsV1) NewNewRuleOperations(apiTypes []NewRuleOperationsAPITypesItem) (_model *NewRuleOperations, err error)

NewNewRuleOperations : Instantiate NewRuleOperations (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewNewRuleOperationsAPITypesItem added in v0.28.0 

func (*ContextBasedRestrictionsV1) NewNewRuleOperationsAPITypesItem(apiTypeID string) (_model *NewRuleOperationsAPITypesItem, err error)

NewNewRuleOperationsAPITypesItem : Instantiate NewRuleOperationsAPITypesItem (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewReplaceRuleOptions 

func (*ContextBasedRestrictionsV1) NewReplaceRuleOptions(ruleID string, ifMatch string) *ReplaceRuleOptions

NewReplaceRuleOptions : Instantiate ReplaceRuleOptions

func (*ContextBasedRestrictionsV1) NewReplaceZoneOptions 

func (*ContextBasedRestrictionsV1) NewReplaceZoneOptions(zoneID string, ifMatch string) *ReplaceZoneOptions

NewReplaceZoneOptions : Instantiate ReplaceZoneOptions

func (*ContextBasedRestrictionsV1) NewResource 

func (*ContextBasedRestrictionsV1) NewResource(attributes []ResourceAttribute) (_model *Resource, err error)

NewResource : Instantiate Resource (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewResourceAttribute 

func (*ContextBasedRestrictionsV1) NewResourceAttribute(name string, value string) (_model *ResourceAttribute, err error)

NewResourceAttribute : Instantiate ResourceAttribute (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewResourceTagAttribute 

func (*ContextBasedRestrictionsV1) NewResourceTagAttribute(name string, value string) (_model *ResourceTagAttribute, err error)

NewResourceTagAttribute : Instantiate ResourceTagAttribute (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewRuleContext 

func (*ContextBasedRestrictionsV1) NewRuleContext(attributes []RuleContextAttribute) (_model *RuleContext, err error)

NewRuleContext : Instantiate RuleContext (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewRuleContextAttribute 

func (*ContextBasedRestrictionsV1) NewRuleContextAttribute(name string, value string) (_model *RuleContextAttribute, err error)

NewRuleContextAttribute : Instantiate RuleContextAttribute (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) NewServiceRefValue 

func (*ContextBasedRestrictionsV1) NewServiceRefValue(accountID string) (_model *ServiceRefValue, err error)

NewServiceRefValue : Instantiate ServiceRefValue (Generic Model Constructor)

func (*ContextBasedRestrictionsV1) ReplaceRule 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ReplaceRule(replaceRuleOptions *ReplaceRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

ReplaceRule : Replace a rule This operation replaces the rule identified by the specified rule ID. Partial updates are not supported. The entire rule object must be replaced.

func (*ContextBasedRestrictionsV1) ReplaceRuleWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ReplaceRuleWithContext(ctx context.Context, replaceRuleOptions *ReplaceRuleOptions) (result *Rule, response *core.DetailedResponse, err error)

ReplaceRuleWithContext is an alternate form of the ReplaceRule method which supports a Context parameter

func (*ContextBasedRestrictionsV1) ReplaceZone 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ReplaceZone(replaceZoneOptions *ReplaceZoneOptions) (result *Zone, response *core.DetailedResponse, err error)

ReplaceZone : Replace a network zone This operation replaces the network zone identified by the specified zone ID. Partial updates are not supported. The entire network zone object must be replaced.

func (*ContextBasedRestrictionsV1) ReplaceZoneWithContext 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) ReplaceZoneWithContext(ctx context.Context, replaceZoneOptions *ReplaceZoneOptions) (result *Zone, response *core.DetailedResponse, err error)

ReplaceZoneWithContext is an alternate form of the ReplaceZone method which supports a Context parameter

func (*ContextBasedRestrictionsV1) SetDefaultHeaders 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*ContextBasedRestrictionsV1) SetEnableGzipCompression 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*ContextBasedRestrictionsV1) SetServiceURL 

func (contextBasedRestrictions *ContextBasedRestrictionsV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

type ContextBasedRestrictionsV1Options added in v0.26.0 

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

ContextBasedRestrictionsV1Options : Service options

type CreateRuleOptions 

type CreateRuleOptions struct {
	// The description of the rule.
	Description *string `json:"description,omitempty"`

	// The contexts this rule applies to.
	Contexts []RuleContext `json:"contexts,omitempty"`

	// The resources this rule apply to.
	Resources []Resource `json:"resources,omitempty"`

	// The operations this rule applies to.
	Operations *NewRuleOperations `json:"operations,omitempty"`

	// The rule enforcement mode:
	//  * `enabled` - The restrictions are enforced and reported. This is the default.
	//  * `disabled` - The restrictions are disabled. Nothing is enforced or reported.
	//  * `report` - The restrictions are evaluated and reported, but not enforced.
	EnforcementMode *string `json:"enforcement_mode,omitempty"`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

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

CreateRuleOptions : The CreateRule options.

func (*CreateRuleOptions) SetContexts 

func (_options *CreateRuleOptions) SetContexts(contexts []RuleContext) *CreateRuleOptions

SetContexts : Allow user to set Contexts

func (*CreateRuleOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*CreateRuleOptions) SetEnforcementMode added in v0.26.0 

func (_options *CreateRuleOptions) SetEnforcementMode(enforcementMode string) *CreateRuleOptions

SetEnforcementMode : Allow user to set EnforcementMode

func (*CreateRuleOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateRuleOptions) SetOperations added in v0.28.0 

func (_options *CreateRuleOptions) SetOperations(operations *NewRuleOperations) *CreateRuleOptions

SetOperations : Allow user to set Operations

func (*CreateRuleOptions) SetResources 

func (_options *CreateRuleOptions) SetResources(resources []Resource) *CreateRuleOptions

SetResources : Allow user to set Resources

func (*CreateRuleOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*CreateRuleOptions) SetXCorrelationID added in v0.22.3 

func (_options *CreateRuleOptions) SetXCorrelationID(xCorrelationID string) *CreateRuleOptions

SetXCorrelationID : Allow user to set XCorrelationID

type CreateZoneOptions 

type CreateZoneOptions struct {
	// The name of the zone.
	Name *string `json:"name,omitempty"`

	// The id of the account owning this zone.
	AccountID *string `json:"account_id,omitempty"`

	// The description of the zone.
	Description *string `json:"description,omitempty"`

	// The list of addresses in the zone.
	Addresses []AddressIntf `json:"addresses,omitempty"`

	// The list of excluded addresses in the zone. Only addresses of type `ipAddress`, `ipRange`, and `subnet` can be
	// excluded.
	Excluded []AddressIntf `json:"excluded,omitempty"`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

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

CreateZoneOptions : The CreateZone options.

func (*CreateZoneOptions) SetAccountID 

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

SetAccountID : Allow user to set AccountID

func (*CreateZoneOptions) SetAddresses 

func (_options *CreateZoneOptions) SetAddresses(addresses []AddressIntf) *CreateZoneOptions

SetAddresses : Allow user to set Addresses

func (*CreateZoneOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*CreateZoneOptions) SetExcluded 

func (_options *CreateZoneOptions) SetExcluded(excluded []AddressIntf) *CreateZoneOptions

SetExcluded : Allow user to set Excluded

func (*CreateZoneOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*CreateZoneOptions) SetName 

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

SetName : Allow user to set Name

func (*CreateZoneOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*CreateZoneOptions) SetXCorrelationID added in v0.22.3 

func (_options *CreateZoneOptions) SetXCorrelationID(xCorrelationID string) *CreateZoneOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DeleteRuleOptions 

type DeleteRuleOptions struct {
	// The ID of a rule.
	RuleID *string `json:"rule_id" validate:"required,ne="`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// 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 Deprecated: this method is deprecated and may be removed in a future release.

func (*DeleteRuleOptions) SetXCorrelationID added in v0.22.3 

func (_options *DeleteRuleOptions) SetXCorrelationID(xCorrelationID string) *DeleteRuleOptions

SetXCorrelationID : Allow user to set XCorrelationID

type DeleteZoneOptions 

type DeleteZoneOptions struct {
	// The ID of a zone.
	ZoneID *string `json:"zone_id" validate:"required,ne="`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

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

DeleteZoneOptions : The DeleteZone options.

func (*DeleteZoneOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*DeleteZoneOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*DeleteZoneOptions) SetXCorrelationID added in v0.22.3 

func (_options *DeleteZoneOptions) SetXCorrelationID(xCorrelationID string) *DeleteZoneOptions

SetXCorrelationID : Allow user to set XCorrelationID

func (*DeleteZoneOptions) SetZoneID 

func (_options *DeleteZoneOptions) SetZoneID(zoneID string) *DeleteZoneOptions

SetZoneID : Allow user to set ZoneID

type GetAccountSettingsOptions 

type GetAccountSettingsOptions struct {
	// The ID of the account the settings are for.
	AccountID *string `json:"account_id" validate:"required,ne="`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

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

GetAccountSettingsOptions : The GetAccountSettings options.

func (*GetAccountSettingsOptions) SetAccountID 

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

SetAccountID : Allow user to set AccountID

func (*GetAccountSettingsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetAccountSettingsOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*GetAccountSettingsOptions) SetXCorrelationID added in v0.22.3 

func (_options *GetAccountSettingsOptions) SetXCorrelationID(xCorrelationID string) *GetAccountSettingsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetRuleOptions 

type GetRuleOptions struct {
	// The ID of a rule.
	RuleID *string `json:"rule_id" validate:"required,ne="`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// 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 Deprecated: this method is deprecated and may be removed in a future release.

func (*GetRuleOptions) SetXCorrelationID added in v0.22.3 

func (_options *GetRuleOptions) SetXCorrelationID(xCorrelationID string) *GetRuleOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetServicerefTargetOptions added in v0.60.0 

type GetServicerefTargetOptions struct {
	// The name of a service.
	ServiceName *string `json:"service_name" validate:"required,ne="`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

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

GetServicerefTargetOptions : The GetServicerefTarget options.

func (*GetServicerefTargetOptions) SetHeaders added in v0.60.0 

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

SetHeaders : Allow user to set Headers

func (*GetServicerefTargetOptions) SetServiceName added in v0.60.0 

func (_options *GetServicerefTargetOptions) SetServiceName(serviceName string) *GetServicerefTargetOptions

SetServiceName : Allow user to set ServiceName

func (*GetServicerefTargetOptions) SetTransactionID added in v0.60.0 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*GetServicerefTargetOptions) SetXCorrelationID added in v0.60.0 

func (_options *GetServicerefTargetOptions) SetXCorrelationID(xCorrelationID string) *GetServicerefTargetOptions

SetXCorrelationID : Allow user to set XCorrelationID

type GetZoneOptions 

type GetZoneOptions struct {
	// The ID of a zone.
	ZoneID *string `json:"zone_id" validate:"required,ne="`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

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

GetZoneOptions : The GetZone options.

func (*GetZoneOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*GetZoneOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*GetZoneOptions) SetXCorrelationID added in v0.22.3 

func (_options *GetZoneOptions) SetXCorrelationID(xCorrelationID string) *GetZoneOptions

SetXCorrelationID : Allow user to set XCorrelationID

func (*GetZoneOptions) SetZoneID 

func (_options *GetZoneOptions) SetZoneID(zoneID string) *GetZoneOptions

SetZoneID : Allow user to set ZoneID

type ListAvailableServiceOperationsOptions added in v0.28.0 

type ListAvailableServiceOperationsOptions struct {
	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// The name of the service.
	ServiceName *string `json:"service_name,omitempty"`

	// The id of the service group.
	ServiceGroupID *string `json:"service_group_id,omitempty"`

	// The type of resource.
	ResourceType *string `json:"resource_type,omitempty"`

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

ListAvailableServiceOperationsOptions : The ListAvailableServiceOperations options.

func (*ListAvailableServiceOperationsOptions) SetHeaders added in v0.28.0 

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

SetHeaders : Allow user to set Headers

func (*ListAvailableServiceOperationsOptions) SetResourceType added in v0.49.0 

func (_options *ListAvailableServiceOperationsOptions) SetResourceType(resourceType string) *ListAvailableServiceOperationsOptions

SetResourceType : Allow user to set ResourceType

func (*ListAvailableServiceOperationsOptions) SetServiceGroupID added in v0.49.0 

func (_options *ListAvailableServiceOperationsOptions) SetServiceGroupID(serviceGroupID string) *ListAvailableServiceOperationsOptions

SetServiceGroupID : Allow user to set ServiceGroupID

func (*ListAvailableServiceOperationsOptions) SetServiceName added in v0.28.0 

func (_options *ListAvailableServiceOperationsOptions) SetServiceName(serviceName string) *ListAvailableServiceOperationsOptions

SetServiceName : Allow user to set ServiceName

func (*ListAvailableServiceOperationsOptions) SetTransactionID added in v0.28.0 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*ListAvailableServiceOperationsOptions) SetXCorrelationID added in v0.28.0 

func (_options *ListAvailableServiceOperationsOptions) SetXCorrelationID(xCorrelationID string) *ListAvailableServiceOperationsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ListAvailableServicerefTargetsOptions 

type ListAvailableServicerefTargetsOptions struct {
	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// Specifies the types of services to retrieve.
	Type *string `json:"type,omitempty"`

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

ListAvailableServicerefTargetsOptions : The ListAvailableServicerefTargets options.

func (*ListAvailableServicerefTargetsOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListAvailableServicerefTargetsOptions) SetTransactionID added in v0.22.3 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*ListAvailableServicerefTargetsOptions) SetType 

func (_options *ListAvailableServicerefTargetsOptions) SetType(typeVar string) *ListAvailableServicerefTargetsOptions

SetType : Allow user to set Type

func (*ListAvailableServicerefTargetsOptions) SetXCorrelationID added in v0.22.3 

func (_options *ListAvailableServicerefTargetsOptions) SetXCorrelationID(xCorrelationID string) *ListAvailableServicerefTargetsOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ListRulesOptions 

type ListRulesOptions struct {
	// The ID of the managing account.
	AccountID *string `json:"account_id" validate:"required"`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// The `region` resource attribute.
	Region *string `json:"region,omitempty"`

	// The `resource` resource attribute.
	Resource *string `json:"resource,omitempty"`

	// The `resourceType` resource attribute.
	ResourceType *string `json:"resource_type,omitempty"`

	// The `serviceInstance` resource attribute.
	ServiceInstance *string `json:"service_instance,omitempty"`

	// The `serviceName` resource attribute.
	ServiceName *string `json:"service_name,omitempty"`

	// The rule's `serviceType` resource attribute.
	ServiceType *string `json:"service_type,omitempty"`

	// The rule's `service_group_id` resource attribute.
	ServiceGroupID *string `json:"service_group_id,omitempty"`

	// The globally unique ID of the zone.
	ZoneID *string `json:"zone_id,omitempty"`

	// Sorts results by using a valid sort field. To learn more, see
	// [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting).
	Sort *string `json:"sort,omitempty"`

	// The rule's `enforcement_mode` attribute.
	EnforcementMode *string `json:"enforcement_mode,omitempty"`

	// 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) SetEnforcementMode added in v0.28.0 

func (_options *ListRulesOptions) SetEnforcementMode(enforcementMode string) *ListRulesOptions

SetEnforcementMode : Allow user to set EnforcementMode

func (*ListRulesOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListRulesOptions) SetRegion 

func (_options *ListRulesOptions) SetRegion(region string) *ListRulesOptions

SetRegion : Allow user to set Region

func (*ListRulesOptions) SetResource 

func (_options *ListRulesOptions) SetResource(resource string) *ListRulesOptions

SetResource : Allow user to set Resource

func (*ListRulesOptions) SetResourceType 

func (_options *ListRulesOptions) SetResourceType(resourceType string) *ListRulesOptions

SetResourceType : Allow user to set ResourceType

func (*ListRulesOptions) SetServiceGroupID added in v0.28.6 

func (_options *ListRulesOptions) SetServiceGroupID(serviceGroupID string) *ListRulesOptions

SetServiceGroupID : Allow user to set ServiceGroupID

func (*ListRulesOptions) SetServiceInstance 

func (_options *ListRulesOptions) SetServiceInstance(serviceInstance string) *ListRulesOptions

SetServiceInstance : Allow user to set ServiceInstance

func (*ListRulesOptions) SetServiceName 

func (_options *ListRulesOptions) SetServiceName(serviceName string) *ListRulesOptions

SetServiceName : Allow user to set ServiceName

func (*ListRulesOptions) SetServiceType 

func (_options *ListRulesOptions) SetServiceType(serviceType string) *ListRulesOptions

SetServiceType : Allow user to set ServiceType

func (*ListRulesOptions) SetSort 

func (_options *ListRulesOptions) SetSort(sort string) *ListRulesOptions

SetSort : Allow user to set Sort

func (*ListRulesOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*ListRulesOptions) SetXCorrelationID added in v0.22.3 

func (_options *ListRulesOptions) SetXCorrelationID(xCorrelationID string) *ListRulesOptions

SetXCorrelationID : Allow user to set XCorrelationID

func (*ListRulesOptions) SetZoneID 

func (_options *ListRulesOptions) SetZoneID(zoneID string) *ListRulesOptions

SetZoneID : Allow user to set ZoneID

type ListZonesOptions 

type ListZonesOptions struct {
	// The ID of the managing account.
	AccountID *string `json:"account_id" validate:"required"`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

	// The name of the zone.
	Name *string `json:"name,omitempty"`

	// Sorts results by using a valid sort field. To learn more, see
	// [Sorting](https://cloud.ibm.com/docs/api-handbook?topic=api-handbook-sorting).
	Sort *string `json:"sort,omitempty"`

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

ListZonesOptions : The ListZones options.

func (*ListZonesOptions) SetAccountID 

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

SetAccountID : Allow user to set AccountID

func (*ListZonesOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ListZonesOptions) SetName 

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

SetName : Allow user to set Name

func (*ListZonesOptions) SetSort 

func (_options *ListZonesOptions) SetSort(sort string) *ListZonesOptions

SetSort : Allow user to set Sort

func (*ListZonesOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*ListZonesOptions) SetXCorrelationID added in v0.22.3 

func (_options *ListZonesOptions) SetXCorrelationID(xCorrelationID string) *ListZonesOptions

SetXCorrelationID : Allow user to set XCorrelationID

type NewRuleOperations added in v0.28.0 

type NewRuleOperations struct {
	// The API types this rule applies to.
	APITypes []NewRuleOperationsAPITypesItem `json:"api_types" validate:"required"`
}

NewRuleOperations : The operations this rule applies to.

type NewRuleOperationsAPITypesItem added in v0.28.0 

type NewRuleOperationsAPITypesItem struct {
	APITypeID *string `json:"api_type_id" validate:"required"`
}

NewRuleOperationsAPITypesItem : NewRuleOperationsAPITypesItem struct

type OperationsList added in v0.28.0 

type OperationsList struct {
	// The returned API types.
	APITypes []APIType `json:"api_types" validate:"required"`
}

OperationsList : The response object of the `list_available_service_operations` operation.

type ReplaceRuleOptions 

type ReplaceRuleOptions struct {
	// The ID of a rule.
	RuleID *string `json:"rule_id" validate:"required,ne="`

	// The current revision of the resource being updated. This can be found in the Create/Get/Update resource response
	// ETag header.
	IfMatch *string `json:"If-Match" validate:"required"`

	// The description of the rule.
	Description *string `json:"description,omitempty"`

	// The contexts this rule applies to.
	Contexts []RuleContext `json:"contexts,omitempty"`

	// The resources this rule apply to.
	Resources []Resource `json:"resources,omitempty"`

	// The operations this rule applies to.
	Operations *NewRuleOperations `json:"operations,omitempty"`

	// The rule enforcement mode:
	//  * `enabled` - The restrictions are enforced and reported. This is the default.
	//  * `disabled` - The restrictions are disabled. Nothing is enforced or reported.
	//  * `report` - The restrictions are evaluated and reported, but not enforced.
	EnforcementMode *string `json:"enforcement_mode,omitempty"`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

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

ReplaceRuleOptions : The ReplaceRule options.

func (*ReplaceRuleOptions) SetContexts 

func (_options *ReplaceRuleOptions) SetContexts(contexts []RuleContext) *ReplaceRuleOptions

SetContexts : Allow user to set Contexts

func (*ReplaceRuleOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*ReplaceRuleOptions) SetEnforcementMode added in v0.26.0 

func (_options *ReplaceRuleOptions) SetEnforcementMode(enforcementMode string) *ReplaceRuleOptions

SetEnforcementMode : Allow user to set EnforcementMode

func (*ReplaceRuleOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ReplaceRuleOptions) SetIfMatch 

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

SetIfMatch : Allow user to set IfMatch

func (*ReplaceRuleOptions) SetOperations added in v0.28.0 

func (_options *ReplaceRuleOptions) SetOperations(operations *NewRuleOperations) *ReplaceRuleOptions

SetOperations : Allow user to set Operations

func (*ReplaceRuleOptions) SetResources 

func (_options *ReplaceRuleOptions) SetResources(resources []Resource) *ReplaceRuleOptions

SetResources : Allow user to set Resources

func (*ReplaceRuleOptions) SetRuleID 

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

SetRuleID : Allow user to set RuleID

func (*ReplaceRuleOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*ReplaceRuleOptions) SetXCorrelationID added in v0.22.3 

func (_options *ReplaceRuleOptions) SetXCorrelationID(xCorrelationID string) *ReplaceRuleOptions

SetXCorrelationID : Allow user to set XCorrelationID

type ReplaceZoneOptions 

type ReplaceZoneOptions struct {
	// The ID of a zone.
	ZoneID *string `json:"zone_id" validate:"required,ne="`

	// The current revision of the resource being updated. This can be found in the Create/Get/Update resource response
	// ETag header.
	IfMatch *string `json:"If-Match" validate:"required"`

	// The name of the zone.
	Name *string `json:"name,omitempty"`

	// The id of the account owning this zone.
	AccountID *string `json:"account_id,omitempty"`

	// The description of the zone.
	Description *string `json:"description,omitempty"`

	// The list of addresses in the zone.
	Addresses []AddressIntf `json:"addresses,omitempty"`

	// The list of excluded addresses in the zone. Only addresses of type `ipAddress`, `ipRange`, and `subnet` can be
	// excluded.
	Excluded []AddressIntf `json:"excluded,omitempty"`

	// The supplied or generated value of this header is logged for a request and repeated in a response header for the
	// corresponding response. The same value is used for downstream requests and retries of those requests. If a value of
	// this headers is not supplied in a request, the service generates a random (version 4) UUID.
	XCorrelationID *string `json:"X-Correlation-Id,omitempty"`

	// The `Transaction-Id` header behaves as the `X-Correlation-Id` header. It is supported for backward compatibility
	// with other IBM platform services that support the `Transaction-Id` header only. If both `X-Correlation-Id` and
	// `Transaction-Id` are provided, `X-Correlation-Id` has the precedence over `Transaction-Id`.
	// Deprecated: this field is deprecated and may be removed in a future release.
	TransactionID *string `json:"Transaction-Id,omitempty"`

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

ReplaceZoneOptions : The ReplaceZone options.

func (*ReplaceZoneOptions) SetAccountID 

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

SetAccountID : Allow user to set AccountID

func (*ReplaceZoneOptions) SetAddresses 

func (_options *ReplaceZoneOptions) SetAddresses(addresses []AddressIntf) *ReplaceZoneOptions

SetAddresses : Allow user to set Addresses

func (*ReplaceZoneOptions) SetDescription 

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

SetDescription : Allow user to set Description

func (*ReplaceZoneOptions) SetExcluded 

func (_options *ReplaceZoneOptions) SetExcluded(excluded []AddressIntf) *ReplaceZoneOptions

SetExcluded : Allow user to set Excluded

func (*ReplaceZoneOptions) SetHeaders 

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

SetHeaders : Allow user to set Headers

func (*ReplaceZoneOptions) SetIfMatch 

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

SetIfMatch : Allow user to set IfMatch

func (*ReplaceZoneOptions) SetName 

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

SetName : Allow user to set Name

func (*ReplaceZoneOptions) SetTransactionID 

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

SetTransactionID : Allow user to set TransactionID Deprecated: this method is deprecated and may be removed in a future release.

func (*ReplaceZoneOptions) SetXCorrelationID added in v0.22.3 

func (_options *ReplaceZoneOptions) SetXCorrelationID(xCorrelationID string) *ReplaceZoneOptions

SetXCorrelationID : Allow user to set XCorrelationID

func (*ReplaceZoneOptions) SetZoneID 

func (_options *ReplaceZoneOptions) SetZoneID(zoneID string) *ReplaceZoneOptions

SetZoneID : Allow user to set ZoneID

type Resource 

type Resource struct {
	// The resource attributes.
	Attributes []ResourceAttribute `json:"attributes" validate:"required"`

	// The optional resource tags.
	Tags []ResourceTagAttribute `json:"tags,omitempty"`
}

Resource : An rule resource.

type ResourceAttribute 

type ResourceAttribute struct {
	// The attribute name.
	Name *string `json:"name" validate:"required"`

	// The attribute value.
	Value *string `json:"value" validate:"required"`

	// The attribute operator.
	Operator *string `json:"operator,omitempty"`
}

ResourceAttribute : A rule resource attribute.

type ResourceTagAttribute 

type ResourceTagAttribute struct {
	// The tag attribute name.
	Name *string `json:"name" validate:"required"`

	// The tag attribute value.
	Value *string `json:"value" validate:"required"`

	// The attribute operator.
	Operator *string `json:"operator,omitempty"`
}

ResourceTagAttribute : A rule resource tag attribute.

type Rule 

type Rule struct {
	// The globally unique ID of the rule.
	ID *string `json:"id" validate:"required"`

	// The rule CRN.
	CRN *string `json:"crn" validate:"required"`

	// The description of the rule.
	Description *string `json:"description" validate:"required"`

	// The contexts this rule applies to.
	Contexts []RuleContext `json:"contexts" validate:"required"`

	// The resources this rule apply to.
	Resources []Resource `json:"resources" validate:"required"`

	// The operations this rule applies to.
	Operations *NewRuleOperations `json:"operations,omitempty"`

	// The rule enforcement mode:
	//  * `enabled` - The restrictions are enforced and reported. This is the default.
	//  * `disabled` - The restrictions are disabled. Nothing is enforced or reported.
	//  * `report` - The restrictions are evaluated and reported, but not enforced.
	EnforcementMode *string `json:"enforcement_mode,omitempty"`

	// The href link to the resource.
	Href *string `json:"href" validate:"required"`

	// The time the resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// IAM ID of the user or service which created the resource.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The last time the resource was modified.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// IAM ID of the user or service which modified the resource.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

Rule : An output rule.

type RuleContext 

type RuleContext struct {
	// The attributes.
	Attributes []RuleContextAttribute `json:"attributes" validate:"required"`
}

RuleContext : A rule context.

type RuleContextAttribute 

type RuleContextAttribute struct {
	// The attribute name.
	Name *string `json:"name" validate:"required"`

	// The attribute value.
	Value *string `json:"value" validate:"required"`
}

RuleContextAttribute : An rule context attribute.

type RuleList 

type RuleList struct {
	// The number of returned results.
	Count *int64 `json:"count" validate:"required"`

	// The returned rules.
	Rules []Rule `json:"rules" validate:"required"`
}

RuleList : The response object of the ListRules operation.

type ServiceRefTarget 

type ServiceRefTarget struct {
	// The name of the service.
	ServiceName *string `json:"service_name" validate:"required"`

	// The type of the service.
	ServiceType *string `json:"service_type,omitempty"`

	// The locations the service is available.
	Locations []ServiceRefTargetLocationsItem `json:"locations,omitempty"`
}

ServiceRefTarget : Summary information about a service reference target.

type ServiceRefTargetList 

type ServiceRefTargetList struct {
	// The number of returned results.
	Count *int64 `json:"count" validate:"required"`

	// The list of service reference targets.
	Targets []ServiceRefTarget `json:"targets" validate:"required"`
}

ServiceRefTargetList : A list of service reference targets.

type ServiceRefTargetLocationsItem added in v0.28.0 

type ServiceRefTargetLocationsItem struct {
	// The location display name.
	DisplayName *string `json:"display_name,omitempty"`

	// The location kind.
	Kind *string `json:"kind,omitempty"`

	// The location name.
	Name *string `json:"name" validate:"required"`
}

ServiceRefTargetLocationsItem : ServiceRefTargetLocationsItem struct

type ServiceRefValue 

type ServiceRefValue struct {
	// The id of the account owning the service.
	AccountID *string `json:"account_id" validate:"required"`

	// The service type.
	ServiceType *string `json:"service_type,omitempty"`

	// The service name.
	ServiceName *string `json:"service_name,omitempty"`

	// The service instance.
	ServiceInstance *string `json:"service_instance,omitempty"`

	// The location.
	Location *string `json:"location,omitempty"`
}

ServiceRefValue : A service reference value.

type Zone 

type Zone struct {
	// The globally unique ID of the zone.
	ID *string `json:"id" validate:"required"`

	// The zone CRN.
	CRN *string `json:"crn" validate:"required"`

	// The number of addresses in the zone.
	AddressCount *int64 `json:"address_count" validate:"required"`

	// The number of excluded addresses in the zone.
	ExcludedCount *int64 `json:"excluded_count" validate:"required"`

	// The name of the zone.
	Name *string `json:"name" validate:"required"`

	// The id of the account owning this zone.
	AccountID *string `json:"account_id" validate:"required"`

	// The description of the zone.
	Description *string `json:"description" validate:"required"`

	// The list of addresses in the zone.
	Addresses []AddressIntf `json:"addresses" validate:"required"`

	// The list of excluded addresses in the zone. Only addresses of type `ipAddress`, `ipRange`, and `subnet` can be
	// excluded.
	Excluded []AddressIntf `json:"excluded" validate:"required"`

	// The href link to the resource.
	Href *string `json:"href" validate:"required"`

	// The time the resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// IAM ID of the user or service which created the resource.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The last time the resource was modified.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// IAM ID of the user or service which modified the resource.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

Zone : An output zone.

type ZoneList 

type ZoneList struct {
	// The number of returned results.
	Count *int64 `json:"count" validate:"required"`

	// The returned zones.
	Zones []ZoneSummary `json:"zones" validate:"required"`
}

ZoneList : The response object of the ListZones operation.

type ZoneSummary 

type ZoneSummary struct {
	// The globally unique ID of the zone.
	ID *string `json:"id" validate:"required"`

	// The zone CRN.
	CRN *string `json:"crn" validate:"required"`

	// The name of the zone.
	Name *string `json:"name" validate:"required"`

	// The description of the zone.
	Description *string `json:"description,omitempty"`

	// A preview of addresses in the zone (3 addresses maximum).
	AddressesPreview []AddressIntf `json:"addresses_preview" validate:"required"`

	// The number of addresses in the zone.
	AddressCount *int64 `json:"address_count" validate:"required"`

	// The number of excluded addresses in the zone.
	ExcludedCount *int64 `json:"excluded_count" validate:"required"`

	// The href link to the resource.
	Href *string `json:"href" validate:"required"`

	// The time the resource was created.
	CreatedAt *strfmt.DateTime `json:"created_at" validate:"required"`

	// IAM ID of the user or service which created the resource.
	CreatedByID *string `json:"created_by_id" validate:"required"`

	// The last time the resource was modified.
	LastModifiedAt *strfmt.DateTime `json:"last_modified_at" validate:"required"`

	// IAM ID of the user or service which modified the resource.
	LastModifiedByID *string `json:"last_modified_by_id" validate:"required"`
}

ZoneSummary : An output zone summary.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.