Documentation
      ¶
    
    
  
    
  
    Overview ¶
Package listsapiv1 : Operations and models for the ListsApiV1 service
Index ¶
- Constants
 - func GetServiceURLForRegion(region string) (string, error)
 - func UnmarshalCreateListItemsReqItem(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalCustomListResp(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalCustomListResult(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalCustomListsResp(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalDeleteListItemsReqItemsItem(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalDeleteResourceResp(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalDeleteResourceRespResult(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalListItem(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalListItemResp(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalListItemsResp(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalListOperationResp(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalListOperationRespResult(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalManagedListsResp(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalManagedListsResultItem(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalOperationStatusResp(m map[string]json.RawMessage, result interface{}) (err error)
 - func UnmarshalOperationStatusRespResult(m map[string]json.RawMessage, result interface{}) (err error)
 - type CreateCustomListsOptions
 - func (_options *CreateCustomListsOptions) SetDescription(description string) *CreateCustomListsOptions
 - func (options *CreateCustomListsOptions) SetHeaders(param map[string]string) *CreateCustomListsOptions
 - func (_options *CreateCustomListsOptions) SetKind(kind string) *CreateCustomListsOptions
 - func (_options *CreateCustomListsOptions) SetName(name string) *CreateCustomListsOptions
 
- type CreateListItemsOptions
 - type CreateListItemsReqItem
 - type CustomListResp
 - type CustomListResult
 - type CustomListsResp
 - type DeleteCustomListOptions
 - type DeleteListItemsOptions
 - type DeleteListItemsReqItemsItem
 - type DeleteResourceResp
 - type DeleteResourceRespResult
 - type GetCustomListOptions
 - type GetCustomListsOptions
 - type GetListItemOptions
 - type GetListItemsOptions
 - type GetManagedListsOptions
 - type GetOperationStatusOptions
 - type ListItem
 - type ListItemResp
 - type ListItemsResp
 - type ListOperationResp
 - type ListOperationRespResult
 - type ListsApiV1
 - func (listsApi *ListsApiV1) Clone() *ListsApiV1
 - func (listsApi *ListsApiV1) CreateCustomLists(createCustomListsOptions *CreateCustomListsOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) CreateCustomListsWithContext(ctx context.Context, createCustomListsOptions *CreateCustomListsOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) CreateListItems(createListItemsOptions *CreateListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) CreateListItemsWithContext(ctx context.Context, createListItemsOptions *CreateListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) DeleteCustomList(deleteCustomListOptions *DeleteCustomListOptions) (result *DeleteResourceResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) DeleteCustomListWithContext(ctx context.Context, deleteCustomListOptions *DeleteCustomListOptions) (result *DeleteResourceResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) DeleteListItems(deleteListItemsOptions *DeleteListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) DeleteListItemsWithContext(ctx context.Context, deleteListItemsOptions *DeleteListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) DisableRetries()
 - func (listsApi *ListsApiV1) EnableRetries(maxRetries int, maxRetryInterval time.Duration)
 - func (listsApi *ListsApiV1) GetCustomList(getCustomListOptions *GetCustomListOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetCustomListWithContext(ctx context.Context, getCustomListOptions *GetCustomListOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetCustomLists(getCustomListsOptions *GetCustomListsOptions) (result *CustomListsResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetCustomListsWithContext(ctx context.Context, getCustomListsOptions *GetCustomListsOptions) (result *CustomListsResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetEnableGzipCompression() bool
 - func (listsApi *ListsApiV1) GetListItem(getListItemOptions *GetListItemOptions) (result *ListItemResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetListItemWithContext(ctx context.Context, getListItemOptions *GetListItemOptions) (result *ListItemResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetListItems(getListItemsOptions *GetListItemsOptions) (result *ListItemsResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetListItemsWithContext(ctx context.Context, getListItemsOptions *GetListItemsOptions) (result *ListItemsResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetManagedLists(getManagedListsOptions *GetManagedListsOptions) (result *ManagedListsResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetManagedListsWithContext(ctx context.Context, getManagedListsOptions *GetManagedListsOptions) (result *ManagedListsResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetOperationStatus(getOperationStatusOptions *GetOperationStatusOptions) (result *OperationStatusResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetOperationStatusWithContext(ctx context.Context, getOperationStatusOptions *GetOperationStatusOptions) (result *OperationStatusResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) GetServiceURL() string
 - func (*ListsApiV1) NewCreateCustomListsOptions() *CreateCustomListsOptions
 - func (*ListsApiV1) NewCreateListItemsOptions() *CreateListItemsOptions
 - func (*ListsApiV1) NewDeleteCustomListOptions() *DeleteCustomListOptions
 - func (*ListsApiV1) NewDeleteListItemsOptions() *DeleteListItemsOptions
 - func (*ListsApiV1) NewGetCustomListOptions() *GetCustomListOptions
 - func (*ListsApiV1) NewGetCustomListsOptions() *GetCustomListsOptions
 - func (*ListsApiV1) NewGetListItemOptions() *GetListItemOptions
 - func (*ListsApiV1) NewGetListItemsOptions() *GetListItemsOptions
 - func (*ListsApiV1) NewGetManagedListsOptions() *GetManagedListsOptions
 - func (*ListsApiV1) NewGetOperationStatusOptions() *GetOperationStatusOptions
 - func (*ListsApiV1) NewUpdateCustomListOptions() *UpdateCustomListOptions
 - func (*ListsApiV1) NewUpdateListItemsOptions() *UpdateListItemsOptions
 - func (listsApi *ListsApiV1) SetDefaultHeaders(headers http.Header)
 - func (listsApi *ListsApiV1) SetEnableGzipCompression(enableGzip bool)
 - func (listsApi *ListsApiV1) SetServiceURL(url string) error
 - func (listsApi *ListsApiV1) UpdateCustomList(updateCustomListOptions *UpdateCustomListOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) UpdateCustomListWithContext(ctx context.Context, updateCustomListOptions *UpdateCustomListOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) UpdateListItems(updateListItemsOptions *UpdateListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
 - func (listsApi *ListsApiV1) UpdateListItemsWithContext(ctx context.Context, updateListItemsOptions *UpdateListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
 
- type ListsApiV1Options
 - type ManagedListsResp
 - type ManagedListsResultItem
 - type OperationStatusResp
 - type OperationStatusRespResult
 - type UpdateCustomListOptions
 - type UpdateListItemsOptions
 
Constants ¶
const ( CreateCustomListsOptions_Kind_Asn = "asn" CreateCustomListsOptions_Kind_Hostname = "hostname" CreateCustomListsOptions_Kind_Ip = "ip" CreateCustomListsOptions_Kind_Redirect = "redirect" )
Constants associated with the CreateCustomListsOptions.Kind property. The type of list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
const ( OperationStatusRespResult_Status_Completed = "completed" OperationStatusRespResult_Status_Failed = "failed" OperationStatusRespResult_Status_Pending = "pending" OperationStatusRespResult_Status_Running = "running" )
Constants associated with the OperationStatusRespResult.Status property.
const DefaultServiceName = "lists_api"
    DefaultServiceName is the default key used to find external configuration information.
const DefaultServiceURL = "https://api.cis.cloud.ibm.com"
    DefaultServiceURL is the default URL to make service requests to.
Variables ¶
This section is empty.
Functions ¶
func GetServiceURLForRegion ¶
GetServiceURLForRegion returns the service URL to be used for the specified region
func UnmarshalCreateListItemsReqItem ¶
func UnmarshalCreateListItemsReqItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCreateListItemsReqItem unmarshals an instance of CreateListItemsReqItem from the specified map of raw messages.
func UnmarshalCustomListResp ¶
func UnmarshalCustomListResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCustomListResp unmarshals an instance of CustomListResp from the specified map of raw messages.
func UnmarshalCustomListResult ¶
func UnmarshalCustomListResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCustomListResult unmarshals an instance of CustomListResult from the specified map of raw messages.
func UnmarshalCustomListsResp ¶
func UnmarshalCustomListsResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalCustomListsResp unmarshals an instance of CustomListsResp from the specified map of raw messages.
func UnmarshalDeleteListItemsReqItemsItem ¶
func UnmarshalDeleteListItemsReqItemsItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteListItemsReqItemsItem unmarshals an instance of DeleteListItemsReqItemsItem from the specified map of raw messages.
func UnmarshalDeleteResourceResp ¶
func UnmarshalDeleteResourceResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteResourceResp unmarshals an instance of DeleteResourceResp from the specified map of raw messages.
func UnmarshalDeleteResourceRespResult ¶
func UnmarshalDeleteResourceRespResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalDeleteResourceRespResult unmarshals an instance of DeleteResourceRespResult from the specified map of raw messages.
func UnmarshalListItem ¶
func UnmarshalListItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListItem unmarshals an instance of ListItem from the specified map of raw messages.
func UnmarshalListItemResp ¶
func UnmarshalListItemResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListItemResp unmarshals an instance of ListItemResp from the specified map of raw messages.
func UnmarshalListItemsResp ¶
func UnmarshalListItemsResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListItemsResp unmarshals an instance of ListItemsResp from the specified map of raw messages.
func UnmarshalListOperationResp ¶
func UnmarshalListOperationResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListOperationResp unmarshals an instance of ListOperationResp from the specified map of raw messages.
func UnmarshalListOperationRespResult ¶
func UnmarshalListOperationRespResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalListOperationRespResult unmarshals an instance of ListOperationRespResult from the specified map of raw messages.
func UnmarshalManagedListsResp ¶
func UnmarshalManagedListsResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalManagedListsResp unmarshals an instance of ManagedListsResp from the specified map of raw messages.
func UnmarshalManagedListsResultItem ¶
func UnmarshalManagedListsResultItem(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalManagedListsResultItem unmarshals an instance of ManagedListsResultItem from the specified map of raw messages.
func UnmarshalOperationStatusResp ¶
func UnmarshalOperationStatusResp(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalOperationStatusResp unmarshals an instance of OperationStatusResp from the specified map of raw messages.
func UnmarshalOperationStatusRespResult ¶
func UnmarshalOperationStatusRespResult(m map[string]json.RawMessage, result interface{}) (err error)
UnmarshalOperationStatusRespResult unmarshals an instance of OperationStatusRespResult from the specified map of raw messages.
Types ¶
type CreateCustomListsOptions ¶
type CreateCustomListsOptions struct {
	// The type of list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects).
	Kind *string `json:"kind,omitempty"`
	// An informative name for the list. Use this name in rule expressions.
	Name *string `json:"name,omitempty"`
	// An informative summary of the list.
	Description *string `json:"description,omitempty"`
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    CreateCustomListsOptions : The CreateCustomLists options.
func (*CreateCustomListsOptions) SetDescription ¶
func (_options *CreateCustomListsOptions) SetDescription(description string) *CreateCustomListsOptions
SetDescription : Allow user to set Description
func (*CreateCustomListsOptions) SetHeaders ¶
func (options *CreateCustomListsOptions) SetHeaders(param map[string]string) *CreateCustomListsOptions
SetHeaders : Allow user to set Headers
func (*CreateCustomListsOptions) SetKind ¶
func (_options *CreateCustomListsOptions) SetKind(kind string) *CreateCustomListsOptions
SetKind : Allow user to set Kind
func (*CreateCustomListsOptions) SetName ¶
func (_options *CreateCustomListsOptions) SetName(name string) *CreateCustomListsOptions
SetName : Allow user to set Name
type CreateListItemsOptions ¶
type CreateListItemsOptions struct {
	CreateListItemsReqItem []CreateListItemsReqItem `json:"CreateListItemsReqItem,omitempty"`
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    CreateListItemsOptions : The CreateListItems options.
func (*CreateListItemsOptions) SetCreateListItemsReqItem ¶
func (_options *CreateListItemsOptions) SetCreateListItemsReqItem(createListItemsReqItem []CreateListItemsReqItem) *CreateListItemsOptions
SetCreateListItemsReqItem : Allow user to set CreateListItemsReqItem
func (*CreateListItemsOptions) SetHeaders ¶
func (options *CreateListItemsOptions) SetHeaders(param map[string]string) *CreateListItemsOptions
SetHeaders : Allow user to set Headers
type CreateListItemsReqItem ¶
type CreateListItemsReqItem struct {
	// An autonomous system number.
	Asn *float64 `json:"asn,omitempty"`
	// An informative summary of the list item.
	Comment *string `json:"comment,omitempty"`
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the
	// hyphen (-).
	Hostname *string `json:"hostname,omitempty"`
	// An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
	Ip *string `json:"ip,omitempty"`
}
    CreateListItemsReqItem : CreateListItemsReqItem struct
type CustomListResp ¶
type CustomListResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`
	// Errors.
	Errors [][]string `json:"errors" validate:"required"`
	// Messages.
	Messages [][]string `json:"messages" validate:"required"`
	Result *CustomListResult `json:"result" validate:"required"`
}
    CustomListResp : Create Custom List Response.
type CustomListResult ¶
type CustomListResult struct {
	// The name of the list to be referenced by rule expressions.
	Name *string `json:"name,omitempty"`
	// The unique ID of the list.
	ID *string `json:"id,omitempty"`
	// Describes the contents of the list.
	Description *string `json:"description,omitempty"`
	// The type of resource this list contains.
	Kind *string `json:"kind,omitempty"`
	// How many items the list contains.
	NumItems *float64 `json:"num_items,omitempty"`
	// How many times the list is used by rule expressions.
	NumReferencingFilters *float64 `json:"num_referencing_filters,omitempty"`
}
    CustomListResult : CustomListResult struct
type CustomListsResp ¶
type CustomListsResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`
	// Errors.
	Errors [][]string `json:"errors" validate:"required"`
	// Messages.
	Messages [][]string `json:"messages" validate:"required"`
	Result []CustomListResult `json:"result" validate:"required"`
}
    CustomListsResp : List Custom Lists Response.
type DeleteCustomListOptions ¶
type DeleteCustomListOptions struct {
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    DeleteCustomListOptions : The DeleteCustomList options.
func (*DeleteCustomListOptions) SetHeaders ¶
func (options *DeleteCustomListOptions) SetHeaders(param map[string]string) *DeleteCustomListOptions
SetHeaders : Allow user to set Headers
type DeleteListItemsOptions ¶
type DeleteListItemsOptions struct {
	Items []DeleteListItemsReqItemsItem `json:"items,omitempty"`
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    DeleteListItemsOptions : The DeleteListItems options.
func (*DeleteListItemsOptions) SetHeaders ¶
func (options *DeleteListItemsOptions) SetHeaders(param map[string]string) *DeleteListItemsOptions
SetHeaders : Allow user to set Headers
func (*DeleteListItemsOptions) SetItems ¶
func (_options *DeleteListItemsOptions) SetItems(items []DeleteListItemsReqItemsItem) *DeleteListItemsOptions
SetItems : Allow user to set Items
type DeleteListItemsReqItemsItem ¶
type DeleteListItemsReqItemsItem struct {
	ID *string `json:"id,omitempty"`
}
    DeleteListItemsReqItemsItem : DeleteListItemsReqItemsItem struct
type DeleteResourceResp ¶
type DeleteResourceResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`
	// Errors.
	Errors [][]string `json:"errors" validate:"required"`
	// Messages.
	Messages [][]string `json:"messages" validate:"required"`
	Result *DeleteResourceRespResult `json:"result" validate:"required"`
}
    DeleteResourceResp : DeleteResourceResp struct
type DeleteResourceRespResult ¶
type DeleteResourceRespResult struct {
	ID *string `json:"id,omitempty"`
}
    DeleteResourceRespResult : DeleteResourceRespResult struct
type GetCustomListOptions ¶
type GetCustomListOptions struct {
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    GetCustomListOptions : The GetCustomList options.
func (*GetCustomListOptions) SetHeaders ¶
func (options *GetCustomListOptions) SetHeaders(param map[string]string) *GetCustomListOptions
SetHeaders : Allow user to set Headers
type GetCustomListsOptions ¶
type GetCustomListsOptions struct {
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    GetCustomListsOptions : The GetCustomLists options.
func (*GetCustomListsOptions) SetHeaders ¶
func (options *GetCustomListsOptions) SetHeaders(param map[string]string) *GetCustomListsOptions
SetHeaders : Allow user to set Headers
type GetListItemOptions ¶
type GetListItemOptions struct {
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    GetListItemOptions : The GetListItem options.
func (*GetListItemOptions) SetHeaders ¶
func (options *GetListItemOptions) SetHeaders(param map[string]string) *GetListItemOptions
SetHeaders : Allow user to set Headers
type GetListItemsOptions ¶
type GetListItemsOptions struct {
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    GetListItemsOptions : The GetListItems options.
func (*GetListItemsOptions) SetHeaders ¶
func (options *GetListItemsOptions) SetHeaders(param map[string]string) *GetListItemsOptions
SetHeaders : Allow user to set Headers
type GetManagedListsOptions ¶
type GetManagedListsOptions struct {
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    GetManagedListsOptions : The GetManagedLists options.
func (*GetManagedListsOptions) SetHeaders ¶
func (options *GetManagedListsOptions) SetHeaders(param map[string]string) *GetManagedListsOptions
SetHeaders : Allow user to set Headers
type GetOperationStatusOptions ¶
type GetOperationStatusOptions struct {
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    GetOperationStatusOptions : The GetOperationStatus options.
func (*GetOperationStatusOptions) SetHeaders ¶
func (options *GetOperationStatusOptions) SetHeaders(param map[string]string) *GetOperationStatusOptions
SetHeaders : Allow user to set Headers
type ListItem ¶
type ListItem struct {
	ID *string `json:"id,omitempty"`
	// An autonomous system number.
	Asn *float64 `json:"asn,omitempty"`
	// An informative summary of the list item.
	Comment *string `json:"comment,omitempty"`
	// Valid characters for hostnames are ASCII(7) letters from a to z, the digits from 0 to 9, wildcards (*), and the
	// hyphen (-).
	Hostname *string `json:"hostname,omitempty"`
	// An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are limited to a maximum of /64.
	Ip *string `json:"ip,omitempty"`
	CreatedOn *string `json:"created_on,omitempty"`
	ModifiedOn *string `json:"modified_on,omitempty"`
}
    ListItem : ListItem struct
type ListItemResp ¶
type ListItemResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`
	// Errors.
	Errors [][]string `json:"errors" validate:"required"`
	// Messages.
	Messages [][]string `json:"messages" validate:"required"`
	Result *ListItem `json:"result" validate:"required"`
}
    ListItemResp : ListItemResp struct
type ListItemsResp ¶
type ListItemsResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`
	// Errors.
	Errors [][]string `json:"errors" validate:"required"`
	// Messages.
	Messages [][]string `json:"messages" validate:"required"`
	Result []ListItem `json:"result" validate:"required"`
}
    ListItemsResp : ListItemsResp struct
type ListOperationResp ¶
type ListOperationResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`
	// Errors.
	Errors [][]string `json:"errors" validate:"required"`
	// Messages.
	Messages [][]string `json:"messages" validate:"required"`
	Result *ListOperationRespResult `json:"result" validate:"required"`
}
    ListOperationResp : ListOperationResp struct
type ListOperationRespResult ¶
type ListOperationRespResult struct {
	OperationID *string `json:"operation_id,omitempty"`
}
    ListOperationRespResult : ListOperationRespResult struct
type ListsApiV1 ¶
type ListsApiV1 struct {
	Service *core.BaseService
	// Full URL-encoded CRN of the service instance.
	Crn *string
	// List item identifier.
	ItemID *string
	// List identifier.
	ListID *string
	// List operation identifier.
	OperationID *string
}
    ListsApiV1 : CIS Lists
API Version: 1.0.0
func NewListsApiV1 ¶
func NewListsApiV1(options *ListsApiV1Options) (service *ListsApiV1, err error)
NewListsApiV1 : constructs an instance of ListsApiV1 with passed in options.
func NewListsApiV1UsingExternalConfig ¶
func NewListsApiV1UsingExternalConfig(options *ListsApiV1Options) (listsApi *ListsApiV1, err error)
NewListsApiV1UsingExternalConfig : constructs an instance of ListsApiV1 with passed in options and external configuration.
func (*ListsApiV1) Clone ¶
func (listsApi *ListsApiV1) Clone() *ListsApiV1
Clone makes a copy of "listsApi" suitable for processing requests.
func (*ListsApiV1) CreateCustomLists ¶
func (listsApi *ListsApiV1) CreateCustomLists(createCustomListsOptions *CreateCustomListsOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
CreateCustomLists : Create Custom List Create a custom list for your instance.
func (*ListsApiV1) CreateCustomListsWithContext ¶
func (listsApi *ListsApiV1) CreateCustomListsWithContext(ctx context.Context, createCustomListsOptions *CreateCustomListsOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
CreateCustomListsWithContext is an alternate form of the CreateCustomLists method which supports a Context parameter
func (*ListsApiV1) CreateListItems ¶
func (listsApi *ListsApiV1) CreateListItems(createListItemsOptions *CreateListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
CreateListItems : Create List Items Create list items for your custom list. This operation is asynchronous. To get current the operation status, use the get operation status API.
func (*ListsApiV1) CreateListItemsWithContext ¶
func (listsApi *ListsApiV1) CreateListItemsWithContext(ctx context.Context, createListItemsOptions *CreateListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
CreateListItemsWithContext is an alternate form of the CreateListItems method which supports a Context parameter
func (*ListsApiV1) DeleteCustomList ¶
func (listsApi *ListsApiV1) DeleteCustomList(deleteCustomListOptions *DeleteCustomListOptions) (result *DeleteResourceResp, response *core.DetailedResponse, err error)
DeleteCustomList : Delete Custom List Delete a custom list for your instance.
func (*ListsApiV1) DeleteCustomListWithContext ¶
func (listsApi *ListsApiV1) DeleteCustomListWithContext(ctx context.Context, deleteCustomListOptions *DeleteCustomListOptions) (result *DeleteResourceResp, response *core.DetailedResponse, err error)
DeleteCustomListWithContext is an alternate form of the DeleteCustomList method which supports a Context parameter
func (*ListsApiV1) DeleteListItems ¶
func (listsApi *ListsApiV1) DeleteListItems(deleteListItemsOptions *DeleteListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
DeleteListItems : Delete List Items Remove one or more list items from your custom list. This operation is asynchronous. To get current the operation status, use the get operation status API.
func (*ListsApiV1) DeleteListItemsWithContext ¶
func (listsApi *ListsApiV1) DeleteListItemsWithContext(ctx context.Context, deleteListItemsOptions *DeleteListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
DeleteListItemsWithContext is an alternate form of the DeleteListItems method which supports a Context parameter
func (*ListsApiV1) DisableRetries ¶
func (listsApi *ListsApiV1) DisableRetries()
DisableRetries disables automatic retries for requests invoked for this service instance.
func (*ListsApiV1) EnableRetries ¶
func (listsApi *ListsApiV1) 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 (*ListsApiV1) GetCustomList ¶
func (listsApi *ListsApiV1) GetCustomList(getCustomListOptions *GetCustomListOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
GetCustomList : Get Custom List Get a custom list for your instance.
func (*ListsApiV1) GetCustomListWithContext ¶
func (listsApi *ListsApiV1) GetCustomListWithContext(ctx context.Context, getCustomListOptions *GetCustomListOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
GetCustomListWithContext is an alternate form of the GetCustomList method which supports a Context parameter
func (*ListsApiV1) GetCustomLists ¶
func (listsApi *ListsApiV1) GetCustomLists(getCustomListsOptions *GetCustomListsOptions) (result *CustomListsResp, response *core.DetailedResponse, err error)
GetCustomLists : List Custom Lists List the custom lists for your instance.
func (*ListsApiV1) GetCustomListsWithContext ¶
func (listsApi *ListsApiV1) GetCustomListsWithContext(ctx context.Context, getCustomListsOptions *GetCustomListsOptions) (result *CustomListsResp, response *core.DetailedResponse, err error)
GetCustomListsWithContext is an alternate form of the GetCustomLists method which supports a Context parameter
func (*ListsApiV1) GetEnableGzipCompression ¶
func (listsApi *ListsApiV1) GetEnableGzipCompression() bool
GetEnableGzipCompression returns the service's EnableGzipCompression field
func (*ListsApiV1) GetListItem ¶
func (listsApi *ListsApiV1) GetListItem(getListItemOptions *GetListItemOptions) (result *ListItemResp, response *core.DetailedResponse, err error)
GetListItem : Get List Item Get a specific list item.
func (*ListsApiV1) GetListItemWithContext ¶
func (listsApi *ListsApiV1) GetListItemWithContext(ctx context.Context, getListItemOptions *GetListItemOptions) (result *ListItemResp, response *core.DetailedResponse, err error)
GetListItemWithContext is an alternate form of the GetListItem method which supports a Context parameter
func (*ListsApiV1) GetListItems ¶
func (listsApi *ListsApiV1) GetListItems(getListItemsOptions *GetListItemsOptions) (result *ListItemsResp, response *core.DetailedResponse, err error)
GetListItems : Get List Items Get the list items for a custom list.
func (*ListsApiV1) GetListItemsWithContext ¶
func (listsApi *ListsApiV1) GetListItemsWithContext(ctx context.Context, getListItemsOptions *GetListItemsOptions) (result *ListItemsResp, response *core.DetailedResponse, err error)
GetListItemsWithContext is an alternate form of the GetListItems method which supports a Context parameter
func (*ListsApiV1) GetManagedLists ¶
func (listsApi *ListsApiV1) GetManagedLists(getManagedListsOptions *GetManagedListsOptions) (result *ManagedListsResp, response *core.DetailedResponse, err error)
GetManagedLists : List Managed Lists List available managed lists for your instance.
func (*ListsApiV1) GetManagedListsWithContext ¶
func (listsApi *ListsApiV1) GetManagedListsWithContext(ctx context.Context, getManagedListsOptions *GetManagedListsOptions) (result *ManagedListsResp, response *core.DetailedResponse, err error)
GetManagedListsWithContext is an alternate form of the GetManagedLists method which supports a Context parameter
func (*ListsApiV1) GetOperationStatus ¶
func (listsApi *ListsApiV1) GetOperationStatus(getOperationStatusOptions *GetOperationStatusOptions) (result *OperationStatusResp, response *core.DetailedResponse, err error)
GetOperationStatus : Get List Operation Status Get the operation status for a custom list operation.
func (*ListsApiV1) GetOperationStatusWithContext ¶
func (listsApi *ListsApiV1) GetOperationStatusWithContext(ctx context.Context, getOperationStatusOptions *GetOperationStatusOptions) (result *OperationStatusResp, response *core.DetailedResponse, err error)
GetOperationStatusWithContext is an alternate form of the GetOperationStatus method which supports a Context parameter
func (*ListsApiV1) GetServiceURL ¶
func (listsApi *ListsApiV1) GetServiceURL() string
GetServiceURL returns the service URL
func (*ListsApiV1) NewCreateCustomListsOptions ¶
func (*ListsApiV1) NewCreateCustomListsOptions() *CreateCustomListsOptions
NewCreateCustomListsOptions : Instantiate CreateCustomListsOptions
func (*ListsApiV1) NewCreateListItemsOptions ¶
func (*ListsApiV1) NewCreateListItemsOptions() *CreateListItemsOptions
NewCreateListItemsOptions : Instantiate CreateListItemsOptions
func (*ListsApiV1) NewDeleteCustomListOptions ¶
func (*ListsApiV1) NewDeleteCustomListOptions() *DeleteCustomListOptions
NewDeleteCustomListOptions : Instantiate DeleteCustomListOptions
func (*ListsApiV1) NewDeleteListItemsOptions ¶
func (*ListsApiV1) NewDeleteListItemsOptions() *DeleteListItemsOptions
NewDeleteListItemsOptions : Instantiate DeleteListItemsOptions
func (*ListsApiV1) NewGetCustomListOptions ¶
func (*ListsApiV1) NewGetCustomListOptions() *GetCustomListOptions
NewGetCustomListOptions : Instantiate GetCustomListOptions
func (*ListsApiV1) NewGetCustomListsOptions ¶
func (*ListsApiV1) NewGetCustomListsOptions() *GetCustomListsOptions
NewGetCustomListsOptions : Instantiate GetCustomListsOptions
func (*ListsApiV1) NewGetListItemOptions ¶
func (*ListsApiV1) NewGetListItemOptions() *GetListItemOptions
NewGetListItemOptions : Instantiate GetListItemOptions
func (*ListsApiV1) NewGetListItemsOptions ¶
func (*ListsApiV1) NewGetListItemsOptions() *GetListItemsOptions
NewGetListItemsOptions : Instantiate GetListItemsOptions
func (*ListsApiV1) NewGetManagedListsOptions ¶
func (*ListsApiV1) NewGetManagedListsOptions() *GetManagedListsOptions
NewGetManagedListsOptions : Instantiate GetManagedListsOptions
func (*ListsApiV1) NewGetOperationStatusOptions ¶
func (*ListsApiV1) NewGetOperationStatusOptions() *GetOperationStatusOptions
NewGetOperationStatusOptions : Instantiate GetOperationStatusOptions
func (*ListsApiV1) NewUpdateCustomListOptions ¶
func (*ListsApiV1) NewUpdateCustomListOptions() *UpdateCustomListOptions
NewUpdateCustomListOptions : Instantiate UpdateCustomListOptions
func (*ListsApiV1) NewUpdateListItemsOptions ¶
func (*ListsApiV1) NewUpdateListItemsOptions() *UpdateListItemsOptions
NewUpdateListItemsOptions : Instantiate UpdateListItemsOptions
func (*ListsApiV1) SetDefaultHeaders ¶
func (listsApi *ListsApiV1) SetDefaultHeaders(headers http.Header)
SetDefaultHeaders sets HTTP headers to be sent in every request
func (*ListsApiV1) SetEnableGzipCompression ¶
func (listsApi *ListsApiV1) SetEnableGzipCompression(enableGzip bool)
SetEnableGzipCompression sets the service's EnableGzipCompression field
func (*ListsApiV1) SetServiceURL ¶
func (listsApi *ListsApiV1) SetServiceURL(url string) error
SetServiceURL sets the service URL
func (*ListsApiV1) UpdateCustomList ¶
func (listsApi *ListsApiV1) UpdateCustomList(updateCustomListOptions *UpdateCustomListOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
UpdateCustomList : Update Custom List Update the description of a custom list.
func (*ListsApiV1) UpdateCustomListWithContext ¶
func (listsApi *ListsApiV1) UpdateCustomListWithContext(ctx context.Context, updateCustomListOptions *UpdateCustomListOptions) (result *CustomListResp, response *core.DetailedResponse, err error)
UpdateCustomListWithContext is an alternate form of the UpdateCustomList method which supports a Context parameter
func (*ListsApiV1) UpdateListItems ¶
func (listsApi *ListsApiV1) UpdateListItems(updateListItemsOptions *UpdateListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
UpdateListItems : Update All List Items Update all list items for your custom list. This removes existing items from the list. This operation is asynchronous. To get current the operation status, use the get operation status API.
func (*ListsApiV1) UpdateListItemsWithContext ¶
func (listsApi *ListsApiV1) UpdateListItemsWithContext(ctx context.Context, updateListItemsOptions *UpdateListItemsOptions) (result *ListOperationResp, response *core.DetailedResponse, err error)
UpdateListItemsWithContext is an alternate form of the UpdateListItems method which supports a Context parameter
type ListsApiV1Options ¶
type ListsApiV1Options struct {
	ServiceName   string
	URL           string
	Authenticator core.Authenticator
	// Full URL-encoded CRN of the service instance.
	Crn *string `validate:"required"`
	// List item identifier.
	ItemID *string `validate:"required"`
	// List identifier.
	ListID *string `validate:"required"`
	// List operation identifier.
	OperationID *string `validate:"required"`
}
    ListsApiV1Options : Service options
type ManagedListsResp ¶
type ManagedListsResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`
	// Errors.
	Errors [][]string `json:"errors" validate:"required"`
	// Messages.
	Messages [][]string `json:"messages" validate:"required"`
	Result []ManagedListsResultItem `json:"result" validate:"required"`
}
    ManagedListsResp : List Managed Lists Response.
type ManagedListsResultItem ¶
type ManagedListsResultItem struct {
	// The name of the list to be referenced by rule expressions.
	Name *string `json:"name,omitempty"`
	// Describes the contents of the managed list.
	Description *string `json:"description,omitempty"`
	// The type of resource this list contains.
	Kind *string `json:"kind,omitempty"`
}
    ManagedListsResultItem : ManagedListsResultItem struct
type OperationStatusResp ¶
type OperationStatusResp struct {
	// Was operation successful.
	Success *bool `json:"success" validate:"required"`
	// Errors.
	Errors [][]string `json:"errors" validate:"required"`
	// Messages.
	Messages [][]string `json:"messages" validate:"required"`
	Result *OperationStatusRespResult `json:"result" validate:"required"`
}
    OperationStatusResp : OperationStatusResp struct
type OperationStatusRespResult ¶
type OperationStatusRespResult struct {
	ID *string `json:"id,omitempty"`
	Status *string `json:"status,omitempty"`
	Completed *string `json:"completed,omitempty"`
	// A message describing the error when the status is failed.
	Error *string `json:"error,omitempty"`
}
    OperationStatusRespResult : OperationStatusRespResult struct
type UpdateCustomListOptions ¶
type UpdateCustomListOptions struct {
	// An informative summary of the list.
	Description *string `json:"description,omitempty"`
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    UpdateCustomListOptions : The UpdateCustomList options.
func (*UpdateCustomListOptions) SetDescription ¶
func (_options *UpdateCustomListOptions) SetDescription(description string) *UpdateCustomListOptions
SetDescription : Allow user to set Description
func (*UpdateCustomListOptions) SetHeaders ¶
func (options *UpdateCustomListOptions) SetHeaders(param map[string]string) *UpdateCustomListOptions
SetHeaders : Allow user to set Headers
type UpdateListItemsOptions ¶
type UpdateListItemsOptions struct {
	CreateListItemsReqItem []CreateListItemsReqItem `json:"CreateListItemsReqItem,omitempty"`
	// Allows users to set headers on API requests.
	Headers map[string]string
}
    UpdateListItemsOptions : The UpdateListItems options.
func (*UpdateListItemsOptions) SetCreateListItemsReqItem ¶
func (_options *UpdateListItemsOptions) SetCreateListItemsReqItem(createListItemsReqItem []CreateListItemsReqItem) *UpdateListItemsOptions
SetCreateListItemsReqItem : Allow user to set CreateListItemsReqItem
func (*UpdateListItemsOptions) SetHeaders ¶
func (options *UpdateListItemsOptions) SetHeaders(param map[string]string) *UpdateListItemsOptions
SetHeaders : Allow user to set Headers