subscriptions

Documentation

Index

• Variables
• type CreateOps
  • func (ops CreateOps) ToSubscriptionCreateMap() (map[string]interface{}, error)
• type CreateOpsBuilder
• type CreateResult
  • func Create(client *golangsdk.ServiceClient, ops CreateOpsBuilder, topicUrn string) (r CreateResult)
  • func (r CreateResult) Extract() (*Subscription, error)
  • func (r CreateResult) ExtractInto(v interface{}) error
• type DeleteResult
  • func Delete(client *golangsdk.ServiceClient, subscriptionUrn string) (r DeleteResult)
• type ExtensionSpec
• type FilterPolicy
• type GetResult
  • func (r GetResult) Extract() (*Subscription, error)
  • func (r GetResult) ExtractInto(v interface{}) error
• type ListResult
  • func List(client *golangsdk.ServiceClient) (r ListResult)
  • func ListFromTopic(client *golangsdk.ServiceClient, topicUrn string) (r ListResult)
  • func (lr ListResult) Extract() ([]SubscriptionGet, error)
• type Subscription
• type SubscriptionGet
  • func ExtractSubscriptions(r pagination.Page) ([]SubscriptionGet, error)
• type SubscriptionPage
  • func (b SubscriptionPage) IsEmpty() (bool, error)

Variables

var RequestOpts golangsdk.RequestOpts = golangsdk.RequestOpts{
	MoreHeaders: map[string]string{"Content-Type": "application/json", "X-Language": "en-us"},
}

Types

type CreateOps

type CreateOps struct {
	//Message endpoint
	Endpoint string `json:"endpoint" required:"true"`
	//Protocol of the message endpoint
	Protocol string `json:"protocol" required:"true"`
	//Description of the subscription
	Remark string `json:"remark,omitempty"`
	// Extension config
	Extension *ExtensionSpec `json:"extension,omitempty"`
}

CreateOps is a struct that contains all the parameters.

func (CreateOps) ToSubscriptionCreateMap

func (ops CreateOps) ToSubscriptionCreateMap() (map[string]interface{}, error)

type CreateOpsBuilder

type CreateOpsBuilder interface {
	ToSubscriptionCreateMap() (map[string]interface{}, error)
}

CreateOpsBuilder is used for creating subscription parameters. any struct providing the parameters should implement this interface

type CreateResult

type CreateResult struct {
	// contains filtered or unexported fields
}

CreateResult contains the response body and error from a Create request.

func Create

func Create(client *golangsdk.ServiceClient, ops CreateOpsBuilder, topicUrn string) (r CreateResult)

Create a subscription with given parameters.

func (CreateResult) Extract

func (r CreateResult) Extract() (*Subscription, error)

Extract will get the subscription object out of the commonResult object.

func (CreateResult) ExtractInto

func (r CreateResult) ExtractInto(v interface{}) error

type DeleteResult

type DeleteResult struct {
	golangsdk.ErrResult
}

func Delete

func Delete(client *golangsdk.ServiceClient, subscriptionUrn string) (r DeleteResult)

delete a subscription via subscription urn

type ExtensionSpec

type ExtensionSpec struct {
	ClientID     string `json:"client_id,omitempty"`
	ClientSecret string `json:"client_secret,omitempty"`
	Keyword      string `json:"keyword,omitempty"`
	SignSecret   string `json:"sign_secret,omitempty"`
}

type FilterPolicy

type FilterPolicy struct {
	Name         string   `json:"name"`
	StringEquals []string `json:"string_equals"`
}

type GetResult

type GetResult struct {
	// contains filtered or unexported fields
}

func (GetResult) Extract

func (r GetResult) Extract() (*Subscription, error)

Extract will get the subscription object out of the commonResult object.

func (GetResult) ExtractInto

func (r GetResult) ExtractInto(v interface{}) error

type ListResult

type ListResult struct {
	golangsdk.Result
}

func List

func List(client *golangsdk.ServiceClient) (r ListResult)

list all the subscriptions

func ListFromTopic

func ListFromTopic(client *golangsdk.ServiceClient, topicUrn string) (r ListResult)

list all the subscriptions of a topic

func (ListResult) Extract

func (lr ListResult) Extract() ([]SubscriptionGet, error)

type Subscription

type Subscription struct {
	RequestId       string `json:"request_id"`
	SubscriptionUrn string `json:"subscription_urn"`
}

type SubscriptionGet

type SubscriptionGet struct {
	TopicUrn        string         `json:"topic_urn"`
	Protocol        string         `json:"protocol"`
	SubscriptionUrn string         `json:"subscription_urn"`
	Owner           string         `json:"owner"`
	Endpoint        string         `json:"endpoint"`
	Remark          string         `json:"remark"`
	Status          int            `json:"status"`
	FilterPolicies  []FilterPolicy `json:"filter_polices"`
}

func ExtractSubscriptions

func ExtractSubscriptions(r pagination.Page) ([]SubscriptionGet, error)

type SubscriptionPage

type SubscriptionPage struct {
	pagination.OffsetPageBase
}

func (SubscriptionPage) IsEmpty

func (b SubscriptionPage) IsEmpty() (bool, error)