filtersv1

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: 5

Documentation

Overview

Package filtersv1 : Operations and models for the FiltersV1 service

Index

Constants

View Source
const DefaultServiceName = "filters"

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 UnmarshalDeleteFilterResp added in v0.16.0

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

UnmarshalDeleteFilterResp unmarshals an instance of DeleteFilterResp from the specified map of raw messages.

func UnmarshalDeleteFilterRespResult added in v0.16.0

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

UnmarshalDeleteFilterRespResult unmarshals an instance of DeleteFilterRespResult from the specified map of raw messages.

func UnmarshalDeleteFiltersResp added in v0.16.0

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

UnmarshalDeleteFiltersResp unmarshals an instance of DeleteFiltersResp from the specified map of raw messages.

func UnmarshalDeleteFiltersRespResultItem added in v0.16.0

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

UnmarshalDeleteFiltersRespResultItem unmarshals an instance of DeleteFiltersRespResultItem from the specified map of raw messages.

func UnmarshalFilterInput

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

UnmarshalFilterInput unmarshals an instance of FilterInput from the specified map of raw messages.

func UnmarshalFilterObject added in v0.16.0

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

UnmarshalFilterObject unmarshals an instance of FilterObject from the specified map of raw messages.

func UnmarshalFilterResp added in v0.16.0

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

UnmarshalFilterResp unmarshals an instance of FilterResp from the specified map of raw messages.

func UnmarshalFilterUpdateInput

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

UnmarshalFilterUpdateInput unmarshals an instance of FilterUpdateInput from the specified map of raw messages.

func UnmarshalFiltersResp added in v0.16.0

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

UnmarshalFiltersResp unmarshals an instance of FiltersResp from the specified map of raw messages.

func UnmarshalListFiltersResp added in v0.16.0

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

UnmarshalListFiltersResp unmarshals an instance of ListFiltersResp from the specified map of raw messages.

func UnmarshalListFiltersRespResultInfo added in v0.16.0

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

UnmarshalListFiltersRespResultInfo unmarshals an instance of ListFiltersRespResultInfo from the specified map of raw messages.

Types

type CreateFilterOptions

type CreateFilterOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `validate:"required"`

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

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

	// Json objects which are used to create filters.
	FilterInput []FilterInput

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

CreateFilterOptions : The CreateFilter options.

func (*CreateFilterOptions) SetCrn

func (options *CreateFilterOptions) SetCrn(crn string) *CreateFilterOptions

SetCrn : Allow user to set Crn

func (*CreateFilterOptions) SetFilterInput

func (options *CreateFilterOptions) SetFilterInput(filterInput []FilterInput) *CreateFilterOptions

SetFilterInput : Allow user to set FilterInput

func (*CreateFilterOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*CreateFilterOptions) SetXAuthUserToken

func (options *CreateFilterOptions) SetXAuthUserToken(xAuthUserToken string) *CreateFilterOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*CreateFilterOptions) SetZoneIdentifier

func (options *CreateFilterOptions) SetZoneIdentifier(zoneIdentifier string) *CreateFilterOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type DeleteFilterOptions

type DeleteFilterOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `validate:"required"`

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

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

	// Identifier of the filter to be deleted.
	FilterIdentifier *string `validate:"required,ne="`

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

DeleteFilterOptions : The DeleteFilter options.

func (*DeleteFilterOptions) SetCrn

func (options *DeleteFilterOptions) SetCrn(crn string) *DeleteFilterOptions

SetCrn : Allow user to set Crn

func (*DeleteFilterOptions) SetFilterIdentifier

func (options *DeleteFilterOptions) SetFilterIdentifier(filterIdentifier string) *DeleteFilterOptions

SetFilterIdentifier : Allow user to set FilterIdentifier

func (*DeleteFilterOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteFilterOptions) SetXAuthUserToken

func (options *DeleteFilterOptions) SetXAuthUserToken(xAuthUserToken string) *DeleteFilterOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*DeleteFilterOptions) SetZoneIdentifier

