v20220110

package
v3.0.761+incompatible Latest Latest
Warning

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

 Go to latest Published: Aug 16, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Index

Constants

View Source 
const (

	// Operation failed.
	FAILEDOPERATION = "FailedOperation"

	// Concurrency quota not requested or request timed out.
	FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"

	// Processing timed out.
	FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"

	// The request for the current `UserId` is being processed. Try again later.
	FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"

	// Internal error.
	INTERNALERROR = "InternalError"

	// JSON parsing error.
	INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"

	// Invalid parameter value.
	INVALIDPARAMETERVALUE = "InvalidParameterValue"

	// Operation denied.
	OPERATIONDENIED = "OperationDenied"

	// No available concurrency quota.
	RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"

	// Unable to find the session.
	RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"

	// Failed to access the concurrency instance.
	RESOURCEUNAVAILABLE_ACCESSFAILED = "ResourceUnavailable.AccessFailed"

	// The instance is being initialized.
	RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"

	// The session is being terminated.
	UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"
)
View Source 
const APIVersion = "2022-01-10"

Variables

This section is empty.

Functions

This section is empty.

Types

type ApplyConcurrentRequest 

type ApplyConcurrentRequest struct {
	*tchttp.BaseRequest

	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// Public IP of user’s application client, which is used for nearby scheduling.
	UserIp *string `json:"UserIp,omitempty" name:"UserIp"`

	// The project ID.
	ProjectId *string `json:"ProjectId,omitempty" name:"ProjectId"`

	// The application version ID.
	ApplicationVersionId *string `json:"ApplicationVersionId,omitempty" name:"ApplicationVersionId"`

	// Application ID, which is used only by the multi-application project to specify applications. For a single-application project, this parameter is ignored, and the application bound to the project will be used.
	ApplicationId *string `json:"ApplicationId,omitempty" name:"ApplicationId"`
}

func NewApplyConcurrentRequest 

func NewApplyConcurrentRequest() (request *ApplyConcurrentRequest)

func (*ApplyConcurrentRequest) FromJsonString 

func (r *ApplyConcurrentRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyConcurrentRequest) ToJsonString 

func (r *ApplyConcurrentRequest) ToJsonString() string

type ApplyConcurrentRequestParams 

type ApplyConcurrentRequestParams struct {
	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// Public IP of user’s application client, which is used for nearby scheduling.
	UserIp *string `json:"UserIp,omitempty" name:"UserIp"`

	// The project ID.
	ProjectId *string `json:"ProjectId,omitempty" name:"ProjectId"`

	// The application version ID.
	ApplicationVersionId *string `json:"ApplicationVersionId,omitempty" name:"ApplicationVersionId"`

	// Application ID, which is used only by the multi-application project to specify applications. For a single-application project, this parameter is ignored, and the application bound to the project will be used.
	ApplicationId *string `json:"ApplicationId,omitempty" name:"ApplicationId"`
}

Predefined struct for user

type ApplyConcurrentResponse 

type ApplyConcurrentResponse struct {
	*tchttp.BaseResponse
	Response *ApplyConcurrentResponseParams `json:"Response"`
}

func NewApplyConcurrentResponse 

func NewApplyConcurrentResponse() (response *ApplyConcurrentResponse)

func (*ApplyConcurrentResponse) FromJsonString 

func (r *ApplyConcurrentResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*ApplyConcurrentResponse) ToJsonString 

func (r *ApplyConcurrentResponse) ToJsonString() string

type ApplyConcurrentResponseParams 

type ApplyConcurrentResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type Client 

type Client struct {
	common.Client
}

func NewClient 

func NewClient(credential common.CredentialIface, region string, clientProfile *profile.ClientProfile) (client *Client, err error)

func NewClientWithSecretId 

func NewClientWithSecretId(secretId, secretKey, region string) (client *Client, err error)

Deprecated

func (*Client) ApplyConcurrent 

func (c *Client) ApplyConcurrent(request *ApplyConcurrentRequest) (response *ApplyConcurrentResponse, err error)

ApplyConcurrent This API is used to request concurrency quota.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"
RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"
UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"

