Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CreateApp ¶
func CreateApp(client *golangsdk.ServiceClient, opts CreateAppOpts) error
Types ¶
type CreateAppOpts ¶
type CreateAppOpts struct {
// Unique identifier of the consumer application to be created.
// The application name contains 1 to 200 characters, including letters, digits, underscores (_), and hyphens (-).
// Minimum: 1
// Maximum: 200
AppName string `json:"app_name"`
}
type DescribeAppResult ¶
type DescribeAppResult struct {
// Name of the app.
AppName string `json:"app_name,omitempty"`
// Unique identifier of the app.
AppId string `json:"app_id,omitempty"`
// Time when the app is created, in milliseconds.
CreateTime *int64 `json:"create_time,omitempty"`
// List of associated streams.
CommitCheckPointStreamNames []string `json:"commit_checkpoint_stream_names,omitempty"`
}
type GetAppResponse ¶
type GetAppResponse struct {
// Name of the app.
AppName string `json:"app_name,omitempty"`
// Unique identifier of the app.
AppId string `json:"app_id,omitempty"`
// Time when the app is created, in milliseconds.
CreateTime *int64 `json:"create_time,omitempty"`
// List of associated streams.
CommitCheckPointStreamNames []string `json:"commit_checkpoint_stream_names,omitempty"`
}
func GetApp ¶
func GetApp(client *golangsdk.ServiceClient, appName string) (*GetAppResponse, error)
type GetAppStatusOpts ¶
type GetAppStatusOpts struct {
// Name of the app to be queried.
AppName string
// Name of the stream to be queried.
// Maximum: 60
StreamName string
// Max. number of partitions to list in a single API call.
// The minimum value is 1 and the maximum value is 1,000.
// The default value is 100.
// Minimum: 1
// Maximum: 1000
// Default: 100
Limit *int `q:"limit,omitempty"`
// Name of the partition to start the partition list with.
// The returned partition list does not contain this partition.
StartPartitionId string `q:"start_partition_id,omitempty"`
// Type of the checkpoint.
// - LAST_READ: Only sequence numbers are recorded in databases.
// Enumeration values:
// LAST_READ
CheckpointType string `q:"checkpoint_type"`
}
type GetAppStatusResponse ¶
type GetAppStatusResponse struct {
// Specify whether there are more matching DIS streams to list. Possible values:
// true: yes
// false: no
// Default: false.
HasMore bool `json:"has_more"`
// Stream Name
StreamName string `json:"stream_name"`
// App name
AppName string `json:"app_name"`
// Partition consuming state list
PartitionConsumingStates []struct {
// Partition Id
PartitionId string `json:"partition_id"`
// Partition Sequence Number
SequenceNumber string `json:"sequence_number"`
// Partition data latest offset
LatestOffset int `json:"latest_offset"`
// Partition data earliest offset
EarliestOffset int `json:"earliest_offset"`
// Type of the checkpoint.
// LAST_READ: Only sequence numbers are recorded in databases.
// Enumeration values:
// LAST_READ
CheckpointType string `json:"checkpoint_type"`
// Partition Status:
// CREATING
// ACTIVE
// DELETED
// EXPIRED
Status string `json:"status"`
} `json:"partition_consuming_states"`
}
func GetAppStatus ¶
func GetAppStatus(client *golangsdk.ServiceClient, opts GetAppStatusOpts) (*GetAppStatusResponse, error)
type ListAppOpts ¶
type ListAppOpts struct {
// Maximum number of apps to list in a single API call. Value range: 1-100 Default value: 10
// Minimum: 1
// Maximum: 1000
// Default: 10
Limit *int `q:"limit,omitempty"`
// Name of the app to start the list with. The returned app list does not contain this app name.
StartAppName string `q:"start_app_name,omitempty"`
// Name of the stream whose apps will be returned.
StreamName string `q:"stream_name,omitempty"`
}
type ListAppResponse ¶
type ListAppResponse struct {
// Specifies whether there are more matching consumer applications to list.
// true: yes
// false: no
HasMoreApp *bool `json:"has_more_app,omitempty"`
// AppEntry list that meets the current request.
Apps []DescribeAppResult `json:"apps,omitempty"`
// Total number of apps that meet criteria.
TotalNumber *int `json:"total_number,omitempty"`
}
func ListApps ¶
func ListApps(client *golangsdk.ServiceClient, opts ListAppOpts) (*ListAppResponse, error)
Click to show internal directories.
Click to hide internal directories.