func (options *DeleteFilterOptions) SetZoneIdentifier(zoneIdentifier string) *DeleteFilterOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type DeleteFilterResp added in v0.16.0

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

DeleteFilterResp : DeleteFilterResp struct

type DeleteFilterRespResult added in v0.16.0

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

DeleteFilterRespResult : Container for response information.

type DeleteFiltersOptions

type DeleteFiltersOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `validate:"required"`

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

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

	// ids of filters which will be deleted.
	ID *string `validate:"required"`

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

DeleteFiltersOptions : The DeleteFilters options.

func (*DeleteFiltersOptions) SetCrn

func (options *DeleteFiltersOptions) SetCrn(crn string) *DeleteFiltersOptions

SetCrn : Allow user to set Crn

func (*DeleteFiltersOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*DeleteFiltersOptions) SetID

func (options *DeleteFiltersOptions) SetID(id string) *DeleteFiltersOptions

SetID : Allow user to set ID

func (*DeleteFiltersOptions) SetXAuthUserToken

func (options *DeleteFiltersOptions) SetXAuthUserToken(xAuthUserToken string) *DeleteFiltersOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*DeleteFiltersOptions) SetZoneIdentifier

func (options *DeleteFiltersOptions) SetZoneIdentifier(zoneIdentifier string) *DeleteFiltersOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type DeleteFiltersResp added in v0.16.0

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

DeleteFiltersResp : DeleteFiltersResp struct

type DeleteFiltersRespResultItem added in v0.16.0

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

DeleteFiltersRespResultItem : DeleteFiltersRespResultItem struct

type FilterInput

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

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

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

FilterInput : Json objects which are used to create filters.

type FilterObject added in v0.16.0

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

	// 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"`
}

FilterObject : FilterObject struct

type FilterResp added in v0.16.0

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

FilterResp : FilterResp struct

type FilterUpdateInput

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

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

	// To briefly describe the filter.
	Description *string `json:"description,omitempty"`

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

FilterUpdateInput : FilterUpdateInput struct

type FiltersResp added in v0.16.0

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

FiltersResp : FiltersResp struct

type FiltersV1

type FiltersV1 struct {
	Service *core.BaseService
}

FiltersV1 : Filters

Version: 1.0.1

func NewFiltersV1

func NewFiltersV1(options *FiltersV1Options) (service *FiltersV1, err error)

NewFiltersV1 : constructs an instance of FiltersV1 with passed in options.

func NewFiltersV1UsingExternalConfig

func NewFiltersV1UsingExternalConfig(options *FiltersV1Options) (filters *FiltersV1, err error)

NewFiltersV1UsingExternalConfig : constructs an instance of FiltersV1 with passed in options and external configuration.

func (*FiltersV1) Clone

func (filters *FiltersV1) Clone() *FiltersV1

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

func (*FiltersV1) CreateFilter

func (filters *FiltersV1) CreateFilter(createFilterOptions *CreateFilterOptions) (result *FiltersResp, response *core.DetailedResponse, err error)

CreateFilter : Create filters for a zone Create new filters for a given zone under a service instance.

func (*FiltersV1) CreateFilterWithContext

func (filters *FiltersV1) CreateFilterWithContext(ctx context.Context, createFilterOptions *CreateFilterOptions) (result *FiltersResp, response *core.DetailedResponse, err error)

CreateFilterWithContext is an alternate form of the CreateFilter method which supports a Context parameter

func (*FiltersV1) DeleteFilter

func (filters *FiltersV1) DeleteFilter(deleteFilterOptions *DeleteFilterOptions) (result *DeleteFilterResp, response *core.DetailedResponse, err error)

DeleteFilter : Delete a filter Delete a filter given its id.

func (*FiltersV1) DeleteFilterWithContext

func (filters *FiltersV1) DeleteFilterWithContext(ctx context.Context, deleteFilterOptions *DeleteFilterOptions) (result *DeleteFilterResp, response *core.DetailedResponse, err error)

DeleteFilterWithContext is an alternate form of the DeleteFilter method which supports a Context parameter