func (*Client) ApplyConcurrentWithContext 

func (c *Client) ApplyConcurrentWithContext(ctx context.Context, request *ApplyConcurrentRequest) (response *ApplyConcurrentResponse, err error)

ApplyConcurrent This API is used to request concurrency quota.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"
RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"
UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"

func (*Client) CreateSession 

func (c *Client) CreateSession(request *CreateSessionRequest) (response *CreateSessionResponse, err error)

CreateSession This API is used to create a session.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"
UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"

func (*Client) CreateSessionWithContext 

func (c *Client) CreateSessionWithContext(ctx context.Context, request *CreateSessionRequest) (response *CreateSessionResponse, err error)

CreateSession This API is used to create a session.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_LOCKTIMEOUT = "FailedOperation.LockTimeout"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
FAILEDOPERATION_SLOWDOWN = "FailedOperation.SlowDown"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
INVALIDPARAMETERVALUE = "InvalidParameterValue"
OPERATIONDENIED = "OperationDenied"
RESOURCENOTFOUND_NOIDLE = "ResourceNotFound.NoIdle"
RESOURCENOTFOUND_SESSIONNOTFOUND = "ResourceNotFound.SessionNotFound"
RESOURCEUNAVAILABLE_INITIALIZATION = "ResourceUnavailable.Initialization"
UNSUPPORTEDOPERATION_STOPPING = "UnsupportedOperation.Stopping"

func (*Client) DestroySession 

func (c *Client) DestroySession(request *DestroySessionRequest) (response *DestroySessionResponse, err error)

DestroySession This API is used to terminate a session.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
RESOURCEUNAVAILABLE_ACCESSFAILED = "ResourceUnavailable.AccessFailed"

func (*Client) DestroySessionWithContext 

func (c *Client) DestroySessionWithContext(ctx context.Context, request *DestroySessionRequest) (response *DestroySessionResponse, err error)

DestroySession This API is used to terminate a session.

error code that may be returned: 

FAILEDOPERATION = "FailedOperation"
FAILEDOPERATION_PROCESSTIMEOUT = "FailedOperation.ProcessTimeout"
INTERNALERROR = "InternalError"
INVALIDPARAMETER_JSONPARSEERROR = "InvalidParameter.JsonParseError"
RESOURCEUNAVAILABLE_ACCESSFAILED = "ResourceUnavailable.AccessFailed"

type CreateSessionRequest 

type CreateSessionRequest struct {
	*tchttp.BaseRequest

	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// Public IP of user’s application client, which is used for nearby scheduling.
	UserIp *string `json:"UserIp,omitempty" name:"UserIp"`

	// The client-side session data, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be null.
	ClientSession *string `json:"ClientSession,omitempty" name:"ClientSession"`

	// The on-cloud running mode.
	// `RunWithoutClient`: Keep the application running on the cloud even when there are no client connections.
	// Empty string (default): Keep the application running on the cloud only when there are client connections.
	RunMode *string `json:"RunMode,omitempty" name:"RunMode"`

	// Application startup parameter.
	// If the user requests a multi-application project or a prelaunch-disabled single-application project, this parameter takes effect.
	// If the user requests a prelaunch-enabled single-application project, this parameter is invalid.
	ApplicationParameters *string `json:"ApplicationParameters,omitempty" name:"ApplicationParameters"`

	// The user ID of the host in **multi-person interaction** scenarios, which is required.
	// If the current user is the host, `HostUserId` must be the same as their `UserId`; otherwise, `HostUserId` should be the host's `UserId`.
	HostUserId *string `json:"HostUserId,omitempty" name:"HostUserId"`

	// The role in **multi-person interaction** scenarios. Valid values:
	// `Player`: A user who can operate an application by using a keyboard and mouse
	// `Viewer`: A user who can only watch the video in the room but cannot operate the application
	Role *string `json:"Role,omitempty" name:"Role"`
}

func NewCreateSessionRequest 

func NewCreateSessionRequest() (request *CreateSessionRequest)

func (*CreateSessionRequest) FromJsonString 

func (r *CreateSessionRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSessionRequest) ToJsonString 

