checkpoints

type CommitCheckpointOpts struct {
	// Name of the app, which is the unique identifier of a user data consumption program.
	AppName string `json:"app_name"`
	// Type of the checkpoint.
	// LAST_READ: Only sequence numbers are recorded in databases.
	// Enumeration values:
	// LAST_READ
	CheckpointType string `json:"checkpoint_type"`
	// Name of the stream.
	StreamName string `json:"stream_name"`
	// Partition identifier of the stream. The value can be in either of the following formats:
	// shardId-0000000000
	// 0
	// For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.
	PartitionId string `json:"partition_id"`
	// Sequence number to be submitted, which is used to record the consumption checkpoint of the stream.
	// Ensure that the sequence number is within the valid range.
	SequenceNumber string `json:"sequence_number"`
	// Metadata information of the consumer application.
	// The metadata information can contain a maximum of 1,000 characters.
	// Maximum: 1000
	Metadata string `json:"metadata,omitempty"`
}

type DeleteCheckpointOpts struct {
	// Name of the stream to which the checkpoint belongs.
	StreamName string `q:"stream_name"`
	// Name of the application associated with the checkpoint.
	// Minimum: 1
	// Maximum: 50
	AppName string `q:"app_name"`
	// Type of the checkpoint. LAST_READ: Only sequence numbers are recorded in databases.
	// Enumeration values:
	// LAST_READ
	CheckpointType string `q:"checkpoint_type"`
	// Identifier of the stream partition to which the checkpoint belongs. The value can be in either of the following formats:
	// shardId-0000000000
	// 0
	// For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2, and shardId-0000000000, shardId-0000000001, shardId-0000000002, respectively.
	PartitionId string `q:"partition_id,omitempty"`
}

type GetCheckpointOpts struct {
	// Name of the stream to which the checkpoint belongs.
	StreamName string `q:"stream_name"`
	// Identifier of the stream partition to which the checkpoint belongs.
	// The value can be in either of the following formats:
	//  - shardId-0000000000
	//  - 0
	// For example, if a stream has three partitions, the partition identifiers are 0, 1, and 2,
	// or shardId-0000000000, shardId-0000000001, and shardId-0000000002, respectively.
	PartitionId string `q:"partition_id"`
	// Name of the app associated with the checkpoint.
	AppName string `q:"app_name"`
	// Type of the checkpoint.
	// LAST_READ: Only sequence numbers are recorded in databases.
	// Enumeration values:
	// LAST_READ
	CheckpointType string `q:"checkpoint_type"`
}

type GetCheckpointResponse struct {
	// Sequence number used to record the consumption checkpoint of the stream.
	SequenceNumber string `json:"sequence_number,omitempty"`
	// Metadata information of the consumer application.
	Metadata string `json:"metadata,omitempty"`
}