func (*FiltersV1) DeleteFilters

func (filters *FiltersV1) DeleteFilters(deleteFiltersOptions *DeleteFiltersOptions) (result *DeleteFiltersResp, response *core.DetailedResponse, err error)

DeleteFilters : Delete filters Delete filters by filter ids.

func (*FiltersV1) DeleteFiltersWithContext

func (filters *FiltersV1) DeleteFiltersWithContext(ctx context.Context, deleteFiltersOptions *DeleteFiltersOptions) (result *DeleteFiltersResp, response *core.DetailedResponse, err error)

DeleteFiltersWithContext is an alternate form of the DeleteFilters method which supports a Context parameter

func (*FiltersV1) DisableRetries

func (filters *FiltersV1) DisableRetries()

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

func (*FiltersV1) EnableRetries

func (filters *FiltersV1) 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 (*FiltersV1) GetEnableGzipCompression

func (filters *FiltersV1) GetEnableGzipCompression() bool

GetEnableGzipCompression returns the service's EnableGzipCompression field

func (*FiltersV1) GetFilter

func (filters *FiltersV1) GetFilter(getFilterOptions *GetFilterOptions) (result *FilterResp, response *core.DetailedResponse, err error)

GetFilter : Get filter details by id Get the details of a filter for a given zone under a given service instance.

func (*FiltersV1) GetFilterWithContext

func (filters *FiltersV1) GetFilterWithContext(ctx context.Context, getFilterOptions *GetFilterOptions) (result *FilterResp, response *core.DetailedResponse, err error)

GetFilterWithContext is an alternate form of the GetFilter method which supports a Context parameter

func (*FiltersV1) GetServiceURL

func (filters *FiltersV1) GetServiceURL() string

GetServiceURL returns the service URL

func (*FiltersV1) ListAllFilters

func (filters *FiltersV1) ListAllFilters(listAllFiltersOptions *ListAllFiltersOptions) (result *ListFiltersResp, response *core.DetailedResponse, err error)

ListAllFilters : List all filters for a zone List all filters for a zone.

func (*FiltersV1) ListAllFiltersWithContext

func (filters *FiltersV1) ListAllFiltersWithContext(ctx context.Context, listAllFiltersOptions *ListAllFiltersOptions) (result *ListFiltersResp, response *core.DetailedResponse, err error)

ListAllFiltersWithContext is an alternate form of the ListAllFilters method which supports a Context parameter

func (*FiltersV1) NewCreateFilterOptions

func (*FiltersV1) NewCreateFilterOptions(xAuthUserToken string, crn string, zoneIdentifier string) *CreateFilterOptions

NewCreateFilterOptions : Instantiate CreateFilterOptions

func (*FiltersV1) NewDeleteFilterOptions

func (*FiltersV1) NewDeleteFilterOptions(xAuthUserToken string, crn string, zoneIdentifier string, filterIdentifier string) *DeleteFilterOptions

NewDeleteFilterOptions : Instantiate DeleteFilterOptions

func (*FiltersV1) NewDeleteFiltersOptions

func (*FiltersV1) NewDeleteFiltersOptions(xAuthUserToken string, crn string, zoneIdentifier string, id string) *DeleteFiltersOptions

NewDeleteFiltersOptions : Instantiate DeleteFiltersOptions

func (*FiltersV1) NewFilterInput

func (*FiltersV1) NewFilterInput(expression string) (model *FilterInput, err error)

NewFilterInput : Instantiate FilterInput (Generic Model Constructor)

func (*FiltersV1) NewFilterUpdateInput

func (*FiltersV1) NewFilterUpdateInput(id string, expression string) (model *FilterUpdateInput, err error)

NewFilterUpdateInput : Instantiate FilterUpdateInput (Generic Model Constructor)

func (*FiltersV1) NewGetFilterOptions

func (*FiltersV1) NewGetFilterOptions(xAuthUserToken string, crn string, zoneIdentifier string, filterIdentifier string) *GetFilterOptions

NewGetFilterOptions : Instantiate GetFilterOptions