func (r *CreateSessionRequest) ToJsonString() string

type CreateSessionRequestParams 

type CreateSessionRequestParams struct {
	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitempty" name:"UserId"`

	// Public IP of user’s application client, which is used for nearby scheduling.
	UserIp *string `json:"UserIp,omitempty" name:"UserIp"`

	// The client-side session data, which is obtained from the SDK. If `RunMode` is `RunWithoutClient`, this parameter can be null.
	ClientSession *string `json:"ClientSession,omitempty" name:"ClientSession"`

	// The on-cloud running mode.
	// `RunWithoutClient`: Keep the application running on the cloud even when there are no client connections.
	// Empty string (default): Keep the application running on the cloud only when there are client connections.
	RunMode *string `json:"RunMode,omitempty" name:"RunMode"`

	// Application startup parameter.
	// If the user requests a multi-application project or a prelaunch-disabled single-application project, this parameter takes effect.
	// If the user requests a prelaunch-enabled single-application project, this parameter is invalid.
	ApplicationParameters *string `json:"ApplicationParameters,omitempty" name:"ApplicationParameters"`

	// The user ID of the host in **multi-person interaction** scenarios, which is required.
	// If the current user is the host, `HostUserId` must be the same as their `UserId`; otherwise, `HostUserId` should be the host's `UserId`.
	HostUserId *string `json:"HostUserId,omitempty" name:"HostUserId"`

	// The role in **multi-person interaction** scenarios. Valid values:
	// `Player`: A user who can operate an application by using a keyboard and mouse
	// `Viewer`: A user who can only watch the video in the room but cannot operate the application
	Role *string `json:"Role,omitempty" name:"Role"`
}

Predefined struct for user

type CreateSessionResponse 

type CreateSessionResponse struct {
	*tchttp.BaseResponse
	Response *CreateSessionResponseParams `json:"Response"`
}

func NewCreateSessionResponse 

func NewCreateSessionResponse() (response *CreateSessionResponse)

func (*CreateSessionResponse) FromJsonString 

func (r *CreateSessionResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*CreateSessionResponse) ToJsonString 

func (r *CreateSessionResponse) ToJsonString() string

type CreateSessionResponseParams 

type CreateSessionResponseParams struct {
	// The server-side session data, which is returned to the SDK.
	ServerSession *string `json:"ServerSession,omitempty" name:"ServerSession"`

	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

type DestroySessionRequest 

type DestroySessionRequest struct {
	*tchttp.BaseRequest

	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitempty" name:"UserId"`
}

func NewDestroySessionRequest 

func NewDestroySessionRequest() (request *DestroySessionRequest)

func (*DestroySessionRequest) FromJsonString 

func (r *DestroySessionRequest) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DestroySessionRequest) ToJsonString 

func (r *DestroySessionRequest) ToJsonString() string

type DestroySessionRequestParams 

type DestroySessionRequestParams struct {
	// The user’s unique ID. Tencent Cloud does not parse the ID. You need to manage your own user IDs. Based on your needs, you can either define unique IDs for users or use timestamps to generate random IDs. Make sure the same ID is used when a user reconnects to your application.
	UserId *string `json:"UserId,omitempty" name:"UserId"`
}

Predefined struct for user

type DestroySessionResponse 

type DestroySessionResponse struct {
	*tchttp.BaseResponse
	Response *DestroySessionResponseParams `json:"Response"`
}

func NewDestroySessionResponse 

func NewDestroySessionResponse() (response *DestroySessionResponse)

func (*DestroySessionResponse) FromJsonString 

func (r *DestroySessionResponse) FromJsonString(s string) error

FromJsonString It is highly **NOT** recommended to use this function because it has no param check, nor strict type check

func (*DestroySessionResponse) ToJsonString 

func (r *DestroySessionResponse) ToJsonString() string

type DestroySessionResponseParams 

type DestroySessionResponseParams struct {
	// The unique request ID, which is returned for each request. RequestId is required for locating a problem.
	RequestId *string `json:"RequestId,omitempty" name:"RequestId"`
}

Predefined struct for user

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.