service

Documentation

Overview

Package service is a wrapper for the message gateway Service

Package service is a wrapper for the message gateway Service

Index

• type CreateControlChannelInput
• type CreateControlChannelOutput
• type CreateDataChannelInput
• type CreateDataChannelOutput
• type MessageGatewayService
  • func (mgsService *MessageGatewayService) CreateControlChannel(log log.T, createControlChannelInput *CreateControlChannelInput, ...) (createControlChannelOutput *CreateControlChannelOutput, err error)
  • func (mgsService *MessageGatewayService) CreateDataChannel(log log.T, createDataChannelInput *CreateDataChannelInput, sessionId string) (createDataChannelOutput *CreateDataChannelOutput, err error)
  • func (mgsService *MessageGatewayService) GetRegion() string
  • func (mgsService *MessageGatewayService) GetV4Signer() *v4.Signer
• type OpenControlChannelInput
• type OpenDataChannelInput
• type Service
  • func NewService(context context.T, mgsConfig appconfig.MgsConfig, ...) Service

Types

type CreateControlChannelInput

type CreateControlChannelInput struct {

	// MessageSchemaVersion is a required field
	MessageSchemaVersion *string `json:"MessageSchemaVersion" min:"1" type:"string" required:"true"`

	// RequestId is a required field
	RequestId *string `json:"RequestId" min:"16" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type CreateControlChannelOutput

type CreateControlChannelOutput struct {

	// MessageSchemaVersion
	MessageSchemaVersion *string `xml:"MessageSchemaVersion"`

	// TokenValue is a required field
	TokenValue *string `xml:"TokenValue"`
	// contains filtered or unexported fields
}

type CreateDataChannelInput

type CreateDataChannelInput struct {

	// MessageSchemaVersion is a required field
	MessageSchemaVersion *string `json:"MessageSchemaVersion" min:"1" type:"string" required:"true"`

	// RequestId is a required field
	RequestId *string `json:"RequestId" min:"16" type:"string" required:"true"`

	// ClientId is a required field
	ClientId *string `json:"ClientId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type CreateDataChannelOutput

type CreateDataChannelOutput struct {

	// MessageSchemaVersion
	MessageSchemaVersion *string `xml:"MessageSchemaVersion"`

	// TokenValue is a required field
	TokenValue *string `xml:"TokenValue"`
	// contains filtered or unexported fields
}

type MessageGatewayService

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

MessageGatewayService is a service wrapper that delegates to the message gateway service sdk.

func (*MessageGatewayService) CreateControlChannel

func (mgsService *MessageGatewayService) CreateControlChannel(log log.T, createControlChannelInput *CreateControlChannelInput, channelId string) (createControlChannelOutput *CreateControlChannelOutput, err error)

CreateControlChannel calls the CreateControlChannel MGS API

func (*MessageGatewayService) CreateDataChannel

func (mgsService *MessageGatewayService) CreateDataChannel(log log.T, createDataChannelInput *CreateDataChannelInput, sessionId string) (createDataChannelOutput *CreateDataChannelOutput, err error)

CreateDataChannel calls the CreateDataChannel MGS API

func (*MessageGatewayService) GetRegion

func (mgsService *MessageGatewayService) GetRegion() string

GetRegion gets the region.

func (*MessageGatewayService) GetV4Signer

func (mgsService *MessageGatewayService) GetV4Signer() *v4.Signer

GetV4Signer gets the v4 signer.

type OpenControlChannelInput

type OpenControlChannelInput struct {

	// Cookie for reopening a channel
	Cookie *string `json:"Cookie" min:"1" type:"string"`

	// MessageSchemaVersion is a required field
	MessageSchemaVersion *string `json:"MessageSchemaVersion" min:"1" type:"string" required:"true"`

	// RequestId is a required field
	RequestId *string `json:"RequestId" min:"16" type:"string" required:"true"`

	// TokenValue is a required field
	TokenValue *string `json:"TokenValue" min:"1" type:"string" required:"true"`

	// AgentVersion is a required field
	AgentVersion *string `json:"AgentVersion" min:"1" type:"string" required:"true"`

	// PlatformType is a required field
	PlatformType *string `json:"PlatformType" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type OpenDataChannelInput

type OpenDataChannelInput struct {

	// MessageSchemaVersion is a required field
	MessageSchemaVersion *string `json:"MessageSchemaVersion" min:"1" type:"string" required:"true"`

	// RequestId is a required field
	RequestId *string `json:"RequestId" min:"16" type:"string" required:"true"`

	// TokenValue is a required field
	TokenValue *string `json:"TokenValue" min:"1" type:"string" required:"true"`

	// ClientInstanceId is a required field
	ClientInstanceId *string `json:"ClientInstanceId" min:"1" type:"string" required:"true"`

	// ClientId is a required field
	ClientId *string `json:"ClientId" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

type Service

type Service interface {
	CreateControlChannel(log log.T, createControlChannelInput *CreateControlChannelInput, channelId string) (createControlChannelOutput *CreateControlChannelOutput, err error)
	CreateDataChannel(log log.T, createDataChannelInput *CreateDataChannelInput, sessionId string) (createDataChannelOutput *CreateDataChannelOutput, err error)
	GetV4Signer() *v4.Signer
	GetRegion() string
}

Service is an interface to the message gateway service operation v1.

func NewService

func NewService(context context.T, mgsConfig appconfig.MgsConfig, connectionTimeout time.Duration) Service

NewService creates a new service instance.