func (*FiltersV1) NewListAllFiltersOptions

func (*FiltersV1) NewListAllFiltersOptions(xAuthUserToken string, crn string, zoneIdentifier string) *ListAllFiltersOptions

NewListAllFiltersOptions : Instantiate ListAllFiltersOptions

func (*FiltersV1) NewUpdateFilterOptions

func (*FiltersV1) NewUpdateFilterOptions(xAuthUserToken string, crn string, zoneIdentifier string, filterIdentifier string) *UpdateFilterOptions

NewUpdateFilterOptions : Instantiate UpdateFilterOptions

func (*FiltersV1) NewUpdateFiltersOptions

func (*FiltersV1) NewUpdateFiltersOptions(xAuthUserToken string, crn string, zoneIdentifier string) *UpdateFiltersOptions

NewUpdateFiltersOptions : Instantiate UpdateFiltersOptions

func (*FiltersV1) SetDefaultHeaders

func (filters *FiltersV1) SetDefaultHeaders(headers http.Header)

SetDefaultHeaders sets HTTP headers to be sent in every request

func (*FiltersV1) SetEnableGzipCompression

func (filters *FiltersV1) SetEnableGzipCompression(enableGzip bool)

SetEnableGzipCompression sets the service's EnableGzipCompression field

func (*FiltersV1) SetServiceURL

func (filters *FiltersV1) SetServiceURL(url string) error

SetServiceURL sets the service URL

func (*FiltersV1) UpdateFilter

func (filters *FiltersV1) UpdateFilter(updateFilterOptions *UpdateFilterOptions) (result *FilterResp, response *core.DetailedResponse, err error)

UpdateFilter : Update a filter Update an existing filter for a given zone under a given service instance.

func (*FiltersV1) UpdateFilterWithContext

func (filters *FiltersV1) UpdateFilterWithContext(ctx context.Context, updateFilterOptions *UpdateFilterOptions) (result *FilterResp, response *core.DetailedResponse, err error)

UpdateFilterWithContext is an alternate form of the UpdateFilter method which supports a Context parameter

func (*FiltersV1) UpdateFilters

func (filters *FiltersV1) UpdateFilters(updateFiltersOptions *UpdateFiltersOptions) (result *FiltersResp, response *core.DetailedResponse, err error)

UpdateFilters : Update filters Update existing filters for a given zone under a given service instance.

func (*FiltersV1) UpdateFiltersWithContext

func (filters *FiltersV1) UpdateFiltersWithContext(ctx context.Context, updateFiltersOptions *UpdateFiltersOptions) (result *FiltersResp, response *core.DetailedResponse, err error)

UpdateFiltersWithContext is an alternate form of the UpdateFilters method which supports a Context parameter

type FiltersV1Options

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

FiltersV1Options : Service options

type GetFilterOptions

type GetFilterOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `validate:"required"`

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

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

	// Identifier of filter for the given zone.
	FilterIdentifier *string `validate:"required,ne="`

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

GetFilterOptions : The GetFilter options.

func (*GetFilterOptions) SetCrn

func (options *GetFilterOptions) SetCrn(crn string) *GetFilterOptions

SetCrn : Allow user to set Crn

func (*GetFilterOptions) SetFilterIdentifier

func (options *GetFilterOptions) SetFilterIdentifier(filterIdentifier string) *GetFilterOptions

SetFilterIdentifier : Allow user to set FilterIdentifier

func (*GetFilterOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*GetFilterOptions) SetXAuthUserToken

func (options *GetFilterOptions) SetXAuthUserToken(xAuthUserToken string) *GetFilterOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*GetFilterOptions) SetZoneIdentifier

func (options *GetFilterOptions) SetZoneIdentifier(zoneIdentifier string) *GetFilterOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type ListAllFiltersOptions

type ListAllFiltersOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `validate:"required"`

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

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

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

ListAllFiltersOptions : The ListAllFilters options.

func (*ListAllFiltersOptions) SetCrn

func (options *ListAllFiltersOptions) SetCrn(crn string) *ListAllFiltersOptions

SetCrn : Allow user to set Crn

func (*ListAllFiltersOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*ListAllFiltersOptions) SetXAuthUserToken

func (options *ListAllFiltersOptions) SetXAuthUserToken(xAuthUserToken string) *ListAllFiltersOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*ListAllFiltersOptions) SetZoneIdentifier

func (options *ListAllFiltersOptions) SetZoneIdentifier(zoneIdentifier string) *ListAllFiltersOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type ListFiltersResp added in v0.16.0

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

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

ListFiltersResp : ListFiltersResp struct

type ListFiltersRespResultInfo added in v0.16.0

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

ListFiltersRespResultInfo : Statistics of results.

type UpdateFilterOptions

type UpdateFilterOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `validate:"required"`

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

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

	// Identifier of filter.
	FilterIdentifier *string `validate:"required,ne="`

	// Identifier of the filter.
	ID *string

	// A filter expression.
	Expression *string

	// To briefly describe the filter.
	Description *string

	// Indicates if the filter is active.
	Paused *bool

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

UpdateFilterOptions : The UpdateFilter options.

func (*UpdateFilterOptions) SetCrn

func (options *UpdateFilterOptions) SetCrn(crn string) *UpdateFilterOptions

SetCrn : Allow user to set Crn

func (*UpdateFilterOptions) SetDescription

func (options *UpdateFilterOptions) SetDescription(description string) *UpdateFilterOptions

SetDescription : Allow user to set Description

func (*UpdateFilterOptions) SetExpression

func (options *UpdateFilterOptions) SetExpression(expression string) *UpdateFilterOptions

SetExpression : Allow user to set Expression

func (*UpdateFilterOptions) SetFilterIdentifier

func (options *UpdateFilterOptions) SetFilterIdentifier(filterIdentifier string) *UpdateFilterOptions

SetFilterIdentifier : Allow user to set FilterIdentifier

func (*UpdateFilterOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateFilterOptions) SetID

func (options *UpdateFilterOptions) SetID(id string) *UpdateFilterOptions

SetID : Allow user to set ID

func (*UpdateFilterOptions) SetPaused

func (options *UpdateFilterOptions) SetPaused(paused bool) *UpdateFilterOptions

SetPaused : Allow user to set Paused

func (*UpdateFilterOptions) SetXAuthUserToken

func (options *UpdateFilterOptions) SetXAuthUserToken(xAuthUserToken string) *UpdateFilterOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*UpdateFilterOptions) SetZoneIdentifier

func (options *UpdateFilterOptions) SetZoneIdentifier(zoneIdentifier string) *UpdateFilterOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

type UpdateFiltersOptions

type UpdateFiltersOptions struct {
	// IBM Cloud user IAM token.
	XAuthUserToken *string `validate:"required"`

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

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

	FilterUpdateInput []FilterUpdateInput

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

UpdateFiltersOptions : The UpdateFilters options.

func (*UpdateFiltersOptions) SetCrn

func (options *UpdateFiltersOptions) SetCrn(crn string) *UpdateFiltersOptions

SetCrn : Allow user to set Crn

func (*UpdateFiltersOptions) SetFilterUpdateInput

func (options *UpdateFiltersOptions) SetFilterUpdateInput(filterUpdateInput []FilterUpdateInput) *UpdateFiltersOptions

SetFilterUpdateInput : Allow user to set FilterUpdateInput

func (*UpdateFiltersOptions) SetHeaders

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

SetHeaders : Allow user to set Headers

func (*UpdateFiltersOptions) SetXAuthUserToken

func (options *UpdateFiltersOptions) SetXAuthUserToken(xAuthUserToken string) *UpdateFiltersOptions

SetXAuthUserToken : Allow user to set XAuthUserToken

func (*UpdateFiltersOptions) SetZoneIdentifier

func (options *UpdateFiltersOptions) SetZoneIdentifier(zoneIdentifier string) *UpdateFiltersOptions

SetZoneIdentifier : Allow user to set ZoneIdentifier

Jump to

Keyboard shortcuts

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